KICAD_MANAGER_FRAME Class Reference

The main KiCad project manager frame. More...

#include <kicad_manager_frame.h>

Inheritance diagram for KICAD_MANAGER_FRAME:

Public Types
enum	UNDO_REDO_LIST { UNDO_LIST , REDO_LIST }
	Specify whether we are interacting with the undo or redo stacks. More...
enum	HOLDER_TYPE { DIALOG , FRAME , PANEL }

Public Member Functions
	KICAD_MANAGER_FRAME (wxWindow *parent, const wxString &title, const wxPoint &pos, const wxSize &size)
	~KICAD_MANAGER_FRAME ()
void	OnIdle (wxIdleEvent &event)
bool	canCloseWindow (wxCloseEvent &aCloseEvent) override
void	doCloseWindow () override
void	OnSize (wxSizeEvent &event) override
void	UnarchiveFiles ()
void	OnOpenFileInTextEditor (wxCommandEvent &event)
void	OnEditAdvancedCfg (wxCommandEvent &event)
void	OnFileHistory (wxCommandEvent &event)
void	OnClearFileHistory (wxCommandEvent &aEvent)
void	OnExit (wxCommandEvent &event)
wxStatusBar *	OnCreateStatusBar (int number, long style, wxWindowID id, const wxString &name) override
	Create the status line (like a wxStatusBar).
void	HideTabsIfNeeded ()
	Hides the tabs for Editor notebook if there is only 1 page.
wxString	GetCurrentFileName () const override
	Get the full filename + path of the currently opened file in the frame.
void	ImportNonKiCadProject (const wxString &aWindowTitle, const wxString &aFilesWildcard, const std::vector< std::string > &aSchFileExtensions, const std::vector< std::string > &aPcbFileExtensions, int aSchFileType, int aPcbFileType)
	Creates a project and imports a non-KiCad Schematic and PCB.
void	OnImportAltiumProjectFiles (wxCommandEvent &event)
	Open dialog to import Altium project files.
void	OnImportCadstarArchiveFiles (wxCommandEvent &event)
	Open dialog to import CADSTAR Schematic and PCB Archive files.
void	OnImportEagleFiles (wxCommandEvent &event)
	Open dialog to import Eagle schematic and board files.
void	OnImportEasyEdaFiles (wxCommandEvent &event)
	Open dialog to import EasyEDA Std schematic and board files.
void	OnImportEasyEdaProFiles (wxCommandEvent &event)
	Open dialog to import EasyEDA Pro schematic and board files.
void	PrintPrjInfo ()
	Prints the current working directory name and the project name on the text panel.
void	RefreshProjectTree ()
void	CreateNewProject (const wxFileName &aProjectFileName, bool aCreateStubFiles=true)
	Creates a new project by setting up and initial project, schematic, and board files.
bool	CloseProject (bool aSave)
	Closes the project, and saves it if aSave is true;.
void	LoadProject (const wxFileName &aProjectFileName)
void	OpenJobsFile (const wxFileName &aFileName, bool aCreate=false, bool aResaveProjectPreferences=true)
void	LoadSettings (APP_SETTINGS_BASE *aCfg) override
	Load common frame parameters from a configuration file.
void	SaveSettings (APP_SETTINGS_BASE *aCfg) override
	Save common frame parameters to a configuration data file.
void	ShowChangedLanguage () override
	Redraw the menus and what not in current language.
void	CommonSettingsChanged (int aFlags) override
	Notification event that some of the common (suite-wide) settings have changed.
void	ProjectChanged () override
	Notification event that the project has changed.
void	OnChangeWatchedPaths (wxCommandEvent &aEvent)
	Called by sending a event with id = ID_INIT_WATCHED_PATHS rebuild the list of watched paths.
const wxString	GetProjectFileName () const
bool	IsProjectActive ()
const wxString	SchFileName ()
const wxString	SchLegacyFileName ()
const wxString	PcbFileName ()
const wxString	PcbLegacyFileName ()
void	ReCreateTreePrj ()
void	SaveOpenJobSetsToLocalSettings (bool aIsExplicitUserSave=false)
wxWindow *	GetToolCanvas () const override
	Canvas access.
std::shared_ptr< PLUGIN_CONTENT_MANAGER >	GetPcm ()
void	SetPcmButton (BITMAP_BUTTON *aButton)
void	CreatePCM ()
void	ChangeUserUnits (EDA_UNITS aUnits)
virtual void	ToggleUserUnits ()
ORIGIN_TRANSFORMS &	GetOriginTransforms () override
	Return a reference to the default ORIGIN_TRANSFORMS object.
SETTINGS_MANAGER *	GetSettingsManager () const
virtual SEVERITY	GetSeverity (int aErrorCode) const
bool	ProcessEvent (wxEvent &aEvent) override
	Override the default process event handler to implement the auto save feature.
virtual void	OnCharHook (wxKeyEvent &aKeyEvent)
	Capture the key event before it is sent to the GUI.
void	OnMenuEvent (wxMenuEvent &event)
	The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves.
virtual void	RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
	Register a UI update handler for the control with ID aID.
virtual void	RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
	Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls.
virtual void	UnregisterUIUpdateHandler (int aID) override
	Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler.
virtual void	UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
	Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.
virtual void	OnMove (wxMoveEvent &aEvent)
void	SelectLeftToolbarAction (const TOOL_ACTION &aAction)
	Select the given action in the left toolbar group which contains it, if any.
void	OnMaximize (wxMaximizeEvent &aEvent)
int	GetAutoSaveInterval () const
bool	IsType (FRAME_T aType) const
FRAME_T	GetFrameType () const
void	OnKicadAbout (wxCommandEvent &event)
void	OnPreferences (wxCommandEvent &event)
void	ShowPreferences (wxString aStartPage, wxString aStartParentPage)
	Display the preferences and settings of all opened editors paged dialog, starting with a particular page.
void	PrintMsg (const wxString &text)
void	CreateInfoBar ()
void	RestoreAuiLayout ()
void	FinishAUIInitialization ()
WX_INFOBAR *	GetInfoBar ()
void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.
void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.
void	ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar.
void	ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar.
void	LoadWindowState (const wxString &aFileName)
virtual void	LoadWindowState (const WINDOW_STATE &aState)
	Load frame state info from a configuration file.
void	LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
	Load window settings from the given settings object.
void	SaveWindowSettings (WINDOW_SETTINGS *aCfg)
	Save window settings to the given settings object.
virtual WINDOW_SETTINGS *	GetWindowSettings (APP_SETTINGS_BASE *aCfg)
	Return a pointer to the window settings for this frame.
wxString	ConfigBaseName () override
	Get the configuration base name.
virtual void	SaveProjectLocalSettings ()
	Save changes to the project local settings.
void	ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
	Prompt the user for a hotkey file to read, and read it.
wxString	GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
	Fetch the file name from the file history list.
virtual void	ClearFileHistory ()
	Remove all files from the file history.
void	UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
	Update the list of recently opened files.
FILE_HISTORY &	GetFileHistory ()
	Get the frame's main file history.
void	SetMruPath (const wxString &aPath)
wxString	GetMruPath () const
virtual void	RecreateToolbars ()
void	OnToolbarSizeChanged ()
	Update toolbars if desired toolbar icon changed.
virtual void	UpdateToolbarControlSizes ()
	Update the sizes of any controls in the toolbars of the frame.
void	RegisterCustomToolbarControlFactory (const ACTION_TOOLBAR_CONTROL &aControlDesc, const ACTION_TOOLBAR_CONTROL_FACTORY &aControlFactory)
	Register a creation factory for toolbar controls that are present in this frame.
ACTION_TOOLBAR_CONTROL_FACTORY *	GetCustomToolbarControlFactory (const std::string &aName)
void	ReCreateMenuBar ()
	Recreate the menu bar.
void	AddStandardHelpMenu (wxMenuBar *aMenuBar)
	Add the standard KiCad help menu to the menubar.
wxString	GetRunMenuCommandDescription (const TOOL_ACTION &aAction)
bool	IsWritable (const wxFileName &aFileName, bool aVerbose=true)
	Check if aFileName can be written.
virtual void	CheckForAutoSaveFile (const wxFileName &aFileName)
	Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input.
virtual void	DeleteAutoSaveFile (const wxFileName &aFileName)
virtual void	UpdateStatusBar ()
	Update the status bar information.
virtual void	ThemeChanged ()
	Process light/dark theme change.
const wxString &	GetAboutTitle () const
const wxString &	GetUntranslatedAboutTitle () const
virtual bool	IsContentModified () const
	Get if the contents of the frame have been modified since the last save.
wxSize	GetWindowSize ()
	Get the undecorated window size that can be used for restoring the window size.
virtual void	ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)
	Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.
virtual void	ClearUndoRedoList ()
	Clear the undo and redo list using ClearUndoORRedoList()
virtual void	PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
	Add a command to undo in the undo list.
virtual void	PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
	Add a command to redo in the redo list.
virtual PICKED_ITEMS_LIST *	PopCommandFromUndoList ()
	Return the last command to undo and remove it from list, nothing is deleted.
virtual PICKED_ITEMS_LIST *	PopCommandFromRedoList ()
	Return the last command to undo and remove it from list, nothing is deleted.
virtual int	GetUndoCommandCount () const
virtual int	GetRedoCommandCount () const
virtual wxString	GetUndoActionDescription () const
virtual wxString	GetRedoActionDescription () const
int	GetMaxUndoItems () const
virtual void	OnModify ()
	Must be called after a model change in order to set the "modify" flag and do other frame-specific processing.
bool	IsClosing () const
bool	NonUserClose (bool aForce)
virtual void	HandleSystemColorChange ()
	Update the UI in response to a change in the system colors.
virtual bool	CanAcceptApiCommands ()
	Check if this frame is ready to accept API commands.
TOOL_MANAGER *	GetToolManager () const
	Return the MVC controller.
TOOL_DISPATCHER *	GetToolDispatcher () const
virtual SELECTION &	GetCurrentSelection ()
	Get the current selection from the canvas area.
virtual void	PushTool (const TOOL_EVENT &aEvent)
	NB: the definition of "tool" is different at the user level.
virtual void	PopTool (const TOOL_EVENT &aEvent)
	Pops a tool from the stack.
bool	ToolStackIsEmpty ()
std::string	CurrentToolName () const
bool	IsCurrentTool (const TOOL_ACTION &aAction) const
virtual void	DisplayToolMsg (const wxString &msg)
bool	GetDoImmediateActions () const
	Indicate that hotkeys should perform an immediate action even if another tool is currently active.
MOUSE_DRAG_ACTION	GetDragAction () const
	Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.
bool	GetMoveWarpsCursor () const
	Indicate that a move operation should warp the mouse pointer to the origin of the move object.
virtual void	RefreshCanvas ()
HOLDER_TYPE	GetType () const
KIWAY &	Kiway () const
	Return a reference to the KIWAY that this object has an opportunity to participate in.
bool	HasKiway () const
	Safety check before asking for the Kiway reference.
PROJECT &	Prj () const
	Return a reference to the PROJECT associated with this KIWAY.
void	SetKiway (wxWindow *aDest, KIWAY *aKiway)
	It is only used for debugging, since "this" is not a wxWindow*.
EDA_UNITS	GetUserUnits () const
void	SetUserUnits (EDA_UNITS aUnits)
virtual void	GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
const EDA_IU_SCALE &	GetIuScale () const
wxString	StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	Converts aValue in internal units into a united string.
wxString	StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false) const
wxString	StringFromOptionalValue (std::optional< int > aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	Converts an optional aValue in internal units into a united string.
wxString	MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	A lower-precision version of StringFromValue().
wxString	MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true) const
wxString	MessageTextFromMinOptMax (const MINOPTMAX< int > &aValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
int	ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	Converts aTextValue in aUnits to internal units used by the frame.
std::optional< int >	OptionalValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	Converts aTextValue in aUnits to internal units used by the frame.
EDA_ANGLE	AngleValueFromString (const wxString &aTextValue) const
EDA_UNITS	GetUnitsFromType (EDA_DATA_TYPE aType) const
	Gets the units to use in the conversion based on the underlying user units.

Static Public Member Functions
static void	HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
	Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g.
static EDA_DATA_TYPE	GetTypeFromUnits (const EDA_UNITS aUnits)
	Gets the inferred type from the given units.

Public Attributes
wxString	m_FileWatcherInfo

Static Public Attributes
static const wxString	NullUiString = ""
	The string that is used in the UI to represent a null value.

Protected Member Functions
virtual void	setupUIConditions () override
	Setup the UI conditions for the various actions and their controls in this frame.
void	doReCreateMenuBar () override
void	onToolbarSizeChanged ()
void	onNotebookPageCloseRequest (wxAuiNotebookEvent &evt)
void	onNotebookPageCountChanged (wxAuiNotebookEvent &evt)
virtual void	configureToolbars ()
void	onAutoSaveTimer (wxTimerEvent &aEvent)
	Handle the auto save timer event.
virtual void	handleIconizeEvent (wxIconizeEvent &aEvent)
	Handle a window iconize event.
void	onIconize (wxIconizeEvent &aEvent)
virtual bool	isAutoSaveRequired () const
	Return the auto save status of the application.
virtual bool	doAutoSave ()
	This should be overridden by the derived class to handle the auto save feature.
void	onSystemColorChange (wxSysColourChangedEvent &aEvent)
virtual void	unitsChangeRefresh ()
	Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them.
void	initExitKey ()
	Set the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
void	ensureWindowIsOnScreen ()
virtual void	saveProjectSettings ()
	Save any design-related project settings associated with this frame.
virtual void	OnDropFiles (wxDropFilesEvent &aEvent)
	Handle event fired when a file is dropped to the window.
void	AddMenuLanguageList (ACTION_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
	Create a menu list for language choice, and add it as submenu to MasterMenu.

Protected Attributes
std::vector< wxFileName >	m_AcceptedFiles
FRAME_T	m_ident
wxPoint	m_framePos
wxSize	m_frameSize
bool	m_maximizeByDefault
int	m_displayIndex
wxPoint	m_normalFramePos
wxSize	m_normalFrameSize
wxString	m_aboutTitle
wxAuiManager	m_auimgr
wxString	m_perspective
nlohmann::json	m_auiLayoutState
WX_INFOBAR *	m_infoBar
APPEARANCE_CONTROLS_3D *	m_appearancePanel
wxString	m_configName
SETTINGS_MANAGER *	m_settingsManager
FILE_HISTORY *	m_fileHistory
bool	m_supportsAutoSave
bool	m_autoSavePending
bool	m_autoSaveRequired
wxTimer *	m_autoSaveTimer
bool	m_autoSavePermissionError
int	m_undoRedoCountMax
UNDO_REDO_CONTAINER	m_undoList
UNDO_REDO_CONTAINER	m_redoList
wxString	m_mruPath
ORIGIN_TRANSFORMS	m_originTransforms
std::map< int, UIUpdateHandler >	m_uiUpdateMap
	Map containing the UI update handlers registered with wx for each action.
bool	m_isClosing
	Set by the close window event handler after frames are asked if they can close.
bool	m_isNonUserClose
	Set by NonUserClose() to indicate that the user did not request the current close.
std::map< const wxString, TOOL_ACTION * >	m_acceptedExts
	Associate file extensions with action to execute.
TOOLBAR_SETTINGS *	m_toolbarSettings
ACTION_TOOLBAR *	m_tbTopMain
ACTION_TOOLBAR *	m_tbTopAux
ACTION_TOOLBAR *	m_tbRight
ACTION_TOOLBAR *	m_tbLeft
std::map< std::string, ACTION_TOOLBAR_CONTROL_FACTORY >	m_toolbarControlFactories
TOOL_MANAGER *	m_toolManager
ACTIONS *	m_actions
TOOL_DISPATCHER *	m_toolDispatcher
SELECTION	m_dummySelection
std::vector< std::string >	m_toolStack
bool	m_immediateActions
MOUSE_DRAG_ACTION	m_dragAction
bool	m_moveWarpsCursor

Static Protected Attributes
static constexpr int	KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
	Default style flags used for wxAUI toolbars.

Private Member Functions
void	setupTools ()
void	setupActions ()
void	DoWithAcceptedFiles () override
	Execute action on accepted dropped file.
APP_SETTINGS_BASE *	config () const override
	Return the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
KICAD_SETTINGS *	kicadSettings () const
const SEARCH_STACK &	sys_search () override
	Return a SEARCH_STACK pertaining to entire program.
wxString	help_name () override
void	language_change (wxCommandEvent &event)
void	updatePcmButtonBadge ()
void	windowClosing (wxCloseEvent &event)
	(with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings().
void	commonInit (FRAME_T aFrameType)
	Collect common initialization functions used in all CTORs.
wxWindow *	findQuasiModalDialog ()
virtual bool	IsModal () const
	Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame.

Private Attributes
bool	m_openSavedWindows
int	m_leftWinWidth
bool	m_active_project
PROJECT_TREE_PANE *	m_leftWin
wxAuiNotebook *	m_notebook
PANEL_KICAD_LAUNCHER *	m_launcher
int	m_lastToolbarIconSize
std::shared_ptr< PLUGIN_CONTENT_MANAGER >	m_pcm
BITMAP_BUTTON *	m_pcmButton
int	m_pcmUpdateCount
std::unique_ptr< UPDATE_MANAGER >	m_updateManager
KIWAY *	m_kiway
HOLDER_TYPE	m_type
const EDA_IU_SCALE &	m_iuScale
EDA_UNITS	m_userUnits

Detailed Description

The main KiCad project manager frame.

It is not a KIWAY_PLAYER.

Definition at line 43 of file kicad_manager_frame.h.

Member Enumeration Documentation

HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 41 of file kiway_holder.h.

UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

Specify whether we are interacting with the undo or redo stacks.

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 118 of file eda_base_frame.h.

Constructor & Destructor Documentation

KICAD_MANAGER_FRAME()

KICAD_MANAGER_FRAME::KICAD_MANAGER_FRAME	(	wxWindow *	parent,
		const wxString &	title,
		const wxPoint &	pos,
		const wxSize &	size )

References name.

~KICAD_MANAGER_FRAME()

KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME

(

)

Definition at line 298 of file kicad_manager_frame.cpp.

References TOOL_DISPATCHER::DispatchWxEvent(), PGM_BASE::GetBackgroundJobMonitor(), PGM_BASE::GetNotificationsManager(), TOOLS_HOLDER::m_actions, EDA_BASE_FRAME::m_auimgr, m_notebook, m_pcm, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, onNotebookPageCloseRequest(), onNotebookPageCountChanged(), Pgm(), BACKGROUND_JOBS_MONITOR::UnregisterStatusBar(), and NOTIFICATIONS_MANAGER::UnregisterStatusBar().

Member Function Documentation

AddMenuLanguageList()

void EDA_BASE_FRAME::AddMenuLanguageList ( ACTION_MENU * aMasterMenu, TOOL_INTERACTIVE * aControlTool )

protectedinherited

Create a menu list for language choice, and add it as submenu to MasterMenu.

Parameters

aMasterMenu	is the main menu.
aControlTool	is the tool to associate with the menu.

Definition at line 1857 of file eda_base_frame.cpp.

References _, ACTION_MENU::Add(), language, LanguagesList, ACTION_MENU::SetIcon(), and ACTION_MENU::SetTitle().

Referenced by BITMAP2CMP_FRAME::doReCreateMenuBar(), CVPCB_MAINFRAME::doReCreateMenuBar(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_CALCULATOR_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SIMULATOR_FRAME::doReCreateMenuBar(), and SYMBOL_EDIT_FRAME::doReCreateMenuBar().

AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar * aMenuBar )

inherited

Add the standard KiCad help menu to the menubar.

Definition at line 648 of file eda_base_frame.cpp.

References _, ACTIONS::about, ACTIONS::donate, ACTIONS::getInvolved, ACTIONS::gettingStarted, ACTIONS::help, ACTIONS::listHotKeys, TOOLS_HOLDER::m_toolManager, and ACTIONS::reportBug.

Referenced by CVPCB_MAINFRAME::doReCreateMenuBar(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), and SYMBOL_VIEWER_FRAME::doReCreateMenuBar().

AngleValueFromString()

EDA_ANGLE UNITS_PROVIDER::AngleValueFromString ( const wxString & aTextValue ) const

inlineinherited

Definition at line 188 of file units_provider.h.

References DEGREES, DEGREES_T, EDA_UNIT_UTILS::UI::DoubleValueFromString(), and GetIuScale().

CanAcceptApiCommands()

virtual bool EDA_BASE_FRAME::CanAcceptApiCommands ( )

inlinevirtualinherited

Check if this frame is ready to accept API commands.

A frame might not accept commands if a long-running process is underway, a dialog is open, the user is interacting with a tool, etc.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 656 of file eda_base_frame.h.

Referenced by PCB_EDIT_FRAME::CanAcceptApiCommands().

canCloseWindow()

bool KICAD_MANAGER_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 614 of file kicad_manager_frame.cpp.

References CloseProject(), SETTINGS_MANAGER::GetOpenProjects(), EDA_BASE_FRAME::GetSettingsManager(), kicadSettings(), m_notebook, and KICAD_SETTINGS::m_OpenProjects.

ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1745 of file eda_base_frame.cpp.

References UNITS_PROVIDER::SetUserUnits(), and unitsChangeRefresh().

CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName & aFileName )

virtualinherited

Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input.

If an auto save file exists for aFileName, the user is prompted if they wish to replace file aFileName with the auto saved file. If the user chooses to replace the file, the backup file of aFileName is removed, aFileName is renamed to the backup file name, and the auto save file is renamed to aFileName. If user chooses to keep the existing version of aFileName, the auto save file is removed.

Parameters

aFileName

A wxFileName object containing the file name to check.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1588 of file eda_base_frame.cpp.

References _, FILEEXT::AutoSaveFilePrefix, DeleteAutoSaveFile(), KIPLATFORM::IO::DuplicatePermissions(), Pgm(), and traceAutoSave.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

ClearFileHistory()

void EDA_BASE_FRAME::ClearFileHistory ( )

virtualinherited

Remove all files from the file history.

Reimplemented in GERBVIEW_FRAME.

Definition at line 1238 of file eda_base_frame.cpp.

References m_fileHistory, and ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::ClearFileHistory(), KIWAY::ClearFileHistory(), BITMAP2CMP_FRAME::OnClearFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), and SCH_EDIT_FRAME::OnClearFileHistory().

ClearUndoORRedoList()

virtual void EDA_BASE_FRAME::ClearUndoORRedoList ( UNDO_REDO_LIST aList, int aItemCount = -1 )

inlinevirtualinherited

Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.

Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN. Commands are deleted from the older to the last.

Parameters

aList	= the UNDO_REDO_CONTAINER of commands.
aItemCount	number of old commands to delete. -1 to remove all old commands this will empty the list of commands.

Reimplemented in PCB_BASE_EDIT_FRAME, PL_EDITOR_FRAME, SCH_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 589 of file eda_base_frame.h.

Referenced by ClearUndoRedoList(), PushCommandToRedoList(), and PushCommandToUndoList().

ClearUndoRedoList()

void EDA_BASE_FRAME::ClearUndoRedoList ( )

virtualinherited

Clear the undo and redo list using ClearUndoORRedoList()

Picked items are deleted by ClearUndoORRedoList() according to their status.

Definition at line 1672 of file eda_base_frame.cpp.

References ClearUndoORRedoList(), REDO_LIST, and UNDO_LIST.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_EDIT_FRAME::emptyScreen(), SCH_EDIT_FRAME::importFile(), PCB_EDIT_FRAME::ImportSpecctraSession(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SCH_EDIT_FRAME::OnImportProject(), PL_EDITOR_FRAME::OnNewDrawingSheet(), SCH_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), ~EDA_BASE_FRAME(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

CloseProject()

bool KICAD_MANAGER_FRAME::CloseProject

(

bool

aSave

)

Closes the project, and saves it if aSave is true;.

Definition at line 707 of file kicad_manager_frame.cpp.

References NULL_REPORTER::GetInstance(), PGM_BASE::GetSettingsManager(), HideTabsIfNeeded(), KIWAY_HOLDER::Kiway(), m_active_project, m_leftWin, m_notebook, Pgm(), KIWAY_HOLDER::Prj(), SETTINGS_MANAGER::SaveProject(), SETTINGS_MANAGER::TriggerBackupIfNeeded(), and SETTINGS_MANAGER::UnloadProject().

Referenced by canCloseWindow(), ImportNonKiCadProject(), and LoadProject().

commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T aFrameType )

privateinherited

Collect common initialization functions used in all CTORs.

Definition at line 137 of file eda_base_frame.cpp.

References commonInit(), DEFAULT_MAX_UNDO_ITEMS, defaultSize(), EDA_BASE_FRAME(), PATHS::GetDefaultUserProjectsPath(), PGM_BASE::GetSettingsManager(), ID_AUTO_SAVE_TIMER, initExitKey(), m_auimgr, m_autoSavePending, m_autoSavePermissionError, m_autoSaveRequired, m_autoSaveTimer, m_displayIndex, m_fileHistory, m_frameSize, m_ident, m_infoBar, m_isClosing, m_isNonUserClose, m_maximizeByDefault, m_mruPath, m_settingsManager, m_supportsAutoSave, m_undoRedoCountMax, minSize, minSizeLookup(), onAutoSaveTimer(), Pgm(), and windowClosing().

Referenced by commonInit(), and EDA_BASE_FRAME().

CommonSettingsChanged()

void KICAD_MANAGER_FRAME::CommonSettingsChanged ( int aFlags )

overridevirtual

Notification event that some of the common (suite-wide) settings have changed.

Update menus, toolbars, local variables, etc.

Reimplemented from EDA_BASE_FRAME.

Definition at line 1024 of file kicad_manager_frame.cpp.

References EDA_BASE_FRAME::CommonSettingsChanged(), ENVVARS_CHANGED, PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::m_Appearance, m_lastToolbarIconSize, m_leftWin, m_pcm, onToolbarSizeChanged(), Pgm(), and COMMON_SETTINGS::APPEARANCE::toolbar_icon_size.

config()

APP_SETTINGS_BASE * KICAD_MANAGER_FRAME::config ( ) const

overrideprivatevirtual

Return the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.

Reimplemented from EDA_BASE_FRAME.

Definition at line 467 of file kicad_manager_frame.cpp.

References PGM_KICAD::PgmSettings(), and PgmTop().

Referenced by kicadSettings(), setupActions(), and setupTools().

ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )

inlineoverridevirtualinherited

Get the configuration base name.

This is usually the name of the frame set by CTOR, except for frames shown in multiple modes in which case the m_configName must be set to the base name so that a single configuration can be used.

Returns

a base name prefix used in Load/Save settings to build the full name of keys used in configuration.

Reimplemented from TOOLS_HOLDER.

Definition at line 367 of file eda_base_frame.h.

References m_configName.

configureToolbars()

void EDA_BASE_FRAME::configureToolbars ( )

protectedvirtualinherited

Reimplemented in CVPCB_MAINFRAME, EDA_DRAW_FRAME, GERBVIEW_FRAME, PCB_BASE_EDIT_FRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 521 of file eda_base_frame.cpp.

Referenced by CVPCB_MAINFRAME::configureToolbars(), EDA_DRAW_FRAME::configureToolbars(), PCB_BASE_EDIT_FRAME::configureToolbars(), SCH_EDIT_FRAME::configureToolbars(), SYMBOL_EDIT_FRAME::configureToolbars(), SYMBOL_VIEWER_FRAME::configureToolbars(), and SIMULATOR_FRAME::SIMULATOR_FRAME().

CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 1078 of file eda_base_frame.cpp.

References TOOLS_HOLDER::GetToolCanvas(), m_auimgr, and m_infoBar.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

CreateNewProject()

void KICAD_MANAGER_FRAME::CreateNewProject	(	const wxFileName &	aProjectFileName,
		bool	aCreateStubFiles = true )

Creates a new project by setting up and initial project, schematic, and board files.

The project file is copied from the kicad.pro template file if possible. Otherwise, a minimal project file is created from an empty project. A minimal schematic and board file are created to prevent the schematic and board editors from complaining. If any of these files already exist, they are not overwritten.

Parameters

aProjectFileName	is the absolute path of the project file name.
aCreateStubFiles	specifies if an empty PCB and schematic should be created

Definition at line 853 of file kicad_manager_frame.cpp.

References GetMajorMinorVersion(), EDA_BASE_FRAME::GetSettingsManager(), FILEEXT::KiCadPcbFileExtension, FILEEXT::KiCadSchematicFileExtension, kicadSettings(), FILEEXT::LegacyPcbFileExtension, FILEEXT::LegacyProjectFileExtension, SETTINGS_MANAGER::LoadProject(), m_openSavedWindows, Pgm(), FILEEXT::ProjectFileExtension, SETTINGS_MANAGER::SaveProject(), SaveSettings(), JSON_SETTINGS::SaveToFile(), SEXPR_BOARD_FILE_VERSION, SEXPR_SCHEMATIC_FILE_VERSION, and sys_search().

Referenced by ImportNonKiCadProject().

CreatePCM()

void KICAD_MANAGER_FRAME::CreatePCM

(

)

Definition at line 371 of file kicad_manager_frame.cpp.

References _, NOTIFICATIONS_MANAGER::CreateOrUpdate(), PGM_BASE::GetNotificationsManager(), kicadSettings(), m_pcm, m_pcmUpdateCount, Pgm(), NOTIFICATIONS_MANAGER::Remove(), and updatePcmButtonBadge().

Referenced by OnIdle().

CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 120 of file tools_holder.cpp.

References m_toolStack, and ACTIONS::selectionTool.

Referenced by ShowChangedLanguage().

DeleteAutoSaveFile()

void EDA_BASE_FRAME::DeleteAutoSaveFile ( const wxFileName & aFileName )

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1638 of file eda_base_frame.cpp.

References FILEEXT::AutoSaveFilePrefix, Pgm(), and traceAutoSave.

Referenced by CheckForAutoSaveFile(), and PCB_EDIT_FRAME::OpenProjectFiles().

DisplayToolMsg()

virtual void TOOLS_HOLDER::DisplayToolMsg ( const wxString & msg )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 130 of file tools_holder.h.

Referenced by PopTool(), PushTool(), and ShowChangedLanguage().

doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )

protectedvirtualinherited

This should be overridden by the derived class to handle the auto save feature.

Returns

true if the auto save was successful otherwise false.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 367 of file eda_base_frame.cpp.

Referenced by onAutoSaveTimer().

doCloseWindow()

void KICAD_MANAGER_FRAME::doCloseWindow ( )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 649 of file kicad_manager_frame.cpp.

References m_leftWin, PGM_BASE::m_Quitting, and Pgm().

doReCreateMenuBar()

void KICAD_MANAGER_FRAME::doReCreateMenuBar ( )

overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 46 of file kicad/menubar.cpp.

References _, ACTION_MENU::Add(), FILE_HISTORY::AddFilesToMenu(), EDA_BASE_FRAME::AddMenuLanguageList(), ACTION_MENU::AddQuitOrClose(), EDA_BASE_FRAME::AddStandardHelpMenu(), KICAD_MANAGER_ACTIONS::archiveProject, ACTION_MENU::Clone(), KICAD_MANAGER_ACTIONS::closeProject, ACTIONS::configurePaths, KICAD_MANAGER_ACTIONS::convertImage, ACTIONS::copy, ACTIONS::cut, KIPLATFORM::POLICY::DISABLED, KICAD_MANAGER_ACTIONS::editDrawingSheet, KICAD_MANAGER_ACTIONS::editFootprints, editor, KICAD_MANAGER_ACTIONS::editPCB, KICAD_MANAGER_ACTIONS::editSchematic, KICAD_MANAGER_ACTIONS::editSymbols, ACTION_CONDITIONS::Enable(), FILE_HISTORY::FileHistoryNotEmpty(), EDA_BASE_FRAME::GetFileHistory(), KIPLATFORM::POLICY::GetPolicyBool(), PATHS::GetStockDemosPath(), ID_EDIT_ADVANCED_CFG, ID_EDIT_LOCAL_FILE_IN_TEXT_EDITOR, ID_IMPORT_ALTIUM_PROJECT, ID_IMPORT_CADSTAR_ARCHIVE_PROJECT, ID_IMPORT_EAGLE_PROJECT, ID_IMPORT_EASYEDA_PROJECT, ID_IMPORT_EASYEDAPRO_PROJECT, import_project, TOOLS_HOLDER::m_toolManager, KICAD_MANAGER_ACTIONS::newFromRepository, KICAD_MANAGER_ACTIONS::newJobsetFile, KICAD_MANAGER_ACTIONS::newProject, KICAD_MANAGER_ACTIONS::openDemoProject, KICAD_MANAGER_ACTIONS::openJobsetFile, ACTIONS::openPreferences, KICAD_MANAGER_ACTIONS::openProject, KICAD_MANAGER_ACTIONS::openProjectDirectory, KICAD_MANAGER_ACTIONS::openTextEditor, ACTIONS::paste, Pgm(), POLICY_KEY_PCM, recent, EDA_BASE_FRAME::RegisterUIUpdateHandler(), ACTIONS::saveAs, FILE_HISTORY::SetClearText(), ACTION_MENU::SetIcon(), ACTION_MENU::SetTitle(), KICAD_MANAGER_ACTIONS::showCalculator, ACTIONS::showDesignBlockLibTable, ACTIONS::showFootprintLibTable, KICAD_MANAGER_ACTIONS::showPluginManager, ACTIONS::showSymbolLibTable, KICAD_MANAGER_ACTIONS::unarchiveProject, KICAD_MANAGER_ACTIONS::viewGerbers, and ACTIONS::zoomRedraw.

DoWithAcceptedFiles()

void KICAD_MANAGER_FRAME::DoWithAcceptedFiles ( )

overrideprivatevirtual

Execute action on accepted dropped file.

Called in OnDropFiles() and should be populated with the action to execute in inherited classes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 560 of file kicad_manager_frame.cpp.

References FILEEXT::DrillFileExtension, FindKicadFile(), FILEEXT::GerberFileExtension, FILEEXT::GerberJobFileExtension, GERBVIEW_EXE, FILEEXT::IsGerberFileExtension(), FILEEXT::LegacyProjectFileExtension, EDA_BASE_FRAME::m_acceptedExts, EDA_BASE_FRAME::m_AcceptedFiles, TOOLS_HOLDER::m_toolManager, and FILEEXT::ProjectFileExtension.

Referenced by setupActions().

ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 886 of file eda_base_frame.cpp.

References GetWindowSize(), and traceDisplayLocation.

Referenced by OnSize().

findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

privateinherited

Definition at line 214 of file eda_base_frame.cpp.

References findQuasiModalDialog(), FRAME_SCH, and m_ident.

Referenced by findQuasiModalDialog(), ProcessEvent(), and windowClosing().

FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 1090 of file eda_base_frame.cpp.

References m_auimgr.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

GetAboutTitle()

const wxString & EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 556 of file eda_base_frame.h.

References m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), PGM_KICAD::OnPgmInit(), and PGM_SINGLE_TOP::OnPgmInit().

GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inherited

Definition at line 347 of file eda_base_frame.cpp.

References COMMON_SETTINGS::SYSTEM::autosave_interval, PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::m_System, and Pgm().

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), onAutoSaveTimer(), and ProcessEvent().

GetCurrentFileName()

wxString KICAD_MANAGER_FRAME::GetCurrentFileName ( ) const

inlineoverridevirtual

Get the full filename + path of the currently opened file in the frame.

If no file is open, an empty string is returned.

Returns

the filename and full path to the open file

Reimplemented from EDA_BASE_FRAME.

Definition at line 78 of file kicad_manager_frame.h.

References GetProjectFileName().

GetCurrentSelection()

virtual SELECTION & TOOLS_HOLDER::GetCurrentSelection ( )

inlinevirtualinherited

Get the current selection from the canvas area.

Returns

the current selection.

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, GERBVIEW_FRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 98 of file tools_holder.h.

References m_dummySelection.

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), NL_GERBVIEW_PLUGIN_IMPL::SetActiveCommand(), NL_PCBNEW_PLUGIN_IMPL::SetActiveCommand(), NL_PL_EDITOR_PLUGIN_IMPL::SetActiveCommand(), and NL_SCHEMATIC_PLUGIN_IMPL::SetActiveCommand().

GetCustomToolbarControlFactory()

ACTION_TOOLBAR_CONTROL_FACTORY * EDA_BASE_FRAME::GetCustomToolbarControlFactory ( const std::string & aName )

inherited

Definition at line 509 of file eda_base_frame.cpp.

References m_toolbarControlFactories.

Referenced by ACTION_TOOLBAR::ApplyConfiguration().

GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const

inlineinherited

Indicate that hotkeys should perform an immediate action even if another tool is currently active.

If false, the first hotkey should select the relevant tool.

Definition at line 138 of file tools_holder.h.

References m_immediateActions.

GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.

Definition at line 144 of file tools_holder.h.

References m_dragAction.

GetFileFromHistory()

wxString EDA_BASE_FRAME::GetFileFromHistory ( int cmdId, const wxString & type, FILE_HISTORY * aFileHistory = nullptr )

inherited

Fetch the file name from the file history list.

This removes the selected file, if this file does not exist. The menu is also updated, if #FILE_HISTORY::UseMenu was called at initialization time.

Parameters

cmdId	The command ID associated with the aFileHistory object.
type	Please document me!
aFileHistory	The FILE_HISTORY in use. If null, the main application file history is used

Returns

a wxString containing the selected filename

Definition at line 1198 of file eda_base_frame.cpp.

References _, DisplayErrorMessage(), m_fileHistory, and ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), BITMAP2CMP_FRAME::OnFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), SCH_EDIT_FRAME::OnLoadFile(), and GERBVIEW_FRAME::OnZipFileHistory().

GetFileHistory()

FILE_HISTORY & EDA_BASE_FRAME::GetFileHistory ( )

inlineinherited

Get the frame's main file history.

Returns

the main file history

Definition at line 432 of file eda_base_frame.h.

References m_fileHistory.

Referenced by BITMAP2CMP_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), and SCH_EDIT_FRAME::doReCreateMenuBar().

GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 218 of file eda_base_frame.h.

References m_ident.

Referenced by KIWAY_PLAYER::Destroy(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), EDA_3D_CONTROLLER::ExportImage(), PCB_BASE_FRAME::GetViewerSettingsBase(), SCH_BASE_FRAME::GetViewerSettingsBase(), EDA_3D_CONTROLLER::ReloadBoard(), ShowPreferences(), COMMON_CONTROL::ShowProjectManager(), EDA_3D_CONTROLLER::ToggleLayersManager(), EDA_3D_CONTROLLER::ToggleRaytracing(), and EDA_3D_CONTROLLER::ToggleVisibility().

GetInfoBar()

WX_INFOBAR * EDA_BASE_FRAME::GetInfoBar ( )

inlineinherited

Returns

the WX_INFOBAR that can be displayed on the top of the canvas.

Definition at line 250 of file eda_base_frame.h.

References m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), PCB_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDIT_FRAME::ReloadFootprint(), SYMBOL_EDIT_FRAME::SetCurSymbol(), ShowInfoBarError(), ShowInfoBarError(), ShowInfoBarMsg(), and ShowInfoBarWarning().

GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 55 of file units_provider.h.

References m_iuScale.

Referenced by AngleValueFromString(), GRID_MENU::BuildChoiceList(), RC_ITEM::GetJsonViolation(), DRC_ENGINE::loadImplicitRules(), MessageTextFromMinOptMax(), MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), OptionalValueFromString(), StringFromOptionalValue(), StringFromValue(), GRID::UserUnitsMessageText(), and ValueFromString().

GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 629 of file eda_base_frame.h.

References m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

Indicate that a move operation should warp the mouse pointer to the origin of the move object.

This improves snapping, but some users are allergic to mouse warping.

Definition at line 150 of file tools_holder.h.

References m_moveWarpsCursor.

Referenced by EDIT_TOOL::doMoveSelection(), and ROUTER_TOOL::InlineDrag().

GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 439 of file eda_base_frame.h.

References m_mruPath.

Referenced by AskLoadBoardFileName(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), EDA_DRAW_FRAME::LibraryFileBrowser(), PCB_EDIT_FRAME::SaveBoard(), and SCH_EDIT_FRAME::SaveProject().

GetOriginTransforms()

ORIGIN_TRANSFORMS & EDA_BASE_FRAME::GetOriginTransforms ( )

inlineoverridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from UNITS_PROVIDER.

Reimplemented in PCB_BASE_FRAME.

Definition at line 137 of file eda_base_frame.h.

References m_originTransforms.

Referenced by PCB_DIM_LEADER::GetMsgPanelInfo(), and PCB_DIMENSION_BASE::GetMsgPanelInfo().

GetPcm()

std::shared_ptr< PLUGIN_CONTENT_MANAGER > KICAD_MANAGER_FRAME::GetPcm ( )

inline

Definition at line 189 of file kicad_manager_frame.h.

References m_pcm.

GetProjectFileName()

const wxString KICAD_MANAGER_FRAME::GetProjectFileName

(

)

const

Definition at line 483 of file kicad_manager_frame.cpp.

References PROJECT::GetProjectFullName(), PGM_BASE::GetSettingsManager(), SETTINGS_MANAGER::IsProjectOpen(), Pgm(), and KIWAY_HOLDER::Prj().

Referenced by GetCurrentFileName(), PcbFileName(), PcbLegacyFileName(), ProjectChanged(), SchFileName(), and SchLegacyFileName().

GetRedoActionDescription()

wxString EDA_BASE_FRAME::GetRedoActionDescription ( ) const

virtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 1730 of file eda_base_frame.cpp.

References GetRedoCommandCount(), and m_redoList.

Referenced by HandleUpdateUIEvent().

GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 624 of file eda_base_frame.h.

References m_redoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), GetRedoActionDescription(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), PushCommandToRedoList(), EDITOR_CONDITIONS::redoFunc(), and PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList().

GetRunMenuCommandDescription()

wxString EDA_BASE_FRAME::GetRunMenuCommandDescription ( const TOOL_ACTION & aAction )

inherited

Definition at line 668 of file eda_base_frame.cpp.

References _, TOOL_ACTION::GetFriendlyName(), and TOOL_ACTION::GetMenuLabel().

GetSettingsManager()

SETTINGS_MANAGER * EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

Definition at line 143 of file eda_base_frame.h.

References m_settingsManager.

Referenced by KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CreateNewProject(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::saveProjectSettings(), KICAD_MANAGER_FRAME::SaveSettings(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int aErrorCode ) const

inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME, and SCH_EDIT_FRAME.

Definition at line 145 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

GetToolCanvas()

wxWindow * KICAD_MANAGER_FRAME::GetToolCanvas ( ) const

overridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 461 of file kicad_manager_frame.cpp.

References m_leftWin.

GetToolDispatcher()

TOOL_DISPATCHER * TOOLS_HOLDER::GetToolDispatcher ( ) const

inlineinherited

Definition at line 57 of file tools_holder.h.

References m_toolDispatcher.

GetToolManager()

TOOL_MANAGER * TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

References m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), PCB_EDIT_FRAME::CanAcceptApiCommands(), EDA_DRAW_FRAME::CommonSettingsChanged(), CommonSettingsChanged(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), SCH_FIELD::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), PCB_TUNING_PATTERN::GetPreviewItems(), PCBNEW_JOBS_HANDLER::getToolManager(), API_HANDLER_PCB::handleAddToSelection(), API_HANDLER_PCB::handleClearSelection(), API_HANDLER_PCB::handleGetSelection(), API_HANDLER_PCB::handleInteractiveMoveItems(), API_HANDLER_PCB::handleRefillZones(), API_HANDLER_PCB::handleRemoveFromSelection(), API_HANDLER_PCB::handleSaveSelectionToString(), API_HANDLER_PCB::handleSetBoardOrigin(), PCB_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PCB_EDIT_FRAME::OnCrossProbeFlashTimer(), SCH_EDIT_FRAME::OnCrossProbeFlashTimer(), FOOTPRINT_CHOOSER_FRAME::onFpChanged(), PANEL_COMPONENT_CLASS_ASSIGNMENT::OnHighlightItemsClick(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), PCB_EDIT_FRAME::OnNetlistChanged(), SCH_EDIT_FRAME::onNetNavigatorSelection(), DIALOG_PLOT::onRunDRC(), PCB_EDIT_FRAME::onSize(), SCH_EDIT_FRAME::onSize(), PCB_DESIGN_BLOCK_PANE::PCB_DESIGN_BLOCK_PANE(), PopTool(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), PCB_BASE_FRAME::rebuildConnectivity(), SCH_EDIT_FRAME::RecalculateConnections(), FOOTPRINT_EDIT_FRAME::ReloadFootprint(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), SCH_COMMIT::SCH_COMMIT(), SCH_DESIGN_BLOCK_PANE::SCH_DESIGN_BLOCK_PANE(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), NL_GERBVIEW_PLUGIN_IMPL::SetActiveCommand(), NL_PCBNEW_PLUGIN_IMPL::SetActiveCommand(), NL_PL_EDITOR_PLUGIN_IMPL::SetActiveCommand(), NL_SCHEMATIC_PLUGIN_IMPL::SetActiveCommand(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_MAINFRAME::setupEventHandlers(), FOOTPRINT_EDIT_FRAME::setupTools(), ShowChangedLanguage(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), CVPCB_MAINFRAME::updateFootprintViewerOnIdle(), PCB_EDIT_FRAME::UpdateUserInterface(), and GLOBAL_EDIT_TOOL::ZonesManager().

GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 48 of file kiway_holder.h.

References m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), EDA_3D_CONTROLLER::Main(), and PANEL_PREVIEW_3D_MODEL::onModify().

GetTypeFromUnits()

static EDA_DATA_TYPE UNITS_PROVIDER::GetTypeFromUnits ( const EDA_UNITS aUnits )

inlinestaticinherited

Gets the inferred type from the given units.

Note: will always return the most simple type (e.g. a DISTANCE rather than AREA or VOLUME for a measurement unit).

Definition at line 221 of file units_provider.h.

References CM, DEGREES, DISTANCE, FS, INCH, LENGTH_DELAY, MILS, MM, PERCENT, PS, PS_PER_CM, PS_PER_INCH, PS_PER_MM, TIME, UM, UNITLESS, and UNSCALED.

Referenced by DRC_RULES_PARSER::parseConstraint(), and WX_GRID::SetAutoEvalColUnits().

GetUndoActionDescription()

wxString EDA_BASE_FRAME::GetUndoActionDescription ( ) const

virtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 1721 of file eda_base_frame.cpp.

References GetUndoCommandCount(), and m_undoList.

Referenced by HandleUpdateUIEvent().

GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 623 of file eda_base_frame.h.

References m_undoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), GetUndoActionDescription(), PushCommandToUndoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), PCB_EDIT_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), and EDITOR_CONDITIONS::undoFunc().

GetUnitPair()

virtual void UNITS_PROVIDER::GetUnitPair ( EDA_UNITS & aPrimaryUnit, EDA_UNITS & aSecondaryUnits )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 48 of file units_provider.h.

References GetUserUnits(), EDA_UNIT_UTILS::IsImperialUnit(), MILS, and MM.

GetUnitsFromType()

EDA_UNITS UNITS_PROVIDER::GetUnitsFromType ( EDA_DATA_TYPE aType ) const

inlineinherited

Gets the units to use in the conversion based on the underlying user units.

Definition at line 199 of file units_provider.h.

References GetUserUnits(), EDA_UNIT_UTILS::IsMetricUnit(), LENGTH_DELAY, PS, PS_PER_CM, PS_PER_INCH, and TIME.

Referenced by MessageTextFromMinOptMax(), MessageTextFromValue(), OptionalValueFromString(), StringFromOptionalValue(), StringFromValue(), and ValueFromString().

GetUntranslatedAboutTitle()

const wxString & EDA_BASE_FRAME::GetUntranslatedAboutTitle ( ) const

inlineinherited

Definition at line 558 of file eda_base_frame.h.

References m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 45 of file units_provider.h.

References m_userUnits.

Referenced by PCB::IFACE::CreateKiWindow(), DIALOG_SHIM::DIALOG_SHIM(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), WX_GRID::getColumnUnits(), RC_ITEM::GetJsonViolation(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUnitPair(), GetUnitsFromType(), IfaceOrAddress(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), PANEL_PREVIEW_3D_MODEL::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), POSITION_RELATIVE_TOOL::PositionRelative(), SaveFileAs(), EDA_DRAW_FRAME::SaveSettings(), PCB_BASE_FRAME::SetBoard(), WX_GRID::SetUnitsProvider(), EDA_DRAW_FRAME::ToggleUserUnits(), PCB_BASE_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), PL_EDITOR_FRAME::UpdateStatusBar(), and GRID::UserUnitsMessageText().

GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE * aCfg )

virtualinherited

Return a pointer to the window settings for this frame.

By default, points to aCfg->m_Window for top-level frames.

Parameters

aCfg	is this frame's config object

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_CHOOSER_FRAME, FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, SIMULATOR_FRAME, SYMBOL_CHOOSER_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 1047 of file eda_base_frame.cpp.

References APP_SETTINGS_BASE::m_Window.

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

GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )

inherited

Get the undecorated window size that can be used for restoring the window size.

This is needed for GTK, since the normal wxWidgets GetSize() call will return a window size that includes the window decorations added by the window manager.

Returns

the undecorated window size

Definition at line 1781 of file eda_base_frame.cpp.

References KICAD_MAIN_FRAME_T, and m_ident.

Referenced by ensureWindowIsOnScreen(), OnMaximize(), and SaveWindowSettings().

handleIconizeEvent()

virtual void EDA_BASE_FRAME::handleIconizeEvent ( wxIconizeEvent & aEvent )

inlineprotectedvirtualinherited

Handle a window iconize event.

Parameters

aEvent

is the data for the event.

Reimplemented in EDA_3D_VIEWER_FRAME, GERBVIEW_FRAME, PCB_BASE_FRAME, PL_EDITOR_FRAME, and SCH_BASE_FRAME.

Definition at line 677 of file eda_base_frame.h.

Referenced by EDA_3D_VIEWER_FRAME::handleIconizeEvent(), GERBVIEW_FRAME::handleIconizeEvent(), PCB_BASE_FRAME::handleIconizeEvent(), PL_EDITOR_FRAME::handleIconizeEvent(), SCH_BASE_FRAME::handleIconizeEvent(), and onIconize().

HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

Update the UI in response to a change in the system colors.

Definition at line 1805 of file eda_base_frame.cpp.

References GetBitmapStore(), ReCreateMenuBar(), BITMAP_STORE::ThemeChanged(), and ThemeChanged().

Referenced by onSystemColorChange().

HandleUpdateUIEvent()

void EDA_BASE_FRAME::HandleUpdateUIEvent ( wxUpdateUIEvent & aEvent, EDA_BASE_FRAME * aFrame, ACTION_CONDITIONS aCond )

staticinherited

Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g.

enabled, checked, etc.).

Parameters

aEvent	is the wxUpdateUIEvent to be processed.
aFrame	is the frame to get the selection from
aCond	are the #UI SELECTION_CONDITIONS used

Definition at line 416 of file eda_base_frame.cpp.

References _, ACTION_CONDITIONS::checkCondition, ACTIONS::copy, ACTIONS::cut, EDA_BASE_FRAME(), ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), GetRedoActionDescription(), GetUndoActionDescription(), ACTIONS::paste, ACTIONS::redo, ACTION_CONDITIONS::showCondition, and ACTIONS::undo.

Referenced by RegisterUIUpdateHandler().

HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const

inlineinherited

Safety check before asking for the Kiway reference.

Returns

true if kiway is non-null

Definition at line 65 of file kiway_holder.h.

References m_kiway.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), and DIALOG_SHIM::~DIALOG_SHIM().

help_name()

wxString KICAD_MANAGER_FRAME::help_name ( )

overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 538 of file kicad_manager_frame.cpp.

References PGM_KICAD::GetHelpFileName(), and PgmTop().

Referenced by setupActions().

HideTabsIfNeeded()

void KICAD_MANAGER_FRAME::HideTabsIfNeeded

(

)

Hides the tabs for Editor notebook if there is only 1 page.

Definition at line 323 of file kicad_manager_frame.cpp.

References m_notebook.

Referenced by CloseProject(), onNotebookPageCountChanged(), and OpenJobsFile().

ImportHotkeyConfigFromFile()

void EDA_BASE_FRAME::ImportHotkeyConfigFromFile ( std::map< std::string, TOOL_ACTION * > aActionMap, const wxString & aDefaultShortname )

inherited

Prompt the user for a hotkey file to read, and read it.

Parameters

aActionMap	current hotkey map (over which the imported hotkeys will be applied).
aDefaultShortname	a default short name (extension not needed) like Eeschema, KiCad...

ImportNonKiCadProject()

void KICAD_MANAGER_FRAME::ImportNonKiCadProject	(	const wxString &	aWindowTitle,
		const wxString &	aFilesWildcard,
		const std::vector< std::string > &	aSchFileExtensions,
		const std::vector< std::string > &	aPcbFileExtensions,
		int	aSchFileType,
		int	aPcbFileType )

Creates a project and imports a non-KiCad Schematic and PCB.

Parameters

aWindowTitle	to display to the user when opening the files
aFilesWildcard	that includes both PCB and Schematic files (from wildcards_and_files_ext.h)
aSchFileExtensions	e.g. { "sch" } or { "csa" }. Specify { "INPUT" } to copy input file.
aPcbFileExtensions	e.g. { "brd" } or { "cpa" }. Specify { "INPUT" } to copy input file.
aSchFileType	Type of Schematic File to import (from SCH_IO_MGR::SCH_FILE_T)
aPcbFileType	Type of PCB File to import (from IO_MGR::PCB_FILE_T)

Definition at line 46 of file import_project.cpp.

References _, CloseProject(), CreateNewProject(), DisplayErrorMessage(), KIDIALOG::DoNotShowCheckbox(), IMPORT_PROJ_HELPER::FindEmptyTargetDir(), EDA_BASE_FRAME::GetMruPath(), IMPORT_PROJ_HELPER::ImportFiles(), LoadProject(), m_active_project, IMPORT_PROJ_HELPER::m_InputFile, IMPORT_PROJ_HELPER::m_TargetProj, FILEEXT::ProjectFileExtension, ReCreateTreePrj(), and KIDIALOG::ShowModal().

Referenced by OnImportAltiumProjectFiles(), OnImportCadstarArchiveFiles(), OnImportEagleFiles(), OnImportEasyEdaFiles(), and OnImportEasyEdaProFiles().

initExitKey()

void EDA_BASE_FRAME::initExitKey ( )

protectedinherited

Set the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.

This is useful in sub-applications to pass the event up to a non-owning window.

Definition at line 1663 of file eda_base_frame.cpp.

Referenced by commonInit().

isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const

inlineprotectedvirtualinherited

Return the auto save status of the application.

Override this function if your derived frame supports automatic file saving.

Definition at line 685 of file eda_base_frame.h.

References m_autoSaveRequired.

Referenced by ProcessEvent().

IsClosing()

bool EDA_BASE_FRAME::IsClosing ( ) const

inlineinherited

Definition at line 637 of file eda_base_frame.h.

References m_isClosing.

IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( ) const

virtualinherited

Get if the contents of the frame have been modified since the last save.

Returns

true if the contents of the frame have not been saved

Reimplemented in CVPCB_MAINFRAME, FOOTPRINT_EDIT_FRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, SCH_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 1656 of file eda_base_frame.cpp.

Referenced by GERBVIEW_FRAME::Clear_DrawLayers(), EDITOR_CONDITIONS::contentModifiedFunc(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), and SCH_BASE_FRAME::OnSymChangeDebounceTimer().

IsCurrentTool()

bool TOOLS_HOLDER::IsCurrentTool ( const TOOL_ACTION & aAction ) const

inherited

Definition at line 129 of file tools_holder.cpp.

References TOOL_ACTION::GetName(), m_toolStack, and ACTIONS::selectionTool.

Referenced by EDITOR_CONDITIONS::toolFunc().

IsModal()

virtual bool EDA_BASE_FRAME::IsModal ( ) const

inlineprivatevirtualinherited

Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame.

In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing.

Reimplemented in KIWAY_PLAYER.

Definition at line 785 of file eda_base_frame.h.

References IsModal().

Referenced by IsModal(), and windowClosing().

IsProjectActive()

bool KICAD_MANAGER_FRAME::IsProjectActive

(

)

Definition at line 1144 of file kicad_manager_frame.cpp.

References m_active_project.

IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inlineinherited

Definition at line 217 of file eda_base_frame.h.

References m_ident.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), PCB_POINT_EDITOR::changeArcEditMode(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), COMMON_TOOLS::doZoomFit(), SCH_BASE_FRAME::GetColorSettings(), FOOTPRINT::GetMsgPanelInfo(), PCB_BASE_FRAME::loadFootprint(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), EE_GRID_HELPER::queryVisible(), SCH_COMMIT::SCH_COMMIT(), and SCH_COMMIT::SCH_COMMIT().

IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName & aFileName, bool aVerbose = true )

inherited

Check if aFileName can be written.

The function performs a number of tests on aFileName to verify that it can be saved. If aFileName defines a path with no file name, them the path is tested for user write permission. If aFileName defines a file name that does not exist in the path, the path is tested for user write permission. If aFileName defines a file that already exits, the file name is tested for user write permissions.

Note

The file name path must be set or an assertion will be raised on debug builds and return false on release builds.

Parameters

aFileName	The full path and/or file name of the file to test.
aVerbose	If true will show an error dialog if the file is not writable

Returns

False if aFileName cannot be written.

Definition at line 1545 of file eda_base_frame.cpp.

References _, and DisplayErrorMessage().

Referenced by PCB_EDIT_FRAME::DoAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::saveBoardAsFile(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveProjectSettings(), and SCH_EDIT_FRAME::saveSchematicFile().

kicadSettings()

KICAD_SETTINGS * KICAD_MANAGER_FRAME::kicadSettings ( ) const

private

Definition at line 475 of file kicad_manager_frame.cpp.

References config().

Referenced by canCloseWindow(), CreateNewProject(), CreatePCM(), LoadProject(), OnIdle(), and setupActions().

Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const

inlineinherited

Return a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 55 of file kiway_holder.h.

References m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), IMPORT_PROJ_HELPER::addLocalLibraries(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesList(), KICAD_MANAGER_FRAME::CloseProject(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), KIWAY_PLAYER::Destroy(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), PGM_SINGLE_TOP::MacOpenFile(), PCB_CALCULATOR_FRAME::OnExit(), SIMULATOR_FRAME::onExit(), EDA_3D_CANVAS::OnLeftDown(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::PCB_DESIGN_BLOCK_PREVIEW_WIDGET(), Prj(), SCH_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), BOARD_EDITOR_CONTROL::ShowEeschema(), CVPCB_CONTROL::ShowFootprintViewer(), showFrame(), EDA_BASE_FRAME::ShowPreferences(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), KICAD_MANAGER_FRAME::UnarchiveFiles(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

language_change()

void KICAD_MANAGER_FRAME::language_change ( wxCommandEvent & event )

private

Definition at line 993 of file kicad_manager_frame.cpp.

References KIWAY_HOLDER::Kiway(), and KIWAY::SetLanguage().

Referenced by setupActions().

LoadProject()

void KICAD_MANAGER_FRAME::LoadProject

(

const wxFileName &

aProjectFileName

)

Definition at line 794 of file kicad_manager_frame.cpp.

References KIPLATFORM::ENV::AddToRecentDocs(), CloseProject(), EDA_BASE_FRAME::GetSettingsManager(), PGM_BASE::GetSettingsManager(), ID_INIT_WATCHED_PATHS, jobset, kicadSettings(), SETTINGS_MANAGER::LoadProject(), EDA_BASE_FRAME::LoadWindowState(), m_active_project, m_leftWin, m_notebook, m_openSavedWindows, OpenJobsFile(), Pgm(), PrintPrjInfo(), KIWAY_HOLDER::Prj(), KIPLATFORM::APP::RegisterApplicationRestart(), SaveSettings(), JSON_SETTINGS::SaveToFile(), and EDA_BASE_FRAME::SetMruPath().

Referenced by PROJECT_TREE_ITEM::Activate(), ImportNonKiCadProject(), PGM_KICAD::MacOpenFile(), OnFileHistory(), PGM_KICAD::OnPgmInit(), and UnarchiveFiles().

LoadSettings()

void KICAD_MANAGER_FRAME::LoadSettings ( APP_SETTINGS_BASE * aCfg )

overridevirtual

Load common frame parameters from a configuration file.

Don't forget to call the base method or your frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 1107 of file kicad_manager_frame.cpp.

References EDA_BASE_FRAME::LoadSettings(), and m_leftWinWidth.

LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS * aCfg )

inherited

Load window settings from the given settings object.

Normally called by LoadSettings() unless the window in question is a child window that* stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.

Definition at line 939 of file eda_base_frame.cpp.

References WINDOW_SETTINGS::aui_state, TOOLS_HOLDER::CommonSettingsChanged(), LoadWindowState(), m_auiLayoutState, m_mruPath, m_perspective, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, and WINDOW_SETTINGS::state.

Referenced by LoadSettings().

LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE & aState )

virtualinherited

Load frame state info from a configuration file.

Definition at line 790 of file eda_base_frame.cpp.

References defaultSize(), WINDOW_STATE::display, m_displayIndex, m_framePos, m_frameSize, m_ident, m_maximizeByDefault, m_normalFramePos, m_normalFrameSize, WINDOW_STATE::maximized, minSize, minSizeLookup(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.

LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString & aFileName )

inherited

Definition at line 776 of file eda_base_frame.cpp.

References PROJECT_LOCAL_SETTINGS::GetFileState(), PROJECT::GetLocalSettings(), LoadWindowState(), Pgm(), KIWAY_HOLDER::Prj(), and PROJECT_FILE_STATE::window.

Referenced by KICAD_MANAGER_FRAME::LoadProject(), PCB_EDIT_FRAME::LoadProjectSettings(), LoadWindowSettings(), LoadWindowState(), and SCH_EDIT_FRAME::OpenProjectFiles().

MessageTextFromMinOptMax()

wxString UNITS_PROVIDER::MessageTextFromMinOptMax ( const MINOPTMAX< int > & aValue, EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const

inlineinherited

Definition at line 141 of file units_provider.h.

References DISTANCE, GetIuScale(), GetUnitsFromType(), and EDA_UNIT_UTILS::UI::MessageTextFromMinOptMax().

Referenced by PCB_TRACK::GetMsgPanelInfo(), and PCB_TUNING_PATTERN::GetMsgPanelInfo().

MessageTextFromValue() [1/2]

wxString UNITS_PROVIDER::MessageTextFromValue ( const EDA_ANGLE & aValue, bool aAddUnitLabel = true ) const

inlineinherited

Definition at line 134 of file units_provider.h.

References EDA_ANGLE::AsDegrees(), DEGREES, DISTANCE, EDA_UNIT_UTILS::UI::MessageTextFromValue(), and unityScale.

MessageTextFromValue() [2/2]

wxString UNITS_PROVIDER::MessageTextFromValue ( double aValue, bool aAddUnitLabel = true, EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const

inlineinherited

A lower-precision version of StringFromValue().

Should ONLY be used for status text and messages. Not suitable for dialogs, files, etc. where the loss of precision matters.

Definition at line 127 of file units_provider.h.

References DISTANCE, GetIuScale(), GetUnitsFromType(), and EDA_UNIT_UTILS::UI::MessageTextFromValue().

Referenced by CheckDuplicatePins(), CheckLibSymbol(), CheckLibSymbolGraphics(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), GERBVIEW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DRC_ENGINE::EvalRules(), DRC_TEST_PROVIDER::formatMsg(), DRC_TEST_PROVIDER::formatMsg(), DS_DRAW_ITEM_LINE::GetItemDescription(), DS_DRAW_ITEM_RECT::GetItemDescription(), PCB_TRACK::GetItemDescription(), SCH_LINE::GetItemDescription(), SCH_SHAPE::GetItemDescription(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_BARCODE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_POINT::GetMsgPanelInfo(), PCB_REFERENCE_IMAGE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_JUNCTION::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_TABLECELL::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), STROKE_PARAMS::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), GetNetNavigatorItemText(), PCB_BASE_FRAME::MessageTextFromCoord(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), EDA_SHAPE::ShapeGetMsgPanelInfo(), showCoord(), DRC_TEST_PROVIDER_MISC::testOutline(), VIA_SIZE_MENU::update(), PL_EDITOR_FRAME::UpdateMsgPanelInfo(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), and SCH_BASE_FRAME::UpdateStatusBar().

NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce )

inlineinherited

Definition at line 639 of file eda_base_frame.h.

References m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protectedinherited

Handle the auto save timer event.

Definition at line 353 of file eda_base_frame.cpp.

References doAutoSave(), GetAutoSaveInterval(), ID_AUTO_SAVE_TIMER, and m_autoSaveTimer.

Referenced by commonInit(), and ~EDA_BASE_FRAME().

OnChangeWatchedPaths()

void KICAD_MANAGER_FRAME::OnChangeWatchedPaths

(

wxCommandEvent &

aEvent

)

Called by sending a event with id = ID_INIT_WATCHED_PATHS rebuild the list of watched paths.

Definition at line 1649 of file project_tree_pane.cpp.

References m_leftWin.

OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent & aKeyEvent )

virtualinherited

Capture the key event before it is sent to the GUI.

The basic frame does not capture this event. Editor frames should override this event function to capture and filter these keys when they are used as hotkeys, and skip it if the key is not used as hotkey (otherwise the key events will be not sent to menus).

Reimplemented in FOOTPRINT_VIEWER_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 373 of file eda_base_frame.cpp.

References dump(), and kicadTraceKeyEvent.

OnClearFileHistory()

void KICAD_MANAGER_FRAME::OnClearFileHistory

(

wxCommandEvent &

aEvent

)

Definition at line 49 of file kicad/files-io.cpp.

References EDA_BASE_FRAME::ClearFileHistory().

OnCreateStatusBar()

wxStatusBar * KICAD_MANAGER_FRAME::OnCreateStatusBar ( int number, long style, wxWindowID id, const wxString & name )

override

Create the status line (like a wxStatusBar).

This is actually a KISTATUSBAR status bar. the specified number of fields is the extra number of fields, not the full field count.

Returns

a KISTATUSBAR (derived from wxStatusBar)

Definition at line 364 of file kicad_manager_frame.cpp.

References name.

OnDropFiles()

void EDA_BASE_FRAME::OnDropFiles ( wxDropFilesEvent & aEvent )

protectedvirtualinherited

Handle event fired when a file is dropped to the window.

In this base class, stores the path of files accepted. Calls DoWithAcceptedFiles() to execute actions on files.

Definition at line 1511 of file eda_base_frame.cpp.

References DoWithAcceptedFiles(), FILEEXT::GerberFileExtension, FILEEXT::IsGerberFileExtension(), m_acceptedExts, and m_AcceptedFiles.

OnEditAdvancedCfg()

void KICAD_MANAGER_FRAME::OnEditAdvancedCfg

(

wxCommandEvent &

event

)

Definition at line 980 of file kicad_manager_frame.cpp.

OnExit()

void KICAD_MANAGER_FRAME::OnExit

(

wxCommandEvent &

event

)

Definition at line 701 of file kicad_manager_frame.cpp.

OnFileHistory()

void KICAD_MANAGER_FRAME::OnFileHistory

(

wxCommandEvent &

event

)

Definition at line 38 of file kicad/files-io.cpp.

References _, EDA_BASE_FRAME::GetFileFromHistory(), and LoadProject().

onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent & aEvent )

protectedinherited

Definition at line 1831 of file eda_base_frame.cpp.

References handleIconizeEvent().

OnIdle()

void KICAD_MANAGER_FRAME::OnIdle

(

wxIdleEvent &

event

)

We start loading the saved previously open windows on idle to avoid locking up the GUI earlier in project loading. This gives us the visual effect of a opened KiCad project but with a "busy" progress reporter

Definition at line 1150 of file kicad_manager_frame.cpp.

References _, PROJECT_LOCAL_SETTINGS::ClearFileState(), CreatePCM(), KIPLATFORM::POLICY::DISABLED, KICAD_MANAGER_ACTIONS::editPCB, KICAD_MANAGER_ACTIONS::editSchematic, PGM_BASE::GetCommonSettings(), PROJECT::GetLocalSettings(), KIPLATFORM::POLICY::GetPolicyBool(), TOOLS_HOLDER::GetToolManager(), FILEEXT::KiCadPcbFileExtension, FILEEXT::KiCadSchematicFileExtension, kicadSettings(), FILEEXT::LegacyPcbFileExtension, FILEEXT::LegacySchematicFileExtension, COMMON_SETTINGS::m_DoNotShowAgain, KICAD_SETTINGS::m_KiCadUpdateCheck, m_openSavedWindows, m_pcm, KICAD_SETTINGS::m_PcmUpdateCheck, m_updateManager, Pgm(), POLICY_KEY_PCM, KIWAY_HOLDER::Prj(), TOOL_MANAGER::RunAction(), APP_PROGRESS_DIALOG::Update(), and COMMON_SETTINGS::DO_NOT_SHOW_AGAIN::update_check_prompt.

OnImportAltiumProjectFiles()

void KICAD_MANAGER_FRAME::OnImportAltiumProjectFiles

(

wxCommandEvent &

event

)

Open dialog to import Altium project files.

Definition at line 144 of file import_project.cpp.

References _, PCB_IO_MGR::ALTIUM_DESIGNER, FILEEXT::AltiumProjectFilesWildcard(), and ImportNonKiCadProject().

OnImportCadstarArchiveFiles()

void KICAD_MANAGER_FRAME::OnImportCadstarArchiveFiles

(

wxCommandEvent &

event

)

Open dialog to import CADSTAR Schematic and PCB Archive files.

Definition at line 152 of file import_project.cpp.

References _, PCB_IO_MGR::CADSTAR_PCB_ARCHIVE, FILEEXT::CadstarArchiveFilesWildcard(), and ImportNonKiCadProject().

OnImportEagleFiles()

void KICAD_MANAGER_FRAME::OnImportEagleFiles

(

wxCommandEvent &

event

)

Open dialog to import Eagle schematic and board files.

Definition at line 160 of file import_project.cpp.

References _, PCB_IO_MGR::EAGLE, FILEEXT::EagleFilesWildcard(), and ImportNonKiCadProject().

OnImportEasyEdaFiles()

void KICAD_MANAGER_FRAME::OnImportEasyEdaFiles

(

wxCommandEvent &

event

)

Open dialog to import EasyEDA Std schematic and board files.

Definition at line 167 of file import_project.cpp.

References _, PCB_IO_MGR::EASYEDA, FILEEXT::EasyEdaArchiveWildcard(), and ImportNonKiCadProject().

OnImportEasyEdaProFiles()

void KICAD_MANAGER_FRAME::OnImportEasyEdaProFiles

(

wxCommandEvent &

event

)

Open dialog to import EasyEDA Pro schematic and board files.

Definition at line 174 of file import_project.cpp.

References _, PCB_IO_MGR::EASYEDAPRO, FILEEXT::EasyEdaProFileWildcard(), and ImportNonKiCadProject().

OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

Definition at line 1253 of file eda_base_frame.cpp.

References EDA_BASE_FRAME(), and ShowAboutDialog().

OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

inherited

Definition at line 1757 of file eda_base_frame.cpp.

References GetWindowSize(), m_normalFramePos, m_normalFrameSize, and traceDisplayLocation.

OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent & event )

inherited

The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves.

Definition at line 383 of file eda_base_frame.cpp.

References TOOLS_HOLDER::m_toolDispatcher.

OnModify()

void EDA_BASE_FRAME::OnModify ( )

virtualinherited

Must be called after a model change in order to set the "modify" flag and do other frame-specific processing.

Reimplemented in FOOTPRINT_EDIT_FRAME, PCB_BASE_FRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, SCH_EDIT_FRAME, SIMULATOR_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 1739 of file eda_base_frame.cpp.

References m_autoSaveRequired.

Referenced by PCB_BASE_FRAME::OnModify(), PL_EDITOR_FRAME::OnModify(), SCH_EDIT_FRAME::OnModify(), SIMULATOR_FRAME::OnModify(), and SYMBOL_EDIT_FRAME::OnModify().

OnMove()

virtual void EDA_BASE_FRAME::OnMove ( wxMoveEvent & aEvent )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 196 of file eda_base_frame.h.

onNotebookPageCloseRequest()

void KICAD_MANAGER_FRAME::onNotebookPageCloseRequest ( wxAuiNotebookEvent & evt )

protected

Definition at line 338 of file kicad_manager_frame.cpp.

References SaveOpenJobSetsToLocalSettings().

Referenced by EVT_MENU_RANGE(), and ~KICAD_MANAGER_FRAME().

onNotebookPageCountChanged()

void KICAD_MANAGER_FRAME::onNotebookPageCountChanged ( wxAuiNotebookEvent & evt )

protected

Definition at line 332 of file kicad_manager_frame.cpp.

References HideTabsIfNeeded().

Referenced by EVT_MENU_RANGE(), and ~KICAD_MANAGER_FRAME().

OnOpenFileInTextEditor()

void KICAD_MANAGER_FRAME::OnOpenFileInTextEditor

(

wxCommandEvent &

event

)

Definition at line 960 of file kicad_manager_frame.cpp.

References _, FILEEXT::AllFilesWildcard(), PROJECT::GetProjectPath(), TOOLS_HOLDER::m_toolManager, KICAD_MANAGER_ACTIONS::openTextEditor, Pgm(), and KIWAY_HOLDER::Prj().

OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

inherited

Definition at line 1260 of file eda_base_frame.cpp.

References ShowPreferences().

OnSize()

void KICAD_MANAGER_FRAME::OnSize ( wxSizeEvent & event )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 544 of file kicad_manager_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, m_FileWatcherInfo, PrintPrjInfo(), and KISTATUSBAR::SetEllipsedTextField().

onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent & aEvent )

protectedinherited

Definition at line 1821 of file eda_base_frame.cpp.

References HandleSystemColorChange().

OnToolbarSizeChanged()

void EDA_BASE_FRAME::OnToolbarSizeChanged ( )

inherited

Update toolbars if desired toolbar icon changed.

Definition at line 613 of file eda_base_frame.cpp.

References m_auimgr, m_tbLeft, m_tbRight, m_tbTopAux, and m_tbTopMain.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged().

onToolbarSizeChanged()

void KICAD_MANAGER_FRAME::onToolbarSizeChanged ( )

protected

Definition at line 1270 of file kicad_manager_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, EDA_BASE_FRAME::m_tbLeft, and EDA_BASE_FRAME::RecreateToolbars().

Referenced by CommonSettingsChanged().

OpenJobsFile()

void KICAD_MANAGER_FRAME::OpenJobsFile	(	const wxFileName &	aFileName,
		bool	aCreate = false,
		bool	aResaveProjectPreferences = true )

Definition at line 750 of file kicad_manager_frame.cpp.

References _, DisplayErrorMessage(), HideTabsIfNeeded(), m_notebook, JOBSET_DESTINATION::m_outputHandler, SaveOpenJobSetsToLocalSettings(), PANEL_NOTEBOOK_BASE::SetClosable(), JOBS_OUTPUT_HANDLER::SetOutputPath(), and PANEL_NOTEBOOK_BASE::SetProjectTied().

Referenced by PROJECT_TREE_ITEM::Activate(), and LoadProject().

OptionalValueFromString()

std::optional< int > UNITS_PROVIDER::OptionalValueFromString ( const wxString & aTextValue, EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const

inlineinherited

Converts aTextValue in aUnits to internal units used by the frame.

Allows the return of an empty optional if the string represents a null value (currently empty string)

Warning

This utilizes the current locale and will break if decimal formats differ

Parameters

aType	is the type of this value, and controls the way the string is converted to a value
aTextValue	A reference to a wxString object containing the string to convert.

Returns

internal units value

Definition at line 175 of file units_provider.h.

References DISTANCE, EDA_UNIT_UTILS::UI::DoubleValueFromString(), GetIuScale(), GetUnitsFromType(), KiROUND(), and NullUiString.

Referenced by WX_GRID::GetOptionalUnitValue(), and WX_GRID::onCellEditorHidden().

PcbFileName()

const wxString KICAD_MANAGER_FRAME::PcbFileName

(

)

Definition at line 508 of file kicad_manager_frame.cpp.

References GetProjectFileName().

Referenced by PROJECT_TREE_ITEM::Activate().

PcbLegacyFileName()

const wxString KICAD_MANAGER_FRAME::PcbLegacyFileName

(

)

Definition at line 517 of file kicad_manager_frame.cpp.

References GetProjectFileName(), and FILEEXT::LegacyPcbFileExtension.

Referenced by PROJECT_TREE_ITEM::Activate().

PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )

virtualinherited

Return the last command to undo and remove it from list, nothing is deleted.

Definition at line 1715 of file eda_base_frame.cpp.

References m_redoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), and PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList().

PopCommandFromUndoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromUndoList ( )

virtualinherited

Return the last command to undo and remove it from list, nothing is deleted.

Definition at line 1709 of file eda_base_frame.cpp.

References m_undoList.

Referenced by PCB_BASE_EDIT_FRAME::AppendCopyToUndoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), PCB_BASE_EDIT_FRAME::RollbackFromUndo(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), PCB_EDIT_FRAME::RunActionPlugin(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

PopTool()

void TOOLS_HOLDER::PopTool ( const TOOL_EVENT & aEvent )

virtualinherited

Pops a tool from the stack.

Parameters

aEvent

The event that started the tool that was pushed to the stack.

Definition at line 78 of file tools_holder.cpp.

References DisplayToolMsg(), TOOL_EVENT::getCommandStr(), GetToolManager(), m_toolManager, m_toolStack, TOOL_ACTION::MakeEvent(), TOOL_MANAGER::PostEvent(), ACTIONS::selectionTool, TOOL_EVENT::SetHasPosition(), and TOOL_EVENT::SetReactivate().

Referenced by EDIT_TOOL::doMoveSelection(), PCB_VIEWER_TOOLS::MeasureTool(), and EDIT_TOOL::Remove().

PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString & text )

inherited

Definition at line 1072 of file eda_base_frame.cpp.

References text.

Referenced by KICAD_MANAGER_FRAME::UnarchiveFiles().

PrintPrjInfo()

void KICAD_MANAGER_FRAME::PrintPrjInfo

(

)

Prints the current working directory name and the project name on the text panel.

Definition at line 1134 of file kicad_manager_frame.cpp.

References _, KIWAY_HOLDER::Prj(), and KISTATUSBAR::SetEllipsedTextField().

Referenced by LoadProject(), OnSize(), and ShowChangedLanguage().

Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

References Kiway(), and KIWAY::Prj().

Referenced by DESIGN_BLOCK_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesList(), PCB_BASE_FRAME::canCloseWindow(), SIMULATOR_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), CVPCB_MAINFRAME::DisplayStatus(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TABLECELL_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), EDA_3D_VIEWER_FRAME::getExportFileName(), PCB_BASE_FRAME::GetLibraryItemsForListDialog(), SCH_BASE_FRAME::GetLibraryItemsForListDialog(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), API_HANDLER_PCB::handleRevertDocument(), FIELDS_GRID_TABLE::initGrid(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SIMULATOR_FRAME::LoadSettings(), SIMULATOR_FRAME::LoadSimulator(), EDA_BASE_FRAME::LoadWindowState(), EDA_3D_VIEWER_FRAME::NewDisplay(), DIALOG_SIM_MODEL< T >::onBrowseButtonClick(), DIALOG_EXPORT_2581::onBrowseClicked(), DIALOG_EXPORT_ODBPP::onBrowseClicked(), DIALOG_EXPORT_STEP::onBrowseClicked(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowseClicked(), DIALOG_IMPORT_NETLIST::onBrowseNetlistFiles(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), DIALOG_EXPORT_STEP::onExportButton(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), DIALOG_GENDRILL::onGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_CONFIG_EQUFILES::OnOkClick(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_PLOT::onOpenOutputDirectory(), DIALOG_GEN_FOOTPRINT_POSITION::onOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::onOutputDirectoryBrowseClicked(), DIALOG_PLOT::onOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::onOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_FIELDS_TABLE::OnOutputFileBrowseClicked(), DIALOG_BOARD_SETUP::onPageChanged(), DIALOG_SCHEMATIC_SETUP::onPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_DRC::OnSaveReport(), DIALOG_ERC::OnSaveReport(), SCH_BASE_FRAME::OnSymChange(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), EDA_DRAW_FRAME::PrintDrawingSheet(), KICAD_MANAGER_FRAME::PrintPrjInfo(), KICAD_MANAGER_FRAME::ProjectChanged(), CVPCB_MAINFRAME::readNetListAndFpFiles(), EDA_3D_VIEWER_FRAME::ReloadRequest(), SIMULATOR_FRAME::ReloadSimulator(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), SAVE_SYMBOL_AS_DIALOG::SAVE_SYMBOL_AS_DIALOG(), KICAD_MANAGER_FRAME::SaveOpenJobSetsToLocalSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SIMULATOR_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), SCH_BASE_FRAME::SelectLibrary(), PCB_BASE_FRAME::setFPWatcher(), GERBVIEW_FRAME::SetPageSettings(), SCH_BASE_FRAME::setSymWatcher(), DIALOG_LIB_FIELDS_TABLE::SetupColumnProperties(), DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties(), BOARD_EDITOR_CONTROL::ShowEeschema(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_SIM_MODEL< T >::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataToWindow(), KICAD_MANAGER_FRAME::UnarchiveFiles(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), SIMULATOR_FRAME::UpdateTitle(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), and EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME().

ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent & aEvent )

overrideinherited

Override the default process event handler to implement the auto save feature.

Warning

If you override this function in a derived class, make sure you call down to this or the auto save feature will be disabled.

Definition at line 303 of file eda_base_frame.cpp.

References findQuasiModalDialog(), GetAutoSaveInterval(), isAutoSaveRequired(), m_autoSavePending, m_autoSaveTimer, m_isClosing, m_supportsAutoSave, Pgm(), and traceAutoSave.

Referenced by SYMBOL_VIEWER_FRAME::onSelectNextSymbol(), SYMBOL_VIEWER_FRAME::onSelectPreviousSymbol(), KIWAY::ProcessEvent(), and KIWAY::SetLanguage().

ProjectChanged()

void KICAD_MANAGER_FRAME::ProjectChanged ( )

overridevirtual

Notification event that the project has changed.

Reimplemented from EDA_BASE_FRAME.

Definition at line 1044 of file kicad_manager_frame.cpp.

References _, AskOverrideLock(), ADVANCED_CFG::GetCfg(), LOCKFILE::GetHostname(), GetMajorMinorVersion(), GetProjectFileName(), LOCKFILE::GetUsername(), LOCKFILE::IsLockedByMe(), LOCKFILE::OverrideLock(), Pgm(), KIWAY_HOLDER::Prj(), PROJECT::SetProjectLock(), PROJECT::SetReadOnly(), and LOCKFILE::Valid().

PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST * aItem )

virtualinherited

Add a command to redo in the redo list.

Delete the very old commands when the max count of redo commands is reached.

Definition at line 1694 of file eda_base_frame.cpp.

References ClearUndoORRedoList(), GetRedoCommandCount(), m_redoList, m_undoRedoCountMax, and REDO_LIST.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), and PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList().

PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST * aItem )

virtualinherited

Add a command to undo in the undo list.

Delete the very old commands when the max count of undo commands is reached.

Definition at line 1679 of file eda_base_frame.cpp.

References ClearUndoORRedoList(), GetUndoCommandCount(), m_undoList, m_undoRedoCountMax, and UNDO_LIST.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::PushSymbolToUndoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_EDIT_FRAME::RunActionPlugin(), PL_EDITOR_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and PCB_BASE_EDIT_FRAME::saveCopyInUndoList().

PushTool()

void TOOLS_HOLDER::PushTool ( const TOOL_EVENT & aEvent )

virtualinherited

NB: the definition of "tool" is different at the user level.

The implementation uses a single TOOL_BASE derived class to implement several user "tools", such as rectangle and circle, or wire and bus. So each user-level tool is actually a TOOL_ACTION.

Pushes a tool to the stack.

Parameters

aEvent

The event that is starting the tool to be pushed to the stack.

Definition at line 57 of file tools_holder.cpp.

References DisplayToolMsg(), TOOL_EVENT::getCommandStr(), TOOL_ACTION::GetFriendlyName(), m_toolManager, and m_toolStack.

Referenced by EDIT_TOOL::doMoveSelection(), PCB_VIEWER_TOOLS::MeasureTool(), and EDIT_TOOL::Remove().

ReCreateMenuBar()

void EDA_BASE_FRAME::ReCreateMenuBar ( )

inherited

Recreate the menu bar.

Needed when the language or icons are changed

As of wxWidgets 3.2, recreating the menubar from within an event handler of that menubar will result in memory corruption on macOS. In order to minimize the chance of programmer error causing regressions here, we always wrap calls to ReCreateMenuBar in a CallAfter to ensure that they do not occur within the same event handling call stack.

Definition at line 631 of file eda_base_frame.cpp.

References doReCreateMenuBar(), and m_isClosing.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), ClearFileHistory(), CommonSettingsChanged(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GetFileFromHistory(), HandleSystemColorChange(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), GERBVIEW_FRAME::OnClearDrlFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), GERBVIEW_FRAME::OnClearZipFileHistory(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), ShowChangedLanguage(), SIMULATOR_FRAME::SIMULATOR_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), and UpdateFileHistory().

RecreateToolbars()

void EDA_BASE_FRAME::RecreateToolbars ( )

virtualinherited

Definition at line 526 of file eda_base_frame.cpp.

References config(), dummy, KICAD_AUI_TB_STYLE, LEFT, m_auimgr, m_tbLeft, m_tbRight, m_tbTopAux, m_tbTopMain, m_toolbarSettings, RIGHT, TOP_AUX, and TOP_MAIN.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), KICAD_MANAGER_FRAME::onToolbarSizeChanged(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), GERBVIEW_FRAME::ReFillLayerWidget(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), CVPCB_MAINFRAME::ShowChangedLanguage(), EDA_3D_VIEWER_FRAME::ShowChangedLanguage(), KICAD_MANAGER_FRAME::ShowChangedLanguage(), PCB_BASE_FRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), SIMULATOR_FRAME::SIMULATOR_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

ReCreateTreePrj()

void KICAD_MANAGER_FRAME::ReCreateTreePrj

(

)

Definition at line 526 of file kicad_manager_frame.cpp.

References m_leftWin.

Referenced by ImportNonKiCadProject().

RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 166 of file tools_holder.h.

RefreshProjectTree()

void KICAD_MANAGER_FRAME::RefreshProjectTree

(

)

Definition at line 987 of file kicad_manager_frame.cpp.

References m_leftWin.

RegisterCustomToolbarControlFactory()

void EDA_BASE_FRAME::RegisterCustomToolbarControlFactory ( const ACTION_TOOLBAR_CONTROL & aControlDesc, const ACTION_TOOLBAR_CONTROL_FACTORY & aControlFactory )

inherited

Register a creation factory for toolbar controls that are present in this frame.

The factory function takes a single argument of type ACTION_TOOLBAR*, which is the toolbar to add the controls to.

Parameters

aControlDesc	is the control descriptor
aControlFactory	A functor that creates the custom controls and then adds them to the toolbar

Definition at line 502 of file eda_base_frame.cpp.

References ACTION_TOOLBAR_CONTROL::GetName(), and m_toolbarControlFactories.

Referenced by CVPCB_MAINFRAME::configureToolbars(), EDA_DRAW_FRAME::configureToolbars(), GERBVIEW_FRAME::configureToolbars(), PCB_BASE_EDIT_FRAME::configureToolbars(), PCB_EDIT_FRAME::configureToolbars(), PL_EDITOR_FRAME::configureToolbars(), SCH_EDIT_FRAME::configureToolbars(), SYMBOL_EDIT_FRAME::configureToolbars(), and SYMBOL_VIEWER_FRAME::configureToolbars().

RegisterUIUpdateHandler() [1/2]

void EDA_BASE_FRAME::RegisterUIUpdateHandler ( int aID, const ACTION_CONDITIONS & aConditions )

overridevirtualinherited

Register a UI update handler for the control with ID aID.

Parameters

aID	is the control ID to register the handler for
aConditions	are the UI conditions to use for the control states

Reimplemented from TOOLS_HOLDER.

Definition at line 392 of file eda_base_frame.cpp.

References HandleUpdateUIEvent(), and m_uiUpdateMap.

Referenced by BITMAP2CMP_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), and setupUIConditions().

RegisterUIUpdateHandler() [2/2]

void TOOLS_HOLDER::RegisterUIUpdateHandler ( const TOOL_ACTION & aAction, const ACTION_CONDITIONS & aConditions )

virtualinherited

Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls.

Parameters

aAction	is the action to register.
aConditions	are the UI conditions to use for the control states.

Definition at line 43 of file tools_holder.cpp.

References TOOL_ACTION::GetUIId(), and RegisterUIUpdateHandler().

Referenced by RegisterUIUpdateHandler().

RestoreAuiLayout()

void EDA_BASE_FRAME::RestoreAuiLayout ( )

inherited

Definition at line 1106 of file eda_base_frame.cpp.

References WX_AUI_JSON_SERIALIZER::Deserialize(), ADVANCED_CFG::GetCfg(), m_auiLayoutState, m_auimgr, and m_perspective.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

SaveOpenJobSetsToLocalSettings()

void KICAD_MANAGER_FRAME::SaveOpenJobSetsToLocalSettings

(

bool

aIsExplicitUserSave = false

)

Parameters

aIsExplicitUserSave

is true to indicate the user ran a Save Project action explicitly Note that this parameter should currently always be false, because there is no explicit Save Project action in the project manager. This means that anytime the project manager saves project local settings, it is an implicit save (and should not actually save the file if it was migrated)

Definition at line 678 of file kicad_manager_frame.cpp.

References PROJECT::GetLocalSettings(), jobset, m_notebook, PROJECT_LOCAL_SETTINGS::m_OpenJobSets, KIWAY_HOLDER::Prj(), PROJECT_LOCAL_SETTINGS::SaveToFile(), and PROJECT_LOCAL_SETTINGS::ShouldAutoSave().

Referenced by onNotebookPageCloseRequest(), and OpenJobsFile().

SaveProjectLocalSettings()

virtual void EDA_BASE_FRAME::SaveProjectLocalSettings ( )

inlinevirtualinherited

Save changes to the project local settings.

These settings are used to save/restore the view state for a specific project, and should never contain design data. This method is normally called automatically at various points in the workflow so that the user's most recent display settings are automatically persisted.

The method is virtual so you can override it to call the suitable save method. The base method does nothing.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 384 of file eda_base_frame.h.

saveProjectSettings()

virtual void EDA_BASE_FRAME::saveProjectSettings ( )

inlineprotectedvirtualinherited

Save any design-related project settings associated with this frame.

This method should only be called as the result of direct user action, for example from an explicit "Save Project" command or as a consequence of saving a design document.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 729 of file eda_base_frame.h.

SaveSettings()

void KICAD_MANAGER_FRAME::SaveSettings ( APP_SETTINGS_BASE * aCfg )

overridevirtual

Save common frame parameters to a configuration data file.

Don't forget to call the base class's SaveSettings() from your derived SaveSettings() otherwise the frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 1119 of file kicad_manager_frame.cpp.

References SETTINGS_MANAGER::GetOpenProjects(), EDA_BASE_FRAME::GetSettingsManager(), EDA_BASE_FRAME::m_isClosing, m_leftWin, and EDA_BASE_FRAME::SaveSettings().

Referenced by CreateNewProject(), and LoadProject().

SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings ( WINDOW_SETTINGS * aCfg )

inherited

Save window settings to the given settings object.

Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.

Definition at line 951 of file eda_base_frame.cpp.

References WINDOW_SETTINGS::aui_state, WINDOW_STATE::display, GetWindowSize(), m_auimgr, m_framePos, m_frameSize, m_mruPath, m_normalFramePos, m_normalFrameSize, WINDOW_STATE::maximized, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WX_AUI_JSON_SERIALIZER::Serialize(), WINDOW_STATE::size_x, WINDOW_STATE::size_y, WINDOW_SETTINGS::state, and traceDisplayLocation.

Referenced by SaveSettings().

SchFileName()

const wxString KICAD_MANAGER_FRAME::SchFileName

(

)

Definition at line 490 of file kicad_manager_frame.cpp.

References GetProjectFileName(), and FILEEXT::KiCadSchematicFileExtension.

Referenced by PROJECT_TREE_ITEM::Activate().

SchLegacyFileName()

const wxString KICAD_MANAGER_FRAME::SchLegacyFileName

(

)

Definition at line 499 of file kicad_manager_frame.cpp.

References GetProjectFileName(), and FILEEXT::LegacySchematicFileExtension.

Referenced by PROJECT_TREE_ITEM::Activate().

SelectLeftToolbarAction()

void EDA_BASE_FRAME::SelectLeftToolbarAction ( const TOOL_ACTION & aAction )

inlineinherited

Select the given action in the left toolbar group which contains it, if any.

This updates the displayed icon/tooltip and UI conditions for that group.

Definition at line 207 of file eda_base_frame.h.

References m_tbLeft.

Referenced by BOARD_EDITOR_CONTROL::OnAngleSnapModeChanged(), and FOOTPRINT_EDITOR_CONTROL::OnAngleSnapModeChanged().

SetKiway()

void KIWAY_HOLDER::SetKiway ( wxWindow * aDest, KIWAY * aKiway )

inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters

aDest	is the recipient of aKiway pointer.
aKiway	is often from a parent window or from KIFACE::CreateKiWindow().

Definition at line 43 of file kiway_holder.cpp.

References ignore_unused(), m_kiway, and name.

Referenced by PCB::IFACE::CreateKiWindow(), DIALOG_SHIM::DIALOG_SHIM(), InvokePcbLibTableEditor(), and InvokeSchEditSymbolLibTable().

SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString & aPath )

inlineinherited

Definition at line 437 of file eda_base_frame.h.

References m_mruPath.

Referenced by AskLoadBoardFileName(), EDA_DRAW_FRAME::LibraryFileBrowser(), and KICAD_MANAGER_FRAME::LoadProject().

SetPcmButton()

void KICAD_MANAGER_FRAME::SetPcmButton

(

BITMAP_BUTTON *

aButton

)

Definition at line 1243 of file kicad_manager_frame.cpp.

References m_pcmButton, and updatePcmButtonBadge().

setupActions()

void KICAD_MANAGER_FRAME::setupActions ( )

private

References config(), DoWithAcceptedFiles(), help_name(), kicadSettings(), language_change(), setupActions(), sys_search(), and updatePcmButtonBadge().

Referenced by setupActions().

setupTools()

void KICAD_MANAGER_FRAME::setupTools ( )

private

Definition at line 406 of file kicad_manager_frame.cpp.

References config(), TOOL_DISPATCHER::DispatchWxEvent(), TOOLS_HOLDER::m_actions, TOOLS_HOLDER::m_toolDispatcher, and TOOLS_HOLDER::m_toolManager.

setupUIConditions()

void KICAD_MANAGER_FRAME::setupUIConditions ( )

overrideprotectedvirtual

Setup the UI conditions for the various actions and their controls in this frame.

Reimplemented from EDA_BASE_FRAME.

Definition at line 426 of file kicad_manager_frame.cpp.

References KICAD_MANAGER_ACTIONS::archiveProject, KICAD_MANAGER_ACTIONS::closeProject, ACTIONS::copy, ACTIONS::cut, ENABLE, ACTION_CONDITIONS::Enable(), m_active_project, TOOLS_HOLDER::m_toolManager, KICAD_MANAGER_ACTIONS::newJobsetFile, KICAD_MANAGER_ACTIONS::openJobsetFile, ACTIONS::paste, ACTIONS::saveAs, ACTION_MANAGER::SetConditions(), EDA_BASE_FRAME::setupUIConditions(), and SELECTION_CONDITIONS::ShowNever().

SetUserUnits()

void UNITS_PROVIDER::SetUserUnits ( EDA_UNITS aUnits )

inlineinherited

Definition at line 46 of file units_provider.h.

References m_userUnits.

Referenced by EDA_BASE_FRAME::ChangeUserUnits(), PCB::IFACE::CreateKiWindow(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), IfaceOrAddress(), EDA_DRAW_FRAME::LoadSettings(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), DRC_ENGINE::RunTests(), DRC_TEST_PROVIDER::RunTests(), SaveFileAs(), and EDA_DRAW_FRAME::ToggleUserUnits().

ShowChangedLanguage()

void KICAD_MANAGER_FRAME::ShowChangedLanguage ( )

overridevirtual

Redraw the menus and what not in current language.

Reimplemented from EDA_BASE_FRAME.

Definition at line 1000 of file kicad_manager_frame.cpp.

References EDITORS_CAPTION, EDA_BASE_FRAME::m_auimgr, m_launcher, m_leftWin, m_notebook, PrintPrjInfo(), PROJECT_FILES_CAPTION, EDA_BASE_FRAME::RecreateToolbars(), and EDA_BASE_FRAME::ShowChangedLanguage().

ShowInfoBarError() [1/2]

void EDA_BASE_FRAME::ShowInfoBarError ( const wxString & aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback )

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

The infobar will be closed after a timeout.

This version accepts a callback which will be called when the infobar is dismissed (either as a result of user action or a timeout). This can be useful when the caller wants to make other decorations in the canvas to highlight the error.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.
aCallback	a callback to be called when the infobar is dismissed.

Definition at line 1143 of file eda_base_frame.cpp.

References GetInfoBar(), m_infoBar, and WX_INFOBAR::ShowMessageFor().

ShowInfoBarError() [2/2]

void EDA_BASE_FRAME::ShowInfoBarError ( const wxString & aErrorMsg, bool aShowCloseButton = false, WX_INFOBAR::MESSAGE_TYPE aType = WX_INFOBAR::MESSAGE_TYPE::GENERIC )

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

The infobar will be closed after a timeout.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 1131 of file eda_base_frame.cpp.

References GetInfoBar(), m_infoBar, and WX_INFOBAR::ShowMessageFor().

Referenced by MICROWAVE_TOOL::createInductorBetween(), PCB_BASE_EDIT_FRAME::createNewLibrary(), MICROWAVE_TOOL::createPolygonShape(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), EDIT_TOOL::DeleteItems(), SYMBOL_EDIT_FRAME::ExportSymbol(), PCB_EDIT_FRAME::LoadDrawingSheet(), SCH_EDIT_FRAME::LoadDrawingSheet(), ROUTER_TOOL::prepareInteractive(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), and SYMBOL_EDIT_FRAME::saveLibrary().

ShowInfoBarMsg()

void EDA_BASE_FRAME::ShowInfoBarMsg ( const wxString & aMsg, bool aShowCloseButton = false )

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 1169 of file eda_base_frame.cpp.

References GetInfoBar(), m_infoBar, and WX_INFOBAR::ShowMessageFor().

ShowInfoBarWarning()

void EDA_BASE_FRAME::ShowInfoBarWarning ( const wxString & aWarningMsg, bool aShowCloseButton = false )

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 1158 of file eda_base_frame.cpp.

References GetInfoBar(), m_infoBar, and WX_INFOBAR::ShowMessageFor().

Referenced by SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME().

ShowPreferences()

void EDA_BASE_FRAME::ShowPreferences ( wxString aStartPage, wxString aStartParentPage )

inherited

Display the preferences and settings of all opened editors paged dialog, starting with a particular page.

Definition at line 1266 of file eda_base_frame.cpp.

References _, PANEL_HOTKEYS_EDITOR::ActionsList(), WX_TREEBOOK::AddLazyPage(), WX_TREEBOOK::AddLazySubPage(), KIWAY::CommonSettingsChanged(), KIWAY::FACE_GERBVIEW, KIWAY::FACE_PCB, KIWAY::FACE_PL_EDITOR, KIWAY::FACE_SCH, FRAME_FOOTPRINT_EDITOR, FRAME_GERBER, FRAME_PCB_DISPLAY3D, FRAME_PCB_EDITOR, FRAME_PL_EDITOR, FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, ACTION_MANAGER::GetActions(), ADVANCED_CFG::GetCfg(), GetFrameType(), PGM_BASE::GetSettingsManager(), PAGED_DIALOG::GetTreebook(), HOTKEYS_CHANGED, KICAD_MANAGER_FRAME_NAME, kiface(), KIWAY_HOLDER::Kiway(), LAZY_CTOR, TOOLS_HOLDER::m_toolManager, name, PANEL_3DV_DISPLAY_OPTIONS, PANEL_3DV_OPENGL, PANEL_3DV_RAYTRACING, PANEL_3DV_TOOLBARS, PANEL_DS_COLORS, PANEL_DS_DISPLAY_OPTIONS, PANEL_DS_GRIDS, PANEL_DS_TOOLBARS, PANEL_FP_COLORS, PANEL_FP_DEFAULT_FIELDS, PANEL_FP_DEFAULT_GRAPHICS_VALUES, PANEL_FP_DISPLAY_OPTIONS, PANEL_FP_EDIT_OPTIONS, PANEL_FP_GRIDS, PANEL_FP_ORIGINS_AXES, PANEL_FP_TOOLBARS, PANEL_GBR_COLORS, PANEL_GBR_DISPLAY_OPTIONS, PANEL_GBR_EXCELLON_OPTIONS, PANEL_GBR_GRIDS, PANEL_GBR_TOOLBARS, PANEL_PCB_ACTION_PLUGINS, PANEL_PCB_COLORS, PANEL_PCB_DISPLAY_OPTS, PANEL_PCB_EDIT_OPTIONS, PANEL_PCB_GRIDS, PANEL_PCB_ORIGINS_AXES, PANEL_PCB_TOOLBARS, PANEL_SCH_COLORS, PANEL_SCH_DISP_OPTIONS, PANEL_SCH_EDIT_OPTIONS, PANEL_SCH_FIELD_NAME_TEMPLATES, PANEL_SCH_GRIDS, PANEL_SCH_SIMULATOR, PANEL_SCH_TOOLBARS, PANEL_SYM_COLORS, PANEL_SYM_DISP_OPTIONS, PANEL_SYM_EDIT_GRIDS, PANEL_SYM_EDIT_OPTIONS, PANEL_SYM_TOOLBARS, Pgm(), ReadHotKeyConfigIntoActions(), TOOL_BASE::REDRAW, SETTINGS_MANAGER::Save(), PAGED_DIALOG::SetInitialPage(), and DIALOG_SHIM::ShowModal().

Referenced by OnPreferences().

StringFromOptionalValue()

wxString UNITS_PROVIDER::StringFromOptionalValue ( std::optional< int > aValue, bool aAddUnitLabel = false, EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const

inlineinherited

Converts an optional aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters

aValue	= optional value in internal units
aAddUnitLabel	= true to add symbol unit to the string value
aType	is the type of this value, and controls the way the value is converted to a string, and the suitable unit

Returns

A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 100 of file units_provider.h.

References DISTANCE, GetIuScale(), GetUnitsFromType(), NullUiString, and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by WX_GRID::onCellEditorHidden().

StringFromValue() [1/2]

wxString UNITS_PROVIDER::StringFromValue ( const EDA_ANGLE & aValue, bool aAddUnitLabel = false ) const

inlineinherited

Definition at line 114 of file units_provider.h.

References EDA_ANGLE::AsDegrees(), DEGREES, DISTANCE, EDA_UNIT_UTILS::UI::StringFromValue(), and unityScale.

StringFromValue() [2/2]

wxString UNITS_PROVIDER::StringFromValue ( double aValue, bool aAddUnitLabel = false, EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const

inlineinherited

Converts aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters

aValue	= value in internal units
aAddUnitLabel	= true to add symbol unit to the string value
aType	is the type of this value, and controls the way the value is converted to a string, and the suitable unit

Returns

A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 79 of file units_provider.h.

References DISTANCE, GetIuScale(), GetUnitsFromType(), and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), PAD::doCheckPad(), VALIDATION_ERROR_TOO_LARGE< T >::Format(), VALIDATION_ERROR_TOO_SMALL< T >::Format(), formatBBox(), DRC_TEST_PROVIDER::formatMsg(), DRC_TEST_PROVIDER::formatMsg(), WX_GRID::onCellEditorHidden(), reportMax(), reportMin(), reportOpt(), and PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow().

sys_search()

const SEARCH_STACK & KICAD_MANAGER_FRAME::sys_search ( )

overrideprivatevirtual

Return a SEARCH_STACK pertaining to entire program.

This is overloaded in KICAD_MANAGER_FRAME

Reimplemented from EDA_BASE_FRAME.

Definition at line 532 of file kicad_manager_frame.cpp.

References PgmTop(), and PGM_KICAD::SysSearch().

Referenced by CreateNewProject(), and setupActions().

ThemeChanged()

void EDA_BASE_FRAME::ThemeChanged ( )

virtualinherited

Process light/dark theme change.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 743 of file eda_base_frame.cpp.

References ClearScaledBitmapCache(), and m_auimgr.

Referenced by CommonSettingsChanged(), HandleSystemColorChange(), and PCB_EDIT_FRAME::ThemeChanged().

ToggleUserUnits()

virtual void EDA_BASE_FRAME::ToggleUserUnits ( )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 132 of file eda_base_frame.h.

ToolStackIsEmpty()

bool TOOLS_HOLDER::ToolStackIsEmpty ( )

inlineinherited

Definition at line 125 of file tools_holder.h.

References m_toolStack.

Referenced by PCB_SELECTION_TOOL::Init(), PCB_VIEWER_TOOLS::Init(), and EDITOR_CONDITIONS::noToolFunc().

UnarchiveFiles()

void KICAD_MANAGER_FRAME::UnarchiveFiles

(

)

Definition at line 55 of file kicad/files-io.cpp.

References _, FILEEXT::ArchiveFileExtension, PROJECT::GetProjectFullName(), KIWAY_HOLDER::Kiway(), LoadProject(), EDA_BASE_FRAME::PrintMsg(), KIWAY_HOLDER::Prj(), FILEEXT::ProjectFileExtension, PROJECT_ARCHIVER::Unarchive(), and FILEEXT::ZipFileWildcard().

unitsChangeRefresh()

virtual void EDA_BASE_FRAME::unitsChangeRefresh ( )

inlineprotectedvirtualinherited

Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them.

The default version only updates the status bar. Don't forget to call the default in your derived class or the status bar will not get updated properly.

Reimplemented in EDA_DRAW_FRAME, GERBVIEW_FRAME, PCB_BASE_EDIT_FRAME, PCB_BASE_FRAME, and SCH_EDIT_FRAME.

Definition at line 706 of file eda_base_frame.h.

Referenced by ChangeUserUnits().

UnregisterUIUpdateHandler() [1/2]

void EDA_BASE_FRAME::UnregisterUIUpdateHandler ( int aID )

overridevirtualinherited

Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler.

Parameters

aID	is the control ID to unregister the handler for

Reimplemented from TOOLS_HOLDER.

Definition at line 405 of file eda_base_frame.cpp.

References m_uiUpdateMap.

UnregisterUIUpdateHandler() [2/2]

void TOOLS_HOLDER::UnregisterUIUpdateHandler ( const TOOL_ACTION & aAction )

virtualinherited

Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.

Parameters

aAction

is the action to unregister the handler for.

Definition at line 50 of file tools_holder.cpp.

References TOOL_ACTION::GetUIId(), and UnregisterUIUpdateHandler().

Referenced by UnregisterUIUpdateHandler().

UpdateFileHistory()

void EDA_BASE_FRAME::UpdateFileHistory ( const wxString & FullFileName, FILE_HISTORY * aFileHistory = nullptr )

inherited

Update the list of recently opened files.

The menu is also updated, if FILE_HISTORY::UseMenu was called at init time.

Parameters

FullFileName	The full file name including the path.
aFileHistory	The FILE_HISTORY in use. If NULL, the main application file history is used.

Definition at line 1180 of file eda_base_frame.cpp.

References FILE_HISTORY::AddFileToHistory(), m_fileHistory, m_isClosing, and ReCreateMenuBar().

Referenced by SCH_EDIT_FRAME::doCloseWindow(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), BITMAP2CMP_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SaveSettings(), and GERBVIEW_FRAME::unarchiveFiles().

updatePcmButtonBadge()

void KICAD_MANAGER_FRAME::updatePcmButtonBadge ( )

private

Definition at line 1251 of file kicad_manager_frame.cpp.

References m_pcmButton, and m_pcmUpdateCount.

Referenced by CreatePCM(), SetPcmButton(), and setupActions().

UpdateStatusBar()

virtual void EDA_BASE_FRAME::UpdateStatusBar ( )

inlinevirtualinherited

Update the status bar information.

The status bar can draw itself. This is not a drawing function per se, but rather updates lines of text held by the components within the status bar which is owned by the wxFrame.

Reimplemented in EDA_DRAW_FRAME, FOOTPRINT_CHOOSER_FRAME, GERBVIEW_FRAME, PCB_BASE_FRAME, PL_EDITOR_FRAME, and SCH_BASE_FRAME.

Definition at line 533 of file eda_base_frame.h.

Referenced by TOOL_MANAGER::UpdateUI().

UpdateToolbarControlSizes()

void EDA_BASE_FRAME::UpdateToolbarControlSizes ( )

virtualinherited

Update the sizes of any controls in the toolbars of the frame.

Reimplemented in PL_EDITOR_FRAME.

Definition at line 596 of file eda_base_frame.cpp.

References m_tbLeft, m_tbRight, m_tbTopAux, and m_tbTopMain.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FOOTPRINT_EDIT_FRAME::ReCreateLayerBox(), PCB_EDIT_FRAME::ReCreateLayerBox(), and PL_EDITOR_FRAME::UpdateToolbarControlSizes().

ValueFromString()

int UNITS_PROVIDER::ValueFromString ( const wxString & aTextValue, EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const

inlineinherited

Converts aTextValue in aUnits to internal units used by the frame.

Warning

This utilizes the current locale and will break if decimal formats differ

Parameters

aType	is the type of this value, and controls the way the string is converted to a value
aTextValue	A reference to a wxString object containing the string to convert.

Returns

internal units value

Definition at line 156 of file units_provider.h.

References DISTANCE, EDA_UNIT_UTILS::UI::DoubleValueFromString(), GetIuScale(), GetUnitsFromType(), and KiROUND().

Referenced by PIN_TABLE_DATA_MODEL::compare(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), WX_GRID::GetUnitValue(), and WX_GRID::onCellEditorHidden().

windowClosing()

void EDA_BASE_FRAME::windowClosing ( wxCloseEvent & event )

privateinherited

(with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings().

SaveSettings() is called for all derived wxFrames in this base class overload. Calling it from a destructor is deprecated since the wxFrame's position is not available in the destructor on linux. In other words, you should not need to call SaveSettings() anywhere, except in this one function found only in this class.

Definition at line 233 of file eda_base_frame.cpp.

References canCloseWindow(), config(), doCloseWindow(), findQuasiModalDialog(), IsModal(), m_infoBar, m_isClosing, m_isNonUserClose, and SaveSettings().

Referenced by commonInit(), and ~EDA_BASE_FRAME().

Member Data Documentation

KICAD_AUI_TB_STYLE

int EDA_BASE_FRAME::KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND

staticconstexprprotectedinherited

Default style flags used for wxAUI toolbars.

Definition at line 660 of file eda_base_frame.h.

Referenced by RecreateToolbars().

m_aboutTitle

wxString EDA_BASE_FRAME::m_aboutTitle

protectedinherited

Definition at line 805 of file eda_base_frame.h.

Referenced by BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GetAboutTitle(), GetUntranslatedAboutTitle(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

m_acceptedExts

std::map<const wxString, TOOL_ACTION*> EDA_BASE_FRAME::m_acceptedExts

protectedinherited

Associate file extensions with action to execute.

Definition at line 846 of file eda_base_frame.h.

Referenced by DoWithAcceptedFiles(), GERBVIEW_FRAME::DoWithAcceptedFiles(), KICAD_MANAGER_FRAME::DoWithAcceptedFiles(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), OnDropFiles(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), and SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME().

m_AcceptedFiles

std::vector<wxFileName> EDA_BASE_FRAME::m_AcceptedFiles

protectedinherited

Definition at line 754 of file eda_base_frame.h.

Referenced by DoWithAcceptedFiles(), GERBVIEW_FRAME::DoWithAcceptedFiles(), KICAD_MANAGER_FRAME::DoWithAcceptedFiles(), PL_EDITOR_FRAME::DoWithAcceptedFiles(), and OnDropFiles().

m_actions

ACTIONS* TOOLS_HOLDER::m_actions

protectedinherited

Definition at line 172 of file tools_holder.h.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), CVPCB_MAINFRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), TOOLS_HOLDER(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), and KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME().

m_active_project

bool KICAD_MANAGER_FRAME::m_active_project

private

Definition at line 232 of file kicad_manager_frame.h.

Referenced by CloseProject(), ImportNonKiCadProject(), IsProjectActive(), LoadProject(), and setupUIConditions().

m_appearancePanel

APPEARANCE_CONTROLS_3D* EDA_BASE_FRAME::m_appearancePanel

protectedinherited

Definition at line 811 of file eda_base_frame.h.

Referenced by EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), EDA_3D_VIEWER_FRAME::GetAppearanceManager(), EDA_3D_VIEWER_FRAME::LoadSettings(), EDA_3D_VIEWER_FRAME::OnDarkModeToggle(), EDA_3D_VIEWER_FRAME::ReloadRequest(), EDA_3D_VIEWER_FRAME::SaveSettings(), EDA_3D_VIEWER_FRAME::ShowChangedLanguage(), EDA_3D_VIEWER_FRAME::ToggleAppearanceManager(), EDA_3D_VIEWER_FRAME::TryBefore(), and EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME().

m_auiLayoutState

nlohmann::json EDA_BASE_FRAME::m_auiLayoutState

protectedinherited

Definition at line 809 of file eda_base_frame.h.

Referenced by LoadWindowSettings(), and RestoreAuiLayout().

m_auimgr

wxAuiManager EDA_BASE_FRAME::m_auimgr

protectedinherited

Definition at line 807 of file eda_base_frame.h.

Referenced by SCH_EDIT_FRAME::CaptureHierarchyPaneSize(), commonInit(), CreateInfoBar(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), FinishAUIInitialization(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_BASE_EDIT_FRAME::GetAuiManager(), FOOTPRINT_EDIT_FRAME::IsLibraryTreeShown(), SYMBOL_EDIT_FRAME::IsLibraryTreeShown(), PCB_EDIT_FRAME::IsSearchPaneShown(), SCH_EDIT_FRAME::IsSearchPaneShown(), PCB_EDIT_FRAME::LayerManagerShown(), PCB_EDIT_FRAME::NetInspectorShown(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::onResizeNetNavigator(), FOOTPRINT_VIEWER_FRAME::OnSize(), FOOTPRINT_WIZARD_FRAME::OnSize(), KICAD_MANAGER_FRAME::OnSize(), SYMBOL_VIEWER_FRAME::OnSize(), OnToolbarSizeChanged(), KICAD_MANAGER_FRAME::onToolbarSizeChanged(), PCB_BASE_EDIT_FRAME::OpenVertexEditor(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PCB_EDIT_FRAME::PropertiesShown(), RecreateToolbars(), GERBVIEW_FRAME::ReFillLayerWidget(), CVPCB_MAINFRAME::refreshAfterSymbolSearch(), RestoreAuiLayout(), FOOTPRINT_WIZARD_FRAME::SaveSettings(), PCB_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), SaveWindowSettings(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), PCB_BASE_FRAME::SetDrawBgColor(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::ShowChangedLanguage(), EDA_DRAW_FRAME::ShowChangedLanguage(), FOOTPRINT_EDIT_FRAME::ShowChangedLanguage(), GERBVIEW_FRAME::ShowChangedLanguage(), KICAD_MANAGER_FRAME::ShowChangedLanguage(), PCB_EDIT_FRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), ThemeChanged(), EDA_3D_VIEWER_FRAME::ToggleAppearanceManager(), GERBVIEW_FRAME::ToggleLayerManager(), FOOTPRINT_EDIT_FRAME::ToggleLayersManager(), PCB_EDIT_FRAME::ToggleLayersManager(), FOOTPRINT_EDIT_FRAME::ToggleLibraryTree(), PCB_EDIT_FRAME::ToggleLibraryTree(), SCH_EDIT_FRAME::ToggleLibraryTree(), SYMBOL_EDIT_FRAME::ToggleLibraryTree(), PCB_EDIT_FRAME::ToggleNetInspector(), SCH_EDIT_FRAME::ToggleNetNavigator(), PCB_BASE_EDIT_FRAME::ToggleProperties(), SCH_EDIT_FRAME::ToggleProperties(), SYMBOL_EDIT_FRAME::ToggleProperties(), SCH_EDIT_FRAME::ToggleSchematicHierarchy(), PCB_EDIT_FRAME::ToggleSearch(), SCH_EDIT_FRAME::ToggleSearch(), GERBVIEW_FRAME::updateDCodeSelectBox(), SCH_EDIT_FRAME::updateSelectionFilterVisbility(), SYMBOL_EDIT_FRAME::updateSelectionFilterVisbility(), GERBVIEW_FRAME::UpdateTitleAndInfo(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), and KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME().

m_autoSavePending

bool EDA_BASE_FRAME::m_autoSavePending

protectedinherited

Definition at line 819 of file eda_base_frame.h.

Referenced by commonInit(), EDA_DRAW_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::DoAutoSave(), SCH_EDIT_FRAME::doAutoSave(), and ProcessEvent().

m_autoSavePermissionError

bool EDA_BASE_FRAME::m_autoSavePermissionError

protectedinherited

Definition at line 822 of file eda_base_frame.h.

Referenced by commonInit(), PCB_EDIT_FRAME::DoAutoSave(), and SCH_EDIT_FRAME::doAutoSave().

m_autoSaveRequired

bool EDA_BASE_FRAME::m_autoSaveRequired

protectedinherited

Definition at line 820 of file eda_base_frame.h.

Referenced by commonInit(), PCB_EDIT_FRAME::DoAutoSave(), SCH_EDIT_FRAME::doAutoSave(), isAutoSaveRequired(), OnModify(), PCB_EDIT_FRAME::SaveBoard(), and SCH_EDIT_FRAME::SaveProject().

m_autoSaveTimer

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer

protectedinherited

Definition at line 821 of file eda_base_frame.h.

Referenced by commonInit(), EDA_DRAW_FRAME::CommonSettingsChanged(), onAutoSaveTimer(), ProcessEvent(), and ~EDA_BASE_FRAME().

m_configName

wxString EDA_BASE_FRAME::m_configName

protectedinherited

Definition at line 812 of file eda_base_frame.h.

Referenced by ConfigBaseName(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

m_displayIndex

int EDA_BASE_FRAME::m_displayIndex

protectedinherited

Definition at line 799 of file eda_base_frame.h.

Referenced by commonInit(), LoadWindowState(), and OnSize().

m_dragAction

MOUSE_DRAG_ACTION TOOLS_HOLDER::m_dragAction

protectedinherited

Definition at line 188 of file tools_holder.h.

Referenced by CommonSettingsChanged(), GetDragAction(), and TOOLS_HOLDER().

m_dummySelection

SELECTION TOOLS_HOLDER::m_dummySelection

protectedinherited

Definition at line 175 of file tools_holder.h.

Referenced by GetCurrentSelection().

m_fileHistory

FILE_HISTORY* EDA_BASE_FRAME::m_fileHistory

protectedinherited

Definition at line 817 of file eda_base_frame.h.

Referenced by ClearFileHistory(), commonInit(), CommonSettingsChanged(), GetFileFromHistory(), GetFileHistory(), LoadSettings(), SaveSettings(), UpdateFileHistory(), and ~EDA_BASE_FRAME().

m_FileWatcherInfo

wxString KICAD_MANAGER_FRAME::m_FileWatcherInfo

Definition at line 196 of file kicad_manager_frame.h.

Referenced by OnSize().

m_framePos

wxPoint EDA_BASE_FRAME::m_framePos

protectedinherited

Definition at line 796 of file eda_base_frame.h.

Referenced by BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), LoadWindowState(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SaveWindowSettings().

m_frameSize

wxSize EDA_BASE_FRAME::m_frameSize

protectedinherited

Definition at line 797 of file eda_base_frame.h.

Referenced by BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), commonInit(), SCH_BASE_FRAME::createCanvas(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), LoadWindowState(), EDA_DRAW_FRAME::OnSize(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), and SaveWindowSettings().

m_ident

FRAME_T EDA_BASE_FRAME::m_ident

protectedinherited

Definition at line 795 of file eda_base_frame.h.

Referenced by commonInit(), findQuasiModalDialog(), GetFrameType(), GetWindowSize(), IsType(), LoadWindowState(), and EDA_DRAW_FRAME::saveCanvasTypeSetting().

m_immediateActions

bool TOOLS_HOLDER::m_immediateActions

protectedinherited

Definition at line 184 of file tools_holder.h.

Referenced by CommonSettingsChanged(), GetDoImmediateActions(), and TOOLS_HOLDER().

m_infoBar

WX_INFOBAR* EDA_BASE_FRAME::m_infoBar

protectedinherited

Definition at line 810 of file eda_base_frame.h.

Referenced by SCH_BASE_FRAME::ClearFindReplaceStatus(), commonInit(), CreateInfoBar(), GetInfoBar(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), PCB_EDIT_FRAME::OnBoardLoaded(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::saveAllLibraries(), PL_EDITOR_FRAME::SaveDrawingSheetFile(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::saveSchematicFile(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), SCH_BASE_FRAME::ShowFindReplaceStatus(), ShowInfoBarError(), ShowInfoBarError(), ShowInfoBarMsg(), ShowInfoBarWarning(), SIMULATOR_FRAME::SIMULATOR_FRAME(), and windowClosing().

m_isClosing

bool EDA_BASE_FRAME::m_isClosing

protectedinherited

Set by the close window event handler after frames are asked if they can close.

Allows other functions when called to know our state is cleanup.

Definition at line 838 of file eda_base_frame.h.

Referenced by EDA_DRAW_FRAME::AppendMsgPanel(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), EDA_DRAW_FRAME::ClearMsgPanel(), commonInit(), EDA_DRAW_FRAME::DisplayConstraintsMsg(), EDA_DRAW_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayToolMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), GERBVIEW_FRAME::doCloseWindow(), IsClosing(), FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), SYMBOL_EDIT_FRAME::IsSymbolFromSchematic(), FOOTPRINT_EDIT_FRAME::OnModify(), PCB_BASE_FRAME::OnModify(), PCB_EDIT_FRAME::OnModify(), PL_EDITOR_FRAME::OnModify(), SCH_EDIT_FRAME::OnModify(), SYMBOL_EDIT_FRAME::OnModify(), ProcessEvent(), ReCreateMenuBar(), SaveSettings(), KICAD_MANAGER_FRAME::SaveSettings(), EDA_DRAW_FRAME::SetMsgPanel(), EDA_DRAW_FRAME::SetMsgPanel(), UpdateFileHistory(), EDA_DRAW_FRAME::UpdateProperties(), EDA_DRAW_FRAME::UpdateStatusBar(), and windowClosing().

m_isNonUserClose

bool EDA_BASE_FRAME::m_isNonUserClose

protectedinherited

Set by NonUserClose() to indicate that the user did not request the current close.

Definition at line 841 of file eda_base_frame.h.

Referenced by commonInit(), NonUserClose(), SaveSettings(), and windowClosing().

m_iuScale

const EDA_IU_SCALE& UNITS_PROVIDER::m_iuScale

privateinherited

Definition at line 253 of file units_provider.h.

Referenced by GetIuScale(), and UNITS_PROVIDER().

m_kiway

KIWAY* KIWAY_HOLDER::m_kiway

privateinherited

Definition at line 86 of file kiway_holder.h.

Referenced by HasKiway(), Kiway(), KIWAY_HOLDER(), and SetKiway().

m_lastToolbarIconSize

int KICAD_MANAGER_FRAME::m_lastToolbarIconSize

private

Definition at line 237 of file kicad_manager_frame.h.

Referenced by CommonSettingsChanged().

m_launcher

PANEL_KICAD_LAUNCHER* KICAD_MANAGER_FRAME::m_launcher

private

Definition at line 236 of file kicad_manager_frame.h.

Referenced by ShowChangedLanguage().

m_leftWin

PROJECT_TREE_PANE* KICAD_MANAGER_FRAME::m_leftWin

private

Definition at line 234 of file kicad_manager_frame.h.

Referenced by CloseProject(), CommonSettingsChanged(), doCloseWindow(), GetToolCanvas(), LoadProject(), OnChangeWatchedPaths(), ReCreateTreePrj(), RefreshProjectTree(), SaveSettings(), and ShowChangedLanguage().

m_leftWinWidth

int KICAD_MANAGER_FRAME::m_leftWinWidth

private

Definition at line 231 of file kicad_manager_frame.h.

Referenced by LoadSettings().

m_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault

protectedinherited

Definition at line 798 of file eda_base_frame.h.

Referenced by commonInit(), GERBVIEW_FRAME::GERBVIEW_FRAME(), LoadWindowState(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), and SCH_EDIT_FRAME::SCH_EDIT_FRAME().

m_moveWarpsCursor

bool TOOLS_HOLDER::m_moveWarpsCursor

protectedinherited

Definition at line 190 of file tools_holder.h.

Referenced by CommonSettingsChanged(), GetMoveWarpsCursor(), and TOOLS_HOLDER().

m_mruPath

wxString EDA_BASE_FRAME::m_mruPath

protectedinherited

Definition at line 829 of file eda_base_frame.h.

Referenced by commonInit(), FOOTPRINT_EDIT_FRAME::ExportFootprint(), BITMAP2CMP_FRAME::ExportPcbnewFormat(), SYMBOL_EDIT_FRAME::ExportSymbol(), GetMruPath(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), SYMBOL_EDIT_FRAME::ImportSymbol(), GERBVIEW_FRAME::LoadFileOrShowDialog(), GERBVIEW_FRAME::LoadGerberJobFile(), SCH_EDIT_FRAME::LoadProject(), LoadWindowSettings(), GERBVIEW_FRAME::LoadZipArchiveFile(), SCH_EDIT_FRAME::NewProject(), BITMAP2CMP_FRAME::OnLoadFile(), GERBVIEW_FRAME::OpenProjectFiles(), SaveWindowSettings(), and SetMruPath().

m_normalFramePos

wxPoint EDA_BASE_FRAME::m_normalFramePos

protectedinherited

Definition at line 802 of file eda_base_frame.h.

Referenced by LoadWindowState(), OnMaximize(), and SaveWindowSettings().

m_normalFrameSize

wxSize EDA_BASE_FRAME::m_normalFrameSize

protectedinherited

Definition at line 803 of file eda_base_frame.h.

Referenced by LoadWindowState(), OnMaximize(), and SaveWindowSettings().

m_notebook

wxAuiNotebook* KICAD_MANAGER_FRAME::m_notebook

private

Definition at line 235 of file kicad_manager_frame.h.

Referenced by canCloseWindow(), CloseProject(), HideTabsIfNeeded(), LoadProject(), OpenJobsFile(), SaveOpenJobSetsToLocalSettings(), ShowChangedLanguage(), and ~KICAD_MANAGER_FRAME().

m_openSavedWindows

bool KICAD_MANAGER_FRAME::m_openSavedWindows

private

Definition at line 230 of file kicad_manager_frame.h.

Referenced by CreateNewProject(), LoadProject(), and OnIdle().

m_originTransforms

ORIGIN_TRANSFORMS EDA_BASE_FRAME::m_originTransforms

protectedinherited

Definition at line 831 of file eda_base_frame.h.

Referenced by GetOriginTransforms().

m_pcm

std::shared_ptr<PLUGIN_CONTENT_MANAGER> KICAD_MANAGER_FRAME::m_pcm

private

Definition at line 239 of file kicad_manager_frame.h.

Referenced by CommonSettingsChanged(), CreatePCM(), GetPcm(), OnIdle(), and ~KICAD_MANAGER_FRAME().

m_pcmButton

BITMAP_BUTTON* KICAD_MANAGER_FRAME::m_pcmButton

private

Definition at line 240 of file kicad_manager_frame.h.

Referenced by SetPcmButton(), and updatePcmButtonBadge().

m_pcmUpdateCount

int KICAD_MANAGER_FRAME::m_pcmUpdateCount

private

Definition at line 241 of file kicad_manager_frame.h.

Referenced by CreatePCM(), and updatePcmButtonBadge().

m_perspective

wxString EDA_BASE_FRAME::m_perspective

protectedinherited

Definition at line 808 of file eda_base_frame.h.

Referenced by LoadWindowSettings(), and RestoreAuiLayout().

m_redoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_redoList

protectedinherited

Definition at line 827 of file eda_base_frame.h.

Referenced by PCB_BASE_EDIT_FRAME::ClearUndoORRedoList(), PL_EDITOR_FRAME::ClearUndoORRedoList(), SCH_EDIT_FRAME::ClearUndoORRedoList(), SYMBOL_EDIT_FRAME::ClearUndoORRedoList(), GetRedoActionDescription(), GetRedoCommandCount(), PopCommandFromRedoList(), and PushCommandToRedoList().

m_settingsManager

SETTINGS_MANAGER* EDA_BASE_FRAME::m_settingsManager

protectedinherited

Definition at line 815 of file eda_base_frame.h.

Referenced by commonInit(), and GetSettingsManager().

m_supportsAutoSave

bool EDA_BASE_FRAME::m_supportsAutoSave

protectedinherited

Definition at line 818 of file eda_base_frame.h.

Referenced by commonInit(), EDA_DRAW_FRAME::CommonSettingsChanged(), ProcessEvent(), and SCH_EDIT_FRAME::SCH_EDIT_FRAME().

m_tbLeft

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbLeft

protectedinherited

Definition at line 855 of file eda_base_frame.h.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EDA_BASE_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), OnToolbarSizeChanged(), KICAD_MANAGER_FRAME::onToolbarSizeChanged(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), RecreateToolbars(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SelectLeftToolbarAction(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and UpdateToolbarControlSizes().

m_tbRight

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbRight

protectedinherited

Definition at line 854 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), OnToolbarSizeChanged(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), RecreateToolbars(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and UpdateToolbarControlSizes().

m_tbTopAux

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbTopAux

protectedinherited

Definition at line 853 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), OnToolbarSizeChanged(), PCB_EDIT_FRAME::PrepareLayerIndicator(), PCB_EDIT_FRAME::ReCreateLayerBox(), RecreateToolbars(), and UpdateToolbarControlSizes().

m_tbTopMain

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbTopMain

protectedinherited

Definition at line 852 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::configureToolbars(), SYMBOL_VIEWER_FRAME::configureToolbars(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), EDA_BASE_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), OnToolbarSizeChanged(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), RecreateToolbars(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SIMULATOR_FRAME::SIMULATOR_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), and UpdateToolbarControlSizes().

m_toolbarControlFactories

std::map<std::string, ACTION_TOOLBAR_CONTROL_FACTORY> EDA_BASE_FRAME::m_toolbarControlFactories

protectedinherited

Definition at line 857 of file eda_base_frame.h.

Referenced by GetCustomToolbarControlFactory(), and RegisterCustomToolbarControlFactory().

m_toolbarSettings

TOOLBAR_SETTINGS* EDA_BASE_FRAME::m_toolbarSettings

protectedinherited

Definition at line 849 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), RecreateToolbars(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SIMULATOR_FRAME::SIMULATOR_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

m_toolDispatcher

TOOL_DISPATCHER* TOOLS_HOLDER::m_toolDispatcher

protectedinherited

Definition at line 173 of file tools_holder.h.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GetToolDispatcher(), EDA_BASE_FRAME::OnMenuEvent(), PANEL_PREVIEW_3D_MODEL::OnMenuEvent(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), PCB_TEST_FRAME_BASE::SetBoard(), FOOTPRINT_EDIT_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIMULATOR_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), TOOLS_HOLDER(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME(), and PCB_CALCULATOR_FRAME::~PCB_CALCULATOR_FRAME().

m_toolManager

TOOL_MANAGER* TOOLS_HOLDER::m_toolManager

protectedinherited

Definition at line 171 of file tools_holder.h.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::AddFootprintToBoard(), EDA_BASE_FRAME::AddStandardHelpMenu(), EDA_DRAW_FRAME::AddStandardSubMenus(), SCH_EDIT_FRAME::AnnotateSymbols(), BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), PCB_EDIT_FRAME::CanAcceptApiCommands(), FOOTPRINT_EDIT_FRAME::canCloseWindow(), PCB_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::CheckAnnotate(), GERBVIEW_FRAME::Clear_DrawLayers(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), EDA_DRAW_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), SYMBOL_VIEWER_FRAME::DClickOnSymbolList(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_EDIT_FRAME::DeleteJunction(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), SCH_EDIT_FRAME::DisplayCurrentSheet(), FOOTPRINT_VIEWER_FRAME::displayFootprint(), EDA_DRAW_FRAME::DisplayGridMsg(), CVPCB_MAINFRAME::doCloseWindow(), GERBVIEW_FRAME::doCloseWindow(), SCH_BASE_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::doCloseWindow(), SYMBOL_VIEWER_FRAME::doCloseWindow(), BITMAP2CMP_FRAME::doReCreateMenuBar(), CVPCB_MAINFRAME::doReCreateMenuBar(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_CALCULATOR_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SIMULATOR_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_VIEWER_FRAME::doReCreateMenuBar(), EDA_BASE_FRAME::DoWithAcceptedFiles(), GERBVIEW_FRAME::DoWithAcceptedFiles(), KICAD_MANAGER_FRAME::DoWithAcceptedFiles(), SCH_EDIT_FRAME::EditSheetProperties(), SYMBOL_EDIT_FRAME::emptyScreen(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetCurrentSelection(), FOOTPRINT_EDIT_FRAME::GetCurrentSelection(), FOOTPRINT_VIEWER_FRAME::GetCurrentSelection(), GERBVIEW_FRAME::GetCurrentSelection(), PCB_EDIT_FRAME::GetCurrentSelection(), PL_EDITOR_FRAME::GetCurrentSelection(), SCH_EDIT_FRAME::GetCurrentSelection(), SYMBOL_EDIT_FRAME::GetCurrentSelection(), SYMBOL_VIEWER_FRAME::GetCurrentSelection(), SCH_BASE_FRAME::GetSelectionTool(), GetToolManager(), EDA_DRAW_FRAME::GetUnitPair(), PL_EDITOR_FRAME::HardRedraw(), SCH_EDIT_FRAME::HardRedraw(), SYMBOL_EDIT_FRAME::HardRedraw(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::initScreenZoom(), PCB_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), FOOTPRINT_EDIT_FRAME::MakeGridHelper(), PCB_EDIT_FRAME::MakeGridHelper(), SCH_EDIT_FRAME::MakeGridHelper(), SYMBOL_EDIT_FRAME::MakeGridHelper(), PCB_EDIT_FRAME::OnBoardLoaded(), PCB_EDIT_FRAME::onCloseModelessBookReporterDialogs(), SCH_EDIT_FRAME::onCloseSymbolDiffDialog(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_BASE_FRAME::OnFindDialogClose(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), SCH_EDIT_FRAME::OnImportProject(), PCB_EDIT_FRAME::OnNetlistChanged(), PL_EDITOR_FRAME::OnNewDrawingSheet(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), EDA_DRAW_FRAME::OnSelectGrid(), EDA_DRAW_FRAME::OnSelectZoom(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), PopTool(), PushTool(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::RebuildAndRefresh(), SYMBOL_EDIT_FRAME::RebuildView(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_BASE_FRAME::RefreshZoomDependentItems(), FOOTPRINT_WIZARD_FRAME::RegenerateFootprint(), DISPLAY_FOOTPRINTS_FRAME::ReloadFootprint(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SYMBOL_EDIT_FRAME::saveLibrary(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), EDA_DRAW_FRAME::SaveSettings(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_BASE_FRAME::SCH_BASE_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_EDIT_FRAME::SelectBodyStyle(), SCH_EDIT_FRAME::SelectUnit(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), GERBVIEW_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), SCH_EDIT_FRAME::SetAltPinFunction(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_TEST_FRAME_BASE::SetBoard(), SYMBOL_EDIT_FRAME::SetBodyStyle(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SCH_EDIT_FRAME::SetSchematic(), SCH_EDIT_FRAME::SetScreen(), SYMBOL_EDIT_FRAME::SetScreen(), PCB_TEST_FRAME_BASE::SetSelectionHook(), SYMBOL_EDIT_FRAME::SetUnit(), CVPCB_MAINFRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIMULATOR_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupUIConditions(), DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::setupUIConditions(), FOOTPRINT_CHOOSER_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), FOOTPRINT_VIEWER_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), KICAD_MANAGER_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SIMULATOR_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowFindDialog(), SCH_BASE_FRAME::ShowFindReplaceDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), EDA_BASE_FRAME::ShowPreferences(), PCB_BASE_EDIT_FRAME::ShowReferenceImagePropertiesDialog(), SIMULATOR_FRAME::SIMULATOR_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SCH_BASE_FRAME::SyncView(), EDA_DRAW_FRAME::ToggleUserUnits(), TOOLS_HOLDER(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), SCH_EDIT_FRAME::TrimWire(), EDA_DRAW_FRAME::unitsChangeRefresh(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), SCH_EDIT_FRAME::UpdateHierarchyNavigator(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), FOOTPRINT_EDIT_FRAME::UpdateView(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), EDA_DRAW_FRAME::Zoom_Automatique(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), FOOTPRINT_EDIT_FRAME::~FOOTPRINT_EDIT_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME(), PCB_CALCULATOR_FRAME::~PCB_CALCULATOR_FRAME(), PCB_EDIT_FRAME::~PCB_EDIT_FRAME(), PL_EDITOR_FRAME::~PL_EDITOR_FRAME(), SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::~SYMBOL_VIEWER_FRAME().

m_toolStack

std::vector<std::string> TOOLS_HOLDER::m_toolStack

protectedinherited

Definition at line 177 of file tools_holder.h.

Referenced by CurrentToolName(), IsCurrentTool(), PopTool(), PushTool(), and ToolStackIsEmpty().

m_type

HOLDER_TYPE KIWAY_HOLDER::m_type

privateinherited

Definition at line 87 of file kiway_holder.h.

Referenced by GetType(), and KIWAY_HOLDER().

m_uiUpdateMap

std::map<int, UIUpdateHandler> EDA_BASE_FRAME::m_uiUpdateMap

protectedinherited

Map containing the UI update handlers registered with wx for each action.

Definition at line 834 of file eda_base_frame.h.

Referenced by RegisterUIUpdateHandler(), and UnregisterUIUpdateHandler().

m_undoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_undoList

protectedinherited

Definition at line 826 of file eda_base_frame.h.

Referenced by PCB_BASE_EDIT_FRAME::ClearUndoORRedoList(), PL_EDITOR_FRAME::ClearUndoORRedoList(), SCH_EDIT_FRAME::ClearUndoORRedoList(), SYMBOL_EDIT_FRAME::ClearUndoORRedoList(), GetUndoActionDescription(), GetUndoCommandCount(), PopCommandFromUndoList(), PushCommandToUndoList(), and SCH_EDIT_FRAME::RecalculateConnections().

m_undoRedoCountMax

int EDA_BASE_FRAME::m_undoRedoCountMax

protectedinherited

Definition at line 824 of file eda_base_frame.h.

Referenced by commonInit(), GetMaxUndoItems(), PushCommandToRedoList(), and PushCommandToUndoList().

m_updateManager

std::unique_ptr<UPDATE_MANAGER> KICAD_MANAGER_FRAME::m_updateManager

private

Definition at line 242 of file kicad_manager_frame.h.

Referenced by OnIdle().

m_userUnits

EDA_UNITS UNITS_PROVIDER::m_userUnits

privateinherited

Definition at line 254 of file units_provider.h.

Referenced by GetUserUnits(), SetUserUnits(), and UNITS_PROVIDER().

NullUiString

const wxString UNITS_PROVIDER::NullUiString = ""

inlinestaticinherited

The string that is used in the UI to represent a null value.

Definition at line 250 of file units_provider.h.

Referenced by WX_GRID::GetOptionalUnitValue(), WX_GRID::onCellEditorHidden(), OptionalValueFromString(), and StringFromOptionalValue().

---

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

• kicad_manager_frame.h
• kicad/files-io.cpp
• import_project.cpp
• kicad_manager_frame.cpp
• kicad/menubar.cpp
• project_tree_pane.cpp