Implementing SIM_PLOT_FRAME_BASE. More...

#include <sim_plot_frame.h>

Inheritance diagram for SIM_PLOT_FRAME:

Classes
class	SIGNAL_CONTEXT_MENU
	Panel that was used as the most recent one for simulations. More...

Public Types
enum	UNDO_REDO_LIST { UNDO_LIST, REDO_LIST }
	Specifies whether we are interacting with the undo or redo stacks. More...

enum	HOLDER_TYPE { DIALOG, FRAME, PANEL }

Public Member Functions
	SIM_PLOT_FRAME (KIWAY aKiway, wxWindow aParent)

	~SIM_PLOT_FRAME ()

void	StartSimulation (const wxString &aSimCommand=wxEmptyString)

void	StopSimulation ()

bool	IsSimulationRunning ()

SIM_PANEL_BASE *	NewPlotPanel (wxString aSimCommand)
	Create a new plot panel for a given simulation type and adds it to the main notebook. More...

void	AddVoltagePlot (const wxString &aNetName)
	Add a voltage plot for a given net name. More...

void	AddCurrentPlot (const wxString &aDeviceName, const wxString &aParam)
	Add a current plot for a particular device. More...

void	AddTuner (SCH_SYMBOL *aSymbol)
	Add a tuner for a symbol. More...

void	RemoveTuner (TUNER_SLIDER *aTuner, bool aErase=true)
	Remove an existing tuner. More...

SIM_PLOT_PANEL *	CurrentPlot () const
	Return the currently opened plot panel (or NULL if there is none). More...

const NETLIST_EXPORTER_PSPICE_SIM *	GetExporter () const
	Return the netlist exporter object used for simulations. More...

bool	GetPlotBgOpt () const

void	LoadSettings (APP_SETTINGS_BASE *aCfg) override
	Load common frame parameters from a configuration file. More...

void	SaveSettings (APP_SETTINGS_BASE *aCfg) override
	Save common frame parameters to a configuration data file. More...

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

wxWindow *	GetToolCanvas () const override
	Canvas access. More...

std::shared_ptr< SPICE_SIMULATOR_SETTINGS > &	GetSimulatorSettings ()

void	m_splitterLeftRightOnIdle (wxIdleEvent &)

void	m_splitterPlotAndConsoleOnIdle (wxIdleEvent &)

void	m_splitterSignalsOnIdle (wxIdleEvent &)

void	m_splitterTuneValuesOnIdle (wxIdleEvent &)

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

virtual void	ParseArgs (wxCmdLineParser &aParser)
	Handle command-line arguments in a frame-specific way. More...

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

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

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

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

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

EDA_UNITS	GetUserUnits () const
	Return the user units currently in use. More...

void	SetUserUnits (EDA_UNITS aUnits)

void	ChangeUserUnits (EDA_UNITS aUnits)

virtual void	ToggleUserUnits ()

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

virtual void	OnCharHook (wxKeyEvent &aKeyEvent)
	Capture the key event before it is sent to the GUI. More...

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

virtual void	RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
	Register a UI update handler for the control with ID `aID`. More...

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

virtual void	UnregisterUIUpdateHandler (int aID) override
	Unregister a UI handler for a given ID that was registered using `RegisterUIUpdateHandler`. More...

virtual void	UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
	Unregister a UI handler for an action that was registered using `RegisterUIUpdateHandler`. More...

virtual void	OnMove (wxMoveEvent &aEvent)

virtual void	OnSize (wxSizeEvent &aEvent)

void	OnMaximize (wxMaximizeEvent &aEvent)

void	SetAutoSaveInterval (int aInterval)

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

virtual wxString	help_name ()

void	OnKicadAbout (wxCommandEvent &event)

void	OnPreferences (wxCommandEvent &event)
	Displays the preferences and settings of all opened editors paged dialog. More...

void	PrintMsg (const wxString &text)

void	CreateInfoBar ()

void	FinishAUIInitialization ()

WX_INFOBAR *	GetInfoBar ()

void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false)
	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. More...

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

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

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

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

virtual void	InstallPreferences (PAGED_DIALOG , PANEL_HOTKEYS_EDITOR )
	Allow a frame to load its preference panels (if any) into the preferences dialog. More...

void	LoadWindowState (const wxString &aFileName)

virtual void	LoadWindowState (const WINDOW_STATE &aState)
	Load frame state info from a configuration file. More...

void	LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
	Load window settings from the given settings object. More...

void	SaveWindowSettings (WINDOW_SETTINGS *aCfg)
	Save window settings to the given settings object. More...

wxString	ConfigBaseName () override
	Get the configuration base name. More...

virtual void	SaveProjectSettings ()
	Save changes to the project settings to the project (.pro) file. More...

void	ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
	Prompt the user for a hotkey file to read, and read it. More...

wxString	GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
	Fetches the file name from the file history list. More...

void	ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
	Removes all files from the file history. More...

void	UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
	Update the list of recently opened files. More...

FILE_HISTORY &	GetFileHistory ()
	Get the frame's main file history. More...

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

virtual void	ReCreateMenuBar ()
	Recreates the menu bar. More...

void	AddStandardHelpMenu (wxMenuBar *aMenuBar)
	Adds the standard KiCad help menu to the menubar. More...

bool	IsWritable (const wxFileName &aFileName)
	Checks if aFileName can be written. More...

void	CheckForAutoSaveFile (const wxFileName &aFileName)
	Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...

virtual void	UpdateStatusBar ()
	Update the status bar information. More...

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

void	CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
	Notification event that some of the common (suite-wide) settings have changed. More...

virtual void	ThemeChanged ()
	Process light/dark theme change. More...

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

const wxString &	GetAboutTitle () const

virtual bool	IsContentModified () const
	Get if the contents of the frame have been modified since the last save. More...

wxSize	GetWindowSize ()
	Get the undecorated window size that can be used for restoring the window size. More...

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

virtual void	ClearUndoRedoList ()
	Clear the undo and redo list using ClearUndoORRedoList() More...

virtual void	PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
	Add a command to undo in the undo list. More...

virtual void	PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
	Add a command to redo in the redo list. More...

virtual PICKED_ITEMS_LIST *	PopCommandFromUndoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...

virtual PICKED_ITEMS_LIST *	PopCommandFromRedoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...

virtual int	GetUndoCommandCount () const

virtual int	GetRedoCommandCount () const

int	GetMaxUndoItems () const

bool	NonUserClose (bool aForce)

virtual void	HandleSystemColorChange ()
	Update the UI in response to a change in the system colors. More...

TOOL_MANAGER *	GetToolManager () const
	Return the MVC controller. More...

virtual SELECTION &	GetCurrentSelection ()
	Get the current selection from the canvas area. More...

virtual void	PushTool (const std::string &actionName)
	NB: the definition of "tool" is different at the user level. More...

virtual void	PopTool (const std::string &actionName)

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

MOUSE_DRAG_ACTION	GetDragAction () const
	Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...

bool	GetMoveWarpsCursor () const
	Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...

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

PROJECT &	Prj () const
	Return a reference to the PROJECT associated with this KIWAY. More...

void	SetKiway (wxWindow aDest, KIWAY aKiway)
	It is only used for debugging, since "this" is not a wxWindow*. More...

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

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

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

void	onAutoSaveTimer (wxTimerEvent &aEvent)
	Handle the auto save timer event. More...

virtual bool	isAutoSaveRequired () const
	Return the auto save status of the application. More...

virtual bool	doAutoSave ()
	This should be overridden by the derived class to handle the auto save feature. More...

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

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

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

void	ensureWindowIsOnScreen ()

Static Protected Member Functions
static wxString	GetAutoSaveFilePrefix ()

Protected Attributes
wxMenuBar *	m_mainMenu

wxMenu *	m_fileMenu

wxMenu *	m_simulationMenu

wxMenuItem *	m_runSimulation

wxMenuItem *	m_addSignals

wxMenuItem *	m_probeSignals

wxMenuItem *	m_tuneValue

wxMenuItem *	m_showNetlist

wxMenuItem *	m_settings

wxMenu *	m_viewMenu

wxBoxSizer *	m_sizerMain

wxToolBar *	m_toolBar

wxSplitterWindow *	m_splitterLeftRight

wxPanel *	m_panelLeft

wxBoxSizer *	m_sizer11

wxSplitterWindow *	m_splitterPlotAndConsole

wxPanel *	m_plotPanel

wxBoxSizer *	m_sizerPlot

wxAuiNotebook *	m_plotNotebook

wxPanel *	m_panelConsole

wxBoxSizer *	m_sizerConsole

wxTextCtrl *	m_simConsole

wxPanel *	m_sidePanel

wxBoxSizer *	m_sideSizer

wxSplitterWindow *	m_splitterSignals

wxPanel *	m_panelSignals

wxStaticText *	m_staticTextSignals

wxListView *	m_signals

wxPanel *	m_panelCursorsAndTune

wxSplitterWindow *	m_splitterTuneValues

wxPanel *	m_panelCursors

wxStaticText *	m_staticTextCursors

wxListCtrl *	m_cursors

wxPanel *	m_tunePanel

wxStaticText *	m_staticTextTune

wxBoxSizer *	m_tuneSizer

bool	m_modal

WX_EVENT_LOOP *	m_modal_loop
	< Points to nested event_loop. NULL means not modal and dismissed. More...

wxWindow *	m_modal_resultant_parent

wxString	m_modal_string

bool	m_modal_ret_val

wxSocketServer *	m_socketServer

std::vector< wxSocketBase * >	m_sockets
	interprocess communication More...

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

wxString	m_configName

SETTINGS_MANAGER *	m_settingsManager

FILE_HISTORY *	m_fileHistory

bool	m_hasAutoSave

bool	m_autoSaveState

int	m_autoSaveInterval

wxTimer *	m_autoSaveTimer

int	m_undoRedoCountMax

UNDO_REDO_CONTAINER	m_undoList

UNDO_REDO_CONTAINER	m_redoList

wxString	m_mruPath

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

std::map< int, UIUpdateHandler >	m_uiUpdateMap
	Set by the close window event handler after frames are asked if they can close. More...

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

bool	m_isNonUserClose

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

Private Member Functions
void	initWorkbook ()
	Load the currently active workbook stored in the project settings. More...

void	updateTitle ()
	Set the main window title bar text. More...

void	updateWorkbook ()
	Update the workbook to match the changes in the frame. More...

void	updateFrame ()
	Update the frame to match the changes to the workbook. More...

void	setIconsForMenuItems ()
	Give icons to menuitems of the main menubar. More...

SIM_PANEL_BASE *	currentPlotWindow () const
	Return the currently opened plot panel (or NULL if there is none). More...

void	addPlot (const wxString &aName, SIM_PLOT_TYPE aType, const wxString &aParam)
	Add a new plot to the current panel. More...

void	removePlot (const wxString &aPlotName, bool aErase=true)
	Remove a plot with a specific title. More...

void	updateNetlistExporter ()
	Reload the current schematic for the netlist exporter. More...

bool	updatePlot (const wxString &aName, SIM_PLOT_TYPE aType, const wxString &aParam, SIM_PLOT_PANEL *aPanel)
	Update plot in a particular SIM_PLOT_PANEL. More...

void	updateSignalList ()
	Update the list of currently plotted signals. More...

void	updateTuners ()
	Filter out tuners for components that do not exist anymore. More...

void	applyTuners ()
	Apply component values specified using tuner sliders to the current netlist. More...

bool	loadWorkbook (const wxString &aPath)
	Load plot settings from a file. More...

bool	saveWorkbook (const wxString &aPath)
	Save plot settings to a file. More...

SIM_PLOT_TYPE	GetXAxisType (SIM_TYPE aType) const
	Return X axis for a given simulation type. More...

void	menuNewPlot (wxCommandEvent &aEvent) override

void	menuOpenWorkbook (wxCommandEvent &event) override

void	menuSaveWorkbook (wxCommandEvent &event) override

void	menuSaveWorkbookAs (wxCommandEvent &event) override

void	menuExit (wxCommandEvent &event) override

void	menuSaveImage (wxCommandEvent &event) override

void	menuSaveCsv (wxCommandEvent &event) override

void	menuZoomIn (wxCommandEvent &event) override

void	menuZoomOut (wxCommandEvent &event) override

void	menuZoomFit (wxCommandEvent &event) override

void	menuShowGrid (wxCommandEvent &event) override

void	menuShowGridUpdate (wxUpdateUIEvent &event) override

void	menuShowLegend (wxCommandEvent &event) override

void	menuShowLegendUpdate (wxUpdateUIEvent &event) override

void	menuShowDotted (wxCommandEvent &event) override

void	menuShowDottedUpdate (wxUpdateUIEvent &event) override

void	menuWhiteBackground (wxCommandEvent &event) override

void	menuShowWhiteBackgroundUpdate (wxUpdateUIEvent &event) override

void	onPlotClose (wxAuiNotebookEvent &event) override

void	onPlotClosed (wxAuiNotebookEvent &event) override

void	onPlotChanged (wxAuiNotebookEvent &event) override

void	onPlotDragged (wxAuiNotebookEvent &event) override

void	onSignalDblClick (wxMouseEvent &event) override

void	onSignalRClick (wxListEvent &event) override

void	onSimulate (wxCommandEvent &event)

void	onSettings (wxCommandEvent &event)

void	onAddSignal (wxCommandEvent &event)

void	onProbe (wxCommandEvent &event)

void	onTune (wxCommandEvent &event)

void	onShowNetlist (wxCommandEvent &event)

bool	canCloseWindow (wxCloseEvent &aEvent) override

void	doCloseWindow () override

void	onCursorUpdate (wxCommandEvent &aEvent)

void	onSimUpdate (wxCommandEvent &aEvent)

void	onSimReport (wxCommandEvent &aEvent)

void	onSimStarted (wxCommandEvent &aEvent)

void	onSimFinished (wxCommandEvent &aEvent)

void	setSubWindowsSashSize ()

Private Attributes
wxToolBarToolBase *	m_toolSimulate

wxToolBarToolBase *	m_toolAddSignals

wxToolBarToolBase *	m_toolProbe

wxToolBarToolBase *	m_toolTune

wxToolBarToolBase *	m_toolSettings

SCH_EDIT_FRAME *	m_schematicFrame

std::unique_ptr< NETLIST_EXPORTER_PSPICE_SIM >	m_exporter

std::shared_ptr< SPICE_SIMULATOR >	m_simulator

SIM_THREAD_REPORTER *	m_reporter
	Stores the data that can be preserved across simulator sessions. More...

std::unique_ptr< SIM_WORKBOOK >	m_workbook
	List of currently displayed tuners. More...

std::list< TUNER_SLIDER * >	m_tuners

DIALOG_SIM_SETTINGS *	m_settingsDlg

SIM_PLOT_PANEL *	m_lastSimPlot
	imagelists used to add a small colored icon to signal names and cursors name, the same color as the corresponding signal traces More...

wxImageList *	m_signalsIconColorList
	A string to store the path of saved workbooks during a session. More...

int	m_splitterLeftRightSashPosition

int	m_splitterPlotAndConsoleSashPosition

int	m_splitterSignalsSashPosition

int	m_splitterTuneValuesSashPosition

bool	m_plotUseWhiteBg

unsigned int	m_plotNumber

Static Private Attributes
static wxString	m_savedWorkbooksPath

Detailed Description

Implementing SIM_PLOT_FRAME_BASE.

Definition at line 66 of file sim_plot_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

39 { DIALOG, FRAME, PANEL };

KIWAY_HOLDER::DIALOG

Definition: kiway_holder.h:39

KIWAY_HOLDER::PANEL

Definition: kiway_holder.h:39

KIWAY_HOLDER::FRAME

Definition: kiway_holder.h:39

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

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

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 109 of file eda_base_frame.h.

     {
         UNDO_LIST,
         REDO_LIST
     };

Constructor & Destructor Documentation

◆ SIM_PLOT_FRAME()

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

Definition at line 114 of file sim_plot_frame.cpp.

                                                                  :
         SIM_PLOT_FRAME_BASE( aParent ),
         m_lastSimPlot( nullptr ),
         m_plotNumber( 0 )
 {
     SetKiway( this, aKiway );
     m_signalsIconColorList = NULL;
 
     m_schematicFrame = (SCH_EDIT_FRAME*) Kiway().Player( FRAME_SCH, false );
 
     if( m_schematicFrame == NULL )
         throw std::runtime_error( "There is no schematic window" );
 
     // Give an icon
     wxIcon icon;
     icon.CopyFromBitmap( KiBitmap( BITMAPS::simulator ) );
     SetIcon( icon );
 
     m_simulator = SPICE_SIMULATOR::CreateInstance( "ngspice" );
 
     if( !m_simulator )
     {
         throw std::runtime_error( "Could not create simulator instance" );
         return;
     }
 
     // Get the previous size and position of windows:
     LoadSettings( config() );
 
     // Prepare the color list to plot traces
     SIM_PLOT_COLORS::FillDefaultColorList( GetPlotBgOpt() );
 
     // Give icons to menuitems
     setIconsForMenuItems();
 
     m_simulator->Init();
 
     if( m_savedWorkbooksPath.IsEmpty() )
         m_savedWorkbooksPath = Prj().GetProjectPath();
 
     m_reporter = new SIM_THREAD_REPORTER( this );
     m_simulator->SetReporter( m_reporter );
 
     // the settings dialog will be created later, on demand.
     // if created in the ctor, for some obscure reason, there is an issue
     // on Windows: when open it, the simulator frame is sent to the background.
     // instead of being behind the dialog frame (as it does)
     m_settingsDlg = nullptr;
 
     updateNetlistExporter();
 
     Connect( EVT_SIM_UPDATE, wxCommandEventHandler( SIM_PLOT_FRAME::onSimUpdate ), NULL, this );
     Connect( EVT_SIM_REPORT, wxCommandEventHandler( SIM_PLOT_FRAME::onSimReport ), NULL, this );
     Connect( EVT_SIM_STARTED, wxCommandEventHandler( SIM_PLOT_FRAME::onSimStarted ), NULL, this );
     Connect( EVT_SIM_FINISHED, wxCommandEventHandler( SIM_PLOT_FRAME::onSimFinished ), NULL, this );
     Connect( EVT_SIM_CURSOR_UPDATE, wxCommandEventHandler( SIM_PLOT_FRAME::onCursorUpdate ),
              NULL, this );
 
     // Toolbar buttons
     m_toolSimulate = m_toolBar->AddTool( ID_SIM_RUN, _( "Run/Stop Simulation" ),
             KiBitmap( BITMAPS::sim_run ), _( "Run Simulation" ), wxITEM_NORMAL );
     m_toolAddSignals = m_toolBar->AddTool( ID_SIM_ADD_SIGNALS, _( "Add Signals" ),
             KiBitmap( BITMAPS::sim_add_signal ), _( "Add signals to plot" ), wxITEM_NORMAL );
     m_toolProbe = m_toolBar->AddTool( ID_SIM_PROBE,  _( "Probe" ),
             KiBitmap( BITMAPS::sim_probe ), _( "Probe signals on the schematic" ), wxITEM_NORMAL );
     m_toolTune = m_toolBar->AddTool( ID_SIM_TUNE, _( "Tune" ),
             KiBitmap( BITMAPS::sim_tune ), _( "Tune component values" ), wxITEM_NORMAL );
     m_toolSettings = m_toolBar->AddTool( wxID_ANY, _( "Sim Parameters" ),
             KiBitmap( BITMAPS::config ), _( "Simulation parameters and settings" ), wxITEM_NORMAL );
 
     Connect( m_toolSimulate->GetId(), wxEVT_COMMAND_TOOL_CLICKED,
              wxCommandEventHandler( SIM_PLOT_FRAME::onSimulate ), NULL, this );
     Connect( m_toolAddSignals->GetId(), wxEVT_COMMAND_TOOL_CLICKED,
              wxCommandEventHandler( SIM_PLOT_FRAME::onAddSignal ), NULL, this );
     Connect( m_toolProbe->GetId(), wxEVT_COMMAND_TOOL_CLICKED,
              wxCommandEventHandler( SIM_PLOT_FRAME::onProbe ), NULL, this );
     Connect( m_toolTune->GetId(), wxEVT_COMMAND_TOOL_CLICKED,
              wxCommandEventHandler( SIM_PLOT_FRAME::onTune ), NULL, this );
     Connect( m_toolSettings->GetId(), wxEVT_COMMAND_TOOL_CLICKED,
              wxCommandEventHandler( SIM_PLOT_FRAME::onSettings ), NULL, this );
 
     // Bind toolbar buttons event to existing menu event handlers, so they behave the same
     Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onSimulate, this,
           m_runSimulation->GetId() );
     Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onAddSignal, this, m_addSignals->GetId() );
     Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onProbe, this, m_probeSignals->GetId() );
     Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onTune, this, m_tuneValue->GetId() );
     Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onShowNetlist, this,
           m_showNetlist->GetId() );
     Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onSettings, this, m_settings->GetId() );
 
     m_toolBar->Realize();
 
 #ifndef wxHAS_NATIVE_TABART
     // Non-native default tab art has ulgy gradients we don't want
     m_plotNotebook->SetArtProvider( new wxAuiSimpleTabArt() );
 #endif
 
     // Ensure new items are taken in account by sizers:
     Layout();
 
     // resize the subwindows size. At least on Windows, calling wxSafeYield before
     // resizing the subwindows forces the wxSplitWindows size events automatically generated
     // by wxWidgets to be executed before our resize code.
     // Otherwise, the changes made by setSubWindowsSashSize are overwritten by one these
     // events
     wxSafeYield();
     setSubWindowsSashSize();
 
     // Ensure the window is on top
     Raise();
 
     initWorkbook();
 }

◆ ~SIM_PLOT_FRAME()

SIM_PLOT_FRAME::~SIM_PLOT_FRAME ( )

Definition at line 230 of file sim_plot_frame.cpp.

 {
     m_simulator->SetReporter( nullptr );
     delete m_reporter;
     delete m_signalsIconColorList;
 
     if( m_settingsDlg )
         m_settingsDlg->Destroy();
 }

References m_reporter, m_settingsDlg, m_signalsIconColorList, and m_simulator.

Member Function Documentation

◆ AddCurrentPlot()

void SIM_PLOT_FRAME::AddCurrentPlot	(	const wxString &	aDeviceName,
		const wxString &	aParam
	)

Add a current plot for a particular device.

Parameters

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

Definition at line 553 of file sim_plot_frame.cpp.

 {
     addPlot( aDeviceName, SPT_CURRENT, aParam );
 }

References addPlot(), and SPT_CURRENT.

Referenced by DIALOG_SIGNAL_LIST::addSignalToPlotFrame().

◆ addPlot()

void SIM_PLOT_FRAME::addPlot	(	const wxString &	aName,
		SIM_PLOT_TYPE	aType,
		const wxString &	aParam
	)

private

Add a new plot to the current panel.

Parameters

aName	is the device/net name.
aType	describes the type of plot.
aParam	is the parameter for the device/net (e.g. I, Id, V).

Definition at line 634 of file sim_plot_frame.cpp.

 {
     SIM_TYPE simType = m_exporter->GetSimType();
 
     if( simType == ST_UNKNOWN )
     {
         m_simConsole->AppendText( _( "Error: simulation type not defined!\n" ) );
         m_simConsole->SetInsertionPointEnd();
         return;
     }
     else if( !SIM_PANEL_BASE::IsPlottable( simType ) )
     {
         m_simConsole->AppendText( _( "Error: simulation type doesn't support plotting!\n" ) );
         m_simConsole->SetInsertionPointEnd();
         return;
     }
 
     // Create a new plot if the current one displays a different type
     SIM_PLOT_PANEL* plotPanel = CurrentPlot();
 
     if( !plotPanel || plotPanel->GetType() != simType )
         plotPanel =
                 dynamic_cast<SIM_PLOT_PANEL*>( NewPlotPanel( m_exporter->GetUsedSimCommand() ) );
 
     wxASSERT( plotPanel );
 
     if( !plotPanel )    // Something is wrong
         return;
 
     bool updated = false;
     SIM_PLOT_TYPE xAxisType = GetXAxisType( simType );
 
     if( xAxisType == SPT_LIN_FREQUENCY || xAxisType == SPT_LOG_FREQUENCY )
     {
         int baseType = aType & ~( SPT_AC_MAG | SPT_AC_PHASE );
 
         // Add two plots: magnitude & phase
         updated |=
                 updatePlot( aName, ( SIM_PLOT_TYPE )( baseType | SPT_AC_MAG ), aParam, plotPanel );
         updated |= updatePlot( aName, ( SIM_PLOT_TYPE )( baseType | SPT_AC_PHASE ), aParam,
                                plotPanel );
     }
     else
     {
         updated = updatePlot( aName, aType, aParam, plotPanel );
     }
 
     if( updated )
     {
         updateSignalList();
     }
 }

References _, CurrentPlot(), SIM_PANEL_BASE::GetType(), GetXAxisType(), SIM_PANEL_BASE::IsPlottable(), m_exporter, SIM_PLOT_FRAME_BASE::m_simConsole, NewPlotPanel(), SPT_AC_MAG, SPT_AC_PHASE, SPT_LIN_FREQUENCY, SPT_LOG_FREQUENCY, ST_UNKNOWN, updatePlot(), and updateSignalList().

Referenced by AddCurrentPlot(), AddVoltagePlot(), and loadWorkbook().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar * aMenuBar )

inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 438 of file eda_base_frame.cpp.

 {
     COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
     ACTION_MENU*    helpMenu = new ACTION_MENU( false, commonControl );
 
     helpMenu->Add( ACTIONS::help );
     helpMenu->Add( ACTIONS::gettingStarted );
     helpMenu->Add( ACTIONS::listHotKeys );
     helpMenu->Add( ACTIONS::getInvolved );
     helpMenu->Add( ACTIONS::donate );
     helpMenu->Add( ACTIONS::reportBug );
 
     helpMenu->AppendSeparator();
     helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
 
     aMenuBar->Append( helpMenu, _( "&Help" ) );
 }

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

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

◆ AddTuner()

void SIM_PLOT_FRAME::AddTuner ( SCH_SYMBOL * aSymbol )

Add a tuner for a symbol.

Definition at line 559 of file sim_plot_frame.cpp.

 {
     SIM_PANEL_BASE* plotPanel = currentPlotWindow();
 
     if( !plotPanel )
         return;
 
     // For now limit the tuner tool to RLC components
     char primitiveType = NETLIST_EXPORTER_PSPICE::GetSpiceField( SF_PRIMITIVE, aSymbol, 0 )[0];
 
     if( primitiveType != SP_RESISTOR && primitiveType != SP_CAPACITOR
       && primitiveType != SP_INDUCTOR )
         return;
 
     const wxString componentName = aSymbol->GetField( REFERENCE_FIELD )->GetText();
 
     // Do not add multiple instances for the same component
     auto tunerIt = std::find_if( m_tuners.begin(), m_tuners.end(), [&]( const TUNER_SLIDER* t )
         {
             return t->GetComponentName() == componentName;
         }
     );
 
     if( tunerIt != m_tuners.end() )
         return;     // We already have it
 
     try
     {
         TUNER_SLIDER* tuner = new TUNER_SLIDER( this, m_tunePanel, aSymbol );
         m_tuneSizer->Add( tuner );
         m_tuners.push_back( tuner );
         m_tunePanel->Layout();
     }
     catch( const KI_PARAM_ERROR& e )
     {
         // Sorry, no bonus
         DisplayErrorMessage( nullptr, e.What() );
     }
 }

References currentPlotWindow(), DisplayErrorMessage(), SCH_SYMBOL::GetField(), NETLIST_EXPORTER_PSPICE::GetSpiceField(), EDA_TEXT::GetText(), SIM_PLOT_FRAME_BASE::m_tunePanel, m_tuners, SIM_PLOT_FRAME_BASE::m_tuneSizer, REFERENCE_FIELD, SF_PRIMITIVE, SP_CAPACITOR, SP_INDUCTOR, SP_RESISTOR, and KI_PARAM_ERROR::What().

◆ AddVoltagePlot()

void SIM_PLOT_FRAME::AddVoltagePlot ( const wxString & aNetName )

Add a voltage plot for a given net name.

Parameters

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

Definition at line 547 of file sim_plot_frame.cpp.

 {
     addPlot( aNetName, SPT_VOLTAGE, "V" );
 }

References addPlot(), and SPT_VOLTAGE.

Referenced by DIALOG_SIGNAL_LIST::addSelectionToPlotFrame(), and DIALOG_SIGNAL_LIST::addSignalToPlotFrame().

◆ applyTuners()

void SIM_PLOT_FRAME::applyTuners ( )

private

Apply component values specified using tuner sliders to the current netlist.

Todo:: no ngspice hardcoding

Definition at line 916 of file sim_plot_frame.cpp.

 {
     for( auto& tuner : m_tuners )
     {
         std::string command( "alter @" + tuner->GetSpiceName()
                 + "=" + tuner->GetValue().ToSpiceString() );
 
         m_simulator->Command( command );
     }
 }

References m_simulator, and m_tuners.

Referenced by onSimUpdate(), and StartSimulation().

◆ canCloseWindow()

bool SIM_PLOT_FRAME::canCloseWindow ( wxCloseEvent & aEvent )

overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 1549 of file sim_plot_frame.cpp.

 {
     if( m_workbook->IsModified() )
     {
         wxFileName filename = m_simulator->Settings()->GetWorkbookFilename();
 
         if( filename.GetName().IsEmpty() )
             filename.SetFullName( Prj().GetProjectName() + wxT( ".wbk" ) );
 
         wxString msg = _( "Save changes to \"%s\" before closing?" );
 
         return HandleUnsavedChanges( this, wxString::Format( msg, filename.GetFullName() ), 
                                      [&]()->bool { return saveWorkbook( Prj().AbsolutePath ( filename.GetFullName() ) ); } );
     }
 
     return true;
 }

References _, Format(), HandleUnsavedChanges(), m_simulator, m_workbook, KIWAY_HOLDER::Prj(), and saveWorkbook().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1175 of file eda_base_frame.cpp.

 {
     SetUserUnits( aUnits );
     unitsChangeRefresh();
 
     wxCommandEvent e( UNITS_CHANGED );
     ProcessEventLocally( e );
 }

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

Referenced by COMMON_TOOLS::SwitchUnits(), and COMMON_TOOLS::ToggleUnits().

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName & aFileName )

inherited

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.

Definition at line 1063 of file eda_base_frame.cpp.

 {
     wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
 
     wxFileName autoSaveFileName = aFileName;
 
     // Check for auto save file.
     autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
 
     wxLogTrace( traceAutoSave,
                 wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
 
     if( !autoSaveFileName.FileExists() )
         return;
 
     wxString msg = wxString::Format( _(
             "Well this is potentially embarrassing!\n"
             "It appears that the last time you were editing the file\n"
             "\"%s\"\n"
             "it was not saved properly.  Do you wish to restore the last saved edits you made?" ),
             aFileName.GetFullName()
         );
 
     int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
                                  this );
 
     // Make a backup of the current file, delete the file, and rename the auto save file to
     // the file name.
     if( response == wxYES )
     {
         if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
         {
             wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
                           Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
         }
     }
     else
     {
         wxLogTrace( traceAutoSave,
                     wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
 
         // Remove the auto save file when using the previous file as is.
         wxRemoveFile( autoSaveFileName.GetFullPath() );
     }
 }

References _, Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), Pgm(), and traceAutoSave.

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

◆ ClearFileHistory()

void EDA_BASE_FRAME::ClearFileHistory ( FILE_HISTORY * aFileHistory = nullptr )

inherited

Removes all files from the file history.

Parameters

aFileHistory The FILE_HISTORY in use. If null, the main application file history is used

Definition at line 950 of file eda_base_frame.cpp.

 {
     if( !aFileHistory )
         aFileHistory = m_fileHistory;
 
     wxASSERT( aFileHistory );
 
     aFileHistory->ClearFileHistory();
 
     // Update the menubar to update the file history menu
     if( GetMenuBar() )
     {
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 }

References FILE_HISTORY::ClearFileHistory(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), SCH_EDIT_FRAME::OnClearFileHistory(), GERBVIEW_FRAME::OnClearGbrFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), and GERBVIEW_FRAME::OnClearZipFileHistory().

◆ 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 SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 543 of file eda_base_frame.h.

544 { }

Referenced by EDA_BASE_FRAME::ClearUndoRedoList(), EDA_BASE_FRAME::PushCommandToRedoList(), and EDA_BASE_FRAME::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 1126 of file eda_base_frame.cpp.

 {
     ClearUndoORRedoList( UNDO_LIST );
     ClearUndoORRedoList( REDO_LIST );
 }

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::REDO_LIST, and EDA_BASE_FRAME::UNDO_LIST.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_EDIT_FRAME::emptyScreen(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), PL_EDITOR_FRAME::OnNewDrawingSheet(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and EDA_BASE_FRAME::~EDA_BASE_FRAME().

◆ CommonSettingsChanged()

void EDA_BASE_FRAME::CommonSettingsChanged	(	bool	aEnvVarsChanged,
		bool	aTextVarsChanged
	)

overridevirtualinherited

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

Update menus, toolbars, local variables, etc.

Reimplemented from TOOLS_HOLDER.

Reimplemented in PCB_EDIT_FRAME, PCB_BASE_FRAME, FOOTPRINT_EDIT_FRAME, EDA_DRAW_FRAME, FOOTPRINT_VIEWER_FRAME, KICAD_MANAGER_FRAME, and PL_EDITOR_FRAME.

Definition at line 467 of file eda_base_frame.cpp.

 {
     TOOLS_HOLDER::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
 
     COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
 
     if( m_fileHistory )
     {
         int historySize = settings->m_System.file_history_size;
         m_fileHistory->SetMaxFiles( (unsigned) std::max( 0, historySize ) );
     }
 
     if( GetBitmapStore()->ThemeChanged() )
     {
         ThemeChanged();
     }
 
     if( GetMenuBar() )
     {
         // For icons in menus, icon scaling & hotkeys
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 }

References TOOLS_HOLDER::CommonSettingsChanged(), COMMON_SETTINGS::SYSTEM::file_history_size, GetBitmapStore(), EDA_BASE_FRAME::m_fileHistory, COMMON_SETTINGS::m_System, Pgm(), EDA_BASE_FRAME::ReCreateMenuBar(), FILE_HISTORY::SetMaxFiles(), and EDA_BASE_FRAME::ThemeChanged().

Referenced by EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), and KIWAY::CommonSettingsChanged().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const

virtualinherited

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

Reimplemented in SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 791 of file eda_base_frame.cpp.

 {
     // KICAD_MANAGER_FRAME overrides this
     return Kiface().KifaceSettings();
 }

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), ZOOM_MENU::ZOOM_MENU(), and BM2CMP_FRAME::~BM2CMP_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 357 of file eda_base_frame.h.

     {
         wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
         return baseCfgName;
     }

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 816 of file eda_base_frame.cpp.

 {
 #if defined( __WXOSX_MAC__ )
     m_infoBar = new WX_INFOBAR( GetToolCanvas() );
 #else
     m_infoBar = new WX_INFOBAR( this, &m_auimgr );
 
     m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
 #endif
 }

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

◆ CreateServer()

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

inherited

Definition at line 49 of file eda_dde.cpp.

 {
     wxIPV4address addr;
 
     // Set the port number
     addr.Service( service );
 
     // Listen on localhost only if requested
     if( local )
         addr.Hostname( HOSTNAME );
 
     delete m_socketServer;
     m_socketServer = new wxSocketServer( addr );
 
     m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
     m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
     m_socketServer->Notify( true );
 }

References HOSTNAME(), ID_EDA_SOCKET_EVENT_SERV, and KIWAY_PLAYER::m_socketServer.

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

◆ CurrentPlot()

SIM_PLOT_PANEL * SIM_PLOT_FRAME::CurrentPlot ( ) const

Return the currently opened plot panel (or NULL if there is none).

Definition at line 610 of file sim_plot_frame.cpp.

 {
     SIM_PANEL_BASE* curPage = currentPlotWindow();
 
     return ( ( !curPage || curPage->GetType() == ST_UNKNOWN ) ?
                      nullptr :
                      dynamic_cast<SIM_PLOT_PANEL*>( curPage ) );
 }

References currentPlotWindow(), SIM_PANEL_BASE::GetType(), and ST_UNKNOWN.

Referenced by addPlot(), menuSaveCsv(), menuSaveImage(), menuShowDotted(), menuShowDottedUpdate(), menuShowGrid(), menuShowGridUpdate(), menuShowLegend(), menuShowLegendUpdate(), menuZoomFit(), menuZoomIn(), menuZoomOut(), onAddSignal(), onCursorUpdate(), onSimUpdate(), removePlot(), SIM_PLOT_FRAME::SIGNAL_CONTEXT_MENU::SIGNAL_CONTEXT_MENU(), and updateSignalList().

◆ currentPlotWindow()

SIM_PANEL_BASE* SIM_PLOT_FRAME::currentPlotWindow ( ) const

inlineprivate

Return the currently opened plot panel (or NULL if there is none).

Definition at line 171 of file sim_plot_frame.h.

     {
         return dynamic_cast<SIM_PANEL_BASE*>( m_plotNotebook->GetCurrentPage() );
     }

References SIM_PLOT_FRAME_BASE::m_plotNotebook.

Referenced by AddTuner(), CurrentPlot(), onSettings(), onSimFinished(), and StartSimulation().

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 100 of file tools_holder.cpp.

 {
     if( m_toolStack.empty() )
         return ACTIONS::selectionTool.GetName();
     else
         return m_toolStack.back();
 }

References TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by TOOL_MANAGER::processEvent().

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

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

Definition at line 150 of file kiway_player.cpp.

 {
     return EDA_BASE_FRAME::Destroy();
 }

Referenced by DISPLAY_FOOTPRINTS_FRAME::doCloseWindow(), GERBVIEW_FRAME::doCloseWindow(), SYMBOL_VIEWER_FRAME::doCloseWindow(), PL_EDITOR_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::doCloseWindow(), doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), PCB_BASE_FRAME::SelectFootprintFromLibBrowser(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ DismissModal()

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

inherited

Definition at line 161 of file kiway_player.cpp.

 {
     m_modal_ret_val = aRetVal;
     m_modal_string  = aResult;
 
     if( m_modal_loop )
     {
         m_modal_loop->Exit();
         m_modal_loop = nullptr;      // this marks it as dismissed.
     }
 
     Show( false );
 }

References KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_ret_val, and KIWAY_PLAYER::m_modal_string.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), and SYMBOL_VIEWER_FRAME::FinishModal().

◆ DisplayToolMsg()

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

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 121 of file tools_holder.h.

121 {};

Referenced by TOOLS_HOLDER::PopTool(), and TOOLS_HOLDER::PushTool().

◆ 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 SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 321 of file eda_base_frame.cpp.

 {
     wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden.  Bad programmer!" ) );
 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void SIM_PLOT_FRAME::doCloseWindow ( )

overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 1568 of file sim_plot_frame.cpp.

 {
     if( IsSimulationRunning() )
         m_simulator->Stop();
 
     // Cancel a running simProbe or simTune tool
     m_schematicFrame->GetToolManager()->RunAction( ACTIONS::cancelInteractive );
 
     SaveSettings( config() );
     Destroy();
 }

References ACTIONS::cancelInteractive, EDA_BASE_FRAME::config(), KIWAY_PLAYER::Destroy(), TOOLS_HOLDER::GetToolManager(), IsSimulationRunning(), m_schematicFrame, m_simulator, TOOL_MANAGER::RunAction(), and SaveSettings().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 633 of file eda_base_frame.cpp.

 {
     wxDisplay display( wxDisplay::GetFromWindow( this ) );
     wxRect    clientSize = display.GetClientArea();
     wxPoint   pos        = GetPosition();
     wxSize    size       = GetWindowSize();
 
     wxLogTrace( traceDisplayLocation,
                 "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d", clientSize.x, clientSize.y,
                 clientSize.width, clientSize.height );
 
     if( pos.y < clientSize.y )
     {
         wxLogTrace( traceDisplayLocation,
                     "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d", pos.y,
                     clientSize.y );
         pos.y = clientSize.y;
     }
 
     if( pos.x < clientSize.x )
     {
         wxLogTrace( traceDisplayLocation,
                     "ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d", pos.x,
                     clientSize.x );
         pos.x = clientSize.x;
     }
 
     if( pos.x + size.x - clientSize.x > clientSize.width )
     {
         int newWidth = clientSize.width - ( pos.x - clientSize.x );
         wxLogTrace( traceDisplayLocation,
                     "ensureWindowIsOnScreen: effective width %d above available %d, setting to %d",
                     pos.x + size.x, clientSize.width, newWidth );
         size.x = newWidth;
     }
 
     if( pos.y + size.y - clientSize.y > clientSize.height )
     {
         int newHeight = clientSize.height - ( pos.y - clientSize.y );
         wxLogTrace( traceDisplayLocation,
                     "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d",
                     pos.y + size.y, clientSize.height, newHeight );
         size.y = newHeight;
     }
 
     wxLogTrace( traceDisplayLocation, "Updating window position (%d, %d) with size (%d, %d)",
                 pos.x, pos.y, size.x, size.y );
 
     SetSize( pos.x, pos.y, size.x, size.y );
 }

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::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 SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 196 of file kiway_player.h.

196 {}

Referenced by KIWAY_PLAYER::OnSockRequest().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 828 of file eda_base_frame.cpp.

 {
 #if defined( __WXOSX_MAC__ )
     m_auimgr.Update();
 #else
     // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
     // hiding it.
     m_auimgr.Update();
 
     // We don't want the infobar displayed right away
     m_auimgr.GetPane( "InfoBar" ).Hide();
     m_auimgr.Update();
 #endif
 }

References EDA_BASE_FRAME::m_auimgr.

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 512 of file eda_base_frame.h.

512 { return m_aboutTitle; }

EDA_BASE_FRAME::m_aboutTitle

wxString m_aboutTitle

Definition: eda_base_frame.h:695

References EDA_BASE_FRAME::m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), PGM_SINGLE_TOP::OnPgmInit(), and COMMON_CONTROL::ReportBug().

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )

inlinestaticprotectedinherited

Returns: the string to prepend to a file name for automatic save.

Definition at line 600 of file eda_base_frame.h.

     {
         return wxT( "_autosave-" );
     }

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::OnExportSTEP(), SCH_EDIT_FRAME::SaveEEFile(), and PCB_EDIT_FRAME::SavePcbFile().

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inlineinherited

Definition at line 204 of file eda_base_frame.h.

204 { return m_autoSaveInterval; }

EDA_BASE_FRAME::m_autoSaveInterval

int m_autoSaveInterval

Definition: eda_base_frame.h:711

References EDA_BASE_FRAME::m_autoSaveInterval.

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

Definition at line 438 of file eda_base_frame.h.

438 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

virtual SELECTION& TOOLS_HOLDER::GetCurrentSelection ( )

inlinevirtualinherited

Get the current selection from the canvas area.

Returns: the current selection.

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

Definition at line 101 of file tools_holder.h.

     {
         return m_dummySelection;
     }

References TOOLS_HOLDER::m_dummySelection.

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent(), and ACTION_MANAGER::RunHotKey().

◆ 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 127 of file tools_holder.h.

127 { return m_immediateActions; }

TOOLS_HOLDER::m_immediateActions

bool m_immediateActions

Definition: tools_holder.h:169

References TOOLS_HOLDER::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 133 of file tools_holder.h.

133 { return m_dragAction; }

TOOLS_HOLDER::m_dragAction

MOUSE_DRAG_ACTION m_dragAction

Definition: tools_holder.h:173

References TOOLS_HOLDER::m_dragAction.

Referenced by PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), and PCB_SELECTION_TOOL::Main().

◆ GetExporter()

const NETLIST_EXPORTER_PSPICE_SIM * SIM_PLOT_FRAME::GetExporter ( ) const

Return the netlist exporter object used for simulations.

Definition at line 620 of file sim_plot_frame.cpp.

 {
     return m_exporter.get();
 }

References m_exporter.

Referenced by TUNER_SLIDER::TUNER_SLIDER().

◆ GetFileFromHistory()

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

inherited

Fetches 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 910 of file eda_base_frame.cpp.

 {
     if( !aFileHistory )
         aFileHistory = m_fileHistory;
 
     wxASSERT( aFileHistory );
 
     int baseId = aFileHistory->GetBaseId();
 
     wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
 
     unsigned i = cmdId - baseId;
 
     if( i < aFileHistory->GetCount() )
     {
         wxString fn = aFileHistory->GetHistoryFile( i );
 
         if( wxFileName::FileExists( fn ) )
             return fn;
         else
         {
             wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
             wxMessageBox( msg );
 
             aFileHistory->RemoveFileFromHistory( i );
         }
     }
 
     // Update the menubar to update the file history menu
     if( GetMenuBar() )
     {
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 
     return wxEmptyString;
 }

References _, Format(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), PCB_EDIT_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 422 of file eda_base_frame.h.

     {
         return *m_fileHistory;
     }

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 207 of file eda_base_frame.h.

207 { return m_ident; }

EDA_BASE_FRAME::m_ident

FRAME_T m_ident

Definition: eda_base_frame.h:685

References EDA_BASE_FRAME::m_ident.

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

234 { return m_infoBar; }

EDA_BASE_FRAME::m_infoBar

WX_INFOBAR * m_infoBar

Definition: eda_base_frame.h:700

References EDA_BASE_FRAME::m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), APPEARANCE_CONTROLS::onReadOnlySwatch(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SYMBOL_EDIT_FRAME::SetCurSymbol(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), EDA_BASE_FRAME::ShowInfoBarWarning(), and SCH_DRAWING_TOOLS::SingleClickPlace().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 580 of file eda_base_frame.h.

580 { return m_undoRedoCountMax; }

EDA_BASE_FRAME::m_undoRedoCountMax

int m_undoRedoCountMax

Definition: eda_base_frame.h:714

References EDA_BASE_FRAME::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 139 of file tools_holder.h.

139 { return m_moveWarpsCursor; }

TOOLS_HOLDER::m_moveWarpsCursor

bool m_moveWarpsCursor

Definition: tools_holder.h:175

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 429 of file eda_base_frame.h.

429 { return m_mruPath; }

EDA_BASE_FRAME::m_mruPath

wxString m_mruPath

Definition: eda_base_frame.h:719

References EDA_BASE_FRAME::m_mruPath.

Referenced by AskLoadBoardFileName(), PANEL_HOTKEYS_EDITOR::dumpHotkeys(), GERBVIEW_CONTROL::ExportToPcbnew(), PCB_EDIT_FRAME::Files_io_from_id(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_CONTROL::NewProject(), KICAD_MANAGER_CONTROL::OpenProject(), SCH_EDIT_FRAME::SaveEEFile(), and KICAD_MANAGER_CONTROL::SaveProjectAs().

◆ GetPlotBgOpt()

bool SIM_PLOT_FRAME::GetPlotBgOpt ( ) const

inline

Returns: the current background option for plotting. false for drak bg, true for clear bg

Definition at line 127 of file sim_plot_frame.h.

127 { return m_plotUseWhiteBg; }

SIM_PLOT_FRAME::m_plotUseWhiteBg

bool m_plotUseWhiteBg

Definition: sim_plot_frame.h:365

References m_plotUseWhiteBg.

Referenced by menuWhiteBackground(), and SIM_PLOT_FRAME().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 578 of file eda_base_frame.h.

578 { return m_redoList.m_CommandsList.size(); }

UNDO_REDO_CONTAINER::m_CommandsList

std::vector< PICKED_ITEMS_LIST * > m_CommandsList

Definition: undo_redo_container.h:307

EDA_BASE_FRAME::m_redoList

UNDO_REDO_CONTAINER m_redoList

Definition: eda_base_frame.h:717

References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_redoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), EDA_BASE_FRAME::PushCommandToRedoList(), SCH_EDITOR_CONTROL::Redo(), and EDITOR_CONDITIONS::redoFunc().

◆ GetSettingsManager()

SETTINGS_MANAGER* EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

Definition at line 140 of file eda_base_frame.h.

140 { return m_settingsManager; }

EDA_BASE_FRAME::m_settingsManager

SETTINGS_MANAGER * m_settingsManager

Definition: eda_base_frame.h:705

References EDA_BASE_FRAME::m_settingsManager.

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CreateNewProject(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_PLOT_SCHEMATIC::getColorSettings(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), SCH_EDIT_FRAME::OnImportProject(), GERBER_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_EDIT_FRAME::Save_File(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int aErrorCode ) const

inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME.

Definition at line 142 of file eda_base_frame.h.

142 { return RPT_SEVERITY_UNDEFINED; }

RPT_SEVERITY_UNDEFINED

Definition: ui_common.h:84

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetSimulatorSettings()

std::shared_ptr< SPICE_SIMULATOR_SETTINGS > & SIM_PLOT_FRAME::GetSimulatorSettings ( )

Definition at line 626 of file sim_plot_frame.cpp.

 {
     wxASSERT( m_simulator->Settings() );
 
     return m_simulator->Settings();
 }

References m_simulator.

◆ GetToolCanvas()

wxWindow* SIM_PLOT_FRAME::GetToolCanvas ( ) const

inlineoverridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 136 of file sim_plot_frame.h.

136 { return nullptr; }

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 54 of file tools_holder.h.

54 { return m_toolManager; }

TOOLS_HOLDER::m_toolManager

TOOL_MANAGER * m_toolManager

Definition: tools_holder.h:156

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), BOARD_COMMIT::BOARD_COMMIT(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), doCloseWindow(), DIALOG_GLOBAL_DELETION::doGlobalDeletions(), SCH_FIELD::DoHypertextMenu(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_NAVIGATE_TOOL::HypertextCommand(), ROUTER_TOOL::InlineBreakTrack(), EDA_3D_VIEWER_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), FOOTPRINT_EDIT_FRAME::InstallPreferences(), SYMBOL_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), DIALOG_INSPECTION_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PANEL_PCBNEW_ACTION_PLUGINS::OnOpenDirectoryButtonClick(), onProbe(), PANEL_PCBNEW_ACTION_PLUGINS::OnReloadButtonClick(), DIALOG_ABOUT::onReportBug(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_FIELDS_EDITOR_GLOBAL::OnTableCellClick(), onTune(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), DIALOG_FIND::search(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), DIALOG_NETLIST::~DIALOG_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

46 { return m_type; }

KIWAY_HOLDER::m_type

HOLDER_TYPE m_type

Definition: kiway_holder.h:76

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 577 of file eda_base_frame.h.

577 { return m_undoList.m_CommandsList.size(); }

EDA_BASE_FRAME::m_undoList

UNDO_REDO_CONTAINER m_undoList

Definition: eda_base_frame.h:716

UNDO_REDO_CONTAINER::m_CommandsList

std::vector< PICKED_ITEMS_LIST * > m_CommandsList

Definition: undo_redo_container.h:307

References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_undoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EDA_BASE_FRAME::PushCommandToUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDITOR_CONTROL::Undo(), and EDITOR_CONDITIONS::undoFunc().

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const

inlineinherited

Return the user units currently in use.

Definition at line 126 of file eda_base_frame.h.

     {
         return m_userUnits;
     }

References EDA_BASE_FRAME::m_userUnits.

◆ GetWindowSettings()

WINDOW_SETTINGS * SIM_PLOT_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 296 of file sim_plot_frame.cpp.

 {
     EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( aCfg );
     wxASSERT( cfg );
 
     return cfg ? &cfg->m_Simulator.window : nullptr;
 }

References EESCHEMA_SETTINGS::m_Simulator, and EESCHEMA_SETTINGS::SIMULATOR::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 1207 of file eda_base_frame.cpp.

 {
 #ifdef __WXGTK__
     // GTK includes the window decorations in the normal GetSize call,
     // so we have to use a GTK-specific sizing call that returns the
     // non-decorated window size.
     int width  = 0;
     int height = 0;
     GTKDoGetSize( &width, &height );
 
     wxSize winSize( width, height );
 #else
     wxSize winSize = GetSize();
 #endif
 
     return winSize;
 }

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

◆ GetXAxisType()

SIM_PLOT_TYPE SIM_PLOT_FRAME::GetXAxisType ( SIM_TYPE aType ) const

private

Return X axis for a given simulation type.

Todo:: SPT_LOG_FREQUENCY

Definition at line 1074 of file sim_plot_frame.cpp.

 {
     switch( aType )
     {
         case ST_AC:
             return SPT_LIN_FREQUENCY;
 
         case ST_DC:
             return SPT_SWEEP;
 
         case ST_TRANSIENT:
             return SPT_TIME;
 
         default:
             wxASSERT_MSG( false, "Unhandled simulation type" );
             return (SIM_PLOT_TYPE) 0;
     }
 }

References SPT_LIN_FREQUENCY, SPT_SWEEP, SPT_TIME, ST_AC, ST_DC, and ST_TRANSIENT.

Referenced by addPlot().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

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

Definition at line 1226 of file eda_base_frame.cpp.

 {
     // Update the icon theme when the system theme changes and update the toolbars
     if( GetBitmapStore()->ThemeChanged() )
         ThemeChanged();
 
     // This isn't handled by ThemeChanged()
     if( GetMenuBar() )
     {
         // For icons in menus, icon scaling & hotkeys
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 }

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

Referenced by EDA_BASE_FRAME::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 370 of file eda_base_frame.cpp.

 {
     bool       checkRes  = false;
     bool       enableRes = true;
     bool       showRes   = true;
     SELECTION& selection = aFrame->GetCurrentSelection();
 
     try
     {
         checkRes  = aCond.checkCondition( selection );
         enableRes = aCond.enableCondition( selection );
         showRes   = aCond.showCondition( selection );
     }
     catch( std::exception& )
     {
         // Something broke with the conditions, just skip the event.
         aEvent.Skip();
         return;
     }
 
     aEvent.Enable( enableRes );
     aEvent.Show( showRes );
 
     // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
     // checked, since wxMenuItems don't want to be checked unless they actually are checkable
 #if wxCHECK_VERSION( 3, 1, 5 )
     if( aEvent.IsCheckable() )
         aEvent.Check( checkRes );
 #else
     bool canCheck = true;
 
     // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
     // see if they can be and can't just universally apply a check in this event.
     if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
         canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
 
     if( canCheck )
         aEvent.Check( checkRes );
 #endif
 }

References ACTION_CONDITIONS::checkCondition, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), and ACTION_CONDITIONS::showCondition.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 804 of file eda_base_frame.cpp.

 {
     return Kiface().GetHelpFileName();
 }

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ 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

Sets 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 1117 of file eda_base_frame.cpp.

 {
     wxAcceleratorEntry entries[1];
     entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
     wxAcceleratorTable accel( 1, entries );
     SetAcceleratorTable( accel );
 }

◆ initWorkbook()

void SIM_PLOT_FRAME::initWorkbook ( )

private

Load the currently active workbook stored in the project settings.

If there is none, generate a filename for the currently active workbook and store it in the project settings.

Definition at line 305 of file sim_plot_frame.cpp.

 {
     m_workbook = std::make_unique<SIM_WORKBOOK>();
 
     if( !m_simulator->Settings()->GetWorkbookFilename().IsEmpty() )
     {
         wxFileName filename = m_simulator->Settings()->GetWorkbookFilename();
         filename.SetPath( Prj().GetProjectPath() );
 
         if( !loadWorkbook( filename.GetFullPath() ) )
         {
             // Empty the workbook filename to prevent error messages from appearing again
             m_simulator->Settings()->SetWorkbookFilename( "" );
         }
     }
 }

References loadWorkbook(), m_simulator, m_workbook, and KIWAY_HOLDER::Prj().

Referenced by SIM_PLOT_FRAME().

◆ InstallPreferences()

virtual void EDA_BASE_FRAME::InstallPreferences	(	PAGED_DIALOG *	,
		PANEL_HOTKEYS_EDITOR *
	)

inlinevirtualinherited

Allow a frame to load its preference panels (if any) into the preferences dialog.

Parameters

aParent a paged dialog into which the preference panels should be installed.

Reimplemented in SCH_EDIT_FRAME, PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, PL_EDITOR_FRAME, KICAD_MANAGER_FRAME, and EDA_3D_VIEWER_FRAME.

Definition at line 297 of file eda_base_frame.h.

297 { }

Referenced by EDA_BASE_FRAME::OnPreferences().

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 615 of file eda_base_frame.h.

615 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ 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 SCH_EDIT_FRAME, CVPCB_MAINFRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, SYMBOL_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 1110 of file eda_base_frame.cpp.

 {
     // This function should be overridden in child classes
     return false;
 }

Referenced by GERBVIEW_FRAME::Clear_DrawLayers(), and EDITOR_CONDITIONS::contentModifiedFunc().

◆ IsCurrentTool()

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

inherited

Definition at line 109 of file tools_holder.cpp.

 {
     if( m_toolStack.empty() )
         return &aAction == &ACTIONS::selectionTool;
     else
         return m_toolStack.back() == aAction.GetName();
 }

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

Referenced by SCH_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), and 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 155 of file kiway_player.cpp.

 {
     return !m_modal_loop;
 }

References KIWAY_PLAYER::m_modal_loop.

Referenced by SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), and FOOTPRINT_WIZARD_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 173 of file kiway_player.h.

173 { return m_modal; }

KIWAY_PLAYER::m_modal

bool m_modal

Definition: kiway_player.h:210

References KIWAY_PLAYER::m_modal.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), KIWAY_PLAYER::ShowModal(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ IsSimulationRunning()

bool SIM_PLOT_FRAME::IsSimulationRunning ( )

Definition at line 507 of file sim_plot_frame.cpp.

 {
     return m_simulator ? m_simulator->IsRunning() : false;
 }

References m_simulator.

Referenced by doCloseWindow(), loadWorkbook(), onAddSignal(), onProbe(), onSimFinished(), onSimulate(), and onSimUpdate().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inlineinherited

Definition at line 206 of file eda_base_frame.h.

206 { return m_ident == aType; }

EDA_BASE_FRAME::m_ident

FRAME_T m_ident

Definition: eda_base_frame.h:685

References EDA_BASE_FRAME::m_ident.

◆ IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName & aFileName )

inherited

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

Returns: False if aFileName cannot be written.

Definition at line 1019 of file eda_base_frame.cpp.

 {
     wxString msg;
     wxFileName fn = aFileName;
 
     // Check for absence of a file path with a file name.  Unfortunately KiCad
     // uses paths relative to the current project path without the ./ part which
     // confuses wxFileName. Making the file name path absolute may be less than
     // elegant but it solves the problem.
     if( fn.GetPath().IsEmpty() && fn.HasName() )
         fn.MakeAbsolute();
 
     wxCHECK_MSG( fn.IsOk(), false,
                  wxT( "File name object is invalid.  Bad programmer!" ) );
     wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
                  wxT( "File name object path <" ) + fn.GetFullPath() +
                  wxT( "> is not set.  Bad programmer!" ) );
 
     if( fn.IsDir() && !fn.IsDirWritable() )
     {
         msg.Printf( _( "You do not have write permissions to folder '%s'." ),
                     fn.GetPath() );
     }
     else if( !fn.FileExists() && !fn.IsDirWritable() )
     {
         msg.Printf( _( "You do not have write permissions to save file '%s' to folder '%s'." ),
                     fn.GetFullName(), fn.GetPath() );
     }
     else if( fn.FileExists() && !fn.IsFileWritable() )
     {
         msg.Printf( _( "You do not have write permissions to save file '%s'." ),
                     fn.GetFullPath() );
     }
 
     if( !msg.IsEmpty() )
     {
         wxMessageBox( msg );
         return false;
     }
 
     return true;
 }

References _.

Referenced by SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::SaveEEFile(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProjectSettings().

◆ 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 53 of file kiway_holder.h.

     {
         wxASSERT( m_kiway );    // smoke out bugs in Debug build, then Release runs fine.
         return *m_kiway;
     }

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS & aEvent )

protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 176 of file kiway_player.cpp.

 {
     // logging support
     KiwayMailIn( aEvent );     // call the virtual, override in derived.
 }

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS & aEvent )

virtualinherited

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

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

Definition at line 70 of file kiway_player.cpp.

 {
     // override this in derived classes.
 }

Referenced by KIWAY_PLAYER::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 183 of file kiway_player.cpp.

 {
     int id = event.GetId();
 
     // tell all the KIWAY_PLAYERs about the language change.
     Kiway().SetLanguage( id );
 }

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

◆ LoadSettings()

void SIM_PLOT_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 241 of file sim_plot_frame.cpp.

 {
     EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( aCfg );
     wxASSERT( cfg );
 
     if( cfg )
     {
         EDA_BASE_FRAME::LoadSettings( cfg );
 
         // Read subwindows sizes (should be > 0 )
         m_splitterLeftRightSashPosition      = cfg->m_Simulator.plot_panel_width;
         m_splitterPlotAndConsoleSashPosition = cfg->m_Simulator.plot_panel_height;
         m_splitterSignalsSashPosition        = cfg->m_Simulator.signal_panel_height;
         m_splitterTuneValuesSashPosition     = cfg->m_Simulator.cursors_panel_height;
         m_plotUseWhiteBg                     = cfg->m_Simulator.white_background;
     }
 
     PROJECT_FILE& project = Prj().GetProjectFile();
 
     NGSPICE* currentSim = dynamic_cast<NGSPICE*>( m_simulator.get() );
 
     if( currentSim )
         m_simulator->Settings() = project.m_SchematicSettings->m_NgspiceSimulatorSettings;
 }

References EESCHEMA_SETTINGS::SIMULATOR::cursors_panel_height, PROJECT::GetProjectFile(), EDA_BASE_FRAME::LoadSettings(), m_plotUseWhiteBg, EESCHEMA_SETTINGS::m_Simulator, m_simulator, m_splitterLeftRightSashPosition, m_splitterPlotAndConsoleSashPosition, m_splitterSignalsSashPosition, m_splitterTuneValuesSashPosition, EESCHEMA_SETTINGS::SIMULATOR::plot_panel_height, EESCHEMA_SETTINGS::SIMULATOR::plot_panel_width, KIWAY_HOLDER::Prj(), project, EESCHEMA_SETTINGS::SIMULATOR::signal_panel_height, and EESCHEMA_SETTINGS::SIMULATOR::white_background.

Referenced by SIM_PLOT_FRAME().

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

 {
     LoadWindowState( aCfg->state );
 
     if( m_hasAutoSave )
         m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
 
     m_perspective = aCfg->perspective;
     m_mruPath = aCfg->mru_path;
 
     TOOLS_HOLDER::CommonSettingsChanged( false, false );
 }

References TOOLS_HOLDER::CommonSettingsChanged(), EDA_BASE_FRAME::LoadWindowState(), EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_perspective, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), and WINDOW_SETTINGS::state.

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString & aFileName )

inherited

Definition at line 526 of file eda_base_frame.cpp.

 {
     if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
         return;
 
     const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
 
     if( state != nullptr )
     {
         LoadWindowState( state->window );
     }
 }

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

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

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE & aState )

virtualinherited

Load frame state info from a configuration file.

Definition at line 540 of file eda_base_frame.cpp.

 {
     bool wasDefault = false;
 
     m_framePos.x  = aState.pos_x;
     m_framePos.y  = aState.pos_y;
     m_frameSize.x = aState.size_x;
     m_frameSize.y = aState.size_y;
 
     wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
                 m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
     // Ensure minimum size is set if the stored config was zero-initialized
     if( m_frameSize.x < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
     {
         m_frameSize = defaultSize( m_ident );
         wasDefault  = true;
 
         wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_frameSize.x, m_frameSize.y );
     }
 
     wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
 
     if( aState.display >= wxDisplay::GetCount() )
     {
         wxLogTrace( traceDisplayLocation, "Previous display not found" );
 
         // If it isn't attached, use the first display
         // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
         const unsigned int index = 0;
         wxDisplay display( index );
         wxRect    clientSize = display.GetGeometry();
 
         m_framePos = wxDefaultPosition;
 
         // Ensure the window fits on the display, since the other one could have been larger
         if( m_frameSize.x > clientSize.width )
             m_frameSize.x = clientSize.width;
 
         if( m_frameSize.y > clientSize.height )
             m_frameSize.y = clientSize.height;
     }
     else
     {
         wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
         wxPoint upperLeft( m_framePos.x, m_framePos.y );
 
         wxDisplay display( aState.display );
         wxRect clientSize = display.GetClientArea();
 
         int yLimTop   = clientSize.y;
         int yLimBottom = clientSize.y + clientSize.height;
         int xLimLeft  = clientSize.x;
         int xLimRight = clientSize.x + clientSize.width;
 
         if( upperLeft.x  > xLimRight ||  // Upper left corner too close to right edge of screen
             upperRight.x < xLimLeft  ||  // Upper right corner too close to left edge of screen
             upperLeft.y < yLimTop ||   // Upper corner too close to the bottom of the screen
             upperLeft.y > yLimBottom )
         {
             m_framePos = wxDefaultPosition;
             wxLogTrace( traceDisplayLocation, "Resetting to default position" );
         }
     }
 
     wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
                 m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
     SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
     // Center the window if we reset to default
     if( m_framePos.x == -1 )
     {
         wxLogTrace( traceDisplayLocation, "Centering window" );
         Center();
         m_framePos = GetPosition();
     }
 
     // Record the frame sizes in an un-maximized state
     m_normalFrameSize = m_frameSize;
     m_normalFramePos  = m_framePos;
 
     // Maximize if we were maximized before
     if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
     {
         wxLogTrace( traceDisplayLocation, "Maximizing window" );
         Maximize();
     }
 
     m_displayIndex = wxDisplay::GetFromWindow( this );
 }

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

◆ loadWorkbook()

bool SIM_PLOT_FRAME::loadWorkbook ( const wxString & aPath )

private

Load plot settings from a file.

Parameters

aPath is the file name.

Returns: True if successful.

Definition at line 929 of file sim_plot_frame.cpp.

 {
     m_workbook->Clear();
     m_plotNotebook->DeleteAllPages();
 
     wxTextFile file( aPath );
 
     if( !file.Open() )
     {
         updateFrame();
         return false;
     }
 
     long plotsCount;
 
     if( !file.GetFirstLine().ToLong( &plotsCount ) )        // GetFirstLine instead of GetNextLine
     {
         file.Close();
         updateFrame();
         return false;
     }
 
     for( long i = 0; i < plotsCount; ++i )
     {
         long plotType, tracesCount;
 
         if( !file.GetNextLine().ToLong( &plotType ) )
         {
             updateFrame();
             return false;
         }
 
         wxString        simCommand = file.GetNextLine();
         NewPlotPanel( simCommand );
         StartSimulation( simCommand );
 
         // Perform simulation, so plots can be added with values
         do
         {
             wxThread::This()->Sleep( 50 );
         }
         while( IsSimulationRunning() );
 
         if( !file.GetNextLine().ToLong( &tracesCount ) )
         {
             updateFrame();
             return false;
         }
 
         for( long j = 0; j < tracesCount; ++j )
         {
             long traceType;
             wxString name, param;
 
             if( !file.GetNextLine().ToLong( &traceType ) )
             {
                 file.Close();
                 updateFrame();
                 return false;
             }
 
             name = file.GetNextLine();
             param = file.GetNextLine();
 
             if( name.IsEmpty() || param.IsEmpty() )
             {
                 file.Close();
                 updateFrame();
                 return false;
             }
 
             addPlot( name, (SIM_PLOT_TYPE) traceType, param );
         }
     }
 
     file.Close();
 
     // Successfully loading a workbook does not count as modyfying it.
     m_workbook->ClrModified();
 
     updateFrame();
     return true;
 }

References addPlot(), IsSimulationRunning(), SIM_PLOT_FRAME_BASE::m_plotNotebook, m_workbook, name, NewPlotPanel(), StartSimulation(), and updateFrame().

Referenced by initWorkbook(), and menuOpenWorkbook().

◆ m_splitterLeftRightOnIdle()

void SIM_PLOT_FRAME_BASE::m_splitterLeftRightOnIdle ( wxIdleEvent & )

inlineinherited

Definition at line 127 of file sim_plot_frame_base.h.

         {
             m_splitterLeftRight->SetSashPosition( 700 );
             m_splitterLeftRight->Disconnect( wxEVT_IDLE, wxIdleEventHandler( SIM_PLOT_FRAME_BASE::m_splitterLeftRightOnIdle ), NULL, this );
         }

References SIM_PLOT_FRAME_BASE::m_splitterLeftRight, and NULL.

Referenced by SIM_PLOT_FRAME_BASE::SIM_PLOT_FRAME_BASE().

◆ m_splitterPlotAndConsoleOnIdle()

void SIM_PLOT_FRAME_BASE::m_splitterPlotAndConsoleOnIdle ( wxIdleEvent & )

inlineinherited

Definition at line 133 of file sim_plot_frame_base.h.

         {
             m_splitterPlotAndConsole->SetSashPosition( 500 );
             m_splitterPlotAndConsole->Disconnect( wxEVT_IDLE, wxIdleEventHandler( SIM_PLOT_FRAME_BASE::m_splitterPlotAndConsoleOnIdle ), NULL, this );
         }

References SIM_PLOT_FRAME_BASE::m_splitterPlotAndConsole, and NULL.

Referenced by SIM_PLOT_FRAME_BASE::SIM_PLOT_FRAME_BASE().

◆ m_splitterSignalsOnIdle()

void SIM_PLOT_FRAME_BASE::m_splitterSignalsOnIdle ( wxIdleEvent & )

inlineinherited

Definition at line 139 of file sim_plot_frame_base.h.

         {
             m_splitterSignals->SetSashPosition( 0 );
             m_splitterSignals->Disconnect( wxEVT_IDLE, wxIdleEventHandler( SIM_PLOT_FRAME_BASE::m_splitterSignalsOnIdle ), NULL, this );
         }

References SIM_PLOT_FRAME_BASE::m_splitterSignals, and NULL.

Referenced by SIM_PLOT_FRAME_BASE::SIM_PLOT_FRAME_BASE().

◆ m_splitterTuneValuesOnIdle()

void SIM_PLOT_FRAME_BASE::m_splitterTuneValuesOnIdle ( wxIdleEvent & )

inlineinherited

Definition at line 145 of file sim_plot_frame_base.h.

         {
             m_splitterTuneValues->SetSashPosition( 0 );
             m_splitterTuneValues->Disconnect( wxEVT_IDLE, wxIdleEventHandler( SIM_PLOT_FRAME_BASE::m_splitterTuneValuesOnIdle ), NULL, this );
         }

References SIM_PLOT_FRAME_BASE::m_splitterTuneValues, and NULL.

Referenced by SIM_PLOT_FRAME_BASE::SIM_PLOT_FRAME_BASE().

◆ menuExit()

void SIM_PLOT_FRAME::menuExit ( wxCommandEvent & event )

inlineoverrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 253 of file sim_plot_frame.h.

     {
         Close();
     }

◆ menuNewPlot()

void SIM_PLOT_FRAME::menuNewPlot ( wxCommandEvent & aEvent )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1095 of file sim_plot_frame.cpp.

 {
     SIM_TYPE type = m_exporter->GetSimType();
 
     if( SIM_PANEL_BASE::IsPlottable( type ) )
     {
         NewPlotPanel( m_exporter->GetUsedSimCommand() );
         updateFrame();
     }
 }

References SIM_PANEL_BASE::IsPlottable(), m_exporter, NewPlotPanel(), and updateFrame().

◆ menuOpenWorkbook()

void SIM_PLOT_FRAME::menuOpenWorkbook ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1107 of file sim_plot_frame.cpp.

 {
     wxFileDialog openDlg( this, _( "Open simulation workbook" ), m_savedWorkbooksPath, "",
                           WorkbookFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST );
 
     if( openDlg.ShowModal() == wxID_CANCEL )
         return;
 
     m_savedWorkbooksPath = openDlg.GetDirectory();
 
     if( !loadWorkbook( openDlg.GetPath() ) )
         DisplayErrorMessage( this, _( "There was an error while opening the workbook file" ) );
 }

References _, DisplayErrorMessage(), loadWorkbook(), m_savedWorkbooksPath, and WorkbookFileWildcard().

◆ menuSaveCsv()

void SIM_PLOT_FRAME::menuSaveCsv ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1175 of file sim_plot_frame.cpp.

 {
     if( !CurrentPlot() )
         return;
 
     const wxChar SEPARATOR = ';';
 
     wxFileDialog saveDlg( this, _( "Save Plot Data" ), "", "",
                           CsvFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
     if( saveDlg.ShowModal() == wxID_CANCEL )
         return;
 
     wxFFile out( saveDlg.GetPath(), "wb" );
     bool timeWritten = false;
 
     for( const auto& t : CurrentPlot()->GetTraces() )
     {
         const TRACE* trace = t.second;
 
         if( !timeWritten )
         {
             out.Write( wxString::Format( "Time%c", SEPARATOR ) );
 
             for( double v : trace->GetDataX() )
                 out.Write( wxString::Format( "%g%c", v, SEPARATOR ) );
 
             out.Write( "\r\n" );
             timeWritten = true;
         }
 
         out.Write( wxString::Format( "%s%c", t.first, SEPARATOR ) );
 
         for( double v : trace->GetDataY() )
             out.Write( wxString::Format( "%g%c", v, SEPARATOR ) );
 
         out.Write( "\r\n" );
     }
 
     out.Close();
 }

References _, CsvFileWildcard(), CurrentPlot(), Format(), TRACE::GetDataX(), TRACE::GetDataY(), and SIM_PLOT_PANEL::GetTraces().

◆ menuSaveImage()

void SIM_PLOT_FRAME::menuSaveImage ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1160 of file sim_plot_frame.cpp.

 {
     if( !CurrentPlot() )
         return;
 
     wxFileDialog saveDlg( this, _( "Save Plot as Image" ), "", "",
                           PngFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
     if( saveDlg.ShowModal() == wxID_CANCEL )
         return;
 
     CurrentPlot()->GetPlotWin()->SaveScreenshot( saveDlg.GetPath(), wxBITMAP_TYPE_PNG );
 }

References _, CurrentPlot(), SIM_PLOT_PANEL::GetPlotWin(), PngFileWildcard(), and mpWindow::SaveScreenshot().

◆ menuSaveWorkbook()

void SIM_PLOT_FRAME::menuSaveWorkbook ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1122 of file sim_plot_frame.cpp.

 {
     if( !m_workbook->IsModified() )
         return;
 
     wxString filename = m_simulator->Settings()->GetWorkbookFilename();
 
     if( filename.IsEmpty() )
     {
         menuSaveWorkbookAs( event );
         return;
     }
 
     if ( !saveWorkbook( Prj().AbsolutePath( m_simulator->Settings()->GetWorkbookFilename() ) ) )
         DisplayErrorMessage( this, _( "There was an error while saving the workbook file" ) );
 }

References _, DisplayErrorMessage(), m_simulator, m_workbook, menuSaveWorkbookAs(), KIWAY_HOLDER::Prj(), and saveWorkbook().

◆ menuSaveWorkbookAs()

void SIM_PLOT_FRAME::menuSaveWorkbookAs ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1140 of file sim_plot_frame.cpp.

 {
     wxString defaultFilename = m_simulator->Settings()->GetWorkbookFilename();
 
     if( defaultFilename.IsEmpty() )
         defaultFilename = Prj().GetProjectName() + wxT( ".wbk" );
 
     wxFileDialog saveAsDlg( this, _( "Save Simulation Workbook As" ), m_savedWorkbooksPath,
             defaultFilename, WorkbookFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
     if( saveAsDlg.ShowModal() == wxID_CANCEL )
         return;
 
     m_savedWorkbooksPath = saveAsDlg.GetDirectory();
 
     if( !saveWorkbook( saveAsDlg.GetPath() ) )
         DisplayErrorMessage( this, _( "There was an error while saving the workbook file" ) );
 }

References _, DisplayErrorMessage(), PROJECT::GetProjectName(), m_savedWorkbooksPath, m_simulator, KIWAY_HOLDER::Prj(), saveWorkbook(), and WorkbookFileWildcard().

Referenced by menuSaveWorkbook().

◆ menuShowDotted()

void SIM_PLOT_FRAME::menuShowDotted ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1272 of file sim_plot_frame.cpp.

 {
     SIM_PLOT_PANEL* plot = CurrentPlot();
 
     if( plot )
         plot->SetDottedCurrentPhase( !plot->GetDottedCurrentPhase() );
 }

References CurrentPlot(), and plot.

◆ menuShowDottedUpdate()

void SIM_PLOT_FRAME::menuShowDottedUpdate ( wxUpdateUIEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1281 of file sim_plot_frame.cpp.

 {
     SIM_PLOT_PANEL* plot = CurrentPlot();
 
     event.Check( plot ? plot->GetDottedCurrentPhase() : false );
 }

References CurrentPlot(), and plot.

◆ menuShowGrid()

void SIM_PLOT_FRAME::menuShowGrid ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1239 of file sim_plot_frame.cpp.

 {
     SIM_PLOT_PANEL* plot = CurrentPlot();
 
     if( plot )
         plot->ShowGrid( !plot->IsGridShown() );
 }

References CurrentPlot(), and plot.

◆ menuShowGridUpdate()

void SIM_PLOT_FRAME::menuShowGridUpdate ( wxUpdateUIEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1248 of file sim_plot_frame.cpp.

 {
     SIM_PLOT_PANEL* plot = CurrentPlot();
 
     event.Check( plot ? plot->IsGridShown() : false );
 }

References CurrentPlot(), and plot.

◆ menuShowLegend()

void SIM_PLOT_FRAME::menuShowLegend ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1256 of file sim_plot_frame.cpp.

 {
     SIM_PLOT_PANEL* plot = CurrentPlot();
 
     if( plot )
         plot->ShowLegend( !plot->IsLegendShown() );
 }

References CurrentPlot(), and plot.

◆ menuShowLegendUpdate()

void SIM_PLOT_FRAME::menuShowLegendUpdate ( wxUpdateUIEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1265 of file sim_plot_frame.cpp.

 {
     SIM_PLOT_PANEL* plot = CurrentPlot();
     event.Check( plot ? plot->IsLegendShown() : false );
 }

References CurrentPlot(), and plot.

◆ menuShowWhiteBackgroundUpdate()

void SIM_PLOT_FRAME::menuShowWhiteBackgroundUpdate ( wxUpdateUIEvent & event )

inlineoverrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 270 of file sim_plot_frame.h.

     {
         event.Check( m_plotUseWhiteBg );
     }

References m_plotUseWhiteBg.

◆ menuWhiteBackground()

void SIM_PLOT_FRAME::menuWhiteBackground ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1289 of file sim_plot_frame.cpp.

 {
     m_plotUseWhiteBg = not m_plotUseWhiteBg;
 
     // Rebuild the color list to plot traces
     SIM_PLOT_COLORS::FillDefaultColorList( GetPlotBgOpt() );
 
     // Now send changes to all SIM_PLOT_PANEL
     for( size_t page = 0; page < m_plotNotebook->GetPageCount(); page++ )
     {
         wxWindow* curPage = m_plotNotebook->GetPage( page );
 
         // ensure it is truly a plot panel and not the (zero plots) placeholder
         // which is only SIM_PLOT_PANEL_BASE
         SIM_PLOT_PANEL* panel = dynamic_cast<SIM_PLOT_PANEL*>( curPage );
 
         if( panel != nullptr )
         {
             panel->UpdatePlotColors();
         }
     }
 }

References SIM_PLOT_COLORS::FillDefaultColorList(), GetPlotBgOpt(), SIM_PLOT_FRAME_BASE::m_plotNotebook, m_plotUseWhiteBg, and SIM_PLOT_PANEL::UpdatePlotColors().

◆ menuZoomFit()

void SIM_PLOT_FRAME::menuZoomFit ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1232 of file sim_plot_frame.cpp.

 {
     if( CurrentPlot() )
         CurrentPlot()->GetPlotWin()->Fit();
 }

References CurrentPlot(), mpWindow::Fit(), and SIM_PLOT_PANEL::GetPlotWin().

◆ menuZoomIn()

void SIM_PLOT_FRAME::menuZoomIn ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1218 of file sim_plot_frame.cpp.

 {
     if( CurrentPlot() )
         CurrentPlot()->GetPlotWin()->ZoomIn();
 }

References CurrentPlot(), SIM_PLOT_PANEL::GetPlotWin(), and mpWindow::ZoomIn().

◆ menuZoomOut()

void SIM_PLOT_FRAME::menuZoomOut ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1225 of file sim_plot_frame.cpp.

 {
     if( CurrentPlot() )
         CurrentPlot()->GetPlotWin()->ZoomOut();
 }

References CurrentPlot(), SIM_PLOT_PANEL::GetPlotWin(), and mpWindow::ZoomOut().

◆ NewPlotPanel()

SIM_PANEL_BASE * SIM_PLOT_FRAME::NewPlotPanel ( wxString aSimCommand )

Create a new plot panel for a given simulation type and adds it to the main notebook.

Parameters

aSimType is requested simulation type.

Returns: The new plot panel.

Definition at line 513 of file sim_plot_frame.cpp.

 {
     SIM_PANEL_BASE* plotPanel = nullptr;
     SIM_TYPE        simType   = NETLIST_EXPORTER_PSPICE_SIM::CommandToSimType( aSimCommand );
 
     if( SIM_PANEL_BASE::IsPlottable( simType ) )
     {
         SIM_PLOT_PANEL* panel;
         panel = new SIM_PLOT_PANEL( aSimCommand, m_plotNotebook, this, wxID_ANY );
 
         panel->GetPlotWin()->EnableMouseWheelPan(
                 Pgm().GetCommonSettings()->m_Input.scroll_modifier_zoom != 0 );
 
         plotPanel = dynamic_cast<SIM_PANEL_BASE*>( panel );
     }
     else
     {
         SIM_NOPLOT_PANEL* panel;
         panel = new SIM_NOPLOT_PANEL( aSimCommand, m_plotNotebook, wxID_ANY );
         plotPanel = dynamic_cast<SIM_PANEL_BASE*>( panel );
     }
 
     wxString pageTitle( m_simulator->TypeToName( simType, true ) );
     pageTitle.Prepend( wxString::Format( _( "Plot%u - " ), (unsigned int) ++m_plotNumber ) );
 
     m_workbook->AddPlotPanel( plotPanel );
 
     m_plotNotebook->AddPage( dynamic_cast<wxWindow*>( plotPanel ), pageTitle, true );
 
     updateFrame();
     return plotPanel;
 }

References _, NETLIST_EXPORTER_PSPICE_SIM::CommandToSimType(), mpWindow::EnableMouseWheelPan(), Format(), SIM_PLOT_PANEL::GetPlotWin(), SIM_PANEL_BASE::IsPlottable(), SIM_PLOT_FRAME_BASE::m_plotNotebook, m_plotNumber, m_simulator, m_workbook, Pgm(), and updateFrame().

Referenced by addPlot(), loadWorkbook(), menuNewPlot(), onSettings(), and onSimFinished().

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce )

inlineinherited

Definition at line 582 of file eda_base_frame.h.

     {
         m_isNonUserClose = true;
         return Close( aForce );
     }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onAddSignal()

void SIM_PLOT_FRAME::onAddSignal ( wxCommandEvent & event )

private

Definition at line 1444 of file sim_plot_frame.cpp.

 {
     if( IsSimulationRunning() )
     {
         DisplayInfoMessage( this, _( "Simulator is running. Try later" ) );
         return;
     }
 
     SIM_PLOT_PANEL* plotPanel = CurrentPlot();
 
     if( !plotPanel || !m_exporter || plotPanel->GetType() != m_exporter->GetSimType() )
     {
         DisplayInfoMessage( this, _( "You need to run plot-providing simulation first." ) );
         return;
     }
 
     DIALOG_SIGNAL_LIST dialog( this, m_exporter.get() );
     dialog.ShowModal();
 }

References _, CurrentPlot(), DisplayInfoMessage(), SIM_PANEL_BASE::GetType(), IsSimulationRunning(), and m_exporter.

Referenced by SIM_PLOT_FRAME().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protectedinherited

Handle the auto save timer event.

Definition at line 314 of file eda_base_frame.cpp.

 {
     if( !doAutoSave() )
         m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
 }

References EDA_BASE_FRAME::doAutoSave(), EDA_BASE_FRAME::m_autoSaveInterval, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by EDA_BASE_FRAME::commonInit().

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

Definition at line 327 of file eda_base_frame.cpp.

 {
     wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( aKeyEvent ) );
 
     // Key events can be filtered here.
     // Currently no filtering is made.
     aKeyEvent.Skip();
 }

References dump(), and kicadTraceKeyEvent.

◆ onCursorUpdate()

void SIM_PLOT_FRAME::onCursorUpdate ( wxCommandEvent & aEvent )

private

Definition at line 1581 of file sim_plot_frame.cpp.

 {
     wxSize size = m_cursors->GetClientSize();
     SIM_PLOT_PANEL* plotPanel = CurrentPlot();
     m_cursors->ClearAll();
 
     if( !plotPanel )
         return;
 
     if( m_signalsIconColorList )
         m_cursors->SetImageList(m_signalsIconColorList, wxIMAGE_LIST_SMALL);
 
     // Fill the signals listctrl
     m_cursors->AppendColumn( _( "Signal" ), wxLIST_FORMAT_LEFT, size.x / 2 );
     const long X_COL = m_cursors->AppendColumn( plotPanel->GetLabelX(), wxLIST_FORMAT_LEFT,
                                                 size.x / 4 );
 
     wxString labelY1 = plotPanel->GetLabelY1();
     wxString labelY2 = plotPanel->GetLabelY2();
     wxString labelY;
 
     if( !labelY2.IsEmpty() )
         labelY = labelY1 + " / " + labelY2;
     else
         labelY = labelY1;
 
     const long Y_COL = m_cursors->AppendColumn( labelY, wxLIST_FORMAT_LEFT, size.x / 4 );
 
     // Update cursor values
     int itemidx = 0;
 
     for( const auto& trace : plotPanel->GetTraces() )
     {
         if( CURSOR* cursor = trace.second->GetCursor() )
         {
            // Find the right icon color in list.
             // It is the icon used in m_signals list for the same trace
             long iconColor = m_signals->FindItem( -1, trace.first );
 
             const wxRealPoint coords = cursor->GetCoords();
             long idx = m_cursors->InsertItem( itemidx++, trace.first, iconColor );
             m_cursors->SetItem( idx, X_COL, SPICE_VALUE( coords.x ).ToSpiceString() );
             m_cursors->SetItem( idx, Y_COL, SPICE_VALUE( coords.y ).ToSpiceString() );
         }
     }
 }

References _, CurrentPlot(), cursor, SIM_PLOT_PANEL::GetLabelX(), SIM_PLOT_PANEL::GetLabelY1(), SIM_PLOT_PANEL::GetLabelY2(), SIM_PLOT_PANEL::GetTraces(), SIM_PLOT_FRAME_BASE::m_cursors, SIM_PLOT_FRAME_BASE::m_signals, m_signalsIconColorList, and SPICE_VALUE::ToSpiceString().

Referenced by onPlotChanged(), onPlotClose(), removePlot(), and SIM_PLOT_FRAME().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

Definition at line 968 of file eda_base_frame.cpp.

 {
     void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
     ShowAboutDialog( this );
 }

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

inherited

Definition at line 1185 of file eda_base_frame.cpp.

 {
     // When we maximize the window, we want to save the old information
     // so that we can add it to the settings on next window load.
     // Contrary to the documentation, this event seems to be generated
     // when the window is also being unmaximized on OSX, so we only
     // capture the size information when we maximize the window when on OSX.
 #ifdef __WXOSX__
     if( !IsMaximized() )
 #endif
     {
         m_normalFrameSize = GetWindowSize();
         m_normalFramePos  = GetPosition();
         wxLogTrace( traceDisplayLocation, "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
                     m_normalFramePos.x, m_normalFramePos.y, m_normalFrameSize.x, m_normalFrameSize.y );
     }
 
     // Skip event to actually maximize the window
     aEvent.Skip();
 }

References EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::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 337 of file eda_base_frame.cpp.

 {
     if( !m_toolDispatcher )
         aEvent.Skip();
     else
         m_toolDispatcher->DispatchWxEvent( aEvent );
 }

References TOOL_DISPATCHER::DispatchWxEvent(), and TOOLS_HOLDER::m_toolDispatcher.

◆ OnMove()

virtual void EDA_BASE_FRAME::OnMove ( wxMoveEvent & aEvent )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 193 of file eda_base_frame.h.

     {
         aEvent.Skip();
     }

◆ onPlotChanged()

void SIM_PLOT_FRAME::onPlotChanged ( wxAuiNotebookEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1336 of file sim_plot_frame.cpp.

 {
     updateSignalList();
     wxCommandEvent dummy;
     onCursorUpdate( dummy );
 
     updateWorkbook();
     updateFrame();
 }

References dummy(), onCursorUpdate(), updateFrame(), updateSignalList(), and updateWorkbook().

◆ onPlotClose()

void SIM_PLOT_FRAME::onPlotClose ( wxAuiNotebookEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1313 of file sim_plot_frame.cpp.

 {
     int idx = event.GetSelection();
 
     if( idx == wxNOT_FOUND )
         return;
 
     SIM_PANEL_BASE* plotPanel =
             dynamic_cast<SIM_PANEL_BASE*>( m_plotNotebook->GetPage( idx ) );
 
     m_workbook->RemovePlotPanel( plotPanel );
     wxCommandEvent dummy;
     onCursorUpdate( dummy );
 }

References dummy(), SIM_PLOT_FRAME_BASE::m_plotNotebook, m_workbook, and onCursorUpdate().

◆ onPlotClosed()

void SIM_PLOT_FRAME::onPlotClosed ( wxAuiNotebookEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1329 of file sim_plot_frame.cpp.

 {
     updateWorkbook();
     updateFrame();
 }

References updateFrame(), and updateWorkbook().

◆ onPlotDragged()

void SIM_PLOT_FRAME::onPlotDragged ( wxAuiNotebookEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1347 of file sim_plot_frame.cpp.

 {
     updateWorkbook();
     updateFrame();
 }

References updateFrame(), and updateWorkbook().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

inherited

Displays the preferences and settings of all opened editors paged dialog.

Definition at line 975 of file eda_base_frame.cpp.

 {
     PAGED_DIALOG dlg( this, _( "Preferences" ), true );
     wxTreebook* book = dlg.GetTreebook();
 
     book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
 
     book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
 
     PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
     book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
 
     wxWindow* viewer3D = nullptr;
 
     for( unsigned i = 0; i < KIWAY_PLAYER_COUNT;  ++i )
     {
         KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
 
         if( frame )
         {
             frame->InstallPreferences( &dlg, hotkeysPanel );
 
             if( !viewer3D )
                 viewer3D = wxFindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( frame ) );
         }
     }
 
     if( viewer3D )
         static_cast<EDA_BASE_FRAME*>( viewer3D )->InstallPreferences( &dlg, hotkeysPanel );
 
     // The Kicad manager frame is not a player so we have to add it by hand
     wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
 
     if( manager )
         static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
 
     for( size_t i = 0; i < book->GetPageCount(); ++i )
         book->GetPage( i )->Layout();
 
     if( dlg.ShowModal() == wxID_OK )
         dlg.Kiway().CommonSettingsChanged( false, false );
 }

References _, KIWAY::CommonSettingsChanged(), PAGED_DIALOG::GetTreebook(), EDA_BASE_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME_NAME, KIWAY_HOLDER::Kiway(), KIWAY_PLAYER_COUNT, KIWAY::Player(), and QUALIFIED_VIEWER3D_FRAMENAME.

Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch(), and COMMON_CONTROL::OpenPreferences().

◆ onProbe()

void SIM_PLOT_FRAME::onProbe ( wxCommandEvent & event )

private

Definition at line 1465 of file sim_plot_frame.cpp.

 {
     if( m_schematicFrame == NULL )
         return;
 
     if( IsSimulationRunning() )
     {
         DisplayInfoMessage( this, _( "Simulator is running. Try later" ) );
         return;
     }
 
     m_schematicFrame->GetToolManager()->RunAction( EE_ACTIONS::simProbe );
     m_schematicFrame->Raise();
 }

References _, DisplayInfoMessage(), TOOLS_HOLDER::GetToolManager(), IsSimulationRunning(), m_schematicFrame, NULL, TOOL_MANAGER::RunAction(), and EE_ACTIONS::simProbe.

Referenced by SIM_PLOT_FRAME().

◆ onSettings()

void SIM_PLOT_FRAME::onSettings ( wxCommandEvent & event )

private

Definition at line 1391 of file sim_plot_frame.cpp.

 {
     SIM_PANEL_BASE* plotPanelWindow = currentPlotWindow();
 
     if( !m_settingsDlg )
         m_settingsDlg = new DIALOG_SIM_SETTINGS( this, m_simulator->Settings() );
 
     // Initial processing is required to e.g. display a list of power sources
     updateNetlistExporter();
 
     if( !m_exporter->ProcessNetlist( NET_ALL_FLAGS ) )
     {
         DisplayErrorMessage( this, _( "There were errors during netlist export, aborted." ) );
         return;
     }
 
     if( m_workbook->HasPlotPanel( plotPanelWindow ) )
         m_settingsDlg->SetSimCommand( plotPanelWindow->GetSimCommand() );
 
     if( m_settingsDlg->ShowModal() == wxID_OK )
     {
         wxString oldCommand;
 
         if( m_workbook->HasPlotPanel( plotPanelWindow ) )
             oldCommand = plotPanelWindow->GetSimCommand();
         else
             oldCommand = wxString();
 
         wxString newCommand = m_settingsDlg->GetSimCommand();
         SIM_TYPE newSimType = NETLIST_EXPORTER_PSPICE_SIM::CommandToSimType( newCommand );
 
         // If it is a new simulation type, open a new plot
         // For the DC sim, check if sweep source type has changed (char 4 will contain 'v',
         // 'i', 'r' or 't'.
         if( !plotPanelWindow
             || ( plotPanelWindow && plotPanelWindow->GetType() != newSimType )
             || ( newSimType == ST_DC
                  && oldCommand.Lower().GetChar( 4 ) != newCommand.Lower().GetChar( 4 ) ) )
         {
             plotPanelWindow = NewPlotPanel( newCommand );
         }
         else
         {
             // Update simulation command in the current plot
             plotPanelWindow->SetSimCommand( newCommand );
         }
 
         m_simulator->Init();
         updateFrame();
     }
 }

References _, NETLIST_EXPORTER_PSPICE_SIM::CommandToSimType(), currentPlotWindow(), DisplayErrorMessage(), DIALOG_SIM_SETTINGS::GetSimCommand(), SIM_PANEL_BASE::GetSimCommand(), SIM_PANEL_BASE::GetType(), m_exporter, m_settingsDlg, m_simulator, m_workbook, NET_ALL_FLAGS, NewPlotPanel(), DIALOG_SIM_SETTINGS::SetSimCommand(), SIM_PANEL_BASE::SetSimCommand(), DIALOG_SIM_SETTINGS::ShowModal(), ST_DC, updateFrame(), and updateNetlistExporter().

Referenced by SIM_PLOT_FRAME().

◆ onShowNetlist()

void SIM_PLOT_FRAME::onShowNetlist ( wxCommandEvent & event )

private

Definition at line 1491 of file sim_plot_frame.cpp.

 {
     class NETLIST_VIEW_DIALOG : public DIALOG_SHIM
     {
     public:
         enum
         {
             MARGIN_LINE_NUMBERS
         };
 
         void onClose( wxCloseEvent& evt )
         {
             EndModal( GetReturnCode() );
         }
 
         NETLIST_VIEW_DIALOG( wxWindow* parent, wxString source) :
             DIALOG_SHIM( parent, wxID_ANY, "SPICE Netlist",
                          wxDefaultPosition, wxDefaultSize,
                          wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER )
         {
             wxStyledTextCtrl* text = new wxStyledTextCtrl( this, wxID_ANY );
             text->SetMinSize( wxSize( 600, 400 ) );
 
             text->SetMarginWidth( MARGIN_LINE_NUMBERS, 50 );
             text->StyleSetForeground( wxSTC_STYLE_LINENUMBER, wxColour( 75, 75, 75 ) );
             text->StyleSetBackground( wxSTC_STYLE_LINENUMBER, wxColour( 220, 220, 220 ) );
             text->SetMarginType( MARGIN_LINE_NUMBERS, wxSTC_MARGIN_NUMBER );
 
             wxFont font = wxFont( wxNORMAL_FONT->GetPointSize(), wxFONTFAMILY_TELETYPE,
                     wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL, false, wxEmptyString );
             text->StyleSetFont( wxSTC_STYLE_DEFAULT, font );
 
             text->SetWrapMode( wxSTC_WRAP_WORD );
 
             text->SetText( source );
 
             text->StyleClearAll();
             text->SetLexer( wxSTC_LEX_SPICE );
 
             wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
             sizer->Add( text, 1, wxEXPAND );
             SetSizer( sizer );
 
             Connect( wxEVT_CLOSE_WINDOW, wxCloseEventHandler( NETLIST_VIEW_DIALOG::onClose ), NULL,
                      this );
 
             finishDialogSettings();
         }
     };
 
     if( m_schematicFrame == NULL || m_simulator == NULL )
         return;
 
     NETLIST_VIEW_DIALOG dlg( this, m_simulator->GetNetlist() );
     dlg.ShowModal();
 }

References m_schematicFrame, m_simulator, NULL, and text.

Referenced by SIM_PLOT_FRAME().

◆ onSignalDblClick()

void SIM_PLOT_FRAME::onSignalDblClick ( wxMouseEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1354 of file sim_plot_frame.cpp.

 {
     // Remove signal from the plot panel when double clicked
     long idx = m_signals->GetFocusedItem();
 
     if( idx != wxNOT_FOUND )
         removePlot( m_signals->GetItemText( idx, 0 ) );
 }

References SIM_PLOT_FRAME_BASE::m_signals, and removePlot().

◆ onSignalRClick()

void SIM_PLOT_FRAME::onSignalRClick ( wxListEvent & event )

overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1364 of file sim_plot_frame.cpp.

 {
     int idx = event.GetIndex();
 
     if( idx != wxNOT_FOUND )
         m_signals->Select( idx );
 
     idx = m_signals->GetFirstSelected();
 
     if( idx != wxNOT_FOUND )
     {
         const wxString& netName = m_signals->GetItemText( idx, 0 );
         SIGNAL_CONTEXT_MENU ctxMenu( netName, this );
         m_signals->PopupMenu( &ctxMenu );
     }
 }

References SIM_PLOT_FRAME_BASE::m_signals.

◆ onSimFinished()

void SIM_PLOT_FRAME::onSimFinished ( wxCommandEvent & aEvent )

private

< Name of the measured net/device

< Type of the signal

< Name of the signal parameter

Definition at line 1636 of file sim_plot_frame.cpp.

 {
     m_toolBar->SetToolNormalBitmap( ID_SIM_RUN, KiBitmap( BITMAPS::sim_run ) );
     SetCursor( wxCURSOR_ARROW );
 
     SIM_TYPE simType = m_exporter->GetSimType();
 
     if( simType == ST_UNKNOWN )
         return;
 
     SIM_PANEL_BASE* plotPanelWindow = currentPlotWindow();
 
     if( !plotPanelWindow || plotPanelWindow->GetType() != simType )
         plotPanelWindow = NewPlotPanel( m_exporter->GetUsedSimCommand() );
 
     if( IsSimulationRunning() )
         return;
 
     // If there are any signals plotted, update them
     if( SIM_PANEL_BASE::IsPlottable( simType ) )
     {
         SIM_PLOT_PANEL* plotPanel = dynamic_cast<SIM_PLOT_PANEL*>( plotPanelWindow );
         wxCHECK_RET( plotPanel, "not a SIM_PLOT_PANEL"  );
 
         struct TRACE_DESC
         {
             wxString m_name;
 
             SIM_PLOT_TYPE m_type;
 
             wxString m_param;
         };
 
         std::vector<struct TRACE_DESC> traceInfo;
 
         // Get information about all the traces on the plot, remove and add again
         for( auto& trace : plotPanel->GetTraces() )
         {
             struct TRACE_DESC placeholder;
             placeholder.m_name = trace.second->GetName();
             placeholder.m_type = trace.second->GetType();
             placeholder.m_param = trace.second->GetParam();
 
             traceInfo.push_back( placeholder );
         }
 
         for( auto& trace : traceInfo )
         {
             if( !updatePlot( trace.m_name, trace.m_type, trace.m_param, plotPanel ) )
             {
                 removePlot( trace.m_name, false );
                 m_workbook->RemoveTrace( plotPanel, trace.m_name );
             }
         }
 
         updateSignalList();
         plotPanel->GetPlotWin()->UpdateAll();
         plotPanel->ResetScales();
         updateFrame();
     }
     else if( simType == ST_OP )
     {
         m_simConsole->AppendText( _( "\n\nSimulation results:\n\n" ) );
         m_simConsole->SetInsertionPointEnd();
 
         for( const auto& vec : m_simulator->AllPlots() )
         {
             std::vector<double> val_list = m_simulator->GetRealPlot( vec, 1 );
 
             if( val_list.size() == 0 )      // The list of values can be empty!
                 continue;
 
             double val = val_list.at( 0 );
             wxString      outLine, signal;
             SIM_PLOT_TYPE type = m_exporter->VectorToSignal( vec, signal );
 
             const size_t tab     = 25; //characters
             size_t padding = ( signal.length() < tab ) ? ( tab - signal.length() ) : 1;
 
             outLine.Printf( wxT( "%s%s" ), ( signal + wxT( ":" ) ).Pad( padding, wxUniChar( ' ' ) ),
                     SPICE_VALUE( val ).ToSpiceString() );
 
             outLine.Append( type == SPT_CURRENT ? "A\n" : "V\n" );
 
             m_simConsole->AppendText( outLine );
             m_simConsole->SetInsertionPointEnd();
 
             // @todo display calculated values on the schematic
         }
     }
 }

References _, currentPlotWindow(), SIM_PLOT_PANEL::GetPlotWin(), SIM_PLOT_PANEL::GetTraces(), SIM_PANEL_BASE::GetType(), ID_SIM_RUN, SIM_PANEL_BASE::IsPlottable(), IsSimulationRunning(), KiBitmap(), m_exporter, SIM_PLOT_FRAME_BASE::m_simConsole, m_simulator, SIM_PLOT_FRAME_BASE::m_toolBar, KIWAY_HOLDER::m_type, m_workbook, NewPlotPanel(), removePlot(), SIM_PLOT_PANEL::ResetScales(), sim_run, SPT_CURRENT, ST_OP, ST_UNKNOWN, mpWindow::UpdateAll(), updateFrame(), updatePlot(), and updateSignalList().

Referenced by SIM_PLOT_FRAME().

◆ onSimReport()

void SIM_PLOT_FRAME::onSimReport ( wxCommandEvent & aEvent )

private

Definition at line 1754 of file sim_plot_frame.cpp.

 {
     m_simConsole->AppendText( aEvent.GetString() + "\n" );
     m_simConsole->SetInsertionPointEnd();
 }

References SIM_PLOT_FRAME_BASE::m_simConsole.

Referenced by SIM_PLOT_FRAME().

◆ onSimStarted()

void SIM_PLOT_FRAME::onSimStarted ( wxCommandEvent & aEvent )

private

Definition at line 1629 of file sim_plot_frame.cpp.

 {
     m_toolBar->SetToolNormalBitmap( ID_SIM_RUN, KiBitmap( BITMAPS::sim_stop ) );
     SetCursor( wxCURSOR_ARROWWAIT );
 }

References ID_SIM_RUN, KiBitmap(), SIM_PLOT_FRAME_BASE::m_toolBar, and sim_stop.

Referenced by SIM_PLOT_FRAME().

◆ onSimulate()

void SIM_PLOT_FRAME::onSimulate ( wxCommandEvent & event )

private

Definition at line 1382 of file sim_plot_frame.cpp.

 {
     if( IsSimulationRunning() )
         StopSimulation();
     else
         StartSimulation();
 }

References IsSimulationRunning(), StartSimulation(), and StopSimulation().

Referenced by SIM_PLOT_FRAME().

◆ onSimUpdate()

void SIM_PLOT_FRAME::onSimUpdate ( wxCommandEvent & aEvent )

private

Definition at line 1732 of file sim_plot_frame.cpp.

 {
     if( IsSimulationRunning() )
         StopSimulation();
 
     if( CurrentPlot() != m_lastSimPlot )
     {
         // We need to rerun simulation, as the simulator currently stores
         // results for another plot
         StartSimulation();
     }
     else
     {
         // Incremental update
         m_simConsole->Clear();
         // Do not export netlist, it is already stored in the simulator
         applyTuners();
         m_simulator->Run();
     }
 }

References applyTuners(), CurrentPlot(), IsSimulationRunning(), m_lastSimPlot, SIM_PLOT_FRAME_BASE::m_simConsole, m_simulator, StartSimulation(), and StopSimulation().

Referenced by SIM_PLOT_FRAME().

◆ OnSize()

void EDA_BASE_FRAME::OnSize ( wxSizeEvent & aEvent )

virtualinherited

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

Definition at line 508 of file eda_base_frame.cpp.

 {
 #ifdef __WXMAC__
     int currentDisplay = wxDisplay::GetFromWindow( this );
 
     if( m_displayIndex >= 0 && currentDisplay >= 0 && currentDisplay != m_displayIndex )
     {
         wxLogTrace( traceDisplayLocation, "OnSize: current display changed %d to %d",
                     m_displayIndex, currentDisplay );
         m_displayIndex = currentDisplay;
         ensureWindowIsOnScreen();
     }
 #endif
 
     aEvent.Skip();
 }

References EDA_BASE_FRAME::ensureWindowIsOnScreen(), EDA_BASE_FRAME::m_displayIndex, and traceDisplayLocation.

Referenced by EDA_DRAW_FRAME::OnSize().

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent & evt )

inherited

Definition at line 71 of file eda_dde.cpp.

 {
     size_t        len;
     wxSocketBase* sock = evt.GetSocket();
 
     switch( evt.GetSocketEvent() )
     {
     case wxSOCKET_INPUT:
         sock->Read( client_ipc_buffer, 1 );
 
         if( sock->LastCount() == 0 )
             break;                    // No data, occurs on opening connection
 
         sock->Read( client_ipc_buffer + 1, IPC_BUF_SIZE - 2 );
         len = 1 + sock->LastCount();
         client_ipc_buffer[len] = 0;
         ExecuteRemoteCommand( client_ipc_buffer );
         break;
 
     case wxSOCKET_LOST:
         return;
         break;
 
     default:
         wxPrintf( wxT( "EDA_DRAW_FRAME::OnSockRequest() error: Invalid event !" ) );
         break;
     }
 }

References client_ipc_buffer, KIWAY_PLAYER::ExecuteRemoteCommand(), and IPC_BUF_SIZE.

◆ OnSockRequestServer()

void KIWAY_PLAYER::OnSockRequestServer ( wxSocketEvent & evt )

inherited

Definition at line 103 of file eda_dde.cpp.

 {
     wxSocketBase*   socket;
     wxSocketServer* server = (wxSocketServer*) evt.GetSocket();
 
     socket = server->Accept();
 
     if( socket == NULL )
         return;
 
     m_sockets.push_back( socket );
 
     socket->Notify( true );
     socket->SetEventHandler( *this, ID_EDA_SOCKET_EVENT );
     socket->SetNotify( wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG );
 }

References ID_EDA_SOCKET_EVENT, KIWAY_PLAYER::m_sockets, and NULL.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent & aEvent )

protectedinherited

Definition at line 1242 of file eda_base_frame.cpp.

 {
     // Call the handler to update the colors used in the frame
     HandleSystemColorChange();
 
     // Skip the change event to ensure the rest of the window controls get it
     aEvent.Skip();
 }

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ onTune()

void SIM_PLOT_FRAME::onTune ( wxCommandEvent & event )

private

Definition at line 1481 of file sim_plot_frame.cpp.

 {
     if( m_schematicFrame == NULL )
         return;
 
     m_schematicFrame->GetToolManager()->RunAction( EE_ACTIONS::simTune );
     m_schematicFrame->Raise();
 }

References TOOLS_HOLDER::GetToolManager(), m_schematicFrame, NULL, TOOL_MANAGER::RunAction(), and EE_ACTIONS::simTune.

Referenced by SIM_PLOT_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 SCH_EDIT_FRAME, PCB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, BM2CMP_FRAME, CVPCB_MAINFRAME, GERBVIEW_FRAME, and PL_EDITOR_FRAME.

Definition at line 118 of file kiway_player.h.

     {
         // overload me for your wxFrame type.
 
         // Any overload should probably do this also:
         // Prj().MaybeLoadProjectSettings();
 
         // Then update the window title.
 
         return false;
     }

Referenced by BACK_ANNOTATE::FetchNetlistFromPCB(), PGM_SINGLE_TOP::MacOpenFile(), PGM_MOCK_EESCHEMA_FRAME::MacOpenFile(), SCH_EDIT_FRAME::OnOpenPcbnew(), PGM_SINGLE_TOP::OnPgmInit(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::RunEeschema(), and PCB_EDIT_FRAME::TestStandalone().

◆ ParseArgs()

virtual void KIWAY_PLAYER::ParseArgs ( wxCmdLineParser & aParser )

inlinevirtualinherited

Handle command-line arguments in a frame-specific way.

The given argument parser has already been initialized with the command line and any options/switches that are handled by the top-level launcher before passing control to the child frame.

Parameters

aParser is the argument parser created by the top-level launcher.

Definition at line 139 of file kiway_player.h.

     {
         WXUNUSED( aParser );
     }

Referenced by PGM_SINGLE_TOP::OnPgmInit().

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

 {
     return m_redoList.PopCommand();
 }

References EDA_BASE_FRAME::m_redoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), and SCH_EDITOR_CONTROL::Redo().

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

 {
     return m_undoList.PopCommand();
 }

References EDA_BASE_FRAME::m_undoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), PCB_EDIT_FRAME::RunActionPlugin(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const std::string & actionName )

virtualinherited

Definition at line 61 of file tools_holder.cpp.

 {
     // Push/pop events can get out of order (such as when they're generated by the Simulator
     // frame but not processed until the mouse is back in the Schematic frame), so make sure
     // we're popping the right stack frame.
 
     for( int i = (int) m_toolStack.size() - 1; i >= 0; --i )
     {
         if( m_toolStack[ i ] == actionName )
         {
             m_toolStack.erase( m_toolStack.begin() + i );
 
             // If there's something underneath us, and it's now the top of the stack, then
             // re-activate it
             if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
             {
                 std::string  back = m_toolStack[ i ];
                 TOOL_ACTION* action = m_toolManager->GetActionManager()->FindAction( back );
 
                 if( action )
                 {
                     // Pop the action as running it will push it back onto the stack
                     m_toolStack.pop_back();
 
                     TOOL_EVENT evt = action->MakeEvent();
                     evt.SetHasPosition( false );
                     evt.SetReactivate( true );
                     GetToolManager()->PostEvent( evt );
                 }
             }
             else
                 DisplayToolMsg( ACTIONS::selectionTool.GetLabel() );
 
             return;
         }
     }
 }

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

Referenced by EDIT_TOOL::copyToClipboard(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), ZOOM_TOOL::Main(), PCB_PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString & text )

inherited

Definition at line 810 of file eda_base_frame.cpp.

 {
     SetStatusText( text );
 }

References text.

Referenced by KICAD_MANAGER_CONTROL::Execute(), TERMINATE_HANDLER::OnTerminate(), and KICAD_MANAGER_FRAME::OnUnarchiveFiles().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 35 of file kiway_holder.cpp.

 {
     return Kiway().Prj();
 }

References KIWAY_HOLDER::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 256 of file eda_base_frame.cpp.

 {
 #ifdef  __WXMAC__
     // Apple in its infinite wisdom will raise a disabled window before even passing
     // us the event, so we have no way to stop it.  Instead, we have to catch an
     // improperly ordered disabled window and quasi-modal dialog here and reorder
     // them.
     if( !IsEnabled() && IsActive() )
     {
         wxWindow* dlg = findQuasiModalDialog();
         if( dlg )
             dlg->Raise();
     }
 #endif
 
     if( !wxFrame::ProcessEvent( aEvent ) )
         return false;
 
     if( IsShown() && m_hasAutoSave && IsActive() &&
         (m_autoSaveState != isAutoSaveRequired()) && (m_autoSaveInterval > 0) )
     {
         if( !m_autoSaveState )
         {
             wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
             m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
             m_autoSaveState = true;
         }
  

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ HOLDER_TYPE

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ SIM_PLOT_FRAME()

◆ ~SIM_PLOT_FRAME()

Member Function Documentation

◆ AddCurrentPlot()

◆ addPlot()

◆ AddStandardHelpMenu()

◆ AddTuner()

◆ AddVoltagePlot()

◆ applyTuners()

◆ canCloseWindow()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ ClearFileHistory()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

◆ config()

◆ ConfigBaseName()

◆ CreateInfoBar()

◆ CreateServer()

◆ CurrentPlot()

◆ currentPlotWindow()

◆ CurrentToolName()

◆ Destroy()

◆ DismissModal()

◆ DisplayToolMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ ensureWindowIsOnScreen()

◆ ExecuteRemoteCommand()

◆ FinishAUIInitialization()

◆ GetAboutTitle()

◆ GetAutoSaveFilePrefix()

◆ GetAutoSaveInterval()

◆ GetCurrentFileName()

◆ GetCurrentSelection()

◆ GetDoImmediateActions()

◆ GetDragAction()

◆ GetExporter()

◆ GetFileFromHistory()

◆ GetFileHistory()

◆ GetFrameType()

◆ GetInfoBar()

◆ GetMaxUndoItems()

◆ GetMoveWarpsCursor()

◆ GetMruPath()

◆ GetPlotBgOpt()

◆ GetRedoCommandCount()

◆ GetSettingsManager()

◆ GetSeverity()

◆ GetSimulatorSettings()

◆ GetToolCanvas()

◆ GetToolManager()

◆ GetType()

◆ GetUndoCommandCount()

◆ GetUserUnits()

◆ GetWindowSettings()

◆ GetWindowSize()

◆ GetXAxisType()

◆ HandleSystemColorChange()

◆ HandleUpdateUIEvent()

◆ help_name()

◆ ImportHotkeyConfigFromFile()

◆ initExitKey()