KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
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  PANEL_DESIGN_BLOCK_CHOOSER
 
struct  PLUGINS
 
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< GRID > DefaultGridSizeList () const
 
const std::vector< double > DefaultZoomList () 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_INTERNALS * Internals ()
 
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<>
KICOMMON_API 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)
 
virtual std::map< std::string, nlohmann::json > GetFileHistories ()
 
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
 
PANEL_DESIGN_BLOCK_CHOOSER m_DesignBlockChooserPanel
 
GRAPHICS m_Graphics
 
COLOR_PICKER m_ColorPicker
 
LIB_TREE m_LibTree
 
PRINTING m_Printing
 
SEARCH_PANE m_SearchPane
 
SYSTEM m_System
 
PLUGINS m_Plugins
 
WINDOW_SETTINGS m_Window
 
wxString m_ColorTheme
 Active color theme name.
 
bool m_CustomToolbars
 Use custom toolbars.
 
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 list.s
 
bool migrateWindowConfig (wxConfigBase *aCfg, const std::string &aFrameName, const std::string &aJsonPath)
 Migrate legacy window settings into the JSON document.
 
void addParamsForWindow (WINDOW_SETTINGS *aWindow, const std::string &aJsonPath, int aDefaultWidth=0, int aDefaultHeight=0)
 Add parameters for the given window object.
 
bool migrateLibTreeWidth ()
 Migrate 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.
 
bool m_isFutureFormat
 Set to true if this settings is loaded from a file with a newer schema version than is known.
 
SETTINGS_MANAGER * m_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_INTERNALS > m_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 113 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 36 of file app_settings.cpp.

References JSON_SETTINGS::JSON_SETTINGS(), m_appSettingsSchemaVersion, m_ColorPicker, m_CrossProbing, m_CustomToolbars, m_DesignBlockChooserPanel, m_FindReplace, m_Graphics, m_LibTree, JSON_SETTINGS::m_params, m_Plugins, m_Printing, m_SearchPane, m_System, m_Window, name, and USER.

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), PCB_CALCULATOR_SETTINGS::PCB_CALCULATOR_SETTINGS(), PCB_VIEWERS_SETTINGS_BASE::PCB_VIEWERS_SETTINGS_BASE(), PL_EDITOR_SETTINGS::PL_EDITOR_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ ~APP_SETTINGS_BASE()

virtual APP_SETTINGS_BASE::~APP_SETTINGS_BASE ( )
inlinevirtual

Definition at line 210 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 907 of file json_settings.cpp.

References GetFilename(), m_nested_settings, NESTED_SETTINGS, and traceSettings.

◆ addParamsForWindow()

void APP_SETTINGS_BASE::addParamsForWindow ( WINDOW_SETTINGS * aWindow,
const std::string & aJsonPath,
int aDefaultWidth = 0,
int aDefaultHeight = 0 )
protected

Add parameters for the given window object.

Parameters
aWindowis the target window settings object.
aJsonPathis the path to read parameters from.

Definition at line 412 of file app_settings.cpp.

References CURSOR_SETTINGS::always_show_cursor, GRID_SETTINGS::axes_enabled, CURSOR_SETTINGS::cross_hair_mode, WINDOW_SETTINGS::cursor, DefaultGridSizeList(), DefaultZoomList(), WINDOW_STATE::display, GRID_SETTINGS::fast_grid_1, GRID_SETTINGS::fast_grid_2, WINDOW_SETTINGS::grid, GRID_SETTINGS::grids, GRID_SETTINGS::last_size_idx, GRID_SETTINGS::line_width, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_params, WINDOW_STATE::maximized, GRID_SETTINGS::min_spacing, WINDOW_SETTINGS::mru_path, GRID_SETTINGS::override_connected, GRID_SETTINGS::override_connected_idx, GRID_SETTINGS::override_graphics, GRID_SETTINGS::override_graphics_idx, GRID_SETTINGS::override_text, GRID_SETTINGS::override_text_idx, GRID_SETTINGS::override_vias, GRID_SETTINGS::override_vias_idx, GRID_SETTINGS::override_wires, GRID_SETTINGS::override_wires_idx, GRID_SETTINGS::overrides_enabled, WINDOW_SETTINGS::perspective, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, GRID_SETTINGS::show, WINDOW_STATE::size_x, WINDOW_STATE::size_y, KIGFX::SMALL_CROSS, GRID_SETTINGS::snap, WINDOW_SETTINGS::state, GRID_SETTINGS::style, GRID_SETTINGS::user_grid_x, GRID_SETTINGS::user_grid_y, and WINDOW_SETTINGS::zoom_factors.

Referenced by CVPCB_SETTINGS::CVPCB_SETTINGS(), and EESCHEMA_SETTINGS::EESCHEMA_SETTINGS().

◆ 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 119 of file json_settings.cpp.

References m_internals.

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

◆ Contains()

bool JSON_SETTINGS::Contains ( const std::string & aPath) const
inherited

Definition at line 125 of file json_settings.cpp.

References m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), GERBVIEW_SETTINGS::GetFileHistories(), GetFileHistories(), BOARD_DESIGN_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::migrateBomSettings(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ DefaultGridSizeList()

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

Definition at line 575 of file app_settings.cpp.

References JSON_SETTINGS::m_filename.

Referenced by addParamsForWindow().

◆ DefaultZoomList()

const std::vector< double > APP_SETTINGS_BASE::DefaultZoomList ( ) const

Definition at line 551 of file app_settings.cpp.

References ADVANCED_CFG::GetCfg(), JSON_SETTINGS::m_filename, ZOOM_LIST_EESCHEMA, ZOOM_LIST_GERBVIEW, ZOOM_LIST_PCBNEW, ZOOM_LIST_PCBNEW_HYPER, and ZOOM_LIST_PL_EDITOR.

Referenced by addParamsForWindow().

◆ 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 955 of file json_settings.cpp.

◆ FormatAsString()

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

Definition at line 538 of file json_settings.cpp.

References dummy, m_internals, and Store().

◆ 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 816 of file json_settings.cpp.

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy(), BITMAP2CMP_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), CVPCB_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().

◆ 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 879 of file json_settings.cpp.

References color.

Referenced by APP_SETTINGS_BASE::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 855 of file json_settings.cpp.

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

◆ Get() [1/3]

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

Definition at line 938 of file json_settings.cpp.

References GetJson().

◆ Get() [2/3]

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 603 of file json_settings.cpp.

References GetJson().

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), JSON_SETTINGS::Get< KIGFX::COLOR4D >(), JSON_SETTINGS::Get< KIGFX::CROSS_HAIR_MODE >(), JSON_SETTINGS::Get< nlohmann::json >(), JSON_SETTINGS::Get< std::string >(), 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_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), EESCHEMA_SETTINGS::migrateBomSettings(), COMMON_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PROJECT_FILE::SaveAs(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ Get() [3/3]

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

References KICOMMON_API.

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in DATABASE_LIB_SETTINGS, HTTP_LIB_SETTINGS, JOBSET, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 291 of file json_settings.h.

Referenced by GetFullFilename(), LoadFromFile(), and SaveToFile().

◆ GetFileHistories()

std::map< std::string, nlohmann::json > JSON_SETTINGS::GetFileHistories ( )
virtualinherited

Reimplemented in GERBVIEW_SETTINGS.

Definition at line 400 of file json_settings.cpp.

References Contains(), and GetJson().

Referenced by GERBVIEW_SETTINGS::GetFileHistories().

◆ GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const
inlineinherited

Definition at line 87 of file json_settings.h.

References m_filename.

Referenced by AddNestedSettings(), SETTINGS_MANAGER::loadColorSettingsByName(), NESTED_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_GERBVIEW_COLOR_SETTINGS::PANEL_GERBVIEW_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PCB_PLOTTER::PlotJobToPlotOpts(), DIALOG_PLOT_SCHEMATIC::plotSchematic(), PROJECT_FILE::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), DIALOG_PRINT::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), NESTED_SETTINGS::SaveToFile(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow().

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 110 of file json_settings.cpp.

References getFileExt(), and m_filename.

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

◆ 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 583 of file json_settings.cpp.

References m_internals.

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 296 of file json_settings.h.

Referenced by LoadFromFile().

◆ getLegacyFrameName()

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

Reimplemented in BITMAP2CMP_SETTINGS, CVPCB_SETTINGS, EDA_3D_VIEWER_SETTINGS, EESCHEMA_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, GERBVIEW_SETTINGS, KICAD_SETTINGS, PCB_CALCULATOR_SETTINGS, PCBNEW_SETTINGS, PL_EDITOR_SETTINGS, and SYMBOL_EDITOR_SETTINGS.

Definition at line 253 of file app_settings.h.

Referenced by MigrateFromLegacy().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 94 of file json_settings.h.

References m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile(), and COLOR_SETTINGS::migrateSchema0to1().

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

Definition at line 131 of file json_settings.cpp.

References m_internals.

Referenced by COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
inlineinherited

Definition at line 98 of file json_settings.h.

References m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::GetSettingsDropdownName(), PANEL_COLOR_SETTINGS::OnThemeChanged(), APPEARANCE_CONTROLS::rebuildLayers(), SETTINGS_MANAGER::SaveColorSettings(), and APPEARANCE_CONTROLS::syncColorsAndVisibility().

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

Updates the parameters of this object based on the current JSON document contents.

Definition at line 137 of file json_settings.cpp.

References m_params, m_resetParamsIfMissing, and traceSettings.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), BOARD_DESIGN_SETTINGS::LoadFromFile(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), LoadFromRawFile(), PCB_TEST_FRAME_BASE::LoadSettings(), PCBNEW_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_3D_DISPLAY_OPTIONS::ResetPanel(), PANEL_3D_OPENGL_OPTIONS::ResetPanel(), PANEL_3D_RAYTRACING_OPTIONS::ResetPanel(), PANEL_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_EESCHEMA_DISPLAY_OPTIONS::ResetPanel(), PANEL_EESCHEMA_EDITING_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_FIELD_DEFAULTS::ResetPanel(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::ResetPanel(), PANEL_GERBVIEW_DISPLAY_OPTIONS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), PANEL_PL_EDITOR_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_EDITING_OPTIONS::ResetPanel(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromFile()

bool JSON_SETTINGS::LoadFromFile ( const wxString & aDirectory = "")
virtualinherited

Loads the backing file from disk and then calls Load()

Parameters
aDirectoryis the path to the file
Returns
true if the file was found on disk and loaded or migrated

Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.

Definition at line 154 of file json_settings.cpp.

References getFileExt(), GetFullFilename(), getLegacyFileExt(), Load(), m_deleteLegacyAfterMigration, m_filename, m_internals, m_isFutureFormat, m_legacy_filename, m_modified, m_nested_settings, m_schemaVersion, m_writeFile, Migrate(), MigrateFromLegacy(), NESTED_SETTINGS, path, SaveToFile(), and traceSettings.

Referenced by CLI::JOBSET_RUN_COMMAND::doPerform(), SETTINGS_MANAGER::LoadProject(), SETTINGS_MANAGER::loadProjectFile(), SETTINGS_MANAGER::MigrateIfNeeded(), SAVE_AS_TRAVERSER::OnFile(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromRawFile()

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

Definition at line 551 of file json_settings.cpp.

References Load(), m_internals, and traceSettings.

◆ 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 706 of file json_settings.cpp.

References m_internals, m_migrators, m_schemaVersion, and traceSettings.

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

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase * aCfg)
protected

! Migrates the find/replace history string list.s

Definition at line 350 of file app_settings.cpp.

References JSON_SETTINGS::Set().

Referenced by MigrateFromLegacy().

◆ MigrateFromLegacy()

bool APP_SETTINGS_BASE::MigrateFromLegacy ( wxConfigBase * aLegacyConfig)
overridevirtual

Migrates from wxConfig to JSON-based configuration.

Should be implemented by any subclasses of JSON_SETTINGS that map to a legacy (wxConfig-based) config file.

Parameters
aLegacyConfigis a wxConfigBase holding a loaded configuration to migrate
Returns
true if migration was successful

Reimplemented from JSON_SETTINGS.

Reimplemented in BITMAP2CMP_SETTINGS, CVPCB_SETTINGS, EDA_3D_VIEWER_SETTINGS, EESCHEMA_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, GERBVIEW_SETTINGS, KICAD_SETTINGS, PCB_CALCULATOR_SETTINGS, PCBNEW_SETTINGS, PL_EDITOR_SETTINGS, and SYMBOL_EDITOR_SETTINGS.

Definition at line 289 of file app_settings.cpp.

References JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyString(), PGM_BASE::GetCommonSettings(), getLegacyFrameName(), COMMON_SETTINGS::m_System, migrateFindReplace(), migrateWindowConfig(), PCB_LAYER_ID_COUNT, Pgm(), and JSON_SETTINGS::Set().

Referenced by BITMAP2CMP_SETTINGS::MigrateFromLegacy(), CVPCB_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PL_EDITOR_SETTINGS::MigrateFromLegacy(), and SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy().

◆ migrateLibTreeWidth()

bool APP_SETTINGS_BASE::migrateLibTreeWidth ( )
protected

Migrate the library tree width setting from a single column (Item) to multi-column.

Definition at line 648 of file app_settings.cpp.

References JSON_SETTINGS::At(), JSON_SETTINGS::Get(), and JSON_SETTINGS::Set< nlohmann::json >().

Referenced by EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ migrateWindowConfig()

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

Migrate 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 374 of file app_settings.cpp.

References JSON_SETTINGS::fromLegacy(), 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 697 of file json_settings.cpp.

References m_migrators, and m_schemaVersion.

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), 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 914 of file json_settings.cpp.

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

Referenced by 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 393 of file json_settings.cpp.

References m_params.

Referenced by PANEL_COMMON_SETTINGS::ResetPanel(), PANEL_MAINTENANCE::ResetPanel(), PANEL_MOUSE_SETTINGS::ResetPanel(), and PANEL_SPACEMOUSE::ResetPanel().

◆ SaveToFile()

bool JSON_SETTINGS::SaveToFile ( const wxString & aDirectory = "",
bool aForce = false )
virtualinherited

Calls Store() and then writes the contents of the JSON document to a file.

Parameters
aDirectoryis the directory to save to, including trailing separator
Returns
true if the file was saved

Reimplemented in JOBSET, NESTED_SETTINGS, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 414 of file json_settings.cpp.

References dummy, getFileExt(), GetFullFilename(), m_createIfDefault, m_createIfMissing, m_filename, m_internals, m_modified, m_nested_settings, m_params, m_writeFile, NESTED_SETTINGS, path, JSON_SETTINGS_INTERNALS::PointerFromString(), Store(), and traceSettings.

Referenced by KICAD_MANAGER_FRAME::CreateNewProject(), LoadFromFile(), KICAD_MANAGER_FRAME::LoadProject(), SETTINGS_MANAGER::MigrateIfNeeded(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT::PinLibrary(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), JOBSET::SaveToFile(), PROJECT_FILE::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PGM_BASE::SetLanguage(), and PROJECT::UnpinLibrary().

◆ 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 658 of file json_settings.cpp.

References m_internals.

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), JSON_SETTINGS::Set< KIGFX::COLOR4D >(), JSON_SETTINGS::Set< KIGFX::CROSS_HAIR_MODE >(), JSON_SETTINGS::Set< nlohmann::json >(), JSON_SETTINGS::Set< std::string >(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), APP_SETTINGS_BASE::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), 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_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_LIST< Type >::Store(), PARAM_MAP< Value >::Store(), PARAM_PATH::Store(), PARAM_PATH_LIST::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_SET< Type >::Store(), and PARAM_WXSTRING_MAP::Store().

◆ Set() [2/3]

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

Definition at line 948 of file json_settings.cpp.

◆ Set() [3/3]

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

References KICOMMON_API.

◆ SetFilename()

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

Definition at line 91 of file json_settings.h.

References m_filename.

Referenced by SETTINGS_MANAGER::GetColorSettings(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().

◆ 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 770 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 785 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 800 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 755 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by 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 96 of file json_settings.h.

References m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC aLocation)
inlineinherited

Definition at line 93 of file json_settings.h.

References m_location.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), and COLOR_SETTINGS::migrateSchema0to1().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER * aManager)
inlineinherited

Definition at line 207 of file json_settings.h.

References m_manager.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool aReadOnly)
inlineinherited

Definition at line 99 of file json_settings.h.

References m_writeFile.

Referenced by SETTINGS_MANAGER::GetColorSettings(), SETTINGS_MANAGER::loadAllColorSettings(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT_FILE::SaveAs(), and SETTINGS_MANAGER::SaveProjectAs().

◆ 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 381 of file json_settings.cpp.

References m_modified, and m_params.

Referenced by FormatAsString(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), 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 249 of file app_settings.h.

Referenced by APP_SETTINGS_BASE().

◆ m_ColorPicker

COLOR_PICKER APP_SETTINGS_BASE::m_ColorPicker

Definition at line 227 of file app_settings.h.

Referenced by APP_SETTINGS_BASE(), DIALOG_COLOR_PICKER::DIALOG_COLOR_PICKER(), and DIALOG_COLOR_PICKER::~DIALOG_COLOR_PICKER().

◆ m_ColorTheme

wxString APP_SETTINGS_BASE::m_ColorTheme

Active color theme name.

Definition at line 242 of file app_settings.h.

Referenced by PL_EDITOR_FRAME::CommonSettingsChanged(), DISPLAY_FOOTPRINTS_FRAME::GetColorSettings(), FOOTPRINT_CHOOSER_FRAME::GetColorSettings(), FOOTPRINT_EDIT_FRAME::GetColorSettings(), FOOTPRINT_VIEWER_FRAME::GetColorSettings(), FOOTPRINT_WIZARD_FRAME::GetColorSettings(), GERBVIEW_FRAME::GetColorSettings(), PCB_BASE_EDIT_FRAME::GetColorSettings(), SCH_BASE_FRAME::GetColorSettings(), SYMBOL_EDIT_FRAME::GetColorSettings(), PCB_LAYER_PRESENTATION::getLayerColor(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_GERBVIEW_COLOR_SETTINGS::PANEL_GERBVIEW_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::PCB_DESIGN_BLOCK_PREVIEW_WIDGET(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), DIALOG_PLOT::Plot(), BOARD_ADAPTER::ReloadColorSettings(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::SCH_DESIGN_BLOCK_PREVIEW_WIDGET(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), DIALOG_PRINT::TransferDataFromWindow(), DIALOG_PRINT::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataToWindow(), and PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow().

◆ 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 334 of file json_settings.h.

Referenced by JSON_SETTINGS(), and 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 328 of file json_settings.h.

Referenced by JSON_SETTINGS(), and SaveToFile().

◆ m_CrossProbing

CROSS_PROBING_SETTINGS APP_SETTINGS_BASE::m_CrossProbing

Definition at line 219 of file app_settings.h.

Referenced by APP_SETTINGS_BASE(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PANEL_EESCHEMA_DISPLAY_OPTIONS::loadEEschemaSettings(), and PANEL_DISPLAY_OPTIONS::loadPCBSettings().

◆ m_CustomToolbars

bool APP_SETTINGS_BASE::m_CustomToolbars

Use custom toolbars.

Definition at line 245 of file app_settings.h.

Referenced by APP_SETTINGS_BASE().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 343 of file json_settings.h.

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

◆ m_DesignBlockChooserPanel

PANEL_DESIGN_BLOCK_CHOOSER APP_SETTINGS_BASE::m_DesignBlockChooserPanel

Definition at line 223 of file app_settings.h.

Referenced by APP_SETTINGS_BASE(), SCH_DRAWING_TOOLS::DrawSheet(), and SCH_DRAWING_TOOLS::ImportSheet().

◆ m_filename

wxString JSON_SETTINGS::m_filename
protectedinherited

The filename (not including path) of this settings file (inicode)

Definition at line 313 of file json_settings.h.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), COLOR_SETTINGS::COLOR_SETTINGS(), APP_SETTINGS_BASE::DefaultGridSizeList(), APP_SETTINGS_BASE::DefaultZoomList(), GetFilename(), GetFullFilename(), JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::operator=(), SaveToFile(), NESTED_SETTINGS::SaveToFile(), and SetFilename().

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace

Definition at line 221 of file app_settings.h.

Referenced by APP_SETTINGS_BASE(), EDA_DRAW_FRAME::LoadSettings(), and EDA_DRAW_FRAME::SaveSettings().

◆ m_Graphics

GRAPHICS APP_SETTINGS_BASE::m_Graphics

Definition at line 225 of file app_settings.h.

Referenced by APP_SETTINGS_BASE(), and PCB_BASE_FRAME::LoadSettings().

◆ m_internals

std::unique_ptr<JSON_SETTINGS_INTERNALS> JSON_SETTINGS::m_internals
protectedinherited

Definition at line 360 of file json_settings.h.

Referenced by At(), Contains(), FormatAsString(), GetJson(), Internals(), JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), LoadFromRawFile(), Migrate(), COMMON_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema0to1(), EDA_3D_VIEWER_SETTINGS::migrateSchema0to1(), NET_SETTINGS::migrateSchema0to1(), PROJECT_FILE::migrateSchema1To2(), COMMON_SETTINGS::migrateSchema1to2(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema2To3(), PROJECT_FILE::migrateSchema2To3(), NET_SETTINGS::migrateSchema2to3(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema3To4(), COMMON_SETTINGS::migrateSchema3to4(), NET_SETTINGS::migrateSchema3to4(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema4To5(), NET_SETTINGS::migrateSchema4to5(), SaveToFile(), NESTED_SETTINGS::SaveToFile(), and Set().

◆ m_isFutureFormat

bool JSON_SETTINGS::m_isFutureFormat
protectedinherited

Set to true if this settings is loaded from a file with a newer schema version than is known.

Definition at line 352 of file json_settings.h.

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

◆ 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 316 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), and SetLegacyFilename().

◆ m_LibTree

LIB_TREE APP_SETTINGS_BASE::m_LibTree

Definition at line 229 of file app_settings.h.

Referenced by APP_SETTINGS_BASE().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 319 of file json_settings.h.

Referenced by GetLocation(), JSON_SETTINGS(), and SetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 355 of file json_settings.h.

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

◆ 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 358 of file json_settings.h.

Referenced by Migrate(), and 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 340 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), ReleaseNestedSettings(), SaveToFile(), and 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 325 of file json_settings.h.

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

◆ m_params

std::vector<PARAM_BASE*> JSON_SETTINGS::m_params
protectedinherited

The list of parameters (owned by this object)

Definition at line 322 of file json_settings.h.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), APP_SETTINGS_BASE::APP_SETTINGS_BASE(), BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), COMPONENT_CLASS_SETTINGS::COMPONENT_CLASS_SETTINGS(), COLOR_SETTINGS::CreateBuiltinColorSettings(), CVPCB_SETTINGS::CVPCB_SETTINGS(), DATABASE_LIB_SETTINGS::DATABASE_LIB_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), COLOR_SETTINGS::GetDefaultColor(), HTTP_LIB_SETTINGS::HTTP_LIB_SETTINGS(), COLOR_SETTINGS::initFromOther(), JOBSET::JOBSET(), JSON_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), Load(), NET_SETTINGS::NET_SETTINGS(), NGSPICE_SETTINGS::NGSPICE_SETTINGS(), PCB_CALCULATOR_SETTINGS::PCB_CALCULATOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PL_EDITOR_SETTINGS::PL_EDITOR_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SETTINGS::SPICE_SETTINGS(), Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), TIME_DOMAIN_PARAMETERS::TIME_DOMAIN_PARAMETERS(), TOOLBAR_SETTINGS::TOOLBAR_SETTINGS(), and ~JSON_SETTINGS().

◆ m_Plugins

PLUGINS APP_SETTINGS_BASE::m_Plugins

Definition at line 237 of file app_settings.h.

Referenced by APP_SETTINGS_BASE(), EDA_DRAW_FRAME::GetOrderedPluginActions(), EDA_DRAW_FRAME::IsPluginActionButtonVisible(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataFromWindow().

◆ m_Printing

PRINTING APP_SETTINGS_BASE::m_Printing

Definition at line 231 of file app_settings.h.

Referenced by APP_SETTINGS_BASE(), SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), BOARD_PRINTOUT_SETTINGS::Load(), PRINTOUT_SETTINGS::Load(), SCH_PRINTOUT::PrintPage(), BOARD_PRINTOUT_SETTINGS::Save(), PRINTOUT_SETTINGS::Save(), DIALOG_PRINT::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), DIALOG_PRINT::TransferDataFromWindow(), DIALOG_PRINT::TransferDataToWindow(), and DIALOG_PRINT_PCBNEW::TransferDataToWindow().

◆ 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 346 of file json_settings.h.

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

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

Version of this settings schema.

Definition at line 349 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), Migrate(), registerMigration(), and NESTED_SETTINGS::SaveToFile().

◆ m_SearchPane

SEARCH_PANE APP_SETTINGS_BASE::m_SearchPane

Definition at line 233 of file app_settings.h.

Referenced by APP_SETTINGS_BASE().

◆ m_System

SYSTEM APP_SETTINGS_BASE::m_System

Definition at line 235 of file app_settings.h.

Referenced by APP_SETTINGS_BASE(), AskLoadBoardFileName(), FILE_HISTORY::Load(), EDA_DRAW_FRAME::LoadSettings(), SCH_EDIT_FRAME::OnImportProject(), FILE_HISTORY::Save(), EDA_DRAW_FRAME::SaveSettings(), SCH_EDIT_FRAME::SaveSettings(), and EDA_DRAW_FRAME::setupUnits().

◆ m_Window

WINDOW_SETTINGS APP_SETTINGS_BASE::m_Window

Definition at line 239 of file app_settings.h.

Referenced by APP_SETTINGS_BASE(), GRID_MENU::BuildChoiceList(), PL_EDITOR_FRAME::CommonSettingsChanged(), DISPLAY_FOOTPRINTS_FRAME::GetWindowSettings(), EDA_BASE_FRAME::GetWindowSettings(), FOOTPRINT_CHOOSER_FRAME::GetWindowSettings(), FOOTPRINT_VIEWER_FRAME::GetWindowSettings(), FOOTPRINT_WIZARD_FRAME::GetWindowSettings(), SIMULATOR_FRAME::GetWindowSettings(), SYMBOL_CHOOSER_FRAME::GetWindowSettings(), SYMBOL_VIEWER_FRAME::GetWindowSettings(), EDA_DRAW_FRAME::IsGridOverridden(), EDA_DRAW_FRAME::IsGridVisible(), PCB_BASE_FRAME::LoadSettings(), SCH_BASE_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSettings(), FOOTPRINT_PREVIEW_PANEL::New(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::PCB_DESIGN_BLOCK_PREVIEW_WIDGET(), EDA_BASE_FRAME::SaveSettings(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::SCH_DESIGN_BLOCK_PREVIEW_WIDGET(), EDA_DRAW_FRAME::SetGridOverrides(), EDA_DRAW_FRAME::SetGridVisibility(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), GRID_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 337 of file json_settings.h.

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

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