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

#include <pcbnew_settings.h>

Inheritance diagram for PCBNEW_SETTINGS:
PCB_VIEWERS_SETTINGS_BASE APP_SETTINGS_BASE JSON_SETTINGS

Classes

struct  AUI_PANELS
 
struct  DIALOG_CLEANUP
 
struct  DIALOG_DRC
 
struct  DIALOG_EXPORT_2581
 
struct  DIALOG_EXPORT_IDF
 
struct  DIALOG_EXPORT_STEP
 
struct  DIALOG_EXPORT_SVG
 
struct  DIALOG_EXPORT_VRML
 
struct  DIALOG_FOOTPRINT_WIZARD_LIST
 
struct  DIALOG_GENERATE_DRILL
 
struct  DIALOG_IMPORT_GRAPHICS
 
struct  DIALOG_NET_INSPECTOR
 
struct  DIALOG_NETLIST
 
struct  DIALOG_PLACE_FILE
 
struct  DIALOG_PLOT
 
struct  DIALOG_REANNOTATE
 
struct  DISPLAY_OPTIONS
 
struct  FOOTPRINT_CHOOSER
 
struct  ZONES
 

Public Member Functions

 PCBNEW_SETTINGS ()
 
virtual ~PCBNEW_SETTINGS ()
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig) override
 Migrates from wxConfig to JSON-based configuration. More...
 
const std::vector< GRIDDefaultGridSizeList () const
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
void SetFilename (const wxString &aFilename)
 
void SetLocation (SETTINGS_LOC aLocation)
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const wxString &aFilename)
 
bool IsReadOnly () const
 
void SetReadOnly (bool aReadOnly)
 
nlohmann::json & At (const std::string &aPath)
 Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally. More...
 
bool Contains (const std::string &aPath) const
 
JSON_SETTINGS_INTERNALSInternals ()
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
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. More...
 
virtual bool LoadFromFile (const wxString &aDirectory="")
 Loads the backing file from disk and then calls Load() More...
 
virtual bool SaveToFile (const wxString &aDirectory="", bool aForce=false)
 Calls Store() and then writes the contents of the JSON document to a file. More...
 
void ResetToDefaults ()
 Resets all parameters to default values. More...
 
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. More...
 
template<typename ValueType >
std::optional< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
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. More...
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
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. More...
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object. More...
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one. More...
 
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. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
 Sets the given bool if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
 Sets the given int if the given key/path is present. More...
 
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. More...
 

Public Attributes

AUI_PANELS m_AuiPanels
 
DIALOG_CLEANUP m_Cleanup
 
DIALOG_DRC m_DrcDialog
 
DIALOG_EXPORT_IDF m_ExportIdf
 
DIALOG_EXPORT_STEP m_ExportStep
 
DIALOG_EXPORT_2581 m_Export2581
 
DIALOG_EXPORT_SVG m_ExportSvg
 
DIALOG_EXPORT_VRML m_ExportVrml
 
DIALOG_FOOTPRINT_WIZARD_LIST m_FootprintWizardList
 
DIALOG_GENERATE_DRILL m_GenDrill
 
DIALOG_IMPORT_GRAPHICS m_ImportGraphics
 
DIALOG_NETLIST m_NetlistDialog
 
DIALOG_PLACE_FILE m_PlaceFile
 
DIALOG_PLOT m_Plot
 
DIALOG_REANNOTATE m_Reannotate
 
DIALOG_NET_INSPECTOR m_NetInspector
 
FOOTPRINT_CHOOSER m_FootprintChooser
 
ZONES m_Zones
 
WINDOW_SETTINGS m_FootprintViewer
 
WINDOW_SETTINGS m_FootprintWizard
 
DISPLAY_OPTIONS m_Display
 
MAGNETIC_SETTINGS m_MagneticItems
 
TRACK_DRAG_ACTION m_TrackDragAction
 
ARC_EDIT_MODE m_ArcEditMode
 
bool m_CtrlClickHighlight
 
bool m_Use45DegreeLimit
 
bool m_FlipLeftRight
 
bool m_ESCClearsNetHighlight
 
bool m_PolarCoords
 
EDA_ANGLE m_RotationAngle
 
bool m_ShowPageLimits
 
bool m_ShowCourtyardCollisions
 
bool m_AutoRefillZones
 
bool m_AllowFreePads
 
wxString m_FootprintTextShownColumns
 
std::unique_ptr< PNS::ROUTING_SETTINGSm_PnsSettings
 
double m_FootprintViewerZoom
 The last zoom level used (0 for auto) More...
 
bool m_FootprintViewerAutoZoomOnSelect
 true to use automatic zoom on fp selection More...
 
int m_FootprintViewerLibListWidth
 
int m_FootprintViewerFPListWidth
 
wxString m_lastFootprintLibDir
 
wxString m_lastFootprint3dDir
 
ACTION_PLUGIN_SETTINGS_LIST m_VisibleActionPlugins
 
VIEWERS_DISPLAY_OPTIONS m_ViewersDisplay
 
CROSS_PROBING_SETTINGS m_CrossProbing
 
FIND_REPLACE m_FindReplace
 
GRAPHICS m_Graphics
 
COLOR_PICKER m_ColorPicker
 
LIB_TREE m_LibTree
 
PRINTING m_Printing
 
SYSTEM m_System
 
WINDOW_SETTINGS m_Window
 
wxString m_ColorTheme
 Active color theme name. More...
 
int m_appSettingsSchemaVersion
 ! Local schema version for common app settings More...
 

Protected Member Functions

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

Protected Attributes

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

Detailed Description

Definition at line 133 of file pcbnew_settings.h.

Constructor & Destructor Documentation

◆ PCBNEW_SETTINGS()

PCBNEW_SETTINGS::PCBNEW_SETTINGS ( )

Definition at line 49 of file pcbnew_settings.cpp.

References APP_SETTINGS_BASE::addParamsForWindow(), PCBNEW_SETTINGS::DIALOG_PLOT::all_layers_on_one_page, MAGNETIC_SETTINGS::allLayers, ANGLE_360, PCBNEW_SETTINGS::DIALOG_REANNOTATE::annotation_choice, PCBNEW_SETTINGS::AUI_PANELS::appearance_expand_layer_display, PCBNEW_SETTINGS::AUI_PANELS::appearance_expand_net_display, PCBNEW_SETTINGS::AUI_PANELS::appearance_panel_tab, PCBNEW_SETTINGS::DIALOG_PLOT::as_item_checkboxes, PCBNEW_SETTINGS::DIALOG_NETLIST::associate_by_ref_sch, EDA_ANGLE::AsTenthsOfADegree(), JSON_SETTINGS::At(), PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::auto_adjust, PCBNEW_SETTINGS::DIALOG_REANNOTATE::back_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::back_refdes_start, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::black_and_white, PCBNEW_SETTINGS::DIALOG_PLOT::check_zones_before_plotting, PCBNEW_SETTINGS::DIALOG_CLEANUP::cleanup_short_circuits, PCBNEW_SETTINGS::DIALOG_CLEANUP::cleanup_tracks_in_pad, PCBNEW_SETTINGS::DIALOG_CLEANUP::cleanup_unconnected, PCBNEW_SETTINGS::DIALOG_CLEANUP::cleanup_vias, PCBNEW_SETTINGS::DIALOG_NET_INSPECTOR::col_order, PCBNEW_SETTINGS::DIALOG_NET_INSPECTOR::col_widths, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::color_theme, PCBNEW_SETTINGS::DIALOG_EXPORT_2581::compress, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::copy_3d_models, PCBNEW_SETTINGS::DIALOG_CLEANUP::delete_dangling_vias, PCBNEW_SETTINGS::DIALOG_NETLIST::delete_extra_footprints, PCBNEW_SETTINGS::DIALOG_NETLIST::delete_shorting_tracks, PCBNEW_SETTINGS::DIALOG_NET_INSPECTOR::dlg_height, PCBNEW_SETTINGS::DIALOG_NET_INSPECTOR::dlg_width, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::drill_file_type, Dwgs_User, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::dxf_line_width, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::dxf_line_width_units, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::dxf_units, PCBNEW_SETTINGS::DIALOG_PLOT::edgecut_on_all_layers, PCBNEW_SETTINGS::DIALOG_REANNOTATE::exclude_list, PCBNEW_SETTINGS::DIALOG_REANNOTATE::exclude_locked, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::exclude_TH, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::file_format, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::file_options, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::filter_on_pin_count, PCBNEW_SETTINGS::DIALOG_PLOT::fine_scale_x, PCBNEW_SETTINGS::DIALOG_PLOT::fine_scale_y, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::fix_discontinuities, PCBNEW_SETTINGS::DIALOG_REANNOTATE::front_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::front_refdes_start, MAGNETIC_SETTINGS::graphics, PCBNEW_SETTINGS::DIALOG_REANNOTATE::grid_index, PCBNEW_SETTINGS::DIALOG_NET_INSPECTOR::group_by, PCBNEW_SETTINGS::DIALOG_NET_INSPECTOR::group_by_kind, PCBNEW_SETTINGS::DIALOG_NET_INSPECTOR::group_by_text, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::group_items, PCBNEW_SETTINGS::DIALOG_FOOTPRINT_WIZARD_LIST::height, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::height, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::include_board_edge, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::interactive_placement, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::layer, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::layers, m_AllowFreePads, m_ArcEditMode, m_AuiPanels, m_AutoRefillZones, m_Cleanup, m_CtrlClickHighlight, m_Display, PCB_VIEWERS_SETTINGS_BASE::VIEWERS_DISPLAY_OPTIONS::m_DisplayGraphicsFill, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_DisplayInvertXAxis, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_DisplayInvertYAxis, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_DisplayOrigin, PCB_VIEWERS_SETTINGS_BASE::VIEWERS_DISPLAY_OPTIONS::m_DisplayPadFill, PCB_VIEWERS_SETTINGS_BASE::VIEWERS_DISPLAY_OPTIONS::m_DisplayPadNumbers, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_DisplayPcbTrackFill, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_DisplayRatsnestLinesCurved, PCB_VIEWERS_SETTINGS_BASE::VIEWERS_DISPLAY_OPTIONS::m_DisplayTextFill, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_DisplayViaFill, m_DrcDialog, m_ESCClearsNetHighlight, m_Export2581, m_ExportIdf, m_ExportStep, m_ExportSvg, m_ExportVrml, m_FlipLeftRight, m_FootprintChooser, m_FootprintTextShownColumns, m_FootprintViewer, m_FootprintViewerAutoZoomOnSelect, m_FootprintViewerFPListWidth, m_FootprintViewerLibListWidth, m_FootprintViewerZoom, m_FootprintWizard, m_FootprintWizardList, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_ForceShowFieldsWhenFPSelected, m_GenDrill, m_ImportGraphics, m_lastFootprint3dDir, m_lastFootprintLibDir, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_Live3DRefresh, m_MagneticItems, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_MaxLinksShowed, m_NetInspector, m_NetlistDialog, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_NetNames, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_PadClearance, JSON_SETTINGS::m_params, m_PlaceFile, m_Plot, m_PolarCoords, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_RatsnestThickness, m_Reannotate, m_RotationAngle, m_ShowCourtyardCollisions, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_ShowGlobalRatsnest, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_ShowModuleRatsnest, m_ShowPageLimits, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_TrackClearance, m_TrackDragAction, m_Use45DegreeLimit, PCB_VIEWERS_SETTINGS_BASE::m_ViewersDisplay, m_VisibleActionPlugins, m_Zones, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::map_file_type, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::merge_pth_npth, PCBNEW_SETTINGS::DIALOG_CLEANUP::merge_segments, APP_SETTINGS_BASE::migrateLibTreeWidth(), PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::minimal_header, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::mirror, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::mirror, PCBNEW_SETTINGS::DIALOG_PLOT::mirror, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::negate_xcoord, PCBNEW_SETTINGS::ZONES::net_sort_mode, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::no_dnp, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::no_unspecified, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::one_file, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::only_SMD, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::origin_mode, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::origin_mode, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::origin_units, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::origin_units, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::origin_x, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::origin_x, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::origin_y, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::origin_y, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::output_dir, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::output_directory, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::overwrite_file, MAGNETIC_SETTINGS::pads, PCBNEW_SETTINGS::DIALOG_PLOT::pads_drill_mode, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::page_size, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::plot_board_edges, PCBNEW_SETTINGS::DIALOG_EXPORT_2581::precision, PCBNEW_SETTINGS::AUI_PANELS::properties_panel_width, PCBNEW_SETTINGS::AUI_PANELS::properties_splitter, PCBNEW_SETTINGS::DIALOG_PLOT::ps_fine_width_adjust, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::ref_units, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::ref_units, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::ref_x, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::ref_x, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::ref_y, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::ref_y, PCBNEW_SETTINGS::DIALOG_DRC::refill_zones, JSON_SETTINGS::registerMigration(), PCBNEW_SETTINGS::DIALOG_REANNOTATE::remove_back_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::remove_front_prefix, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::replace_models, PCBNEW_SETTINGS::DIALOG_REANNOTATE::report_file_name, PCBNEW_SETTINGS::DIALOG_NETLIST::report_filter, PCBNEW_SETTINGS::DIALOG_REANNOTATE::report_severity, PCBNEW_SETTINGS::AUI_PANELS::right_panel_width, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::sash_h, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::sash_v, PCBNEW_SETTINGS::AUI_PANELS::search_panel_dock_direction, PCBNEW_SETTINGS::AUI_PANELS::search_panel_height, PCBNEW_SETTINGS::AUI_PANELS::search_panel_width, JSON_SETTINGS::Set(), PCBNEW_SETTINGS::DIALOG_DRC::severities, PCBNEW_SETTINGS::AUI_PANELS::show_layer_manager, PCBNEW_SETTINGS::AUI_PANELS::show_properties, PCBNEW_SETTINGS::AUI_PANELS::show_search, SHOW_WITH_VIA_WHILE_ROUTING, PCBNEW_SETTINGS::DIALOG_NET_INSPECTOR::show_zero_pad_nets, PCBNEW_SETTINGS::DIALOG_REANNOTATE::sort_code, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::sort_mode, PCBNEW_SETTINGS::DIALOG_REANNOTATE::sort_on_fp_location, PCBNEW_SETTINGS::DIALOG_NET_INSPECTOR::sort_order_asc, PCBNEW_SETTINGS::DIALOG_NET_INSPECTOR::sorting_column, TENTHS_OF_A_DEGREE_T, PCBNEW_SETTINGS::DIALOG_DRC::test_all_track_errors, PCBNEW_SETTINGS::DIALOG_DRC::test_footprints, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::tolerance, MAGNETIC_SETTINGS::tracks, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::unit_drill_is_inch, PCBNEW_SETTINGS::DIALOG_EXPORT_2581::units, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::units, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::units, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::units_mils, PCBNEW_SETTINGS::DIALOG_NETLIST::update_footprints, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::use_aux_origin, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::use_dlg_layer_selection, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::use_fp_filters, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::use_relative_paths, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::use_route_for_oval_holes, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::use_selected_theme, PCBNEW_SETTINGS::DIALOG_EXPORT_2581::version, PCBNEW_SETTINGS::DIALOG_FOOTPRINT_WIZARD_LIST::width, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::width, and PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::zeros_format.

◆ ~PCBNEW_SETTINGS()

PCBNEW_SETTINGS::~PCBNEW_SETTINGS ( )
virtualdefault

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 840 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 
)
protectedinherited

◆ 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 EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ Contains()

◆ DefaultGridSizeList()

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

◆ fetchOrDefault()

template<typename ResultType >
template 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 899 of file json_settings.cpp.

◆ FormatAsString()

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

◆ fromLegacy()

template<typename ValueType >
template 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 752 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 812 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 788 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(), MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().

◆ Get() [1/2]

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

Definition at line 870 of file json_settings.cpp.

References JSON_SETTINGS::GetJson().

◆ Get() [2/2]

template<typename ValueType >
template 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 576 of file json_settings.cpp.

References JSON_SETTINGS::GetJson().

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

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

◆ GetFilename()

◆ GetFullFilename()

◆ GetJson()

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

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

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

Definition at line 556 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 280 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

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

Reimplemented from APP_SETTINGS_BASE.

Definition at line 468 of file pcbnew_settings.h.

Referenced by MigrateFromLegacy().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

◆ IsReadOnly()

◆ Load()

◆ LoadFromFile()

◆ LoadFromRawFile()

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

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
inherited

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

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

Returns
true if migration was successful

Definition at line 649 of file json_settings.cpp.

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

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

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protectedinherited

! Migrates the find/replace history string lists

Definition at line 245 of file app_settings.cpp.

References JSON_SETTINGS::Set().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().

◆ MigrateFromLegacy()

bool PCBNEW_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
overridevirtual

◆ migrateLibTreeWidth()

bool APP_SETTINGS_BASE::migrateLibTreeWidth ( )
protectedinherited

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

Definition at line 480 of file app_settings.cpp.

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

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

◆ migrateWindowConfig()

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

Migrates legacy window settings into the JSON document.

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

Definition at line 269 of file app_settings.cpp.

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

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

◆ registerMigration()

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

Registers a migration from one schema version to another.

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

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

Definition at line 640 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(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

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

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

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

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 388 of file json_settings.cpp.

References JSON_SETTINGS::m_params.

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

◆ SaveToFile()

◆ Set() [1/3]

template<typename ValueType >
template 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 613 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(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), 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(), MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), 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(), and PARAM_MAP< Value >::Store().

◆ Set() [2/3]

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

Definition at line 879 of file json_settings.cpp.

◆ Set() [3/3]

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

◆ SetFilename()

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

◆ SetIfPresent() [1/4]

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

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

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

Definition at line 706 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 721 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 736 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 691 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

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

◆ SetLegacyFilename()

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

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation)
inlineinherited

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 191 of file json_settings.h.

References JSON_SETTINGS::m_manager.

◆ SetReadOnly()

◆ 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 was updated

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

Member Data Documentation

◆ m_AllowFreePads

◆ m_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion
inherited

! Local schema version for common app settings

Definition at line 176 of file app_settings.h.

◆ m_ArcEditMode

◆ m_AuiPanels

◆ m_AutoRefillZones

bool PCBNEW_SETTINGS::m_AutoRefillZones

◆ m_Cleanup

DIALOG_CLEANUP PCBNEW_SETTINGS::m_Cleanup

◆ m_ColorPicker

◆ m_ColorTheme

◆ m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault
protectedinherited

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

Ignored if m_createIfMissing is false or m_writeFile is false.

Definition at line 318 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 312 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_CrossProbing

◆ m_CtrlClickHighlight

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 324 of file json_settings.h.

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

◆ m_Display

DISPLAY_OPTIONS PCBNEW_SETTINGS::m_Display

Definition at line 420 of file pcbnew_settings.h.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), PCB_BASE_FRAME::CommonSettingsChanged(), PCB_TOOL_BASE::displayOptions(), PCB_VIEWER_TOOLS::displayOptions(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::draw(), BOARD_INSPECTION_TOOL::HighlightItem(), PCB_ORIGIN_TRANSFORMS::invertXAxis(), PCB_ORIGIN_TRANSFORMS::invertYAxis(), PANEL_EDIT_OPTIONS::loadPCBSettings(), PANEL_PCB_DISPLAY_OPTIONS::loadPCBSettings(), PANEL_PCBNEW_DISPLAY_ORIGIN::loadSettings(), DIALOG_DRC::OnDRCItemSelected(), PCB_EDIT_FRAME::OnNetlistChanged(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), APPEARANCE_CONTROLS::onRatsnestMode(), PCB_DRAW_PANEL_GAL::OnShow(), PCBNEW_SETTINGS(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BOARD_COMMIT::Push(), PCB_EDIT_FRAME::redrawNetnames(), PCB_EDIT_FRAME::SetActiveLayer(), APPEARANCE_CONTROLS::SetObjectVisible(), PCB_EDIT_FRAME::setupUIConditions(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDITOR_CONDITIONS::trackFillDisplayFunc(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), PANEL_PCB_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataFromWindow(), DIALOG_IMPORT_GRAPHICS::TransferDataFromWindow(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), PCB_EDITOR_CONDITIONS::viaFillDisplayFunc(), and RATSNEST_VIEW_ITEM::ViewDraw().

◆ m_DrcDialog

DIALOG_DRC PCBNEW_SETTINGS::m_DrcDialog

◆ m_ESCClearsNetHighlight

bool PCBNEW_SETTINGS::m_ESCClearsNetHighlight

◆ m_Export2581

◆ m_ExportIdf

DIALOG_EXPORT_IDF PCBNEW_SETTINGS::m_ExportIdf

Definition at line 386 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and DIALOG_EXPORT_IDF3::~DIALOG_EXPORT_IDF3().

◆ m_ExportStep

◆ m_ExportSvg

◆ m_ExportVrml

◆ m_filename

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace
inherited

◆ m_FlipLeftRight

◆ m_FootprintChooser

FOOTPRINT_CHOOSER PCBNEW_SETTINGS::m_FootprintChooser

◆ m_FootprintTextShownColumns

◆ m_FootprintViewer

◆ m_FootprintViewerAutoZoomOnSelect

bool PCBNEW_SETTINGS::m_FootprintViewerAutoZoomOnSelect

true to use automatic zoom on fp selection

Definition at line 456 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and FOOTPRINT_VIEWER_FRAME::SaveSettings().

◆ m_FootprintViewerFPListWidth

int PCBNEW_SETTINGS::m_FootprintViewerFPListWidth

◆ m_FootprintViewerLibListWidth

int PCBNEW_SETTINGS::m_FootprintViewerLibListWidth

◆ m_FootprintViewerZoom

double PCBNEW_SETTINGS::m_FootprintViewerZoom

The last zoom level used (0 for auto)

Definition at line 455 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and FOOTPRINT_VIEWER_FRAME::SaveSettings().

◆ m_FootprintWizard

WINDOW_SETTINGS PCBNEW_SETTINGS::m_FootprintWizard

Definition at line 418 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS().

◆ m_FootprintWizardList

◆ m_GenDrill

DIALOG_GENERATE_DRILL PCBNEW_SETTINGS::m_GenDrill

Definition at line 398 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and DIALOG_GENDRILL::UpdateConfig().

◆ m_Graphics

◆ m_ImportGraphics

◆ m_internals

◆ m_lastFootprint3dDir

wxString PCBNEW_SETTINGS::m_lastFootprint3dDir

◆ m_lastFootprintLibDir

wxString PCBNEW_SETTINGS::m_lastFootprintLibDir

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

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

◆ m_LibTree

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 303 of file json_settings.h.

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

◆ m_MagneticItems

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 333 of file json_settings.h.

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

◆ m_migrators

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

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

Definition at line 336 of file json_settings.h.

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

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

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

◆ m_NetInspector

◆ m_NetlistDialog

◆ m_params

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

◆ m_PlaceFile

◆ m_Plot

DIALOG_PLOT PCBNEW_SETTINGS::m_Plot

◆ m_PnsSettings

std::unique_ptr<PNS::ROUTING_SETTINGS> PCBNEW_SETTINGS::m_PnsSettings

Definition at line 453 of file pcbnew_settings.h.

Referenced by PNS::TOOL_BASE::Reset(), and GENERATOR_TOOL_PNS_PROXY::Reset().

◆ m_PolarCoords

bool PCBNEW_SETTINGS::m_PolarCoords

Definition at line 436 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and PCB_BASE_FRAME::SaveSettings().

◆ m_Printing

◆ m_Reannotate

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

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

◆ m_RotationAngle

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_ShowCourtyardCollisions

bool PCBNEW_SETTINGS::m_ShowCourtyardCollisions
Todo:
Implement real auto zone filling (not just after zone properties are edited)

Definition at line 442 of file pcbnew_settings.h.

Referenced by EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::InlineDrag(), PANEL_EDIT_OPTIONS::loadPCBSettings(), PCBNEW_SETTINGS(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

◆ m_ShowPageLimits

◆ m_System

◆ m_TrackDragAction

◆ m_Use45DegreeLimit

◆ m_ViewersDisplay

◆ m_VisibleActionPlugins

◆ m_Window

WINDOW_SETTINGS APP_SETTINGS_BASE::m_Window
inherited

Definition at line 170 of file app_settings.h.

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

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

◆ m_Zones


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