Configuration object for wxString objects. More...
#include <config_params.h>
Public Member Functions | |
| PARAM_CFG_WXSTRING (const wxString &ident, wxString *ptparam, const wxChar *group=nullptr) | |
| PARAM_CFG_WXSTRING (bool Insetup, const wxString &ident, wxString *ptparam, const wxString &default_val=wxEmptyString, 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 | |
| wxString * | m_Pt_param |
| Pointer to the parameter value. | |
| wxString | m_default |
| The default value of the parameter. | |
| 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 wxString objects.
Definition at line 211 of file config_params.h.
Constructor & Destructor Documentation
◆ PARAM_CFG_WXSTRING() [1/2]
| PARAM_CFG_WXSTRING::PARAM_CFG_WXSTRING | ( | const wxString & | ident, |
| wxString * | ptparam, | ||
| const wxChar * | group = nullptr |
||
| ) |
Definition at line 342 of file config_params.cpp.
References m_Pt_param.
◆ PARAM_CFG_WXSTRING() [2/2]
| PARAM_CFG_WXSTRING::PARAM_CFG_WXSTRING | ( | bool | Insetup, |
| const wxString & | ident, | ||
| wxString * | ptparam, | ||
| const wxString & | default_val = wxEmptyString, |
||
| const wxChar * | group = nullptr |
||
| ) |
Definition at line 350 of file config_params.cpp.
References m_default, m_Pt_param, and PARAM_CFG::m_Setup.
Member Function Documentation
◆ ReadParam()
|
overridevirtual |
Read the value of the parameter stored in aConfig.
- Parameters
-
aConfig the wxConfigBase that holds the parameter.
Reimplemented from PARAM_CFG.
Definition at line 360 of file config_params.cpp.
References m_default, PARAM_CFG::m_Ident, and m_Pt_param.
◆ SaveParam()
|
overridevirtual |
Save the value of the parameter stored in aConfig.
- Parameters
-
aConfig the wxConfigBase that can store the parameter.
Reimplemented from PARAM_CFG.
Definition at line 369 of file config_params.cpp.
References PARAM_CFG::m_Ident, and m_Pt_param.
Member Data Documentation
◆ m_default
| wxString PARAM_CFG_WXSTRING::m_default |
The default value of the parameter.
Definition at line 226 of file config_params.h.
Referenced by PARAM_CFG_WXSTRING(), and ReadParam().
◆ 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::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(), PARAM_CFG_INT::ReadParam(), PARAM_CFG_INT_WITH_SCALE::ReadParam(), PARAM_CFG_DOUBLE::ReadParam(), PARAM_CFG_BOOL::ReadParam(), ReadParam(), PARAM_CFG_WXSTRING_SET::ReadParam(), PARAM_CFG_FILENAME::ReadParam(), PARAM_CFG_LIBNAME_LIST::ReadParam(), PARAM_CFG_INT::SaveParam(), PARAM_CFG_INT_WITH_SCALE::SaveParam(), PARAM_CFG_DOUBLE::SaveParam(), PARAM_CFG_BOOL::SaveParam(), SaveParam(), PARAM_CFG_WXSTRING_SET::SaveParam(), PARAM_CFG_FILENAME::SaveParam(), and PARAM_CFG_LIBNAME_LIST::SaveParam().
◆ m_Ident_legacy
|
inherited |
Definition at line 107 of file config_params.h.
Referenced by PARAM_CFG::PARAM_CFG(), PARAM_CFG_INT::ReadParam(), PARAM_CFG_INT_WITH_SCALE::ReadParam(), and PARAM_CFG_BOOL::ReadParam().
◆ m_Pt_param
| wxString* PARAM_CFG_WXSTRING::m_Pt_param |
Pointer to the parameter value.
Definition at line 225 of file config_params.h.
Referenced by PARAM_CFG_WXSTRING(), ReadParam(), and SaveParam().
◆ 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(), PARAM_CFG_BOOL::PARAM_CFG_BOOL(), PARAM_CFG_DOUBLE::PARAM_CFG_DOUBLE(), PARAM_CFG_INT::PARAM_CFG_INT(), PARAM_CFG_WXSTRING(), and PARAM_CFG_WXSTRING_SET::PARAM_CFG_WXSTRING_SET().
◆ m_Type
|
inherited |
Type of parameter.
Definition at line 101 of file config_params.h.
Referenced by dumpParamCfg(), PARAM_CFG::PARAM_CFG(), and PARAM_CFG_INT_WITH_SCALE::PARAM_CFG_INT_WITH_SCALE().
The documentation for this class was generated from the following files:
