PARAM_CFG_BOOL Class Reference

Configuration object for booleans. More...

#include <config_params.h>

Inheritance diagram for PARAM_CFG_BOOL:

Public Member Functions
	PARAM_CFG_BOOL (const wxString &ident, bool *ptparam, int default_val=false, const wxChar *group=nullptr, const wxString &legacy_ident=wxEmptyString)
	PARAM_CFG_BOOL (bool Insetup, const wxString &ident, bool *ptparam, int default_val=false, const wxChar *group=nullptr, const wxString &legacy_ident=wxEmptyString)
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
bool *	m_Pt_param
	Pointer to the parameter value.
int	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 booleans.

Definition at line 190 of file config_params.h.

Constructor & Destructor Documentation

PARAM_CFG_BOOL() [1/2]

PARAM_CFG_BOOL::PARAM_CFG_BOOL	(	const wxString &	ident,
		bool *	ptparam,
		int	default_val = false,
		const wxChar *	group = nullptr,
		const wxString &	legacy_ident = wxEmptyString
	)

Definition at line 300 of file config_params.cpp.

References m_Default, and m_Pt_param.

PARAM_CFG_BOOL() [2/2]

PARAM_CFG_BOOL::PARAM_CFG_BOOL	(	bool	Insetup,
		const wxString &	ident,
		bool *	ptparam,
		int	default_val = false,
		const wxChar *	group = nullptr,
		const wxString &	legacy_ident = wxEmptyString
	)

Definition at line 309 of file config_params.cpp.

References m_Default, m_Pt_param, and PARAM_CFG::m_Setup.

Member Function Documentation

ReadParam()

void PARAM_CFG_BOOL::ReadParam ( wxConfigBase *  aConfig ) const

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 319 of file config_params.cpp.

References m_Default, PARAM_CFG::m_Ident, PARAM_CFG::m_Ident_legacy, and m_Pt_param.

SaveParam()

void PARAM_CFG_BOOL::SaveParam ( wxConfigBase *  aConfig ) const

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 333 of file config_params.cpp.

References PARAM_CFG::m_Ident, and m_Pt_param.

Member Data Documentation

m_Default

int PARAM_CFG_BOOL::m_Default

The default value of the parameter.

Definition at line 204 of file config_params.h.

Referenced by PARAM_CFG_BOOL(), and ReadParam().

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::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(), PARAM_CFG_INT::ReadParam(), PARAM_CFG_INT_WITH_SCALE::ReadParam(), PARAM_CFG_DOUBLE::ReadParam(), ReadParam(), PARAM_CFG_WXSTRING::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(), SaveParam(), PARAM_CFG_WXSTRING::SaveParam(), PARAM_CFG_WXSTRING_SET::SaveParam(), PARAM_CFG_FILENAME::SaveParam(), and PARAM_CFG_LIBNAME_LIST::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(), PARAM_CFG_INT::ReadParam(), PARAM_CFG_INT_WITH_SCALE::ReadParam(), and ReadParam().

m_Pt_param

bool* PARAM_CFG_BOOL::m_Pt_param

Pointer to the parameter value.

Definition at line 203 of file config_params.h.

Referenced by PARAM_CFG_BOOL(), 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(), 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(), and PARAM_CFG_INT_WITH_SCALE::PARAM_CFG_INT_WITH_SCALE().

---

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

• config_params.h
• config_params.cpp