KiCad PCB EDA Suite
|
The project local settings are things that are attached to a particular project, but also might be particular to a certain user editing that project, or change quickly, and therefore may not want to be checked in to version control or otherwise distributed with the main project. More...
#include <project_local_settings.h>
Public Member Functions | |
PROJECT_LOCAL_SETTINGS (PROJECT *aProject, const wxString &aFilename) | |
virtual | ~PROJECT_LOCAL_SETTINGS () |
bool | MigrateFromLegacy (wxConfigBase *aLegacyConfig) override |
Migrates from wxConfig to JSON-based configuration. | |
bool | SaveAs (const wxString &aDirectory, const wxString &aFile) |
bool | SaveToFile (const wxString &aDirectory="", bool aForce=false) override |
Calls Store() and then writes the contents of the JSON document to a file. | |
void | SetProject (PROJECT *aProject) |
void | SaveFileState (const wxString &aFileName, const WINDOW_SETTINGS *aWindowCfg, bool aOpen) |
const PROJECT_FILE_STATE * | GetFileState (const wxString &aFileName) |
void | ClearFileState () |
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() | |
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 | |
std::vector< PROJECT_FILE_STATE > | m_files |
Project scope. | |
LSET | m_VisibleLayers |
Board settings. | |
GAL_SET | m_VisibleItems |
The GAL layers (aka items) that are turned on for viewing (. | |
PCB_LAYER_ID | m_ActiveLayer |
The current (active) board layer for editing. | |
wxString | m_ActiveLayerPreset |
The name of a LAYER_PRESET that is currently activated (or blank if none) | |
HIGH_CONTRAST_MODE | m_ContrastModeDisplay |
The current contrast mode. | |
NET_COLOR_MODE | m_NetColorMode |
The current net color mode. | |
PANEL_NET_INSPECTOR_SETTINGS | m_NetInspectorPanel |
The state of the net inspector panel. | |
bool | m_AutoTrackWidth |
The current setting for whether to automatically adjust track widths to match. | |
ZONE_DISPLAY_MODE | m_ZoneDisplayMode |
How zones are drawn. | |
double | m_TrackOpacity |
Opacity override for all tracks. | |
double | m_ViaOpacity |
Opacity override for all types of via. | |
double | m_PadOpacity |
Opacity override for SMD pads and PTH. | |
double | m_ZoneOpacity |
Opacity override for filled zones. | |
double | m_ShapeOpacity |
Opacity override for graphic shapes. | |
double | m_ImageOpacity |
Opacity override for user images. | |
std::vector< wxString > | m_HiddenNets |
A list of netnames that have been manually hidden in the board editor. | |
std::set< wxString > | m_HiddenNetclasses |
PCB_SELECTION_FILTER_OPTIONS | m_PcbSelectionFilter |
State of the selection filter widgets. | |
SCH_SELECTION_FILTER_OPTIONS | m_SchSelectionFilter |
wxString | m_GitRepoUsername |
wxString | m_GitRepoPassword |
wxString | m_GitRepoType |
wxString | m_GitSSHKey |
Protected Member Functions | |
wxString | getFileExt () const override |
wxString | getLegacyFileExt () const override |
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. | |
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 |
Private Attributes | |
PROJECT * | m_project |
A link to the owning project. | |
The project local settings are things that are attached to a particular project, but also might be particular to a certain user editing that project, or change quickly, and therefore may not want to be checked in to version control or otherwise distributed with the main project.
Examples include layer visibility, recently-used design entry settings, and so on.
The backing store is a JSON file named <project>.kicad_prl
This file doesn't need to exist for a project to be loaded. It will be created on-demand if any of the things stored here are modified by the user.
Definition at line 54 of file project_local_settings.h.
PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS | ( | PROJECT * | aProject, |
const wxString & | aFilename | ||
) |
Schema version 1 to 2: LAYER_PADS and LAYER_ZONES added to visibility controls
Schema version 2 to 3: Fix issue with object visibility not migrating from legacy, which required remapping of GAL_LAYER_ID to match the legacy bitmask ordering.
Stores a mapping from old to new enum offset
Definition at line 31 of file project_local_settings.cpp.
References LSET::AllLayersMask(), PANEL_NET_INSPECTOR_SETTINGS::custom_group_rules, GAL_SET::DefaultVisible(), PCB_SELECTION_FILTER_OPTIONS::dimensions, F_Cu, F_Fab, PANEL_NET_INSPECTOR_SETTINGS::filter_by_net_name, PANEL_NET_INSPECTOR_SETTINGS::filter_by_netclass, PANEL_NET_INSPECTOR_SETTINGS::filter_text, LSET::FmtHex(), PCB_SELECTION_FILTER_OPTIONS::footprints, PCB_SELECTION_FILTER_OPTIONS::graphics, PANEL_NET_INSPECTOR_SETTINGS::group_by_constraint, PANEL_NET_INSPECTOR_SETTINGS::group_by_netclass, PCB_SELECTION_FILTER_OPTIONS::keepouts, PCB_SELECTION_FILTER_OPTIONS::lockedItems, m_ActiveLayer, m_ActiveLayerPreset, m_AutoTrackWidth, m_ContrastModeDisplay, JSON_SETTINGS::m_deleteLegacyAfterMigration, m_GitRepoPassword, m_GitRepoType, m_GitRepoUsername, m_GitSSHKey, m_HiddenNetclasses, m_HiddenNets, m_ImageOpacity, m_NetColorMode, m_NetInspectorPanel, m_PadOpacity, JSON_SETTINGS::m_params, m_PcbSelectionFilter, m_ShapeOpacity, m_TrackOpacity, m_ViaOpacity, m_VisibleItems, m_VisibleLayers, m_ZoneDisplayMode, m_ZoneOpacity, PCB_SELECTION_FILTER_OPTIONS::otherItems, PCB_SELECTION_FILTER_OPTIONS::pads, LSET::ParseHex(), PCBNEW_LAYER_ID_START, GAL_SET::set(), JSON_SETTINGS::SetIfPresent(), PCB_SELECTION_FILTER_OPTIONS::text, PCB_SELECTION_FILTER_OPTIONS::tracks, PCB_SELECTION_FILTER_OPTIONS::vias, and PCB_SELECTION_FILTER_OPTIONS::zones.
|
inlinevirtual |
Definition at line 59 of file project_local_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().
|
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().
void PROJECT_LOCAL_SETTINGS::ClearFileState | ( | ) |
Definition at line 513 of file project_local_settings.cpp.
References m_files.
Referenced by KICAD_MANAGER_FRAME::OnIdle().
|
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().
|
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().
|
inlineoverrideprotectedvirtual |
Reimplemented from JSON_SETTINGS.
Definition at line 76 of file project_local_settings.h.
References FILEEXT::ProjectLocalSettingsFileExtension.
|
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().
const PROJECT_FILE_STATE * PROJECT_LOCAL_SETTINGS::GetFileState | ( | const wxString & | aFileName | ) |
Definition at line 465 of file project_local_settings.cpp.
References m_files.
Referenced by EDA_BASE_FRAME::LoadWindowState().
|
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().
|
inlineoverrideprotectedvirtual |
Reimplemented from JSON_SETTINGS.
Definition at line 81 of file project_local_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().
|
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 |
The normal legacy migration code won't be used for this because the only legacy information stored here was stored in board files, so we do that migration when loading the board.
Reimplemented from JSON_SETTINGS.
Definition at line 435 of file project_local_settings.cpp.
|
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().
bool PROJECT_LOCAL_SETTINGS::SaveAs | ( | const wxString & | aDirectory, |
const wxString & | aFile | ||
) |
Definition at line 456 of file project_local_settings.cpp.
References FILEEXT::ProjectLocalSettingsFileExtension, JSON_SETTINGS::SaveToFile(), JSON_SETTINGS::Set(), and JSON_SETTINGS::SetFilename().
Referenced by SAVE_AS_TRAVERSER::OnFile(), and ROUTER_TOOL::saveRouterDebugLog().
void PROJECT_LOCAL_SETTINGS::SaveFileState | ( | const wxString & | aFileName, |
const WINDOW_SETTINGS * | aWindowCfg, | ||
bool | aOpen | ||
) |
Definition at line 482 of file project_local_settings.cpp.
References WINDOW_STATE::display, PROJECT_FILE_STATE::fileName, m_files, WINDOW_STATE::maximized, PROJECT_FILE_STATE::open, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, WINDOW_SETTINGS::state, and PROJECT_FILE_STATE::window.
Referenced by EDA_BASE_FRAME::SaveSettings(), and KICAD_MANAGER_CONTROL::ShowPlayer().
|
overridevirtual |
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 from JSON_SETTINGS.
Definition at line 446 of file project_local_settings.cpp.
References PROJECT::GetProjectName(), m_project, FILEEXT::ProjectLocalSettingsFileExtension, JSON_SETTINGS::SaveToFile(), and JSON_SETTINGS::Set().
Referenced by SETTINGS_MANAGER::SaveProject(), KICAD_MANAGER_CONTROL::SaveProjectAs(), SETTINGS_MANAGER::SaveProjectAs(), SETTINGS_MANAGER::SaveProjectCopy(), and KICAD_MANAGER_CONTROL::ShowPlayer().
|
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(), KICAD_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), SaveAs(), PROJECT_FILE::SaveToFile(), 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(), 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(), 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.
|
inline |
Definition at line 67 of file project_local_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().
PCB_LAYER_ID PROJECT_LOCAL_SETTINGS::m_ActiveLayer |
The current (active) board layer for editing.
Definition at line 106 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::onBoardLoaded(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
wxString PROJECT_LOCAL_SETTINGS::m_ActiveLayerPreset |
The name of a LAYER_PRESET that is currently activated (or blank if none)
Definition at line 109 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::onBoardLoaded(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
bool PROJECT_LOCAL_SETTINGS::m_AutoTrackWidth |
The current setting for whether to automatically adjust track widths to match.
Definition at line 121 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
HIGH_CONTRAST_MODE PROJECT_LOCAL_SETTINGS::m_ContrastModeDisplay |
The current contrast mode.
Definition at line 112 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
|
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().
|
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().
|
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().
std::vector<PROJECT_FILE_STATE> PROJECT_LOCAL_SETTINGS::m_files |
Project scope.
File based state
Definition at line 93 of file project_local_settings.h.
Referenced by ClearFileState(), GetFileState(), and SaveFileState().
wxString PROJECT_LOCAL_SETTINGS::m_GitRepoPassword |
Definition at line 146 of file project_local_settings.h.
Referenced by KICAD_MANAGER_CONTROL::NewFromRepository(), PROJECT_TREE_PANE::onGitInitializeProject(), and PROJECT_LOCAL_SETTINGS().
wxString PROJECT_LOCAL_SETTINGS::m_GitRepoType |
Definition at line 147 of file project_local_settings.h.
Referenced by KICAD_MANAGER_CONTROL::NewFromRepository(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_LOCAL_SETTINGS(), and PROJECT_TREE_PANE::ReCreateTreePrj().
wxString PROJECT_LOCAL_SETTINGS::m_GitRepoUsername |
Definition at line 145 of file project_local_settings.h.
Referenced by KICAD_MANAGER_CONTROL::NewFromRepository(), PROJECT_TREE_PANE::onGitInitializeProject(), and PROJECT_LOCAL_SETTINGS().
wxString PROJECT_LOCAL_SETTINGS::m_GitSSHKey |
Definition at line 148 of file project_local_settings.h.
Referenced by KICAD_MANAGER_CONTROL::NewFromRepository(), PROJECT_TREE_PANE::onGitInitializeProject(), and PROJECT_LOCAL_SETTINGS().
std::set<wxString> PROJECT_LOCAL_SETTINGS::m_HiddenNetclasses |
Definition at line 138 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), APPEARANCE_CONTROLS::rebuildNets(), and APPEARANCE_CONTROLS::showNetclass().
std::vector<wxString> PROJECT_LOCAL_SETTINGS::m_HiddenNets |
A list of netnames that have been manually hidden in the board editor.
Currently, hiding nets means hiding the ratsnest for those nets.
Definition at line 137 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
double PROJECT_LOCAL_SETTINGS::m_ImageOpacity |
Opacity override for user images.
Definition at line 131 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
|
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().
|
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().
|
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().
NET_COLOR_MODE PROJECT_LOCAL_SETTINGS::m_NetColorMode |
The current net color mode.
Definition at line 115 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
PANEL_NET_INSPECTOR_SETTINGS PROJECT_LOCAL_SETTINGS::m_NetInspectorPanel |
The state of the net inspector panel.
Definition at line 118 of file project_local_settings.h.
Referenced by PCB_NET_INSPECTOR_PANEL::buildColumns(), PCB_NET_INSPECTOR_PANEL::buildNetsList(), PCB_NET_INSPECTOR_PANEL::netFilterMatches(), PCB_NET_INSPECTOR_PANEL::OnBoardChanged(), PCB_NET_INSPECTOR_PANEL::OnConfigButton(), PROJECT_LOCAL_SETTINGS(), and PCB_NET_INSPECTOR_PANEL::SaveSettings().
double PROJECT_LOCAL_SETTINGS::m_PadOpacity |
Opacity override for SMD pads and PTH.
Definition at line 128 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
|
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::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(), 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().
PCB_SELECTION_FILTER_OPTIONS PROJECT_LOCAL_SETTINGS::m_PcbSelectionFilter |
State of the selection filter widgets.
Definition at line 141 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
|
private |
A link to the owning project.
Definition at line 152 of file project_local_settings.h.
Referenced by SaveToFile().
|
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().
SCH_SELECTION_FILTER_OPTIONS PROJECT_LOCAL_SETTINGS::m_SchSelectionFilter |
Definition at line 142 of file project_local_settings.h.
Referenced by SCH_EDIT_FRAME::LoadProjectSettings(), and SCH_EDIT_FRAME::SaveProjectLocalSettings().
double PROJECT_LOCAL_SETTINGS::m_ShapeOpacity |
Opacity override for graphic shapes.
Definition at line 130 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
double PROJECT_LOCAL_SETTINGS::m_TrackOpacity |
Opacity override for all tracks.
Definition at line 126 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
double PROJECT_LOCAL_SETTINGS::m_ViaOpacity |
Opacity override for all types of via.
Definition at line 127 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
GAL_SET PROJECT_LOCAL_SETTINGS::m_VisibleItems |
The GAL layers (aka items) that are turned on for viewing (.
Definition at line 103 of file project_local_settings.h.
Referenced by BOARD::GetVisibleElements(), BOARD::IsElementVisible(), PCB_EDIT_FRAME::OpenProjectFiles(), PROJECT_LOCAL_SETTINGS(), and BOARD::SetElementVisibility().
LSET PROJECT_LOCAL_SETTINGS::m_VisibleLayers |
Board settings.
The board layers that are turned on for viewing (
Definition at line 100 of file project_local_settings.h.
Referenced by BOARD::GetVisibleLayers(), BOARD::IsLayerVisible(), PCB_EDIT_FRAME::OpenProjectFiles(), PROJECT_LOCAL_SETTINGS(), and BOARD::SetVisibleLayers().
|
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().
ZONE_DISPLAY_MODE PROJECT_LOCAL_SETTINGS::m_ZoneDisplayMode |
How zones are drawn.
Definition at line 124 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().
double PROJECT_LOCAL_SETTINGS::m_ZoneOpacity |
Opacity override for filled zones.
Definition at line 129 of file project_local_settings.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().