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 ()
 
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...
 
void UpdateTunerValue (SCH_SYMBOL *aSymbol, int aId, const wxString &aValue)
 Safely update a field of the associated symbol without dereferencing the symbol. More...
 
SIM_PLOT_PANELGetCurrentPlot () 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, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. 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, bool aVerbose=true)
 Checks if aFileName can be written. More...
 
virtual void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void UpdateStatusBar ()
 Update the status bar information. More...
 
void ShowChangedLanguage () override
 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_boardAdapter
 
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
 
SIM_WORKBOOKm_workbook
 
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 setIconsForMenuItems ()
 Give icons to menuitems of the main menubar. 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)
 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 *aPlotPanel)
 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...
 
wxString getDefaultFilename ()
 Return the default filename (with extension) to be used in file browser dialog. More...
 
wxString getDefaultPath ()
 Return the default path to be used in file browser dialog. More...
 
SIM_PANEL_BASEgetCurrentPlotWindow () const
 Return the currently opened plot panel (or NULL if there is none). More...
 
wxString getCurrentSimCommand () const
 
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 menuSimulateUpdate (wxUpdateUIEvent &event) override
 
void menuAddSignalsUpdate (wxUpdateUIEvent &event) override
 
void menuProbeUpdate (wxUpdateUIEvent &event) override
 
void menuTuneUpdate (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 onWorkbookModified (wxCommandEvent &event)
 
void onWorkbookClrModified (wxCommandEvent &event)
 
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
 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
 
int m_splitterLeftRightSashPosition
 
int m_splitterPlotAndConsoleSashPosition
 
int m_splitterSignalsSashPosition
 
int m_splitterTuneValuesSashPosition
 
bool m_plotUseWhiteBg
 
unsigned int m_plotNumber
 
bool m_simFinished
 

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 113 of file sim_plot_frame.cpp.

113  :
114  SIM_PLOT_FRAME_BASE( aParent ),
115  m_lastSimPlot( nullptr ),
116  m_plotNumber( 0 ),
117  m_simFinished( false )
118 {
119  SetKiway( this, aKiway );
120  m_signalsIconColorList = nullptr;
121 
123 
124  if( m_schematicFrame == nullptr )
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  m_reporter = new SIM_THREAD_REPORTER( this );
152  m_simulator->SetReporter( m_reporter );
153 
154  // the settings dialog will be created later, on demand.
155  // if created in the ctor, for some obscure reason, there is an issue
156  // on Windows: when open it, the simulator frame is sent to the background.
157  // instead of being behind the dialog frame (as it does)
158  m_settingsDlg = nullptr;
159 
161 
162  Bind( EVT_SIM_UPDATE, &SIM_PLOT_FRAME::onSimUpdate, this );
163  Bind( EVT_SIM_REPORT, &SIM_PLOT_FRAME::onSimReport, this );
164  Bind( EVT_SIM_STARTED, &SIM_PLOT_FRAME::onSimStarted, this );
165  Bind( EVT_SIM_FINISHED, &SIM_PLOT_FRAME::onSimFinished, this );
166  Bind( EVT_SIM_CURSOR_UPDATE, &SIM_PLOT_FRAME::onCursorUpdate, this );
167 
168  // Toolbar buttons
169  m_toolSimulate = m_toolBar->AddTool( ID_SIM_RUN, _( "Run/Stop Simulation" ),
170  KiBitmap( BITMAPS::sim_run ), _( "Run Simulation" ), wxITEM_NORMAL );
171  m_toolAddSignals = m_toolBar->AddTool( ID_SIM_ADD_SIGNALS, _( "Add Signals" ),
172  KiBitmap( BITMAPS::sim_add_signal ), _( "Add signals to plot" ), wxITEM_NORMAL );
173  m_toolProbe = m_toolBar->AddTool( ID_SIM_PROBE, _( "Probe" ),
174  KiBitmap( BITMAPS::sim_probe ), _( "Probe signals on the schematic" ), wxITEM_NORMAL );
175  m_toolTune = m_toolBar->AddTool( ID_SIM_TUNE, _( "Tune" ),
176  KiBitmap( BITMAPS::sim_tune ), _( "Tune component values" ), wxITEM_NORMAL );
177  m_toolSettings = m_toolBar->AddTool( wxID_ANY, _( "Sim Parameters" ),
178  KiBitmap( BITMAPS::config ), _( "Simulation parameters and settings" ), wxITEM_NORMAL );
179 
180  // Start all toolbar buttons except settings as disabled
181  m_toolSimulate->Enable( false );
182  m_toolAddSignals->Enable( false );
183  m_toolProbe->Enable( false );
184  m_toolTune->Enable( false );
185  m_toolSettings->Enable( true );
186 
187  Bind( wxEVT_UPDATE_UI, &SIM_PLOT_FRAME::menuSimulateUpdate, this, m_toolSimulate->GetId() );
188  Bind( wxEVT_UPDATE_UI, &SIM_PLOT_FRAME::menuAddSignalsUpdate, this,
189  m_toolAddSignals->GetId() );
190  Bind( wxEVT_UPDATE_UI, &SIM_PLOT_FRAME::menuProbeUpdate, this, m_toolProbe->GetId() );
191  Bind( wxEVT_UPDATE_UI, &SIM_PLOT_FRAME::menuTuneUpdate, this, m_toolTune->GetId() );
192 
193  Bind( wxEVT_COMMAND_TOOL_CLICKED, &SIM_PLOT_FRAME::onSimulate, this, m_toolSimulate->GetId() );
194  Bind( wxEVT_COMMAND_TOOL_CLICKED, &SIM_PLOT_FRAME::onAddSignal, this,
195  m_toolAddSignals->GetId() );
196  Bind( wxEVT_COMMAND_TOOL_CLICKED, &SIM_PLOT_FRAME::onProbe, this, m_toolProbe->GetId() );
197  Bind( wxEVT_COMMAND_TOOL_CLICKED, &SIM_PLOT_FRAME::onTune, this, m_toolTune->GetId() );
198  Bind( wxEVT_COMMAND_TOOL_CLICKED, &SIM_PLOT_FRAME::onSettings, this, m_toolSettings->GetId() );
199 
200  Bind( EVT_WORKBOOK_MODIFIED, &SIM_PLOT_FRAME::onWorkbookModified, this );
201  Bind( EVT_WORKBOOK_CLR_MODIFIED, &SIM_PLOT_FRAME::onWorkbookClrModified, this );
202 
203  // Bind toolbar buttons event to existing menu event handlers, so they behave the same
204  Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onSimulate, this,
205  m_runSimulation->GetId() );
206  Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onAddSignal, this, m_addSignals->GetId() );
207  Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onProbe, this, m_probeSignals->GetId() );
208  Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onTune, this, m_tuneValue->GetId() );
209  Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onShowNetlist, this,
210  m_showNetlist->GetId() );
211  Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onSettings, this,
212  m_boardAdapter->GetId() );
213 
214  m_toolBar->Realize();
215 
216 #ifndef wxHAS_NATIVE_TABART
217  // Non-native default tab art has ugly gradients we don't want
218  m_workbook->SetArtProvider( new wxAuiSimpleTabArt() );
219 #endif
220 
221  // Ensure new items are taken in account by sizers:
222  Layout();
223 
224  // resize the subwindows size. At least on Windows, calling wxSafeYield before
225  // resizing the subwindows forces the wxSplitWindows size events automatically generated
226  // by wxWidgets to be executed before our resize code.
227  // Otherwise, the changes made by setSubWindowsSashSize are overwritten by one these
228  // events
229  wxSafeYield();
231 
232  // Ensure the window is on top
233  Raise();
234 
235  initWorkbook();
236  updateTitle();
237 }
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
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:393
Schematic editor (Eeschema) main window.
void onWorkbookModified(wxCommandEvent &event)
void onSimUpdate(wxCommandEvent &aEvent)
SIM_THREAD_REPORTER * m_reporter
List of currently displayed tuners.
std::shared_ptr< SPICE_SIMULATOR > m_simulator
void menuProbeUpdate(wxUpdateUIEvent &event) override
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...
static void FillDefaultColorList(bool aWhiteBg)
Fills m_colorList by a default set of colors.
wxMenuItem * m_runSimulation
void onSimReport(wxCommandEvent &aEvent)
void menuTuneUpdate(wxUpdateUIEvent &event) override
void onSimFinished(wxCommandEvent &aEvent)
void onShowNetlist(wxCommandEvent &event)
#define _(s)
wxToolBarToolBase * m_toolAddSignals
static std::shared_ptr< SPICE_SIMULATOR > CreateInstance(const std::string &aName)
void onWorkbookClrModified(wxCommandEvent &event)
void menuAddSignalsUpdate(wxUpdateUIEvent &event) override
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
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)
void menuSimulateUpdate(wxUpdateUIEvent &event) override
SIM_WORKBOOK * m_workbook
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 updateTitle()
Set the main window title bar text.
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(), 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_boardAdapter, SIM_PLOT_FRAME_BASE::m_probeSignals, m_reporter, SIM_PLOT_FRAME_BASE::m_runSimulation, m_schematicFrame, 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, SIM_PLOT_FRAME_BASE::m_workbook, menuAddSignalsUpdate(), menuProbeUpdate(), menuSimulateUpdate(), menuTuneUpdate(), onAddSignal(), onCursorUpdate(), onProbe(), onSettings(), onShowNetlist(), onSimFinished(), onSimReport(), onSimStarted(), onSimulate(), onSimUpdate(), onTune(), onWorkbookClrModified(), onWorkbookModified(), KIWAY::Player(), setIconsForMenuItems(), KIWAY_HOLDER::SetKiway(), setSubWindowsSashSize(), sim_add_signal, sim_probe, sim_run, sim_tune, simulator, updateNetlistExporter(), and updateTitle().

◆ ~SIM_PLOT_FRAME()

SIM_PLOT_FRAME::~SIM_PLOT_FRAME ( )

Definition at line 240 of file sim_plot_frame.cpp.

241 {
242  m_simulator->SetReporter( nullptr );
243  delete m_reporter;
244  delete m_signalsIconColorList;
245 
246  if( m_settingsDlg )
247  m_settingsDlg->Destroy();
248 }
wxImageList * m_signalsIconColorList
SIM_THREAD_REPORTER * m_reporter
List of currently displayed tuners.
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 529 of file sim_plot_frame.cpp.

530 {
531  addPlot( aDeviceName, SPT_CURRENT, aParam );
532 }
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 631 of file sim_plot_frame.cpp.

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

References _, GetCurrentPlot(), 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 460 of file eda_base_frame.cpp.

461 {
462  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
463  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
464 
465  helpMenu->Add( ACTIONS::help );
466  helpMenu->Add( ACTIONS::gettingStarted );
467  helpMenu->Add( ACTIONS::listHotKeys );
468  helpMenu->Add( ACTIONS::getInvolved );
469  helpMenu->Add( ACTIONS::donate );
470  helpMenu->Add( ACTIONS::reportBug );
471 
472  helpMenu->AppendSeparator();
473  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
474 
475  // Trailing space keeps OSX from hijacking our menu (and disabling everything in it).
476  aMenuBar->Append( helpMenu, _( "&Help" ) + wxS( " " ) );
477 }
static TOOL_ACTION listHotKeys
Definition: actions.h:179
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:182
static TOOL_ACTION donate
Definition: actions.h:180
#define _(s)
Handle actions that are shared between different applications.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
static TOOL_ACTION help
Definition: actions.h:178
static TOOL_ACTION getInvolved
Definition: actions.h:181
static TOOL_ACTION gettingStarted
Definition: actions.h:177

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(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_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 535 of file sim_plot_frame.cpp.

536 {
537  SIM_PANEL_BASE* plotPanel = getCurrentPlotWindow();
538 
539  if( !plotPanel )
540  return;
541 
542  // For now limit the tuner tool to RLC components
543  char primitiveType = NETLIST_EXPORTER_PSPICE::GetSpiceField( SF_PRIMITIVE, aSymbol, 0 )[0];
544 
545  if( primitiveType != SP_RESISTOR && primitiveType != SP_CAPACITOR
546  && primitiveType != SP_INDUCTOR )
547  return;
548 
549  const wxString componentName = aSymbol->GetField( REFERENCE_FIELD )->GetText();
550 
551  // Do not add multiple instances for the same component
552  auto tunerIt = std::find_if( m_tuners.begin(), m_tuners.end(), [&]( const TUNER_SLIDER* t )
553  {
554  return t->GetComponentName() == componentName;
555  }
556  );
557 
558  if( tunerIt != m_tuners.end() )
559  return; // We already have it
560 
561  try
562  {
563  TUNER_SLIDER* tuner = new TUNER_SLIDER( this, m_tunePanel, aSymbol );
564  m_tuneSizer->Add( tuner );
565  m_tuners.push_back( tuner );
566  m_tunePanel->Layout();
567  }
568  catch( const KI_PARAM_ERROR& e )
569  {
570  // Sorry, no bonus
571  DisplayErrorMessage( nullptr, e.What() );
572  }
573 }
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:292
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:705
std::list< TUNER_SLIDER * > m_tuners
SIM_PANEL_BASE * getCurrentPlotWindow() 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:154
Hold a translatable error message and may be used when throwing exceptions containing a translated er...
Definition: ki_exception.h:44

References DisplayErrorMessage(), getCurrentPlotWindow(), 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 523 of file sim_plot_frame.cpp.

524 {
525  addPlot( aNetName, SPT_VOLTAGE, "V" );
526 }
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 hard coding

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 1608 of file sim_plot_frame.cpp.

1609 {
1610  if( m_workbook->IsModified() )
1611  {
1612  wxFileName filename = m_simulator->Settings()->GetWorkbookFilename();
1613 
1614  if( filename.GetName().IsEmpty() )
1615  {
1616  if( Prj().GetProjectName().IsEmpty() )
1617  filename.SetFullName( wxT( "noname.wbk" ) );
1618  else
1619  filename.SetFullName( Prj().GetProjectName() + wxT( ".wbk" ) );
1620  }
1621 
1622  wxString fullFilename = filename.GetFullName();
1623  wxString msg = _( "Save changes to '%s' before closing?" );
1624 
1625  return HandleUnsavedChanges( this, wxString::Format( msg, fullFilename ),
1626  [&]() -> bool
1627  {
1628  return saveWorkbook( Prj().AbsolutePath( fullFilename ) );
1629  } );
1630  }
1631 
1632  return true;
1633 }
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:239
std::shared_ptr< SPICE_SIMULATOR > m_simulator
bool IsModified() const
Definition: sim_workbook.h:68
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
SIM_WORKBOOK * m_workbook
virtual const wxString GetProjectName() const
Return the short name of the project.
Definition: project.cpp:128

References _, Format(), PROJECT::GetProjectName(), HandleUnsavedChanges(), SIM_WORKBOOK::IsModified(), m_simulator, SIM_PLOT_FRAME_BASE::m_workbook, KIWAY_HOLDER::Prj(), and saveWorkbook().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 1203 of file eda_base_frame.cpp.

1204 {
1205  SetUserUnits( aUnits );
1207 
1208  wxCommandEvent e( UNITS_CHANGED );
1209  ProcessEventLocally( e );
1210 }
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)
virtualinherited

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

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

Parameters
aFileNameA wxFileName object containing the file name to check.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1091 of file eda_base_frame.cpp.

1092 {
1093  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
1094 
1095  wxFileName autoSaveFileName = aFileName;
1096 
1097  // Check for auto save file.
1098  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
1099 
1100  wxLogTrace( traceAutoSave,
1101  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
1102 
1103  if( !autoSaveFileName.FileExists() )
1104  return;
1105 
1106  wxString msg = wxString::Format( _(
1107  "Well this is potentially embarrassing!\n"
1108  "It appears that the last time you were editing the file\n"
1109  "%s\n"
1110  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
1111  aFileName.GetFullName()
1112  );
1113 
1114  int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
1115  this );
1116 
1117  // Make a backup of the current file, delete the file, and rename the auto save file to
1118  // the file name.
1119  if( response == wxYES )
1120  {
1121  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1122  {
1123  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1124  Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1125  }
1126  }
1127  else
1128  {
1129  wxLogTrace( traceAutoSave,
1130  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1131 
1132  // Remove the auto save file when using the previous file as is.
1133  wxRemoveFile( autoSaveFileName.GetFullPath() );
1134  }
1135 }
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().

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

977 {
978  if( !aFileHistory )
979  aFileHistory = m_fileHistory;
980 
981  wxASSERT( aFileHistory );
982 
983  aFileHistory->ClearFileHistory();
984 
985  // Update the menubar to update the file history menu
986  if( GetMenuBar() )
987  {
988  ReCreateMenuBar();
989  GetMenuBar()->Refresh();
990  }
991 }
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 545 of file eda_base_frame.h.

546  { }

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

◆ ClearUndoRedoList()

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

493 {
494  TOOLS_HOLDER::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
495 
496  COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
497 
498  if( m_fileHistory )
499  {
500  int historySize = settings->m_System.file_history_size;
501  m_fileHistory->SetMaxFiles( (unsigned) std::max( 0, historySize ) );
502  }
503 
505  ThemeChanged();
506 
507  if( GetMenuBar() )
508  {
509  // For icons in menus, icon scaling & hotkeys
510  ReCreateMenuBar();
511  GetMenuBar()->Refresh();
512  }
513 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void ThemeChanged()
Notifies the store that the icon theme has been changed by the user, so caches must be invalidated.
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(), BITMAP_STORE::ThemeChanged(), 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 816 of file eda_base_frame.cpp.

817 {
818  // KICAD_MANAGER_FRAME overrides this
819  return Kiface().KifaceSettings();
820 }
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:92

References Kiface(), and KIFACE_BASE::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(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), 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(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), 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 358 of file eda_base_frame.h.

359  {
360  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
361  return baseCfgName;
362  }
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 841 of file eda_base_frame.cpp.

842 {
843 #if defined( __WXOSX_MAC__ )
845 #else
846  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
847 
848  m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( wxT( "InfoBar" ) ).Top().Layer(1) );
849 #endif
850 }
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 43 of file eda_dde.cpp.

44 {
45  wxIPV4address addr;
46 
47  // Set the port number
48  addr.Service( service );
49 
50  // Listen on localhost only if requested
51  if( local )
52  addr.Hostname( HOSTNAME );
53 
54  delete m_socketServer;
55  m_socketServer = new wxSocketServer( addr );
56 
57  m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
58  m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
59  m_socketServer->Notify( true );
60 }
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().

◆ 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:164
static TOOL_ACTION selectionTool
Definition: actions.h:153

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

Referenced by TOOL_MANAGER::processEvent(), and TOOLS_HOLDER::ShowChangedLanguage().

◆ Destroy()

◆ DismissModal()

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

Definition at line 166 of file kiway_player.cpp.

167 {
168  m_modal_ret_val = aRetVal;
169  m_modal_string = aResult;
170 
171  if( m_modal_loop )
172  {
173  m_modal_loop->Exit();
174  m_modal_loop = nullptr; // this marks it as dismissed.
175  }
176 
177  Show( false );
178 }
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(), TOOLS_HOLDER::PushTool(), and TOOLS_HOLDER::ShowChangedLanguage().

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

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

Returns
true if the auto save was successful otherwise false.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 327 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void SIM_PLOT_FRAME::doCloseWindow ( )
overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 1636 of file sim_plot_frame.cpp.

1637 {
1638  if( m_simulator->IsRunning() )
1639  m_simulator->Stop();
1640 
1641  // Cancel a running simProbe or simTune tool
1643 
1644  SaveSettings( config() );
1645  Destroy();
1646 }
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 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(), m_schematicFrame, m_simulator, TOOL_MANAGER::RunAction(), and SaveSettings().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )
protectedinherited

Definition at line 657 of file eda_base_frame.cpp.

658 {
659  wxDisplay display( wxDisplay::GetFromWindow( this ) );
660  wxRect clientSize = display.GetClientArea();
661  wxPoint pos = GetPosition();
662  wxSize size = GetWindowSize();
663 
664  wxLogTrace( traceDisplayLocation,
665  wxT( "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d" ), clientSize.x, clientSize.y,
666  clientSize.width, clientSize.height );
667 
668  if( pos.y < clientSize.y )
669  {
670  wxLogTrace( traceDisplayLocation,
671  wxT( "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d" ), pos.y,
672  clientSize.y );
673  pos.y = clientSize.y;
674  }
675 
676  if( pos.x < clientSize.x )
677  {
678  wxLogTrace( traceDisplayLocation,
679  wxT( "ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d" ), pos.x,
680  clientSize.x );
681  pos.x = clientSize.x;
682  }
683 
684  if( pos.x + size.x - clientSize.x > clientSize.width )
685  {
686  int newWidth = clientSize.width - ( pos.x - clientSize.x );
687  wxLogTrace( traceDisplayLocation,
688  wxT( "ensureWindowIsOnScreen: effective width %d above available %d, setting to %d" ),
689  pos.x + size.x, clientSize.width, newWidth );
690  size.x = newWidth;
691  }
692 
693  if( pos.y + size.y - clientSize.y > clientSize.height )
694  {
695  int newHeight = clientSize.height - ( pos.y - clientSize.y );
696  wxLogTrace( traceDisplayLocation,
697  wxT( "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d" ),
698  pos.y + size.y, clientSize.height, newHeight );
699  size.y = newHeight;
700  }
701 
702  wxLogTrace( traceDisplayLocation, wxT( "Updating window position (%d, %d) with size (%d, %d)" ),
703  pos.x, pos.y, size.x, size.y );
704 
705  SetSize( pos.x, pos.y, size.x, size.y );
706 }
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 853 of file eda_base_frame.cpp.

854 {
855 #if defined( __WXOSX_MAC__ )
856  m_auimgr.Update();
857 #else
858  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
859  // hiding it.
860  m_auimgr.Update();
861 
862  // We don't want the infobar displayed right away
863  m_auimgr.GetPane( wxT( "InfoBar" ) ).Hide();
864  m_auimgr.Update();
865 #endif
866 }
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

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

439 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentPlot()

SIM_PLOT_PANEL * SIM_PLOT_FRAME::GetCurrentPlot ( ) const

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

Definition at line 607 of file sim_plot_frame.cpp.

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

References getCurrentPlotWindow(), 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().

◆ getCurrentPlotWindow()

SIM_PANEL_BASE* SIM_PLOT_FRAME::getCurrentPlotWindow ( ) const
inlineprivate

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

Definition at line 246 of file sim_plot_frame.h.

247  {
248  return dynamic_cast<SIM_PANEL_BASE*>( m_workbook->GetCurrentPage() );
249  }
SIM_WORKBOOK * m_workbook

References SIM_PLOT_FRAME_BASE::m_workbook.

Referenced by AddTuner(), GetCurrentPlot(), getCurrentSimCommand(), onSettings(), and onSimFinished().

◆ 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, SYMBOL_EDIT_FRAME, DISPLAY_FOOTPRINTS_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:162

References TOOLS_HOLDER::m_dummySelection.

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

◆ getCurrentSimCommand()

wxString SIM_PLOT_FRAME::getCurrentSimCommand ( ) const
inlineprivate

Definition at line 254 of file sim_plot_frame.h.

255  {
256  if( getCurrentPlotWindow() == nullptr )
257  return m_exporter->GetSheetSimCommand();
258  else
260  }
SIM_PANEL_BASE * getCurrentPlotWindow() const
Return the currently opened plot panel (or NULL if there is none).
const wxString & GetSimCommand(const SIM_PANEL_BASE *aPlotPanel)
Definition: sim_workbook.h:62
std::unique_ptr< NETLIST_EXPORTER_PSPICE_SIM > m_exporter
SIM_WORKBOOK * m_workbook

References getCurrentPlotWindow(), SIM_WORKBOOK::GetSimCommand(), m_exporter, and SIM_PLOT_FRAME_BASE::m_workbook.

Referenced by menuSimulateUpdate(), and StartSimulation().

◆ getDefaultFilename()

wxString SIM_PLOT_FRAME::getDefaultFilename ( )
private

Return the default filename (with extension) to be used in file browser dialog.

Definition at line 1100 of file sim_plot_frame.cpp.

1101 {
1102  wxFileName filename = m_simulator->Settings()->GetWorkbookFilename();
1103 
1104  if( filename.GetName().IsEmpty() )
1105  {
1106  if( Prj().GetProjectName().IsEmpty() )
1107  {
1108  filename.SetName( _( "noname" ) );
1109  filename.SetExt( WorkbookFileExtension );
1110  }
1111  else
1112  {
1113  filename.SetName( Prj().GetProjectName() );
1114  filename.SetExt( WorkbookFileExtension );
1115  }
1116  }
1117 
1118  return filename.GetFullName();
1119 }
std::shared_ptr< SPICE_SIMULATOR > m_simulator
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
#define _(s)
virtual const wxString GetProjectName() const
Return the short name of the project.
Definition: project.cpp:128
const std::string WorkbookFileExtension

References _, PROJECT::GetProjectName(), m_simulator, KIWAY_HOLDER::Prj(), and WorkbookFileExtension.

Referenced by menuSaveWorkbookAs().

◆ getDefaultPath()

wxString SIM_PLOT_FRAME::getDefaultPath ( )
private

Return the default path to be used in file browser dialog.

Definition at line 1122 of file sim_plot_frame.cpp.

1123 {
1124  wxFileName path = m_simulator->Settings()->GetWorkbookFilename();
1125 
1126  path.Normalize( wxPATH_NORM_ALL, Prj().GetProjectPath() );
1127  return path.GetPath();
1128 }
std::shared_ptr< SPICE_SIMULATOR > m_simulator
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.

References m_simulator, path, and KIWAY_HOLDER::Prj().

Referenced by menuOpenWorkbook(), and menuSaveWorkbookAs().

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

129 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:171

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

135 { return m_dragAction; }
MOUSE_DRAG_ACTION m_dragAction
Definition: tools_holder.h:175

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 617 of file sim_plot_frame.cpp.

618 {
619  return m_exporter.get();
620 }
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 936 of file eda_base_frame.cpp.

938 {
939  if( !aFileHistory )
940  aFileHistory = m_fileHistory;
941 
942  wxASSERT( aFileHistory );
943 
944  int baseId = aFileHistory->GetBaseId();
945 
946  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
947 
948  unsigned i = cmdId - baseId;
949 
950  if( i < aFileHistory->GetCount() )
951  {
952  wxString fn = aFileHistory->GetHistoryFile( i );
953 
954  if( wxFileName::FileExists( fn ) )
955  {
956  return fn;
957  }
958  else
959  {
960  DisplayErrorMessage( this, wxString::Format( _( "File '%s' was not found." ), fn ) );
961  aFileHistory->RemoveFileFromHistory( i );
962  }
963  }
964 
965  // Update the menubar to update the file history menu
966  if( GetMenuBar() )
967  {
968  ReCreateMenuBar();
969  GetMenuBar()->Refresh();
970  }
971 
972  return wxEmptyString;
973 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:292
#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 _, DisplayErrorMessage(), 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 423 of file eda_base_frame.h.

424  {
425  return *m_fileHistory;
426  }
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 582 of file eda_base_frame.h.

582 { 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 141 of file tools_holder.h.

141 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:177

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 136 of file sim_plot_frame.h.

136 { 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(), GetSettingsManager(), 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(), 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_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_FP_EDITOR_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, and SCH_EDIT_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 623 of file sim_plot_frame.cpp.

624 {
625  wxASSERT( m_simulator->Settings() );
626 
627  return m_simulator->Settings();
628 }
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 145 of file sim_plot_frame.h.

145 { 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:158

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(), DIALOG_PAD_PROPERTIES::initValues(), 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_ABOUT::onDonateClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_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_SYMBOL_FIELDS_TABLE::OnTableCellClick(), onTune(), PANEL_KICAD_LAUNCHER::PANEL_KICAD_LAUNCHER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), Refresh(), 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_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), DIALOG_NETLIST_IMPORT::~DIALOG_NETLIST_IMPORT(), 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(), EE_INSPECTION_TOOL::CheckSymbol(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_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(), SCH_PIN::GetMsgPanelInfo(), PL_EDITOR_LAYOUT::GetMsgPanelInfo(), PCB_MARKER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), FP_TEXT_GRID_TABLE::GetValue(), PIN_TABLE_DATA_MODEL::GetValue(), RC_TREE_MODEL::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), 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(), FP_TEXT_GRID_TABLE::SetValue(), PIN_TABLE_DATA_MODEL::SetValue(), EDA_SHAPE::ShapeGetMsgPanelInfo(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), PIN_TABLE_DATA_MODEL::SortRows(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), 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(), ROUTER_TOOL::UpdateMessagePanel(), 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 306 of file sim_plot_frame.cpp.

307 {
308  EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( aCfg );
309  wxASSERT( cfg );
310 
311  return cfg ? &cfg->m_Simulator.window : nullptr;
312 }

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

1238 {
1239 #ifdef __WXGTK__
1240  wxSize winSize = GetSize();
1241 
1242  // GTK includes the window decorations in the normal GetSize call,
1243  // so we have to use a GTK-specific sizing call that returns the
1244  // non-decorated window size.
1245  if( m_ident == KICAD_MAIN_FRAME_T )
1246  {
1247  int width = 0;
1248  int height = 0;
1249  GTKDoGetSize( &width, &height );
1250 
1251  winSize.Set( width, height );
1252  }
1253 #else
1254  wxSize winSize = GetSize();
1255 #endif
1256 
1257  return winSize;
1258 }

References KICAD_MAIN_FRAME_T, and EDA_BASE_FRAME::m_ident.

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 1131 of file sim_plot_frame.cpp.

1132 {
1133  switch( aType )
1134  {
1136  case ST_AC: return SPT_LIN_FREQUENCY;
1137  case ST_DC: return SPT_SWEEP;
1138  case ST_TRANSIENT: return SPT_TIME;
1139  default:
1140  wxASSERT_MSG( false, "Unhandled simulation type" );
1141  return (SIM_PLOT_TYPE) 0;
1142  }
1143 }
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 1261 of file eda_base_frame.cpp.

1262 {
1263  // Update the icon theme when the system theme changes and update the toolbars
1265  ThemeChanged();
1266 
1267  // This isn't handled by ThemeChanged()
1268  if( GetMenuBar() )
1269  {
1270  // For icons in menus, icon scaling & hotkeys
1271  ReCreateMenuBar();
1272  GetMenuBar()->Refresh();
1273  }
1274 }
void ThemeChanged()
Notifies the store that the icon theme has been changed by the user, so caches must be invalidated.
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(), BITMAP_STORE::ThemeChanged(), 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 376 of file eda_base_frame.cpp.

378 {
379  bool checkRes = false;
380  bool enableRes = true;
381  bool showRes = true;
382  bool isCut = aEvent.GetId() == ACTIONS::cut.GetUIId();
383  bool isCopy = aEvent.GetId() == ACTIONS::copy.GetUIId();
384  bool isPaste = aEvent.GetId() == ACTIONS::paste.GetUIId();
385  SELECTION& selection = aFrame->GetCurrentSelection();
386 
387  try
388  {
389  checkRes = aCond.checkCondition( selection );
390  enableRes = aCond.enableCondition( selection );
391  showRes = aCond.showCondition( selection );
392  }
393  catch( std::exception& )
394  {
395  // Something broke with the conditions, just skip the event.
396  aEvent.Skip();
397  return;
398  }
399 
400  if( isCut || isCopy || isPaste )
401  {
402  wxWindow* focus = wxWindow::FindFocus();
403  wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( focus );
404 
405  if( textEntry && isCut && textEntry->CanCut() )
406  enableRes = true;
407  else if( textEntry && isCopy && textEntry->CanCopy() )
408  enableRes = true;
409  else if( textEntry && isPaste && textEntry->CanPaste() )
410  enableRes = true;
411  }
412 
413  aEvent.Enable( enableRes );
414  aEvent.Show( showRes );
415 
416  // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
417  // checked, since wxMenuItems don't want to be checked unless they actually are checkable
418 #if wxCHECK_VERSION( 3, 1, 5 )
419  if( aEvent.IsCheckable() )
420  aEvent.Check( checkRes );
421 #else
422  bool canCheck = true;
423 
424  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to
425  // check to see if they can be and can't just universally apply a check in this event.
426  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
427  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
428 
429  if( canCheck )
430  aEvent.Check( checkRes );
431 #endif
432 }
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
int GetUIId() const
Definition: tool_action.h:130
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
static TOOL_ACTION copy
Definition: actions.h:67
static TOOL_ACTION cut
Definition: actions.h:66
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:101
static TOOL_ACTION paste
Definition: actions.h:68

References ACTION_CONDITIONS::checkCondition, ACTIONS::copy, ACTIONS::cut, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), TOOL_ACTION::GetUIId(), ACTIONS::paste, 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 829 of file eda_base_frame.cpp.

830 {
831  return Kiface().GetHelpFileName();
832 }
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
const wxString & GetHelpFileName() const
Return just the basename portion of the current help file.
Definition: kiface_base.h:109

References KIFACE_BASE::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 1145 of file eda_base_frame.cpp.

1146 {
1147  wxAcceleratorEntry entries[1];
1148  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
1149  wxAcceleratorTable accel( 1, entries );
1150  SetAcceleratorTable( accel );
1151 }

◆ 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 315 of file sim_plot_frame.cpp.

316 {
317  // Removed for the time being. We cannot run the simulation on simulator launch, as it may
318  // take a lot of time, confusing the user.
319  // TODO: Change workbook loading routines so that they don't run the simulation until the user
320  // initiates it.
321 
322  /*if( !m_simulator->Settings()->GetWorkbookFilename().IsEmpty() )
323  {
324  wxFileName filename = m_simulator->Settings()->GetWorkbookFilename();
325  filename.SetPath( Prj().GetProjectPath() );
326 
327  if( !loadWorkbook( filename.GetFullPath() ) )
328  m_simulator->Settings()->SetWorkbookFilename( "" );
329  }*/
330 }

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

298 { }

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

617 { 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 1138 of file eda_base_frame.cpp.

1139 {
1140  // This function should be overridden in child classes
1141  return false;
1142 }

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:164
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 160 of file kiway_player.cpp.

161 {
162  return !m_modal_loop;
163 }
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().

◆ 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(), CONVERT_TOOL::CreatePolys(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), 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(), PCB_EDITOR_CONDITIONS::get45degModeFunc(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), CONVERT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), DIALOG_FIELD_PROPERTIES::init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SYMBOL_EDITOR_CONTROL::Revert(), SYMBOL_EDITOR_CONTROL::Save(), APPEARANCE_CONTROLS::setVisibleObjects(), EE_INSPECTION_TOOL::ShowDatasheet(), EE_INSPECTION_TOOL::ShowERCDialog(), DRAWING_TOOL::ToggleLine45degMode(), SYMBOL_EDITOR_CONTROL::ToggleSymbolTree(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), and DRAWING_TOOL::updateStatusBar().

◆ IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName &  aFileName,
bool  aVerbose = true 
)
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.
aVerboseIf true will show an error dialog if the file is not writable
Returns
False if aFileName cannot be written.

Definition at line 1045 of file eda_base_frame.cpp.

1046 {
1047  wxString msg;
1048  wxFileName fn = aFileName;
1049 
1050  // Check for absence of a file path with a file name. Unfortunately KiCad
1051  // uses paths relative to the current project path without the ./ part which
1052  // confuses wxFileName. Making the file name path absolute may be less than
1053  // elegant but it solves the problem.
1054  if( fn.GetPath().IsEmpty() && fn.HasName() )
1055  fn.MakeAbsolute();
1056 
1057  wxCHECK_MSG( fn.IsOk(), false,
1058  wxT( "File name object is invalid. Bad programmer!" ) );
1059  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
1060  wxT( "File name object path <" ) + fn.GetFullPath() +
1061  wxT( "> is not set. Bad programmer!" ) );
1062 
1063  if( fn.IsDir() && !fn.IsDirWritable() )
1064  {
1065  msg.Printf( _( "Insufficient permissions to folder '%s'." ),
1066  fn.GetPath() );
1067  }
1068  else if( !fn.FileExists() && !fn.IsDirWritable() )
1069  {
1070  msg.Printf( _( "Insufficient permissions to save file '%s'." ),
1071  fn.GetFullName(), fn.GetPath() );
1072  }
1073  else if( fn.FileExists() && !fn.IsFileWritable() )
1074  {
1075  msg.Printf( _( "Insufficient permissions to save file '%s'." ),
1076  fn.GetFullPath() );
1077  }
1078 
1079  if( !msg.IsEmpty() )
1080  {
1081  if( aVerbose )
1082  wxMessageBox( msg );
1083 
1084  return false;
1085  }
1086 
1087  return true;
1088 }
#define _(s)

References _.

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

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 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_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AskToSaveChanges(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), 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(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), 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(), 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_FIELD_PROPERTIES::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(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), SYMBOL_EDIT_FRAME::saveCurrentSymbol(), 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 181 of file kiway_player.cpp.

182 {
183  // logging support
184  KiwayMailIn( aEvent ); // call the virtual, override in derived.
185 }
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 71 of file kiway_player.cpp.

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

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 188 of file kiway_player.cpp.

189 {
190  int id = event.GetId();
191 
192  // tell all the KIWAY_PLAYERs about the language change.
193  Kiway().SetLanguage( id );
194 }
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:496

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 251 of file sim_plot_frame.cpp.

252 {
253  EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( aCfg );
254  wxASSERT( cfg );
255 
256  if( cfg )
257  {
259 
260  // Read subwindows sizes (should be > 0 )
266  }
267 
269 
270  NGSPICE* currentSim = dynamic_cast<NGSPICE*>( m_simulator.get() );
271 
272  if( currentSim )
273  m_simulator->Settings() = project.m_SchematicSettings->m_NgspiceSimulatorSettings;
274 }
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 709 of file eda_base_frame.cpp.

710 {
711  LoadWindowState( aCfg->state );
712 
713  if( m_hasAutoSave )
714  m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
715 
716  m_perspective = aCfg->perspective;
717  m_mruPath = aCfg->mru_path;
718 
719  TOOLS_HOLDER::CommonSettingsChanged( false, false );
720 }
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 549 of file eda_base_frame.cpp.

550 {
551  if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
552  return;
553 
554  const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
555 
556  if( state != nullptr )
557  {
558  LoadWindowState( state->window );
559  }
560 }
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 563 of file eda_base_frame.cpp.

564 {
565  bool wasDefault = false;
566 
567  m_framePos.x = aState.pos_x;
568  m_framePos.y = aState.pos_y;
569  m_frameSize.x = aState.size_x;
570  m_frameSize.y = aState.size_y;
571 
572  wxLogTrace( traceDisplayLocation, wxT( "Config position (%d, %d) with size (%d, %d)" ),
574 
575  // Ensure minimum size is set if the stored config was zero-initialized
576  if( m_frameSize.x < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
577  {
579  wasDefault = true;
580 
581  wxLogTrace( traceDisplayLocation, wxT( "Using minimum size (%d, %d)" ),
582  m_frameSize.x, m_frameSize.y );
583  }
584 
585  wxLogTrace( traceDisplayLocation, wxT( "Number of displays: %d" ), wxDisplay::GetCount() );
586 
587  if( aState.display >= wxDisplay::GetCount() )
588  {
589  wxLogTrace( traceDisplayLocation, wxT( "Previous display not found" ) );
590 
591  // If it isn't attached, use the first display
592  // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
593  const unsigned int index = 0;
594  wxDisplay display( index );
595  wxRect clientSize = display.GetGeometry();
596 
597  m_framePos = wxDefaultPosition;
598 
599  // Ensure the window fits on the display, since the other one could have been larger
600  if( m_frameSize.x > clientSize.width )
601  m_frameSize.x = clientSize.width;
602 
603  if( m_frameSize.y > clientSize.height )
604  m_frameSize.y = clientSize.height;
605  }
606  else
607  {
608  wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
609  wxPoint upperLeft( m_framePos.x, m_framePos.y );
610 
611  wxDisplay display( aState.display );
612  wxRect clientSize = display.GetClientArea();
613 
614  int yLimTop = clientSize.y;
615  int yLimBottom = clientSize.y + clientSize.height;
616  int xLimLeft = clientSize.x;
617  int xLimRight = clientSize.x + clientSize.width;
618 
619  if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
620  upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
621  upperLeft.y < yLimTop || // Upper corner too close to the bottom of the screen
622  upperLeft.y > yLimBottom )
623  {
624  m_framePos = wxDefaultPosition;
625  wxLogTrace( traceDisplayLocation, wxT( "Resetting to default position" ) );
626  }
627  }
628 
629  wxLogTrace( traceDisplayLocation, wxT( "Final window position (%d, %d) with size (%d, %d)" ),
631 
632  SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
633 
634  // Center the window if we reset to default
635  if( m_framePos.x == -1 )
636  {
637  wxLogTrace( traceDisplayLocation, wxT( "Centering window" ) );
638  Center();
639  m_framePos = GetPosition();
640  }
641 
642  // Record the frame sizes in an un-maximized state
645 
646  // Maximize if we were maximized before
647  if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
648  {
649  wxLogTrace( traceDisplayLocation, wxT( "Maximizing window" ) );
650  Maximize();
651  }
652 
653  m_displayIndex = wxDisplay::GetFromWindow( this );
654 }
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 {
932 
933  wxTextFile file( aPath );
934 
935 #define DISPLAY_LOAD_ERROR( fmt ) DisplayErrorMessage( this, wxString::Format( _( fmt ), \
936  file.GetCurrentLine()+1 ) )
937 
938  if( !file.Open() )
939  return false;
940 
941  long plotsCount;
942 
943  if( !file.GetFirstLine().ToLong( &plotsCount ) ) // GetFirstLine instead of GetNextLine
944  {
945  DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." );
946  file.Close();
947 
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  DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." );
958  file.Close();
959 
960  return false;
961  }
962 
963  wxString simCommand = UnescapeString( file.GetNextLine() );
964  NewPlotPanel( simCommand );
965  StartSimulation( simCommand );
966 
967  // Perform simulation, so plots can be added with values
968  do
969  {
970  wxThread::This()->Sleep( 50 );
971  }
972  while( m_simulator->IsRunning() );
973 
974  if( !file.GetNextLine().ToLong( &tracesCount ) )
975  {
976  DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." );
977  file.Close();
978 
979  return false;
980  }
981 
982  for( long j = 0; j < tracesCount; ++j )
983  {
984  long traceType;
985  wxString name, param;
986 
987  if( !file.GetNextLine().ToLong( &traceType ) )
988  {
989  DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." );
990  file.Close();
991 
992  return false;
993  }
994 
995  name = file.GetNextLine();
996 
997  if( name.IsEmpty() )
998  {
999  DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is empty." );
1000  file.Close();
1001 
1002  return false;
1003  }
1004 
1005  param = file.GetNextLine();
1006 
1007  if( param.IsEmpty() )
1008  {
1009  DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is empty." );
1010  file.Close();
1011 
1012  return false;
1013  }
1014 
1015  addPlot( name, (SIM_PLOT_TYPE) traceType, param );
1016  }
1017  }
1018 
1019  file.Close();
1020 
1021  wxFileName filename( aPath );
1022  filename.MakeRelativeTo( Prj().GetProjectPath() );
1023 
1024  // Remember the loaded workbook filename.
1025  m_simulator->Settings()->SetWorkbookFilename( filename.GetFullPath() );
1026 
1027  // Successfully loading a workbook does not count as modifying it.
1029  return true;
1030 }
SIM_PANEL_BASE * NewPlotPanel(wxString aSimCommand)
Create a new plot panel for a given simulation type and adds it to the main notebook.
bool DeleteAllPages() override
std::shared_ptr< SPICE_SIMULATOR > m_simulator
void StartSimulation(const wxString &aSimCommand=wxEmptyString)
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
wxString UnescapeString(const wxString &aSource)
#define DISPLAY_LOAD_ERROR(fmt)
const char * name
Definition: DXF_plotter.cpp:56
void ClrModified()
SIM_WORKBOOK * m_workbook
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(), SIM_WORKBOOK::ClrModified(), SIM_WORKBOOK::DeleteAllPages(), DISPLAY_LOAD_ERROR, m_simulator, SIM_PLOT_FRAME_BASE::m_workbook, name, NewPlotPanel(), KIWAY_HOLDER::Prj(), StartSimulation(), and UnescapeString().

Referenced by menuOpenWorkbook().

◆ m_splitterLeftRightOnIdle()

void SIM_PLOT_FRAME_BASE::m_splitterLeftRightOnIdle ( wxIdleEvent &  )
inlineinherited

Definition at line 131 of file sim_plot_frame_base.h.

132  {
133  m_splitterLeftRight->SetSashPosition( 700 );
134  m_splitterLeftRight->Disconnect( wxEVT_IDLE, wxIdleEventHandler( SIM_PLOT_FRAME_BASE::m_splitterLeftRightOnIdle ), NULL, this );
135  }
void m_splitterLeftRightOnIdle(wxIdleEvent &)
wxSplitterWindow * m_splitterLeftRight

References SIM_PLOT_FRAME_BASE::m_splitterLeftRight.

Referenced by SIM_PLOT_FRAME_BASE::SIM_PLOT_FRAME_BASE().

◆ m_splitterPlotAndConsoleOnIdle()

void SIM_PLOT_FRAME_BASE::m_splitterPlotAndConsoleOnIdle ( wxIdleEvent &  )
inlineinherited

Definition at line 137 of file sim_plot_frame_base.h.

138  {
139  m_splitterPlotAndConsole->SetSashPosition( 500 );
140  m_splitterPlotAndConsole->Disconnect( wxEVT_IDLE, wxIdleEventHandler( SIM_PLOT_FRAME_BASE::m_splitterPlotAndConsoleOnIdle ), NULL, this );
141  }
void m_splitterPlotAndConsoleOnIdle(wxIdleEvent &)
wxSplitterWindow * m_splitterPlotAndConsole

References SIM_PLOT_FRAME_BASE::m_splitterPlotAndConsole.

Referenced by SIM_PLOT_FRAME_BASE::SIM_PLOT_FRAME_BASE().

◆ m_splitterSignalsOnIdle()

void SIM_PLOT_FRAME_BASE::m_splitterSignalsOnIdle ( wxIdleEvent &  )
inlineinherited

Definition at line 143 of file sim_plot_frame_base.h.

144  {
145  m_splitterSignals->SetSashPosition( 0 );
146  m_splitterSignals->Disconnect( wxEVT_IDLE, wxIdleEventHandler( SIM_PLOT_FRAME_BASE::m_splitterSignalsOnIdle ), NULL, this );
147  }
wxSplitterWindow * m_splitterSignals
void m_splitterSignalsOnIdle(wxIdleEvent &)

References SIM_PLOT_FRAME_BASE::m_splitterSignals.

Referenced by SIM_PLOT_FRAME_BASE::SIM_PLOT_FRAME_BASE().

◆ m_splitterTuneValuesOnIdle()

void SIM_PLOT_FRAME_BASE::m_splitterTuneValuesOnIdle ( wxIdleEvent &  )
inlineinherited

Definition at line 149 of file sim_plot_frame_base.h.

150  {
151  m_splitterTuneValues->SetSashPosition( 0 );
152  m_splitterTuneValues->Disconnect( wxEVT_IDLE, wxIdleEventHandler( SIM_PLOT_FRAME_BASE::m_splitterTuneValuesOnIdle ), NULL, this );
153  }
wxSplitterWindow * m_splitterTuneValues
void m_splitterTuneValuesOnIdle(wxIdleEvent &)

References SIM_PLOT_FRAME_BASE::m_splitterTuneValues.

Referenced by SIM_PLOT_FRAME_BASE::SIM_PLOT_FRAME_BASE().

◆ menuAddSignalsUpdate()

void SIM_PLOT_FRAME::menuAddSignalsUpdate ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1354 of file sim_plot_frame.cpp.

1355 {
1356  event.Enable( m_simFinished );
1357 }

References m_simFinished.

Referenced by SIM_PLOT_FRAME().

◆ menuExit()

void SIM_PLOT_FRAME::menuExit ( wxCommandEvent &  event)
inlineoverrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 273 of file sim_plot_frame.h.

274  {
275  Close();
276  }

◆ menuNewPlot()

void SIM_PLOT_FRAME::menuNewPlot ( wxCommandEvent &  aEvent)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1146 of file sim_plot_frame.cpp.

1147 {
1148  SIM_TYPE type = m_exporter->GetSimType();
1149 
1150  if( SIM_PANEL_BASE::IsPlottable( type ) )
1151  NewPlotPanel( m_exporter->GetUsedSimCommand() );
1152 }
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_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, and NewPlotPanel().

◆ menuOpenWorkbook()

void SIM_PLOT_FRAME::menuOpenWorkbook ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1155 of file sim_plot_frame.cpp.

1156 {
1157  wxFileDialog openDlg( this, _( "Open simulation workbook" ), getDefaultPath(), "",
1158  WorkbookFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST );
1159 
1160  if( openDlg.ShowModal() == wxID_CANCEL )
1161  return;
1162 
1163  loadWorkbook( openDlg.GetPath() );
1164 }
wxString getDefaultPath()
Return the default path to be used in file browser dialog.
#define _(s)
bool loadWorkbook(const wxString &aPath)
Load plot settings from a file.
wxString WorkbookFileWildcard()

References _, getDefaultPath(), loadWorkbook(), and WorkbookFileWildcard().

◆ menuProbeUpdate()

void SIM_PLOT_FRAME::menuProbeUpdate ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1360 of file sim_plot_frame.cpp.

1361 {
1362  event.Enable( m_simFinished );
1363 }

References m_simFinished.

Referenced by SIM_PLOT_FRAME().

◆ menuSaveCsv()

void SIM_PLOT_FRAME::menuSaveCsv ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1212 of file sim_plot_frame.cpp.

1213 {
1214  if( !GetCurrentPlot() )
1215  return;
1216 
1217  const wxChar SEPARATOR = ';';
1218 
1219  wxFileDialog saveDlg( this, _( "Save Plot Data" ), "", "", CsvFileWildcard(),
1220  wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1221 
1222  if( saveDlg.ShowModal() == wxID_CANCEL )
1223  return;
1224 
1225  wxFFile out( saveDlg.GetPath(), "wb" );
1226  bool timeWritten = false;
1227 
1228  for( const auto& t : GetCurrentPlot()->GetTraces() )
1229  {
1230  const TRACE* trace = t.second;
1231 
1232  if( !timeWritten )
1233  {
1234  out.Write( wxString::Format( "Time%c", SEPARATOR ) );
1235 
1236  for( double v : trace->GetDataX() )
1237  out.Write( wxString::Format( "%g%c", v, SEPARATOR ) );
1238 
1239  out.Write( "\r\n" );
1240  timeWritten = true;
1241  }
1242 
1243  out.Write( wxString::Format( "%s%c", t.first, SEPARATOR ) );
1244 
1245  for( double v : trace->GetDataY() )
1246  out.Write( wxString::Format( "%g%c", v, SEPARATOR ) );
1247 
1248  out.Write( "\r\n" );
1249  }
1250 
1251  out.Close();
1252 }
const std::vector< double > & GetDataX() const
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
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
const std::vector< double > & GetDataY() const
const std::map< wxString, TRACE * > & GetTraces() const

References _, CsvFileWildcard(), Format(), GetCurrentPlot(), 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 1197 of file sim_plot_frame.cpp.

1198 {
1199  if( !GetCurrentPlot() )
1200  return;
1201 
1202  wxFileDialog saveDlg( this, _( "Save Plot as Image" ), "", "", PngFileWildcard(),
1203  wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1204 
1205  if( saveDlg.ShowModal() == wxID_CANCEL )
1206  return;
1207 
1208  GetCurrentPlot()->GetPlotWin()->SaveScreenshot( saveDlg.GetPath(), wxBITMAP_TYPE_PNG );
1209 }
mpWindow * GetPlotWin() const
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
#define _(s)
wxString PngFileWildcard()
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:2630

References _, GetCurrentPlot(), 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 1167 of file sim_plot_frame.cpp.

1168 {
1169  if( !m_workbook->IsModified() )
1170  return;
1171 
1172  wxString filename = m_simulator->Settings()->GetWorkbookFilename();
1173 
1174  if( filename.IsEmpty() )
1175  {
1176  menuSaveWorkbookAs( event );
1177  return;
1178  }
1179 
1180  saveWorkbook( Prj().AbsolutePath( m_simulator->Settings()->GetWorkbookFilename() ) );
1181 }
bool saveWorkbook(const wxString &aPath)
Save plot settings to a file.
std::shared_ptr< SPICE_SIMULATOR > m_simulator
bool IsModified() const
Definition: sim_workbook.h:68
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
void menuSaveWorkbookAs(wxCommandEvent &event) override
SIM_WORKBOOK * m_workbook

References SIM_WORKBOOK::IsModified(), m_simulator, SIM_PLOT_FRAME_BASE::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 1184 of file sim_plot_frame.cpp.

1185 {
1186  wxFileDialog saveAsDlg( this, _( "Save Simulation Workbook As" ), getDefaultPath(),
1188  wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1189 
1190  if( saveAsDlg.ShowModal() == wxID_CANCEL )
1191  return;
1192 
1193  saveWorkbook( Prj().AbsolutePath( saveAsDlg.GetPath() ) );
1194 }
bool saveWorkbook(const wxString &aPath)
Save plot settings to a file.
wxString getDefaultPath()
Return the default path to be used in file browser dialog.
wxString getDefaultFilename()
Return the default filename (with extension) to be used in file browser dialog.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
#define _(s)
wxString WorkbookFileWildcard()

References _, getDefaultFilename(), getDefaultPath(), 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 1309 of file sim_plot_frame.cpp.

1310 {
1312 
1313  if( plot )
1314  plot->SetDottedCurrentPhase( !plot->GetDottedCurrentPhase() );
1315 }
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

References GetCurrentPlot(), and plot.

◆ menuShowDottedUpdate()

void SIM_PLOT_FRAME::menuShowDottedUpdate ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1318 of file sim_plot_frame.cpp.

1319 {
1321 
1322  event.Check( plot ? plot->GetDottedCurrentPhase() : false );
1323 }
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

References GetCurrentPlot(), and plot.

◆ menuShowGrid()

void SIM_PLOT_FRAME::menuShowGrid ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1276 of file sim_plot_frame.cpp.

1277 {
1279 
1280  if( plot )
1281  plot->ShowGrid( !plot->IsGridShown() );
1282 }
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

References GetCurrentPlot(), and plot.

◆ menuShowGridUpdate()

void SIM_PLOT_FRAME::menuShowGridUpdate ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1285 of file sim_plot_frame.cpp.

1286 {
1288 
1289  event.Check( plot ? plot->IsGridShown() : false );
1290 }
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

References GetCurrentPlot(), and plot.

◆ menuShowLegend()

void SIM_PLOT_FRAME::menuShowLegend ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1293 of file sim_plot_frame.cpp.

1294 {
1296 
1297  if( plot )
1298  plot->ShowLegend( !plot->IsLegendShown() );
1299 }
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

References GetCurrentPlot(), and plot.

◆ menuShowLegendUpdate()

void SIM_PLOT_FRAME::menuShowLegendUpdate ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1302 of file sim_plot_frame.cpp.

1303 {
1305  event.Check( plot ? plot->IsLegendShown() : false );
1306 }
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

References GetCurrentPlot(), and plot.

◆ menuShowWhiteBackgroundUpdate()

void SIM_PLOT_FRAME::menuShowWhiteBackgroundUpdate ( wxUpdateUIEvent &  event)
inlineoverrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 290 of file sim_plot_frame.h.

291  {
292  event.Check( m_plotUseWhiteBg );
293  }

References m_plotUseWhiteBg.

◆ menuSimulateUpdate()

void SIM_PLOT_FRAME::menuSimulateUpdate ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1348 of file sim_plot_frame.cpp.

1349 {
1350  event.Enable( m_exporter->CommandToSimType( getCurrentSimCommand() ) != ST_UNKNOWN );
1351 }
wxString getCurrentSimCommand() const
std::unique_ptr< NETLIST_EXPORTER_PSPICE_SIM > m_exporter

References getCurrentSimCommand(), m_exporter, and ST_UNKNOWN.

Referenced by SIM_PLOT_FRAME().

◆ menuTuneUpdate()

void SIM_PLOT_FRAME::menuTuneUpdate ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1366 of file sim_plot_frame.cpp.

1367 {
1368  event.Enable( m_simFinished );
1369 }

References m_simFinished.

Referenced by SIM_PLOT_FRAME().

◆ menuWhiteBackground()

void SIM_PLOT_FRAME::menuWhiteBackground ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1326 of file sim_plot_frame.cpp.

1327 {
1329 
1330  // Rebuild the color list to plot traces
1332 
1333  // Now send changes to all SIM_PLOT_PANEL
1334  for( size_t page = 0; page < m_workbook->GetPageCount(); page++ )
1335  {
1336  wxWindow* curPage = m_workbook->GetPage( page );
1337 
1338  // ensure it is truly a plot panel and not the (zero plots) placeholder
1339  // which is only SIM_PLOT_PANEL_BASE
1340  SIM_PLOT_PANEL* panel = dynamic_cast<SIM_PLOT_PANEL*>( curPage );
1341 
1342  if( panel )
1343  panel->UpdatePlotColors();
1344  }
1345 }
bool GetPlotBgOpt() const
static void FillDefaultColorList(bool aWhiteBg)
Fills m_colorList by a default set of colors.
void UpdatePlotColors()
Update plot colors
SIM_WORKBOOK * m_workbook

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

◆ menuZoomFit()

void SIM_PLOT_FRAME::menuZoomFit ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1269 of file sim_plot_frame.cpp.

1270 {
1271  if( GetCurrentPlot() )
1272  GetCurrentPlot()->GetPlotWin()->Fit();
1273 }
mpWindow * GetPlotWin() const
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
void Fit() override
Set view to fit global bounding box of all plot layers and refresh display.
Definition: mathplot.cpp:1910

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

◆ menuZoomIn()

void SIM_PLOT_FRAME::menuZoomIn ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1255 of file sim_plot_frame.cpp.

1256 {
1257  if( GetCurrentPlot() )
1259 }
mpWindow * GetPlotWin() const
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
void ZoomIn(const wxPoint &centerPoint=wxDefaultPosition)
Zoom into current view and refresh display.
Definition: mathplot.cpp:2070

References GetCurrentPlot(), 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 1262 of file sim_plot_frame.cpp.

1263 {
1264  if( GetCurrentPlot() )
1266 }
void ZoomOut(const wxPoint &centerPoint=wxDefaultPosition)
Zoom out current view and refresh display.
Definition: mathplot.cpp:2127
mpWindow * GetPlotWin() const
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).

References GetCurrentPlot(), 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 492 of file sim_plot_frame.cpp.

493 {
494  SIM_PANEL_BASE* plotPanel = nullptr;
496 
497  if( SIM_PANEL_BASE::IsPlottable( simType ) )
498  {
499  SIM_PLOT_PANEL* panel;
500  panel = new SIM_PLOT_PANEL( aSimCommand, m_workbook, this, wxID_ANY );
501 
503  Pgm().GetCommonSettings()->m_Input.scroll_modifier_zoom != 0 );
504 
505  plotPanel = dynamic_cast<SIM_PANEL_BASE*>( panel );
506  }
507  else
508  {
509  SIM_NOPLOT_PANEL* panel;
510  panel = new SIM_NOPLOT_PANEL( aSimCommand, m_workbook, wxID_ANY );
511  plotPanel = dynamic_cast<SIM_PANEL_BASE*>( panel );
512  }
513 
514  wxString pageTitle( m_simulator->TypeToName( simType, true ) );
515  pageTitle.Prepend( wxString::Format( _( "Plot%u - " ), (unsigned int) ++m_plotNumber ) );
516 
517  m_workbook->AddPage( dynamic_cast<wxWindow*>( plotPanel ), pageTitle, true );
518 
519  return plotPanel;
520 }
void EnableMouseWheelPan(bool enabled)
Enable/disable trackpad friendly panning (2-axis scroll wheel)
Definition: mathplot.h:1220
mpWindow * GetPlotWin() const
bool AddPage(wxWindow *aPage, const wxString &aCaption, bool aSelect=false, const wxBitmap &aBitmap=wxNullBitmap)
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.
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
SIM_WORKBOOK * m_workbook
unsigned int m_plotNumber

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

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

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce)
inlineinherited

Definition at line 584 of file eda_base_frame.h.

585  {
586  m_isNonUserClose = true;
587  return Close( aForce );
588  }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onAddSignal()

void SIM_PLOT_FRAME::onAddSignal ( wxCommandEvent &  event)
private

Definition at line 1507 of file sim_plot_frame.cpp.

1508 {
1509  wxCHECK_RET( m_simFinished, "No simulation results available" );
1510 
1511  SIM_PLOT_PANEL* plotPanel = GetCurrentPlot();
1512 
1513  if( !plotPanel || !m_exporter || plotPanel->GetType() != m_exporter->GetSimType() )
1514  {
1515  DisplayInfoMessage( this, _( "You need to run plot-providing simulation first." ) );
1516  return;
1517  }
1518 
1519  DIALOG_SIGNAL_LIST dialog( this, m_exporter.get() );
1520  dialog.ShowModal();
1521 }
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
#define _(s)
SIM_TYPE GetType() const
std::unique_ptr< NETLIST_EXPORTER_PSPICE_SIM > m_exporter
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:307

References _, DisplayInfoMessage(), GetCurrentPlot(), SIM_PANEL_BASE::GetType(), m_exporter, and m_simFinished.

Referenced by SIM_PLOT_FRAME().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 320 of file eda_base_frame.cpp.

321 {
322  if( !doAutoSave() )
323  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
324 }
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 333 of file eda_base_frame.cpp.

334 {
335  wxLogTrace( kicadTraceKeyEvent, wxT( "EDA_BASE_FRAME::OnCharHook %s" ), dump( aKeyEvent ) );
336 
337  // Key events can be filtered here.
338  // Currently no filtering is made.
339  aKeyEvent.Skip();
340 }
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 1649 of file sim_plot_frame.cpp.

1650 {
1651  wxSize size = m_cursors->GetClientSize();
1652  SIM_PLOT_PANEL* plotPanel = GetCurrentPlot();
1653  m_cursors->ClearAll();
1654 
1655  if( !plotPanel )
1656  return;
1657 
1659  m_cursors->SetImageList(m_signalsIconColorList, wxIMAGE_LIST_SMALL);
1660 
1661  // Fill the signals listctrl
1662  m_cursors->AppendColumn( _( "Signal" ), wxLIST_FORMAT_LEFT, size.x / 2 );
1663  const long X_COL = m_cursors->AppendColumn( plotPanel->GetLabelX(), wxLIST_FORMAT_LEFT,
1664  size.x / 4 );
1665 
1666  wxString labelY1 = plotPanel->GetLabelY1();
1667  wxString labelY2 = plotPanel->GetLabelY2();
1668  wxString labelY;
1669 
1670  if( !labelY2.IsEmpty() )
1671  labelY = labelY1 + " / " + labelY2;
1672  else
1673  labelY = labelY1;
1674 
1675  const long Y_COL = m_cursors->AppendColumn( labelY, wxLIST_FORMAT_LEFT, size.x / 4 );
1676 
1677  // Update cursor values
1678  int itemidx = 0;
1679 
1680  for( const auto& trace : plotPanel->GetTraces() )
1681  {
1682  if( CURSOR* cursor = trace.second->GetCursor() )
1683  {
1684  // Find the right icon color in list.
1685  // It is the icon used in m_signals list for the same trace
1686  long iconColor = m_signals->FindItem( -1, trace.first );
1687 
1688  const wxRealPoint coords = cursor->GetCoords();
1689  long idx = m_cursors->InsertItem( itemidx++, trace.first, iconColor );
1690  m_cursors->SetItem( idx, X_COL, SPICE_VALUE( coords.x ).ToSpiceString() );
1691  m_cursors->SetItem( idx, Y_COL, SPICE_VALUE( coords.y ).ToSpiceString() );
1692  }
1693  }
1694 }
wxString ToSpiceString() const
Return string value in Spice format (e.g.
wxImageList * m_signalsIconColorList
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
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)
const std::map< wxString, TRACE * > & GetTraces() const
Cursor attached to a trace to follow its values:

References _, cursor, GetCurrentPlot(), 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(), onPlotClosed(), removePlot(), and SIM_PLOT_FRAME().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 994 of file eda_base_frame.cpp.

995 {
996  void ShowAboutDialog( EDA_BASE_FRAME * aParent ); // See AboutDialog_main.cpp
997  ShowAboutDialog( this );
998 }
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 1213 of file eda_base_frame.cpp.

1214 {
1215  // When we maximize the window, we want to save the old information
1216  // so that we can add it to the settings on next window load.
1217  // Contrary to the documentation, this event seems to be generated
1218  // when the window is also being unmaximized on OSX, so we only
1219  // capture the size information when we maximize the window when on OSX.
1220 #ifdef __WXOSX__
1221  if( !IsMaximized() )
1222 #endif
1223  {
1225  m_normalFramePos = GetPosition();
1226  wxLogTrace( traceDisplayLocation,
1227  wxT( "Maximizing window - Saving position (%d, %d) with size (%d, %d)" ),
1230  }
1231 
1232  // Skip event to actually maximize the window
1233  aEvent.Skip();
1234 }
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 343 of file eda_base_frame.cpp.

344 {
345  if( !m_toolDispatcher )
346  aEvent.Skip();
347  else
349 }
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:160

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 1393 of file sim_plot_frame.cpp.

1394 {
1395  updateSignalList();
1396  wxCommandEvent dummy;
1397  onCursorUpdate( dummy );
1398 }
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
void onCursorUpdate(wxCommandEvent &aEvent)
void updateSignalList()
Update the list of currently plotted signals.

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

◆ onPlotClose()

void SIM_PLOT_FRAME::onPlotClose ( wxAuiNotebookEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1372 of file sim_plot_frame.cpp.

1373 {
1374 }

◆ onPlotClosed()

void SIM_PLOT_FRAME::onPlotClosed ( wxAuiNotebookEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1377 of file sim_plot_frame.cpp.

1378 {
1379  if( m_workbook->GetPageCount() == 0 )
1380  {
1381  m_signals->ClearAll();
1382  m_cursors->ClearAll();
1383  }
1384  else
1385  {
1386  updateSignalList();
1387  wxCommandEvent dummy;
1388  onCursorUpdate( dummy );
1389  }
1390 }
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
void onCursorUpdate(wxCommandEvent &aEvent)
void updateSignalList()
Update the list of currently plotted signals.
SIM_WORKBOOK * m_workbook

References dummy(), SIM_PLOT_FRAME_BASE::m_cursors, SIM_PLOT_FRAME_BASE::m_signals, SIM_PLOT_FRAME_BASE::m_workbook, onCursorUpdate(), and updateSignalList().

◆ onPlotDragged()

void SIM_PLOT_FRAME::onPlotDragged ( wxAuiNotebookEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1401 of file sim_plot_frame.cpp.

1402 {
1403 }

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

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

Definition at line 1001 of file eda_base_frame.cpp.

1002 {
1003  PAGED_DIALOG dlg( this, _( "Preferences" ), true );
1004  wxTreebook* book = dlg.GetTreebook();
1005 
1006  book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
1007 
1008  book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
1009 
1010  PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
1011  book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
1012 
1013  wxWindow* viewer3D = nullptr;
1014 
1015  for( unsigned i = 0; i < KIWAY_PLAYER_COUNT; ++i )
1016  {
1017  KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
1018 
1019  if( frame )
1020  {
1021  frame->InstallPreferences( &dlg, hotkeysPanel );
1022 
1023  if( !viewer3D )
1024  viewer3D = wxFindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( frame ) );
1025  }
1026  }
1027 
1028  if( viewer3D )
1029  static_cast<EDA_BASE_FRAME*>( viewer3D )->InstallPreferences( &dlg, hotkeysPanel );
1030 
1031  // The Kicad manager frame is not a player so we have to add it by hand
1032  wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
1033 
1034  if( manager )
1035  static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
1036 
1037  for( size_t i = 0; i < book->GetPageCount(); ++i )
1038  book->GetPage( i )->Layout();
1039 
1040  if( dlg.ShowModal() == wxID_OK )
1041  dlg.Kiway().CommonSettingsChanged( false, false );
1042 }
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:393
#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 1524 of file sim_plot_frame.cpp.

1525 {
1526  wxCHECK_RET( m_simFinished, "No simulation results available" );
1527 
1528  if( m_schematicFrame == nullptr )
1529  return;
1530 
1532  m_schematicFrame->Raise();
1533 }
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
static TOOL_ACTION simProbe
Definition: ee_actions.h:216
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54

References TOOLS_HOLDER::GetToolManager(), m_schematicFrame, m_simFinished, TOOL_MANAGER::RunAction(), and EE_ACTIONS::simProbe.

Referenced by SIM_PLOT_FRAME().

◆ onSettings()

void SIM_PLOT_FRAME::onSettings ( wxCommandEvent &  event)
private

Definition at line 1455 of file sim_plot_frame.cpp.

1456 {
1457  SIM_PANEL_BASE* plotPanelWindow = getCurrentPlotWindow();
1458 
1459  if( !m_settingsDlg )
1460  m_settingsDlg = new DIALOG_SIM_SETTINGS( this, m_simulator->Settings() );
1461 
1462  // Initial processing is required to e.g. display a list of power sources
1464 
1465  if( !m_exporter->ProcessNetlist( NET_ALL_FLAGS ) )
1466  {
1467  DisplayErrorMessage( this, _( "There were errors during netlist export, aborted." ) );
1468  return;
1469  }
1470 
1471  if( m_workbook->GetPageIndex( plotPanelWindow ) != wxNOT_FOUND )
1472  m_settingsDlg->SetSimCommand( m_workbook->GetSimCommand( plotPanelWindow ) );
1473 
1474  if( m_settingsDlg->ShowModal() == wxID_OK )
1475  {
1476  wxString oldCommand;
1477 
1478  if( m_workbook->GetPageIndex( plotPanelWindow ) != wxNOT_FOUND )
1479  oldCommand = m_workbook->GetSimCommand( plotPanelWindow );
1480  else
1481  oldCommand = wxString();
1482 
1483  wxString newCommand = m_settingsDlg->GetSimCommand();
1484  SIM_TYPE newSimType = NETLIST_EXPORTER_PSPICE_SIM::CommandToSimType( newCommand );
1485 
1486  // If it is a new simulation type, open a new plot
1487  // For the DC sim, check if sweep source type has changed (char 4 will contain 'v',
1488  // 'i', 'r' or 't'.
1489  if( !plotPanelWindow
1490  || ( plotPanelWindow && plotPanelWindow->GetType() != newSimType )
1491  || ( newSimType == ST_DC
1492  && oldCommand.Lower().GetChar( 4 ) != newCommand.Lower().GetChar( 4 ) ) )
1493  {
1494  plotPanelWindow = NewPlotPanel( newCommand );
1495  }
1496  else
1497  {
1498  // Update simulation command in the current plot
1499  m_workbook->SetSimCommand( plotPanelWindow, newCommand );
1500  }
1501 
1502  m_simulator->Init();
1503  }
1504 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:292
void SetSimCommand(SIM_PANEL_BASE *aPlotPanel, const wxString &aSimCommand)
Definition: sim_workbook.h:56
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.
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
SIM_TYPE
< Possible simulation types
Definition: sim_types.h:31
#define _(s)
SIM_PANEL_BASE * getCurrentPlotWindow() const
Return the currently opened plot panel (or NULL if there is none).
const wxString & GetSimCommand(const SIM_PANEL_BASE *aPlotPanel)
Definition: sim_workbook.h:62
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.
SIM_WORKBOOK * m_workbook

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

Referenced by SIM_PLOT_FRAME().

◆ onShowNetlist()

void SIM_PLOT_FRAME::onShowNetlist ( wxCommandEvent &  event)
private

Definition at line 1548 of file sim_plot_frame.cpp.

1549 {
1550  class NETLIST_VIEW_DIALOG : public DIALOG_SHIM
1551  {
1552  public:
1553  enum
1554  {
1555  MARGIN_LINE_NUMBERS
1556  };
1557 
1558  void onClose( wxCloseEvent& evt )
1559  {
1560  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL ) );
1561  }
1562 
1563  NETLIST_VIEW_DIALOG( wxWindow* parent, wxString source) :
1564  DIALOG_SHIM( parent, wxID_ANY, "SPICE Netlist",
1565  wxDefaultPosition, wxDefaultSize,
1566  wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER )
1567  {
1568  wxStyledTextCtrl* text = new wxStyledTextCtrl( this, wxID_ANY );
1569  text->SetMinSize( wxSize( 600, 400 ) );
1570 
1571  text->SetMarginWidth( MARGIN_LINE_NUMBERS, 50 );
1572  text->StyleSetForeground( wxSTC_STYLE_LINENUMBER, wxColour( 75, 75, 75 ) );
1573  text->StyleSetBackground( wxSTC_STYLE_LINENUMBER, wxColour( 220, 220, 220 ) );
1574  text->SetMarginType( MARGIN_LINE_NUMBERS, wxSTC_MARGIN_NUMBER );
1575 
1576  wxFont fixedFont = KIUI::GetMonospacedUIFont();
1577 
1578  for( size_t i = 0; i < wxSTC_STYLE_MAX; ++i )
1579  text->StyleSetFont( i, fixedFont );
1580 
1581  text->StyleClearAll(); // Addresses a bug in wx3.0 where styles are not correctly set
1582 
1583  text->SetWrapMode( wxSTC_WRAP_WORD );
1584 
1585  text->SetText( source );
1586 
1587  text->SetLexer( wxSTC_LEX_SPICE );
1588 
1589  wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
1590  sizer->Add( text, 1, wxEXPAND );
1591  SetSizer( sizer );
1592 
1593  Connect( wxEVT_CLOSE_WINDOW, wxCloseEventHandler( NETLIST_VIEW_DIALOG::onClose ),
1594  nullptr, this );
1595 
1596  finishDialogSettings();
1597  }
1598  };
1599 
1600  if( m_schematicFrame == nullptr || m_simulator == nullptr )
1601  return;
1602 
1603  NETLIST_VIEW_DIALOG dlg( this, m_simulator->GetNetlist() );
1604  dlg.ShowModal();
1605 }
wxFont GetMonospacedUIFont()
Definition: ui_common.cpp:85
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

References KIUI::GetMonospacedUIFont(), m_schematicFrame, m_simulator, 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 1406 of file sim_plot_frame.cpp.

1407 {
1408  // Remove signal from the plot panel when double clicked
1409  long idx = m_signals->GetFocusedItem();
1410 
1411  if( idx != wxNOT_FOUND )
1412  removePlot( m_signals->GetItemText( idx, 0 ) );
1413 }
void removePlot(const wxString &aPlotName)
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 1416 of file sim_plot_frame.cpp.

1417 {
1418  int idx = event.GetIndex();
1419 
1420  if( idx != wxNOT_FOUND )
1421  m_signals->Select( idx );
1422 
1423  idx = m_signals->GetFirstSelected();
1424 
1425  if( idx != wxNOT_FOUND )
1426  {
1427  const wxString& netName = m_signals->GetItemText( idx, 0 );
1428  SIGNAL_CONTEXT_MENU ctxMenu( netName, this );
1429  m_signals->PopupMenu( &ctxMenu );
1430  }
1431 }

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 1704 of file sim_plot_frame.cpp.

1705 {
1706  m_toolBar->SetToolNormalBitmap( ID_SIM_RUN, KiBitmap( BITMAPS::sim_run ) );
1707  SetCursor( wxCURSOR_ARROW );
1708 
1709  SIM_TYPE simType = m_exporter->GetSimType();
1710 
1711  if( simType == ST_UNKNOWN )
1712  return;
1713 
1714  SIM_PANEL_BASE* plotPanelWindow = getCurrentPlotWindow();
1715 
1716  if( !plotPanelWindow || plotPanelWindow->GetType() != simType )
1717  plotPanelWindow = NewPlotPanel( m_exporter->GetUsedSimCommand() );
1718 
1719  if( m_simulator->IsRunning() )
1720  return;
1721 
1722  // If there are any signals plotted, update them
1723  if( SIM_PANEL_BASE::IsPlottable( simType ) )
1724  {
1725  SIM_PLOT_PANEL* plotPanel = dynamic_cast<SIM_PLOT_PANEL*>( plotPanelWindow );
1726  wxCHECK_RET( plotPanel, "not a SIM_PLOT_PANEL" );
1727 
1728  struct TRACE_DESC
1729  {
1730  wxString m_name;
1732  wxString m_param;
1733  };
1734 
1735  std::vector<struct TRACE_DESC> traceInfo;
1736 
1737  // Get information about all the traces on the plot, remove and add again
1738  for( auto& trace : plotPanel->GetTraces() )
1739  {
1740  struct TRACE_DESC placeholder;
1741  placeholder.m_name = trace.second->GetName();
1742  placeholder.m_type = trace.second->GetType();
1743  placeholder.m_param = trace.second->GetParam();
1744 
1745  traceInfo.push_back( placeholder );
1746  }
1747 
1748  for( auto& trace : traceInfo )
1749  {
1750  if( !updatePlot( trace.m_name, trace.m_type, trace.m_param, plotPanel ) )
1751  removePlot( trace.m_name );
1752  }
1753 
1754  updateSignalList();
1755  plotPanel->GetPlotWin()->UpdateAll();
1756  plotPanel->ResetScales();
1757  }
1758  else if( simType == ST_OP )
1759  {
1760  m_simConsole->AppendText( _( "\n\nSimulation results:\n\n" ) );
1761  m_simConsole->SetInsertionPointEnd();
1762 
1763  for( const auto& vec : m_simulator->AllPlots() )
1764  {
1765  std::vector<double> val_list = m_simulator->GetRealPlot( vec, 1 );
1766 
1767  if( val_list.size() == 0 ) // The list of values can be empty!
1768  continue;
1769 
1770  double val = val_list.at( 0 );
1771  wxString outLine, signal;
1772  SIM_PLOT_TYPE type = m_exporter->VectorToSignal( vec, signal );
1773 
1774  const size_t tab = 25; //characters
1775  size_t padding = ( signal.length() < tab ) ? ( tab - signal.length() ) : 1;
1776 
1777  outLine.Printf( wxT( "%s%s" ),
1778  ( signal + wxT( ":" ) ).Pad( padding, wxUniChar( ' ' ) ),
1779  SPICE_VALUE( val ).ToSpiceString() );
1780 
1781  outLine.Append( type == SPT_CURRENT ? "A\n" : "V\n" );
1782 
1783  m_simConsole->AppendText( outLine );
1784  m_simConsole->SetInsertionPointEnd();
1785 
1786  // @todo display calculated values on the schematic
1787  }
1788  }
1789 
1790  m_simFinished = true;
1791 }
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.
bool updatePlot(const wxString &aName, SIM_PLOT_TYPE aType, const wxString &aParam, SIM_PLOT_PANEL *aPlotPanel)
Update plot in a particular SIM_PLOT_PANEL.
std::shared_ptr< SPICE_SIMULATOR > m_simulator
static bool IsPlottable(SIM_TYPE aSimType)
void UpdateAll()
Refresh display.
Definition: mathplot.cpp:2403
void removePlot(const wxString &aPlotName)
Remove a plot with a specific title.
< 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 * getCurrentPlotWindow() const
Return the currently opened plot panel (or NULL if there is none).
void ResetScales()
Update trace line style.
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
void updateSignalList()
Update the list of currently plotted signals.
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 _, getCurrentPlotWindow(), SIM_PLOT_PANEL::GetPlotWin(), SIM_PLOT_PANEL::GetTraces(), SIM_PANEL_BASE::GetType(), ID_SIM_RUN, SIM_PANEL_BASE::IsPlottable(), KiBitmap(), m_exporter, SIM_PLOT_FRAME_BASE::m_simConsole, m_simFinished, m_simulator, SIM_PLOT_FRAME_BASE::m_toolBar, KIWAY_HOLDER::m_type, NewPlotPanel(), removePlot(), SIM_PLOT_PANEL::ResetScales(), sim_run, SPT_CURRENT, ST_OP, ST_UNKNOWN, mpWindow::UpdateAll(), updatePlot(), and updateSignalList().

Referenced by SIM_PLOT_FRAME().

◆ onSimReport()

void SIM_PLOT_FRAME::onSimReport ( wxCommandEvent &  aEvent)
private

Definition at line 1817 of file sim_plot_frame.cpp.

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

References SIM_PLOT_FRAME_BASE::m_simConsole.

Referenced by SIM_PLOT_FRAME().

◆ onSimStarted()

void SIM_PLOT_FRAME::onSimStarted ( wxCommandEvent &  aEvent)
private

Definition at line 1697 of file sim_plot_frame.cpp.

1698 {
1699  m_toolBar->SetToolNormalBitmap( ID_SIM_RUN, KiBitmap( BITMAPS::sim_stop ) );
1700  SetCursor( wxCURSOR_ARROWWAIT );
1701 }
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 1446 of file sim_plot_frame.cpp.

1447 {
1448  if( m_simulator->IsRunning() )
1449  StopSimulation();
1450  else
1451  StartSimulation();
1452 }
std::shared_ptr< SPICE_SIMULATOR > m_simulator
void StartSimulation(const wxString &aSimCommand=wxEmptyString)

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

Referenced by SIM_PLOT_FRAME().

◆ onSimUpdate()

void SIM_PLOT_FRAME::onSimUpdate ( wxCommandEvent &  aEvent)
private

Definition at line 1794 of file sim_plot_frame.cpp.

1795 {
1796  if( m_simulator->IsRunning() )
1797  StopSimulation();
1798 
1799  if( GetCurrentPlot() != m_lastSimPlot )
1800  {
1801  // We need to rerun simulation, as the simulator currently stores
1802  // results for another plot
1803  StartSimulation();
1804  }
1805  else
1806  {
1807  // Incremental update
1808  m_simConsole->Clear();
1809 
1810  // Do not export netlist, it is already stored in the simulator
1811  applyTuners();
1812  m_simulator->Run();
1813  }
1814 }
void applyTuners()
Apply component values specified using tuner sliders to the current netlist.
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
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...

References applyTuners(), GetCurrentPlot(), 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 531 of file eda_base_frame.cpp.

532 {
533 #ifdef __WXMAC__
534  int currentDisplay = wxDisplay::GetFromWindow( this );
535 
536  if( m_displayIndex >= 0 && currentDisplay >= 0 && currentDisplay != m_displayIndex )
537  {
538  wxLogTrace( traceDisplayLocation, wxT( "OnSize: current display changed %d to %d" ),
539  m_displayIndex, currentDisplay );
540  m_displayIndex = currentDisplay;
542  }
543 #endif
544 
545  aEvent.Skip();
546 }
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 63 of file eda_dde.cpp.

64 {
65  size_t len;
66  wxSocketBase* sock = evt.GetSocket();
67 
68  switch( evt.GetSocketEvent() )
69  {
70  case wxSOCKET_INPUT:
71  sock->Read( client_ipc_buffer, 1 );
72 
73  if( sock->LastCount() == 0 )
74  break; // No data, occurs on opening connection
75 
76  sock->Read( client_ipc_buffer + 1, IPC_BUF_SIZE - 2 );
77  len = 1 + sock->LastCount();
78  client_ipc_buffer[len] = 0;
80  break;
81 
82  case wxSOCKET_LOST:
83  return;
84  break;
85 
86  default:
87  wxPrintf( wxT( "EDA_DRAW_FRAME::OnSockRequest() error: Invalid event !" ) );
88  break;
89  }
90 }
#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 93 of file eda_dde.cpp.

94 {
95  wxSocketBase* socket;
96  wxSocketServer* server = (wxSocketServer*) evt.GetSocket();
97 
98  socket = server->Accept();
99 
100  if( socket == nullptr )
101  return;
102 
103  m_sockets.push_back( socket );
104 
105  socket->Notify( true );
106  socket->SetEventHandler( *this, ID_EDA_SOCKET_EVENT );
107  socket->SetNotify( wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG );
108 }
std::vector< wxSocketBase * > m_sockets
interprocess communication
Definition: kiway_player.h:219

References ID_EDA_SOCKET_EVENT, and KIWAY_PLAYER::m_sockets.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent &  aEvent)
protectedinherited

Definition at line 1277 of file eda_base_frame.cpp.

1278 {
1279  // Call the handler to update the colors used in the frame
1281 
1282  // Skip the change event to ensure the rest of the window controls get it
1283  aEvent.Skip();
1284 }
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 1536 of file sim_plot_frame.cpp.

1537 {
1538  wxCHECK_RET( m_simFinished, "No simulation results available" );
1539 
1540  if( m_schematicFrame == nullptr )
1541  return;
1542 
1544  m_schematicFrame->Raise();
1545 }
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
static TOOL_ACTION simTune
Definition: ee_actions.h:217
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54

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

Referenced by SIM_PLOT_FRAME().

◆ onWorkbookClrModified()

void SIM_PLOT_FRAME::onWorkbookClrModified ( wxCommandEvent &  event)
private

Definition at line 1440 of file sim_plot_frame.cpp.

1441 {
1442  updateTitle();
1443 }
void updateTitle()
Set the main window title bar text.

References updateTitle().

Referenced by SIM_PLOT_FRAME().

◆ onWorkbookModified()

void SIM_PLOT_FRAME::onWorkbookModified ( wxCommandEvent &  event)
private

Definition at line 1434 of file sim_plot_frame.cpp.

1435 {
1436  updateTitle();
1437 }
void updateTitle()
Set the main window title bar text.

References updateTitle().

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, GERBVIEW_FRAME, CVPCB_MAINFRAME, 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 1197 of file eda_base_frame.cpp.

1198 {
1199  return m_redoList.PopCommand();
1200 }
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:158
std::vector< std::string > m_toolStack
Definition: tools_holder.h:164
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 835 of file eda_base_frame.cpp.

836 {
837  SetStatusText( text );
838 }

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 36 of file kiway_holder.cpp.

37 {
38  return Kiway().Prj();
39 }
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:191

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(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), 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_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_NETLIST_IMPORT::DIALOG_NETLIST_IMPORT(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), 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(), 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(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), getDefaultFilename(), getDefaultPath(), 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(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), 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(), loadWorkbook(), menuSaveWorkbook(), menuSaveWorkbookAs(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_NETLIST_IMPORT::onBrowseNetlistFiles(), WX_HTML_REPORT_PANEL::onBtnSaveToFile(), 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(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_SCHEMATIC_SETUP::OnPageChange(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_FIELD_PROPERTIES::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_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), 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(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), 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(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), 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(), SCH_EDIT_FRAME::saveSchematicFile(), SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::saveSymbolAs(), SCH_BASE_FRAME::saveSymbolLibTables(), saveWorkbook(), 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(), 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(), PANEL_SETUP_RULES::TransferDataToWindow(), SCH_EDIT_FRAME::updateAutoSaveFile(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MOD