KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
PARAM_CFG_WXSTRING_SET Class Reference

Configuration object for a set of wxString objects. More...

#include <config_params.h>

Inheritance diagram for PARAM_CFG_WXSTRING_SET:
PARAM_CFG

Public Member Functions

 PARAM_CFG_WXSTRING_SET (const wxString &ident, std::set< wxString > *ptparam, const wxChar *group=nullptr)
 
 PARAM_CFG_WXSTRING_SET (bool Insetup, const wxString &ident, std::set< wxString > *ptparam, const wxChar *group=nullptr)
 
virtual void ReadParam (wxConfigBase *aConfig) const override
 Read the value of the parameter stored in aConfig.
 
virtual void SaveParam (wxConfigBase *aConfig) const override
 Save the value of the parameter stored in aConfig.
 

Public Attributes

std::set< wxString > * m_Pt_param
 Pointer to the parameter value.
 
wxString m_Ident
 Keyword in config data.
 
paramcfg_id m_Type
 Type of parameter.
 
wxString m_Group
 Group name (this is like a path in the config data)
 
bool m_Setup
 Install or Project based parameter, true == install.
 
wxString m_Ident_legacy
 

Detailed Description

Configuration object for a set of wxString objects.

Definition at line 234 of file config_params.h.

Constructor & Destructor Documentation

◆ PARAM_CFG_WXSTRING_SET() [1/2]

PARAM_CFG_WXSTRING_SET::PARAM_CFG_WXSTRING_SET ( const wxString & ident,
std::set< wxString > * ptparam,
const wxChar * group = nullptr )

Definition at line 378 of file config_params.cpp.

References group, m_Pt_param, PARAM_CFG::PARAM_CFG(), and PARAM_WXSTRING_SET.

◆ PARAM_CFG_WXSTRING_SET() [2/2]

PARAM_CFG_WXSTRING_SET::PARAM_CFG_WXSTRING_SET ( bool Insetup,
const wxString & ident,
std::set< wxString > * ptparam,
const wxChar * group = nullptr )

Definition at line 386 of file config_params.cpp.

References group, m_Pt_param, PARAM_CFG::m_Setup, PARAM_CFG::PARAM_CFG(), and PARAM_WXSTRING.

Member Function Documentation

◆ ReadParam()

void PARAM_CFG_WXSTRING_SET::ReadParam ( wxConfigBase * aConfig) const
overridevirtual

Read the value of the parameter stored in aConfig.

Parameters
aConfigthe wxConfigBase that holds the parameter.

Reimplemented from PARAM_CFG.

Definition at line 395 of file config_params.cpp.

References PARAM_CFG::m_Ident, and m_Pt_param.

◆ SaveParam()

void PARAM_CFG_WXSTRING_SET::SaveParam ( wxConfigBase * aConfig) const
overridevirtual

Save the value of the parameter stored in aConfig.

Parameters
aConfigthe wxConfigBase that can store the parameter.

Reimplemented from PARAM_CFG.

Definition at line 416 of file config_params.cpp.

References PARAM_CFG::m_Ident, and m_Pt_param.

Member Data Documentation

◆ m_Group

wxString PARAM_CFG::m_Group
inherited

Group name (this is like a path in the config data)

Definition at line 102 of file config_params.h.

Referenced by PARAM_CFG().

◆ m_Ident

wxString PARAM_CFG::m_Ident
inherited

Keyword in config data.

Definition at line 100 of file config_params.h.

Referenced by dumpParamCfg(), PARAM_CFG(), PARAM_CFG_BOOL::ReadParam(), PARAM_CFG_DOUBLE::ReadParam(), PARAM_CFG_FILENAME::ReadParam(), PARAM_CFG_INT::ReadParam(), PARAM_CFG_INT_WITH_SCALE::ReadParam(), PARAM_CFG_LIBNAME_LIST::ReadParam(), PARAM_CFG_WXSTRING::ReadParam(), PARAM_CFG_WXSTRING_SET::ReadParam(), PARAM_CFG_BOOL::SaveParam(), PARAM_CFG_DOUBLE::SaveParam(), PARAM_CFG_FILENAME::SaveParam(), PARAM_CFG_INT::SaveParam(), PARAM_CFG_INT_WITH_SCALE::SaveParam(), PARAM_CFG_LIBNAME_LIST::SaveParam(), PARAM_CFG_WXSTRING::SaveParam(), and PARAM_CFG_WXSTRING_SET::SaveParam().

◆ m_Ident_legacy

wxString PARAM_CFG::m_Ident_legacy
inherited

Definition at line 107 of file config_params.h.

Referenced by PARAM_CFG(), PARAM_CFG_BOOL::ReadParam(), PARAM_CFG_INT::ReadParam(), and PARAM_CFG_INT_WITH_SCALE::ReadParam().

◆ m_Pt_param

std::set<wxString>* PARAM_CFG_WXSTRING_SET::m_Pt_param

Pointer to the parameter value.

Definition at line 248 of file config_params.h.

Referenced by PARAM_CFG_WXSTRING_SET(), PARAM_CFG_WXSTRING_SET(), ReadParam(), and SaveParam().

◆ m_Setup

bool PARAM_CFG::m_Setup
inherited

Install or Project based parameter, true == install.

Definition at line 103 of file config_params.h.

Referenced by PARAM_CFG(), PARAM_CFG_BOOL::PARAM_CFG_BOOL(), PARAM_CFG_DOUBLE::PARAM_CFG_DOUBLE(), PARAM_CFG_INT::PARAM_CFG_INT(), PARAM_CFG_WXSTRING::PARAM_CFG_WXSTRING(), and PARAM_CFG_WXSTRING_SET::PARAM_CFG_WXSTRING_SET().

◆ m_Type

paramcfg_id PARAM_CFG::m_Type
inherited

Type of parameter.

Definition at line 101 of file config_params.h.

Referenced by dumpParamCfg(), PARAM_CFG(), PARAM_CFG_INT_WITH_SCALE::PARAM_CFG_INT_WITH_SCALE(), PARAM_CFG_INT_WITH_SCALE::PARAM_CFG_INT_WITH_SCALE(), paramDefaultString(), paramValueString(), and writeParam().

The documentation for this class was generated from the following files: