The SIMULATOR_FRAME holds the main user-interface for running simulations. More...

#include <simulator_frame.h>

Inheritance diagram for SIMULATOR_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
	SIMULATOR_FRAME (KIWAY aKiway, wxWindow aParent)

	~SIMULATOR_FRAME ()

bool	LoadSimulator (const wxString &aSimCommand, unsigned aSimOptions)
	Check and load the current netlist into the simulator.

void	ReloadSimulator (const wxString &aSimCommand, unsigned aSimOptions)
	Re-send the current command and settings to the simulator.

void	StartSimulation ()

SIM_TAB *	NewSimTab (const wxString &aSimCommand)
	Create a new plot tab for a given simulation type.

bool	EditAnalysis ()
	Shows a dialog for editing the current tab's simulation command, or creating a new tab with a different simulation command type.

const std::vector< wxString >	SimPlotVectors ()

const std::vector< wxString >	Signals ()

const std::map< int, wxString > &	UserDefinedSignals ()

void	SetUserDefinedSignals (const std::map< int, wxString > &aSignals)

void	AddVoltageTrace (const wxString &aNetName)
	Add a voltage trace for a given net to the current plot.

void	AddCurrentTrace (const wxString &aDeviceName)
	Add a current trace for a given device to the current plot.

void	AddTuner (const SCH_SHEET_PATH &aSheetPath, SCH_SYMBOL *aSymbol)
	Add a tuner for a symbol.

SIM_TAB *	GetCurrentSimTab () const
	Return the current tab (or NULL if there is none).

void	ToggleSimConsole ()

void	ToggleSimSidePanel ()

void	ToggleDarkModePlots ()
	Toggle dark-mode of the plot tabs.

void	ShowChangedLanguage () override
	Redraw the menus and what not in current language.

bool	LoadWorkbook (const wxString &aPath)
	Load plot, signal, cursor, measurement, etc.

bool	SaveWorkbook (const wxString &aPath)
	Save plot, signal, cursor, measurement, etc.

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	CommonSettingsChanged (int aFlags) override
	Notification event that some of the common (suite-wide) settings have changed.

WINDOW_SETTINGS *	GetWindowSettings (APP_SETTINGS_BASE *aCfg) override
	Return a pointer to the window settings for this frame.

SCH_EDIT_FRAME *	GetSchematicFrame () const

std::shared_ptr< SPICE_CIRCUIT_MODEL >	GetCircuitModel () const

std::shared_ptr< SPICE_SIMULATOR >	GetSimulator () const

wxString	GetCurrentSimCommand () const

SIM_TYPE	GetCurrentSimType () const

int	GetCurrentOptions () const

bool	SimFinished () const

wxWindow *	GetToolCanvas () const override
	Canvas access.

void	UpdateTitle ()
	Set the main window title bar text.

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

virtual bool	OpenProjectFiles (const std::vector< wxString > &aFileList, int aCtl=0)
	Open a project or set of files given by aFileList.

virtual bool	ShowModal (wxString aResult=nullptr, wxWindow aResultantFocusWindow=nullptr)
	Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal().

virtual void	KiwayMailIn (KIWAY_EXPRESS &aEvent)
	Receive KIWAY_EXPRESS messages from other players.

bool	Destroy () override
	Our version of Destroy() which is virtual from wxWidgets.

bool	IsModal () const override
	Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame.

void	SetModal (bool aIsModal)

bool	IsDismissed ()

void	DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)

void	CreateServer (int service, bool local=true)

void	OnSockRequest (wxSocketEvent &evt)

void	OnSockRequestServer (wxSocketEvent &evt)

virtual void	ExecuteRemoteCommand (const char *cmdline)
	Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242).

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)

virtual void	OnSize (wxSizeEvent &aEvent)

void	OnMaximize (wxMaximizeEvent &aEvent)

int	GetAutoSaveInterval () const

bool	IsType (FRAME_T aType) const

FRAME_T	GetFrameType () const

virtual const SEARCH_STACK &	sys_search ()
	Return a SEARCH_STACK pertaining to entire program.

virtual wxString	help_name ()

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	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.

virtual APP_SETTINGS_BASE *	config () const
	Return the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.

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.

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 wxString	GetCurrentFileName () const
	Get the full filename + path of the currently opened file in the frame.

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.

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.

virtual void	ProjectChanged ()
	Notification event that the project has changed.

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

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.

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

Protected Member Functions
void	kiway_express (KIWAY_EXPRESS &aEvent)
	Event handler, routes to derivative specific virtual KiwayMailIn().

void	language_change (wxCommandEvent &event)
	An event handler called on a language menu selection.

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.

virtual void	DoWithAcceptedFiles ()
	Execute action on accepted dropped file.

Protected Attributes
bool	m_modal

wxGUIEventLoop *	m_modal_loop
	Points to nested event_loop. NULL means not modal and dismissed.

wxWindow *	m_modal_resultant_parent

wxString	m_modal_string

bool	m_modal_ret_val

wxSocketServer *	m_socketServer

std::vector< wxSocketBase * >	m_sockets

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

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	doReCreateMenuBar () override

void	setupUIConditions () override
	Setup the UI conditions for the various actions and their controls in this frame.

void	showNetlistErrors (const WX_STRING_REPORTER &aReporter)

bool	canCloseWindow (wxCloseEvent &aEvent) override

void	doCloseWindow () override

void	onUpdateSim (wxCommandEvent &aEvent)

void	onSimReport (wxCommandEvent &aEvent)

void	onSimStarted (wxCommandEvent &aEvent)

void	onSimFinished (wxCommandEvent &aEvent)

void	onExit (wxCommandEvent &event)

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

Private Attributes
SCH_EDIT_FRAME *	m_schematicFrame

ACTION_TOOLBAR *	m_toolBar

SIMULATOR_FRAME_UI *	m_ui

std::shared_ptr< SPICE_SIMULATOR >	m_simulator

SIM_THREAD_REPORTER *	m_reporter

std::shared_ptr< SPICE_CIRCUIT_MODEL >	m_circuitModel

bool	m_simFinished

bool	m_workbookModified

KIWAY *	m_kiway

HOLDER_TYPE	m_type

const EDA_IU_SCALE &	m_iuScale

EDA_UNITS	m_userUnits

Detailed Description

The SIMULATOR_FRAME holds the main user-interface for running simulations.

It contains a workbook with multiple tabs, each tab holding a SIM_PLOT_TAB, a specific simulation command (.TRAN, .AC, etc.), and simulation settings (save all currents, etc.).

Each plot can have multiple TRACEs. While internally each TRACE can have multiple cursors, the GUI supports only two cursors (and a differential cursor) for each plot.

TRACEs are identified by a signal (V(OUT), I(R2), etc.) and a type (SPT_VOLTAGE, SPT_AC_PHASE, etc.).

The simulator outputs simple signals in a vector of the same name. Complex signals (such as V(OUT) / V(IN)) are stored in vectors of the format "user%d".

Definition at line 83 of file simulator_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 116 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ SIMULATOR_FRAME()

SIMULATOR_FRAME::SIMULATOR_FRAME	(	KIWAY *	aKiway,
		wxWindow *	aParent )

Definition at line 116 of file simulator_frame.cpp.

References _, config, EDA_BASE_FRAME::configureToolbars(), SIMULATOR::CreateInstance(), FRAME_SCH, FRAME_SIMULATOR, PROJECT::GetProjectFile(), GetToolbarSettings(), KiBitmap(), Kiway, KIWAY_PLAYER::KIWAY_PLAYER(), LoadSettings(), LT_PSPICE, m_circuitModel, EDA_BASE_FRAME::m_infoBar, SCHEMATIC_SETTINGS::m_NgspiceSettings, m_reporter, m_schematicFrame, PROJECT_FILE::m_SchematicSettings, m_simFinished, m_simulator, EDA_BASE_FRAME::m_tbTopMain, m_toolBar, EDA_BASE_FRAME::m_toolbarSettings, TOOLS_HOLDER::m_toolManager, m_ui, m_workbookModified, onExit(), onSimFinished(), onSimReport(), onSimStarted(), onUpdateSim(), Prj(), EDA_BASE_FRAME::ReCreateMenuBar(), EDA_BASE_FRAME::RecreateToolbars(), setupTools(), setupUIConditions(), simulator, SIMULATOR_FRAME(), unityScale, and UpdateTitle().

Referenced by SIMULATOR_FRAME().

◆ ~SIMULATOR_FRAME()

SIMULATOR_FRAME::~SIMULATOR_FRAME ( )

Definition at line 204 of file simulator_frame.cpp.

References m_reporter, and m_simulator.

Member Function Documentation

◆ AddCurrentTrace()

void SIMULATOR_FRAME::AddCurrentTrace ( const wxString & aDeviceName )

Add a current trace for a given device to the current plot.

Parameters

aDeviceName	is the device name (e.g. R1, C1).
aParam	is the current type (e.g. I, Ic, Id).

Definition at line 523 of file simulator_frame.cpp.

References m_ui, and SPT_CURRENT.

Referenced by SCH_EDITOR_CONTROL::SimProbe().

◆ 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 1785 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 645 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().

◆ AddTuner()

void SIMULATOR_FRAME::AddTuner	(	const SCH_SHEET_PATH &	aSheetPath,
		SCH_SYMBOL *	aSymbol )

Add a tuner for a symbol.

Definition at line 529 of file simulator_frame.cpp.

References m_ui.

◆ AddVoltageTrace()

void SIMULATOR_FRAME::AddVoltageTrace ( const wxString & aNetName )

Add a voltage trace for a given net to the current plot.

Parameters

aNetName is the net name for which a voltage plot should be created.

Definition at line 517 of file simulator_frame.cpp.

References m_ui, and SPT_VOLTAGE.

Referenced by SCH_EDITOR_CONTROL::SimProbe().

◆ AngleValueFromString()

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

inlineinherited

Definition at line 186 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 640 of file eda_base_frame.h.

Referenced by PCB_EDIT_FRAME::CanAcceptApiCommands().

◆ canCloseWindow()

bool SIMULATOR_FRAME::canCloseWindow ( wxCloseEvent & aEvent )

overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 626 of file simulator_frame.cpp.

References _, HandleUnsavedChanges(), m_simulator, m_workbookModified, KIWAY_HOLDER::Prj(), and SaveWorkbook().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1673 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 1516 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 1166 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 573 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 1600 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().

◆ commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T aFrameType )

privateinherited

Collect common initialization functions used in all CTORs.

Definition at line 134 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 SIMULATOR_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 271 of file simulator_frame.cpp.

References EDA_BASE_FRAME::CommonSettingsChanged(), GetAppSettings(), and m_ui.

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const

virtualinherited

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

Reimplemented in FOOTPRINT_EDIT_FRAME, KICAD_MANAGER_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 1006 of file eda_base_frame.cpp.

References Kiface(), and KIFACE_BASE::KifaceSettings().

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), EDA_DRAW_FRAME::AddApiPluginTools(), PCB_CONTROL::AppendBoard(), PCB_CONTROL::AppendDesignBlock(), AskLoadBoardFileName(), EDA_DRAW_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), SIMULATOR_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), PCB_VIEWER_TOOLS::FootprintAutoZoom(), PCB_EDITOR_CONDITIONS::footprintViewerAutoZoom(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GERBVIEW_FRAME::gvconfig(), EDA_DRAW_FRAME::IsGridOverridden(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), PCB_CALCULATOR_FRAME::loadPages(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), GERBVIEW_FRAME::Read_EXCELLON_File(), RecreateToolbars(), SaveSettings(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetDisplayOptions(), EDA_DRAW_FRAME::SetGridOverrides(), EDA_DRAW_FRAME::SetGridVisibility(), SCH_EDIT_FRAME::SetSchematic(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIMULATOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), BITMAP2CMP_FRAME::ShowChangedLanguage(), PCB_CALCULATOR_FRAME::ShowChangedLanguage(), EDA_DRAW_FRAME::UpdateGridSelectBox(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), windowClosing(), and BITMAP2CMP_FRAME::~BITMAP2CMP_FRAME().

◆ 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 353 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 518 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 1031 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().

◆ CreateServer()

void KIWAY_PLAYER::CreateServer	(	int	service,
		bool	local = true )

inherited

Definition at line 43 of file eda_dde.cpp.

References HOSTNAME(), ID_EDA_SOCKET_EVENT_SERV, and m_socketServer.

Referenced by SCH::IFACE::CreateKiWindow().

◆ 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 1566 of file eda_base_frame.cpp.

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

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

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

Our version of Destroy() which is virtual from wxWidgets.

Definition at line 150 of file kiway_player.cpp.

References EDA_BASE_FRAME::GetFrameType(), KIWAY_HOLDER::Kiway(), and KIWAY::PlayerDidClose().

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), GERBVIEW_FRAME::doCloseWindow(), PL_EDITOR_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), SIMULATOR_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::doCloseWindow(), SYMBOL_VIEWER_FRAME::doCloseWindow(), IfaceOrAddress(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ DismissModal()

void KIWAY_PLAYER::DismissModal	(	bool	aRetVal,
		const wxString &	aResult = wxEmptyString )

inherited

Definition at line 164 of file kiway_player.cpp.

References m_modal_loop, m_modal_ret_val, and m_modal_string.

Referenced by FOOTPRINT_CHOOSER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SYMBOL_CHOOSER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), FOOTPRINT_CHOOSER_FRAME::OnOK(), SYMBOL_CHOOSER_FRAME::OnOK(), and SYMBOL_CHOOSER_FRAME::SYMBOL_CHOOSER_FRAME().

◆ 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 364 of file eda_base_frame.cpp.

Referenced by onAutoSaveTimer().

◆ doCloseWindow()

void SIMULATOR_FRAME::doCloseWindow ( )

overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 651 of file simulator_frame.cpp.

References ACTIONS::cancelInteractive, EDA_BASE_FRAME::config(), KIWAY_PLAYER::Destroy(), m_schematicFrame, m_simulator, and SaveSettings().

◆ doReCreateMenuBar()

void SIMULATOR_FRAME::doReCreateMenuBar ( )

overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 80 of file toolbars_simulator_frame.cpp.

References _, ACTION_MENU::Add(), ACTION_MENU::AddClose(), EDA_BASE_FRAME::AddMenuLanguageList(), ACTION_MENU::CHECK, EDA_BASE_FRAME::EDA_BASE_FRAME(), SCH_ACTIONS::editUserDefinedSignals, SCH_ACTIONS::exportPlotAsCSV, SCH_ACTIONS::exportPlotAsPNG, SCH_ACTIONS::exportPlotToClipboard, SCH_ACTIONS::exportPlotToSchematic, TOOLS_HOLDER::m_toolManager, SCH_ACTIONS::newAnalysisTab, ACTIONS::openPreferences, SCH_ACTIONS::openWorkbook, SCH_ACTIONS::runSimulation, SCH_ACTIONS::saveWorkbook, SCH_ACTIONS::saveWorkbookAs, SCH_ACTIONS::showNetlist, SCH_ACTIONS::simAnalysisProperties, SCH_ACTIONS::simProbe, SCH_ACTIONS::simTune, SCH_ACTIONS::toggleDarkModePlots, SCH_ACTIONS::toggleDottedSecondary, ACTIONS::toggleGrid, SCH_ACTIONS::toggleLegend, SCH_ACTIONS::toggleSimConsole, SCH_ACTIONS::toggleSimSidePanel, ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomInHorizontally, ACTIONS::zoomInVertically, ACTIONS::zoomOutCenter, ACTIONS::zoomOutHorizontally, ACTIONS::zoomOutVertically, ACTIONS::zoomRedo, and ACTIONS::zoomUndo.

◆ DoWithAcceptedFiles()

void EDA_BASE_FRAME::DoWithAcceptedFiles ( )

protectedvirtualinherited

Execute action on accepted dropped file.

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

Reimplemented in GERBVIEW_FRAME, KICAD_MANAGER_FRAME, and PL_EDITOR_FRAME.

Definition at line 1463 of file eda_base_frame.cpp.

References m_acceptedExts, m_AcceptedFiles, and TOOLS_HOLDER::m_toolManager.

Referenced by OnDropFiles().

◆ EditAnalysis()

bool SIMULATOR_FRAME::EditAnalysis ( )

Shows a dialog for editing the current tab's simulation command, or creating a new tab with a different simulation command type.

Definition at line 594 of file simulator_frame.cpp.

References DIALOG_SIM_COMMAND::ApplySettings(), DIALOG_SIM_COMMAND::GetSimCommand(), SIM_TAB::GetSimCommand(), SIM_TAB::GetSimOptions(), m_circuitModel, m_simulator, m_ui, OnModify(), NETLIST_EXPORTER_SPICE::OPTION_DEFAULT_FLAGS, s_reporter, DIALOG_SIM_COMMAND::SetPlotSettings(), DIALOG_SIM_COMMAND::SetSimCommand(), SIM_TAB::SetSimCommand(), DIALOG_SIM_COMMAND::SetSimOptions(), DIALOG_SHIM::ShowModal(), and showNetlistErrors().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 855 of file eda_base_frame.cpp.

References GetWindowSize(), and traceDisplayLocation.

Referenced by OnSize().

◆ ExecuteRemoteCommand()

virtual void KIWAY_PLAYER::ExecuteRemoteCommand ( const char * cmdline )

inlinevirtualinherited

Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242).

Subclasses should override to implement actual command handlers.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 177 of file kiway_player.h.

Referenced by OnSockRequest().

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

privateinherited

Definition at line 211 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 1043 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 540 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 344 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().

◆ GetCircuitModel()

std::shared_ptr< SPICE_CIRCUIT_MODEL > SIMULATOR_FRAME::GetCircuitModel ( ) const

inline

Definition at line 185 of file simulator_frame.h.

References m_circuitModel.

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const

inlinevirtualinherited

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 in KICAD_MANAGER_FRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, and SCH_EDIT_FRAME.

Definition at line 434 of file eda_base_frame.h.

Referenced by SaveSettings().

◆ GetCurrentOptions()

int SIMULATOR_FRAME::GetCurrentOptions ( ) const

Definition at line 305 of file simulator_frame.cpp.

References m_ui, and NETLIST_EXPORTER_SPICE::OPTION_DEFAULT_FLAGS.

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

◆ GetCurrentSimCommand()

wxString SIMULATOR_FRAME::GetCurrentSimCommand ( ) const

Definition at line 290 of file simulator_frame.cpp.

References m_circuitModel, and m_ui.

Referenced by GetCurrentSimType().

◆ GetCurrentSimTab()

SIM_TAB * SIMULATOR_FRAME::GetCurrentSimTab ( ) const

Return the current tab (or NULL if there is none).

Definition at line 535 of file simulator_frame.cpp.

References m_ui.

Referenced by setupUIConditions().

◆ GetCurrentSimType()

SIM_TYPE SIMULATOR_FRAME::GetCurrentSimType ( ) const

Definition at line 299 of file simulator_frame.cpp.

References SPICE_CIRCUIT_MODEL::CommandToSimType(), and GetCurrentSimCommand().

◆ GetCustomToolbarControlFactory()

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

inherited

Definition at line 506 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 1126 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 418 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 206 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 236 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(), MessageTextFromMinOptMax(), MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), OptionalValueFromString(), StringFromOptionalValue(), StringFromValue(), GRID::UserUnitsMessageText(), and ValueFromString().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 613 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 425 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 135 of file eda_base_frame.h.

References m_originTransforms.

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

◆ GetRedoActionDescription()

wxString EDA_BASE_FRAME::GetRedoActionDescription ( ) const

virtualinherited

Reimplemented in CVPCB_MAINFRAME.

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

◆ GetSchematicFrame()

SCH_EDIT_FRAME * SIMULATOR_FRAME::GetSchematicFrame ( ) const

inline

Definition at line 183 of file simulator_frame.h.

References m_schematicFrame.

◆ GetSettingsManager()

SETTINGS_MANAGER * EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

Definition at line 141 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 143 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

◆ GetSimulator()

std::shared_ptr< SPICE_SIMULATOR > SIMULATOR_FRAME::GetSimulator ( ) const

inline

Definition at line 187 of file simulator_frame.h.

References m_simulator.

◆ GetToolCanvas()

wxWindow * SIMULATOR_FRAME::GetToolCanvas ( ) const

inlineoverridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 196 of file simulator_frame.h.

◆ 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.

◆ 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 219 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 1649 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 607 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 197 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 542 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 * SIMULATOR_FRAME::GetWindowSettings ( APP_SETTINGS_BASE * aCfg )

overridevirtual

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 from EDA_BASE_FRAME.

Definition at line 280 of file simulator_frame.cpp.

References GetAppSettings(), and APP_SETTINGS_BASE::m_Window.

◆ 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 1709 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 661 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 1733 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 413 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 EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 1019 of file eda_base_frame.cpp.

References KIFACE_BASE::GetHelpFileName(), and Kiface().

◆ 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...

◆ 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 1591 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 669 of file eda_base_frame.h.

References m_autoSaveRequired.

Referenced by ProcessEvent().

◆ IsClosing()

bool EDA_BASE_FRAME::IsClosing ( ) const

inlineinherited

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

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )

inherited

Returns: false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). True if the dialog is not modal or if it is modal and has been dismissed.

Definition at line 158 of file kiway_player.cpp.

References m_modal_loop.

Referenced by FOOTPRINT_CHOOSER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), and SYMBOL_CHOOSER_FRAME::doCloseWindow().

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const

inlineoverridevirtualinherited

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 from EDA_BASE_FRAME.

Definition at line 154 of file kiway_player.h.

References m_modal.

Referenced by FOOTPRINT_WIZARD_FRAME::doCloseWindow(), and ShowModal().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inlineinherited

Definition at line 205 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(), PCB_EDITOR_CONDITIONS::get45degModeFunc(), 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 1473 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().

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

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS & aEvent )

protectedinherited

Event handler, routes to derivative specific virtual KiwayMailIn().

Definition at line 179 of file kiway_player.cpp.

References KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS & aEvent )

virtualinherited

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

Reimplemented in CVPCB_MAINFRAME, FOOTPRINT_CHOOSER_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, PCB_EDIT_FRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 89 of file kiway_player.cpp.

Referenced by kiway_express(), and KIWAY::ProcessEvent().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent & event )

protectedinherited

An event handler called on a language menu selection.

Definition at line 186 of file kiway_player.cpp.

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

◆ LoadSettings()

void SIMULATOR_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 243 of file simulator_frame.cpp.

References PROJECT::GetProjectFile(), EDA_BASE_FRAME::LoadSettings(), SCHEMATIC_SETTINGS::m_NgspiceSettings, PROJECT_FILE::m_SchematicSettings, m_simulator, m_ui, and KIWAY_HOLDER::Prj().

Referenced by SIMULATOR_FRAME().

◆ LoadSimulator()

bool SIMULATOR_FRAME::LoadSimulator	(	const wxString &	aSimCommand,
		unsigned	aSimOptions )

Check and load the current netlist into the simulator.

Returns: true if document is fully annotated and netlist was loaded successfully.

Definition at line 374 of file simulator_frame.cpp.

References _, ADVANCED_CFG::GetCfg(), GLOBAL_CLEANUP, m_circuitModel, m_schematicFrame, m_simulator, KIWAY_HOLDER::Prj(), s_reporter, and showNetlistErrors().

Referenced by StartSimulation().

◆ 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 908 of file eda_base_frame.cpp.

References TOOLS_HOLDER::CommonSettingsChanged(), LoadWindowState(), 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 759 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 745 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().

◆ LoadWorkbook()

bool SIMULATOR_FRAME::LoadWorkbook ( const wxString & aPath )

Load plot, signal, cursor, measurement, etc.

settings from a file.

Definition at line 541 of file simulator_frame.cpp.

References _, DisplayErrorMessage(), m_ui, m_workbookModified, and UpdateTitle().

◆ MessageTextFromMinOptMax()

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

inlineinherited

Definition at line 137 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 130 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 123 of file units_provider.h.

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

◆ NewSimTab()

SIM_TAB * SIMULATOR_FRAME::NewSimTab ( const wxString & aSimCommand )

Create a new plot tab for a given simulation type.

Parameters

aSimCommand is requested simulation command.

Definition at line 487 of file simulator_frame.cpp.

References m_ui.

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce )

inlineinherited

Definition at line 623 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 350 of file eda_base_frame.cpp.

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

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

◆ 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 370 of file eda_base_frame.cpp.

References dump(), and kicadTraceKeyEvent.

◆ 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 1439 of file eda_base_frame.cpp.

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

◆ onExit()

void SIMULATOR_FRAME::onExit ( wxCommandEvent & event )

private

Definition at line 879 of file simulator_frame.cpp.

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

Referenced by SIMULATOR_FRAME().

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent & aEvent )

protectedinherited

Definition at line 1759 of file eda_base_frame.cpp.

References handleIconizeEvent().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

Definition at line 1181 of file eda_base_frame.cpp.

References EDA_BASE_FRAME(), and ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

inherited

Definition at line 1685 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 380 of file eda_base_frame.cpp.

References TOOLS_HOLDER::m_toolDispatcher.

◆ OnModify()

void SIMULATOR_FRAME::OnModify ( )

overridevirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 889 of file simulator_frame.cpp.

References m_workbookModified, EDA_BASE_FRAME::OnModify(), and UpdateTitle().

Referenced by EditAnalysis(), and StartSimulation().

◆ OnMove()

virtual void EDA_BASE_FRAME::OnMove ( wxMoveEvent & aEvent )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 194 of file eda_base_frame.h.

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

inherited

Definition at line 1188 of file eda_base_frame.cpp.

References ShowPreferences().

◆ onSimFinished()

void SIMULATOR_FRAME::onSimFinished ( wxCommandEvent & aEvent )

private

Definition at line 807 of file simulator_frame.cpp.

References SCHEMATIC::ClearOperatingPoints(), m_schematicFrame, m_simFinished, m_simulator, and m_ui.

Referenced by SIMULATOR_FRAME().

◆ onSimReport()

void SIMULATOR_FRAME::onSimReport ( wxCommandEvent & aEvent )

private

Definition at line 873 of file simulator_frame.cpp.

References m_ui.

Referenced by SIMULATOR_FRAME().

◆ onSimStarted()

void SIMULATOR_FRAME::onSimStarted ( wxCommandEvent & aEvent )

private

Definition at line 801 of file simulator_frame.cpp.

Referenced by SIMULATOR_FRAME().

◆ OnSize()

void EDA_BASE_FRAME::OnSize ( wxSizeEvent & aEvent )

virtualinherited

Reimplemented in EDA_DRAW_FRAME, FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, KICAD_MANAGER_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 727 of file eda_base_frame.cpp.

References ensureWindowIsOnScreen(), m_displayIndex, and traceDisplayLocation.

Referenced by EDA_DRAW_FRAME::OnSize().

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent & evt )

inherited

Definition at line 69 of file eda_dde.cpp.

References client_ipc_buffer, ExecuteRemoteCommand(), and IPC_BUF_SIZE.

◆ OnSockRequestServer()

void KIWAY_PLAYER::OnSockRequestServer ( wxSocketEvent & evt )

inherited

Definition at line 99 of file eda_dde.cpp.

References ID_EDA_SOCKET_EVENT, and m_sockets.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent & aEvent )

protectedinherited

Definition at line 1749 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 610 of file eda_base_frame.cpp.

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

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged().

◆ onUpdateSim()

void SIMULATOR_FRAME::onUpdateSim ( wxCommandEvent & aEvent )

private

Definition at line 844 of file simulator_frame.cpp.

References _, DisplayErrorMessage(), m_simulator, and m_ui.

Referenced by SIMULATOR_FRAME().

◆ OpenProjectFiles()

virtual bool KIWAY_PLAYER::OpenProjectFiles	(	const std::vector< wxString > &	aFileList,
		int	aCtl = 0 )

inlinevirtualinherited

Open a project or set of files given by aFileList.

This is generalized in the direction of worst case. In a typical case aFileList will only hold a single file, like "myboard.kicad_pcb" because any KIWAY_PLAYER is only in one KIWAY and the KIWAY owns the PROJECT. Therefore opening files from multiple projects into the same KIWAY_PLAYER is precluded.

Each derived class should handle this in a way specific to its needs. No filename prompting is done inside here for any file or project. There should be no need to call this with aFileList which is empty. However, calling it with a single filename which does not exist should indicate to the implementer that a new session is being started and that the given name is the desired name for the data file at time of save.

This function does not support "appending". Use a different function for that. Any prior project data tree should be cleared before loading the new stuff. Therefore, one of the first things an implementation should do is test for existence of the first file in the list, and if it does not exist, treat it as a new session, possibly with a UI notification to that effect.

After loading the window should update its Title as part of this operation. If the KIWAY_PLAYER needs to, it can load the *.pro file as part of this operation.

If the KIWAY_PLAYER cannot load any of the file(s) in the list, then it should say why through some GUI interface, and return false.

Parameters

aFileList	includes files that this frame should open according to the knowledge in the derived wxFrame. In almost every case, the list will have only a single file in it.
aCtl	is a set of bit flags ORed together from the set of KICTL_* #defined above.

Returns: true if all requested files were opened OK, else false.

Reimplemented in BITMAP2CMP_FRAME, CVPCB_MAINFRAME, FOOTPRINT_EDIT_FRAME, GERBVIEW_FRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, and SCH_EDIT_FRAME.

Definition at line 113 of file kiway_player.h.

Referenced by PANEL_JOBSET::EnsurePcbSchFramesOpen(), BACK_ANNOTATE::FetchNetlistFromPCB(), PGM_SINGLE_TOP::MacOpenFile(), PGM_TEST_FRAME::MacOpenFile(), SCH_EDIT_FRAME::OnOpenPcbnew(), PGM_KICAD::OnPgmInit(), PGM_SINGLE_TOP::OnPgmInit(), SCH_EDIT_FRAME::OnUpdatePCB(), and PCB_EDIT_FRAME::TestStandalone().

◆ 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 173 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().

◆ 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 1643 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 1637 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 1025 of file eda_base_frame.cpp.

References text.

Referenced by KICAD_MANAGER_FRAME::UnarchiveFiles().

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

◆ 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 300 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()

virtual void EDA_BASE_FRAME::ProjectChanged ( )

inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in KICAD_MANAGER_FRAME, and PCB_EDIT_FRAME.

Definition at line 538 of file eda_base_frame.h.

Referenced by KIWAY::ProjectChanged().

◆ 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 1622 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 1607 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 628 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 523 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().

◆ RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 166 of file tools_holder.h.

◆ 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 499 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 389 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().

◆ ReloadSimulator()

void SIMULATOR_FRAME::ReloadSimulator	(	const wxString &	aSimCommand,
		unsigned	aSimOptions )

Re-send the current command and settings to the simulator.

Use the existing netlist.

Definition at line 394 of file simulator_frame.cpp.

References m_circuitModel, m_simulator, KIWAY_HOLDER::Prj(), s_reporter, and showNetlistErrors().

◆ 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 370 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 713 of file eda_base_frame.h.

◆ SaveSettings()

void SIMULATOR_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 256 of file simulator_frame.cpp.

References PROJECT::GetProjectFile(), SCHEMATIC_SETTINGS::m_NgspiceSettings, m_schematicFrame, PROJECT_FILE::m_SchematicSettings, m_ui, KIWAY_HOLDER::Prj(), EDA_BASE_FRAME::SaveSettings(), and NESTED_SETTINGS::SaveToFile().

Referenced by doCloseWindow().

◆ 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 919 of file eda_base_frame.cpp.

References 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, WINDOW_STATE::size_x, WINDOW_STATE::size_y, WINDOW_SETTINGS::state, and traceDisplayLocation.

Referenced by SaveSettings().

◆ SaveWorkbook()

bool SIMULATOR_FRAME::SaveWorkbook ( const wxString & aPath )

Save plot, signal, cursor, measurement, etc.

settings to a file.

Definition at line 562 of file simulator_frame.cpp.

References m_ui, m_workbookModified, and UpdateTitle().

Referenced by canCloseWindow().

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

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool aIsModal )

inlineinherited

Definition at line 155 of file kiway_player.h.

References m_modal.

Referenced by FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), and SYMBOL_CHOOSER_FRAME::SYMBOL_CHOOSER_FRAME().

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString & aPath )

inlineinherited

Definition at line 423 of file eda_base_frame.h.

References m_mruPath.

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

◆ setupTools()

void SIMULATOR_FRAME::setupTools ( )

private

Definition at line 214 of file simulator_frame.cpp.

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

Referenced by SIMULATOR_FRAME().

◆ setupUIConditions()

void SIMULATOR_FRAME::setupUIConditions ( )

overrideprivatevirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 670 of file simulator_frame.cpp.

References CHECK, ENABLE, SCH_ACTIONS::exportPlotAsCSV, SCH_ACTIONS::exportPlotAsPNG, SCH_ACTIONS::exportPlotToClipboard, SCH_ACTIONS::exportPlotToSchematic, GetCurrentSimTab(), SIM_PLOT_TAB::GetDottedSecondary(), SIM_PLOT_TAB::GetPlotWin(), SIM_PLOT_TAB::IsGridShown(), SIM_PLOT_TAB::IsLegendShown(), m_simFinished, m_simulator, TOOLS_HOLDER::m_toolManager, m_ui, SCH_ACTIONS::newAnalysisTab, SCH_ACTIONS::openWorkbook, mpWindow::RedoZoomStackSize(), SCH_ACTIONS::runSimulation, SCH_ACTIONS::saveWorkbook, SCH_ACTIONS::saveWorkbookAs, ACTION_MANAGER::SetConditions(), EDA_BASE_FRAME::setupUIConditions(), SELECTION_CONDITIONS::ShowAlways(), SCH_ACTIONS::showNetlist, SCH_ACTIONS::simAnalysisProperties, SCH_ACTIONS::simProbe, SCH_ACTIONS::simTune, SCH_ACTIONS::stopSimulation, SCH_ACTIONS::toggleDarkModePlots, SCH_ACTIONS::toggleDottedSecondary, ACTIONS::toggleGrid, SCH_ACTIONS::toggleLegend, SCH_ACTIONS::toggleSimConsole, SCH_ACTIONS::toggleSimSidePanel, mpWindow::UndoZoomStackSize(), ACTIONS::zoomRedo, and ACTIONS::zoomUndo.

Referenced by SIMULATOR_FRAME().

◆ SetUserDefinedSignals()

void SIMULATOR_FRAME::SetUserDefinedSignals ( const std::map< int, wxString > & aSignals )

Definition at line 511 of file simulator_frame.cpp.

References m_ui.

◆ 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 SIMULATOR_FRAME::ShowChangedLanguage ( )

overridevirtual

Redraw the menus and what not in current language.

Reimplemented from EDA_BASE_FRAME.

Definition at line 233 of file simulator_frame.cpp.

References m_ui, EDA_BASE_FRAME::ShowChangedLanguage(), and UpdateTitle().

◆ 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 1071 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 1059 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 1097 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 1086 of file eda_base_frame.cpp.

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

Referenced by SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME().

◆ ShowModal()

bool KIWAY_PLAYER::ShowModal	(	wxString *	aResult = nullptr,
		wxWindow *	aResultantFocusWindow = nullptr )

virtualinherited

Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal().

This is behavior is similar to a modal dialog window. Not all KIWAY_PLAYERs use this interface, so don't call this unless the implementation knows how to call DismissModal() on a button click or double click or some special event which ends the modal behavior.

Parameters

aResult	if not NULL, indicates a place to put a resultant string.
aResultantFocusWindow	if not NULL, indicates what window to pass focus to on return.

Returns: true if frame implementation called KIWAY_PLAYER::DismissModal() with aRetVal of true.

Reimplemented in FOOTPRINT_CHOOSER_FRAME, and SYMBOL_CHOOSER_FRAME.

Definition at line 95 of file kiway_player.cpp.

References IsModal(), m_modal_loop, m_modal_resultant_parent, m_modal_ret_val, and m_modal_string.

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_CHOOSER_FRAME::ShowModal(), and SYMBOL_CHOOSER_FRAME::ShowModal().

◆ showNetlistErrors()

void SIMULATOR_FRAME::showNetlistErrors ( const WX_STRING_REPORTER & aReporter )

private

Definition at line 348 of file simulator_frame.cpp.

References _, DisplayErrorMessage(), DisplayInfoMessage(), WX_STRING_REPORTER::GetMessages(), REPORTER::HasMessage(), REPORTER::HasMessageOfSeverity(), MAX_MESSAGES, RPT_SEVERITY_ERROR, RPT_SEVERITY_UNDEFINED, and RPT_SEVERITY_WARNING.

Referenced by EditAnalysis(), LoadSimulator(), and ReloadSimulator().

◆ 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 1194 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().

◆ Signals()

const std::vector< wxString > SIMULATOR_FRAME::Signals ( )

Returns: the list of schematic signals + any user defined signals.

Definition at line 499 of file simulator_frame.cpp.

References m_ui.

◆ SimFinished()

bool SIMULATOR_FRAME::SimFinished ( ) const

inline

Definition at line 193 of file simulator_frame.h.

References m_simFinished.

◆ SimPlotVectors()

const std::vector< wxString > SIMULATOR_FRAME::SimPlotVectors ( )

Returns: the list of vectors (signals) in the current simulation results.

Definition at line 493 of file simulator_frame.cpp.

References m_ui.

◆ StartSimulation()

void SIMULATOR_FRAME::StartSimulation ( )

Definition at line 405 of file simulator_frame.cpp.

References _, DisplayErrorMessage(), SIM_TAB::GetLastSchTextSimCommand(), SIM_TAB::GetSimCommand(), SIM_TAB::GetSimOptions(), IsOK(), LoadSimulator(), m_circuitModel, m_simFinished, m_simulator, m_ui, OnModify(), SIM_TAB::SetLastSchTextSimCommand(), SIM_TAB::SetSimCommand(), SIM_TAB::SetSpicePlotName(), and ST_TRAN.

◆ 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 110 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 & EDA_BASE_FRAME::sys_search ( )

virtualinherited

Return a SEARCH_STACK pertaining to entire program.

This is overloaded in KICAD_MANAGER_FRAME

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 1013 of file eda_base_frame.cpp.

References Kiface(), and KIFACE_BASE::KifaceSearch().

◆ ThemeChanged()

void EDA_BASE_FRAME::ThemeChanged ( )

virtualinherited

Process light/dark theme change.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 712 of file eda_base_frame.cpp.

References ClearScaledBitmapCache(), and m_auimgr.

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

◆ ToggleDarkModePlots()

void SIMULATOR_FRAME::ToggleDarkModePlots ( )

Toggle dark-mode of the plot tabs.

Definition at line 588 of file simulator_frame.cpp.

References m_ui.

◆ ToggleSimConsole()

void SIMULATOR_FRAME::ToggleSimConsole ( )

Definition at line 576 of file simulator_frame.cpp.

References m_ui.

◆ ToggleSimSidePanel()

void SIMULATOR_FRAME::ToggleSimSidePanel ( )

Definition at line 582 of file simulator_frame.cpp.

References m_ui.

◆ ToggleUserUnits()

virtual void EDA_BASE_FRAME::ToggleUserUnits ( )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

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

◆ 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 690 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 402 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 1108 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().

◆ 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 517 of file eda_base_frame.h.

Referenced by TOOL_MANAGER::UpdateUI().

◆ UpdateTitle()

void SIMULATOR_FRAME::UpdateTitle ( )

Set the main window title bar text.

Definition at line 314 of file simulator_frame.cpp.

References _, PROJECT::AbsolutePath(), PROJECT::GetProjectFile(), SCHEMATIC_SETTINGS::m_NgspiceSettings, PROJECT_FILE::m_SchematicSettings, m_workbookModified, and KIWAY_HOLDER::Prj().

Referenced by LoadWorkbook(), OnModify(), SaveWorkbook(), ShowChangedLanguage(), and SIMULATOR_FRAME().

◆ 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 593 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().

◆ UserDefinedSignals()

const std::map< int, wxString > & SIMULATOR_FRAME::UserDefinedSignals ( )

Definition at line 505 of file simulator_frame.cpp.

References m_ui.

◆ 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 152 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 230 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 644 of file eda_base_frame.h.

Referenced by RecreateToolbars().

◆ m_aboutTitle

wxString EDA_BASE_FRAME::m_aboutTitle

protectedinherited

Definition at line 789 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 829 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 738 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.

◆ m_appearancePanel

APPEARANCE_CONTROLS_3D* EDA_BASE_FRAME::m_appearancePanel

protectedinherited

Definition at line 794 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_auimgr

wxAuiManager EDA_BASE_FRAME::m_auimgr

protectedinherited

Definition at line 791 of file eda_base_frame.h.

◆ m_autoSavePending

bool EDA_BASE_FRAME::m_autoSavePending

protectedinherited

Definition at line 802 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 805 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 803 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 804 of file eda_base_frame.h.

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

◆ m_circuitModel

std::shared_ptr<SPICE_CIRCUIT_MODEL> SIMULATOR_FRAME::m_circuitModel

private

Definition at line 232 of file simulator_frame.h.

Referenced by EditAnalysis(), GetCircuitModel(), GetCurrentSimCommand(), LoadSimulator(), ReloadSimulator(), SIMULATOR_FRAME(), and StartSimulation().

◆ m_configName

wxString EDA_BASE_FRAME::m_configName

protectedinherited

Definition at line 795 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 783 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 800 of file eda_base_frame.h.

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

◆ m_framePos

wxPoint EDA_BASE_FRAME::m_framePos

protectedinherited

Definition at line 780 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 781 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 779 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

◆ 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 821 of file eda_base_frame.h.

◆ 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 824 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 251 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_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault

protectedinherited

Definition at line 782 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_modal

bool KIWAY_PLAYER::m_modal

protectedinherited

Definition at line 190 of file kiway_player.h.

Referenced by IsModal(), KIWAY_PLAYER(), and SetModal().

◆ m_modal_loop

wxGUIEventLoop* KIWAY_PLAYER::m_modal_loop

protectedinherited

Points to nested event_loop. NULL means not modal and dismissed.

Definition at line 193 of file kiway_player.h.

Referenced by DismissModal(), IsDismissed(), KIWAY_PLAYER(), and ShowModal().

◆ m_modal_resultant_parent

wxWindow* KIWAY_PLAYER::m_modal_resultant_parent

protectedinherited

Definition at line 194 of file kiway_player.h.

Referenced by KIWAY_PLAYER(), and ShowModal().

◆ m_modal_ret_val

bool KIWAY_PLAYER::m_modal_ret_val

protectedinherited

Definition at line 196 of file kiway_player.h.

Referenced by DismissModal(), FOOTPRINT_WIZARD_FRAME::GetBuiltFootprint(), KIWAY_PLAYER(), and ShowModal().

◆ m_modal_string

wxString KIWAY_PLAYER::m_modal_string

protectedinherited

Definition at line 195 of file kiway_player.h.

Referenced by DismissModal(), and ShowModal().

◆ 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 812 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 786 of file eda_base_frame.h.

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

◆ m_normalFrameSize

wxSize EDA_BASE_FRAME::m_normalFrameSize

protectedinherited

Definition at line 787 of file eda_base_frame.h.

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

◆ m_originTransforms

ORIGIN_TRANSFORMS EDA_BASE_FRAME::m_originTransforms

protectedinherited

Definition at line 814 of file eda_base_frame.h.

Referenced by GetOriginTransforms().

◆ m_perspective

wxString EDA_BASE_FRAME::m_perspective

protectedinherited

Definition at line 792 of file eda_base_frame.h.

Referenced by LoadWindowSettings().

◆ m_redoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_redoList

protectedinherited

Definition at line 810 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_reporter

SIM_THREAD_REPORTER* SIMULATOR_FRAME::m_reporter

private

Definition at line 231 of file simulator_frame.h.

Referenced by SIMULATOR_FRAME(), and ~SIMULATOR_FRAME().

◆ m_schematicFrame

SCH_EDIT_FRAME* SIMULATOR_FRAME::m_schematicFrame

private

Definition at line 226 of file simulator_frame.h.

Referenced by doCloseWindow(), GetSchematicFrame(), LoadSimulator(), onSimFinished(), SaveSettings(), and SIMULATOR_FRAME().

◆ m_settingsManager

SETTINGS_MANAGER* EDA_BASE_FRAME::m_settingsManager

protectedinherited

Definition at line 798 of file eda_base_frame.h.

Referenced by commonInit(), and GetSettingsManager().

◆ m_simFinished

bool SIMULATOR_FRAME::m_simFinished

private

Definition at line 234 of file simulator_frame.h.

Referenced by onSimFinished(), setupUIConditions(), SimFinished(), SIMULATOR_FRAME(), and StartSimulation().

◆ m_simulator

std::shared_ptr<SPICE_SIMULATOR> SIMULATOR_FRAME::m_simulator

private

Definition at line 230 of file simulator_frame.h.

Referenced by canCloseWindow(), doCloseWindow(), EditAnalysis(), GetSimulator(), LoadSettings(), LoadSimulator(), onSimFinished(), onUpdateSim(), ReloadSimulator(), setupUIConditions(), SIMULATOR_FRAME(), StartSimulation(), and ~SIMULATOR_FRAME().

◆ m_sockets

std::vector<wxSocketBase*> KIWAY_PLAYER::m_sockets

protectedinherited

Definition at line 199 of file kiway_player.h.

Referenced by OnSockRequestServer(), and ~KIWAY_PLAYER().

◆ m_socketServer

wxSocketServer* KIWAY_PLAYER::m_socketServer

protectedinherited

Definition at line 198 of file kiway_player.h.

Referenced by CreateServer(), KIWAY_PLAYER(), and ~KIWAY_PLAYER().

◆ m_supportsAutoSave

bool EDA_BASE_FRAME::m_supportsAutoSave

protectedinherited

Definition at line 801 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 838 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(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and UpdateToolbarControlSizes().

◆ m_tbRight

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbRight

protectedinherited

Definition at line 837 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 836 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 835 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_toolBar

ACTION_TOOLBAR* SIMULATOR_FRAME::m_toolBar

private

Definition at line 227 of file simulator_frame.h.

Referenced by SIMULATOR_FRAME().

◆ m_toolbarControlFactories

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

protectedinherited

Definition at line 840 of file eda_base_frame.h.

Referenced by GetCustomToolbarControlFactory(), and RegisterCustomToolbarControlFactory().

◆ m_toolbarSettings

TOOLBAR_SETTINGS* EDA_BASE_FRAME::m_toolbarSettings

protectedinherited

Definition at line 832 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.

◆ 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_ui

SIMULATOR_FRAME_UI* SIMULATOR_FRAME::m_ui

private

◆ 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 817 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 809 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 807 of file eda_base_frame.h.

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

◆ m_userUnits

EDA_UNITS UNITS_PROVIDER::m_userUnits

privateinherited

Definition at line 252 of file units_provider.h.

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

◆ m_workbookModified

bool SIMULATOR_FRAME::m_workbookModified

private

Definition at line 235 of file simulator_frame.h.

Referenced by canCloseWindow(), LoadWorkbook(), OnModify(), SaveWorkbook(), SIMULATOR_FRAME(), and UpdateTitle().

◆ NullUiString

const wxString UNITS_PROVIDER::NullUiString = ""

inlinestaticinherited

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

Definition at line 248 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:

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ HOLDER_TYPE

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ SIMULATOR_FRAME()

◆ ~SIMULATOR_FRAME()

Member Function Documentation

◆ AddCurrentTrace()

◆ AddMenuLanguageList()

◆ AddStandardHelpMenu()

◆ AddTuner()

◆ AddVoltageTrace()

◆ AngleValueFromString()

◆ CanAcceptApiCommands()

◆ canCloseWindow()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ ClearFileHistory()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ commonInit()

◆ CommonSettingsChanged()

◆ config()

◆ ConfigBaseName()

◆ configureToolbars()

◆ CreateInfoBar()

◆ CreateServer()

◆ CurrentToolName()

◆ DeleteAutoSaveFile()

◆ Destroy()

◆ DismissModal()

◆ DisplayToolMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ doReCreateMenuBar()

◆ DoWithAcceptedFiles()

◆ EditAnalysis()

◆ ensureWindowIsOnScreen()

◆ ExecuteRemoteCommand()

◆ findQuasiModalDialog()

◆ FinishAUIInitialization()

◆ GetAboutTitle()

◆ GetAutoSaveInterval()

◆ GetCircuitModel()

◆ GetCurrentFileName()

◆ GetCurrentOptions()

◆ GetCurrentSelection()

◆ GetCurrentSimCommand()

◆ GetCurrentSimTab()

◆ GetCurrentSimType()

◆ GetCustomToolbarControlFactory()

◆ GetDoImmediateActions()

◆ GetDragAction()

◆ GetFileFromHistory()

◆ GetFileHistory()

◆ GetFrameType()

◆ GetInfoBar()

◆ GetIuScale()

◆ GetMaxUndoItems()

◆ GetMoveWarpsCursor()

◆ GetMruPath()

◆ GetOriginTransforms()

◆ GetRedoActionDescription()

◆ GetRedoCommandCount()

◆ GetSchematicFrame()

◆ GetSettingsManager()

◆ GetSeverity()

◆ GetSimulator()

◆ GetToolCanvas()

◆ GetToolDispatcher()