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

APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application. More...

#include <app_settings.h>

Inheritance diagram for APP_SETTINGS_BASE:
JSON_SETTINGS BITMAP2CMP_SETTINGS EDA_3D_VIEWER_SETTINGS EESCHEMA_SETTINGS GERBVIEW_SETTINGS KICAD_SETTINGS PCB_CALCULATOR_SETTINGS PCB_VIEWERS_SETTINGS_BASE PL_EDITOR_SETTINGS SYMBOL_EDITOR_SETTINGS

Classes

struct  COLOR_PICKER
 
struct  FIND_REPLACE
 
struct  GRAPHICS
 
struct  LIB_TREE
 
struct  PRINTING
 
struct  SEARCH_PANE
 
struct  SYSTEM
 

Public Member Functions

 APP_SETTINGS_BASE (const std::string &aFilename, int aSchemaVersion)
 
virtual ~APP_SETTINGS_BASE ()
 
virtual bool MigrateFromLegacy (wxConfigBase *aCfg) override
 Migrates from wxConfig to JSON-based configuration.
 
const std::vector< GRIDDefaultGridSizeList () const
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
void SetFilename (const wxString &aFilename)
 
void SetLocation (SETTINGS_LOC aLocation)
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const wxString &aFilename)
 
bool IsReadOnly () const
 
void SetReadOnly (bool aReadOnly)
 
nlohmann::json & At (const std::string &aPath)
 Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally.
 
bool Contains (const std::string &aPath) const
 
JSON_SETTINGS_INTERNALSInternals ()
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents.
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER.
 
virtual bool LoadFromFile (const wxString &aDirectory="")
 Loads the backing file from disk and then calls Load()
 
virtual bool SaveToFile (const wxString &aDirectory="", bool aForce=false)
 Calls Store() and then writes the contents of the JSON document to a file.
 
void ResetToDefaults ()
 Resets all parameters to default values.
 
std::optional< nlohmann::json > GetJson (const std::string &aPath) const
 Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects.
 
template<typename ValueType >
std::optional< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document.
 
template<>
std::optional< wxString > Get (const std::string &aPath) const
 
template<typename ValueType >
void Set (const std::string &aPath, ValueType aVal)
 Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
KICOMMON_API void Set (const std::string &aPath, wxString aVal)
 
bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version.
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object.
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one.
 
void SetManager (SETTINGS_MANAGER *aManager)
 
const std::string FormatAsString ()
 
bool LoadFromRawFile (const wxString &aPath)
 

Static Public Member Functions

static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
 Sets the given string if the given key/path is present.
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
 Sets the given bool if the given key/path is present.
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
 Sets the given int if the given key/path is present.
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, unsigned int &aTarget)
 Sets the given unsigned int if the given key/path is present.
 

Public Attributes

CROSS_PROBING_SETTINGS m_CrossProbing
 
FIND_REPLACE m_FindReplace
 
GRAPHICS m_Graphics
 
COLOR_PICKER m_ColorPicker
 
LIB_TREE m_LibTree
 
PRINTING m_Printing
 
SEARCH_PANE m_SearchPane
 
SYSTEM m_System
 
WINDOW_SETTINGS m_Window
 
wxString m_ColorTheme
 Active color theme name.
 
int m_appSettingsSchemaVersion
 ! Local schema version for common app settings
 

Protected Member Functions

virtual std::string getLegacyFrameName () const
 
void migrateFindReplace (wxConfigBase *aCfg)
 ! Migrates the find/replace history string lists
 
bool migrateWindowConfig (wxConfigBase *aCfg, const std::string &aFrameName, const std::string &aJsonPath)
 Migrates legacy window settings into the JSON document.
 
void addParamsForWindow (WINDOW_SETTINGS *aWindow, const std::string &aJsonPath)
 Adds parameters for the given window object.
 
bool migrateLibTreeWidth ()
 Migrates the library tree width setting from a single column (Item) to multi-column.
 
void registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
 Registers a migration from one schema version to another.
 
template<typename ValueType >
bool fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig value to a given JSON pointer value.
 
bool fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig string value to a given JSON pointer value.
 
bool fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.
 
virtual wxString getFileExt () const
 
virtual wxString getLegacyFileExt () const
 

Static Protected Member Functions

template<typename ResultType >
static ResultType fetchOrDefault (const nlohmann::json &aJson, const std::string &aKey, ResultType aDefault=ResultType())
 Helper to retrieve a value from a JSON object (dictionary) as a certain result type.
 

Protected Attributes

wxString m_filename
 The filename (not including path) of this settings file (inicode)
 
wxString m_legacy_filename
 The filename of the wxConfig legacy file (if different from m_filename)
 
SETTINGS_LOC m_location
 The location of this settings file (.
 
std::vector< PARAM_BASE * > m_params
 The list of parameters (owned by this object)
 
std::vector< NESTED_SETTINGS * > m_nested_settings
 Nested settings files that live inside this one, if any.
 
bool m_createIfMissing
 Whether or not the backing store file should be created it if doesn't exist.
 
bool m_createIfDefault
 Whether or not the backing store file should be created if all parameters are still at their default values.
 
bool m_writeFile
 Whether or not the backing store file should be written.
 
bool m_modified
 True if the JSON data store has been written to since the last file write.
 
bool m_deleteLegacyAfterMigration
 Whether or not to delete legacy file after migration.
 
bool m_resetParamsIfMissing
 Whether or not to set parameters to their default value if missing from JSON on Load()
 
int m_schemaVersion
 Version of this settings schema.
 
SETTINGS_MANAGERm_manager
 A pointer to the settings manager managing this file (may be null)
 
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
 A map of starting schema version to a pair of <ending version, migrator function>
 
std::unique_ptr< JSON_SETTINGS_INTERNALSm_internals
 

Detailed Description

APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.

It stores settings that should exist for every app, but may be different from app to app depending on the user's preferences.

COMMON_SETTINGS stores settings that are always the same across all applications.

Definition at line 91 of file app_settings.h.

Constructor & Destructor Documentation

◆ APP_SETTINGS_BASE()

APP_SETTINGS_BASE::APP_SETTINGS_BASE ( const std::string &  aFilename,
int  aSchemaVersion 
)

Definition at line 34 of file app_settings.cpp.

References addParamsForWindow(), CROSS_PROBING_SETTINGS::auto_highlight, APP_SETTINGS_BASE::PRINTING::background, APP_SETTINGS_BASE::GRAPHICS::canvas_type, CROSS_PROBING_SETTINGS::center_on_items, COLOR_SETTINGS::COLOR_BUILTIN_DEFAULT, APP_SETTINGS_BASE::PRINTING::color_theme, APP_SETTINGS_BASE::LIB_TREE::column_widths, APP_SETTINGS_BASE::LIB_TREE::columns, APP_SETTINGS_BASE::COLOR_PICKER::default_tab, APP_SETTINGS_BASE::SYSTEM::file_history, APP_SETTINGS_BASE::FIND_REPLACE::find_history, APP_SETTINGS_BASE::FIND_REPLACE::find_string, APP_SETTINGS_BASE::SYSTEM::first_run_shown, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, APP_SETTINGS_BASE::GRAPHICS::highlight_factor, APP_SETTINGS_BASE::SYSTEM::last_imperial_units, APP_SETTINGS_BASE::SYSTEM::last_metric_units, APP_SETTINGS_BASE::PRINTING::layers, m_ColorPicker, m_ColorTheme, m_CrossProbing, JSON_SETTINGS::m_filename, m_FindReplace, m_Graphics, m_LibTree, JSON_SETTINGS::m_params, m_Printing, m_SearchPane, m_System, m_Window, APP_SETTINGS_BASE::FIND_REPLACE::match_case, APP_SETTINGS_BASE::FIND_REPLACE::match_mode, APP_SETTINGS_BASE::SYSTEM::max_undo_items, APP_SETTINGS_BASE::PRINTING::monochrome, CROSS_PROBING_SETTINGS::on_selection, APP_SETTINGS_BASE::LIB_TREE::open_libs, APP_SETTINGS_BASE::SEARCH_PANE::PAN, APP_SETTINGS_BASE::FIND_REPLACE::replace_history, APP_SETTINGS_BASE::FIND_REPLACE::replace_string, APP_SETTINGS_BASE::PRINTING::scale, APP_SETTINGS_BASE::FIND_REPLACE::search_and_replace, APP_SETTINGS_BASE::GRAPHICS::select_factor, APP_SETTINGS_BASE::SEARCH_PANE::selection_zoom, APP_SETTINGS_BASE::SYSTEM::show_import_issues, APP_SETTINGS_BASE::PRINTING::title_block, APP_SETTINGS_BASE::SYSTEM::units, APP_SETTINGS_BASE::PRINTING::use_theme, and CROSS_PROBING_SETTINGS::zoom_to_fit.

◆ ~APP_SETTINGS_BASE()

virtual APP_SETTINGS_BASE::~APP_SETTINGS_BASE ( )
inlinevirtual

Definition at line 163 of file app_settings.h.

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

Can be used to construct a NESTED_SETTINGS without the parent object needing to know about the implementation of the nested object;

Parameters
aSettingsis the settings object to take ownership of
aTargetis a pointer to update to the passed in settings

Definition at line 870 of file json_settings.cpp.

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.

Referenced by NESTED_SETTINGS::SetParent().

◆ addParamsForWindow()

void APP_SETTINGS_BASE::addParamsForWindow ( WINDOW_SETTINGS aWindow,
const std::string &  aJsonPath 
)
protected

◆ At()

nlohmann::json & JSON_SETTINGS::At ( const std::string &  aPath)
inherited

Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally.

Definition at line 118 of file json_settings.cpp.

References JSON_SETTINGS::m_internals.

Referenced by EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().

◆ Contains()

◆ DefaultGridSizeList()

const std::vector< GRID > APP_SETTINGS_BASE::DefaultGridSizeList ( ) const

◆ fetchOrDefault()

template<typename ResultType >
template KICOMMON_API bool JSON_SETTINGS::fetchOrDefault ( const nlohmann::json &  aJson,
const std::string &  aKey,
ResultType  aDefault = ResultType() 
)
staticprotectedinherited

Helper to retrieve a value from a JSON object (dictionary) as a certain result type.

Template Parameters
ResultTypeis the type of the retrieved value.
Parameters
aJsonis the object to act on .
aKeyis the object key to retrieve the value for.
Returns
the result, or aDefault if aKey is not found.

Definition at line 916 of file json_settings.cpp.

◆ FormatAsString()

const std::string JSON_SETTINGS::FormatAsString ( )
inherited

◆ fromLegacy()

template<typename ValueType >
template KICOMMON_API bool JSON_SETTINGS::fromLegacy< bool > ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy wxConfig value to a given JSON pointer value.

Template Parameters
ValueTypeis the basic type of the value
Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 782 of file json_settings.cpp.

◆ fromLegacyColor()

bool JSON_SETTINGS::fromLegacyColor ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.

Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 842 of file json_settings.cpp.

References color.

Referenced by migrateWindowConfig().

◆ fromLegacyString()

bool JSON_SETTINGS::fromLegacyString ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy wxConfig string value to a given JSON pointer value.

Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 818 of file json_settings.cpp.

Referenced by PROJECT_FILE::MigrateFromLegacy(), MigrateFromLegacy(), BITMAP2CMP_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), and migrateWindowConfig().

◆ Get() [1/2]

template<>
template std::optional< wxAuiPaneInfo > JSON_SETTINGS::Get< wxAuiPaneInfo > ( const std::string &  aPath) const
inherited

Definition at line 900 of file json_settings.cpp.

References JSON_SETTINGS::GetJson().

◆ Get() [2/2]

template<typename ValueType >
template KICOMMON_API std::optional< wxAuiPaneInfo > JSON_SETTINGS::Get< wxAuiPaneInfo > ( const std::string &  aPath) const
inherited

Fetches a value from within the JSON document.

Will return an empty optional if the value is not found or a mismatching type.

Template Parameters
ValueTypeis the type to cast to
Parameters
aPathis the path within the document to retrieve
Returns
a value from within this document

Definition at line 580 of file json_settings.cpp.

References JSON_SETTINGS::GetJson().

Referenced by COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< ValueType >::Load(), PARAM_SCALED< ValueType >::Load(), COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

◆ GetFilename()

◆ GetFullFilename()

◆ GetJson()

std::optional< nlohmann::json > JSON_SETTINGS::GetJson ( const std::string &  aPath) const
inherited

Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects.

Parameters
aPathis a string containing one or more keys separated by '.'
Returns
a JSON object from within this one

Definition at line 560 of file json_settings.cpp.

References JSON_SETTINGS::m_internals.

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), PARAM_SET< Type >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_SET< Type >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), SETTINGS_MANAGER::SaveColorSettings(), and NESTED_SETTINGS::SaveToFile().

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 287 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

virtual std::string APP_SETTINGS_BASE::getLegacyFrameName ( ) const
inlineprotectedvirtual

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

◆ IsReadOnly()

◆ Load()

◆ LoadFromFile()

◆ LoadFromRawFile()

bool JSON_SETTINGS::LoadFromRawFile ( const wxString &  aPath)
inherited

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
inherited

Migrates the schema of this settings from the version in the file to the latest version.

Schema migration doesn't need to be used every time a setting is added! This is intended to be more of an "escape hatch" in the event that we decide to move settings around or make other changes to a settings file format that can't simply be handled by loading a new default

Returns
true if migration was successful

Definition at line 677 of file json_settings.cpp.

References JSON_SETTINGS::m_internals, JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, and traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile(), and NESTED_SETTINGS::LoadFromFile().

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protected

! Migrates the find/replace history string lists

Definition at line 253 of file app_settings.cpp.

References JSON_SETTINGS::Set().

Referenced by MigrateFromLegacy().

◆ MigrateFromLegacy()

◆ migrateLibTreeWidth()

bool APP_SETTINGS_BASE::migrateLibTreeWidth ( )
protected

◆ migrateWindowConfig()

bool APP_SETTINGS_BASE::migrateWindowConfig ( wxConfigBase *  aCfg,
const std::string &  aFrameName,
const std::string &  aJsonPath 
)
protected

Migrates legacy window settings into the JSON document.

Parameters
aCfgis the wxConfig object to read from
aFrameNameis the prefix for window settings in the legacy config file
aJsonPathis the prefix for storing window settings in the JSON file
Returns
true if all settings were migrated

Definition at line 277 of file app_settings.cpp.

References JSON_SETTINGS::fromLegacyColor(), and JSON_SETTINGS::fromLegacyString().

Referenced by MigrateFromLegacy(), CVPCB_SETTINGS::MigrateFromLegacy(), and PCBNEW_SETTINGS::MigrateFromLegacy().

◆ registerMigration()

void JSON_SETTINGS::registerMigration ( int  aOldSchemaVersion,
int  aNewSchemaVersion,
std::function< bool(void)>  aMigrator 
)
protectedinherited

Registers a migration from one schema version to another.

If the schema version in the file loaded from disk is less than the schema version of the JSON_SETTINGS class, migration functions will be called one after the other until the data is up-to-date.

Parameters
aOldSchemaVersionis the starting schema version for this migration
aNewSchemaVersionis the ending schema version for this migration
aMigratoris a function that performs the migration and returns true if successful

Definition at line 668 of file json_settings.cpp.

References JSON_SETTINGS::m_migrators, and JSON_SETTINGS::m_schemaVersion.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Saves and frees a nested settings object, if it exists within this one.

Parameters
aSettingsis a pointer to a NESTED_SETTINGS that has already been added to this one

Definition at line 877 of file json_settings.cpp.

References JSON_SETTINGS::m_manager, JSON_SETTINGS::m_modified, JSON_SETTINGS::m_nested_settings, NESTED_SETTINGS::SetParent(), and traceSettings.

Referenced by BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 387 of file json_settings.cpp.

References JSON_SETTINGS::m_params.

Referenced by EDA_3D_VIEWER_FRAME::Process_Special_Functions(), PANEL_COMMON_SETTINGS::ResetPanel(), and PANEL_MOUSE_SETTINGS::ResetPanel().

◆ SaveToFile()

◆ Set() [1/3]

template<typename ValueType >
template KICOMMON_API void JSON_SETTINGS::Set< wxAuiPaneInfo > ( const std::string &  aPath,
ValueType  aVal 
)
inherited

Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.

Template Parameters
ValueTypeis the type to store
Parameters
aPathis a path to store in the form "key1.key2.key3"
aValis the value to store

Definition at line 631 of file json_settings.cpp.

References JSON_SETTINGS::m_internals.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), BOARD_DESIGN_SETTINGS::LoadFromFile(), migrateFindReplace(), PROJECT_FILE::MigrateFromLegacy(), MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), PROJECT_FILE::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), COLOR_MAP_PARAM::Store(), PARAM< ValueType >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< Type >::Store(), PARAM_SET< Type >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

◆ Set() [2/3]

template<>
void JSON_SETTINGS::Set ( const std::string &  aPath,
wxString  aVal 
)
inherited

Definition at line 909 of file json_settings.cpp.

◆ Set() [3/3]

template<>
KICOMMON_API void JSON_SETTINGS::Set ( const std::string &  aPath,
wxString  aVal 
)
inherited

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString &  aFilename)
inlineinherited

◆ SetIfPresent() [1/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json &  aObj,
const std::string &  aPath,
bool &  aTarget 
)
staticinherited

Sets the given bool if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 736 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [2/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json &  aObj,
const std::string &  aPath,
int &  aTarget 
)
staticinherited

Sets the given int if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 751 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json &  aObj,
const std::string &  aPath,
unsigned int &  aTarget 
)
staticinherited

Sets the given unsigned int if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 766 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json &  aObj,
const std::string &  aPath,
wxString &  aTarget 
)
staticinherited

Sets the given string if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 721 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString &  aFilename)
inlineinherited

Definition at line 89 of file json_settings.h.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation)
inlineinherited

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 198 of file json_settings.h.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER.

Returns
true if any part of the JSON document has been updated since the last save to disk

Definition at line 375 of file json_settings.cpp.

References JSON_SETTINGS::m_modified, and JSON_SETTINGS::m_params.

Referenced by JSON_SETTINGS::FormatAsString(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), JSON_SETTINGS::SaveToFile(), and NESTED_SETTINGS::SaveToFile().

Member Data Documentation

◆ m_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion

! Local schema version for common app settings

Definition at line 193 of file app_settings.h.

◆ m_ColorPicker

COLOR_PICKER APP_SETTINGS_BASE::m_ColorPicker

◆ m_ColorTheme

◆ m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault
protectedinherited

Whether or not the backing store file should be created if all parameters are still at their default values.

Ignored if m_createIfMissing is false or m_writeFile is false.

Definition at line 325 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

Whether or not the backing store file should be created it if doesn't exist.

Definition at line 319 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_CrossProbing

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 334 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), PROJECT_FILE::PROJECT_FILE(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ m_filename

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace

◆ m_Graphics

◆ m_internals

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename
protectedinherited

The filename of the wxConfig legacy file (if different from m_filename)

Definition at line 307 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ m_LibTree

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 310 of file json_settings.h.

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

A pointer to the settings manager managing this file (may be null)

Definition at line 343 of file json_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and JSON_SETTINGS::ReleaseNestedSettings().

◆ m_migrators

std::map<int, std::pair<int, std::function<bool()> > > JSON_SETTINGS::m_migrators
protectedinherited

A map of starting schema version to a pair of <ending version, migrator function>

Definition at line 346 of file json_settings.h.

Referenced by JSON_SETTINGS::Migrate(), and JSON_SETTINGS::registerMigration().

◆ m_modified

bool JSON_SETTINGS::m_modified
protectedinherited

True if the JSON data store has been written to since the last file write.

Definition at line 331 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), JSON_SETTINGS::SaveToFile(), and JSON_SETTINGS::Store().

◆ m_nested_settings

std::vector<NESTED_SETTINGS*> JSON_SETTINGS::m_nested_settings
protectedinherited

Nested settings files that live inside this one, if any.

Definition at line 316 of file json_settings.h.

Referenced by JSON_SETTINGS::AddNestedSettings(), JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), and JSON_SETTINGS::SaveToFile().

◆ m_params

◆ m_Printing

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing
protectedinherited

Whether or not to set parameters to their default value if missing from JSON on Load()

Definition at line 337 of file json_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and JSON_SETTINGS::Load().

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_SearchPane

◆ m_System

◆ m_Window

WINDOW_SETTINGS APP_SETTINGS_BASE::m_Window

Definition at line 186 of file app_settings.h.

Referenced by APP_SETTINGS_BASE(), GRID_MENU::BuildChoiceList(), SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), EDA_DRAW_FRAME::DisplayGridMsg(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), GAL_OPTIONS_PANEL::GAL_OPTIONS_PANEL(), EE_GRID_HELPER::GetGridSize(), PCB_GRID_HELPER::GetGridSize(), DIALOG_BOARD_REANNOTATE::GetParameters(), EDA_BASE_FRAME::GetWindowSettings(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), COMMON_TOOLS::GridFastCycle(), SCH_EDITOR_CONTROL::GridFeedback(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), EDA_DRAW_FRAME::IsGridOverridden(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSettings(), GERBVIEW_FRAME::LoadSettings(), PCB_BASE_FRAME::LoadSettings(), PL_EDITOR_FRAME::LoadSettings(), FOOTPRINT_PREVIEW_PANEL::New(), COMMON_TOOLS::OnGridChanged(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), COMMON_TOOLS::Reset(), EDA_BASE_FRAME::SaveSettings(), EDA_DRAW_FRAME::SetGridOverrides(), EDA_DRAW_FRAME::SetGridVisibility(), COMMON_TOOLS::ToggleCursor(), COMMON_TOOLS::ToggleCursorStyle(), PANEL_GRID_SETTINGS::TransferDataFromWindow(), GAL_OPTIONS_PANEL::TransferDataFromWindow(), PANEL_GRID_SETTINGS::TransferDataToWindow(), GAL_OPTIONS_PANEL::TransferDataToWindow(), GRID_MENU::update(), ZOOM_MENU::update(), and EDA_DRAW_FRAME::UpdateZoomSelectBox().

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

Whether or not the backing store file should be written.

Definition at line 328 of file json_settings.h.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), COLOR_SETTINGS::initFromOther(), JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().


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