KiCad PCB EDA Suite
ENV_VAR_ITEM Class Reference

Class ENV_VAR_ITEM. More...

#include <pgm_base.h>

Public Member Functions

 ENV_VAR_ITEM (const wxString &aValue=wxEmptyString, bool aIsDefinedExternally=false)
 
 ~ENV_VAR_ITEM () throw ()
 
bool GetDefinedExternally () const
 
void SetDefinedExternally (bool aIsDefinedExternally)
 
const wxString & GetValue () const
 
void SetValue (const wxString &aValue)
 

Private Attributes

wxString m_value
 The environment variable string value. More...
 
bool m_isDefinedExternally
 Flag to indicate if the environment variable was defined externally to the process. More...
 

Detailed Description

Class ENV_VAR_ITEM.

is a simple helper class to store environment variable values and the status of whether or not they were defined externally to the process created when any of the KiCad applications was launched.

Definition at line 100 of file pgm_base.h.

Constructor & Destructor Documentation

ENV_VAR_ITEM::ENV_VAR_ITEM ( const wxString &  aValue = wxEmptyString,
bool  aIsDefinedExternally = false 
)
inline

Definition at line 103 of file pgm_base.h.

103  :
104  m_value( aValue ),
105  m_isDefinedExternally( aIsDefinedExternally )
106  {
107  }
bool m_isDefinedExternally
Flag to indicate if the environment variable was defined externally to the process.
Definition: pgm_base.h:125
wxString m_value
The environment variable string value.
Definition: pgm_base.h:122
ENV_VAR_ITEM::~ENV_VAR_ITEM ( )
throw (
)
inline

Definition at line 109 of file pgm_base.h.

109 {} // tell SWIG no exception

Member Function Documentation

bool ENV_VAR_ITEM::GetDefinedExternally ( ) const
inline

Definition at line 111 of file pgm_base.h.

111 { return m_isDefinedExternally; }
bool m_isDefinedExternally
Flag to indicate if the environment variable was defined externally to the process.
Definition: pgm_base.h:125
const wxString& ENV_VAR_ITEM::GetValue ( ) const
inline

Definition at line 117 of file pgm_base.h.

117 { return m_value; }
wxString m_value
The environment variable string value.
Definition: pgm_base.h:122
void ENV_VAR_ITEM::SetDefinedExternally ( bool  aIsDefinedExternally)
inline

Definition at line 112 of file pgm_base.h.

Referenced by PGM_BASE::InitPgm().

113  {
114  m_isDefinedExternally = aIsDefinedExternally;
115  }
bool m_isDefinedExternally
Flag to indicate if the environment variable was defined externally to the process.
Definition: pgm_base.h:125
void ENV_VAR_ITEM::SetValue ( const wxString &  aValue)
inline

Definition at line 118 of file pgm_base.h.

Referenced by PGM_BASE::InitPgm().

118 { m_value = aValue; }
wxString m_value
The environment variable string value.
Definition: pgm_base.h:122

Member Data Documentation

bool ENV_VAR_ITEM::m_isDefinedExternally
private

Flag to indicate if the environment variable was defined externally to the process.

Definition at line 125 of file pgm_base.h.

wxString ENV_VAR_ITEM::m_value
private

The environment variable string value.

Definition at line 122 of file pgm_base.h.


The documentation for this class was generated from the following file: