KiCad PCB EDA Suite
PARAM_CFG_BOOL Class Reference

Configuration parameter - Boolean Class. More...

#include <config_params.h>

Inheritance diagram for PARAM_CFG_BOOL:
PARAM_CFG_BASE

Public Member Functions

 PARAM_CFG_BOOL (const wxString &ident, bool *ptparam, int default_val=false, const wxChar *group=NULL)
 
 PARAM_CFG_BOOL (bool Insetup, const wxString &ident, bool *ptparam, int default_val=false, const wxChar *group=NULL)
 
virtual void ReadParam (wxConfigBase *aConfig) const override
 Function ReadParam reads the value of the parameter stored in aConfig. More...
 
virtual void SaveParam (wxConfigBase *aConfig) const override
 Function SaveParam saves the value of the parameter stored in aConfig. More...
 

Public Attributes

bool * m_Pt_param
 Pointer to the parameter value. 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 parameter - Boolean Class.

Definition at line 238 of file config_params.h.

Constructor & Destructor Documentation

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

Definition at line 375 of file config_params.cpp.

References m_Default, and m_Pt_param.

376  :
377  PARAM_CFG_BASE( ident, PARAM_BOOL, group )
378 {
379  m_Pt_param = ptparam;
380  m_Default = default_val ? true : false;
381 }
int m_Default
The default value of the parameter.
PARAM_CFG_BASE(const wxString &ident, const paramcfg_id type, const wxChar *group=NULL, const wxString &legacy_ident=wxEmptyString)
bool * m_Pt_param
Pointer to the parameter value.
PARAM_CFG_BOOL::PARAM_CFG_BOOL ( bool  Insetup,
const wxString &  ident,
bool *  ptparam,
int  default_val = false,
const wxChar *  group = NULL 
)

Definition at line 384 of file config_params.cpp.

References m_Default, m_Pt_param, and PARAM_CFG_BASE::m_Setup.

388  :
389  PARAM_CFG_BASE( ident, PARAM_BOOL, group )
390 {
391  m_Pt_param = ptparam;
392  m_Default = default_val ? true : false;
393  m_Setup = Insetup;
394 }
int m_Default
The default value of the parameter.
PARAM_CFG_BASE(const wxString &ident, const paramcfg_id type, const wxChar *group=NULL, const wxString &legacy_ident=wxEmptyString)
bool m_Setup
Install or Project based parameter, true == install.
bool * m_Pt_param
Pointer to the parameter value.

Member Function Documentation

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

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

Parameters
aConfig= the wxConfigBase that holds the parameter

Reimplemented from PARAM_CFG_BASE.

Definition at line 397 of file config_params.cpp.

References m_Default, PARAM_CFG_BASE::m_Ident, and m_Pt_param.

398 {
399  if( !m_Pt_param || !aConfig )
400  return;
401 
402  int itmp = aConfig->Read( m_Ident, (int) m_Default );
403 
404  *m_Pt_param = itmp ? true : false;
405 }
int m_Default
The default value of the parameter.
bool * m_Pt_param
Pointer to the parameter value.
wxString m_Ident
Keyword in config data.
void PARAM_CFG_BOOL::SaveParam ( wxConfigBase *  aConfig) const
overridevirtual

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

Parameters
aConfig= the wxConfigBase that can store the parameter

Reimplemented from PARAM_CFG_BASE.

Definition at line 408 of file config_params.cpp.

References PARAM_CFG_BASE::m_Ident, and m_Pt_param.

409 {
410  if( !m_Pt_param || !aConfig )
411  return;
412 
413  aConfig->Write( m_Ident, *m_Pt_param );
414 }
bool * m_Pt_param
Pointer to the parameter value.
wxString m_Ident
Keyword in config data.

Member Data Documentation

int PARAM_CFG_BOOL::m_Default

The default value of the parameter.

Definition at line 242 of file config_params.h.

Referenced by PARAM_CFG_BOOL(), and ReadParam().

wxString PARAM_CFG_BASE::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_BASE::PARAM_CFG_BASE().

wxString PARAM_CFG_BASE::m_Ident_legacy
inherited
bool* PARAM_CFG_BOOL::m_Pt_param

Pointer to the parameter value.

Definition at line 241 of file config_params.h.

Referenced by PARAM_CFG_BOOL(), ReadParam(), and SaveParam().

bool PARAM_CFG_BASE::m_Setup
inherited
paramcfg_id PARAM_CFG_BASE::m_Type
inherited

Type of parameter.

Definition at line 103 of file config_params.h.

Referenced by PARAM_CFG_BASE::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: