KiCad PCB EDA Suite
SIM_PLOT_FRAME Class Reference

Implementing SIM_PLOT_FRAME_BASE. More...

#include <sim_plot_frame.h>

Inheritance diagram for SIM_PLOT_FRAME:
SIM_PLOT_FRAME_BASE KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER

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_BASENewPlotPanel (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_PANELCurrentPlot () const
 Return the currently opened plot panel (or NULL if there is none). More...
 
const NETLIST_EXPORTER_PSPICE_SIMGetExporter () 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_SETTINGSGetWindowSettings (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_MANAGERGetSettingsManager () 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_STACKsys_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_INFOBARGetInfoBar ()
 
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_BASEconfig () 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_HISTORYGetFileHistory ()
 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_LISTPopCommandFromUndoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 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_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual SELECTIONGetCurrentSelection ()
 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
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () 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_LOOPm_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_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_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, UIUpdateHandlerm_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_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_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_BASEcurrentPlotWindow () 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_FRAMEm_schematicFrame
 
std::unique_ptr< NETLIST_EXPORTER_PSPICE_SIMm_exporter
 
std::shared_ptr< SPICE_SIMULATORm_simulator
 
SIM_THREAD_REPORTERm_reporter
 Stores the data that can be preserved across simulator sessions. More...
 
std::unique_ptr< SIM_WORKBOOKm_workbook
 List of currently displayed tuners. More...
 
std::list< TUNER_SLIDER * > m_tuners
 
DIALOG_SIM_SETTINGSm_settingsDlg
 
SIM_PLOT_PANELm_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.

◆ UNDO_REDO_LIST

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.

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.

114  :
115  SIM_PLOT_FRAME_BASE( aParent ),
116  m_lastSimPlot( nullptr ),
117  m_plotNumber( 0 )
118 {
119  SetKiway( this, aKiway );
121 
123 
124  if( m_schematicFrame == NULL )
125  throw std::runtime_error( "There is no schematic window" );
126 
127  // Give an icon
128  wxIcon icon;
129  icon.CopyFromBitmap( KiBitmap( BITMAPS::simulator ) );
130  SetIcon( icon );
131 
133 
134  if( !m_simulator )
135  {
136  throw std::runtime_error( "Could not create simulator instance" );
137  return;
138  }
139 
140  // Get the previous size and position of windows:
141  LoadSettings( config() );
142 
143  // Prepare the color list to plot traces
145 
146  // Give icons to menuitems
148 
149  m_simulator->Init();
150 
151  if( m_savedWorkbooksPath.IsEmpty() )
153 
154  m_reporter = new SIM_THREAD_REPORTER( this );
155  m_simulator->SetReporter( m_reporter );
156 
157  // the settings dialog will be created later, on demand.
158  // if created in the ctor, for some obscure reason, there is an issue
159  // on Windows: when open it, the simulator frame is sent to the background.
160  // instead of being behind the dialog frame (as it does)
161  m_settingsDlg = nullptr;
162 
164 
165  Connect( EVT_SIM_UPDATE, wxCommandEventHandler( SIM_PLOT_FRAME::onSimUpdate ), NULL, this );
166  Connect( EVT_SIM_REPORT, wxCommandEventHandler( SIM_PLOT_FRAME::onSimReport ), NULL, this );
167  Connect( EVT_SIM_STARTED, wxCommandEventHandler( SIM_PLOT_FRAME::onSimStarted ), NULL, this );
168  Connect( EVT_SIM_FINISHED, wxCommandEventHandler( SIM_PLOT_FRAME::onSimFinished ), NULL, this );
169  Connect( EVT_SIM_CURSOR_UPDATE, wxCommandEventHandler( SIM_PLOT_FRAME::onCursorUpdate ),
170  NULL, this );
171 
172  // Toolbar buttons
173  m_toolSimulate = m_toolBar->AddTool( ID_SIM_RUN, _( "Run/Stop Simulation" ),
174  KiBitmap( BITMAPS::sim_run ), _( "Run Simulation" ), wxITEM_NORMAL );
175  m_toolAddSignals = m_toolBar->AddTool( ID_SIM_ADD_SIGNALS, _( "Add Signals" ),
176  KiBitmap( BITMAPS::sim_add_signal ), _( "Add signals to plot" ), wxITEM_NORMAL );
177  m_toolProbe = m_toolBar->AddTool( ID_SIM_PROBE, _( "Probe" ),
178  KiBitmap( BITMAPS::sim_probe ), _( "Probe signals on the schematic" ), wxITEM_NORMAL );
179  m_toolTune = m_toolBar->AddTool( ID_SIM_TUNE, _( "Tune" ),
180  KiBitmap( BITMAPS::sim_tune ), _( "Tune component values" ), wxITEM_NORMAL );
181  m_toolSettings = m_toolBar->AddTool( wxID_ANY, _( "Sim Parameters" ),
182  KiBitmap( BITMAPS::config ), _( "Simulation parameters and settings" ), wxITEM_NORMAL );
183 
184  Connect( m_toolSimulate->GetId(), wxEVT_COMMAND_TOOL_CLICKED,
185  wxCommandEventHandler( SIM_PLOT_FRAME::onSimulate ), NULL, this );
186  Connect( m_toolAddSignals->GetId(), wxEVT_COMMAND_TOOL_CLICKED,
187  wxCommandEventHandler( SIM_PLOT_FRAME::onAddSignal ), NULL, this );
188  Connect( m_toolProbe->GetId(), wxEVT_COMMAND_TOOL_CLICKED,
189  wxCommandEventHandler( SIM_PLOT_FRAME::onProbe ), NULL, this );
190  Connect( m_toolTune->GetId(), wxEVT_COMMAND_TOOL_CLICKED,
191  wxCommandEventHandler( SIM_PLOT_FRAME::onTune ), NULL, this );
192  Connect( m_toolSettings->GetId(), wxEVT_COMMAND_TOOL_CLICKED,
193  wxCommandEventHandler( SIM_PLOT_FRAME::onSettings ), NULL, this );
194 
195  // Bind toolbar buttons event to existing menu event handlers, so they behave the same
196  Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onSimulate, this,
197  m_runSimulation->GetId() );
198  Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onAddSignal, this, m_addSignals->GetId() );
199  Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onProbe, this, m_probeSignals->GetId() );
200  Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onTune, this, m_tuneValue->GetId() );
201  Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onShowNetlist, this,
202  m_showNetlist->GetId() );
203  Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onSettings, this, m_settings->GetId() );
204 
205  m_toolBar->Realize();
206 
207 #ifndef wxHAS_NATIVE_TABART
208  // Non-native default tab art has ulgy gradients we don't want
209  m_plotNotebook->SetArtProvider( new wxAuiSimpleTabArt() );
210 #endif
211 
212  // Ensure new items are taken in account by sizers:
213  Layout();
214 
215  // resize the subwindows size. At least on Windows, calling wxSafeYield before
216  // resizing the subwindows forces the wxSplitWindows size events automatically generated
217  // by wxWidgets to be executed before our resize code.
218  // Otherwise, the changes made by setSubWindowsSashSize are overwritten by one these
219  // events
220  wxSafeYield();
222 
223  // Ensure the window is on top
224  Raise();
225 
226  initWorkbook();
227 }
void onAddSignal(wxCommandEvent &event)
void SetKiway(wxWindow *aDest, KIWAY *aKiway)
It is only used for debugging, since "this" is not a wxWindow*.
wxToolBarToolBase * m_toolProbe
void setIconsForMenuItems()
Give icons to menuitems of the main menubar.
void onSimStarted(wxCommandEvent &aEvent)
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
bool GetPlotBgOpt() const
wxImageList * m_signalsIconColorList
A string to store the path of saved workbooks during a session.
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
void initWorkbook()
Load the currently active workbook stored in the project settings.
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:373
Schematic editor (Eeschema) main window.
void onSimUpdate(wxCommandEvent &aEvent)
SIM_THREAD_REPORTER * m_reporter
Stores the data that can be preserved across simulator sessions.
std::shared_ptr< SPICE_SIMULATOR > m_simulator
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:123
wxAuiNotebook * m_plotNotebook
SCH_EDIT_FRAME * m_schematicFrame
void setSubWindowsSashSize()
SIM_PLOT_PANEL * m_lastSimPlot
imagelists used to add a small colored icon to signal names and cursors name, the same color as the c...
#define NULL
static void FillDefaultColorList(bool aWhiteBg)
Fills m_colorList by a default set of colors.
wxMenuItem * m_runSimulation
void onSimReport(wxCommandEvent &aEvent)
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
void onSimFinished(wxCommandEvent &aEvent)
void onShowNetlist(wxCommandEvent &event)
#define _(s)
wxToolBarToolBase * m_toolAddSignals
static std::shared_ptr< SPICE_SIMULATOR > CreateInstance(const std::string &aName)
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
void onTune(wxCommandEvent &event)
wxToolBarToolBase * m_toolSimulate
static wxString m_savedWorkbooksPath
void onCursorUpdate(wxCommandEvent &aEvent)
DIALOG_SIM_SETTINGS * m_settingsDlg
void updateNetlistExporter()
Reload the current schematic for the netlist exporter.
void onSimulate(wxCommandEvent &event)
void onProbe(wxCommandEvent &event)
SIM_PLOT_FRAME_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Spice Simulator"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(564, 531), long style=wxDEFAULT_FRAME_STYLE|wxTAB_TRAVERSAL, const wxString &name=wxT("SIM_PLOT_FRAME"))
unsigned int m_plotNumber
void onSettings(wxCommandEvent &event)
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
wxToolBarToolBase * m_toolTune
wxToolBarToolBase * m_toolSettings

References _, config, EDA_BASE_FRAME::config(), SPICE_SIMULATOR::CreateInstance(), SIM_PLOT_COLORS::FillDefaultColorList(), FRAME_SCH, GetPlotBgOpt(), PROJECT::GetProjectPath(), ID_SIM_ADD_SIGNALS, ID_SIM_PROBE, ID_SIM_RUN, ID_SIM_TUNE, initWorkbook(), KiBitmap(), KIWAY_HOLDER::Kiway(), LoadSettings(), SIM_PLOT_FRAME_BASE::m_addSignals, SIM_PLOT_FRAME_BASE::m_plotNotebook, SIM_PLOT_FRAME_BASE::m_probeSignals, m_reporter, SIM_PLOT_FRAME_BASE::m_runSimulation, m_savedWorkbooksPath, m_schematicFrame, SIM_PLOT_FRAME_BASE::m_settings, m_settingsDlg, SIM_PLOT_FRAME_BASE::m_showNetlist, m_signalsIconColorList, m_simulator, m_toolAddSignals, SIM_PLOT_FRAME_BASE::m_toolBar, m_toolProbe, m_toolSettings, m_toolSimulate, m_toolTune, SIM_PLOT_FRAME_BASE::m_tuneValue, NULL, onAddSignal(), onCursorUpdate(), onProbe(), onSettings(), onShowNetlist(), onSimFinished(), onSimReport(), onSimStarted(), onSimulate(), onSimUpdate(), onTune(), KIWAY::Player(), KIWAY_HOLDER::Prj(), setIconsForMenuItems(), KIWAY_HOLDER::SetKiway(), setSubWindowsSashSize(), sim_add_signal, sim_probe, sim_run, sim_tune, simulator, and updateNetlistExporter().

◆ ~SIM_PLOT_FRAME()

SIM_PLOT_FRAME::~SIM_PLOT_FRAME ( )

Definition at line 230 of file sim_plot_frame.cpp.

231 {
232  m_simulator->SetReporter( nullptr );
233  delete m_reporter;
234  delete m_signalsIconColorList;
235 
236  if( m_settingsDlg )
237  m_settingsDlg->Destroy();
238 }
wxImageList * m_signalsIconColorList
A string to store the path of saved workbooks during a session.
SIM_THREAD_REPORTER * m_reporter
Stores the data that can be preserved across simulator sessions.
std::shared_ptr< SPICE_SIMULATOR > m_simulator
DIALOG_SIM_SETTINGS * m_settingsDlg

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
aDeviceNameis the device name (e.g. R1, C1).
aParamis the current type (e.g. I, Ic, Id).

Definition at line 553 of file sim_plot_frame.cpp.

554 {
555  addPlot( aDeviceName, SPT_CURRENT, aParam );
556 }
void addPlot(const wxString &aName, SIM_PLOT_TYPE aType, const wxString &aParam)
Add a new plot to the current panel.

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
aNameis the device/net name.
aTypedescribes the type of plot.
aParamis the parameter for the device/net (e.g. I, Id, V).

Definition at line 634 of file sim_plot_frame.cpp.

635 {
636  SIM_TYPE simType = m_exporter->GetSimType();
637 
638  if( simType == ST_UNKNOWN )
639  {
640  m_simConsole->AppendText( _( "Error: simulation type not defined!\n" ) );
641  m_simConsole->SetInsertionPointEnd();
642  return;
643  }
644  else if( !SIM_PANEL_BASE::IsPlottable( simType ) )
645  {
646  m_simConsole->AppendText( _( "Error: simulation type doesn't support plotting!\n" ) );
647  m_simConsole->SetInsertionPointEnd();
648  return;
649  }
650 
651  // Create a new plot if the current one displays a different type
652  SIM_PLOT_PANEL* plotPanel = CurrentPlot();
653 
654  if( !plotPanel || plotPanel->GetType() != simType )
655  plotPanel =
656  dynamic_cast<SIM_PLOT_PANEL*>( NewPlotPanel( m_exporter->GetUsedSimCommand() ) );
657 
658  wxASSERT( plotPanel );
659 
660  if( !plotPanel ) // Something is wrong
661  return;
662 
663  bool updated = false;
664  SIM_PLOT_TYPE xAxisType = GetXAxisType( simType );
665 
666  if( xAxisType == SPT_LIN_FREQUENCY || xAxisType == SPT_LOG_FREQUENCY )
667  {
668  int baseType = aType & ~( SPT_AC_MAG | SPT_AC_PHASE );
669 
670  // Add two plots: magnitude & phase
671  updated |=
672  updatePlot( aName, ( SIM_PLOT_TYPE )( baseType | SPT_AC_MAG ), aParam, plotPanel );
673  updated |= updatePlot( aName, ( SIM_PLOT_TYPE )( baseType | SPT_AC_PHASE ), aParam,
674  plotPanel );
675  }
676  else
677  {
678  updated = updatePlot( aName, aType, aParam, plotPanel );
679  }
680 
681  if( updated )
682  {
684  }
685 }
SIM_PANEL_BASE * NewPlotPanel(wxString aSimCommand)
Create a new plot panel for a given simulation type and adds it to the main notebook.
static bool IsPlottable(SIM_TYPE aSimType)
SIM_PLOT_TYPE GetXAxisType(SIM_TYPE aType) const
Return X axis for a given simulation type.
SIM_TYPE
< Possible simulation types
Definition: sim_types.h:31
#define _(s)
SIM_TYPE GetType() const
std::unique_ptr< NETLIST_EXPORTER_PSPICE_SIM > m_exporter
bool updatePlot(const wxString &aName, SIM_PLOT_TYPE aType, const wxString &aParam, SIM_PLOT_PANEL *aPanel)
Update plot in a particular SIM_PLOT_PANEL.
void updateSignalList()
Update the list of currently plotted signals.
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
SIM_PLOT_TYPE
Definition: sim_types.h:46

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.

439 {
440  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
441  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
442 
443  helpMenu->Add( ACTIONS::help );
444  helpMenu->Add( ACTIONS::gettingStarted );
445  helpMenu->Add( ACTIONS::listHotKeys );
446  helpMenu->Add( ACTIONS::getInvolved );
447  helpMenu->Add( ACTIONS::donate );
448  helpMenu->Add( ACTIONS::reportBug );
449 
450  helpMenu->AppendSeparator();
451  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
452 
453  aMenuBar->Append( helpMenu, _( "&Help" ) );
454 }
static TOOL_ACTION listHotKeys
Definition: actions.h:178
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
static TOOL_ACTION reportBug
Cursor control event types.
Definition: actions.h:181
static TOOL_ACTION donate
Definition: actions.h:179
#define _(s)
Handle actions that are shared between different applications.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:156
static TOOL_ACTION help
Definition: actions.h:177
static TOOL_ACTION getInvolved
Definition: actions.h:180
static TOOL_ACTION gettingStarted
Definition: actions.h:176

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.

560 {
561  SIM_PANEL_BASE* plotPanel = currentPlotWindow();
562 
563  if( !plotPanel )
564  return;
565 
566  // For now limit the tuner tool to RLC components
567  char primitiveType = NETLIST_EXPORTER_PSPICE::GetSpiceField( SF_PRIMITIVE, aSymbol, 0 )[0];
568 
569  if( primitiveType != SP_RESISTOR && primitiveType != SP_CAPACITOR
570  && primitiveType != SP_INDUCTOR )
571  return;
572 
573  const wxString componentName = aSymbol->GetField( REFERENCE_FIELD )->GetText();
574 
575  // Do not add multiple instances for the same component
576  auto tunerIt = std::find_if( m_tuners.begin(), m_tuners.end(), [&]( const TUNER_SLIDER* t )
577  {
578  return t->GetComponentName() == componentName;
579  }
580  );
581 
582  if( tunerIt != m_tuners.end() )
583  return; // We already have it
584 
585  try
586  {
587  TUNER_SLIDER* tuner = new TUNER_SLIDER( this, m_tunePanel, aSymbol );
588  m_tuneSizer->Add( tuner );
589  m_tuners.push_back( tuner );
590  m_tunePanel->Layout();
591  }
592  catch( const KI_PARAM_ERROR& e )
593  {
594  // Sorry, no bonus
595  DisplayErrorMessage( nullptr, e.What() );
596  }
597 }
Field Reference of part, i.e. "IC21".
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:265
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:665
std::list< TUNER_SLIDER * > m_tuners
SIM_PANEL_BASE * currentPlotWindow() const
Return the currently opened plot panel (or NULL if there is none).
static wxString GetSpiceField(SPICE_FIELD aField, SCH_SYMBOL *aSymbol, unsigned aCtl)
Retrieve either the requested field value or the default value.
const wxString What() const
Definition: ki_exception.h:57
Custom widget to handle quick component values modification and simulation on the fly.
Definition: tuner_slider.h:42
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133
Hold a translatable error message and may be used when throwing exceptions containing a translated er...
Definition: ki_exception.h:44

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
aNetNameis the net name for which a voltage plot should be created.

Definition at line 547 of file sim_plot_frame.cpp.

548 {
549  addPlot( aNetName, SPT_VOLTAGE, "V" );
550 }
void addPlot(const wxString &aName, SIM_PLOT_TYPE aType, const wxString &aParam)
Add a new plot to the current panel.

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.

917 {
918  for( auto& tuner : m_tuners )
919  {
921  std::string command( "alter @" + tuner->GetSpiceName()
922  + "=" + tuner->GetValue().ToSpiceString() );
923 
924  m_simulator->Command( command );
925  }
926 }
std::list< TUNER_SLIDER * > m_tuners
std::shared_ptr< SPICE_SIMULATOR > m_simulator

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.

1550 {
1551  if( m_workbook->IsModified() )
1552  {
1553  wxFileName filename = m_simulator->Settings()->GetWorkbookFilename();
1554 
1555  if( filename.GetName().IsEmpty() )
1556  filename.SetFullName( Prj().GetProjectName() + wxT( ".wbk" ) );
1557 
1558  wxString msg = _( "Save changes to \"%s\" before closing?" );
1559 
1560  return HandleUnsavedChanges( this, wxString::Format( msg, filename.GetFullName() ),
1561  [&]()->bool { return saveWorkbook( Prj().AbsolutePath ( filename.GetFullName() ) ); } );
1562  }
1563 
1564  return true;
1565 }
bool saveWorkbook(const wxString &aPath)
Save plot settings to a file.
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:207
std::unique_ptr< SIM_WORKBOOK > m_workbook
List of currently displayed tuners.
std::shared_ptr< SPICE_SIMULATOR > m_simulator
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

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.

1176 {
1177  SetUserUnits( aUnits );
1179 
1180  wxCommandEvent e( UNITS_CHANGED );
1181  ProcessEventLocally( e );
1182 }
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void SetUserUnits(EDA_UNITS aUnits)

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
aFileNameA wxFileName object containing the file name to check.

Definition at line 1063 of file eda_base_frame.cpp.

1064 {
1065  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
1066 
1067  wxFileName autoSaveFileName = aFileName;
1068 
1069  // Check for auto save file.
1070  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
1071 
1072  wxLogTrace( traceAutoSave,
1073  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
1074 
1075  if( !autoSaveFileName.FileExists() )
1076  return;
1077 
1078  wxString msg = wxString::Format( _(
1079  "Well this is potentially embarrassing!\n"
1080  "It appears that the last time you were editing the file\n"
1081  "\"%s\"\n"
1082  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
1083  aFileName.GetFullName()
1084  );
1085 
1086  int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
1087  this );
1088 
1089  // Make a backup of the current file, delete the file, and rename the auto save file to
1090  // the file name.
1091  if( response == wxYES )
1092  {
1093  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1094  {
1095  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1096  Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1097  }
1098  }
1099  else
1100  {
1101  wxLogTrace( traceAutoSave,
1102  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1103 
1104  // Remove the auto save file when using the previous file as is.
1105  wxRemoveFile( autoSaveFileName.GetFullPath() );
1106  }
1107 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static wxString GetAutoSaveFilePrefix()

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
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used

Definition at line 950 of file eda_base_frame.cpp.

951 {
952  if( !aFileHistory )
953  aFileHistory = m_fileHistory;
954 
955  wxASSERT( aFileHistory );
956 
957  aFileHistory->ClearFileHistory();
958 
959  // Update the menubar to update the file history menu
960  if( GetMenuBar() )
961  {
962  ReCreateMenuBar();
963  GetMenuBar()->Refresh();
964  }
965 }
void ClearFileHistory()
Clear all entries from the file history.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

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

468 {
469  TOOLS_HOLDER::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
470 
471  COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
472 
473  if( m_fileHistory )
474  {
475  int historySize = settings->m_System.file_history_size;
476  m_fileHistory->SetMaxFiles( (unsigned) std::max( 0, historySize ) );
477  }
478 
479  if( GetBitmapStore()->ThemeChanged() )
480  {
481  ThemeChanged();
482  }
483 
484  if( GetMenuBar() )
485  {
486  // For icons in menus, icon scaling & hotkeys
487  ReCreateMenuBar();
488  GetMenuBar()->Refresh();
489  }
490 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void SetMaxFiles(size_t aMaxFiles)
Update the number of files that will be contained inside the file history.
Definition: filehistory.cpp:85
virtual void ThemeChanged()
Process light/dark theme change.
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.
BITMAP_STORE * GetBitmapStore()
Definition: bitmap.cpp:93

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.

792 {
793  // KICAD_MANAGER_FRAME overrides this
794  return Kiface().KifaceSettings();
795 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:92
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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.

358  {
359  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
360  return baseCfgName;
361  }
wxString m_configName

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.

817 {
818 #if defined( __WXOSX_MAC__ )
820 #else
821  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
822 
823  m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
824 #endif
825 }
wxAuiManager m_auimgr
virtual wxWindow * GetToolCanvas() const =0
Canvas access.
Specialization of the wxAuiPaneInfo class for KiCad panels.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:73
WX_INFOBAR * m_infoBar

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.

50 {
51  wxIPV4address addr;
52 
53  // Set the port number
54  addr.Service( service );
55 
56  // Listen on localhost only if requested
57  if( local )
58  addr.Hostname( HOSTNAME );
59 
60  delete m_socketServer;
61  m_socketServer = new wxSocketServer( addr );
62 
63  m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
64  m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
65  m_socketServer->Notify( true );
66 }
static const wxString HOSTNAME(wxT("localhost"))
wxSocketServer * m_socketServer
Definition: kiway_player.h:218

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.

611 {
612  SIM_PANEL_BASE* curPage = currentPlotWindow();
613 
614  return ( ( !curPage || curPage->GetType() == ST_UNKNOWN ) ?
615  nullptr :
616  dynamic_cast<SIM_PLOT_PANEL*>( curPage ) );
617 }
SIM_PANEL_BASE * currentPlotWindow() const
Return the currently opened plot panel (or NULL if there is none).
SIM_TYPE GetType() const

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.

172  {
173  return dynamic_cast<SIM_PANEL_BASE*>( m_plotNotebook->GetCurrentPage() );
174  }
wxAuiNotebook * m_plotNotebook

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.

101 {
102  if( m_toolStack.empty() )
103  return ACTIONS::selectionTool.GetName();
104  else
105  return m_toolStack.back();
106 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:162
static TOOL_ACTION selectionTool
Definition: actions.h:153

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

Referenced by TOOL_MANAGER::processEvent().

◆ Destroy()

◆ DismissModal()

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

Definition at line 161 of file kiway_player.cpp.

162 {
163  m_modal_ret_val = aRetVal;
164  m_modal_string = aResult;
165 
166  if( m_modal_loop )
167  {
168  m_modal_loop->Exit();
169  m_modal_loop = nullptr; // this marks it as dismissed.
170  }
171 
172  Show( false );
173 }
bool m_modal_ret_val
Definition: kiway_player.h:216
wxString m_modal_string
Definition: kiway_player.h:215
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:213

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.

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

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.

1569 {
1570  if( IsSimulationRunning() )
1571  m_simulator->Stop();
1572 
1573  // Cancel a running simProbe or simTune tool
1575 
1576  SaveSettings( config() );
1577  Destroy();
1578 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
static TOOL_ACTION cancelInteractive
Definition: actions.h:62
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:143
std::shared_ptr< SPICE_SIMULATOR > m_simulator
SCH_EDIT_FRAME * m_schematicFrame
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
bool IsSimulationRunning()
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54

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.

634 {
635  wxDisplay display( wxDisplay::GetFromWindow( this ) );
636  wxRect clientSize = display.GetClientArea();
637  wxPoint pos = GetPosition();
638  wxSize size = GetWindowSize();
639 
640  wxLogTrace( traceDisplayLocation,
641  "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d", clientSize.x, clientSize.y,
642  clientSize.width, clientSize.height );
643 
644  if( pos.y < clientSize.y )
645  {
646  wxLogTrace( traceDisplayLocation,
647  "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d", pos.y,
648  clientSize.y );
649  pos.y = clientSize.y;
650  }
651 
652  if( pos.x < clientSize.x )
653  {
654  wxLogTrace( traceDisplayLocation,
655  "ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d", pos.x,
656  clientSize.x );
657  pos.x = clientSize.x;
658  }
659 
660  if( pos.x + size.x - clientSize.x > clientSize.width )
661  {
662  int newWidth = clientSize.width - ( pos.x - clientSize.x );
663  wxLogTrace( traceDisplayLocation,
664  "ensureWindowIsOnScreen: effective width %d above available %d, setting to %d",
665  pos.x + size.x, clientSize.width, newWidth );
666  size.x = newWidth;
667  }
668 
669  if( pos.y + size.y - clientSize.y > clientSize.height )
670  {
671  int newHeight = clientSize.height - ( pos.y - clientSize.y );
672  wxLogTrace( traceDisplayLocation,
673  "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d",
674  pos.y + size.y, clientSize.height, newHeight );
675  size.y = newHeight;
676  }
677 
678  wxLogTrace( traceDisplayLocation, "Updating window position (%d, %d) with size (%d, %d)",
679  pos.x, pos.y, size.x, size.y );
680 
681  SetSize( pos.x, pos.y, size.x, size.y );
682 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.

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.

829 {
830 #if defined( __WXOSX_MAC__ )
831  m_auimgr.Update();
832 #else
833  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
834  // hiding it.
835  m_auimgr.Update();
836 
837  // We don't want the infobar displayed right away
838  m_auimgr.GetPane( "InfoBar" ).Hide();
839  m_auimgr.Update();
840 #endif
841 }
wxAuiManager m_auimgr

References EDA_BASE_FRAME::m_auimgr.

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

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

601  {
602  return wxT( "_autosave-" );
603  }

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; }

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.

102  {
103  return m_dummySelection;
104  }
SELECTION m_dummySelection
Definition: tools_holder.h:160

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

621 {
622  return m_exporter.get();
623 }
std::unique_ptr< NETLIST_EXPORTER_PSPICE_SIM > m_exporter

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
cmdIdThe command ID associated with the aFileHistory object.
typePlease document me!
aFileHistoryThe 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.

912 {
913  if( !aFileHistory )
914  aFileHistory = m_fileHistory;
915 
916  wxASSERT( aFileHistory );
917 
918  int baseId = aFileHistory->GetBaseId();
919 
920  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
921 
922  unsigned i = cmdId - baseId;
923 
924  if( i < aFileHistory->GetCount() )
925  {
926  wxString fn = aFileHistory->GetHistoryFile( i );
927 
928  if( wxFileName::FileExists( fn ) )
929  return fn;
930  else
931  {
932  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
933  wxMessageBox( msg );
934 
935  aFileHistory->RemoveFileFromHistory( i );
936  }
937  }
938 
939  // Update the menubar to update the file history menu
940  if( GetMenuBar() )
941  {
942  ReCreateMenuBar();
943  GetMenuBar()->Refresh();
944  }
945 
946  return wxEmptyString;
947 }
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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.

423  {
424  return *m_fileHistory;
425  }
FILE_HISTORY * 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; }

References EDA_BASE_FRAME::m_ident.

◆ GetInfoBar()

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 580 of file eda_base_frame.h.

580 { return m_undoRedoCountMax; }

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

◆ 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; }

References m_plotUseWhiteBg.

Referenced by menuWhiteBackground(), and SIM_PLOT_FRAME().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetSettingsManager()

SETTINGS_MANAGER* EDA_BASE_FRAME::GetSettingsManager ( ) const
inlineinherited

Definition at line 140 of file eda_base_frame.h.

140 { return m_settingsManager; }
SETTINGS_MANAGER * m_settingsManager

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.

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.

627 {
628  wxASSERT( m_simulator->Settings() );
629 
630  return m_simulator->Settings();
631 }
std::shared_ptr< SPICE_SIMULATOR > m_simulator

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; }
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; }
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

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

127  {
128  return m_userUnits;
129  }
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

References EDA_BASE_FRAME::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_FP_EDITOR_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), BOARD_INSPECTION_TOOL::getItemDescription(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), PL_EDITOR_LAYOUT::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), PCB_MARKER::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), RC_TREE_MODEL::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_NET_INSPECTOR::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), GERBVIEW_FRAME::UpdateStatusBar(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), and DRC_TOOL::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
aCfgis this frame's config object

Reimplemented from EDA_BASE_FRAME.

Definition at line 296 of file sim_plot_frame.cpp.

297 {
298  EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( aCfg );
299  wxASSERT( cfg );
300 
301  return cfg ? &cfg->m_Simulator.window : nullptr;
302 }

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.

1208 {
1209 #ifdef __WXGTK__
1210  // GTK includes the window decorations in the normal GetSize call,
1211  // so we have to use a GTK-specific sizing call that returns the
1212  // non-decorated window size.
1213  int width = 0;
1214  int height = 0;
1215  GTKDoGetSize( &width, &height );
1216 
1217  wxSize winSize( width, height );
1218 #else
1219  wxSize winSize = GetSize();
1220 #endif
1221 
1222  return winSize;
1223 }

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.

1075 {
1076  switch( aType )
1077  {
1078  case ST_AC:
1079  return SPT_LIN_FREQUENCY;
1081 
1082  case ST_DC:
1083  return SPT_SWEEP;
1084 
1085  case ST_TRANSIENT:
1086  return SPT_TIME;
1087 
1088  default:
1089  wxASSERT_MSG( false, "Unhandled simulation type" );
1090  return (SIM_PLOT_TYPE) 0;
1091  }
1092 }
SIM_PLOT_TYPE
Definition: sim_types.h:46

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.

1227 {
1228  // Update the icon theme when the system theme changes and update the toolbars
1229  if( GetBitmapStore()->ThemeChanged() )
1230  ThemeChanged();
1231 
1232  // This isn't handled by ThemeChanged()
1233  if( GetMenuBar() )
1234  {
1235  // For icons in menus, icon scaling & hotkeys
1236  ReCreateMenuBar();
1237  GetMenuBar()->Refresh();
1238  }
1239 }
virtual void ThemeChanged()
Process light/dark theme change.
virtual void ReCreateMenuBar()
Recreates the menu bar.
BITMAP_STORE * GetBitmapStore()
Definition: bitmap.cpp:93

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
aEventis the wxUpdateUIEvent to be processed.
aFrameis the frame to get the selection from
aCondare the #UI SELECTION_CONDITIONS used

Definition at line 370 of file eda_base_frame.cpp.

372 {
373  bool checkRes = false;
374  bool enableRes = true;
375  bool showRes = true;
376  SELECTION& selection = aFrame->GetCurrentSelection();
377 
378  try
379  {
380  checkRes = aCond.checkCondition( selection );
381  enableRes = aCond.enableCondition( selection );
382  showRes = aCond.showCondition( selection );
383  }
384  catch( std::exception& )
385  {
386  // Something broke with the conditions, just skip the event.
387  aEvent.Skip();
388  return;
389  }
390 
391  aEvent.Enable( enableRes );
392  aEvent.Show( showRes );
393 
394  // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
395  // checked, since wxMenuItems don't want to be checked unless they actually are checkable
396 #if wxCHECK_VERSION( 3, 1, 5 )
397  if( aEvent.IsCheckable() )
398  aEvent.Check( checkRes );
399 #else
400  bool canCheck = true;
401 
402  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
403  // see if they can be and can't just universally apply a check in this event.
404  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
405  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
406 
407  if( canCheck )
408  aEvent.Check( checkRes );
409 #endif
410 }
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:101

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.

805 {
806  return Kiface().GetHelpFileName();
807 }
const wxString & GetHelpFileName() const
Return just the basename portion of the current help file.
Definition: kiface_i.h:109
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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
aActionMapcurrent hotkey map (over which the imported hotkeys will be applied).
aDefaultShortnamea 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.

1118 {
1119  wxAcceleratorEntry entries[1];
1120  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
1121  wxAcceleratorTable accel( 1, entries );
1122  SetAcceleratorTable( accel );
1123 }

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

306 {
307  m_workbook = std::make_unique<SIM_WORKBOOK>();
308 
309  if( !m_simulator->Settings()->GetWorkbookFilename().IsEmpty() )
310  {
311  wxFileName filename = m_simulator->Settings()->GetWorkbookFilename();
312  filename.SetPath( Prj().GetProjectPath() );
313 
314  if( !loadWorkbook( filename.GetFullPath() ) )
315  {
316  // Empty the workbook filename to prevent error messages from appearing again
317  m_simulator->Settings()->SetWorkbookFilename( "" );
318  }
319  }
320 }
std::unique_ptr< SIM_WORKBOOK > m_workbook
List of currently displayed tuners.
std::shared_ptr< SPICE_SIMULATOR > m_simulator
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool loadWorkbook(const wxString &aPath)
Load plot settings from a file.

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

1111 {
1112  // This function should be overridden in child classes
1113  return false;
1114 }

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.

110 {
111  if( m_toolStack.empty() )
112  return &aAction == &ACTIONS::selectionTool;
113  else
114  return m_toolStack.back() == aAction.GetName();
115 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:162
static TOOL_ACTION selectionTool
Definition: actions.h:153
const std::string & GetName() const
Return name of the action.
Definition: tool_action.h:101

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.

156 {
157  return !m_modal_loop;
158 }
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:213

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; }

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.

508 {
509  return m_simulator ? m_simulator->IsRunning() : false;
510 }
std::shared_ptr< SPICE_SIMULATOR > m_simulator

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; }

References EDA_BASE_FRAME::m_ident.

Referenced by SYMBOL_EDITOR_CONTROL::AddLibrary(), PCB_CONTROL::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), COMMON_TOOLS::doZoomFit(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbol(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), CONVERT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), CONVERT_TOOL::LinesToPoly(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PANEL_3D_COLORS::PANEL_3D_COLORS(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SYMBOL_EDITOR_CONTROL::Revert(), SYMBOL_EDITOR_CONTROL::Save(), APPEARANCE_CONTROLS::setVisibleObjects(), EE_INSPECTION_TOOL::ShowDatasheet(), EE_INSPECTION_TOOL::ShowERCDialog(), SYMBOL_EDITOR_CONTROL::ToggleSymbolTree(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

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

1020 {
1021  wxString msg;
1022  wxFileName fn = aFileName;
1023 
1024  // Check for absence of a file path with a file name. Unfortunately KiCad
1025  // uses paths relative to the current project path without the ./ part which
1026  // confuses wxFileName. Making the file name path absolute may be less than
1027  // elegant but it solves the problem.
1028  if( fn.GetPath().IsEmpty() && fn.HasName() )
1029  fn.MakeAbsolute();
1030 
1031  wxCHECK_MSG( fn.IsOk(), false,
1032  wxT( "File name object is invalid. Bad programmer!" ) );
1033  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
1034  wxT( "File name object path <" ) + fn.GetFullPath() +
1035  wxT( "> is not set. Bad programmer!" ) );
1036 
1037  if( fn.IsDir() && !fn.IsDirWritable() )
1038  {
1039  msg.Printf( _( "You do not have write permissions to folder '%s'." ),
1040  fn.GetPath() );
1041  }
1042  else if( !fn.FileExists() && !fn.IsDirWritable() )
1043  {
1044  msg.Printf( _( "You do not have write permissions to save file '%s' to folder '%s'." ),
1045  fn.GetFullName(), fn.GetPath() );
1046  }
1047  else if( fn.FileExists() && !fn.IsFileWritable() )
1048  {
1049  msg.Printf( _( "You do not have write permissions to save file '%s'." ),
1050  fn.GetFullPath() );
1051  }
1052 
1053  if( !msg.IsEmpty() )
1054  {
1055  wxMessageBox( msg );
1056  return false;
1057  }
1058 
1059  return true;
1060 }
#define _(s)

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.

54  {
55  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
56  return *m_kiway;
57  }
KIWAY * m_kiway
Definition: kiway_holder.h:75

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.

177 {
178  // logging support
179  KiwayMailIn( aEvent ); // call the virtual, override in derived.
180 }
virtual void KiwayMailIn(KIWAY_EXPRESS &aEvent)
Receive KIWAY_EXPRESS messages from other players.

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.

71 {
72  // override this in derived classes.
73 }

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.

184 {
185  int id = event.GetId();
186 
187  // tell all the KIWAY_PLAYERs about the language change.
188  Kiway().SetLanguage( id );
189 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
virtual void SetLanguage(int aLanguage)
Change the language and then calls ShowChangedLanguage() on all #KIWAY_PLAYERs.
Definition: kiway.cpp:475

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.

242 {
243  EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( aCfg );
244  wxASSERT( cfg );
245 
246  if( cfg )
247  {
249 
250  // Read subwindows sizes (should be > 0 )
256  }
257 
259 
260  NGSPICE* currentSim = dynamic_cast<NGSPICE*>( m_simulator.get() );
261 
262  if( currentSim )
263  m_simulator->Settings() = project.m_SchematicSettings->m_NgspiceSimulatorSettings;
264 }
int m_splitterPlotAndConsoleSashPosition
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:145
std::shared_ptr< SPICE_SIMULATOR > m_simulator
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:64
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
int m_splitterTuneValuesSashPosition
int m_splitterSignalsSashPosition
int m_splitterLeftRightSashPosition
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.

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.

686 {
687  LoadWindowState( aCfg->state );
688 
689  if( m_hasAutoSave )
690  m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
691 
692  m_perspective = aCfg->perspective;
693  m_mruPath = aCfg->mru_path;
694 
695  TOOLS_HOLDER::CommonSettingsChanged( false, false );
696 }
wxString mru_path
Definition: app_settings.h:84
wxString m_mruPath
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void LoadWindowState(const wxString &aFileName)
wxString m_perspective
wxString perspective
Definition: app_settings.h:85
WINDOW_STATE state
Definition: app_settings.h:83
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.

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.

527 {
528  if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
529  return;
530 
531  const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
532 
533  if( state != nullptr )
534  {
535  LoadWindowState( state->window );
536  }
537 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void LoadWindowState(const wxString &aFileName)
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:151
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
struct WINDOW_STATE window
const PROJECT_FILE_STATE * GetFileState(const wxString &aFileName)

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.

541 {
542  bool wasDefault = false;
543 
544  m_framePos.x = aState.pos_x;
545  m_framePos.y = aState.pos_y;
546  m_frameSize.x = aState.size_x;
547  m_frameSize.y = aState.size_y;
548 
549  wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
551 
552  // Ensure minimum size is set if the stored config was zero-initialized
553  if( m_frameSize.x < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
554  {
556  wasDefault = true;
557 
558  wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_frameSize.x, m_frameSize.y );
559  }
560 
561  wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
562 
563  if( aState.display >= wxDisplay::GetCount() )
564  {
565  wxLogTrace( traceDisplayLocation, "Previous display not found" );
566 
567  // If it isn't attached, use the first display
568  // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
569  const unsigned int index = 0;
570  wxDisplay display( index );
571  wxRect clientSize = display.GetGeometry();
572 
573  m_framePos = wxDefaultPosition;
574 
575  // Ensure the window fits on the display, since the other one could have been larger
576  if( m_frameSize.x > clientSize.width )
577  m_frameSize.x = clientSize.width;
578 
579  if( m_frameSize.y > clientSize.height )
580  m_frameSize.y = clientSize.height;
581  }
582  else
583  {
584  wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
585  wxPoint upperLeft( m_framePos.x, m_framePos.y );
586 
587  wxDisplay display( aState.display );
588  wxRect clientSize = display.GetClientArea();
589 
590  int yLimTop = clientSize.y;
591  int yLimBottom = clientSize.y + clientSize.height;
592  int xLimLeft = clientSize.x;
593  int xLimRight = clientSize.x + clientSize.width;
594 
595  if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
596  upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
597  upperLeft.y < yLimTop || // Upper corner too close to the bottom of the screen
598  upperLeft.y > yLimBottom )
599  {
600  m_framePos = wxDefaultPosition;
601  wxLogTrace( traceDisplayLocation, "Resetting to default position" );
602  }
603  }
604 
605  wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
607 
608  SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
609 
610  // Center the window if we reset to default
611  if( m_framePos.x == -1 )
612  {
613  wxLogTrace( traceDisplayLocation, "Centering window" );
614  Center();
615  m_framePos = GetPosition();
616  }
617 
618  // Record the frame sizes in an un-maximized state
621 
622  // Maximize if we were maximized before
623  if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
624  {
625  wxLogTrace( traceDisplayLocation, "Maximizing window" );
626  Maximize();
627  }
628 
629  m_displayIndex = wxDisplay::GetFromWindow( this );
630 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxPoint m_normalFramePos
wxSize m_normalFrameSize
static const wxSize defaultSize(FRAME_T aFrameType)
static const wxSize minSize(FRAME_T aFrameType)
unsigned int display
Definition: app_settings.h:75

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
aPathis the file name.
Returns
True if successful.

Definition at line 929 of file sim_plot_frame.cpp.

930 {
931  m_workbook->Clear();
932  m_plotNotebook->DeleteAllPages();
933 
934  wxTextFile file( aPath );
935 
936  if( !file.Open() )
937  {
938  updateFrame();
939  return false;
940  }
941 
942  long plotsCount;
943 
944  if( !file.GetFirstLine().ToLong( &plotsCount ) ) // GetFirstLine instead of GetNextLine
945  {
946  file.Close();
947  updateFrame();
948  return false;
949  }
950 
951  for( long i = 0; i < plotsCount; ++i )
952  {
953  long plotType, tracesCount;
954 
955  if( !file.GetNextLine().ToLong( &plotType ) )
956  {
957  updateFrame();
958  return false;
959  }
960 
961  wxString simCommand = file.GetNextLine();
962  NewPlotPanel( simCommand );
963  StartSimulation( simCommand );
964 
965  // Perform simulation, so plots can be added with values
966  do
967  {
968  wxThread::This()->Sleep( 50 );
969  }
970  while( IsSimulationRunning() );
971 
972  if( !file.GetNextLine().ToLong( &tracesCount ) )
973  {
974  updateFrame();
975  return false;
976  }
977 
978  for( long j = 0; j < tracesCount; ++j )
979  {
980  long traceType;
981  wxString name, param;
982 
983  if( !file.GetNextLine().ToLong( &traceType ) )
984  {
985  file.Close();
986  updateFrame();
987  return false;
988  }
989 
990  name = file.GetNextLine();
991  param = file.GetNextLine();
992 
993  if( name.IsEmpty() || param.IsEmpty() )
994  {
995  file.Close();
996  updateFrame();
997  return false;
998  }
999 
1000  addPlot( name, (SIM_PLOT_TYPE) traceType, param );
1001  }
1002  }
1003 
1004  file.Close();
1005 
1006  // Successfully loading a workbook does not count as modyfying it.
1007  m_workbook->ClrModified();
1008 
1009  updateFrame();
1010  return true;
1011 }
SIM_PANEL_BASE * NewPlotPanel(wxString aSimCommand)
Create a new plot panel for a given simulation type and adds it to the main notebook.
void updateFrame()
Update the frame to match the changes to the workbook.
std::unique_ptr< SIM_WORKBOOK > m_workbook
List of currently displayed tuners.
void StartSimulation(const wxString &aSimCommand=wxEmptyString)
wxAuiNotebook * m_plotNotebook
bool IsSimulationRunning()
const char * name
Definition: DXF_plotter.cpp:59
SIM_PLOT_TYPE
Definition: sim_types.h:46
void addPlot(const wxString &aName, SIM_PLOT_TYPE aType, const wxString &aParam)
Add a new plot to the current panel.

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.

128  {
129  m_splitterLeftRight->SetSashPosition( 700 );
130  m_splitterLeftRight->Disconnect( wxEVT_IDLE, wxIdleEventHandler( SIM_PLOT_FRAME_BASE::m_splitterLeftRightOnIdle ), NULL, this );
131  }
void m_splitterLeftRightOnIdle(wxIdleEvent &)
#define NULL
wxSplitterWindow * m_splitterLeftRight

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.

134  {
135  m_splitterPlotAndConsole->SetSashPosition( 500 );
136  m_splitterPlotAndConsole->Disconnect( wxEVT_IDLE, wxIdleEventHandler( SIM_PLOT_FRAME_BASE::m_splitterPlotAndConsoleOnIdle ), NULL, this );
137  }
#define NULL
void m_splitterPlotAndConsoleOnIdle(wxIdleEvent &)
wxSplitterWindow * m_splitterPlotAndConsole

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.

140  {
141  m_splitterSignals->SetSashPosition( 0 );
142  m_splitterSignals->Disconnect( wxEVT_IDLE, wxIdleEventHandler( SIM_PLOT_FRAME_BASE::m_splitterSignalsOnIdle ), NULL, this );
143  }
wxSplitterWindow * m_splitterSignals
void m_splitterSignalsOnIdle(wxIdleEvent &)
#define NULL

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.

146  {
147  m_splitterTuneValues->SetSashPosition( 0 );
148  m_splitterTuneValues->Disconnect( wxEVT_IDLE, wxIdleEventHandler( SIM_PLOT_FRAME_BASE::m_splitterTuneValuesOnIdle ), NULL, this );
149  }
wxSplitterWindow * m_splitterTuneValues
#define NULL
void m_splitterTuneValuesOnIdle(wxIdleEvent &)

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.

254  {
255  Close();
256  }

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

1096 {
1097  SIM_TYPE type = m_exporter->GetSimType();
1098 
1099  if( SIM_PANEL_BASE::IsPlottable( type ) )
1100  {
1101  NewPlotPanel( m_exporter->GetUsedSimCommand() );
1102  updateFrame();
1103  }
1104 }
SIM_PANEL_BASE * NewPlotPanel(wxString aSimCommand)
Create a new plot panel for a given simulation type and adds it to the main notebook.
void updateFrame()
Update the frame to match the changes to the workbook.
static bool IsPlottable(SIM_TYPE aSimType)
SIM_TYPE
< Possible simulation types
Definition: sim_types.h:31
std::unique_ptr< NETLIST_EXPORTER_PSPICE_SIM > m_exporter

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.

1108 {
1109  wxFileDialog openDlg( this, _( "Open simulation workbook" ), m_savedWorkbooksPath, "",
1110  WorkbookFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST );
1111 
1112  if( openDlg.ShowModal() == wxID_CANCEL )
1113  return;
1114 
1115  m_savedWorkbooksPath = openDlg.GetDirectory();
1116 
1117  if( !loadWorkbook( openDlg.GetPath() ) )
1118  DisplayErrorMessage( this, _( "There was an error while opening the workbook file" ) );
1119 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:265
#define _(s)
bool loadWorkbook(const wxString &aPath)
Load plot settings from a file.
static wxString m_savedWorkbooksPath
wxString WorkbookFileWildcard()

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.

1176 {
1177  if( !CurrentPlot() )
1178  return;
1179 
1180  const wxChar SEPARATOR = ';';
1181 
1182  wxFileDialog saveDlg( this, _( "Save Plot Data" ), "", "",
1183  CsvFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1184 
1185  if( saveDlg.ShowModal() == wxID_CANCEL )
1186  return;
1187 
1188  wxFFile out( saveDlg.GetPath(), "wb" );
1189  bool timeWritten = false;
1190 
1191  for( const auto& t : CurrentPlot()->GetTraces() )
1192  {
1193  const TRACE* trace = t.second;
1194 
1195  if( !timeWritten )
1196  {
1197  out.Write( wxString::Format( "Time%c", SEPARATOR ) );
1198 
1199  for( double v : trace->GetDataX() )
1200  out.Write( wxString::Format( "%g%c", v, SEPARATOR ) );
1201 
1202  out.Write( "\r\n" );
1203  timeWritten = true;
1204  }
1205 
1206  out.Write( wxString::Format( "%s%c", t.first, SEPARATOR ) );
1207 
1208  for( double v : trace->GetDataY() )
1209  out.Write( wxString::Format( "%g%c", v, SEPARATOR ) );
1210 
1211  out.Write( "\r\n" );
1212  }
1213 
1214  out.Close();
1215 }
const std::vector< double > & GetDataX() const
wxString CsvFileWildcard()
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
const std::vector< double > & GetDataY() const
const std::map< wxString, TRACE * > & GetTraces() const

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.

1161 {
1162  if( !CurrentPlot() )
1163  return;
1164 
1165  wxFileDialog saveDlg( this, _( "Save Plot as Image" ), "", "",
1166  PngFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1167 
1168  if( saveDlg.ShowModal() == wxID_CANCEL )
1169  return;
1170 
1171  CurrentPlot()->GetPlotWin()->SaveScreenshot( saveDlg.GetPath(), wxBITMAP_TYPE_PNG );
1172 }
mpWindow * GetPlotWin() const
#define _(s)
wxString PngFileWildcard()
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
bool SaveScreenshot(const wxString &filename, wxBitmapType type=wxBITMAP_TYPE_BMP, wxSize imageSize=wxDefaultSize, bool fit=false)
Draw the window on a wxBitmap, then save it to a file.
Definition: mathplot.cpp:2972

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.

1123 {
1124  if( !m_workbook->IsModified() )
1125  return;
1126 
1127  wxString filename = m_simulator->Settings()->GetWorkbookFilename();
1128 
1129  if( filename.IsEmpty() )
1130  {
1131  menuSaveWorkbookAs( event );
1132  return;
1133  }
1134 
1135  if ( !saveWorkbook( Prj().AbsolutePath( m_simulator->Settings()->GetWorkbookFilename() ) ) )
1136  DisplayErrorMessage( this, _( "There was an error while saving the workbook file" ) );
1137 }
bool saveWorkbook(const wxString &aPath)
Save plot settings to a file.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:265
std::unique_ptr< SIM_WORKBOOK > m_workbook
List of currently displayed tuners.
std::shared_ptr< SPICE_SIMULATOR > m_simulator
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
void menuSaveWorkbookAs(wxCommandEvent &event) override
#define _(s)

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.

1141 {
1142  wxString defaultFilename = m_simulator->Settings()->GetWorkbookFilename();
1143 
1144  if( defaultFilename.IsEmpty() )
1145  defaultFilename = Prj().GetProjectName() + wxT( ".wbk" );
1146 
1147  wxFileDialog saveAsDlg( this, _( "Save Simulation Workbook As" ), m_savedWorkbooksPath,
1148  defaultFilename, WorkbookFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1149 
1150  if( saveAsDlg.ShowModal() == wxID_CANCEL )
1151  return;
1152 
1153  m_savedWorkbooksPath = saveAsDlg.GetDirectory();
1154 
1155  if( !saveWorkbook( saveAsDlg.GetPath() ) )
1156  DisplayErrorMessage( this, _( "There was an error while saving the workbook file" ) );
1157 }
bool saveWorkbook(const wxString &aPath)
Save plot settings to a file.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:265
std::shared_ptr< SPICE_SIMULATOR > m_simulator
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
#define _(s)
static wxString m_savedWorkbooksPath
virtual const wxString GetProjectName() const
Return the short name of the project.
Definition: project.cpp:129
wxString WorkbookFileWildcard()

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.

1273 {
1275 
1276  if( plot )
1277  plot->SetDottedCurrentPhase( !plot->GetDottedCurrentPhase() );
1278 }
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

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.

1282 {
1284 
1285  event.Check( plot ? plot->GetDottedCurrentPhase() : false );
1286 }
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

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.

1240 {
1242 
1243  if( plot )
1244  plot->ShowGrid( !plot->IsGridShown() );
1245 }
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

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.

1249 {
1251 
1252  event.Check( plot ? plot->IsGridShown() : false );
1253 }
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

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.

1257 {
1259 
1260  if( plot )
1261  plot->ShowLegend( !plot->IsLegendShown() );
1262 }
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

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.

1266 {
1268  event.Check( plot ? plot->IsLegendShown() : false );
1269 }
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

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.

271  {
272  event.Check( m_plotUseWhiteBg );
273  }

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.

1290 {
1292 
1293  // Rebuild the color list to plot traces
1295 
1296  // Now send changes to all SIM_PLOT_PANEL
1297  for( size_t page = 0; page < m_plotNotebook->GetPageCount(); page++ )
1298  {
1299  wxWindow* curPage = m_plotNotebook->GetPage( page );
1300 
1301  // ensure it is truly a plot panel and not the (zero plots) placeholder
1302  // which is only SIM_PLOT_PANEL_BASE
1303  SIM_PLOT_PANEL* panel = dynamic_cast<SIM_PLOT_PANEL*>( curPage );
1304 
1305  if( panel != nullptr )
1306  {
1307  panel->UpdatePlotColors();
1308  }
1309  }
1310 }
bool GetPlotBgOpt() const
wxAuiNotebook * m_plotNotebook
static void FillDefaultColorList(bool aWhiteBg)
Fills m_colorList by a default set of colors.
void UpdatePlotColors()
Update plot colors

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.

1233 {
1234  if( CurrentPlot() )
1235  CurrentPlot()->GetPlotWin()->Fit();
1236 }
mpWindow * GetPlotWin() const
void Fit() override
Set view to fit global bounding box of all plot layers and refresh display.
Definition: mathplot.cpp:2011
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

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.

1219 {
1220  if( CurrentPlot() )
1221  CurrentPlot()->GetPlotWin()->ZoomIn();
1222 }
mpWindow * GetPlotWin() const
void ZoomIn(const wxPoint &centerPoint=wxDefaultPosition)
Zoom into current view and refresh display.
Definition: mathplot.cpp:2216
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

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.

1226 {
1227  if( CurrentPlot() )
1228  CurrentPlot()->GetPlotWin()->ZoomOut();
1229 }
void ZoomOut(const wxPoint &centerPoint=wxDefaultPosition)
Zoom out current view and refresh display.
Definition: mathplot.cpp:2273
mpWindow * GetPlotWin() const
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

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
aSimTypeis requested simulation type.
Returns
The new plot panel.

Definition at line 513 of file sim_plot_frame.cpp.

514 {
515  SIM_PANEL_BASE* plotPanel = nullptr;
517 
518  if( SIM_PANEL_BASE::IsPlottable( simType ) )
519  {
520  SIM_PLOT_PANEL* panel;
521  panel = new SIM_PLOT_PANEL( aSimCommand, m_plotNotebook, this, wxID_ANY );
522 
524  Pgm().GetCommonSettings()->m_Input.scroll_modifier_zoom != 0 );
525 
526  plotPanel = dynamic_cast<SIM_PANEL_BASE*>( panel );
527  }
528  else
529  {
530  SIM_NOPLOT_PANEL* panel;
531  panel = new SIM_NOPLOT_PANEL( aSimCommand, m_plotNotebook, wxID_ANY );
532  plotPanel = dynamic_cast<SIM_PANEL_BASE*>( panel );
533  }
534 
535  wxString pageTitle( m_simulator->TypeToName( simType, true ) );
536  pageTitle.Prepend( wxString::Format( _( "Plot%u - " ), (unsigned int) ++m_plotNumber ) );
537 
538  m_workbook->AddPlotPanel( plotPanel );
539 
540  m_plotNotebook->AddPage( dynamic_cast<wxWindow*>( plotPanel ), pageTitle, true );
541 
542  updateFrame();
543  return plotPanel;
544 }
void EnableMouseWheelPan(bool enabled)
Enable/disable trackpad friendly panning (2-axis scroll wheel)
Definition: mathplot.h:1220
mpWindow * GetPlotWin() const
void updateFrame()
Update the frame to match the changes to the workbook.
std::unique_ptr< SIM_WORKBOOK > m_workbook
List of currently displayed tuners.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
std::shared_ptr< SPICE_SIMULATOR > m_simulator
static bool IsPlottable(SIM_TYPE aSimType)
static SIM_TYPE CommandToSimType(const wxString &aCmd)
Return simulation type basing on a simulation command directive.
wxAuiNotebook * m_plotNotebook
SIM_TYPE
< Possible simulation types
Definition: sim_types.h:31
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
unsigned int m_plotNumber

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.

583  {
584  m_isNonUserClose = true;
585  return Close( aForce );
586  }

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.

1445 {
1446  if( IsSimulationRunning() )
1447  {
1448  DisplayInfoMessage( this, _( "Simulator is running. Try later" ) );
1449  return;
1450  }
1451 
1452  SIM_PLOT_PANEL* plotPanel = CurrentPlot();
1453 
1454  if( !plotPanel || !m_exporter || plotPanel->GetType() != m_exporter->GetSimType() )
1455  {
1456  DisplayInfoMessage( this, _( "You need to run plot-providing simulation first." ) );
1457  return;
1458  }
1459 
1460  DIALOG_SIGNAL_LIST dialog( this, m_exporter.get() );
1461  dialog.ShowModal();
1462 }
#define _(s)
bool IsSimulationRunning()
SIM_TYPE GetType() const
std::unique_ptr< NETLIST_EXPORTER_PSPICE_SIM > m_exporter
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:280

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.

315 {
316  if( !doAutoSave() )
317  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
318 }
virtual bool doAutoSave()
This should be overridden by the derived class to handle the auto save feature.
wxTimer * m_autoSaveTimer

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.

328 {
329  wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( aKeyEvent ) );
330 
331  // Key events can be filtered here.
332  // Currently no filtering is made.
333  aKeyEvent.Skip();
334 }
wxString dump(const wxArrayString &aArray)
Debug helper for printing wxArrayString contents.
const wxChar *const kicadTraceKeyEvent
Flag to enable wxKeyEvent debug tracing.

References dump(), and kicadTraceKeyEvent.

◆ onCursorUpdate()

void SIM_PLOT_FRAME::onCursorUpdate ( wxCommandEvent &  aEvent)
private

Definition at line 1581 of file sim_plot_frame.cpp.

1582 {
1583  wxSize size = m_cursors->GetClientSize();
1584  SIM_PLOT_PANEL* plotPanel = CurrentPlot();
1585  m_cursors->ClearAll();
1586 
1587  if( !plotPanel )
1588  return;
1589 
1591  m_cursors->SetImageList(m_signalsIconColorList, wxIMAGE_LIST_SMALL);
1592 
1593  // Fill the signals listctrl
1594  m_cursors->AppendColumn( _( "Signal" ), wxLIST_FORMAT_LEFT, size.x / 2 );
1595  const long X_COL = m_cursors->AppendColumn( plotPanel->GetLabelX(), wxLIST_FORMAT_LEFT,
1596  size.x / 4 );
1597 
1598  wxString labelY1 = plotPanel->GetLabelY1();
1599  wxString labelY2 = plotPanel->GetLabelY2();
1600  wxString labelY;
1601 
1602  if( !labelY2.IsEmpty() )
1603  labelY = labelY1 + " / " + labelY2;
1604  else
1605  labelY = labelY1;
1606 
1607  const long Y_COL = m_cursors->AppendColumn( labelY, wxLIST_FORMAT_LEFT, size.x / 4 );
1608 
1609  // Update cursor values
1610  int itemidx = 0;
1611 
1612  for( const auto& trace : plotPanel->GetTraces() )
1613  {
1614  if( CURSOR* cursor = trace.second->GetCursor() )
1615  {
1616  // Find the right icon color in list.
1617  // It is the icon used in m_signals list for the same trace
1618  long iconColor = m_signals->FindItem( -1, trace.first );
1619 
1620  const wxRealPoint coords = cursor->GetCoords();
1621  long idx = m_cursors->InsertItem( itemidx++, trace.first, iconColor );
1622  m_cursors->SetItem( idx, X_COL, SPICE_VALUE( coords.x ).ToSpiceString() );
1623  m_cursors->SetItem( idx, Y_COL, SPICE_VALUE( coords.y ).ToSpiceString() );
1624  }
1625  }
1626 }
wxString ToSpiceString() const
Return string value in Spice format (e.g.
wxImageList * m_signalsIconColorList
A string to store the path of saved workbooks during a session.
wxString GetLabelY1() const
wxString GetLabelX() const
wxString GetLabelY2() const
< Helper class to handle Spice way of expressing values (e.g. 10.5 Meg) Helper class to recognize Spi...
Definition: spice_value.h:34
#define _(s)
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
const std::map< wxString, TRACE * > & GetTraces() const
Cursor attached to a trace to follow its values:

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.

969 {
970  void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
971  ShowAboutDialog( this );
972 }
void ShowAboutDialog(EDA_BASE_FRAME *aParent)
The base frame for deriving all KiCad main window classes.

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent &  aEvent)
inherited

Definition at line 1185 of file eda_base_frame.cpp.

1186 {
1187  // When we maximize the window, we want to save the old information
1188  // so that we can add it to the settings on next window load.
1189  // Contrary to the documentation, this event seems to be generated
1190  // when the window is also being unmaximized on OSX, so we only
1191  // capture the size information when we maximize the window when on OSX.
1192 #ifdef __WXOSX__
1193  if( !IsMaximized() )
1194 #endif
1195  {
1197  m_normalFramePos = GetPosition();
1198  wxLogTrace( traceDisplayLocation, "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
1200  }
1201 
1202  // Skip event to actually maximize the window
1203  aEvent.Skip();
1204 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxPoint m_normalFramePos
wxSize m_normalFrameSize
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.

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.

338 {
339  if( !m_toolDispatcher )
340  aEvent.Skip();
341  else
343 }
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:158

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.

194  {
195  aEvent.Skip();
196  }

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

1337 {
1338  updateSignalList();
1339  wxCommandEvent dummy;
1340  onCursorUpdate( dummy );
1341 
1342  updateWorkbook();
1343  updateFrame();
1344 }
void updateFrame()
Update the frame to match the changes to the workbook.
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:70
void updateWorkbook()
Update the workbook to match the changes in the frame.
void onCursorUpdate(wxCommandEvent &aEvent)
void updateSignalList()
Update the list of currently plotted signals.

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.

1314 {
1315  int idx = event.GetSelection();
1316 
1317  if( idx == wxNOT_FOUND )
1318  return;
1319 
1320  SIM_PANEL_BASE* plotPanel =
1321  dynamic_cast<SIM_PANEL_BASE*>( m_plotNotebook->GetPage( idx ) );
1322 
1323  m_workbook->RemovePlotPanel( plotPanel );
1324  wxCommandEvent dummy;
1325  onCursorUpdate( dummy );
1326 }
std::unique_ptr< SIM_WORKBOOK > m_workbook
List of currently displayed tuners.
wxAuiNotebook * m_plotNotebook
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:70
void onCursorUpdate(wxCommandEvent &aEvent)

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.

1330 {
1331  updateWorkbook();
1332  updateFrame();
1333 }
void updateFrame()
Update the frame to match the changes to the workbook.
void updateWorkbook()
Update the workbook to match the changes in the frame.

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.

1348 {
1349  updateWorkbook();
1350  updateFrame();
1351 }
void updateFrame()
Update the frame to match the changes to the workbook.
void updateWorkbook()
Update the workbook to match the changes in the frame.

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.

976 {
977  PAGED_DIALOG dlg( this, _( "Preferences" ), true );
978  wxTreebook* book = dlg.GetTreebook();
979 
980  book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
981 
982  book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
983 
984  PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
985  book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
986 
987  wxWindow* viewer3D = nullptr;
988 
989  for( unsigned i = 0; i < KIWAY_PLAYER_COUNT; ++i )
990  {
991  KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
992 
993  if( frame )
994  {
995  frame->InstallPreferences( &dlg, hotkeysPanel );
996 
997  if( !viewer3D )
998  viewer3D = wxFindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( frame ) );
999  }
1000  }
1001 
1002  if( viewer3D )
1003  static_cast<EDA_BASE_FRAME*>( viewer3D )->InstallPreferences( &dlg, hotkeysPanel );
1004 
1005  // The Kicad manager frame is not a player so we have to add it by hand
1006  wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
1007 
1008  if( manager )
1009  static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
1010 
1011  for( size_t i = 0; i < book->GetPageCount(); ++i )
1012  book->GetPage( i )->Layout();
1013 
1014  if( dlg.ShowModal() == wxID_OK )
1015  dlg.Kiway().CommonSettingsChanged( false, false );
1016 }
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:64
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:32
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:373
#define _(s)
#define KICAD_MANAGER_FRAME_NAME
#define QUALIFIED_VIEWER3D_FRAMENAME(parent)
virtual void InstallPreferences(PAGED_DIALOG *, PANEL_HOTKEYS_EDITOR *)
Allow a frame to load its preference panels (if any) into the preferences dialog.

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.

1466 {
1467  if( m_schematicFrame == NULL )
1468  return;
1469 
1470  if( IsSimulationRunning() )
1471  {
1472  DisplayInfoMessage( this, _( "Simulator is running. Try later" ) );
1473  return;
1474  }
1475 
1477  m_schematicFrame->Raise();
1478 }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:143
SCH_EDIT_FRAME * m_schematicFrame
#define NULL
#define _(s)
bool IsSimulationRunning()
static TOOL_ACTION simProbe
Definition: ee_actions.h:210
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:280

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.

1392 {
1393  SIM_PANEL_BASE* plotPanelWindow = currentPlotWindow();
1394 
1395  if( !m_settingsDlg )
1396  m_settingsDlg = new DIALOG_SIM_SETTINGS( this, m_simulator->Settings() );
1397 
1398  // Initial processing is required to e.g. display a list of power sources
1400 
1401  if( !m_exporter->ProcessNetlist( NET_ALL_FLAGS ) )
1402  {
1403  DisplayErrorMessage( this, _( "There were errors during netlist export, aborted." ) );
1404  return;
1405  }
1406 
1407  if( m_workbook->HasPlotPanel( plotPanelWindow ) )
1408  m_settingsDlg->SetSimCommand( plotPanelWindow->GetSimCommand() );
1409 
1410  if( m_settingsDlg->ShowModal() == wxID_OK )
1411  {
1412  wxString oldCommand;
1413 
1414  if( m_workbook->HasPlotPanel( plotPanelWindow ) )
1415  oldCommand = plotPanelWindow->GetSimCommand();
1416  else
1417  oldCommand = wxString();
1418 
1419  wxString newCommand = m_settingsDlg->GetSimCommand();
1420  SIM_TYPE newSimType = NETLIST_EXPORTER_PSPICE_SIM::CommandToSimType( newCommand );
1421 
1422  // If it is a new simulation type, open a new plot
1423  // For the DC sim, check if sweep source type has changed (char 4 will contain 'v',
1424  // 'i', 'r' or 't'.
1425  if( !plotPanelWindow
1426  || ( plotPanelWindow && plotPanelWindow->GetType() != newSimType )
1427  || ( newSimType == ST_DC
1428  && oldCommand.Lower().GetChar( 4 ) != newCommand.Lower().GetChar( 4 ) ) )
1429  {
1430  plotPanelWindow = NewPlotPanel( newCommand );
1431  }
1432  else
1433  {
1434  // Update simulation command in the current plot
1435  plotPanelWindow->SetSimCommand( newCommand );
1436  }
1437 
1438  m_simulator->Init();
1439  updateFrame();
1440  }
1441 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:265
bool SetSimCommand(const wxString &aCommand)
SIM_PANEL_BASE * NewPlotPanel(wxString aSimCommand)
Create a new plot panel for a given simulation type and adds it to the main notebook.
void updateFrame()
Update the frame to match the changes to the workbook.
std::unique_ptr< SIM_WORKBOOK > m_workbook
List of currently displayed tuners.
std::shared_ptr< SPICE_SIMULATOR > m_simulator
static SIM_TYPE CommandToSimType(const wxString &aCmd)
Return simulation type basing on a simulation command directive.
const wxString & GetSimCommand() const
void SetSimCommand(const wxString &aSimCommand)
SIM_TYPE
< Possible simulation types
Definition: sim_types.h:31
#define _(s)
SIM_PANEL_BASE * currentPlotWindow() const
Return the currently opened plot panel (or NULL if there is none).
const wxString & GetSimCommand() const
SIM_TYPE GetType() const
DIALOG_SIM_SETTINGS * m_settingsDlg
std::unique_ptr< NETLIST_EXPORTER_PSPICE_SIM > m_exporter
void updateNetlistExporter()
Reload the current schematic for the netlist exporter.

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.

1492 {
1493  class NETLIST_VIEW_DIALOG : public DIALOG_SHIM
1494  {
1495  public:
1496  enum
1497  {
1498  MARGIN_LINE_NUMBERS
1499  };
1500 
1501  void onClose( wxCloseEvent& evt )
1502  {
1503  EndModal( GetReturnCode() );
1504  }
1505 
1506  NETLIST_VIEW_DIALOG( wxWindow* parent, wxString source) :
1507  DIALOG_SHIM( parent, wxID_ANY, "SPICE Netlist",
1508  wxDefaultPosition, wxDefaultSize,
1509  wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER )
1510  {
1511  wxStyledTextCtrl* text = new wxStyledTextCtrl( this, wxID_ANY );
1512  text->SetMinSize( wxSize( 600, 400 ) );
1513 
1514  text->SetMarginWidth( MARGIN_LINE_NUMBERS, 50 );
1515  text->StyleSetForeground( wxSTC_STYLE_LINENUMBER, wxColour( 75, 75, 75 ) );
1516  text->StyleSetBackground( wxSTC_STYLE_LINENUMBER, wxColour( 220, 220, 220 ) );
1517  text->SetMarginType( MARGIN_LINE_NUMBERS, wxSTC_MARGIN_NUMBER );
1518 
1519  wxFont font = wxFont( wxNORMAL_FONT->GetPointSize(), wxFONTFAMILY_TELETYPE,
1520  wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL, false, wxEmptyString );
1521  text->StyleSetFont( wxSTC_STYLE_DEFAULT, font );
1522 
1523  text->SetWrapMode( wxSTC_WRAP_WORD );
1524 
1525  text->SetText( source );
1526 
1527  text->StyleClearAll();
1528  text->SetLexer( wxSTC_LEX_SPICE );
1529 
1530  wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
1531  sizer->Add( text, 1, wxEXPAND );
1532  SetSizer( sizer );
1533 
1534  Connect( wxEVT_CLOSE_WINDOW, wxCloseEventHandler( NETLIST_VIEW_DIALOG::onClose ), NULL,
1535  this );
1536 
1537  finishDialogSettings();
1538  }
1539  };
1540 
1541  if( m_schematicFrame == NULL || m_simulator == NULL )
1542  return;
1543 
1544  NETLIST_VIEW_DIALOG dlg( this, m_simulator->GetNetlist() );
1545  dlg.ShowModal();
1546 }
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition: dialog_shim.h:82
std::shared_ptr< SPICE_SIMULATOR > m_simulator
SCH_EDIT_FRAME * m_schematicFrame
#define NULL

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.

1355 {
1356  // Remove signal from the plot panel when double clicked
1357  long idx = m_signals->GetFocusedItem();
1358 
1359  if( idx != wxNOT_FOUND )
1360  removePlot( m_signals->GetItemText( idx, 0 ) );
1361 }
void removePlot(const wxString &aPlotName, bool aErase=true)
Remove a plot with a specific title.

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.

1365 {
1366  int idx = event.GetIndex();
1367 
1368  if( idx != wxNOT_FOUND )
1369  m_signals->Select( idx );
1370 
1371  idx = m_signals->GetFirstSelected();
1372 
1373  if( idx != wxNOT_FOUND )
1374  {
1375  const wxString& netName = m_signals->GetItemText( idx, 0 );
1376  SIGNAL_CONTEXT_MENU ctxMenu( netName, this );
1377  m_signals->PopupMenu( &ctxMenu );
1378  }
1379 }

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.

1637 {
1638  m_toolBar->SetToolNormalBitmap( ID_SIM_RUN, KiBitmap( BITMAPS::sim_run ) );
1639  SetCursor( wxCURSOR_ARROW );
1640 
1641  SIM_TYPE simType = m_exporter->GetSimType();
1642 
1643  if( simType == ST_UNKNOWN )
1644  return;
1645 
1646  SIM_PANEL_BASE* plotPanelWindow = currentPlotWindow();
1647 
1648  if( !plotPanelWindow || plotPanelWindow->GetType() != simType )
1649  plotPanelWindow = NewPlotPanel( m_exporter->GetUsedSimCommand() );
1650 
1651  if( IsSimulationRunning() )
1652  return;
1653 
1654  // If there are any signals plotted, update them
1655  if( SIM_PANEL_BASE::IsPlottable( simType ) )
1656  {
1657  SIM_PLOT_PANEL* plotPanel = dynamic_cast<SIM_PLOT_PANEL*>( plotPanelWindow );
1658  wxCHECK_RET( plotPanel, "not a SIM_PLOT_PANEL" );
1659 
1660  struct TRACE_DESC
1661  {
1663  wxString m_name;
1664 
1667 
1669  wxString m_param;
1670  };
1671 
1672  std::vector<struct TRACE_DESC> traceInfo;
1673 
1674  // Get information about all the traces on the plot, remove and add again
1675  for( auto& trace : plotPanel->GetTraces() )
1676  {
1677  struct TRACE_DESC placeholder;
1678  placeholder.m_name = trace.second->GetName();
1679  placeholder.m_type = trace.second->GetType();
1680  placeholder.m_param = trace.second->GetParam();
1681 
1682  traceInfo.push_back( placeholder );
1683  }
1684 
1685  for( auto& trace : traceInfo )
1686  {
1687  if( !updatePlot( trace.m_name, trace.m_type, trace.m_param, plotPanel ) )
1688  {
1689  removePlot( trace.m_name, false );
1690  m_workbook->RemoveTrace( plotPanel, trace.m_name );
1691  }
1692  }
1693 
1694  updateSignalList();
1695  plotPanel->GetPlotWin()->UpdateAll();
1696  plotPanel->ResetScales();
1697  updateFrame();
1698  }
1699  else if( simType == ST_OP )
1700  {
1701  m_simConsole->AppendText( _( "\n\nSimulation results:\n\n" ) );
1702  m_simConsole->SetInsertionPointEnd();
1703 
1704  for( const auto& vec : m_simulator->AllPlots() )
1705  {
1706  std::vector<double> val_list = m_simulator->GetRealPlot( vec, 1 );
1707 
1708  if( val_list.size() == 0 ) // The list of values can be empty!
1709  continue;
1710 
1711  double val = val_list.at( 0 );
1712  wxString outLine, signal;
1713  SIM_PLOT_TYPE type = m_exporter->VectorToSignal( vec, signal );
1714 
1715  const size_t tab = 25; //characters
1716  size_t padding = ( signal.length() < tab ) ? ( tab - signal.length() ) : 1;
1717 
1718  outLine.Printf( wxT( "%s%s" ), ( signal + wxT( ":" ) ).Pad( padding, wxUniChar( ' ' ) ),
1719  SPICE_VALUE( val ).ToSpiceString() );
1720 
1721  outLine.Append( type == SPT_CURRENT ? "A\n" : "V\n" );
1722 
1723  m_simConsole->AppendText( outLine );
1724  m_simConsole->SetInsertionPointEnd();
1725 
1726  // @todo display calculated values on the schematic
1727  }
1728  }
1729 }
mpWindow * GetPlotWin() const
SIM_PANEL_BASE * NewPlotPanel(wxString aSimCommand)
Create a new plot panel for a given simulation type and adds it to the main notebook.
void updateFrame()
Update the frame to match the changes to the workbook.
std::unique_ptr< SIM_WORKBOOK > m_workbook
List of currently displayed tuners.
std::shared_ptr< SPICE_SIMULATOR > m_simulator
static bool IsPlottable(SIM_TYPE aSimType)
void UpdateAll()
Refresh display.
Definition: mathplot.cpp:2747
< Helper class to handle Spice way of expressing values (e.g. 10.5 Meg) Helper class to recognize Spi...
Definition: spice_value.h:34
SIM_TYPE
< Possible simulation types
Definition: sim_types.h:31
#define _(s)
SIM_PANEL_BASE * currentPlotWindow() const
Return the currently opened plot panel (or NULL if there is none).
void ResetScales()
Update trace line style.
bool IsSimulationRunning()
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
SIM_TYPE GetType() const
std::unique_ptr< NETLIST_EXPORTER_PSPICE_SIM > m_exporter
bool updatePlot(const wxString &aName, SIM_PLOT_TYPE aType, const wxString &aParam, SIM_PLOT_PANEL *aPanel)
Update plot in a particular SIM_PLOT_PANEL.
void updateSignalList()
Update the list of currently plotted signals.
void removePlot(const wxString &aPlotName, bool aErase=true)
Remove a plot with a specific title.
const std::map< wxString, TRACE * > & GetTraces() const
SIM_PLOT_TYPE
Definition: sim_types.h:46
HOLDER_TYPE m_type
Definition: kiway_holder.h:76

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.

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

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.

1630 {
1631  m_toolBar->SetToolNormalBitmap( ID_SIM_RUN, KiBitmap( BITMAPS::sim_stop ) );
1632  SetCursor( wxCURSOR_ARROWWAIT );
1633 }
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105

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.

1383 {
1384  if( IsSimulationRunning() )
1385  StopSimulation();
1386  else
1387  StartSimulation();
1388 }
void StartSimulation(const wxString &aSimCommand=wxEmptyString)
bool IsSimulationRunning()

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.

1733 {
1734  if( IsSimulationRunning() )
1735  StopSimulation();
1736 
1737  if( CurrentPlot() != m_lastSimPlot )
1738  {
1739  // We need to rerun simulation, as the simulator currently stores
1740  // results for another plot
1741  StartSimulation();
1742  }
1743  else
1744  {
1745  // Incremental update
1746  m_simConsole->Clear();
1747  // Do not export netlist, it is already stored in the simulator
1748  applyTuners();
1749  m_simulator->Run();
1750  }
1751 }
void applyTuners()
Apply component values specified using tuner sliders to the current netlist.
std::shared_ptr< SPICE_SIMULATOR > m_simulator
void StartSimulation(const wxString &aSimCommand=wxEmptyString)
SIM_PLOT_PANEL * m_lastSimPlot
imagelists used to add a small colored icon to signal names and cursors name, the same color as the c...
bool IsSimulationRunning()
SIM_PLOT_PANEL * CurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

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.

509 {
510 #ifdef __WXMAC__
511  int currentDisplay = wxDisplay::GetFromWindow( this );
512 
513  if( m_displayIndex >= 0 && currentDisplay >= 0 && currentDisplay != m_displayIndex )
514  {
515  wxLogTrace( traceDisplayLocation, "OnSize: current display changed %d to %d",
516  m_displayIndex, currentDisplay );
517  m_displayIndex = currentDisplay;
519  }
520 #endif
521 
522  aEvent.Skip();
523 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
void ensureWindowIsOnScreen()

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.

72 {
73  size_t len;
74  wxSocketBase* sock = evt.GetSocket();
75 
76  switch( evt.GetSocketEvent() )
77  {
78  case wxSOCKET_INPUT:
79  sock->Read( client_ipc_buffer, 1 );
80 
81  if( sock->LastCount() == 0 )
82  break; // No data, occurs on opening connection
83 
84  sock->Read( client_ipc_buffer + 1, IPC_BUF_SIZE - 2 );
85  len = 1 + sock->LastCount();
86  client_ipc_buffer[len] = 0;
88  break;
89 
90  case wxSOCKET_LOST:
91  return;
92  break;
93 
94  default:
95  wxPrintf( wxT( "EDA_DRAW_FRAME::OnSockRequest() error: Invalid event !" ) );
96  break;
97  }
98 }
#define IPC_BUF_SIZE
Definition: eda_dde.cpp:39
static char client_ipc_buffer[IPC_BUF_SIZE]
Definition: eda_dde.cpp:40
virtual void ExecuteRemoteCommand(const char *cmdline)
Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242).
Definition: kiway_player.h:196

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.

104 {
105  wxSocketBase* socket;
106  wxSocketServer* server = (wxSocketServer*) evt.GetSocket();
107 
108  socket = server->Accept();
109 
110  if( socket == NULL )
111  return;
112 
113  m_sockets.push_back( socket );
114 
115  socket->Notify( true );
116  socket->SetEventHandler( *this, ID_EDA_SOCKET_EVENT );
117  socket->SetNotify( wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG );
118 }
#define NULL
std::vector< wxSocketBase * > m_sockets
interprocess communication
Definition: kiway_player.h:219

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.

1243 {
1244  // Call the handler to update the colors used in the frame
1246 
1247  // Skip the change event to ensure the rest of the window controls get it
1248  aEvent.Skip();
1249 }
virtual void HandleSystemColorChange()
Update the UI in response to a change in the system colors.

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ onTune()

void SIM_PLOT_FRAME::onTune ( wxCommandEvent &  event)
private

Definition at line 1481 of file sim_plot_frame.cpp.

1482 {
1483  if( m_schematicFrame == NULL )
1484  return;
1485 
1487  m_schematicFrame->Raise();
1488 }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:143
SCH_EDIT_FRAME * m_schematicFrame
#define NULL
static TOOL_ACTION simTune
Definition: ee_actions.h:211
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54

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

119  {
120  // overload me for your wxFrame type.
121 
122  // Any overload should probably do this also:
123  // Prj().MaybeLoadProjectSettings();
124 
125  // Then update the window title.
126 
127  return false;
128  }

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
aParseris the argument parser created by the top-level launcher.

Definition at line 139 of file kiway_player.h.

140  {
141  WXUNUSED( aParser );
142  }

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.

1170 {
1171  return m_redoList.PopCommand();
1172 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_redoList

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

◆ PopTool()

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

Definition at line 61 of file tools_holder.cpp.

62 {
63  // Push/pop events can get out of order (such as when they're generated by the Simulator
64  // frame but not processed until the mouse is back in the Schematic frame), so make sure
65  // we're popping the right stack frame.
66 
67  for( int i = (int) m_toolStack.size() - 1; i >= 0; --i )
68  {
69  if( m_toolStack[ i ] == actionName )
70  {
71  m_toolStack.erase( m_toolStack.begin() + i );
72 
73  // If there's something underneath us, and it's now the top of the stack, then
74  // re-activate it
75  if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
76  {
77  std::string back = m_toolStack[ i ];
79 
80  if( action )
81  {
82  // Pop the action as running it will push it back onto the stack
83  m_toolStack.pop_back();
84 
85  TOOL_EVENT evt = action->MakeEvent();
86  evt.SetHasPosition( false );
87  evt.SetReactivate( true );
88  GetToolManager()->PostEvent( evt );
89  }
90  }
91  else
93 
94  return;
95  }
96  }
97 }
virtual void DisplayToolMsg(const wxString &msg)
Definition: tools_holder.h:121
void SetReactivate(bool aReactivate=true)
Returns information about difference between current mouse cursor position and the place where draggi...
Definition: tool_event.h:253
TOOL_ACTION * FindAction(const std::string &aActionName) const
Find an action with a given name (if there is one available).
Generic, UI-independent tool event.
Definition: tool_event.h:152
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:156
std::vector< std::string > m_toolStack
Definition: tools_holder.h:162
Represent a single user action.
Definition: tool_action.h:67
TOOL_EVENT MakeEvent() const
Return the event associated with the action (i.e.
Definition: tool_action.cpp:72
ACTION_MANAGER * GetActionManager() const
Definition: tool_manager.h:199
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
void PostEvent(const TOOL_EVENT &aEvent)
Put an event to the event queue to be processed at the end of event processing cycle.
static TOOL_ACTION selectionTool
Definition: actions.h:153
void SetHasPosition(bool aHasPosition)
Returns if the action associated with this event should be treated as immediate regardless of the cur...
Definition: tool_event.h:241

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.

811 {
812  SetStatusText( text );
813 }

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.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:186

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), canCloseWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), DIALOG_EXPORT_SVG::ExportSVGFile(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), initWorkbook(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), menuSaveWorkbook(), menuSaveWorkbookAs(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDxf(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), EDA_3D_VIEWER_FRAME::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::saveSymbolAs(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurSymbol(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER_FRAME::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent &  aEvent)
overrideinherited

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

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

Definition at line 256 of file eda_base_frame.cpp.

257 {
258 #ifdef __WXMAC__
259  // Apple in its infinite wisdom will raise a disabled window before even passing
260  // us the event, so we have no way to stop it. Instead, we have to catch an
261  // improperly ordered disabled window and quasi-modal dialog here and reorder
262  // them.
263  if( !IsEnabled() && IsActive() )
264  {
265  wxWindow* dlg = findQuasiModalDialog();
266  if( dlg )
267  dlg->Raise();
268  }
269 #endif
270 
271  if( !wxFrame::ProcessEvent( aEvent ) )
272  return false;
273 
274  if( IsShown() && m_hasAutoSave && IsActive() &&
276  {
277  if( !m_autoSaveState )
278  {
279  wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
280  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
281  m_autoSaveState = true;
282  }
283