![]() |
KiCad PCB EDA Suite
|
Represents a list of strings holding directory paths. More...
#include <parameters.h>
Public Member Functions | |
PARAM_PATH_LIST (const std::string &aJsonPath, std::vector< wxString > *aPtr, std::initializer_list< wxString > aDefault, bool aReadOnly=false) | |
PARAM_PATH_LIST (const std::string &aJsonPath, std::vector< wxString > *aPtr, std::vector< wxString > aDefault, bool aReadOnly=false) | |
void | Load (JSON_SETTINGS *aSettings, bool aResetIfMissing=true) const override |
Loads the value of this parameter from JSON to the underlying storage. More... | |
void | Store (JSON_SETTINGS *aSettings) const override |
Stores the value of this parameter to the given JSON_SETTINGS object. More... | |
bool | MatchesFile (JSON_SETTINGS *aSettings) const override |
Checks whether the parameter in memory matches the one in a given JSON file. More... | |
void | SetDefault () override |
bool | IsDefault () const override |
Checks whether or not this param has been changed from its default value. More... | |
const std::string & | GetJsonPath () const |
Protected Attributes | |
std::vector< wxString > * | m_ptr |
std::vector< wxString > | m_default |
std::string | m_path |
the string used to store the param in json files More... | |
bool | m_readOnly |
! True if the parameter pointer should never be overwritten More... | |
Private Member Functions | |
wxString | toFileFormat (const wxString &aString) const |
wxString | fromFileFormat (const wxString &aString) const |
Represents a list of strings holding directory paths.
Normalizes paths to unix directory separator style in the file.
Definition at line 560 of file parameters.h.
|
inline |
Definition at line 563 of file parameters.h.
|
inline |
Definition at line 568 of file parameters.h.
|
inlineprivate |
|
inlineinherited |
Definition at line 74 of file parameters.h.
References PARAM_BASE::m_path.
|
inlineoverridevirtualinherited |
Checks whether or not this param has been changed from its default value.
Implements PARAM_BASE.
Definition at line 527 of file parameters.h.
|
inlineoverridevirtual |
Loads the value of this parameter from JSON to the underlying storage.
aSettings | is the JSON_SETTINGS object to load from. |
aResetIfMissing | if true will set the parameter to its default value if load fails |
Implements PARAM_BASE.
Definition at line 573 of file parameters.h.
References fromFileFormat(), PARAM_LIST< Type >::Load(), PARAM_LIST< wxString >::m_ptr, and PARAM_BASE::m_readOnly.
|
inlineoverridevirtual |
Checks whether the parameter in memory matches the one in a given JSON file.
aSettings | is a JSON_SETTINGS to check the JSON file contents of |
Implements PARAM_BASE.
Definition at line 594 of file parameters.h.
References fromFileFormat(), JSON_SETTINGS::GetJson(), PARAM_BASE::m_path, and PARAM_LIST< wxString >::m_ptr.
|
inlineoverridevirtualinherited |
|
inlineoverridevirtual |
Stores the value of this parameter to the given JSON_SETTINGS object.
aSettings | is the JSON_SETTINGS object to store into. |
Implements PARAM_BASE.
Definition at line 584 of file parameters.h.
References PARAM_BASE::m_path, PARAM_LIST< wxString >::m_ptr, JSON_SETTINGS::Set(), and toFileFormat().
|
inlineprivate |
Definition at line 613 of file parameters.h.
Referenced by Store().
|
protectedinherited |
Definition at line 553 of file parameters.h.
|
protectedinherited |
the string used to store the param in json files
Definition at line 80 of file parameters.h.
Referenced by PARAM_BASE::GetJsonPath(), PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_LIST< wxString >::MatchesFile(), MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), PARAM< wxString >::Store(), COLOR_MAP_PARAM::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< nlohmann::json >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< wxString >::Store(), Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().
|
protectedinherited |
Definition at line 551 of file parameters.h.
|
protectedinherited |
! True if the parameter pointer should never be overwritten
Definition at line 83 of file parameters.h.
Referenced by PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_PATH::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_LIST< wxString >::Load(), Load(), PARAM_MAP< Value >::Load(), and PARAM_WXSTRING_MAP::Load().