A base class which establishes the interface functions ReadParam and SaveParam, which are implemented by a number of derived classes, and these function's doxygen comments are inherited also. More...

#include <config_params.h>

Inheritance diagram for PARAM_CFG:

Public Member Functions
	PARAM_CFG (const wxString &ident, const paramcfg_id type, const wxChar *group=nullptr, const wxString &legacy_ident=wxEmptyString)

virtual	~PARAM_CFG ()

virtual void	ReadParam (wxConfigBase *aConfig) const
	Read the value of the parameter stored in aConfig.

virtual void	SaveParam (wxConfigBase *aConfig) const
	Save the value of the parameter stored in aConfig.

Public Attributes
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

A base class which establishes the interface functions ReadParam and SaveParam, which are implemented by a number of derived classes, and these function's doxygen comments are inherited also.

See kicad.odt or kicad.pdf, chapter 2 : "Installation and configuration/Initialization of the default config".

Definition at line 79 of file config_params.h.

Constructor & Destructor Documentation

◆ PARAM_CFG()

PARAM_CFG::PARAM_CFG	(	const wxString &	ident,
		const paramcfg_id	type,
		const wxChar *	group = `nullptr`,
		const wxString &	legacy_ident = `wxEmptyString`
	)

Definition at line 129 of file config_params.cpp.

References group, m_Group, m_Ident, m_Ident_legacy, m_Setup, and m_Type.

◆ ~PARAM_CFG()

virtual PARAM_CFG::~PARAM_CFG ( )

inlinevirtual

Definition at line 84 of file config_params.h.

Member Function Documentation

◆ ReadParam()

virtual void PARAM_CFG::ReadParam ( wxConfigBase * aConfig ) const

inlinevirtual

Read the value of the parameter stored in aConfig.

Parameters

aConfig the wxConfigBase that holds the parameter.

Reimplemented in PARAM_CFG_INT, PARAM_CFG_INT_WITH_SCALE, PARAM_CFG_DOUBLE, PARAM_CFG_BOOL, PARAM_CFG_WXSTRING, PARAM_CFG_WXSTRING_SET, PARAM_CFG_FILENAME, and PARAM_CFG_LIBNAME_LIST.

Definition at line 91 of file config_params.h.

◆ SaveParam()

virtual void PARAM_CFG::SaveParam ( wxConfigBase * aConfig ) const

inlinevirtual

Save the value of the parameter stored in aConfig.

Parameters

aConfig the wxConfigBase that can store the parameter.

Reimplemented in PARAM_CFG_INT, PARAM_CFG_INT_WITH_SCALE, PARAM_CFG_DOUBLE, PARAM_CFG_BOOL, PARAM_CFG_WXSTRING, PARAM_CFG_WXSTRING_SET, PARAM_CFG_FILENAME, and PARAM_CFG_LIBNAME_LIST.

Definition at line 98 of file config_params.h.

Member Data Documentation

◆ m_Group

wxString PARAM_CFG::m_Group

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

◆ m_Ident_legacy

wxString PARAM_CFG::m_Ident_legacy

Definition at line 107 of file config_params.h.

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

◆ m_Setup

bool PARAM_CFG::m_Setup

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

Type of parameter.

Definition at line 101 of file config_params.h.

Referenced by dumpParamCfg(), PARAM_CFG(), and PARAM_CFG_INT_WITH_SCALE::PARAM_CFG_INT_WITH_SCALE().

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PARAM_CFG()

◆ ~PARAM_CFG()

Member Function Documentation

◆ ReadParam()

◆ SaveParam()

Member Data Documentation

◆ m_Group

◆ m_Ident

◆ m_Ident_legacy

◆ m_Setup

◆ m_Type