KiCad PCB EDA Suite
PARAM_CFG_BASE Class Reference

Class PARAM_CFG_BASE 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_BASE:
PARAM_CFG_BOOL PARAM_CFG_DOUBLE PARAM_CFG_FILENAME PARAM_CFG_INT PARAM_CFG_LIBNAME_LIST PARAM_CFG_SETCOLOR PARAM_CFG_WXSTRING PARAM_CFG_INT_WITH_SCALE

Public Member Functions

 PARAM_CFG_BASE (const wxString &ident, const paramcfg_id type, const wxChar *group=NULL)
 
virtual ~PARAM_CFG_BASE ()
 
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...
 

Detailed Description

Class PARAM_CFG_BASE 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 94 of file config_params.h.

Constructor & Destructor Documentation

PARAM_CFG_BASE::PARAM_CFG_BASE ( const wxString &  ident,
const paramcfg_id  type,
const wxChar *  group = NULL 
)

Definition at line 137 of file config_params.cpp.

References m_Group, m_Ident, m_Setup, and m_Type.

139 {
140  m_Ident = ident;
141  m_Type = type;
142  m_Group = group;
143  m_Setup = false;
144 }
bool m_Setup
Install or Project based parameter, true == install.
wxString m_Group
Group name (this is like a path in the config data)
Definition: config_params.h:99
paramcfg_id m_Type
Type of parameter.
Definition: config_params.h:98
wxString m_Ident
Keyword in config data.
Definition: config_params.h:97
virtual PARAM_CFG_BASE::~PARAM_CFG_BASE ( )
inlinevirtual

Definition at line 105 of file config_params.h.

105 {}

Member Function Documentation

virtual void PARAM_CFG_BASE::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, PARAM_CFG_BOOL, PARAM_CFG_DOUBLE, PARAM_CFG_SETCOLOR, PARAM_CFG_INT_WITH_SCALE, and PARAM_CFG_INT.

Definition at line 112 of file config_params.h.

112 {};
virtual void PARAM_CFG_BASE::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, PARAM_CFG_BOOL, PARAM_CFG_DOUBLE, PARAM_CFG_SETCOLOR, PARAM_CFG_INT_WITH_SCALE, and PARAM_CFG_INT.

Definition at line 119 of file config_params.h.

119 {};

Member Data Documentation

wxString PARAM_CFG_BASE::m_Group

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

Definition at line 99 of file config_params.h.

Referenced by PARAM_CFG_BASE().

bool PARAM_CFG_BASE::m_Setup
paramcfg_id PARAM_CFG_BASE::m_Type

Type of parameter.

Definition at line 98 of file config_params.h.

Referenced by PARAM_CFG_BASE(), and PARAM_CFG_INT_WITH_SCALE::PARAM_CFG_INT_WITH_SCALE().


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