KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Classes | Macros | Functions
settings_manager.h File Reference
#include <algorithm>
#include <mutex>
#include <typeinfo>
#include <core/wx_stl_compat.h>
#include <settings/color_settings.h>
#include <pgm_base.h>

Go to the source code of this file.

Classes

class  SETTINGS_MANAGER
 

Macros

#define PROJECT_BACKUPS_DIR_SUFFIX   wxT( "-backups" )
 Project settings path will be <projectname> + this.
 
#define DEFAULT_THEME   wxString( wxT( "user" ) )
 

Functions

template<typename T>
T * GetAppSettings (const char *aFilename)
 
template<typename T>
T * GetToolbarSettings (const wxString &aFilename)
 
COLOR_SETTINGS * GetColorSettings (const wxString &aName)
 

Macro Definition Documentation

◆ DEFAULT_THEME

#define DEFAULT_THEME   wxString( wxT( "user" ) )

Definition at line 45 of file settings_manager.h.

Referenced by PL_EDITOR_FRAME::CommonSettingsChanged(), GRID_CELL_LAYER_RENDERER::Draw(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), PCB_MARKER::getColor(), SCH_MARKER::getColor(), DISPLAY_FOOTPRINTS_FRAME::GetColorSettings(), EDA_DRAW_FRAME::GetColorSettings(), FOOTPRINT_CHOOSER_FRAME::GetColorSettings(), FOOTPRINT_EDIT_FRAME::GetColorSettings(), FOOTPRINT_VIEWER_FRAME::GetColorSettings(), FOOTPRINT_WIZARD_FRAME::GetColorSettings(), GERBVIEW_FRAME::GetColorSettings(), PCB_BASE_EDIT_FRAME::GetColorSettings(), SETTINGS_MANAGER::GetColorSettings(), SYMBOL_EDIT_FRAME::GetColorSettings(), BOARD_ADAPTER::GetDefaultColors(), GetLayerColor(), PCB_LAYER_PRESENTATION::getLayerColor(), BOARD_ADAPTER::GetLayerColors(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), PCB_TEST_FRAME_BASE::LoadSettings(), 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(), SCH_SHEET::Plot(), SCH_PRINTOUT::PrintPage(), BOARD_ADAPTER::ReloadColorSettings(), GERBVIEW_FRAME::SaveSettings(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::SCH_DESIGN_BLOCK_PREVIEW_WIDGET(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), BOARD_ADAPTER::SetLayerColors(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataToWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), and PCB_DRAW_PANEL_GAL::UpdateColors().

◆ PROJECT_BACKUPS_DIR_SUFFIX

#define PROJECT_BACKUPS_DIR_SUFFIX   wxT( "-backups" )

Project settings path will be <projectname> + this.

Definition at line 43 of file settings_manager.h.

Referenced by SETTINGS_MANAGER::GetProjectBackupsPath(), and PROJECT_TREE_TRAVERSER::OnDir().

Function Documentation

◆ GetAppSettings()

template<typename T>
T * GetAppSettings ( const char * aFilename)

Definition at line 537 of file settings_manager.h.

References PgmOrNull(), and T.

Referenced by PANEL_DESIGN_BLOCK_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), FOOTPRINT_CHOOSER_FRAME::build3DCanvas(), EDA_3D_VIEWER_FRAME::captureScreenshot(), BOARD_EDITOR_CONTROL::ChangeLineMode(), FOOTPRINT_EDITOR_CONTROL::ChangeLineMode(), UPDATE_MANAGER::CheckForUpdate(), EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::CommonSettingsChanged(), SIMULATOR_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), PCB::IFACE::CreateKiWindow(), PGE::IFACE::CreateKiWindow(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_RENDER_JOB::DIALOG_RENDER_JOB(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), GRID_CELL_LAYER_RENDERER::Draw(), EVT_TOOL_RANGE(), PANEL_FOOTPRINT_CHOOSER::FinishSetup(), PCB_EDIT_FRAME::GetActionPluginButtonVisible(), PCB_TOOL_BASE::GetAngleSnapMode(), DISPLAY_FOOTPRINTS_FRAME::GetColorSettings(), FOOTPRINT_CHOOSER_FRAME::GetColorSettings(), FOOTPRINT_VIEWER_FRAME::GetColorSettings(), GERBVIEW_FRAME::GetColorSettings(), SCH_BASE_FRAME::GetColorSettings(), SYMBOL_EDIT_FRAME::GetColorSettings(), SCH_ITEM::GetDefaultFont(), GetLastPinLength(), GetLastPinNameSize(), GetLastPinNumSize(), PCB_LAYER_PRESENTATION::getLayerColor(), DISPLAY_FOOTPRINTS_FRAME::GetMagneticItemsSettings(), PCB_EDIT_FRAME::GetOrderedActionPlugins(), GetPgmSettings(), GetPgmSettings(), PIN_LAYOUT_CACHE::GetPinNumberInfo(), FOOTPRINT_EDIT_FRAME::GetSettings(), DISPLAY_FOOTPRINTS_FRAME::GetViewerSettingsBase(), SCH_BASE_FRAME::GetViewerSettingsBase(), DISPLAY_FOOTPRINTS_FRAME::GetWindowSettings(), SIMULATOR_FRAME::GetWindowSettings(), IfaceOrAddress(), POSITION_RELATIVE_TOOL::InteractiveOffset(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportRender(), FP_LIB_TABLE::LoadGlobalTable(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), SYMBOL_VIEWER_FRAME::LoadSettings(), PANEL_PCBNEW_DISPLAY_ORIGIN::loadSettings(), PANEL_PREVIEW_3D_MODEL::loadSettings(), PCB_VIEWER_TOOLS::MeasureTool(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), KICAD_MANAGER_CONTROL::NewProject(), PCB_VIEWER_TOOLS::NextLineMode(), BOARD_EDITOR_CONTROL::OnAngleSnapModeChanged(), FOOTPRINT_EDITOR_CONTROL::OnAngleSnapModeChanged(), PANEL_PACKAGES_VIEW::OnDownloadVersionClicked(), PCB::IFACE::OnKifaceStart(), DIALOG_PCM::OnManageRepositoriesClicked(), PANEL_DESIGN_BLOCK_LIB_TABLE::PANEL_DESIGN_BLOCK_LIB_TABLE(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_GERBVIEW_COLOR_SETTINGS::PANEL_GERBVIEW_COLOR_SETTINGS(), PANEL_GERBVIEW_DISPLAY_OPTIONS::PANEL_GERBVIEW_DISPLAY_OPTIONS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), PANEL_TEMPLATE_FIELDNAMES::PANEL_TEMPLATE_FIELDNAMES(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::PCB_DESIGN_BLOCK_PREVIEW_WIDGET(), SCH_MOVE_TOOL::performItemMove(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), DIALOG_PLOT::Plot(), PCB_PLOTTER::PlotJobToPlotOpts(), EDA_3D_VIEWER_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), APPEARANCE_CONTROLS::rebuildLayers(), PIN_LAYOUT_CACHE::recomputeCaches(), BOARD_ADAPTER::ReloadColorSettings(), EDA_3D_CANVAS::RenderEngineChanged(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SaveFileAs(), EDA_3D_VIEWER_FRAME::SaveSettings(), SYMBOL_VIEWER_FRAME::SaveSettings(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::SCH_DESIGN_BLOCK_PREVIEW_WIDGET(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), PANEL_FP_LIB_TABLE::setupGrid(), PANEL_SYM_LIB_TABLE::setupGrid(), EDA_3D_VIEWER_FRAME::setupRenderingConfig(), PIN_TABLE_DATA_MODEL::SetValue(), KICAD_MANAGER_CONTROL::ShowPluginManager(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), EDA_3D_VIEWER_FRAME::ToggleAppearanceManager(), PANEL_3D_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_3D_OPENGL_OPTIONS::TransferDataFromWindow(), PANEL_3D_RAYTRACING_OPTIONS::TransferDataFromWindow(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataFromWindow(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataFromWindow(), PANEL_PACKAGES_AND_UPDATES::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataFromWindow(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SIMULATOR_PREFERENCES::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_SYM_EDITING_OPTIONS::TransferDataFromWindow(), PANEL_TEMPLATE_FIELDNAMES::TransferDataFromWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataToWindow(), PANEL_3D_OPENGL_OPTIONS::TransferDataToWindow(), PANEL_3D_RAYTRACING_OPTIONS::TransferDataToWindow(), PANEL_DISPLAY_OPTIONS::TransferDataToWindow(), PANEL_EDIT_OPTIONS::TransferDataToWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataToWindow(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataToWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataToWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataToWindow(), PANEL_PACKAGES_AND_UPDATES::TransferDataToWindow(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataToWindow(), PANEL_SIMULATOR_PREFERENCES::TransferDataToWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), PANEL_SYM_DISPLAY_OPTIONS::TransferDataToWindow(), PANEL_SYM_EDITING_OPTIONS::TransferDataToWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), PCB_DRAW_PANEL_GAL::UpdateColors(), FOOTPRINT_EDIT_FRAME::updateEnabledLayers(), DIALOG_CHANGE_SYMBOLS::~DIALOG_CHANGE_SYMBOLS(), DIALOG_ERC::~DIALOG_ERC(), PANEL_FOOTPRINT_CHOOSER::~PANEL_FOOTPRINT_CHOOSER(), and SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME().

◆ GetColorSettings()

COLOR_SETTINGS * GetColorSettings ( const wxString & aName)
inline

Definition at line 556 of file settings_manager.h.

References SETTINGS_MANAGER::GetColorSettings(), PGM_BASE::GetSettingsManager(), and Pgm().

Referenced by GRID_CELL_LAYER_RENDERER::Draw(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), BOARD_ADAPTER::GetDefaultColors(), PCB_LAYER_PRESENTATION::getLayerColor(), BOARD_ADAPTER::GetLayerColors(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), 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(), SCH_PLOTTER::Plot(), SCH_SHEET::Plot(), PCB_PLOTTER::PlotJobToPlotOpts(), SCH_PRINTOUT::PrintPage(), BOARD_ADAPTER::ReloadColorSettings(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::SCH_DESIGN_BLOCK_PREVIEW_WIDGET(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), BOARD_ADAPTER::SetLayerColors(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_PRINT::TransferDataFromWindow(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataToWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), and PCB_DRAW_PANEL_GAL::UpdateColors().

◆ GetToolbarSettings()

template<typename T>
T * GetToolbarSettings ( const wxString & aFilename)

Definition at line 547 of file settings_manager.h.

References PgmOrNull(), and T.

Referenced by PCB::IFACE::CreateKiWindow(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EVT_GRID_CMD_CELL_CHANGED(), EVT_MENU_RANGE(), EVT_UPDATE_UI_RANGE(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SIMULATOR_FRAME::SIMULATOR_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().