KiCad PCB EDA Suite
ENV_VAR_ITEM Class Reference

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

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

87  :
88  m_value( aValue ),
89  m_isDefinedExternally( aIsDefinedExternally )
90  {
91  }
bool m_isDefinedExternally
Flag to indicate if the environment variable was defined externally to the process.
Definition: pgm_base.h:109
wxString m_value
The environment variable string value.
Definition: pgm_base.h:106

◆ ~ENV_VAR_ITEM()

ENV_VAR_ITEM::~ENV_VAR_ITEM ( )
throw (
)
inline

Definition at line 93 of file pgm_base.h.

93 {} // tell SWIG no exception

Member Function Documentation

◆ GetDefinedExternally()

bool ENV_VAR_ITEM::GetDefinedExternally ( ) const
inline

Definition at line 95 of file pgm_base.h.

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

References m_isDefinedExternally.

◆ GetValue()

const wxString& ENV_VAR_ITEM::GetValue ( ) const
inline

Definition at line 101 of file pgm_base.h.

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

References m_value.

Referenced by PGM_BASE::InitPgm().

◆ SetDefinedExternally()

void ENV_VAR_ITEM::SetDefinedExternally ( bool  aIsDefinedExternally)
inline

Definition at line 96 of file pgm_base.h.

97  {
98  m_isDefinedExternally = aIsDefinedExternally;
99  }
bool m_isDefinedExternally
Flag to indicate if the environment variable was defined externally to the process.
Definition: pgm_base.h:109

References m_isDefinedExternally.

Referenced by PGM_BASE::InitPgm(), and DIALOG_CONFIGURE_PATHS::TransferDataFromWindow().

◆ SetValue()

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

Definition at line 102 of file pgm_base.h.

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

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

Referenced by GetValue(), and SetValue().


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