KiCad PCB EDA Suite
|
#include <kicad_settings.h>
Public Member Functions | |
KICAD_SETTINGS () | |
virtual | ~KICAD_SETTINGS () |
virtual bool | MigrateFromLegacy (wxConfigBase *aLegacyConfig) override |
Migrates from wxConfig to JSON-based configuration. | |
const std::vector< GRID > | DefaultGridSizeList () 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<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 | |
int | m_LeftWinWidth |
std::vector< wxString > | m_OpenProjects |
wxString | m_lastDesignBlockLibDir |
std::vector< std::pair< wxString, wxString > > | m_PcmRepositories |
wxString | m_PcmLastDownloadDir |
bool | m_PcmUpdateCheck |
bool | m_PcmLibAutoAdd |
bool | m_PcmLibAutoRemove |
wxString | m_PcmLibPrefix |
bool | m_KiCadUpdateCheck |
wxString | m_lastUpdateCheckTime |
wxString | m_lastReceivedUpdate |
CROSS_PROBING_SETTINGS | m_CrossProbing |
FIND_REPLACE | m_FindReplace |
GRAPHICS | m_Graphics |
COLOR_PICKER | m_ColorPicker |
LIB_TREE | m_LibTree |
PRINTING | m_Printing |
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 override |
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_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_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 |
Definition at line 28 of file kicad_settings.h.
KICAD_SETTINGS::KICAD_SETTINGS | ( | ) |
Definition at line 38 of file kicad_settings.cpp.
References m_KiCadUpdateCheck, m_lastDesignBlockLibDir, m_lastReceivedUpdate, m_lastUpdateCheckTime, m_LeftWinWidth, m_OpenProjects, JSON_SETTINGS::m_params, m_PcmLastDownloadDir, m_PcmLibAutoAdd, m_PcmLibAutoRemove, m_PcmLibPrefix, m_PcmRepositories, m_PcmUpdateCheck, and PCM_DEFAULT_REPOSITORIES.
|
inlinevirtual |
Definition at line 33 of file kicad_settings.h.
|
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;
aSettings | is the settings object to take ownership of |
aTarget | is a pointer to update to the passed in settings |
Definition at line 864 of file json_settings.cpp.
References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.
Referenced by NESTED_SETTINGS::SetParent().
|
protectedinherited |
Adds parameters for the given window object.
aWindow | is the target window settings object |
aJsonPath | is the path to read parameters from |
Definition at line 308 of file app_settings.cpp.
References CURSOR_SETTINGS::always_show_cursor, GRID_SETTINGS::axes_enabled, WINDOW_SETTINGS::cursor, APP_SETTINGS_BASE::DefaultGridSizeList(), WINDOW_STATE::display, GRID_SETTINGS::fast_grid_1, GRID_SETTINGS::fast_grid_2, CURSOR_SETTINGS::fullscreen_cursor, 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, 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 APP_SETTINGS_BASE::APP_SETTINGS_BASE(), CVPCB_SETTINGS::CVPCB_SETTINGS(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().
|
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 117 of file json_settings.cpp.
References JSON_SETTINGS::m_internals.
Referenced by EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().
|
inherited |
Definition at line 123 of file json_settings.cpp.
References JSON_SETTINGS::m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().
Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::migrateBomSettings(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().
|
inherited |
Definition at line 446 of file app_settings.cpp.
References JSON_SETTINGS::m_filename.
Referenced by APP_SETTINGS_BASE::addParamsForWindow(), SCH_BASE_FRAME::LoadSettings(), PCB_BASE_FRAME::LoadSettings(), FOOTPRINT_PREVIEW_PANEL::New(), and PANEL_GRID_SETTINGS::ResetPanel().
|
staticprotectedinherited |
Helper to retrieve a value from a JSON object (dictionary) as a certain result type.
ResultType | is the type of the retrieved value. |
aJson | is the object to act on . |
aKey | is the object key to retrieve the value for. |
Definition at line 910 of file json_settings.cpp.
|
inherited |
Definition at line 509 of file json_settings.cpp.
References dummy, JSON_SETTINGS::m_internals, and JSON_SETTINGS::Store().
Referenced by ROUTER_TOOL::saveRouterDebugLog().
|
protectedinherited |
Translates a legacy wxConfig value to a given JSON pointer value.
ValueType | is the basic type of the value |
aConfig | is the legacy config to read from |
aKey | is the key (within the current path) to read |
aDest | is a string that will form a JSON pointer (key1.key2.key3) to write to |
Definition at line 776 of file json_settings.cpp.
|
protectedinherited |
Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.
aConfig | is the legacy config to read from |
aKey | is the key (within the current path) to read |
aDest | is a string that will form a JSON pointer (key1.key2.key3) to write to |
Definition at line 836 of file json_settings.cpp.
References color.
Referenced by APP_SETTINGS_BASE::migrateWindowConfig().
|
protectedinherited |
Translates a legacy wxConfig string value to a given JSON pointer value.
aConfig | is the legacy config to read from |
aKey | is the key (within the current path) to read |
aDest | is a string that will form a JSON pointer (key1.key2.key3) to write to |
Definition at line 812 of file json_settings.cpp.
Referenced by PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::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 APP_SETTINGS_BASE::migrateWindowConfig().
|
inherited |
Definition at line 894 of file json_settings.cpp.
References JSON_SETTINGS::GetJson().
|
inherited |
Fetches a value from within the JSON document.
Will return an empty optional if the value is not found or a mismatching type.
ValueType | is the type to cast to |
aPath | is the path within the document to retrieve |
Definition at line 574 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().
|
inlineprotectedvirtualinherited |
Reimplemented in JOBSET, DATABASE_LIB_SETTINGS, HTTP_LIB_SETTINGS, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.
Definition at line 282 of file json_settings.h.
Referenced by JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().
|
inlineinherited |
Definition at line 80 of file json_settings.h.
Referenced by JSON_SETTINGS::AddNestedSettings(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), SETTINGS_MANAGER::loadColorSettingsByName(), NESTED_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_COLOR_SETTINGS::OnLeftDownTheme(), PANEL_COLOR_SETTINGS::OnThemeChanged(), DIALOG_PLOT_SCHEMATIC::plotSchematic(), PROJECT_FILE::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), DIALOG_PRINT_USING_PRINTER::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), NESTED_SETTINGS::SaveToFile(), PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow().
|
inherited |
Definition at line 108 of file json_settings.cpp.
References JSON_SETTINGS::getFileExt(), and JSON_SETTINGS::m_filename.
Referenced by JSON_SETTINGS::JSON_SETTINGS(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::SaveToFile(), and SETTINGS_MANAGER::SETTINGS_MANAGER().
|
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.
aPath | is a string containing one or more keys separated by '.' |
Definition at line 554 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().
|
inlineprotectedvirtualinherited |
Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.
Definition at line 287 of file json_settings.h.
Referenced by JSON_SETTINGS::LoadFromFile().
|
inlineoverrideprotectedvirtual |
Reimplemented from APP_SETTINGS_BASE.
Definition at line 62 of file kicad_settings.h.
|
inlineinherited |
Definition at line 87 of file json_settings.h.
Referenced by SETTINGS_MANAGER::GetPathForSettingsFile(), and COLOR_SETTINGS::migrateSchema0to1().
|
inherited |
Definition at line 129 of file json_settings.cpp.
References JSON_SETTINGS::m_internals.
Referenced by COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().
|
inlineinherited |
Definition at line 91 of file json_settings.h.
Referenced by PANEL_COLOR_SETTINGS::GetSettingsDropdownName(), PANEL_COLOR_SETTINGS::OnThemeChanged(), APPEARANCE_CONTROLS::rebuildLayers(), PANEL_COLOR_SETTINGS::ResetPanel(), SETTINGS_MANAGER::SaveColorSettings(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), PANEL_COLOR_SETTINGS::ShowColorContextMenu(), APPEARANCE_CONTROLS::syncColorsAndVisibility(), and PANEL_COLOR_SETTINGS::updateSwatches().
|
virtualinherited |
Updates the parameters of this object based on the current JSON document contents.
Definition at line 135 of file json_settings.cpp.
References JSON_SETTINGS::m_params, JSON_SETTINGS::m_resetParamsIfMissing, and traceSettings.
Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromRawFile(), PCB_TEST_FRAME_BASE::LoadSettings(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_3D_DISPLAY_OPTIONS::ResetPanel(), PANEL_3D_OPENGL_OPTIONS::ResetPanel(), PANEL_3D_RAYTRACING_OPTIONS::ResetPanel(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::ResetPanel(), PANEL_EESCHEMA_DISPLAY_OPTIONS::ResetPanel(), PANEL_EESCHEMA_EDITING_OPTIONS::ResetPanel(), PANEL_SYM_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_EDITING_OPTIONS::ResetPanel(), PANEL_GERBVIEW_DISPLAY_OPTIONS::ResetPanel(), PANEL_PL_EDITOR_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_DEFAULTS::ResetPanel(), PANEL_PCB_DISPLAY_OPTIONS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), SETTINGS_MANAGER::SaveColorSettings(), and SETTINGS_MANAGER::SETTINGS_MANAGER().
|
virtualinherited |
Loads the backing file from disk and then calls Load()
aDirectory | is the path to the file |
Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.
Definition at line 152 of file json_settings.cpp.
References JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::getLegacyFileExt(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_deleteLegacyAfterMigration, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, JSON_SETTINGS::m_legacy_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::m_writeFile, JSON_SETTINGS::Migrate(), JSON_SETTINGS::MigrateFromLegacy(), path, JSON_SETTINGS::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().
|
inherited |
Definition at line 522 of file json_settings.cpp.
References JSON_SETTINGS::Load(), JSON_SETTINGS::m_internals, and traceSettings.
|
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
Definition at line 671 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().
|
protectedinherited |
! Migrates the find/replace history string lists
Definition at line 248 of file app_settings.cpp.
References JSON_SETTINGS::Set().
Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().
|
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.
aLegacyConfig | is a wxConfigBase holding a loaded configuration to migrate |
Reimplemented from APP_SETTINGS_BASE.
Definition at line 105 of file kicad_settings.cpp.
References APP_SETTINGS_BASE::MigrateFromLegacy(), and JSON_SETTINGS::Set().
|
protectedinherited |
Migrates the library tree width setting from a single column (Item) to multi-column.
Definition at line 483 of file app_settings.cpp.
References JSON_SETTINGS::At(), and JSON_SETTINGS::Set< nlohmann::json >().
Referenced by EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().
|
protectedinherited |
Migrates legacy window settings into the JSON document.
aCfg | is the wxConfig object to read from |
aFrameName | is the prefix for window settings in the legacy config file |
aJsonPath | is the prefix for storing window settings in the JSON file |
Definition at line 272 of file app_settings.cpp.
References JSON_SETTINGS::fromLegacyColor(), and JSON_SETTINGS::fromLegacyString().
Referenced by APP_SETTINGS_BASE::MigrateFromLegacy(), CVPCB_SETTINGS::MigrateFromLegacy(), and PCBNEW_SETTINGS::MigrateFromLegacy().
|
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.
aOldSchemaVersion | is the starting schema version for this migration |
aNewSchemaVersion | is the ending schema version for this migration |
aMigrator | is a function that performs the migration and returns true if successful |
Definition at line 662 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().
|
inherited |
Saves and frees a nested settings object, if it exists within this one.
aSettings | is a pointer to a NESTED_SETTINGS that has already been added to this one |
Definition at line 871 of file json_settings.cpp.
References JSON_SETTINGS::m_manager, 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().
|
inherited |
Resets all parameters to default values.
Does NOT write to file or update underlying JSON.
Definition at line 386 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().
|
virtualinherited |
Calls Store() and then writes the contents of the JSON document to a file.
aDirectory | is the directory to save to, including trailing separator |
Reimplemented in JOBSET, PROJECT_FILE, PROJECT_LOCAL_SETTINGS, and NESTED_SETTINGS.
Definition at line 393 of file json_settings.cpp.
References dummy, JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::m_createIfDefault, JSON_SETTINGS::m_createIfMissing, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_params, JSON_SETTINGS::m_writeFile, path, JSON_SETTINGS::Store(), and traceSettings.
Referenced by KICAD_MANAGER_FRAME::CreateNewProject(), JSON_SETTINGS::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().
|
inherited |
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.
ValueType | is the type to store |
aPath | is a path to store in the form "key1.key2.key3" |
aVal | is the value to store |
Definition at line 625 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(), APP_SETTINGS_BASE::migrateFindReplace(), PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), 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().
|
inherited |
Definition at line 903 of file json_settings.cpp.
|
inherited |
|
inlineinherited |
Definition at line 84 of file json_settings.h.
Referenced by SETTINGS_MANAGER::GetColorSettings(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().
|
staticinherited |
Sets the given bool if the given key/path is present.
aObj | is the source object |
aTarget | is the storage destination |
Definition at line 730 of file json_settings.cpp.
References JSON_SETTINGS_INTERNALS::PointerFromString().
|
staticinherited |
Sets the given int if the given key/path is present.
aObj | is the source object |
aTarget | is the storage destination |
Definition at line 745 of file json_settings.cpp.
References JSON_SETTINGS_INTERNALS::PointerFromString().
|
staticinherited |
Sets the given unsigned int if the given key/path is present.
aObj | is the source object |
aTarget | is the storage destination |
Definition at line 760 of file json_settings.cpp.
References JSON_SETTINGS_INTERNALS::PointerFromString().
|
staticinherited |
Sets the given string if the given key/path is present.
aObj | is the source object |
aTarget | is the storage destination |
Definition at line 715 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().
|
inlineinherited |
Definition at line 89 of file json_settings.h.
Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().
|
inlineinherited |
Definition at line 86 of file json_settings.h.
Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), and COLOR_SETTINGS::migrateSchema0to1().
|
inlineinherited |
Definition at line 198 of file json_settings.h.
|
inlineinherited |
Definition at line 92 of file json_settings.h.
Referenced by SETTINGS_MANAGER::GetColorSettings(), SETTINGS_MANAGER::loadAllColorSettings(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT_FILE::SaveAs(), and SETTINGS_MANAGER::SaveProjectAs().
|
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.
Definition at line 372 of file json_settings.cpp.
References 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().
|
inherited |
! Local schema version for common app settings
Definition at line 178 of file app_settings.h.
|
inherited |
Definition at line 164 of file app_settings.h.
Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), DIALOG_COLOR_PICKER::DIALOG_COLOR_PICKER(), and DIALOG_COLOR_PICKER::~DIALOG_COLOR_PICKER().
|
inherited |
Active color theme name.
Definition at line 175 of file app_settings.h.
Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), PL_EDITOR_FRAME::CommonSettingsChanged(), GRID_CELL_LAYER_RENDERER::Draw(), DIALOG_EXPORT_SVG::ExportSVGFile(), BOARD_ADAPTER::GetBoardEditorCopperLayerColors(), SCH_BASE_FRAME::GetColorSettings(), SYMBOL_EDIT_FRAME::GetColorSettings(), GERBVIEW_FRAME::GetColorSettings(), FOOTPRINT_EDIT_FRAME::GetColorSettings(), FOOTPRINT_VIEWER_FRAME::GetColorSettings(), FOOTPRINT_WIZARD_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(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), DIALOG_PLOT::Plot(), BOARD_ADAPTER::ReloadColorSettings(), PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataToWindow(), and DIALOG_PRINT_PCBNEW::TransferDataToWindow().
|
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().
|
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().
|
inherited |
Definition at line 158 of file app_settings.h.
Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), PCB_SELECTION_TOOL::doSyncSelection(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), PANEL_EESCHEMA_DISPLAY_OPTIONS::loadEEschemaSettings(), PANEL_PCB_DISPLAY_OPTIONS::loadPCBSettings(), EE_SELECTION_TOOL::SyncSelection(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), and PANEL_PCB_DISPLAY_OPTIONS::TransferDataFromWindow().
|
protectedinherited |
Whether or not to delete legacy file after migration.
Definition at line 331 of file json_settings.h.
Referenced by JSON_SETTINGS::LoadFromFile(), PROJECT_FILE::PROJECT_FILE(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().
|
protectedinherited |
The filename (not including path) of this settings file (inicode)
Definition at line 304 of file json_settings.h.
Referenced by APP_SETTINGS_BASE::addParamsForWindow(), APP_SETTINGS_BASE::APP_SETTINGS_BASE(), APP_SETTINGS_BASE::DefaultGridSizeList(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::operator=(), JSON_SETTINGS::SaveToFile(), and NESTED_SETTINGS::SaveToFile().
|
inherited |
Definition at line 160 of file app_settings.h.
Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), EDA_DRAW_FRAME::LoadSettings(), and EDA_DRAW_FRAME::SaveSettings().
|
inherited |
Definition at line 162 of file app_settings.h.
Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), EDA_DRAW_FRAME::loadCanvasTypeSetting(), PCB_BASE_FRAME::LoadSettings(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), GAL_OPTIONS_PANEL::TransferDataFromWindow(), and GAL_OPTIONS_PANEL::TransferDataToWindow().
|
protectedinherited |
Definition at line 345 of file json_settings.h.
Referenced by JSON_SETTINGS::At(), JSON_SETTINGS::Contains(), JSON_SETTINGS::FormatAsString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::Internals(), JSON_SETTINGS::JSON_SETTINGS(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromRawFile(), JSON_SETTINGS::Migrate(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::migrateSchema0to1(), NET_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema1to2(), NET_SETTINGS::migrateSchema2to3(), NET_SETTINGS::migrateSchema3to4(), JSON_SETTINGS::SaveToFile(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::Set().
bool KICAD_SETTINGS::m_KiCadUpdateCheck |
Definition at line 57 of file kicad_settings.h.
Referenced by KICAD_SETTINGS(), KICAD_MANAGER_FRAME::OnIdle(), PANEL_PACKAGES_AND_UPDATES::TransferDataFromWindow(), DIALOG_UPDATE_CHECK_PROMPT::TransferDataFromWindow(), and PANEL_PACKAGES_AND_UPDATES::TransferDataToWindow().
wxString KICAD_SETTINGS::m_lastDesignBlockLibDir |
Definition at line 42 of file kicad_settings.h.
Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE::browseLibrariesHandler(), KICAD_SETTINGS(), and PANEL_DESIGN_BLOCK_LIB_TABLE::PANEL_DESIGN_BLOCK_LIB_TABLE().
wxString KICAD_SETTINGS::m_lastReceivedUpdate |
Definition at line 59 of file kicad_settings.h.
Referenced by UPDATE_MANAGER::CheckForUpdate(), and KICAD_SETTINGS().
wxString KICAD_SETTINGS::m_lastUpdateCheckTime |
Definition at line 58 of file kicad_settings.h.
Referenced by UPDATE_MANAGER::CheckForUpdate(), and KICAD_SETTINGS().
int KICAD_SETTINGS::m_LeftWinWidth |
Definition at line 37 of file kicad_settings.h.
Referenced by KICAD_SETTINGS().
|
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().
|
inherited |
Definition at line 166 of file app_settings.h.
Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), and LIB_TREE_MODEL_ADAPTER::SaveSettings().
|
protectedinherited |
The location of this settings file (.
Definition at line 310 of file json_settings.h.
|
protectedinherited |
A pointer to the settings manager managing this file (may be null)
Definition at line 340 of file json_settings.h.
Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and JSON_SETTINGS::ReleaseNestedSettings().
|
protectedinherited |
A map of starting schema version to a pair of <ending version, migrator function>
Definition at line 343 of file json_settings.h.
Referenced by JSON_SETTINGS::Migrate(), and JSON_SETTINGS::registerMigration().
|
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().
std::vector<wxString> KICAD_SETTINGS::m_OpenProjects |
Definition at line 40 of file kicad_settings.h.
Referenced by KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_SETTINGS(), and PGM_KICAD::OnPgmInit().
|
protectedinherited |
The list of parameters (owned by this object)
Definition at line 313 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(), 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::JSON_SETTINGS(), KICAD_SETTINGS(), JSON_SETTINGS::Load(), 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(), JSON_SETTINGS::ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), JSON_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SETTINGS::SPICE_SETTINGS(), JSON_SETTINGS::Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and JSON_SETTINGS::~JSON_SETTINGS().
wxString KICAD_SETTINGS::m_PcmLastDownloadDir |
Definition at line 45 of file kicad_settings.h.
Referenced by KICAD_SETTINGS(), and PANEL_PACKAGES_VIEW::OnDownloadVersionClicked().
bool KICAD_SETTINGS::m_PcmLibAutoAdd |
Definition at line 51 of file kicad_settings.h.
Referenced by KICAD_SETTINGS(), DESIGN_BLOCK_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), KICAD_MANAGER_CONTROL::ShowPluginManager(), PANEL_PACKAGES_AND_UPDATES::TransferDataFromWindow(), and PANEL_PACKAGES_AND_UPDATES::TransferDataToWindow().
bool KICAD_SETTINGS::m_PcmLibAutoRemove |
Definition at line 53 of file kicad_settings.h.
Referenced by KICAD_SETTINGS(), DESIGN_BLOCK_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), KICAD_MANAGER_CONTROL::ShowPluginManager(), PANEL_PACKAGES_AND_UPDATES::TransferDataFromWindow(), and PANEL_PACKAGES_AND_UPDATES::TransferDataToWindow().
wxString KICAD_SETTINGS::m_PcmLibPrefix |
Definition at line 55 of file kicad_settings.h.
Referenced by KICAD_SETTINGS(), DESIGN_BLOCK_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), PANEL_PACKAGES_AND_UPDATES::TransferDataFromWindow(), and PANEL_PACKAGES_AND_UPDATES::TransferDataToWindow().
std::vector<std::pair<wxString, wxString> > KICAD_SETTINGS::m_PcmRepositories |
Definition at line 44 of file kicad_settings.h.
Referenced by KICAD_MANAGER_FRAME::CreatePCM(), KICAD_SETTINGS(), and DIALOG_PCM::OnManageRepositoriesClicked().
bool KICAD_SETTINGS::m_PcmUpdateCheck |
Definition at line 49 of file kicad_settings.h.
Referenced by KICAD_SETTINGS(), KICAD_MANAGER_FRAME::OnIdle(), PANEL_PACKAGES_AND_UPDATES::TransferDataFromWindow(), DIALOG_UPDATE_CHECK_PROMPT::TransferDataFromWindow(), and PANEL_PACKAGES_AND_UPDATES::TransferDataToWindow().
|
inherited |
Definition at line 168 of file app_settings.h.
Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), PRINTOUT_SETTINGS::Load(), BOARD_PRINTOUT_SETTINGS::Load(), DIALOG_PRINT_PCBNEW::onColorModeClicked(), DIALOG_PRINT_USING_PRINTER::OnOutputChoice(), SCH_PRINTOUT::PrintPage(), PRINTOUT_SETTINGS::Save(), BOARD_PRINTOUT_SETTINGS::Save(), DIALOG_PRINT_USING_PRINTER::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), and DIALOG_PRINT_PCBNEW::TransferDataToWindow().
|
protectedinherited |
Whether or not to set parameters to their default value if missing from JSON on Load()
Definition at line 334 of file json_settings.h.
Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and JSON_SETTINGS::Load().
|
protectedinherited |
Version of this settings schema.
Definition at line 337 of file json_settings.h.
Referenced by JSON_SETTINGS::JSON_SETTINGS(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::Migrate(), JSON_SETTINGS::registerMigration(), and NESTED_SETTINGS::SaveToFile().
|
inherited |
Definition at line 170 of file app_settings.h.
Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), AskLoadBoardFileName(), PNS_KICAD_IFACE::GetUnits(), FILE_HISTORY::Load(), EDA_DRAW_FRAME::LoadSettings(), SCH_EDIT_FRAME::OnImportProject(), FILE_HISTORY::Save(), SCH_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), EDA_DRAW_FRAME::setupUnits(), and PCB_TUNING_PATTERN::Update().
|
inherited |
Definition at line 172 of file app_settings.h.
Referenced by APP_SETTINGS_BASE::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().
|
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().