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 117 of file pgm_base.h.

Constructor & Destructor Documentation

◆ ENV_VAR_ITEM()

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

Definition at line 120 of file pgm_base.h.

120  :
121  m_value( aValue ),
122  m_isDefinedExternally( aIsDefinedExternally )
123  {
124  }
bool m_isDefinedExternally
Flag to indicate if the environment variable was defined externally to the process.
Definition: pgm_base.h:142
wxString m_value
The environment variable string value.
Definition: pgm_base.h:139

◆ ~ENV_VAR_ITEM()

ENV_VAR_ITEM::~ENV_VAR_ITEM ( )
throw (
)
inline

Definition at line 126 of file pgm_base.h.

126 {} // tell SWIG no exception

Member Function Documentation

◆ GetDefinedExternally()

bool ENV_VAR_ITEM::GetDefinedExternally ( ) const
inline

Definition at line 128 of file pgm_base.h.

128 { return m_isDefinedExternally; }
bool m_isDefinedExternally
Flag to indicate if the environment variable was defined externally to the process.
Definition: pgm_base.h:142

References m_isDefinedExternally.

◆ GetValue()

const wxString& ENV_VAR_ITEM::GetValue ( ) const
inline

Definition at line 134 of file pgm_base.h.

134 { return m_value; }
wxString m_value
The environment variable string value.
Definition: pgm_base.h:139

References m_value.

◆ SetDefinedExternally()

void ENV_VAR_ITEM::SetDefinedExternally ( bool  aIsDefinedExternally)
inline

Definition at line 129 of file pgm_base.h.

130  {
131  m_isDefinedExternally = aIsDefinedExternally;
132  }
bool m_isDefinedExternally
Flag to indicate if the environment variable was defined externally to the process.
Definition: pgm_base.h:142

References m_isDefinedExternally.

Referenced by PGM_BASE::InitPgm().

◆ SetValue()

void ENV_VAR_ITEM::SetValue ( const wxString &  aValue)
inline

Definition at line 135 of file pgm_base.h.

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

References m_value.

Referenced by PGM_BASE::InitPgm().

Member Data Documentation

◆ m_isDefinedExternally

bool ENV_VAR_ITEM::m_isDefinedExternally
private

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

Definition at line 142 of file pgm_base.h.

Referenced by GetDefinedExternally(), and SetDefinedExternally().

◆ m_value

wxString ENV_VAR_ITEM::m_value
private

The environment variable string value.

Definition at line 139 of file pgm_base.h.

Referenced by GetValue(), and SetValue().


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