KiCad PCB EDA Suite
PARAM_CFG_LIBNAME_LIST Class Reference

#include <config_params.h>

Inheritance diagram for PARAM_CFG_LIBNAME_LIST:
PARAM_CFG_BASE

Public Member Functions

 PARAM_CFG_LIBNAME_LIST (const wxChar *ident, wxArrayString *ptparam, 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

wxArrayString * 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...
 

Detailed Description

Definition at line 290 of file config_params.h.

Constructor & Destructor Documentation

PARAM_CFG_LIBNAME_LIST::PARAM_CFG_LIBNAME_LIST ( const wxChar *  ident,
wxArrayString *  ptparam,
const wxChar *  group = NULL 
)

Definition at line 477 of file config_params.cpp.

References m_Pt_param.

479  :
480  PARAM_CFG_BASE( ident, PARAM_LIBNAME_LIST, group )
481 {
482  m_Pt_param = ptparam;
483 }
wxArrayString * m_Pt_param
Pointer to the parameter value.
PARAM_CFG_BASE(const wxString &ident, const paramcfg_id type, const wxChar *group=NULL)

Member Function Documentation

void PARAM_CFG_LIBNAME_LIST::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 486 of file config_params.cpp.

References PARAM_CFG_BASE::m_Ident, and m_Pt_param.

487 {
488  if( !m_Pt_param || !aConfig )
489  return;
490 
491  int indexlib = 1; // We start indexlib to 1 because first
492  // lib name is LibName1
493  wxString libname, id_lib;
494  wxArrayString* libname_list = m_Pt_param;
495 
496  while( 1 )
497  {
498  id_lib = m_Ident;
499  id_lib << indexlib;
500  indexlib++;
501  libname = aConfig->Read( id_lib, wxT( "" ) );
502 
503  if( libname.IsEmpty() )
504  break;
505  // file names are stored using Unix notation
506  // under Window we must use \ instead of /
507  // mainly if there is a server name in path (something like \\server\kicad)
508 #ifdef __WINDOWS__
509  libname.Replace(wxT("/"), wxT("\\"));
510 #endif
511  libname_list->Add( libname );
512  }
513 }
wxArrayString * m_Pt_param
Pointer to the parameter value.
wxString m_Ident
Keyword in config data.
Definition: config_params.h:97
void PARAM_CFG_LIBNAME_LIST::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 516 of file config_params.cpp.

References PARAM_CFG_BASE::m_Ident, and m_Pt_param.

517 {
518  if( !m_Pt_param || !aConfig )
519  return;
520 
521  wxArrayString* libname_list = m_Pt_param;
522 
523  wxString configkey;
524  wxString libname;
525 
526  for( unsigned indexlib = 0; indexlib < libname_list->GetCount(); indexlib++ )
527  {
528  configkey = m_Ident;
529 
530  // We use indexlib+1 because first lib name is LibName1
531  configkey << (indexlib + 1);
532  libname = libname_list->Item( indexlib );
533 
534  // filenames are stored using Unix notation
535  libname.Replace(wxT("\\"), wxT("/") );
536  aConfig->Write( configkey, libname );
537  }
538 }
wxArrayString * m_Pt_param
Pointer to the parameter value.
wxString m_Ident
Keyword in config data.
Definition: config_params.h:97

Member Data Documentation

wxString PARAM_CFG_BASE::m_Group
inherited

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

wxArrayString* PARAM_CFG_LIBNAME_LIST::m_Pt_param

Pointer to the parameter value.

Definition at line 293 of file config_params.h.

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

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

Type of parameter.

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