KiCad PCB EDA Suite
|
Typedefs | |
using | ENV_VAR_LIST = std::vector< wxString > |
Functions | |
bool | IsEnvVarImmutable (const wxString &aEnvVar) |
Determine if an environment variable is "predefined", i.e. More... | |
const ENV_VAR_LIST & | GetPredefinedEnvVars () |
Get the list of pre-defined environment variables. More... | |
wxString | LookUpEnvVarHelp (const wxString &aEnvVar) |
Look up long-form help text for a given environment variable. More... | |
template<typename VAL_TYPE > | |
std::optional< VAL_TYPE > | GetEnvVar (const wxString &aEnvVarName) |
Get an environment variable as a specific type, if set correctly. More... | |
template<> | |
std::optional< wxString > | GetEnvVar (const wxString &aEnvVarName) |
Get a string environment variable, if it is set. More... | |
template<> | |
std::optional< double > | GetEnvVar (const wxString &aEnvVarName) |
Get a double from an environment variable, if set. More... | |
using ENV_VAR::ENV_VAR_LIST = typedef std::vector<wxString> |
Definition at line 34 of file env_vars.h.
std::optional< VAL_TYPE > ENV_VAR::GetEnvVar | ( | const wxString & | aEnvVarName | ) |
Get an environment variable as a specific type, if set correctly.
aEnvVarName | the name of the environment variable |
std::optional< wxString > ENV_VAR::GetEnvVar | ( | const wxString & | aEnvVarName | ) |
Get a string environment variable, if it is set.
aEnvVarName | the name of the environment variable |
Definition at line 120 of file env_vars.cpp.
std::optional< double > ENV_VAR::GetEnvVar | ( | const wxString & | aEnvVarName | ) |
Get a double from an environment variable, if set.
aEnvVarName | the name of the environment variable |
const ENV_VAR::ENV_VAR_LIST & ENV_VAR::GetPredefinedEnvVars | ( | ) |
Get the list of pre-defined environment variables.
Definition at line 60 of file env_vars.cpp.
References predefinedEnvVars.
Referenced by KIwxExpandEnvVars(), and DIALOG_CONFIGURE_PATHS::OnHelp().
bool ENV_VAR::IsEnvVarImmutable | ( | const wxString & | aEnvVar | ) |
Determine if an environment variable is "predefined", i.e.
if the name of the variable is special to KiCad, and isn't just a user-specified substitution name.
aEnvVar | the variable to check |
Definition at line 48 of file env_vars.cpp.
References predefinedEnvVars.
Referenced by DIALOG_CONFIGURE_PATHS::AppendEnvVar(), and DIALOG_CONFIGURE_PATHS::OnRemoveEnvVar().
wxString ENV_VAR::LookUpEnvVarHelp | ( | const wxString & | aEnvVar | ) |
Look up long-form help text for a given environment variable.
This is intended for use in more verbose help resources (as opposed to tooltip text)
aEnvVar | The variable to look up |
Definition at line 108 of file env_vars.cpp.
References initialiseEnvVarHelp().
Referenced by DIALOG_CONFIGURE_PATHS::OnHelp().