KiCad PCB EDA Suite
PARAM_CFG_WXSTRING_SET Class Reference

Configuration object for a set of wxString objects. More...

#include <config_params.h>

Inheritance diagram for PARAM_CFG_WXSTRING_SET:
PARAM_CFG

Public Member Functions

 PARAM_CFG_WXSTRING_SET (const wxString &ident, std::set< wxString > *ptparam, const wxChar *group=nullptr)
 
 PARAM_CFG_WXSTRING_SET (bool Insetup, const wxString &ident, std::set< wxString > *ptparam, const wxChar *group=nullptr)
 
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

std::set< wxString > * m_Pt_param
 Pointer to the parameter value. 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 a set of wxString objects.

Definition at line 236 of file config_params.h.

Constructor & Destructor Documentation

◆ PARAM_CFG_WXSTRING_SET() [1/2]

PARAM_CFG_WXSTRING_SET::PARAM_CFG_WXSTRING_SET ( const wxString &  ident,
std::set< wxString > *  ptparam,
const wxChar *  group = nullptr 
)

Definition at line 379 of file config_params.cpp.

380  :
382 {
383  m_Pt_param = ptparam;
384 }
PARAM_CFG(const wxString &ident, const paramcfg_id type, const wxChar *group=nullptr, const wxString &legacy_ident=wxEmptyString)
std::set< wxString > * m_Pt_param
Pointer to the parameter value.

References group, and m_Pt_param.

◆ PARAM_CFG_WXSTRING_SET() [2/2]

PARAM_CFG_WXSTRING_SET::PARAM_CFG_WXSTRING_SET ( bool  Insetup,
const wxString &  ident,
std::set< wxString > *  ptparam,
const wxChar *  group = nullptr 
)

Definition at line 387 of file config_params.cpp.

388  :
389  PARAM_CFG( ident, PARAM_WXSTRING, group )
390 {
391  m_Pt_param = ptparam;
392  m_Setup = Insetup;
393 }
bool m_Setup
Install or Project based parameter, true == install.
PARAM_CFG(const wxString &ident, const paramcfg_id type, const wxChar *group=nullptr, const wxString &legacy_ident=wxEmptyString)
std::set< wxString > * m_Pt_param
Pointer to the parameter value.

References group, m_Pt_param, and PARAM_CFG::m_Setup.

Member Function Documentation

◆ ReadParam()

void PARAM_CFG_WXSTRING_SET::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 396 of file config_params.cpp.

397 {
398  if( !m_Pt_param || !aConfig )
399  return;
400 
401  for( int i = 1; true; ++i )
402  {
403  wxString key, data;
404 
405  key = m_Ident;
406  key << i;
407  data = aConfig->Read( key, wxT( "" ) );
408 
409  if( data.IsEmpty() )
410  break;
411 
412  m_Pt_param->insert( data );
413  }
414 }
wxString m_Ident
Keyword in config data.
std::set< wxString > * m_Pt_param
Pointer to the parameter value.

References PARAM_CFG::m_Ident, and m_Pt_param.

◆ SaveParam()

void PARAM_CFG_WXSTRING_SET::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 417 of file config_params.cpp.

418 {
419  if( !m_Pt_param || !aConfig )
420  return;
421 
422  int i = 1;
423 
424  for( const wxString& str : *m_Pt_param )
425  {
426  wxString key, data;
427 
428  key = m_Ident;
429  key << i++;
430 
431  aConfig->Write( key, str );
432  }
433 }
wxString m_Ident
Keyword in config data.
std::set< wxString > * m_Pt_param
Pointer to the parameter value.

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 104 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

std::set<wxString>* PARAM_CFG_WXSTRING_SET::m_Pt_param

Pointer to the parameter value.

Definition at line 250 of file config_params.h.

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

◆ m_Setup

bool PARAM_CFG::m_Setup
inherited

◆ 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: