KiCad PCB EDA Suite
Loading...
Searching...
No Matches
PARAM_PATH Class Reference

Stores a path as a string with directory separators normalized to unix-style. More...

#include <parameters.h>

Inheritance diagram for PARAM_PATH:
PARAM< wxString > PARAM_BASE

Public Member Functions

 PARAM_PATH (const std::string &aJsonPath, wxString *aPtr, const 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...
 
wxString GetDefault () const
 
void SetDefault () override
 
const std::string & GetJsonPath () const
 
bool ClearUnknownKeys () const
 

Protected Attributes

wxString * m_ptr
 
wxString m_default
 
std::string m_path
 Address of the param in the json files. More...
 
bool m_readOnly
 Indicates param pointer should never be overwritten. More...
 
bool m_clearUnknownKeys
 Keys should be cleared from source rather than merged. More...
 

Private Member Functions

wxString toFileFormat (const wxString &aString) const
 
wxString fromFileFormat (const wxString &aString) const
 

Private Attributes

wxString m_min
 
wxString m_max
 
bool m_use_minmax
 

Detailed Description

Stores a path as a string with directory separators normalized to unix-style.

Definition at line 173 of file parameters.h.

Constructor & Destructor Documentation

◆ PARAM_PATH()

PARAM_PATH::PARAM_PATH ( const std::string &  aJsonPath,
wxString *  aPtr,
const wxString &  aDefault,
bool  aReadOnly = false 
)
inline

Definition at line 176 of file parameters.h.

Member Function Documentation

◆ ClearUnknownKeys()

bool PARAM_BASE::ClearUnknownKeys ( ) const
inlineinherited
Returns
true if keys should be cleared from source file rather than merged. Useful for things such as text variables that are semantically an array but stored as a map.

Definition at line 79 of file parameters.h.

◆ fromFileFormat()

wxString PARAM_PATH::fromFileFormat ( const wxString &  aString) const
inlineprivate

Definition at line 212 of file parameters.h.

◆ GetDefault()

wxString PARAM< wxString >::GetDefault ( ) const
inlineinherited

Definition at line 142 of file parameters.h.

◆ GetJsonPath()

const std::string & PARAM_BASE::GetJsonPath ( ) const
inlineinherited
Returns
the path name of the parameter used to store it in the json file mainly useful in error messages

Definition at line 73 of file parameters.h.

◆ Load()

void PARAM_PATH::Load ( JSON_SETTINGS aSettings,
bool  aResetIfMissing = true 
) const
inlineoverridevirtual

Loads the value of this parameter from JSON to the underlying storage.

Parameters
aSettingsis the JSON_SETTINGS object to load from.
aResetIfMissingif true will set the parameter to its default value if load fails

Implements PARAM_BASE.

Definition at line 181 of file parameters.h.

◆ MatchesFile()

bool PARAM_PATH::MatchesFile ( JSON_SETTINGS aSettings) const
inlineoverridevirtual

Checks whether the parameter in memory matches the one in a given JSON file.

Parameters
aSettingsis a JSON_SETTINGS to check the JSON file contents of
Returns
true if the parameter in memory matches its value in the file

Implements PARAM_BASE.

Definition at line 196 of file parameters.h.

References JSON_SETTINGS::Get().

◆ SetDefault()

void PARAM< wxString >::SetDefault ( )
inlineoverridevirtualinherited

Implements PARAM_BASE.

Definition at line 147 of file parameters.h.

◆ Store()

void PARAM_PATH::Store ( JSON_SETTINGS aSettings) const
inlineoverridevirtual

Stores the value of this parameter to the given JSON_SETTINGS object.

Parameters
aSettingsis the JSON_SETTINGS object to store into.

Implements PARAM_BASE.

Definition at line 191 of file parameters.h.

References JSON_SETTINGS::Set().

◆ toFileFormat()

wxString PARAM_PATH::toFileFormat ( const wxString &  aString) const
inlineprivate

Definition at line 205 of file parameters.h.

Member Data Documentation

◆ m_clearUnknownKeys

bool PARAM_BASE::m_clearUnknownKeys
protectedinherited

Keys should be cleared from source rather than merged.

This is useful for things that are semantically an array but stored as a map, such as textVars.

Definition at line 84 of file parameters.h.

◆ m_default

wxString PARAM< wxString >::m_default
protectedinherited

Definition at line 167 of file parameters.h.

◆ m_max

wxString PARAM< wxString >::m_max
privateinherited

Definition at line 162 of file parameters.h.

◆ m_min

wxString PARAM< wxString >::m_min
privateinherited

Definition at line 161 of file parameters.h.

◆ m_path

◆ m_ptr

wxString * PARAM< wxString >::m_ptr
protectedinherited

Definition at line 166 of file parameters.h.

◆ m_readOnly

bool PARAM_BASE::m_readOnly
protectedinherited

◆ m_use_minmax

bool PARAM< wxString >::m_use_minmax
privateinherited

Definition at line 163 of file parameters.h.


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