KiCad PCB EDA Suite
Loading...
Searching...
No Matches
PARAM_CFG_FILENAME Class Reference

Configuration object for a file name object. More...

#include <config_params.h>

Inheritance diagram for PARAM_CFG_FILENAME:
PARAM_CFG

Public Member Functions

 PARAM_CFG_FILENAME (const wxString &ident, wxString *ptparam, const wxChar *group=nullptr)
 
virtual void ReadParam (wxConfigBase *aConfig) const override
 Read the value of the parameter stored in aConfig.
 
virtual void SaveParam (wxConfigBase *aConfig) const override
 Save the value of the parameter stored in aConfig.
 

Public Attributes

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

Configuration object for a file name object.

Same as PARAM_CFG_WXSTRING but stores "\" as "/" and replace "/" by "" under Windows.

Definition at line 257 of file config_params.h.

Constructor & Destructor Documentation

◆ PARAM_CFG_FILENAME()

PARAM_CFG_FILENAME::PARAM_CFG_FILENAME ( const wxString &  ident,
wxString *  ptparam,
const wxChar *  group = nullptr 
)

Definition at line 435 of file config_params.cpp.

References m_Pt_param.

Member Function Documentation

◆ ReadParam()

void PARAM_CFG_FILENAME::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.

Definition at line 444 of file config_params.cpp.

References PARAM_CFG::m_Ident, and m_Pt_param.

◆ SaveParam()

void PARAM_CFG_FILENAME::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.

Definition at line 460 of file config_params.cpp.

References PARAM_CFG::m_Ident, and m_Pt_param.

Member Data Documentation

◆ m_Group

wxString PARAM_CFG::m_Group
inherited

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

Definition at line 102 of file config_params.h.

Referenced by PARAM_CFG::PARAM_CFG().

◆ m_Ident

◆ m_Ident_legacy

wxString PARAM_CFG::m_Ident_legacy
inherited

◆ m_Pt_param

wxString* PARAM_CFG_FILENAME::m_Pt_param

Pointer to the parameter value.

Definition at line 265 of file config_params.h.

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

◆ m_Setup

◆ m_Type

paramcfg_id PARAM_CFG::m_Type
inherited

Type of parameter.

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