KiCad PCB EDA Suite
PARAM_CFG Class Reference

PARAM_CFG is 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:
PARAM_CFG_BOOL PARAM_CFG_DOUBLE PARAM_CFG_FIELDNAMES PARAM_CFG_FILENAME PARAM_CFG_INT PARAM_CFG_LIBNAME_LIST PARAM_CFG_SEVERITIES PARAM_CFG_WXSTRING PARAM_CFG_WXSTRING_SET

Public Member Functions

 PARAM_CFG (const wxString &ident, const paramcfg_id type, const wxChar *group=NULL, const wxString &legacy_ident=wxEmptyString)
 
virtual ~PARAM_CFG ()
 
virtual void ReadParam (wxConfigBase *aConfig) const
 Function ReadParam reads the value of the parameter stored in aConfig. More...
 
virtual void SaveParam (wxConfigBase *aConfig) const
 Function SaveParam saves the value of the parameter stored in aConfig. More...
 

Public Attributes

wxString m_Ident
 Keyword in config data. More...
 
paramcfg_id m_Type
 Type of parameter. More...
 
wxString m_Group
 Group name (this is like a path in the config data) More...
 
bool m_Setup
 Install or Project based parameter, true == install. More...
 
wxString m_Ident_legacy
 

Detailed Description

PARAM_CFG is 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 81 of file config_params.h.

Constructor & Destructor Documentation

◆ PARAM_CFG()

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

Definition at line 131 of file config_params.cpp.

133 {
134  m_Ident = ident;
135  m_Type = type;
136  m_Group = group;
137  m_Setup = false;
138 
139  m_Ident_legacy = legacy;
140 }
bool m_Setup
Install or Project based parameter, true == install.
Definition: config_params.h:87
wxString m_Group
Group name (this is like a path in the config data)
Definition: config_params.h:86
wxString m_Ident
Keyword in config data.
Definition: config_params.h:84
wxString m_Ident_legacy
Definition: config_params.h:91
paramcfg_id m_Type
Type of parameter.
Definition: config_params.h:85

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

◆ ~PARAM_CFG()

virtual PARAM_CFG::~PARAM_CFG ( )
inlinevirtual

Definition at line 96 of file config_params.h.

96 {}

Member Function Documentation

◆ ReadParam()

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

Function ReadParam reads the value of the parameter stored in aConfig.

Parameters
aConfig= the wxConfigBase that holds the parameter

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

Definition at line 103 of file config_params.h.

103 {};

◆ SaveParam()

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

Function SaveParam saves the value of the parameter stored in aConfig.

Parameters
aConfig= the wxConfigBase that can store the parameter

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

Definition at line 110 of file config_params.h.

110 {};

Member Data Documentation

◆ m_Group

wxString PARAM_CFG::m_Group

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

Definition at line 86 of file config_params.h.

Referenced by PARAM_CFG().

◆ m_Ident

◆ m_Ident_legacy

wxString PARAM_CFG::m_Ident_legacy

◆ m_Setup

◆ m_Type

paramcfg_id PARAM_CFG::m_Type

Type of parameter.

Definition at line 85 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: