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 | Private Member Functions | Static Private Member Functions | List of all members
EESCHEMA_SETTINGS Class Reference

#include <eeschema_settings.h>

Inheritance diagram for EESCHEMA_SETTINGS:
APP_SETTINGS_BASE JSON_SETTINGS

Classes

struct  APPEARANCE
 
struct  AUI_PANELS
 
struct  AUTOPLACE_FIELDS
 
struct  BOM_PLUGIN_SETTINGS
 
struct  DIALOG_IMPORT_GRAPHICS
 
struct  DRAWING
 
struct  FIND_REPLACE_EXTRA
 
struct  INPUT
 
struct  NETLIST_PLUGIN_SETTINGS
 
struct  PAGE_SETTINGS
 
struct  PANEL_ANNOTATE
 
struct  PANEL_BOM
 
struct  PANEL_FIELD_EDITOR
 
struct  PANEL_LIB_VIEW
 
struct  PANEL_NETLIST
 
struct  PANEL_SYM_CHOOSER
 
struct  SELECTION
 
struct  SIMULATOR
 

Public Member Functions

 EESCHEMA_SETTINGS ()
 
virtual ~EESCHEMA_SETTINGS ()
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig) 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<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 std::vector< BOM_PLUGIN_SETTINGS > DefaultBomPlugins ()
 
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

APPEARANCE m_Appearance
 
AUTOPLACE_FIELDS m_AutoplaceFields
 
AUI_PANELS m_AuiPanels
 
DRAWING m_Drawing
 
FIND_REPLACE_EXTRA m_FindReplaceExtra
 
INPUT m_Input
 
PAGE_SETTINGS m_PageSettings
 
PANEL_ANNOTATE m_AnnotatePanel
 
PANEL_BOM m_BomPanel
 
PANEL_FIELD_EDITOR m_FieldEditorPanel
 
PANEL_LIB_VIEW m_LibViewPanel
 
PANEL_NETLIST m_NetlistPanel
 
PANEL_SYM_CHOOSER m_SymChooserPanel
 
DIALOG_IMPORT_GRAPHICS m_ImportGraphics
 
SELECTION m_Selection
 
SIMULATOR m_Simulator
 
bool m_RescueNeverShow
 
wxString m_lastSymbolLibDir
 
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 override
 
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
 

Private Member Functions

bool migrateBomSettings ()
 
nlohmann::json bomSettingsToJson () const
 
nlohmann::json netlistSettingsToJson () const
 

Static Private Member Functions

static std::vector< BOM_PLUGIN_SETTINGS > bomSettingsFromJson (const nlohmann::json &aObj)
 
static std::vector< NETLIST_PLUGIN_SETTINGS > netlistSettingsFromJson (const nlohmann::json &aObj)
 

Detailed Description

Definition at line 58 of file eeschema_settings.h.

Constructor & Destructor Documentation

◆ EESCHEMA_SETTINGS()

EESCHEMA_SETTINGS::EESCHEMA_SETTINGS ( )

Definition at line 152 of file eeschema_settings.cpp.

References APP_SETTINGS_BASE::addParamsForWindow(), EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::align_to_grid, EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::allow_rejustify, EESCHEMA_SETTINGS::DRAWING::arc_edit_mode, EESCHEMA_SETTINGS::DRAWING::auto_start_wires, EESCHEMA_SETTINGS::PANEL_ANNOTATE::automatic, bomSettingsFromJson(), bomSettingsToJson(), EESCHEMA_SETTINGS::PANEL_LIB_VIEW::cmp_list_width, EESCHEMA_SETTINGS::SIMULATOR::VIEW::cursors_panel_height, EESCHEMA_SETTINGS::DRAWING::default_bus_thickness, DEFAULT_BUS_WIDTH_MILS, EESCHEMA_SETTINGS::APPEARANCE::default_font, DEFAULT_JUNCTION_DIAM, EESCHEMA_SETTINGS::DRAWING::default_junction_size, EESCHEMA_SETTINGS::DRAWING::default_line_thickness, DEFAULT_LINE_WIDTH_MILS, EESCHEMA_SETTINGS::DRAWING::default_repeat_offset_x, EESCHEMA_SETTINGS::DRAWING::default_repeat_offset_y, EESCHEMA_SETTINGS::DRAWING::default_sheet_background_color, EESCHEMA_SETTINGS::DRAWING::default_sheet_border_color, DEFAULT_TEXT_SIZE, EESCHEMA_SETTINGS::DRAWING::default_text_size, EESCHEMA_SETTINGS::DRAWING::default_wire_thickness, DEFAULT_WIRE_WIDTH_MILS, defaultBomPlugins, EESCHEMA_SETTINGS::AUI_PANELS::design_blocks_panel_docked_width, EESCHEMA_SETTINGS::AUI_PANELS::design_blocks_panel_float_height, EESCHEMA_SETTINGS::AUI_PANELS::design_blocks_panel_float_width, EESCHEMA_SETTINGS::AUI_PANELS::design_blocks_show, EESCHEMA_SETTINGS::INPUT::drag_is_move, EESCHEMA_SETTINGS::SELECTION::draw_selected_children, EESCHEMA_SETTINGS::DIALOG_IMPORT_GRAPHICS::dxf_line_width, EESCHEMA_SETTINGS::DIALOG_IMPORT_GRAPHICS::dxf_line_width_units, EESCHEMA_SETTINGS::DIALOG_IMPORT_GRAPHICS::dxf_units, EESCHEMA_SETTINGS::APPEARANCE::edit_label_height, EESCHEMA_SETTINGS::APPEARANCE::edit_label_visible_columns, EESCHEMA_SETTINGS::APPEARANCE::edit_label_width, EESCHEMA_SETTINGS::APPEARANCE::edit_sheet_visible_columns, EESCHEMA_SETTINGS::APPEARANCE::edit_symbol_height, EESCHEMA_SETTINGS::APPEARANCE::edit_symbol_visible_columns, EESCHEMA_SETTINGS::APPEARANCE::edit_symbol_width, EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::enable, EESCHEMA_SETTINGS::APPEARANCE::erc_severities, EESCHEMA_SETTINGS::INPUT::esc_clears_net_highlight, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment1, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment2, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment3, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment4, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment5, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment6, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment7, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment8, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment9, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_company, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_date, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::export_filename, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_paper, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_revision, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_title, EESCHEMA_SETTINGS::DRAWING::field_names, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::field_widths, EESCHEMA_SETTINGS::SELECTION::fill_shapes, EESCHEMA_SETTINGS::AUI_PANELS::float_net_nav_panel, EESCHEMA_SETTINGS::APPEARANCE::footprint_preview, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::height, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::height, EESCHEMA_SETTINGS::AUI_PANELS::hierarchy_panel_docked_height, EESCHEMA_SETTINGS::AUI_PANELS::hierarchy_panel_docked_width, EESCHEMA_SETTINGS::AUI_PANELS::hierarchy_panel_float_height, EESCHEMA_SETTINGS::AUI_PANELS::hierarchy_panel_float_width, EESCHEMA_SETTINGS::SELECTION::highlight_netclass_colors, EESCHEMA_SETTINGS::SELECTION::highlight_netclass_colors_alpha, EESCHEMA_SETTINGS::SELECTION::highlight_netclass_colors_thickness, EESCHEMA_SETTINGS::SELECTION::highlight_thickness, EESCHEMA_SETTINGS::DRAWING::hop_over_size_choice, SIM_MOUSE_WHEEL_ACTION_SET::horizontal, EESCHEMA_SETTINGS::DIALOG_IMPORT_GRAPHICS::interactive_placement, EESCHEMA_SETTINGS::DRAWING::junction_size_choice, EESCHEMA_SETTINGS::DRAWING::junction_size_mult_list, EESCHEMA_SETTINGS::PANEL_LIB_VIEW::lib_list_width, EESCHEMA_SETTINGS::DRAWING::line_mode, m_AnnotatePanel, m_Appearance, m_AuiPanels, m_AutoplaceFields, m_BomPanel, m_Drawing, m_FieldEditorPanel, m_FindReplaceExtra, m_ImportGraphics, m_Input, m_lastSymbolLibDir, m_LibViewPanel, m_NetlistPanel, m_PageSettings, JSON_SETTINGS::m_params, m_RescueNeverShow, m_Selection, m_Simulator, m_SymChooserPanel, EESCHEMA_SETTINGS::APPEARANCE::mark_sim_exclusions, EESCHEMA_SETTINGS::SIMULATOR::VIEW::measurements_panel_height, EESCHEMA_SETTINGS::PANEL_ANNOTATE::messages_filter, EESCHEMA_SETTINGS::PANEL_ANNOTATE::method, migrateBomSettings(), APP_SETTINGS_BASE::migrateLibTreeWidth(), SIM_PREFERENCES::mouse_wheel_actions, EESCHEMA_SETTINGS::AUI_PANELS::net_nav_panel_docked_size, EESCHEMA_SETTINGS::AUI_PANELS::net_nav_panel_float_pos, EESCHEMA_SETTINGS::AUI_PANELS::net_nav_panel_float_size, netlistSettingsFromJson(), netlistSettingsToJson(), EESCHEMA_SETTINGS::DRAWING::new_power_symbols, EESCHEMA_SETTINGS::PANEL_ANNOTATE::options, EESCHEMA_SETTINGS::DIALOG_IMPORT_GRAPHICS::origin_units, EESCHEMA_SETTINGS::DIALOG_IMPORT_GRAPHICS::origin_x, EESCHEMA_SETTINGS::DIALOG_IMPORT_GRAPHICS::origin_y, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::page, EESCHEMA_SETTINGS::DRAWING::pin_symbol_size, EESCHEMA_SETTINGS::SIMULATOR::VIEW::plot_panel_height, EESCHEMA_SETTINGS::SIMULATOR::VIEW::plot_panel_width, EESCHEMA_SETTINGS::PANEL_BOM::plugins, EESCHEMA_SETTINGS::PANEL_NETLIST::plugins, EESCHEMA_SETTINGS::SIMULATOR::preferences, EESCHEMA_SETTINGS::APPEARANCE::print_sheet_reference, EESCHEMA_SETTINGS::AUI_PANELS::properties_panel_width, EESCHEMA_SETTINGS::AUI_PANELS::properties_splitter, EESCHEMA_SETTINGS::PANEL_ANNOTATE::recursive, JSON_SETTINGS::registerMigration(), EESCHEMA_SETTINGS::DRAWING::repeat_label_increment, EESCHEMA_SETTINGS::FIND_REPLACE_EXTRA::replace_references, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::sash_pos_h, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::sash_pos_v, EESCHEMA_SETTINGS::AUI_PANELS::schematic_hierarchy_float, EESCHEMA_SETTINGS::PANEL_ANNOTATE::scope, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::scope, EESCHEMA_SETTINGS::FIND_REPLACE_EXTRA::search_all_fields, EESCHEMA_SETTINGS::FIND_REPLACE_EXTRA::search_all_pins, EESCHEMA_SETTINGS::FIND_REPLACE_EXTRA::search_current_sheet_only, EESCHEMA_SETTINGS::AUI_PANELS::search_panel_dock_direction, EESCHEMA_SETTINGS::AUI_PANELS::search_panel_height, EESCHEMA_SETTINGS::AUI_PANELS::search_panel_width, EESCHEMA_SETTINGS::PANEL_BOM::selected_plugin, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::selection_mode, EESCHEMA_SETTINGS::SELECTION::selection_thickness, JSON_SETTINGS::Set(), EESCHEMA_SETTINGS::APPEARANCE::show_directive_labels, EESCHEMA_SETTINGS::APPEARANCE::show_erc_errors, EESCHEMA_SETTINGS::APPEARANCE::show_erc_exclusions, EESCHEMA_SETTINGS::APPEARANCE::show_erc_warnings, EESCHEMA_SETTINGS::APPEARANCE::show_hidden_fields, EESCHEMA_SETTINGS::APPEARANCE::show_hidden_pins, EESCHEMA_SETTINGS::APPEARANCE::show_illegal_symbol_lib_dialog, EESCHEMA_SETTINGS::AUI_PANELS::show_net_nav_panel, EESCHEMA_SETTINGS::APPEARANCE::show_op_currents, EESCHEMA_SETTINGS::APPEARANCE::show_op_voltages, EESCHEMA_SETTINGS::APPEARANCE::show_page_limits, EESCHEMA_SETTINGS::APPEARANCE::show_pin_alt_icons, EESCHEMA_SETTINGS::PANEL_LIB_VIEW::show_pin_electrical_type, EESCHEMA_SETTINGS::AUI_PANELS::show_properties, EESCHEMA_SETTINGS::AUI_PANELS::show_schematic_hierarchy, EESCHEMA_SETTINGS::AUI_PANELS::show_search, EESCHEMA_SETTINGS::APPEARANCE::show_sexpr_file_convert_warning, EESCHEMA_SETTINGS::APPEARANCE::show_sheet_filename_case_sensitivity_dialog, EESCHEMA_SETTINGS::SIMULATOR::VIEW::signal_panel_height, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::sort_mode, EESCHEMA_SETTINGS::PANEL_ANNOTATE::sort_order, EESCHEMA_SETTINGS::DRAWING::text_offset_ratio, SIM_MOUSE_WHEEL_ACTION_SET::vertical_unmodified, SIM_MOUSE_WHEEL_ACTION_SET::vertical_with_alt, SIM_MOUSE_WHEEL_ACTION_SET::vertical_with_ctrl, SIM_MOUSE_WHEEL_ACTION_SET::vertical_with_shift, EESCHEMA_SETTINGS::SIMULATOR::view, EESCHEMA_SETTINGS::SIMULATOR::VIEW::white_background, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::width, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::width, EESCHEMA_SETTINGS::PANEL_LIB_VIEW::window, and EESCHEMA_SETTINGS::SIMULATOR::window.

◆ ~EESCHEMA_SETTINGS()

virtual EESCHEMA_SETTINGS::~EESCHEMA_SETTINGS ( )
inlinevirtual

Definition at line 311 of file eeschema_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 890 of file json_settings.cpp.

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

Referenced by NESTED_SETTINGS::SetParent().

◆ addParamsForWindow()

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

Add parameters for the given window object.

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

Definition at line 404 of file app_settings.cpp.

References CURSOR_SETTINGS::always_show_cursor, GRID_SETTINGS::axes_enabled, WINDOW_SETTINGS::cursor, APP_SETTINGS_BASE::DefaultGridSizeList(), APP_SETTINGS_BASE::DefaultZoomList(), 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 CVPCB_SETTINGS::CVPCB_SETTINGS(), EESCHEMA_SETTINGS(), and PCBNEW_SETTINGS::PCBNEW_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 JSON_SETTINGS::m_internals.

Referenced by EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_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().

◆ bomSettingsFromJson()

std::vector< EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS > EESCHEMA_SETTINGS::bomSettingsFromJson ( const nlohmann::json &  aObj)
staticprivate

Definition at line 998 of file eeschema_settings.cpp.

References EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::command.

Referenced by DefaultBomPlugins(), and EESCHEMA_SETTINGS().

◆ bomSettingsToJson()

nlohmann::json EESCHEMA_SETTINGS::bomSettingsToJson ( ) const
private

Definition at line 979 of file eeschema_settings.cpp.

References EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::command, m_BomPanel, EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::name, EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::path, and EESCHEMA_SETTINGS::PANEL_BOM::plugins.

Referenced by EESCHEMA_SETTINGS(), and migrateBomSettings().

◆ Contains()

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

Definition at line 125 of file json_settings.cpp.

References JSON_SETTINGS::m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

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

◆ DefaultBomPlugins()

std::vector< EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS > EESCHEMA_SETTINGS::DefaultBomPlugins ( )
static

Definition at line 948 of file eeschema_settings.cpp.

References bomSettingsFromJson(), and defaultBomPlugins.

Referenced by DIALOG_BOM::DIALOG_BOM().

◆ DefaultGridSizeList()

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

Definition at line 567 of file app_settings.cpp.

References JSON_SETTINGS::m_filename.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), and PANEL_GRID_SETTINGS::ResetPanel().

◆ DefaultZoomList()

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

Definition at line 543 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 APP_SETTINGS_BASE::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 938 of file json_settings.cpp.

◆ FormatAsString()

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

Definition at line 525 of file json_settings.cpp.

References dummy, JSON_SETTINGS::m_internals, and JSON_SETTINGS::Store().

Referenced by ROUTER_TOOL::saveRouterDebugLog().

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

◆ fromLegacyColor()

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

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

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

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

Referenced by PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), BITMAP2CMP_SETTINGS::MigrateFromLegacy(), 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().

◆ Get() [1/2]

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

Definition at line 921 of file json_settings.cpp.

References JSON_SETTINGS::GetJson().

◆ Get() [2/2]

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

Fetches a value from within the JSON document.

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

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

Definition at line 590 of file json_settings.cpp.

References JSON_SETTINGS::GetJson().

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

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

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

Definition at line 288 of file json_settings.h.

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

◆ GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const
inlineinherited

Definition at line 86 of file json_settings.h.

Referenced by JSON_SETTINGS::AddNestedSettings(), SETTINGS_MANAGER::loadColorSettingsByName(), NESTED_SETTINGS::LoadFromFile(), MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_COLOR_SETTINGS::OnLeftDownTheme(), 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(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), DIALOG_PRINT::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().

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 110 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().

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

References JSON_SETTINGS::m_internals.

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 293 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

virtual std::string EESCHEMA_SETTINGS::getLegacyFrameName ( ) const
inlineoverrideprotectedvirtual

Reimplemented from APP_SETTINGS_BASE.

Definition at line 319 of file eeschema_settings.h.

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 93 of file json_settings.h.

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 JSON_SETTINGS::m_internals.

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

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
inlineinherited

Definition at line 97 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().

◆ 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 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(), PCBNEW_SETTINGS::MigrateFromLegacy(), 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_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_FIELD_DEFAULTS::ResetPanel(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), SETTINGS_MANAGER::SaveColorSettings(), and SETTINGS_MANAGER::SETTINGS_MANAGER().

◆ 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 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_isFutureFormat, JSON_SETTINGS::m_legacy_filename, JSON_SETTINGS::m_modified, 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().

◆ LoadFromRawFile()

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

Definition at line 538 of file json_settings.cpp.

References JSON_SETTINGS::Load(), JSON_SETTINGS::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 689 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().

◆ migrateBomSettings()

bool EESCHEMA_SETTINGS::migrateBomSettings ( )
private

Definition at line 954 of file eeschema_settings.cpp.

References JSON_SETTINGS::At(), bomSettingsToJson(), JSON_SETTINGS::Contains(), m_BomPanel, BOM_CFG_PARSER::Parse(), EESCHEMA_SETTINGS::PANEL_BOM::plugins, and TO_UTF8.

Referenced by EESCHEMA_SETTINGS(), and MigrateFromLegacy().

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protectedinherited

! Migrates the find/replace history string list.s

Definition at line 342 of file app_settings.cpp.

References JSON_SETTINGS::Set().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().

◆ MigrateFromLegacy()

bool EESCHEMA_SETTINGS::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 APP_SETTINGS_BASE.

Definition at line 666 of file eeschema_settings.cpp.

References JSON_SETTINGS::fromLegacyString(), PGM_BASE::GetCommonSettings(), JSON_SETTINGS::GetFilename(), SETTINGS_MANAGER::GetMigratedColorSettings(), PGM_BASE::GetSettingsManager(), LAYER_BRIGHTENED, LAYER_BUS, LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LAYER_ERC_ERR, LAYER_ERC_WARN, LAYER_FIELDS, LAYER_GLOBLABEL, LAYER_HIDDEN, LAYER_HIERLABEL, LAYER_JUNCTION, LAYER_LOCLABEL, LAYER_NOCONNECT, LAYER_NOTES, LAYER_PIN, LAYER_PINNAM, LAYER_PINNUM, LAYER_REFERENCEPART, LAYER_SCHEMATIC_BACKGROUND, LAYER_SCHEMATIC_CURSOR, LAYER_SCHEMATIC_DRAWINGSHEET, LAYER_SCHEMATIC_GRID, LAYER_SELECTION_SHADOWS, LAYER_SHEET, LAYER_SHEETFILENAME, LAYER_SHEETLABEL, LAYER_SHEETNAME, LAYER_VALUEPART, LAYER_WIRE, COMMON_SETTINGS::m_Input, migrateBomSettings(), APP_SETTINGS_BASE::MigrateFromLegacy(), Pgm(), SETTINGS_MANAGER::SaveColorSettings(), JSON_SETTINGS::Set(), and COLOR_SETTINGS::SetColor().

◆ migrateLibTreeWidth()

bool APP_SETTINGS_BASE::migrateLibTreeWidth ( )
protectedinherited

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

Definition at line 640 of file app_settings.cpp.

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

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

◆ migrateWindowConfig()

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

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 366 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().

◆ netlistSettingsFromJson()

std::vector< EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS > EESCHEMA_SETTINGS::netlistSettingsFromJson ( const nlohmann::json &  aObj)
staticprivate

Definition at line 1045 of file eeschema_settings.cpp.

References EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::command.

Referenced by EESCHEMA_SETTINGS().

◆ netlistSettingsToJson()

nlohmann::json EESCHEMA_SETTINGS::netlistSettingsToJson ( ) const
private

Definition at line 1026 of file eeschema_settings.cpp.

References EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::command, m_NetlistPanel, EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::name, EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::path, and EESCHEMA_SETTINGS::PANEL_NETLIST::plugins.

Referenced by EESCHEMA_SETTINGS().

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

References JSON_SETTINGS::m_migrators, and JSON_SETTINGS::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(), PCBNEW_SETTINGS::PCBNEW_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 897 of file json_settings.cpp.

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

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

◆ 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 JSON_SETTINGS::m_params.

Referenced by PANEL_COMMON_SETTINGS::ResetPanel(), and PANEL_MOUSE_SETTINGS::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, PROJECT_FILE, PROJECT_LOCAL_SETTINGS, and NESTED_SETTINGS.

Definition at line 400 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_modified, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_params, JSON_SETTINGS::m_writeFile, path, JSON_SETTINGS_INTERNALS::PointerFromString(), 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().

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

References JSON_SETTINGS::m_internals.

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

◆ Set() [2/3]

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

Definition at line 931 of file json_settings.cpp.

◆ Set() [3/3]

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

◆ SetFilename()

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

Definition at line 90 of file json_settings.h.

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 753 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 768 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 783 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 738 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 95 of file json_settings.h.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation)
inlineinherited

Definition at line 92 of file json_settings.h.

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

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER *  aManager)
inlineinherited

Definition at line 204 of file json_settings.h.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

Definition at line 98 of file json_settings.h.

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 JSON_SETTINGS::m_modified, and JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_AnnotatePanel

PANEL_ANNOTATE EESCHEMA_SETTINGS::m_AnnotatePanel

Definition at line 346 of file eeschema_settings.h.

Referenced by SCH_DRAWING_TOOLS::DrawSheet(), EESCHEMA_SETTINGS(), SCH_DRAWING_TOOLS::ImportSheet(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::loadEEschemaSettings(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_FRAME::setupUIConditions(), SCH_EDITOR_CONTROL::ToggleAnnotateAuto(), SCH_EDITOR_CONTROL::ToggleAnnotateRecursive(), DIALOG_ANNOTATE::TransferDataToWindow(), and DIALOG_ANNOTATE::~DIALOG_ANNOTATE().

◆ m_Appearance

APPEARANCE EESCHEMA_SETTINGS::m_Appearance

Definition at line 332 of file eeschema_settings.h.

Referenced by SCH_EDIT_FRAME::AllowCaseSensitiveFileNameClashes(), SCH_SELECTION_TOOL::autostartEvent(), KIGFX::SCH_PAINTER::draw(), EESCHEMA_SETTINGS(), SCH_EDIT_FRAME::GetShowAllPins(), SCH_RENDER_SETTINGS::GetShowPageLimits(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PANEL_EESCHEMA_DISPLAY_OPTIONS::loadEEschemaSettings(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), SCH_EDIT_FRAME::LoadSettings(), SCH_EDITOR_CONTROL::MarkSimExclusions(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_PRINTOUT::PrintPage(), PIN_LAYOUT_CACHE::recomputeCaches(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SCH_SELECTION_TOOL::Selectable(), SCH_EDIT_FRAME::setupUIConditions(), SCH_EDITOR_CONTROL::ToggleDirectiveLabels(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCExclusions(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), SCH_EDITOR_CONTROL::ToggleOPCurrents(), SCH_EDITOR_CONTROL::ToggleOPVoltages(), and SCH_EDITOR_CONTROL::TogglePinAltIcons().

◆ m_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion
inherited

! Local schema version for common app settings.

Definition at line 243 of file app_settings.h.

◆ m_AuiPanels

AUI_PANELS EESCHEMA_SETTINGS::m_AuiPanels

Definition at line 336 of file eeschema_settings.h.

Referenced by SCH_EDIT_FRAME::CaptureHierarchyPaneSize(), EESCHEMA_SETTINGS(), SCH_EDIT_FRAME::LoadSettings(), SCH_EDIT_FRAME::onResizeNetNavigator(), SCH_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SCH_EDIT_FRAME::ToggleLibraryTree(), SCH_EDIT_FRAME::ToggleNetNavigator(), SCH_EDIT_FRAME::ToggleProperties(), SCH_EDIT_FRAME::ToggleSchematicHierarchy(), and SCH_EDIT_FRAME::ToggleSearch().

◆ m_AutoplaceFields

AUTOPLACE_FIELDS EESCHEMA_SETTINGS::m_AutoplaceFields

Definition at line 334 of file eeschema_settings.h.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_EDIT_TOOL::editFieldText(), EESCHEMA_SETTINGS(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), SCH_DRAWING_TOOLS::PlaceSymbol(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_EDIT_TOOL::Properties(), and SCH_EDIT_TOOL::Rotate().

◆ m_BomPanel

PANEL_BOM EESCHEMA_SETTINGS::m_BomPanel

Definition at line 348 of file eeschema_settings.h.

Referenced by bomSettingsToJson(), DIALOG_BOM::DIALOG_BOM(), EESCHEMA_SETTINGS(), DIALOG_BOM::installGeneratorsList(), migrateBomSettings(), and DIALOG_BOM::~DIALOG_BOM().

◆ m_ColorPicker

COLOR_PICKER APP_SETTINGS_BASE::m_ColorPicker
inherited

Definition at line 221 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().

◆ m_ColorTheme

wxString APP_SETTINGS_BASE::m_ColorTheme
inherited

Active color theme name.

Definition at line 236 of file app_settings.h.

Referenced by PL_EDITOR_FRAME::CommonSettingsChanged(), FOOTPRINT_CHOOSER_FRAME::GetColorSettings(), DISPLAY_FOOTPRINTS_FRAME::GetColorSettings(), SCH_BASE_FRAME::GetColorSettings(), SYMBOL_EDIT_FRAME::GetColorSettings(), GERBVIEW_FRAME::GetColorSettings(), FOOTPRINT_EDIT_FRAME::GetColorSettings(), FOOTPRINT_VIEWER_FRAME::GetColorSettings(), FOOTPRINT_WIZARD_FRAME::GetColorSettings(), PCB_BASE_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(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), DIALOG_PRINT::TransferDataToWindow(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataToWindow(), and DIALOG_PRINT_PCBNEW::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 331 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

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

Definition at line 325 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_CrossProbing

CROSS_PROBING_SETTINGS APP_SETTINGS_BASE::m_CrossProbing
inherited

Definition at line 213 of file app_settings.h.

Referenced by PCB_SELECTION_TOOL::doSyncSelection(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), PANEL_EESCHEMA_DISPLAY_OPTIONS::loadEEschemaSettings(), PANEL_DISPLAY_OPTIONS::loadPCBSettings(), and SCH_SELECTION_TOOL::SyncSelection().

◆ m_CustomToolbars

bool APP_SETTINGS_BASE::m_CustomToolbars
inherited

Use custom toolbars.

Definition at line 239 of file app_settings.h.

Referenced by PANEL_TOOLBAR_CUSTOMIZATION::TransferDataFromWindow(), and PANEL_TOOLBAR_CUSTOMIZATION::TransferDataToWindow().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 340 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
inherited

Definition at line 217 of file app_settings.h.

Referenced by FILEDLG_IMPORT_SHEET_CONTENTS::AddCustomControls(), FILEDLG_IMPORT_BOARD_CONTENTS::AddCustomControls(), APP_SETTINGS_BASE::APP_SETTINGS_BASE(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::ImportSheet(), PANEL_DESIGN_BLOCK_CHOOSER::PANEL_DESIGN_BLOCK_CHOOSER(), FILEDLG_IMPORT_SHEET_CONTENTS::TransferDataFromCustomControls(), and FILEDLG_IMPORT_BOARD_CONTENTS::TransferDataFromCustomControls().

◆ m_Drawing

DRAWING EESCHEMA_SETTINGS::m_Drawing

Definition at line 338 of file eeschema_settings.h.

Referenced by SCH_SELECTION_TOOL::autostartEvent(), SCH_POINT_EDITOR::changeArcEditMode(), SCH_EDITOR_CONTROL::ChangeLineMode(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawSheet(), EESCHEMA_SETTINGS(), SCH_EDIT_FRAME::GetSchematicHopOverScale(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SCH_EDITOR_CONDITIONS::lineModeFunc(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), SCH_EDITOR_CONTROL::NextLineMode(), DIALOG_SHAPE_PROPERTIES::onBorderChecked(), DIALOG_TABLE_PROPERTIES::onBorderChecked(), DIALOG_TEXT_PROPERTIES::onBorderChecked(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), and DIALOG_PLOT_SCHEMATIC::TransferDataToWindow().

◆ m_FieldEditorPanel

PANEL_FIELD_EDITOR EESCHEMA_SETTINGS::m_FieldEditorPanel

Definition at line 350 of file eeschema_settings.h.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset(), EESCHEMA_SETTINGS(), DIALOG_SYMBOL_FIELDS_TABLE::OnClose(), DIALOG_SYMBOL_FIELDS_TABLE::OnColMove(), and DIALOG_SYMBOL_FIELDS_TABLE::SetupAllColumnProperties().

◆ m_filename

wxString JSON_SETTINGS::m_filename
protectedinherited

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

Definition at line 310 of file json_settings.h.

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

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace
inherited

Definition at line 215 of file app_settings.h.

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

◆ m_FindReplaceExtra

FIND_REPLACE_EXTRA EESCHEMA_SETTINGS::m_FindReplaceExtra

Definition at line 340 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), SCH_EDIT_FRAME::LoadSettings(), and SCH_EDIT_FRAME::SaveSettings().

◆ m_Graphics

GRAPHICS APP_SETTINGS_BASE::m_Graphics
inherited

Definition at line 219 of file app_settings.h.

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

◆ m_ImportGraphics

DIALOG_IMPORT_GRAPHICS EESCHEMA_SETTINGS::m_ImportGraphics

Definition at line 358 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS().

◆ m_Input

INPUT EESCHEMA_SETTINGS::m_Input

Definition at line 342 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), and SCH_SELECTION_TOOL::Main().

◆ m_internals

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

Definition at line 357 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(), PROJECT_FILE::migrateSchema1To2(), COMMON_SETTINGS::migrateSchema1to2(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema2To3(), NET_SETTINGS::migrateSchema2to3(), PROJECT_FILE::migrateSchema2To3(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema3To4(), NET_SETTINGS::migrateSchema3to4(), COMMON_SETTINGS::migrateSchema3to4(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema4To5(), NET_SETTINGS::migrateSchema4to5(), JSON_SETTINGS::SaveToFile(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::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 349 of file json_settings.h.

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

◆ m_lastSymbolLibDir

wxString EESCHEMA_SETTINGS::m_lastSymbolLibDir

Definition at line 366 of file eeschema_settings.h.

Referenced by PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), and EESCHEMA_SETTINGS().

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

Referenced by JSON_SETTINGS::LoadFromFile().

◆ m_LibTree

LIB_TREE APP_SETTINGS_BASE::m_LibTree
inherited

Definition at line 223 of file app_settings.h.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE().

◆ m_LibViewPanel

PANEL_LIB_VIEW EESCHEMA_SETTINGS::m_LibViewPanel

Definition at line 352 of file eeschema_settings.h.

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

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 316 of file json_settings.h.

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 352 of file json_settings.h.

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

◆ m_migrators

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

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

Definition at line 355 of file json_settings.h.

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

◆ m_modified

bool JSON_SETTINGS::m_modified
protectedinherited

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

Definition at line 337 of file json_settings.h.

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

◆ m_nested_settings

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

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

Definition at line 322 of file json_settings.h.

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

◆ m_NetlistPanel

PANEL_NETLIST EESCHEMA_SETTINGS::m_NetlistPanel

Definition at line 354 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), DIALOG_EXPORT_NETLIST::InstallCustomPages(), netlistSettingsToJson(), and DIALOG_EXPORT_NETLIST::WriteCurrentNetlistSetup().

◆ m_PageSettings

PAGE_SETTINGS EESCHEMA_SETTINGS::m_PageSettings

Definition at line 344 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), SCH_EDIT_FRAME::InitSheet(), DIALOG_EESCHEMA_PAGE_SETTINGS::onTransferDataToWindow(), and DIALOG_EESCHEMA_PAGE_SETTINGS::~DIALOG_EESCHEMA_PAGE_SETTINGS().

◆ m_params

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

The list of parameters (owned by this object)

Definition at line 319 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(), 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::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(), TIME_DOMAIN_PARAMETERS::TIME_DOMAIN_PARAMETERS(), TOOLBAR_SETTINGS::TOOLBAR_SETTINGS(), and JSON_SETTINGS::~JSON_SETTINGS().

◆ m_Plugins

PLUGINS APP_SETTINGS_BASE::m_Plugins
inherited

Definition at line 231 of file app_settings.h.

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

◆ m_Printing

PRINTING APP_SETTINGS_BASE::m_Printing
inherited

Definition at line 225 of file app_settings.h.

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

◆ m_RescueNeverShow

bool EESCHEMA_SETTINGS::m_RescueNeverShow

Definition at line 364 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), DIALOG_RESCUE_EACH::OnNeverShowClick(), and SCH_EDIT_FRAME::OpenProjectFiles().

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

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

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

Version of this settings schema.

Definition at line 346 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().

◆ m_SearchPane

SEARCH_PANE APP_SETTINGS_BASE::m_SearchPane
inherited

Definition at line 227 of file app_settings.h.

Referenced by SEARCH_PANE_MENU::eventHandler(), SYMBOL_SEARCH_HANDLER::Search(), POWER_SEARCH_HANDLER::Search(), TEXT_SEARCH_HANDLER::Search(), LABEL_SEARCH_HANDLER::Search(), GROUP_SEARCH_HANDLER::Search(), FOOTPRINT_SEARCH_HANDLER::Search(), ZONE_SEARCH_HANDLER::Search(), NETS_SEARCH_HANDLER::Search(), RATSNEST_SEARCH_HANDLER::Search(), SCH_SEARCH_HANDLER::SelectItems(), PCB_SEARCH_HANDLER::SelectItems(), and SEARCH_PANE_MENU::updateZoomPanCheckboxes().

◆ m_Selection

SELECTION EESCHEMA_SETTINGS::m_Selection

Definition at line 360 of file eeschema_settings.h.

Referenced by KIGFX::SCH_PAINTER::draw(), EESCHEMA_SETTINGS(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getShadowWidth(), and PANEL_EESCHEMA_DISPLAY_OPTIONS::loadEEschemaSettings().

◆ m_Simulator

SIMULATOR EESCHEMA_SETTINGS::m_Simulator

Definition at line 362 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), SIMULATOR_FRAME_UI::LoadSettings(), and SIMULATOR_FRAME_UI::SaveSettings().

◆ m_SymChooserPanel

PANEL_SYM_CHOOSER EESCHEMA_SETTINGS::m_SymChooserPanel

Definition at line 356 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS().

◆ m_System

SYSTEM APP_SETTINGS_BASE::m_System
inherited

Definition at line 229 of file app_settings.h.

Referenced by 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().

◆ m_Window

WINDOW_SETTINGS APP_SETTINGS_BASE::m_Window
inherited

Definition at line 233 of file app_settings.h.

Referenced by GRID_MENU::BuildChoiceList(), DIALOG_BOARD_REANNOTATE::BuildFootprintList(), PL_EDITOR_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME::DisplayGridMsg(), GAL_OPTIONS_PANEL::GAL_OPTIONS_PANEL(), EE_GRID_HELPER::GetGridSize(), PCB_GRID_HELPER::GetGridSize(), EDA_BASE_FRAME::GetWindowSettings(), DISPLAY_FOOTPRINTS_FRAME::GetWindowSettings(), SIMULATOR_FRAME::GetWindowSettings(), SYMBOL_CHOOSER_FRAME::GetWindowSettings(), SYMBOL_VIEWER_FRAME::GetWindowSettings(), FOOTPRINT_CHOOSER_FRAME::GetWindowSettings(), FOOTPRINT_VIEWER_FRAME::GetWindowSettings(), FOOTPRINT_WIZARD_FRAME::GetWindowSettings(), SCH_EDITOR_CONTROL::GridFeedback(), EDA_DRAW_FRAME::IsGridOverridden(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSettings(), PCB_BASE_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(), PANEL_GRID_SETTINGS::TransferDataFromWindow(), GAL_OPTIONS_PANEL::TransferDataFromWindow(), PANEL_GRID_SETTINGS::TransferDataToWindow(), GAL_OPTIONS_PANEL::TransferDataToWindow(), GRID_MENU::update(), ZOOM_MENU::update(), and EDA_DRAW_FRAME::UpdateZoomSelectBox().

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

Whether or not the backing store file should be written.

Definition at line 334 of file json_settings.h.

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

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