KiCad PCB EDA Suite
Public Member Functions | Public Attributes | List of all members
PARAM_CFG_INT Class Reference

Configuration object for integers. More...

#include <config_params.h>

Inheritance diagram for PARAM_CFG_INT:
PARAM_CFG PARAM_CFG_INT_WITH_SCALE

Public Member Functions

 PARAM_CFG_INT (const wxString &ident, int *ptparam, int default_val=0, int min=std::numeric_limits< int >::min(), int max=std::numeric_limits< int >::max(), const wxChar *group=nullptr, const wxString &legacy_ident=wxEmptyString)
 
 PARAM_CFG_INT (bool Insetup, const wxString &ident, int *ptparam, int default_val=0, int min=std::numeric_limits< int >::min(), int max=std::numeric_limits< int >::max(), 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. More...
 
virtual void SaveParam (wxConfigBase *aConfig) const override
 Save the value of the parameter stored in aConfig. More...
 

Public Attributes

int * m_Pt_param
 Pointer to the parameter value. More...
 
int m_Min
 
int m_Max
 Minimum and maximum values of the param type. More...
 
int m_Default
 The default value of the parameter. More...
 
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

Configuration object for integers.

Definition at line 116 of file config_params.h.

Constructor & Destructor Documentation

◆ PARAM_CFG_INT() [1/2]

PARAM_CFG_INT::PARAM_CFG_INT ( const wxString &  ident,
int *  ptparam,
int  default_val = 0,
int  min = std::numeric_limits<int>::min(),
int  max = std::numeric_limits<int>::max(),
const wxChar *  group = nullptr,
const wxString &  legacy_ident = wxEmptyString 
)

Definition at line 142 of file config_params.cpp.

143 :
144 PARAM_CFG( ident, PARAM_INT, group, legacy )
145{
146 m_Pt_param = ptparam;
147 m_Default = default_val;
148 m_Min = min;
149 m_Max = max;
150}
BITMAPS::group
@ group
PARAM_CFG_INT::m_Max
int m_Max
Minimum and maximum values of the param type.
Definition: config_params.h:134
PARAM_CFG_INT::m_Min
int m_Min
Definition: config_params.h:134
PARAM_CFG_INT::m_Default
int m_Default
The default value of the parameter.
Definition: config_params.h:135
PARAM_CFG_INT::m_Pt_param
int * m_Pt_param
Pointer to the parameter value.
Definition: config_params.h:133
PARAM_CFG::PARAM_CFG
PARAM_CFG(const wxString &ident, const paramcfg_id type, const wxChar *group=nullptr, const wxString &legacy_ident=wxEmptyString)
Definition: config_params.cpp:130
PARAM_INT
@ PARAM_INT
Definition: config_params.h:55

References group, m_Default, m_Max, m_Min, and m_Pt_param.

◆ PARAM_CFG_INT() [2/2]

PARAM_CFG_INT::PARAM_CFG_INT ( bool  Insetup,
const wxString &  ident,
int *  ptparam,
int  default_val = 0,
int  min = std::numeric_limits<int>::min(),
int  max = std::numeric_limits<int>::max(),
const wxChar *  group = nullptr,
const wxString &  legacy_ident = wxEmptyString 
)

Definition at line 153 of file config_params.cpp.

154 :
155 PARAM_CFG( ident, PARAM_INT, group, legacy )
156{
157 m_Pt_param = ptparam;
158 m_Default = default_val;
159 m_Min = min;
160 m_Max = max;
161 m_Setup = setup;
162}
PARAM_CFG::m_Setup
bool m_Setup
Install or Project based parameter, true == install.
Definition: config_params.h:105

References group, m_Default, m_Max, m_Min, m_Pt_param, and PARAM_CFG::m_Setup.

Member Function Documentation

◆ ReadParam()

void PARAM_CFG_INT::ReadParam ( wxConfigBase *  aConfig) const
overridevirtual

Read the value of the parameter stored in aConfig.

Parameters
aConfigthe wxConfigBase that holds the parameter.

Reimplemented from PARAM_CFG.

Reimplemented in PARAM_CFG_INT_WITH_SCALE.

Definition at line 165 of file config_params.cpp.

166{
167 if( !m_Pt_param || !aConfig )
168 return;
169
170 int itmp = m_Default;
171
172 if( !aConfig->Read( m_Ident, &itmp ) && m_Ident_legacy != wxEmptyString )
173 aConfig->Read( m_Ident_legacy, &itmp );
174
175 if( (itmp < m_Min) || (itmp > m_Max) )
176 itmp = m_Default;
177
178 *m_Pt_param = itmp;
179}
PARAM_CFG::m_Ident_legacy
wxString m_Ident_legacy
Definition: config_params.h:109
PARAM_CFG::m_Ident
wxString m_Ident
Keyword in config data.
Definition: config_params.h:102

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

◆ SaveParam()

void PARAM_CFG_INT::SaveParam ( wxConfigBase *  aConfig) const
overridevirtual

Save the value of the parameter stored in aConfig.

Parameters
aConfigthe wxConfigBase that can store the parameter.

Reimplemented from PARAM_CFG.

Reimplemented in PARAM_CFG_INT_WITH_SCALE.

Definition at line 182 of file config_params.cpp.

183{
184 if( !m_Pt_param || !aConfig )
185 return;
186
187 aConfig->Write( m_Ident, *m_Pt_param );
188}

References PARAM_CFG::m_Ident, and m_Pt_param.

Member Data Documentation

◆ m_Default

int PARAM_CFG_INT::m_Default

The default value of the parameter.

Definition at line 135 of file config_params.h.

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

◆ m_Group

wxString PARAM_CFG::m_Group
inherited

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

Definition at line 104 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 102 of file config_params.h.

Referenced by dumpParamCfg(), PARAM_CFG::PARAM_CFG(), ReadParam(), PARAM_CFG_INT_WITH_SCALE::ReadParam(), PARAM_CFG_DOUBLE::ReadParam(), PARAM_CFG_BOOL::ReadParam(), PARAM_CFG_WXSTRING::ReadParam(), PARAM_CFG_WXSTRING_SET::ReadParam(), PARAM_CFG_FILENAME::ReadParam(), PARAM_CFG_LIBNAME_LIST::ReadParam(), SaveParam(), PARAM_CFG_INT_WITH_SCALE::SaveParam(), PARAM_CFG_DOUBLE::SaveParam(), PARAM_CFG_BOOL::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 109 of file config_params.h.

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

◆ m_Max

int PARAM_CFG_INT::m_Max

Minimum and maximum values of the param type.

Definition at line 134 of file config_params.h.

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

◆ m_Min

int PARAM_CFG_INT::m_Min

Definition at line 134 of file config_params.h.

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

◆ m_Pt_param

int* PARAM_CFG_INT::m_Pt_param

Pointer to the parameter value.

Definition at line 133 of file config_params.h.

Referenced by PARAM_CFG_INT(), ReadParam(), PARAM_CFG_INT_WITH_SCALE::ReadParam(), SaveParam(), and PARAM_CFG_INT_WITH_SCALE::SaveParam().

◆ m_Setup

bool PARAM_CFG::m_Setup
inherited

Install or Project based parameter, true == install.

Definition at line 105 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_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 103 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: