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 UNITS_PROVIDER

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)
 
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)
 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 NGSPICE_CIRCUIT_MODELGetExporter () 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...
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
virtual void ToggleUserUnits ()
 
virtual ORIGIN_TRANSFORMSGetOriginTransforms ()
 Return a reference to the default ORIGIN_TRANSFORMS object. More...
 
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)
 
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...
 
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 TOOL_EVENT &aEvent)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const TOOL_EVENT &aEvent)
 Pops a tool from the stack. More...
 
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...
 
bool HasKiway () const
 Safety check before asking for the Kiway reference. 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...
 
EDA_UNITS GetUserUnits () const
 
void SetUserUnits (EDA_UNITS aUnits)
 
const EDA_IU_SCALEGetIuScale () const
 
wxString StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
 Converts aValue in internal units into a united string. More...
 
wxString StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false)
 
wxString MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
 A lower-precision version of StringFromValue(). More...
 
wxString MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true)
 
long long int ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
 Converts aTextValue in aUnits to internal units used by the frame. 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 void handleIconizeEvent (wxIconizeEvent &aEvent)
 Handle a window iconize event. More...
 
void onIconize (wxIconizeEvent &aEvent)
 
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 ()
 
virtual void OnDropFiles (wxDropFilesEvent &aEvent)
 Handles event fired when a file is dropped to the window. More...
 
virtual void DoWithAcceptedFiles ()
 Execute action on accepted dropped file. More...
 

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...
 
std::vector< wxFileName > m_AcceptedFiles
 
FRAME_T m_ident
 
wxPoint m_framePos
 
wxSize m_frameSize
 
bool m_maximizeByDefault
 
int m_displayIndex
 
wxPoint m_normalFramePos
 
wxSize m_normalFrameSize
 
wxString m_aboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_supportsAutoSave
 
bool m_autoSaveState
 
wxTimer * m_autoSaveTimer
 
int m_undoRedoCountMax
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
ORIGIN_TRANSFORMS m_originTransforms
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 < Map containing the UI update handlers registered with wx for each action. More...
 
bool m_isClosing
 Set by NonUserClose() to indicate that the user did not request the current close. More...
 
bool m_isNonUserClose
 
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
 Associates files extensions with action to execute. More...
 
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)
 Add a new plot to the current panel. More...
 
void removePlot (const wxString &aPlotName)
 Remove a plot with a specific title. More...
 
bool updatePlot (const wxString &aName, SIM_PLOT_TYPE aType, 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 ()
 
void windowClosing (wxCloseEvent &event)
 (with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings(). More...
 
void commonInit (FRAME_T aFrameType)
 Collect common initialization functions used in all CTORs. More...
 
wxWindow * findQuasiModalDialog ()
 

Private Attributes

wxToolBarToolBase * m_toolSimulate
 
wxToolBarToolBase * m_toolAddSignals
 
wxToolBarToolBase * m_toolProbe
 
wxToolBarToolBase * m_toolTune
 
wxToolBarToolBase * m_toolSettings
 
SCH_EDIT_FRAMEm_schematicFrame
 
std::shared_ptr< NGSPICE_CIRCUIT_MODELm_circuitModel
 
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_PANEL_BASEm_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
 
KIWAYm_kiway
 
HOLDER_TYPE m_type
 
const EDA_IU_SCALEm_iuScale
 
EDA_UNITS m_userUnits
 

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

112 {
113 UNDO_LIST,
115 };

Constructor & Destructor Documentation

◆ SIM_PLOT_FRAME()

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

Definition at line 115 of file sim_plot_frame.cpp.

115 :
116 SIM_PLOT_FRAME_BASE( aParent ),
117 m_lastSimPlot( nullptr ),
118 m_plotNumber( 0 ),
119 m_simFinished( false )
120{
121 SetKiway( this, aKiway );
122 m_signalsIconColorList = nullptr;
123
125
126 if( m_schematicFrame == nullptr )
127 throw std::runtime_error( "There is no schematic window" );
128
129 // Give an icon
130 wxIcon icon;
131 icon.CopyFromBitmap( KiBitmap( BITMAPS::simulator ) );
132 SetIcon( icon );
133
135
136 if( !m_simulator )
137 {
138 throw std::runtime_error( "Could not create simulator instance" );
139 return;
140 }
141
142 // Get the previous size and position of windows:
143 LoadSettings( config() );
144
145 // Prepare the color list to plot traces
147
148 // Give icons to menuitems
150
151 m_simulator->Init();
152
153 m_reporter = new SIM_THREAD_REPORTER( this );
154 m_simulator->SetReporter( m_reporter );
155
156 // the settings dialog will be created later, on demand.
157 // if created in the ctor, for some obscure reason, there is an issue
158 // on Windows: when open it, the simulator frame is sent to the background.
159 // instead of being behind the dialog frame (as it does)
160 m_settingsDlg = nullptr;
161
163
164 Bind( EVT_SIM_UPDATE, &SIM_PLOT_FRAME::onSimUpdate, this );
165 Bind( EVT_SIM_REPORT, &SIM_PLOT_FRAME::onSimReport, this );
166 Bind( EVT_SIM_STARTED, &SIM_PLOT_FRAME::onSimStarted, this );
167 Bind( EVT_SIM_FINISHED, &SIM_PLOT_FRAME::onSimFinished, this );
168 Bind( EVT_SIM_CURSOR_UPDATE, &SIM_PLOT_FRAME::onCursorUpdate, this );
169
170 // Toolbar buttons
171 m_toolSimulate = m_toolBar->AddTool( ID_SIM_RUN, _( "Run/Stop Simulation" ),
172 KiBitmap( BITMAPS::sim_run ), _( "Run Simulation" ), wxITEM_NORMAL );
173 m_toolAddSignals = m_toolBar->AddTool( ID_SIM_ADD_SIGNALS, _( "Add Signals" ),
174 KiBitmap( BITMAPS::sim_add_signal ), _( "Add signals to plot" ), wxITEM_NORMAL );
175 m_toolProbe = m_toolBar->AddTool( ID_SIM_PROBE, _( "Probe" ),
176 KiBitmap( BITMAPS::sim_probe ), _( "Probe signals on the schematic" ), wxITEM_NORMAL );
177 m_toolTune = m_toolBar->AddTool( ID_SIM_TUNE, _( "Tune" ),
178 KiBitmap( BITMAPS::sim_tune ), _( "Tune component values" ), wxITEM_NORMAL );
179 m_toolSettings = m_toolBar->AddTool( wxID_ANY, _( "Sim Parameters" ),
180 KiBitmap( BITMAPS::config ), _( "Simulation parameters and settings" ), wxITEM_NORMAL );
181
182 // Start all toolbar buttons except settings as disabled
183 m_toolSimulate->Enable( false );
184 m_toolAddSignals->Enable( false );
185 m_toolProbe->Enable( false );
186 m_toolTune->Enable( false );
187 m_toolSettings->Enable( true );
188
189 Bind( wxEVT_UPDATE_UI, &SIM_PLOT_FRAME::menuSimulateUpdate, this, m_toolSimulate->GetId() );
190 Bind( wxEVT_UPDATE_UI, &SIM_PLOT_FRAME::menuAddSignalsUpdate, this,
191 m_toolAddSignals->GetId() );
192 Bind( wxEVT_UPDATE_UI, &SIM_PLOT_FRAME::menuProbeUpdate, this, m_toolProbe->GetId() );
193 Bind( wxEVT_UPDATE_UI, &SIM_PLOT_FRAME::menuTuneUpdate, this, m_toolTune->GetId() );
194
195 Bind( wxEVT_COMMAND_TOOL_CLICKED, &SIM_PLOT_FRAME::onSimulate, this, m_toolSimulate->GetId() );
196 Bind( wxEVT_COMMAND_TOOL_CLICKED, &SIM_PLOT_FRAME::onAddSignal, this,
197 m_toolAddSignals->GetId() );
198 Bind( wxEVT_COMMAND_TOOL_CLICKED, &SIM_PLOT_FRAME::onProbe, this, m_toolProbe->GetId() );
199 Bind( wxEVT_COMMAND_TOOL_CLICKED, &SIM_PLOT_FRAME::onTune, this, m_toolTune->GetId() );
200 Bind( wxEVT_COMMAND_TOOL_CLICKED, &SIM_PLOT_FRAME::onSettings, this, m_toolSettings->GetId() );
201
202 Bind( EVT_WORKBOOK_MODIFIED, &SIM_PLOT_FRAME::onWorkbookModified, this );
203 Bind( EVT_WORKBOOK_CLR_MODIFIED, &SIM_PLOT_FRAME::onWorkbookClrModified, this );
204
205 // Bind toolbar buttons event to existing menu event handlers, so they behave the same
206 Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onSimulate, this,
207 m_runSimulation->GetId() );
208 Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onAddSignal, this, m_addSignals->GetId() );
209 Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onProbe, this, m_probeSignals->GetId() );
210 Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onTune, this, m_tuneValue->GetId() );
211 Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onShowNetlist, this,
212 m_showNetlist->GetId() );
213 Bind( wxEVT_COMMAND_MENU_SELECTED, &SIM_PLOT_FRAME::onSettings, this,
214 m_boardAdapter->GetId() );
215
216 m_toolBar->Realize();
217
218#ifndef wxHAS_NATIVE_TABART
219 // Non-native default tab art has ugly gradients we don't want
220 m_workbook->SetArtProvider( new wxAuiSimpleTabArt() );
221#endif
222
223 // Ensure new items are taken in account by sizers:
224 Layout();
225
226 // resize the subwindows size. At least on Windows, calling wxSafeYield before
227 // resizing the subwindows forces the wxSplitWindows size events automatically generated
228 // by wxWidgets to be executed before our resize code.
229 // Otherwise, the changes made by setSubWindowsSashSize are overwritten by one these
230 // events
231 wxSafeYield();
233
234 // Ensure the window is on top
235 Raise();
236
237 initWorkbook();
238 updateTitle();
239}
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_add_signal
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
void SetKiway(wxWindow *aDest, KIWAY *aKiway)
It is only used for debugging, since "this" is not a wxWindow*.
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:394
Special netlist exporter flavor that allows one to override simulation commands.
Schematic editor (Eeschema) main window.
SCHEMATIC & Schematic() const
static std::shared_ptr< SPICE_SIMULATOR > CreateInstance(const std::string &aName)
static void FillDefaultColorList(bool aWhiteBg)
Fills m_colorList by a default set of colors.
wxMenuItem * m_runSimulation
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"))
void setSubWindowsSashSize()
void onShowNetlist(wxCommandEvent &event)
void setIconsForMenuItems()
Give icons to menuitems of the main menubar.
void onProbe(wxCommandEvent &event)
void onCursorUpdate(wxCommandEvent &aEvent)
void onAddSignal(wxCommandEvent &event)
void onSimReport(wxCommandEvent &aEvent)
void onSimStarted(wxCommandEvent &aEvent)
wxToolBarToolBase * m_toolTune
wxToolBarToolBase * m_toolAddSignals
SIM_THREAD_REPORTER * m_reporter
List of currently displayed tuners.
DIALOG_SIM_SETTINGS * m_settingsDlg
wxToolBarToolBase * m_toolSimulate
void menuSimulateUpdate(wxUpdateUIEvent &event) override
void menuAddSignalsUpdate(wxUpdateUIEvent &event) override
void onSimUpdate(wxCommandEvent &aEvent)
void onWorkbookClrModified(wxCommandEvent &event)
wxToolBarToolBase * m_toolProbe
void updateTitle()
Set the main window title bar text.
void onWorkbookModified(wxCommandEvent &event)
bool GetPlotBgOpt() const
SIM_PANEL_BASE * m_lastSimPlot
imagelists used to add a small colored icon to signal names and cursors name, the same color as the c...
void onSimulate(wxCommandEvent &event)
wxToolBarToolBase * m_toolSettings
void menuTuneUpdate(wxUpdateUIEvent &event) override
void initWorkbook()
Load the currently active workbook stored in the project settings.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void onSimFinished(wxCommandEvent &aEvent)
void onSettings(wxCommandEvent &event)
void onTune(wxCommandEvent &event)
SCH_EDIT_FRAME * m_schematicFrame
wxImageList * m_signalsIconColorList
std::shared_ptr< NGSPICE_CIRCUIT_MODEL > m_circuitModel
std::shared_ptr< SPICE_SIMULATOR > m_simulator
void menuProbeUpdate(wxUpdateUIEvent &event) override
unsigned int m_plotNumber
#define _(s)
@ ID_SIM_PROBE
Definition: eeschema_id.h:80
@ ID_SIM_RUN
Definition: eeschema_id.h:78
@ ID_SIM_ADD_SIGNALS
Definition: eeschema_id.h:81
@ ID_SIM_TUNE
Definition: eeschema_id.h:79
@ FRAME_SCH
Definition: frame_type.h:34

References _, config, EDA_BASE_FRAME::config(), 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, m_circuitModel, 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(), SCH_EDIT_FRAME::Schematic(), setIconsForMenuItems(), KIWAY_HOLDER::SetKiway(), setSubWindowsSashSize(), sim_add_signal, sim_probe, sim_run, sim_tune, simulator, and updateTitle().

◆ ~SIM_PLOT_FRAME()

SIM_PLOT_FRAME::~SIM_PLOT_FRAME ( )

Definition at line 242 of file sim_plot_frame.cpp.

243{
244 m_simulator->Attach( nullptr );
245 m_simulator->SetReporter( nullptr );
246 delete m_reporter;
248
249 if( m_settingsDlg )
250 m_settingsDlg->Destroy();
251}

References m_reporter, m_settingsDlg, m_signalsIconColorList, and m_simulator.

Member Function Documentation

◆ AddCurrentPlot()

void SIM_PLOT_FRAME::AddCurrentPlot ( const wxString &  aDeviceName)

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

536{
537 addPlot( aDeviceName, SPT_CURRENT );
538}
void addPlot(const wxString &aName, SIM_PLOT_TYPE aType)
Add a new plot to the current panel.
@ SPT_CURRENT
Definition: sim_types.h:50

References addPlot(), and SPT_CURRENT.

Referenced by DIALOG_SIGNAL_LIST::addSignalToPlotFrame().

◆ addPlot()

void SIM_PLOT_FRAME::addPlot ( const wxString &  aName,
SIM_PLOT_TYPE  aType 
)
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 645 of file sim_plot_frame.cpp.

646{
647 SIM_TYPE simType = m_circuitModel->GetSimType();
648
649 if( simType == ST_UNKNOWN )
650 {
651 m_simConsole->AppendText( _( "Error: simulation type not defined!\n" ) );
652 m_simConsole->SetInsertionPointEnd();
653 return;
654 }
655 else if( !SIM_PANEL_BASE::IsPlottable( simType ) )
656 {
657 m_simConsole->AppendText( _( "Error: simulation type doesn't support plotting!\n" ) );
658 m_simConsole->SetInsertionPointEnd();
659 return;
660 }
661
662 // Create a new plot if the current one displays a different type
663 SIM_PLOT_PANEL* plotPanel = GetCurrentPlot();
664
665 if( !plotPanel || plotPanel->GetType() != simType )
666 {
667 plotPanel =
668 dynamic_cast<SIM_PLOT_PANEL*>( NewPlotPanel( m_circuitModel->GetSimCommand() ) );
669 }
670
671 wxASSERT( plotPanel );
672
673 if( !plotPanel ) // Something is wrong
674 return;
675
676 bool updated = false;
677 SIM_PLOT_TYPE xAxisType = getXAxisType( simType );
678
679 if( xAxisType == SPT_LIN_FREQUENCY || xAxisType == SPT_LOG_FREQUENCY )
680 {
681 int baseType = aType & ~( SPT_AC_MAG | SPT_AC_PHASE );
682
683 // Add two plots: magnitude & phase
684 updated |= updatePlot( aName, ( SIM_PLOT_TYPE )( baseType | SPT_AC_MAG ), plotPanel );
685 updated |= updatePlot( aName, ( SIM_PLOT_TYPE )( baseType | SPT_AC_PHASE ), plotPanel );
686 }
687 else
688 {
689 updated = updatePlot( aName, aType, plotPanel );
690 }
691
692 if( updated )
693 {
695 }
696}
static bool IsPlottable(SIM_TYPE aSimType)
SIM_TYPE GetType() const
void updateSignalList()
Update the list of currently plotted signals.
bool updatePlot(const wxString &aName, SIM_PLOT_TYPE aType, SIM_PLOT_PANEL *aPlotPanel)
Update plot in a particular SIM_PLOT_PANEL.
SIM_PLOT_PANEL * GetCurrentPlot() const
Return the currently opened plot panel (or NULL if there is none).
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_TYPE getXAxisType(SIM_TYPE aType) const
Return X axis for a given simulation type.
SIM_PLOT_TYPE
Definition: sim_types.h:47
@ SPT_LOG_FREQUENCY
Definition: sim_types.h:57
@ SPT_AC_PHASE
Definition: sim_types.h:51
@ SPT_AC_MAG
Definition: sim_types.h:52
@ SPT_LIN_FREQUENCY
Definition: sim_types.h:56
SIM_TYPE
< Possible simulation types
Definition: sim_types.h:32
@ ST_UNKNOWN
Definition: sim_types.h:33

References _, GetCurrentPlot(), SIM_PANEL_BASE::GetType(), getXAxisType(), SIM_PANEL_BASE::IsPlottable(), m_circuitModel, 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 443 of file eda_base_frame.cpp.

444{
446 ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
447
448 helpMenu->Add( ACTIONS::help );
449 helpMenu->Add( ACTIONS::gettingStarted );
450 helpMenu->Add( ACTIONS::listHotKeys );
451 helpMenu->Add( ACTIONS::getInvolved );
452 helpMenu->Add( ACTIONS::donate );
453 helpMenu->Add( ACTIONS::reportBug );
454
455 helpMenu->AppendSeparator();
456 helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
457
458 // Trailing space keeps OSX from hijacking our menu (and disabling everything in it).
459 aMenuBar->Append( helpMenu, _( "&Help" ) + wxS( " " ) );
460}
static TOOL_ACTION reportBug
Cursor control event types.
Definition: actions.h:186
static TOOL_ACTION donate
Definition: actions.h:184
static TOOL_ACTION listHotKeys
Definition: actions.h:183
static TOOL_ACTION getInvolved
Definition: actions.h:185
static TOOL_ACTION gettingStarted
Definition: actions.h:181
static TOOL_ACTION help
Definition: actions.h:182
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:49
Handle actions that are shared between different applications.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:170

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(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_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 541 of file sim_plot_frame.cpp.

542{
544
545 if( !plotPanel )
546 return;
547
549 SIM_MODEL::DEVICE_TYPE_ deviceType = SIM_MODEL::TypeInfo( type ).deviceType;
550
551 switch( deviceType )
552 {
554 case SIM_MODEL::DEVICE_TYPE_::C:
555 case SIM_MODEL::DEVICE_TYPE_::L:
556 case SIM_MODEL::DEVICE_TYPE_::XSPICE:
557 break;
558
559 default:
560 return;
561 }
562
563 const wxString componentName = aSymbol->GetField( REFERENCE_FIELD )->GetText();
564
565 // Do not add multiple instances for the same component
566 auto tunerIt = std::find_if( m_tuners.begin(), m_tuners.end(), [&]( const TUNER_SLIDER* t )
567 {
568 return t->GetComponentName() == componentName;
569 }
570 );
571
572 if( tunerIt != m_tuners.end() )
573 return; // We already have it
574
575 try
576 {
577 TUNER_SLIDER* tuner = new TUNER_SLIDER( this, m_tunePanel, aSymbol );
578 m_tuneSizer->Add( tuner );
579 m_tuners.push_back( tuner );
580 m_tunePanel->Layout();
581 }
582 catch( const KI_PARAM_ERROR& e )
583 {
584 // Sorry, no bonus
585 DisplayErrorMessage( nullptr, e.What() );
586 }
587}
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:87
Hold a translatable error message and may be used when throwing exceptions containing a translated er...
Definition: ki_exception.h:45
const wxString What() const
Definition: ki_exception.h:57
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:892
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with SCH_FIELDs.
Definition: sch_symbol.cpp:928
static INFO TypeInfo(TYPE aType)
Definition: sim_model.cpp:114
static TYPE ReadTypeFromFields(const std::vector< T > &aFields)
Definition: sim_model.cpp:396
std::list< TUNER_SLIDER * > m_tuners
SIM_PANEL_BASE * getCurrentPlotWindow() const
Return the currently opened plot panel (or NULL if there is none).
Custom widget to handle quick component values modification and simulation on the fly.
Definition: tuner_slider.h:43
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:299
SIM_MODEL::TYPE TYPE
Definition: sim_model.cpp:51
#define R()
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".

References DisplayErrorMessage(), getCurrentPlotWindow(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetFields(), EDA_TEXT::GetText(), SIM_PLOT_FRAME_BASE::m_tunePanel, m_tuners, SIM_PLOT_FRAME_BASE::m_tuneSizer, R, SIM_MODEL::ReadTypeFromFields(), REFERENCE_FIELD, SIM_MODEL::TypeInfo(), 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 529 of file sim_plot_frame.cpp.

530{
531 addPlot( aNetName, SPT_VOLTAGE );
532}
@ SPT_VOLTAGE
Definition: sim_types.h:49

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.

Definition at line 918 of file sim_plot_frame.cpp.

919{
920 for( auto& tuner : m_tuners )
921 {
922 std::pair<wxString, bool> command = tuner->GetSpiceTuningCommand();
923 const SPICE_VALUE& value = tuner->GetValue();
924
925 // 0 < value < 1 for model parameter to avoid division by zero, etc.
926 command.first += command.second
927 ? wxString::FromCDouble( Clamp( 1e-9, value.ToDouble() / 100.0, 1-1e-9 ), 9 )
928 : value.ToSpiceString();
929
930 m_simulator->Command( command.first.ToStdString() );
931 }
932}
< Helper class to handle Spice way of expressing values (e.g. 10.5 Meg) Helper class to recognize Spi...
Definition: spice_value.h:35
double ToDouble() const
constexpr T Clamp(const T &lower, const T &value, const T &upper)
Limit value within the range lower <= value <= upper.
Definition: util.h:59

References Clamp(), m_simulator, m_tuners, SPICE_VALUE::ToDouble(), and SPICE_VALUE::ToSpiceString().

Referenced by onSimUpdate(), and StartSimulation().

◆ canCloseWindow()

bool SIM_PLOT_FRAME::canCloseWindow ( wxCloseEvent &  aEvent)
overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 1640 of file sim_plot_frame.cpp.

1641{
1642 if( m_workbook->IsModified() )
1643 {
1644 wxFileName filename = m_simulator->Settings()->GetWorkbookFilename();
1645
1646 if( filename.GetName().IsEmpty() )
1647 {
1648 if( Prj().GetProjectName().IsEmpty() )
1649 filename.SetFullName( wxT( "noname.wbk" ) );
1650 else
1651 filename.SetFullName( Prj().GetProjectName() + wxT( ".wbk" ) );
1652 }
1653
1654 wxString fullFilename = filename.GetFullName();
1655 wxString msg = _( "Save changes to '%s' before closing?" );
1656
1657 return HandleUnsavedChanges( this, wxString::Format( msg, fullFilename ),
1658 [&]() -> bool
1659 {
1660 return saveWorkbook( Prj().AbsolutePath( fullFilename ) );
1661 } );
1662 }
1663
1664 return true;
1665}
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool saveWorkbook(const wxString &aPath)
Save plot settings to a file.
bool IsModified() const
Definition: sim_workbook.h:67
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:240
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

References _, Format(), HandleUnsavedChanges(), 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 1303 of file eda_base_frame.cpp.

1304{
1305 SetUserUnits( aUnits );
1307
1308 wxCommandEvent e( UNITS_CHANGED );
1309 ProcessEventLocally( e );
1310}
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 UNITS_PROVIDER::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 1191 of file eda_base_frame.cpp.

1192{
1193 wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
1194
1195 wxFileName autoSaveFileName = aFileName;
1196
1197 // Check for auto save file.
1198 autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
1199
1200 wxLogTrace( traceAutoSave,
1201 wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
1202
1203 if( !autoSaveFileName.FileExists() )
1204 return;
1205
1206 wxString msg = wxString::Format( _(
1207 "Well this is potentially embarrassing!\n"
1208 "It appears that the last time you were editing the file\n"
1209 "%s\n"
1210 "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
1211 aFileName.GetFullName()
1212 );
1213
1214 int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
1215 this );
1216
1217 // Make a backup of the current file, delete the file, and rename the auto save file to
1218 // the file name.
1219 if( response == wxYES )
1220 {
1221 if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1222 {
1223 wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1224 Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1225 }
1226 }
1227 else
1228 {
1229 wxLogTrace( traceAutoSave,
1230 wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1231
1232 // Remove the auto save file when using the previous file as is.
1233 wxRemoveFile( autoSaveFileName.GetFullPath() );
1234 }
1235}
static wxString GetAutoSaveFilePrefix()
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:111

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

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

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

Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), SCH_EDIT_FRAME::OnClearFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), PCB_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 528 of file eda_base_frame.h.

529 { }

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

◆ ClearUndoRedoList()

◆ commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T  aFrameType)
privateinherited

Collect common initialization functions used in all CTORs.

Definition at line 117 of file eda_base_frame.cpp.

118{
119 m_ident = aFrameType;
120 m_maximizeByDefault = false;
121 m_infoBar = nullptr;
122 m_settingsManager = nullptr;
123 m_fileHistory = nullptr;
124 m_supportsAutoSave = false;
125 m_autoSaveState = false;
127 m_isClosing = false;
128 m_isNonUserClose = false;
129 m_autoSaveTimer = new wxTimer( this, ID_AUTO_SAVE_TIMER );
131 m_frameSize = defaultSize( aFrameType );
132 m_displayIndex = -1;
133
134 m_auimgr.SetArtProvider( new WX_AUI_DOCK_ART() );
135
136 m_settingsManager = &Pgm().GetSettingsManager();
137
138 // Set a reasonable minimal size for the frame
139 SetSizeHints( minSize( aFrameType ).x, minSize( aFrameType ).y, -1, -1, -1, -1 );
140
141 // Store dimensions of the user area of the main window.
142 GetClientSize( &m_frameSize.x, &m_frameSize.y );
143
144 Connect( ID_AUTO_SAVE_TIMER, wxEVT_TIMER,
145 wxTimerEventHandler( EDA_BASE_FRAME::onAutoSaveTimer ) );
146
147 // hook wxEVT_CLOSE_WINDOW so we can call SaveSettings(). This function seems
148 // to be called before any other hook for wxCloseEvent, which is necessary.
149 Connect( wxEVT_CLOSE_WINDOW, wxCloseEventHandler( EDA_BASE_FRAME::windowClosing ) );
150
151 initExitKey();
152}
void windowClosing(wxCloseEvent &event)
(with its unexpected name so it does not collide with the real OnWindowClose() function provided in d...
void initExitKey()
Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
WX_INFOBAR * m_infoBar
void onAutoSaveTimer(wxTimerEvent &aEvent)
Handle the auto save timer event.
wxTimer * m_autoSaveTimer
wxAuiManager m_auimgr
SETTINGS_MANAGER * m_settingsManager
bool m_isClosing
Set by NonUserClose() to indicate that the user did not request the current close.
wxString m_mruPath
static wxString GetDefaultUserProjectsPath()
Gets the default path we point users to create projects.
Definition: paths.cpp:139
static const wxSize minSize(FRAME_T aFrameType)
static const wxSize defaultSize(FRAME_T aFrameType)
#define DEFAULT_MAX_UNDO_ITEMS
@ ID_AUTO_SAVE_TIMER
Definition: id.h:79

References DEFAULT_MAX_UNDO_ITEMS, defaultSize(), PATHS::GetDefaultUserProjectsPath(), ID_AUTO_SAVE_TIMER, minSize(), EDA_BASE_FRAME::onAutoSaveTimer(), Pgm(), and EDA_BASE_FRAME::windowClosing().

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ CommonSettingsChanged()

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

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

Update menus, toolbars, local variables, etc.

Reimplemented from TOOLS_HOLDER.

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

Definition at line 475 of file eda_base_frame.cpp.

476{
477 TOOLS_HOLDER::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
478
479 COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
480
481 if( m_fileHistory )
482 {
483 int historySize = settings->m_System.file_history_size;
484 m_fileHistory->SetMaxFiles( (unsigned) std::max( 0, historySize ) );
485 }
486
488 ThemeChanged();
489
490 if( GetMenuBar() )
491 {
492 // For icons in menus, icon scaling & hotkeys
494 GetMenuBar()->Refresh();
495 }
496}
BITMAP_STORE * GetBitmapStore()
Definition: bitmap.cpp:93
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.
void SetMaxFiles(size_t aMaxFiles)
Update the number of files that will be contained inside the file history.
Definition: filehistory.cpp:85
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.

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 KIWAY::CommonSettingsChanged(), EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), and KICAD_MANAGER_FRAME::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 788 of file eda_base_frame.cpp.

789{
790 // KICAD_MANAGER_FRAME overrides this
791 return Kiface().KifaceSettings();
792}
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:93

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(), doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_EDIT_FRAME::GetRotationAngle(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), GERBVIEW_FRAME::gvconfig(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), 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(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), GRID_MENU::update(), ZOOM_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 341 of file eda_base_frame.h.

342 {
343 wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
344 return baseCfgName;
345 }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

Definition at line 813 of file eda_base_frame.cpp.

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

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 if( m_socketServer )
55 {
56 // this helps prevent any events that could come in during deletion
57 m_socketServer->Notify( false );
58 delete m_socketServer;
59 }
60
61 m_socketServer = new wxSocketServer( addr );
62
63 m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
64 m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
65 m_socketServer->Notify( true );
66}
wxSocketServer * m_socketServer
Definition: kiway_player.h:218
static const wxString HOSTNAME(wxT("localhost"))
@ ID_EDA_SOCKET_EVENT_SERV
Definition: id.h:163

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 110 of file tools_holder.cpp.

111{
112 if( m_toolStack.empty() )
114 else
115 return m_toolStack.back();
116}
static TOOL_ACTION selectionTool
Definition: actions.h:156
std::vector< std::string > m_toolStack
Definition: tools_holder.h:176
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 TOOLS_HOLDER::ShowChangedLanguage().

◆ Destroy()

◆ DismissModal()

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

Definition at line 182 of file kiway_player.cpp.

183{
184 m_modal_ret_val = aRetVal;
185 m_modal_string = aResult;
186
187 if( m_modal_loop )
188 {
189 m_modal_loop->Exit();
190 m_modal_loop = nullptr; // this marks it as dismissed.
191 }
192
193 Show( false );
194}
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
bool m_modal_ret_val
Definition: kiway_player.h:216

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

133{};

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

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void SIM_PLOT_FRAME::doCloseWindow ( )
overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 1668 of file sim_plot_frame.cpp.

1669{
1670 if( m_simulator->IsRunning() )
1671 m_simulator->Stop();
1672
1673 // Prevent memory leak on exit by deleting all simulation vectors
1674 m_simulator->Clean();
1675
1676 // Cancel a running simProbe or simTune tool
1678
1679 SaveSettings( config() );
1680 Destroy();
1681}
static TOOL_ACTION cancelInteractive
Definition: actions.h:63
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:142

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

◆ DoWithAcceptedFiles()

void EDA_BASE_FRAME::DoWithAcceptedFiles ( )
protectedvirtualinherited

Execute action on accepted dropped file.

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

Reimplemented in GERBVIEW_FRAME, KICAD_MANAGER_FRAME, and PL_EDITOR_FRAME.

Definition at line 1138 of file eda_base_frame.cpp.

1139{
1140 for( const wxFileName& file : m_AcceptedFiles )
1141 {
1142 wxString fn = file.GetFullPath();
1143 m_toolManager->RunAction( *m_acceptedExts.at( file.GetExt() ), true, &fn );
1144 }
1145}
std::vector< wxFileName > m_AcceptedFiles
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
Associates files extensions with action to execute.

References EDA_BASE_FRAME::m_acceptedExts, EDA_BASE_FRAME::m_AcceptedFiles, TOOLS_HOLDER::m_toolManager, and TOOL_MANAGER::RunAction().

Referenced by EDA_BASE_FRAME::OnDropFiles().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )
protectedinherited

Definition at line 640 of file eda_base_frame.cpp.

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

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

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )
privateinherited

Definition at line 168 of file eda_base_frame.cpp.

169{
170 for( wxWindow* iter : GetChildren() )
171 {
172 DIALOG_SHIM* dlg = dynamic_cast<DIALOG_SHIM*>( iter );
173
174 if( dlg && dlg->IsQuasiModal() )
175 return dlg;
176 }
177
178 // FIXME: CvPcb is currently implemented on top of KIWAY_PLAYER rather than DIALOG_SHIM,
179 // so we have to look for it separately.
180 if( m_ident == FRAME_SCH )
181 {
182 wxWindow* cvpcb = wxWindow::FindWindowByName( "CvpcbFrame" );
183
184 if( cvpcb )
185 return cvpcb;
186 }
187
188 return nullptr;
189}
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition: dialog_shim.h:83
bool IsQuasiModal() const
Definition: dialog_shim.h:106

References FRAME_SCH, DIALOG_SHIM::IsQuasiModal(), and EDA_BASE_FRAME::m_ident.

Referenced by EDA_BASE_FRAME::ProcessEvent(), and EDA_BASE_FRAME::windowClosing().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 825 of file eda_base_frame.cpp.

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

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
inherited

Definition at line 297 of file eda_base_frame.cpp.

298{
299 return Pgm().GetCommonSettings()->m_System.autosave_interval;
300}

References Pgm().

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

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

Definition at line 422 of file eda_base_frame.h.

422{ 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 621 of file sim_plot_frame.cpp.

622{
624
625 return ( ( !curPage || curPage->GetType() == ST_UNKNOWN ) ?
626 nullptr :
627 dynamic_cast<SIM_PLOT_PANEL*>( curPage ) );
628}

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(), 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 239 of file sim_plot_frame.h.

240 {
241 return dynamic_cast<SIM_PANEL_BASE*>( m_workbook->GetCurrentPage() );
242 }

References SIM_PLOT_FRAME_BASE::m_workbook.

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

◆ GetCurrentSelection()

virtual SELECTION & TOOLS_HOLDER::GetCurrentSelection ( )
inlinevirtualinherited

◆ getCurrentSimCommand()

wxString SIM_PLOT_FRAME::getCurrentSimCommand ( ) const
inlineprivate

Definition at line 247 of file sim_plot_frame.h.

248 {
249 if( getCurrentPlotWindow() == nullptr )
250 return m_circuitModel->GetSheetSimCommand();
251 else
253 }
const wxString & GetSimCommand(const SIM_PANEL_BASE *aPlotPanel)
Definition: sim_workbook.h:61

References getCurrentPlotWindow(), SIM_WORKBOOK::GetSimCommand(), m_circuitModel, 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 1106 of file sim_plot_frame.cpp.

1107{
1108 wxFileName filename = m_simulator->Settings()->GetWorkbookFilename();
1109
1110 if( filename.GetName().IsEmpty() )
1111 {
1112 if( Prj().GetProjectName().IsEmpty() )
1113 {
1114 filename.SetName( _( "noname" ) );
1115 filename.SetExt( WorkbookFileExtension );
1116 }
1117 else
1118 {
1119 filename.SetName( Prj().GetProjectName() );
1120 filename.SetExt( WorkbookFileExtension );
1121 }
1122 }
1123
1124 return filename.GetFullName();
1125}
const std::string WorkbookFileExtension

References _, 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 1128 of file sim_plot_frame.cpp.

1129{
1130 wxFileName path = m_simulator->Settings()->GetWorkbookFilename();
1131
1132 path.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS, Prj().GetProjectPath() );
1133 return path.GetPath();
1134}
#define FN_NORMALIZE_FLAGS
Default flags to pass to wxFileName::Normalize().
Definition: wx_filename.h:38

References FN_NORMALIZE_FLAGS, 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 141 of file tools_holder.h.

141{ return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:183

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

147{ return m_dragAction; }
MOUSE_DRAG_ACTION m_dragAction
Definition: tools_holder.h:187

References TOOLS_HOLDER::m_dragAction.

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

◆ GetExporter()

const NGSPICE_CIRCUIT_MODEL * SIM_PLOT_FRAME::GetExporter ( ) const

Return the netlist exporter object used for simulations.

Definition at line 631 of file sim_plot_frame.cpp.

632{
633 return m_circuitModel.get();
634}

References m_circuitModel.

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

910{
911 if( !aFileHistory )
912 aFileHistory = m_fileHistory;
913
914 wxASSERT( aFileHistory );
915
916 int baseId = aFileHistory->GetBaseId();
917
918 wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
919
920 unsigned i = cmdId - baseId;
921
922 if( i < aFileHistory->GetCount() )
923 {
924 wxString fn = aFileHistory->GetHistoryFile( i );
925
926 if( wxFileName::FileExists( fn ) )
927 {
928 return fn;
929 }
930 else
931 {
932 DisplayErrorMessage( this, wxString::Format( _( "File '%s' was not found." ), fn ) );
933 aFileHistory->RemoveFileFromHistory( i );
934 }
935 }
936
937 // Update the menubar to update the file history menu
938 if( GetMenuBar() )
939 {
941 GetMenuBar()->Refresh();
942 }
943
944 return wxEmptyString;
945}

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

407 {
408 return *m_fileHistory;
409 }

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const
inlineinherited

Definition at line 198 of file eda_base_frame.h.

198{ return m_ident; }

References EDA_BASE_FRAME::m_ident.

Referenced by PCB_BASE_FRAME::GetViewerSettingsBase(), and EDA_BASE_FRAME::OnPreferences().

◆ GetInfoBar()

◆ GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const
inlineinherited

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 565 of file eda_base_frame.h.

565{ 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 153 of file tools_holder.h.

153{ return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:189

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

◆ GetOriginTransforms()

virtual ORIGIN_TRANSFORMS & EDA_BASE_FRAME::GetOriginTransforms ( )
inlinevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented in PCB_BASE_FRAME.

Definition at line 130 of file eda_base_frame.h.

130{ return m_originTransforms; }
ORIGIN_TRANSFORMS m_originTransforms

References EDA_BASE_FRAME::m_originTransforms.

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

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

135{ return m_plotUseWhiteBg; }

References m_plotUseWhiteBg.

Referenced by menuWhiteBackground(), and SIM_PLOT_FRAME().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetSettingsManager()

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int  aErrorCode) const
inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 135 of file eda_base_frame.h.

135{ return RPT_SEVERITY_UNDEFINED; }
@ RPT_SEVERITY_UNDEFINED

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetSimulatorSettings()

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

Definition at line 637 of file sim_plot_frame.cpp.

638{
639 wxASSERT( m_simulator->Settings() );
640
641 return m_simulator->Settings();
642}

References m_simulator.

◆ GetToolCanvas()

wxWindow * SIM_PLOT_FRAME::GetToolCanvas ( ) const
inlineoverridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 144 of file sim_plot_frame.h.

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

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), SCH_NAVIGATE_TOOL::Back(), BOARD_COMMIT::BOARD_COMMIT(), SCH_NAVIGATE_TOOL::changeSheet(), 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::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_NAVIGATE_TOOL::Forward(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineBreakTrack(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnDeleteOneClick(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), GERBER_LAYER_WIDGET::onPopupSelection(), onProbe(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_PANEL::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), PCB_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(), EDA_3D_VIEWER_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), DIALOG_FIND::search(), FOOTPRINT_SEARCH_HANDLER::SelectItems(), ZONE_SEARCH_HANDLER::SelectItems(), TEXT_SEARCH_HANDLER::SelectItems(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), PCB_PROPERTIES_PANEL::UpdateData(), DIALOG_DRC::updateDisplayedCounts(), CVPCB_MAINFRAME::updateFootprintViewerOnIdle(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), PCB_PROPERTIES_PANEL::valueChanged(), 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:85

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const
inlineinherited

Definition at line 37 of file units_provider.h.

37{ return m_userUnits; }
EDA_UNITS m_userUnits

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortDiffPairsClick(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortTrackWidthsClick(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortViaSizesClick(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), PANEL_FP_EDITOR_DEFAULTS::PANEL_FP_EDITOR_DEFAULTS(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), SCH_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), UNITS_PROVIDER::StringFromValue(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), PROPERTIES_PANEL::update(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and UNITS_PROVIDER::ValueFromString().

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

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

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

1338{
1339#ifdef __WXGTK__
1340 wxSize winSize = GetSize();
1341
1342 // GTK includes the window decorations in the normal GetSize call,
1343 // so we have to use a GTK-specific sizing call that returns the
1344 // non-decorated window size.
1346 {
1347 int width = 0;
1348 int height = 0;
1349 GTKDoGetSize( &width, &height );
1350
1351 winSize.Set( width, height );
1352 }
1353#else
1354 wxSize winSize = GetSize();
1355#endif
1356
1357 return winSize;
1358}
@ KICAD_MAIN_FRAME_T
Definition: frame_type.h:64

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

1138{
1139 switch( aType )
1140 {
1142 case ST_AC: return SPT_LIN_FREQUENCY;
1143 case ST_DC: return SPT_SWEEP;
1144 case ST_TRANSIENT: return SPT_TIME;
1145 default:
1146 wxASSERT_MSG( false, "Unhandled simulation type" );
1147 return (SIM_PLOT_TYPE) 0;
1148 }
1149}
@ SPT_TIME
Definition: sim_types.h:55
@ SPT_SWEEP
Definition: sim_types.h:58
@ ST_TRANSIENT
Definition: sim_types.h:42
@ ST_AC
Definition: sim_types.h:34
@ ST_DC
Definition: sim_types.h:35

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

Referenced by addPlot().

◆ handleIconizeEvent()

virtual void EDA_BASE_FRAME::handleIconizeEvent ( wxIconizeEvent &  aEvent)
inlineprotectedvirtualinherited

Handle a window iconize event.

Parameters
aEventis the data for the event.

Reimplemented in EDA_3D_VIEWER_FRAME, SCH_BASE_FRAME, and PCB_BASE_FRAME.

Definition at line 601 of file eda_base_frame.h.

601{}

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

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )
virtualinherited

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

Definition at line 1361 of file eda_base_frame.cpp.

1362{
1363 // Update the icon theme when the system theme changes and update the toolbars
1365 ThemeChanged();
1366
1367 // This isn't handled by ThemeChanged()
1368 if( GetMenuBar() )
1369 {
1370 // For icons in menus, icon scaling & hotkeys
1372 GetMenuBar()->Refresh();
1373 }
1374}

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

361{
362 bool checkRes = false;
363 bool enableRes = true;
364 bool showRes = true;
365 bool isCut = aEvent.GetId() == ACTIONS::cut.GetUIId();
366 bool isCopy = aEvent.GetId() == ACTIONS::copy.GetUIId();
367 bool isPaste = aEvent.GetId() == ACTIONS::paste.GetUIId();
368 SELECTION& selection = aFrame->GetCurrentSelection();
369
370 try
371 {
372 checkRes = aCond.checkCondition( selection );
373 enableRes = aCond.enableCondition( selection );
374 showRes = aCond.showCondition( selection );
375 }
376 catch( std::exception& )
377 {
378 // Something broke with the conditions, just skip the event.
379 aEvent.Skip();
380 return;
381 }
382
383 if( isCut || isCopy || isPaste )
384 {
385 wxWindow* focus = wxWindow::FindFocus();
386 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( focus );
387
388 if( textEntry && isCut && textEntry->CanCut() )
389 enableRes = true;
390 else if( textEntry && isCopy && textEntry->CanCopy() )
391 enableRes = true;
392 else if( textEntry && isPaste && textEntry->CanPaste() )
393 enableRes = true;
394 }
395
396 aEvent.Enable( enableRes );
397 aEvent.Show( showRes );
398
399 // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
400 // checked, since wxMenuItems don't want to be checked unless they actually are checkable
401#if wxCHECK_VERSION( 3, 1, 5 )
402 if( aEvent.IsCheckable() )
403 aEvent.Check( checkRes );
404#else
405 bool canCheck = true;
406
407 // wxMenuItems don't want to be checked unless they actually are checkable, so we have to
408 // check to see if they can be and can't just universally apply a check in this event.
409 if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
410 canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
411
412 if( canCheck )
413 aEvent.Check( checkRes );
414#endif
415}
static TOOL_ACTION paste
Definition: actions.h:69
static TOOL_ACTION copy
Definition: actions.h:68
static TOOL_ACTION cut
Definition: actions.h:67
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:101
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.
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.

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

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const
inlineinherited

Safety check before asking for the Kiway reference.

Returns
true if kiway is non-null

Definition at line 63 of file kiway_holder.h.

64 {
65 return m_kiway != nullptr;
66 }
KIWAY * m_kiway
Definition: kiway_holder.h:84

References KIWAY_HOLDER::m_kiway.

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 801 of file eda_base_frame.cpp.

802{
803 return Kiface().GetHelpFileName();
804}
const wxString & GetHelpFileName() const
Return just the basename portion of the current help file.
Definition: kiface_base.h:110

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

1246{
1247 wxAcceleratorEntry entries[1];
1248 entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
1249 wxAcceleratorTable accel( 1, entries );
1250 SetAcceleratorTable( accel );
1251}

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

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

Referenced by SIM_PLOT_FRAME().

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

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

Definition at line 1238 of file eda_base_frame.cpp.

1239{
1240 // This function should be overridden in child classes
1241 return false;
1242}

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

◆ IsCurrentTool()

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

Definition at line 119 of file tools_holder.cpp.

120{
121 if( m_toolStack.empty() )
122 return &aAction == &ACTIONS::selectionTool;
123 else
124 return m_toolStack.back() == aAction.GetName();
125}

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

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

177{
178 return !m_modal_loop;
179}

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(), KIWAY_PLAYER::ShowModal(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 197 of file eda_base_frame.h.

197{ 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(), SYMBOL_EDITOR_CONTROL::DdAddLibrary(), 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(), SCH_BASE_FRAME::GetColorSettings(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), DIALOG_FIELD_PROPERTIES::init(), SYMBOL_EDITOR_CONTROL::Init(), CONVERT_TOOL::Init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PCB_BASE_FRAME::loadFootprint(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), PCB_CONTROL::placeBoardItems(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), PCB_SELECTION_TOOL::Reset(), SYMBOL_EDITOR_CONTROL::Revert(), SYMBOL_EDITOR_CONTROL::Save(), APPEARANCE_CONTROLS::setVisibleObjects(), EE_INSPECTION_TOOL::ShowDatasheet(), EE_INSPECTION_TOOL::ShowERCDialog(), SYMBOL_EDITOR_CONTROL::ToggleSymbolTree(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), 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 1148 of file eda_base_frame.cpp.

1149{
1150 wxString msg;
1151 wxFileName fn = aFileName;
1152
1153 // Check for absence of a file path with a file name. Unfortunately KiCad
1154 // uses paths relative to the current project path without the ./ part which
1155 // confuses wxFileName. Making the file name path absolute may be less than
1156 // elegant but it solves the problem.
1157 if( fn.GetPath().IsEmpty() && fn.HasName() )
1158 fn.MakeAbsolute();
1159
1160 wxCHECK_MSG( fn.IsOk(), false,
1161 wxT( "File name object is invalid. Bad programmer!" ) );
1162 wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
1163 wxT( "File name object path <" ) + fn.GetFullPath() +
1164 wxT( "> is not set. Bad programmer!" ) );
1165
1166 if( fn.IsDir() && !fn.IsDirWritable() )
1167 {
1168 msg.Printf( _( "Insufficient permissions to folder '%s'." ), fn.GetPath() );
1169 }
1170 else if( !fn.FileExists() && !fn.IsDirWritable() )
1171 {
1172 msg.Printf( _( "Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
1173 }
1174 else if( fn.FileExists() && !fn.IsFileWritable() )
1175 {
1176 msg.Printf( _( "Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
1177 }
1178
1179 if( !msg.IsEmpty() )
1180 {
1181 if( aVerbose )
1182 wxMessageBox( msg );
1183
1184 return false;
1185 }
1186
1187 return true;
1188}

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 }

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(), IMPORT_PROJ_HELPER::AssociateFileWithProj(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), SCH_EDIT_FRAME::canCloseWindow(), PCB_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), SYMBOL_EDIT_FRAME::DdAddLibrary(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::FetchNetlistFromSchematic(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PGM_SINGLE_TOP::MacOpenFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), KIGFX::WX_VIEW_CONTROLS::onMotion(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), onProbe(), PCB_EDIT_FRAME::OnQuit(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), onTune(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SCH_EDITOR_CONTROL::rescueProject(), PCB_EDIT_FRAME::RunEeschema(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), SYMBOL_EDIT_FRAME::saveCurrentSymbol(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), PCB_BASE_FRAME::SelectFootprintFromLibBrowser(), PCB_BASE_FRAME::SelectLibrary(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), PCB_EDIT_FRAME::SendCrossProbeItem(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), PCB_EDIT_FRAME::SendSelectItemsToSch(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME(), PCB_EDIT_FRAME::TestStandalone(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS aEvent)
protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 197 of file kiway_player.cpp.

198{
199 // logging support
200 KiwayMailIn( aEvent ); // call the virtual, override in derived.
201}
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 CVPCB_MAINFRAME, SCH_EDIT_FRAME, PCB_EDIT_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 87 of file kiway_player.cpp.

88{
89 // override this in derived classes.
90}

Referenced by KIWAY_PLAYER::kiway_express(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), 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 204 of file kiway_player.cpp.

205{
206 int id = event.GetId();
207
208 // tell all the KIWAY_PLAYERs about the language change.
209 Kiway().SetLanguage( id );
210}
virtual void SetLanguage(int aLanguage)
Change the language and then calls ShowChangedLanguage() on all #KIWAY_PLAYERs.
Definition: kiway.cpp:504

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

255{
256 EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( aCfg );
257 wxASSERT( cfg );
258
259 if( cfg )
260 {
262
263 // Read subwindows sizes (should be > 0 )
269 }
270
272
273 NGSPICE* currentSim = dynamic_cast<NGSPICE*>( m_simulator.get() );
274
275 if( currentSim )
276 m_simulator->Settings() = project.m_SchematicSettings->m_NgspiceSimulatorSettings;
277}
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:65
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:148
int m_splitterSignalsSashPosition
int m_splitterTuneValuesSashPosition
int m_splitterLeftRightSashPosition
int m_splitterPlotAndConsoleSashPosition

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

693{
694 LoadWindowState( aCfg->state );
695
697 m_mruPath = aCfg->mru_path;
698
700}
void LoadWindowState(const wxString &aFileName)
wxString m_perspective
WINDOW_STATE state
Definition: app_settings.h:84
wxString mru_path
Definition: app_settings.h:85
wxString perspective
Definition: app_settings.h:86

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

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE aState)
virtualinherited

Load frame state info from a configuration file.

Definition at line 546 of file eda_base_frame.cpp.

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

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.

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString &  aFileName)
inherited

Definition at line 532 of file eda_base_frame.cpp.

533{
534 if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
535 return;
536
537 const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
538
539 if( state != nullptr )
540 {
541 LoadWindowState( state->window );
542 }
543}
const PROJECT_FILE_STATE * GetFileState(const wxString &aFileName)
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:154
struct WINDOW_STATE window

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

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

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

936{
938
939 wxTextFile file( aPath );
940
941#define DISPLAY_LOAD_ERROR( fmt ) DisplayErrorMessage( this, wxString::Format( _( fmt ), \
942 file.GetCurrentLine()+1 ) )
943
944 if( !file.Open() )
945 return false;
946
947 long plotsCount;
948
949 if( !file.GetFirstLine().ToLong( &plotsCount ) ) // GetFirstLine instead of GetNextLine
950 {
951 DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." );
952 file.Close();
953
954 return false;
955 }
956
957 for( long i = 0; i < plotsCount; ++i )
958 {
959 long plotType, tracesCount;
960
961 if( !file.GetNextLine().ToLong( &plotType ) )
962 {
963 DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." );
964 file.Close();
965
966 return false;
967 }
968
969 wxString simCommand = UnescapeString( file.GetNextLine() );
970 NewPlotPanel( simCommand );
971 StartSimulation( simCommand );
972
973 // Perform simulation, so plots can be added with values
974 do
975 {
976 wxThread::This()->Sleep( 50 );
977 }
978 while( m_simulator->IsRunning() );
979
980 if( !file.GetNextLine().ToLong( &tracesCount ) )
981 {
982 DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." );
983 file.Close();
984
985 return false;
986 }
987
988 for( long j = 0; j < tracesCount; ++j )
989 {
990 long traceType;
991 wxString name, param;
992
993 if( !file.GetNextLine().ToLong( &traceType ) )
994 {
995 DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." );
996 file.Close();
997
998 return false;
999 }
1000
1001 name = file.GetNextLine();
1002
1003 if( name.IsEmpty() )
1004 {
1005 DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is empty." );
1006 file.Close();
1007
1008 return false;
1009 }
1010
1011 param = file.GetNextLine();
1012
1013 if( param.IsEmpty() )
1014 {
1015 DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is empty." );
1016 file.Close();
1017
1018 return false;
1019 }
1020
1021 addPlot( name, (SIM_PLOT_TYPE) traceType );
1022 }
1023 }
1024
1025 file.Close();
1026
1027 wxFileName filename( aPath );
1028 filename.MakeRelativeTo( Prj().GetProjectPath() );
1029
1030 // Remember the loaded workbook filename.
1031 m_simulator->Settings()->SetWorkbookFilename( filename.GetFullPath() );
1032
1033 // Successfully loading a workbook does not count as modifying it.
1035 return true;
1036}
const char * name
Definition: DXF_plotter.cpp:56
void StartSimulation(const wxString &aSimCommand=wxEmptyString)
bool DeleteAllPages() override
void ClrModified()
#define DISPLAY_LOAD_ERROR(fmt)
wxString UnescapeString(const wxString &aSource)

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 130 of file sim_plot_frame_base.h.

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

References SIM_PLOT_FRAME_BASE::m_splitterLeftRight, and SIM_PLOT_FRAME_BASE::m_splitterLeftRightOnIdle().

Referenced by SIM_PLOT_FRAME_BASE::m_splitterLeftRightOnIdle(), and SIM_PLOT_FRAME_BASE::SIM_PLOT_FRAME_BASE().

◆ m_splitterPlotAndConsoleOnIdle()

void SIM_PLOT_FRAME_BASE::m_splitterPlotAndConsoleOnIdle ( wxIdleEvent &  )
inlineinherited

◆ m_splitterSignalsOnIdle()

void SIM_PLOT_FRAME_BASE::m_splitterSignalsOnIdle ( wxIdleEvent &  )
inlineinherited

Definition at line 142 of file sim_plot_frame_base.h.

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

References SIM_PLOT_FRAME_BASE::m_splitterSignals, and SIM_PLOT_FRAME_BASE::m_splitterSignalsOnIdle().

Referenced by SIM_PLOT_FRAME_BASE::m_splitterSignalsOnIdle(), and SIM_PLOT_FRAME_BASE::SIM_PLOT_FRAME_BASE().

◆ m_splitterTuneValuesOnIdle()

void SIM_PLOT_FRAME_BASE::m_splitterTuneValuesOnIdle ( wxIdleEvent &  )
inlineinherited

Definition at line 148 of file sim_plot_frame_base.h.

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

References SIM_PLOT_FRAME_BASE::m_splitterTuneValues, and SIM_PLOT_FRAME_BASE::m_splitterTuneValuesOnIdle().

Referenced by SIM_PLOT_FRAME_BASE::m_splitterTuneValuesOnIdle(), and 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 1372 of file sim_plot_frame.cpp.

1373{
1374 event.Enable( m_simFinished );
1375}

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

267 {
268 Close();
269 }

◆ menuNewPlot()

void SIM_PLOT_FRAME::menuNewPlot ( wxCommandEvent &  aEvent)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1152 of file sim_plot_frame.cpp.

1153{
1154 SIM_TYPE type = m_circuitModel->GetSimType();
1155
1156 if( SIM_PANEL_BASE::IsPlottable( type ) )
1157 NewPlotPanel( m_circuitModel->GetSimCommand() );
1158}

References SIM_PANEL_BASE::IsPlottable(), m_circuitModel, and NewPlotPanel().

◆ menuOpenWorkbook()

void SIM_PLOT_FRAME::menuOpenWorkbook ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1161 of file sim_plot_frame.cpp.

1162{
1163 wxFileDialog openDlg( this, _( "Open simulation workbook" ), getDefaultPath(), "",
1164 WorkbookFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST );
1165
1166 if( openDlg.ShowModal() == wxID_CANCEL )
1167 return;
1168
1169 loadWorkbook( openDlg.GetPath() );
1170}
wxString getDefaultPath()
Return the default path to be used in file browser dialog.
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 1378 of file sim_plot_frame.cpp.

1379{
1380 event.Enable( m_simFinished );
1381}

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

1219{
1220 if( !GetCurrentPlot() )
1221 return;
1222
1223 const wxChar SEPARATOR = ';';
1224
1225 wxFileDialog saveDlg( this, _( "Save Plot Data" ), "", "", CsvFileWildcard(),
1226 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1227
1228 if( saveDlg.ShowModal() == wxID_CANCEL )
1229 return;
1230
1231 wxFFile out( saveDlg.GetPath(), "wb" );
1232
1233 std::map<wxString, TRACE *> traces = GetCurrentPlot()->GetTraces();
1234
1235 if( traces.size() == 0 )
1236 return;
1237
1238 SIM_TYPE simType = m_circuitModel->GetSimType();
1239
1240 std::size_t rowCount = traces.begin()->second->GetDataX().size();
1241
1242 // write column header names on the first row
1243 wxString xAxisName( m_simulator->GetXAxis( simType ) );
1244 out.Write( wxString::Format( "%s%c", xAxisName, SEPARATOR ) );
1245
1246 for( const auto& trace : traces )
1247 {
1248 wxString yAxisName = trace.first;
1249 out.Write( wxString::Format( "%s%c", yAxisName, SEPARATOR ) );
1250 }
1251
1252 out.Write( "\r\n" );
1253
1254 // write each row's numerical value
1255 for ( std::size_t curRow=0; curRow < rowCount; curRow++ )
1256 {
1257 double xAxisValue = traces.begin()->second->GetDataX().at( curRow );
1258 out.Write( wxString::Format( "%g%c", xAxisValue, SEPARATOR ) );
1259
1260 for( const auto& trace : traces )
1261 {
1262 double yAxisValue = trace.second->GetDataY().at( curRow );
1263 out.Write( wxString::Format( "%g%c", yAxisValue, SEPARATOR ) );
1264 }
1265
1266 out.Write( "\r\n" );
1267 }
1268
1269 out.Close();
1270}
const std::map< wxString, TRACE * > & GetTraces() const
wxString CsvFileWildcard()
#define SEPARATOR
Definition: wx_combobox.cpp:27

References _, CsvFileWildcard(), Format(), GetCurrentPlot(), SIM_PLOT_PANEL::GetTraces(), m_circuitModel, m_simulator, and SEPARATOR.

◆ menuSaveImage()

void SIM_PLOT_FRAME::menuSaveImage ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1203 of file sim_plot_frame.cpp.

1204{
1205 if( !GetCurrentPlot() )
1206 return;
1207
1208 wxFileDialog saveDlg( this, _( "Save Plot as Image" ), "", "", PngFileWildcard(),
1209 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1210
1211 if( saveDlg.ShowModal() == wxID_CANCEL )
1212 return;
1213
1214 GetCurrentPlot()->GetPlotWin()->SaveScreenshot( saveDlg.GetPath(), wxBITMAP_TYPE_PNG );
1215}
mpWindow * GetPlotWin() const
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
wxString PngFileWildcard()

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

1174{
1175 if( !m_workbook->IsModified() )
1176 return;
1177
1178 wxString filename = m_simulator->Settings()->GetWorkbookFilename();
1179
1180 if( filename.IsEmpty() )
1181 {
1182 menuSaveWorkbookAs( event );
1183 return;
1184 }
1185
1186 saveWorkbook( Prj().AbsolutePath( m_simulator->Settings()->GetWorkbookFilename() ) );
1187}
void menuSaveWorkbookAs(wxCommandEvent &event) override

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

1191{
1192 wxFileDialog saveAsDlg( this, _( "Save Simulation Workbook As" ), getDefaultPath(),
1194 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1195
1196 if( saveAsDlg.ShowModal() == wxID_CANCEL )
1197 return;
1198
1199 saveWorkbook( Prj().AbsolutePath( saveAsDlg.GetPath() ) );
1200}
wxString getDefaultFilename()
Return the default filename (with extension) to be used in file browser dialog.

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

1328{
1330
1331 if( plot )
1332 plot->SetDottedCurrentPhase( !plot->GetDottedCurrentPhase() );
1333}

References GetCurrentPlot(), and plot.

◆ menuShowDottedUpdate()

void SIM_PLOT_FRAME::menuShowDottedUpdate ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1336 of file sim_plot_frame.cpp.

1337{
1339
1340 event.Check( plot ? plot->GetDottedCurrentPhase() : false );
1341}

References GetCurrentPlot(), and plot.

◆ menuShowGrid()

void SIM_PLOT_FRAME::menuShowGrid ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1294 of file sim_plot_frame.cpp.

1295{
1297
1298 if( plot )
1299 plot->ShowGrid( !plot->IsGridShown() );
1300}

References GetCurrentPlot(), and plot.

◆ menuShowGridUpdate()

void SIM_PLOT_FRAME::menuShowGridUpdate ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1303 of file sim_plot_frame.cpp.

1304{
1306
1307 event.Check( plot ? plot->IsGridShown() : false );
1308}

References GetCurrentPlot(), and plot.

◆ menuShowLegend()

void SIM_PLOT_FRAME::menuShowLegend ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1311 of file sim_plot_frame.cpp.

1312{
1314
1315 if( plot )
1316 plot->ShowLegend( !plot->IsLegendShown() );
1317}

References GetCurrentPlot(), and plot.

◆ menuShowLegendUpdate()

void SIM_PLOT_FRAME::menuShowLegendUpdate ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1320 of file sim_plot_frame.cpp.

1321{
1323 event.Check( plot ? plot->IsLegendShown() : false );
1324}

References GetCurrentPlot(), and plot.

◆ menuShowWhiteBackgroundUpdate()

void SIM_PLOT_FRAME::menuShowWhiteBackgroundUpdate ( wxUpdateUIEvent &  event)
inlineoverrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 283 of file sim_plot_frame.h.

284 {
285 event.Check( m_plotUseWhiteBg );
286 }

References m_plotUseWhiteBg.

◆ menuSimulateUpdate()

void SIM_PLOT_FRAME::menuSimulateUpdate ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1366 of file sim_plot_frame.cpp.

1367{
1368 event.Enable( m_circuitModel->CommandToSimType( getCurrentSimCommand() ) != ST_UNKNOWN );
1369}
wxString getCurrentSimCommand() const

References getCurrentSimCommand(), m_circuitModel, 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 1384 of file sim_plot_frame.cpp.

1385{
1386 event.Enable( m_simFinished );
1387}

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

1345{
1347
1348 // Rebuild the color list to plot traces
1350
1351 // Now send changes to all SIM_PLOT_PANEL
1352 for( size_t page = 0; page < m_workbook->GetPageCount(); page++ )
1353 {
1354 wxWindow* curPage = m_workbook->GetPage( page );
1355
1356 // ensure it is truly a plot panel and not the (zero plots) placeholder
1357 // which is only SIM_PLOT_PANEL_BASE
1358 SIM_PLOT_PANEL* panel = dynamic_cast<SIM_PLOT_PANEL*>( curPage );
1359
1360 if( panel )
1361 panel->UpdatePlotColors();
1362 }
1363}
void UpdatePlotColors()
‍Update plot colors

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

1288{
1289 if( GetCurrentPlot() )
1291}
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 1273 of file sim_plot_frame.cpp.

1274{
1275 if( GetCurrentPlot() )
1277}
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 1280 of file sim_plot_frame.cpp.

1281{
1282 if( GetCurrentPlot() )
1284}
void ZoomOut(const wxPoint &centerPoint=wxDefaultPosition)
Zoom out current view and refresh display.
Definition: mathplot.cpp:2127

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

◆ MessageTextFromValue() [1/2]

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

Definition at line 82 of file units_provider.h.

83 {
85 aValue.AsDegrees(), aAddUnitLabel,
87 }
constexpr EDA_IU_SCALE unityScale
Definition: base_units.h:112
double AsDegrees() const
Definition: eda_angle.h:149
wxString MessageTextFromValue(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, double aValue, bool aAddUnitsText=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
A helper to convert the double length aValue to a string in inches, millimeters, or unscaled units.
Definition: eda_units.cpp:323

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

◆ MessageTextFromValue() [2/2]

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

A lower-precision version of StringFromValue().

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

Definition at line 75 of file units_provider.h.

77 {
79 aAddUnitLabel, aType );
80 }
const EDA_IU_SCALE & GetIuScale() const
EDA_UNITS GetUserUnits() const

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::MessageTextFromValue().

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), CheckLibSymbol(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), DIALOG_BOARD_REANNOTATE::CoordTowxString(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBVIEW_FRAME::DisplayGridMsg(), PCB_BASE_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DRAWING_TOOL::DrawBoardCharacteristics(), DRC_ENGINE::EvalRules(), DIALOG_NET_INSPECTOR::formatLength(), LIB_FIELD::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_BITMAP::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), STROKE_PARAMS::GetMsgPanelInfo(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), TEXT_SEARCH_HANDLER::GetResultCell(), LIB_SHAPE::GetSelectMenuText(), SCH_LINE::GetSelectMenuText(), SCH_SHAPE::GetSelectMenuText(), DS_DRAW_ITEM_LINE::GetSelectMenuText(), DS_DRAW_ITEM_RECT::GetSelectMenuText(), PCB_TRACK::GetSelectMenuText(), DIALOG_BOARD_REANNOTATE::MakeSampleText(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_SHAPE::ShapeGetMsgPanelInfo(), showCoord(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), VIA_SIZE_MENU::update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), PCB_CONTROL::UpdateMessagePanel(), PL_EDITOR_FRAME::UpdateMsgPanelInfo(), SCH_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), and DIALOG_BOARD_STATISTICS::updateWidets().

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

499{
500 SIM_PANEL_BASE* plotPanel = nullptr;
501 SIM_TYPE simType = NGSPICE_CIRCUIT_MODEL::CommandToSimType( aSimCommand );
502
503 if( SIM_PANEL_BASE::IsPlottable( simType ) )
504 {
505 SIM_PLOT_PANEL* panel;
506 panel = new SIM_PLOT_PANEL( aSimCommand, m_workbook, this, wxID_ANY );
507
509 Pgm().GetCommonSettings()->m_Input.scroll_modifier_zoom != 0 );
510
511 plotPanel = dynamic_cast<SIM_PANEL_BASE*>( panel );
512 }
513 else
514 {
515 SIM_NOPLOT_PANEL* panel;
516 panel = new SIM_NOPLOT_PANEL( aSimCommand, m_workbook, wxID_ANY );
517 plotPanel = dynamic_cast<SIM_PANEL_BASE*>( panel );
518 }
519
520 wxString pageTitle( m_simulator->TypeToName( simType, true ) );
521 pageTitle.Prepend( wxString::Format( _( "Plot%u - " ), (unsigned int) ++m_plotNumber ) );
522
523 m_workbook->AddPage( dynamic_cast<wxWindow*>( plotPanel ), pageTitle, true );
524
525 return plotPanel;
526}
static SIM_TYPE CommandToSimType(const wxString &aCmd)
Return simulation type basing on a simulation command directive.
bool AddPage(wxWindow *aPage, const wxString &aCaption, bool aSelect=false, const wxBitmap &aBitmap=wxNullBitmap)
void EnableMouseWheelPan(bool enabled)
Enable/disable trackpad friendly panning (2-axis scroll wheel)
Definition: mathplot.h:1220

References _, SIM_WORKBOOK::AddPage(), NGSPICE_CIRCUIT_MODEL::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 567 of file eda_base_frame.h.

568 {
569 m_isNonUserClose = true;
570 return Close( aForce );
571 }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onAddSignal()

void SIM_PLOT_FRAME::onAddSignal ( wxCommandEvent &  event)
private

Definition at line 1522 of file sim_plot_frame.cpp.

1523{
1524 wxCHECK_RET( m_simFinished, "No simulation results available" );
1525
1526 SIM_PLOT_PANEL* plotPanel = GetCurrentPlot();
1527
1528 if( !plotPanel || !m_circuitModel || plotPanel->GetType() != m_circuitModel->GetSimType() )
1529 {
1530 DisplayInfoMessage( this, _( "You need to run plot-providing simulation first." ) );
1531 return;
1532 }
1533
1534 DIALOG_SIGNAL_LIST dialog( this, m_circuitModel.get() );
1535 dialog.ShowModal();
1536}
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:320

References _, DisplayInfoMessage(), GetCurrentPlot(), SIM_PANEL_BASE::GetType(), m_circuitModel, 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 303 of file eda_base_frame.cpp.

304{
305 if( !doAutoSave() )
306 m_autoSaveTimer->Start( GetAutoSaveInterval() * 1000, wxTIMER_ONE_SHOT );
307}
virtual bool doAutoSave()
This should be overridden by the derived class to handle the auto save feature.
int GetAutoSaveInterval() const

References EDA_BASE_FRAME::doAutoSave(), EDA_BASE_FRAME::GetAutoSaveInterval(), 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 SYMBOL_VIEWER_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 316 of file eda_base_frame.cpp.

317{
318 wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( aKeyEvent ) );
319
320 // Key events can be filtered here.
321 // Currently no filtering is made.
322 aKeyEvent.Skip();
323}
const wxChar *const kicadTraceKeyEvent
Flag to enable wxKeyEvent debug tracing.
wxString dump(const wxArrayString &aArray)
Debug helper for printing wxArrayString contents.

References dump(), and kicadTraceKeyEvent.

◆ onCursorUpdate()

void SIM_PLOT_FRAME::onCursorUpdate ( wxCommandEvent &  aEvent)
private

Definition at line 1684 of file sim_plot_frame.cpp.

1685{
1686 wxSize size = m_cursors->GetClientSize();
1687 SIM_PLOT_PANEL* plotPanel = GetCurrentPlot();
1688 m_cursors->ClearAll();
1689
1690 if( !plotPanel )
1691 return;
1692
1694 m_cursors->SetImageList(m_signalsIconColorList, wxIMAGE_LIST_SMALL);
1695
1696 // Fill the signals listctrl
1697 m_cursors->AppendColumn( _( "Signal" ), wxLIST_FORMAT_LEFT, size.x / 2 );
1698 const long X_COL = m_cursors->AppendColumn( plotPanel->GetLabelX(), wxLIST_FORMAT_LEFT,
1699 size.x / 4 );
1700
1701 wxString labelY1 = plotPanel->GetLabelY1();
1702 wxString labelY2 = plotPanel->GetLabelY2();
1703 wxString labelY;
1704
1705 if( !labelY2.IsEmpty() )
1706 labelY = labelY1 + " / " + labelY2;
1707 else
1708 labelY = labelY1;
1709
1710 const long Y_COL = m_cursors->AppendColumn( labelY, wxLIST_FORMAT_LEFT, size.x / 4 );
1711
1712 // Update cursor values
1713 int itemidx = 0;
1714
1715 for( const auto& trace : plotPanel->GetTraces() )
1716 {
1717 if( CURSOR* cursor = trace.second->GetCursor() )
1718 {
1719 // Find the right icon color in list.
1720 // It is the icon used in m_signals list for the same trace
1721 long iconColor = m_signals->FindItem( -1, trace.first );
1722
1723 const wxRealPoint coords = cursor->GetCoords();
1724 long idx = m_cursors->InsertItem( itemidx++, trace.first, iconColor );
1725 m_cursors->SetItem( idx, X_COL, SPICE_VALUE( coords.x ).ToSpiceString() );
1726 m_cursors->SetItem( idx, Y_COL, SPICE_VALUE( coords.y ).ToSpiceString() );
1727 }
1728 }
1729}
Cursor attached to a trace to follow its values:
wxString GetLabelY2() const
wxString GetLabelY1() const
wxString GetLabelX() const
wxString ToSpiceString() const
Return string value in Spice format (e.g.

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

◆ OnDropFiles()

void EDA_BASE_FRAME::OnDropFiles ( wxDropFilesEvent &  aEvent)
protectedvirtualinherited

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

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

Definition at line 1118 of file eda_base_frame.cpp.

1119{
1120 wxString* files = aEvent.GetFiles();
1121 for( int nb = 0; nb < aEvent.GetNumberOfFiles(); nb++ )
1122 {
1123 const wxFileName fn = wxFileName( files[nb] );
1124 for( const auto& [ext, tool] : m_acceptedExts )
1125 {
1126 if( IsExtensionAccepted( fn.GetExt(), { ext.ToStdString() } ) )
1127 {
1128 m_AcceptedFiles.emplace( m_AcceptedFiles.end(), fn );
1129 break;
1130 }
1131 }
1132 }
1134 m_AcceptedFiles.clear();
1135}
virtual void DoWithAcceptedFiles()
Execute action on accepted dropped file.
bool IsExtensionAccepted(const wxString &aExt, const std::vector< std::string > acceptedExts)
Checks if the file extension is in accepted extensions.

References EDA_BASE_FRAME::DoWithAcceptedFiles(), IsExtensionAccepted(), EDA_BASE_FRAME::m_acceptedExts, and EDA_BASE_FRAME::m_AcceptedFiles.

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent &  aEvent)
protectedinherited

Definition at line 1387 of file eda_base_frame.cpp.

1388{
1389 // Call the handler
1390 handleIconizeEvent( aEvent );
1391
1392 // Skip the event.
1393 aEvent.Skip();
1394}
virtual void handleIconizeEvent(wxIconizeEvent &aEvent)
Handle a window iconize event.

References EDA_BASE_FRAME::handleIconizeEvent().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 966 of file eda_base_frame.cpp.

967{
968 void ShowAboutDialog( EDA_BASE_FRAME * aParent ); // See AboutDialog_main.cpp
969 ShowAboutDialog( this );
970}
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 1313 of file eda_base_frame.cpp.

1314{
1315 // When we maximize the window, we want to save the old information
1316 // so that we can add it to the settings on next window load.
1317 // Contrary to the documentation, this event seems to be generated
1318 // when the window is also being unmaximized on OSX, so we only
1319 // capture the size information when we maximize the window when on OSX.
1320#ifdef __WXOSX__
1321 if( !IsMaximized() )
1322#endif
1323 {
1325 m_normalFramePos = GetPosition();
1326 wxLogTrace( traceDisplayLocation,
1327 "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
1330 }
1331
1332 // Skip event to actually maximize the window
1333 aEvent.Skip();
1334}

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

327{
328 if( !m_toolDispatcher )
329 aEvent.Skip();
330 else
332}
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:172
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.

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

187 {
188 aEvent.Skip();
189 }

◆ onPlotChanged()

void SIM_PLOT_FRAME::onPlotChanged ( wxAuiNotebookEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1411 of file sim_plot_frame.cpp.

1412{
1414 wxCommandEvent dummy;
1416}
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:74

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

◆ onPlotClose()

void SIM_PLOT_FRAME::onPlotClose ( wxAuiNotebookEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1390 of file sim_plot_frame.cpp.

1391{
1392}

◆ onPlotClosed()

void SIM_PLOT_FRAME::onPlotClosed ( wxAuiNotebookEvent &  event)
overrideprivatevirtual

Reimplemented from SIM_PLOT_FRAME_BASE.

Definition at line 1395 of file sim_plot_frame.cpp.

1396{
1397 if( m_workbook->GetPageCount() == 0 )
1398 {
1399 m_signals->ClearAll();
1400 m_cursors->ClearAll();
1401 }
1402 else
1403 {
1405 wxCommandEvent dummy;
1407 }
1408}

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

1420{
1421}

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

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

Definition at line 973 of file eda_base_frame.cpp.

974{
975 PAGED_DIALOG dlg( this, _( "Preferences" ), true );
976 wxTreebook* book = dlg.GetTreebook();
977
978 PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
979 KIFACE* kiface = nullptr;
980 std::vector<int> expand;
981
982 Kiway().GetActions( hotkeysPanel->ActionsList() );
983
984 book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
985 book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
986 book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
987
988#ifdef KICAD_USE_SENTRY
989 book->AddPage( new PANEL_DATA_COLLECTION( &dlg, book ), _( "Data Collection" ) );
990#endif
991
992#define CREATE_PANEL( key ) kiface->CreateWindow( book, key, &Kiway() )
993
994 // If a dll is not loaded, the loader will show an error message.
995
996 try
997 {
999
1000 kiface->GetActions( hotkeysPanel->ActionsList() );
1001
1003 expand.push_back( book->GetPageCount() );
1004
1005 book->AddPage( new wxPanel( book ), _( "Symbol Editor" ) );
1006 book->AddSubPage( CREATE_PANEL( PANEL_SYM_DISP_OPTIONS ), _( "Display Options" ) );
1007 book->AddSubPage( CREATE_PANEL( PANEL_SYM_EDIT_OPTIONS ), _( "Editing Options" ) );
1008 book->AddSubPage( CREATE_PANEL( PANEL_SYM_COLORS ), _( "Colors" ) );
1009
1010 if( GetFrameType() == FRAME_SCH )
1011 expand.push_back( book->GetPageCount() );
1012
1013 book->AddPage( new wxPanel( book ), _( "Schematic Editor" ) );
1014 book->AddSubPage( CREATE_PANEL( PANEL_SCH_DISP_OPTIONS ), _( "Display Options" ) );
1015 book->AddSubPage( CREATE_PANEL( PANEL_SCH_EDIT_OPTIONS ), _( "Editing Options" ) );
1016 book->AddSubPage( CREATE_PANEL( PANEL_SCH_ANNO_OPTIONS ), _( "Annotation Options" ) );
1017 book->AddSubPage( CREATE_PANEL( PANEL_SCH_COLORS ), _( "Colors" ) );
1018 book->AddSubPage( CREATE_PANEL( PANEL_SCH_FIELD_NAME_TEMPLATES ), _( "Field Name Templates" ) );
1019 }
1020 catch( ... )
1021 {
1022 }
1023
1024 try
1025 {
1027
1028 kiface->GetActions( hotkeysPanel->ActionsList() );
1029
1031 expand.push_back( book->GetPageCount() );
1032
1033 book->AddPage( new wxPanel( book ), _( "Footprint Editor" ) );
1034 book->AddSubPage( CREATE_PANEL( PANEL_FP_DISPLAY_OPTIONS ), _( "Display Options" ) );
1035 book->AddSubPage( CREATE_PANEL( PANEL_FP_EDIT_OPTIONS ), _( "Editing Options" ) );
1036 book->AddSubPage( CREATE_PANEL( PANEL_FP_COLORS ), _( "Colors" ) );
1037 book->AddSubPage( CREATE_PANEL( PANEL_FP_DEFAULT_VALUES ), _( "Default Values" ) );
1038
1040 expand.push_back( book->GetPageCount() );
1041
1042 book->AddPage( new wxPanel( book ), _( "PCB Editor" ) );
1043 book->AddSubPage( CREATE_PANEL( PANEL_PCB_DISPLAY_OPTIONS ), _( "Display Options" ) );
1044 book->AddSubPage( CREATE_PANEL( PANEL_PCB_EDIT_OPTIONS ), _( "Editing Options" ) );
1045 book->AddSubPage( CREATE_PANEL( PANEL_PCB_COLORS ), _( "Colors" ) );
1046 book->AddSubPage( CREATE_PANEL( PANEL_PCB_ACTION_PLUGINS ), _( "Action Plugins" ) );
1047 book->AddSubPage( CREATE_PANEL( PANEL_PCB_ORIGINS_AXES ), _( "Origins & Axes" ) );
1048
1050 expand.push_back( book->GetPageCount() );
1051
1052 book->AddPage( new wxPanel( book ), _( "3D Viewer" ) );
1053 book->AddSubPage( CREATE_PANEL( PANEL_3DV_DISPLAY_OPTIONS ), _( "General" ) );
1054 book->AddSubPage( CREATE_PANEL( PANEL_3DV_OPENGL ), _( "Realtime Renderer" ) );
1055 book->AddSubPage( CREATE_PANEL( PANEL_3DV_RAYTRACING ), _( "Raytracing Renderer" ) );
1056 book->AddSubPage( CREATE_PANEL( PANEL_3DV_COLORS ), _( "Colors" ) );
1057 }
1058 catch( ... )
1059 {
1060 }
1061
1062 try
1063 {
1065
1066 kiface->GetActions( hotkeysPanel->ActionsList() );
1067
1068 if( GetFrameType() == FRAME_GERBER )
1069 expand.push_back( book->GetPageCount() );
1070
1071 book->AddPage( new wxPanel( book ), _( "Gerber Viewer" ) );
1072 book->AddSubPage( CREATE_PANEL( PANEL_GBR_DISPLAY_OPTIONS ), _( "Display Options" ) );
1073 book->AddSubPage( CREATE_PANEL( PANEL_GBR_COLORS ), _( "Colors" ) );
1074 book->AddSubPage( CREATE_PANEL( PANEL_GBR_EXCELLON_OPTIONS ), _( "Excellon Options" ) );
1075 }
1076 catch( ... )
1077 {
1078 }
1079
1080 try
1081 {
1083 kiface->GetActions( hotkeysPanel->ActionsList() );
1084
1085 if( GetFrameType() == FRAME_PL_EDITOR )
1086 expand.push_back( book->GetPageCount() );
1087
1088 book->AddPage( new wxPanel( book ), _( "Drawing Sheet Editor" ) );
1089 book->AddSubPage( CREATE_PANEL( PANEL_DS_DISPLAY_OPTIONS ), _( "Display Options" ) );
1090 book->AddSubPage( CREATE_PANEL( PANEL_DS_COLORS ), _( "Colors" ) );
1091
1092 book->AddPage( new PANEL_PCM_SETTINGS( book ), _( "Plugin and Content Manager" ) );
1093 }
1094 catch( ... )
1095 {
1096 }
1097
1098 // Update all of the action hotkeys. The process of loading the actions through
1099 // the KiFACE will only get us the default hotkeys
1100 ReadHotKeyConfigIntoActions( wxEmptyString, hotkeysPanel->ActionsList() );
1101
1102 for( size_t i = 0; i < book->GetPageCount(); ++i )
1103 book->GetPage( i )->Layout();
1104
1105 for( int page : expand )
1106 book->ExpandNode( page );
1107
1108 if( dlg.ShowModal() == wxID_OK )
1109 {
1110 Pgm().GetSettingsManager().Save();
1111 dlg.Kiway().CommonSettingsChanged( false, false );
1112 }
1113
1114#undef CREATE_PANEL
1115}
FRAME_T GetFrameType() const
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
Definition: kiway.cpp:572
virtual KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Return the KIFACE* given a FACE_T.
Definition: kiway.cpp:198
@ FACE_SCH
eeschema DSO
Definition: kiway.h:274
@ FACE_PL_EDITOR
Definition: kiway.h:278
@ FACE_PCB
pcbnew DSO
Definition: kiway.h:275
@ FACE_GERBVIEW
Definition: kiway.h:277
virtual void GetActions(std::vector< TOOL_ACTION * > &aActions) const
Append all registered actions to the given list.
Definition: kiway.cpp:497
std::vector< TOOL_ACTION * > & ActionsList()
return & kiface
Definition: cvpcb.cpp:112
#define CREATE_PANEL(key)
@ FRAME_PCB_EDITOR
Definition: frame_type.h:40
@ FRAME_SCH_SYMBOL_EDITOR
Definition: frame_type.h:35
@ PANEL_SCH_FIELD_NAME_TEMPLATES
Definition: frame_type.h:76
@ PANEL_GBR_DISPLAY_OPTIONS
Definition: frame_type.h:94
@ PANEL_3DV_COLORS
Definition: frame_type.h:92
@ PANEL_3DV_OPENGL
Definition: frame_type.h:90
@ PANEL_PCB_ORIGINS_AXES
Definition: frame_type.h:87
@ PANEL_PCB_EDIT_OPTIONS
Definition: frame_type.h:84
@ PANEL_SCH_DISP_OPTIONS
Definition: frame_type.h:72
@ PANEL_FP_DISPLAY_OPTIONS
Definition: frame_type.h:78
@ PANEL_DS_COLORS
Definition: frame_type.h:100
@ PANEL_PCB_COLORS
Definition: frame_type.h:85
@ PANEL_3DV_RAYTRACING
Definition: frame_type.h:91
@ PANEL_SYM_EDIT_OPTIONS
Definition: frame_type.h:69
@ PANEL_SCH_EDIT_OPTIONS
Definition: frame_type.h:73
@ PANEL_SYM_DISP_OPTIONS
Definition: frame_type.h:68
@ PANEL_FP_COLORS
Definition: frame_type.h:80
@ PANEL_SYM_COLORS
Definition: frame_type.h:70
@ FRAME_PL_EDITOR
Definition: frame_type.h:55
@ FRAME_FOOTPRINT_EDITOR
Definition: frame_type.h:41
@ FRAME_GERBER
Definition: frame_type.h:53
@ FRAME_PCB_DISPLAY3D
Definition: frame_type.h:45
@ PANEL_FP_EDIT_OPTIONS
Definition: frame_type.h:79
@ PANEL_SCH_ANNO_OPTIONS
Definition: frame_type.h:74
@ PANEL_PCB_ACTION_PLUGINS
Definition: frame_type.h:86
@ PANEL_FP_DEFAULT_VALUES
Definition: frame_type.h:81
@ PANEL_3DV_DISPLAY_OPTIONS
Definition: frame_type.h:89
@ PANEL_DS_DISPLAY_OPTIONS
Definition: frame_type.h:99
@ PANEL_PCB_DISPLAY_OPTIONS
Definition: frame_type.h:83
@ PANEL_SCH_COLORS
Definition: frame_type.h:75
@ PANEL_GBR_COLORS
Definition: frame_type.h:97
@ PANEL_GBR_EXCELLON_OPTIONS
Definition: frame_type.h:96
void ReadHotKeyConfigIntoActions(const wxString &aFileName, std::vector< TOOL_ACTION * > &aActions)
Reads a hotkey config file into a list of actions.
Implement a participant in the KIWAY alchemy.
Definition: kiway.h:150

References _, PANEL_HOTKEYS_EDITOR::ActionsList(), KIWAY::CommonSettingsChanged(), CREATE_PANEL, KIWAY::FACE_GERBVIEW, KIWAY::FACE_PCB, KIWAY::FACE_PL_EDITOR, KIWAY::FACE_SCH, FRAME_FOOTPRINT_EDITOR, FRAME_GERBER, FRAME_PCB_DISPLAY3D, FRAME_PCB_EDITOR, FRAME_PL_EDITOR, FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, KIWAY::GetActions(), EDA_BASE_FRAME::GetFrameType(), PAGED_DIALOG::GetTreebook(), kiface, KIWAY::KiFACE(), KIWAY_HOLDER::Kiway(), PANEL_3DV_COLORS, PANEL_3DV_DISPLAY_OPTIONS, PANEL_3DV_OPENGL, PANEL_3DV_RAYTRACING, PANEL_DS_COLORS, PANEL_DS_DISPLAY_OPTIONS, PANEL_FP_COLORS, PANEL_FP_DEFAULT_VALUES, PANEL_FP_DISPLAY_OPTIONS, PANEL_FP_EDIT_OPTIONS, PANEL_GBR_COLORS, PANEL_GBR_DISPLAY_OPTIONS, PANEL_GBR_EXCELLON_OPTIONS, PANEL_PCB_ACTION_PLUGINS, PANEL_PCB_COLORS, PANEL_PCB_DISPLAY_OPTIONS, PANEL_PCB_EDIT_OPTIONS, PANEL_PCB_ORIGINS_AXES, PANEL_SCH_ANNO_OPTIONS, PANEL_SCH_COLORS, PANEL_SCH_DISP_OPTIONS, PANEL_SCH_EDIT_OPTIONS, PANEL_SCH_FIELD_NAME_TEMPLATES, PANEL_SYM_COLORS, PANEL_SYM_DISP_OPTIONS, PANEL_SYM_EDIT_OPTIONS, Pgm(), and ReadHotKeyConfigIntoActions().

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

◆ onProbe()

void SIM_PLOT_FRAME::onProbe ( wxCommandEvent &  event)
private

Definition at line 1539 of file sim_plot_frame.cpp.

1540{
1541 wxCHECK_RET( m_simFinished, "No simulation results available" );
1542
1543 if( m_schematicFrame == nullptr )
1544 return;
1545
1546 wxWindow* blocking_dialog = m_schematicFrame->Kiway().GetBlockingDialog();
1547
1548 if( blocking_dialog )
1549 blocking_dialog->Close( true );
1550
1552 m_schematicFrame->Raise();
1553}
static TOOL_ACTION simProbe
Definition: ee_actions.h:248
wxWindow * GetBlockingDialog()
Gets the window pointer to the blocking dialog (to send it signals)
Definition: kiway.cpp:617

References KIWAY::GetBlockingDialog(), TOOLS_HOLDER::GetToolManager(), KIWAY_HOLDER::Kiway(), 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 1473 of file sim_plot_frame.cpp.

1474{
1475 SIM_PANEL_BASE* plotPanelWindow = getCurrentPlotWindow();
1476
1477 if( !m_settingsDlg )
1478 m_settingsDlg = new DIALOG_SIM_SETTINGS( this, m_circuitModel, m_simulator->Settings() );
1479
1480 if( !m_circuitModel->ReadSchematicAndLibraries( NETLIST_EXPORTER_SPICE::OPTION_DEFAULT_FLAGS ) )
1481 {
1482 DisplayErrorMessage( this, _( "There were errors during netlist export, aborted." ) );
1483 return;
1484 }
1485
1486 if( m_workbook->GetPageIndex( plotPanelWindow ) != wxNOT_FOUND )
1487 m_settingsDlg->SetSimCommand( m_workbook->GetSimCommand( plotPanelWindow ) );
1488
1489 if( m_settingsDlg->ShowModal() == wxID_OK )
1490 {
1491 wxString oldCommand;
1492
1493 if( m_workbook->GetPageIndex( plotPanelWindow ) != wxNOT_FOUND )
1494 oldCommand = m_workbook->GetSimCommand( plotPanelWindow );
1495 else
1496 oldCommand = wxString();
1497
1498 wxString newCommand = m_settingsDlg->GetSimCommand();
1499 SIM_TYPE newSimType = NGSPICE_CIRCUIT_MODEL::CommandToSimType( newCommand );
1500
1501 // If it is a new simulation type, open a new plot
1502 // For the DC sim, check if sweep source type has changed (char 4 will contain 'v',
1503 // 'i', 'r' or 't'.
1504 if( !plotPanelWindow
1505 || ( plotPanelWindow && plotPanelWindow->GetType() != newSimType )
1506 || ( newSimType == ST_DC
1507 && oldCommand.Lower().GetChar( 4 ) != newCommand.Lower().GetChar( 4 ) ) )
1508 {
1509 plotPanelWindow = NewPlotPanel( newCommand );
1510 }
1511 else
1512 {
1513 // Update simulation command in the current plot
1514 m_workbook->SetSimCommand( plotPanelWindow, newCommand );
1515 }
1516
1517 m_simulator->Init();
1518 }
1519}
const wxString & GetSimCommand() const
bool SetSimCommand(const wxString &aCommand)
void SetSimCommand(SIM_PANEL_BASE *aPlotPanel, const wxString &aSimCommand)
Definition: sim_workbook.h:55

References _, NGSPICE_CIRCUIT_MODEL::CommandToSimType(), DisplayErrorMessage(), getCurrentPlotWindow(), DIALOG_SIM_SETTINGS::GetSimCommand(), SIM_WORKBOOK::GetSimCommand(), SIM_PANEL_BASE::GetType(), m_circuitModel, m_settingsDlg, m_simulator, SIM_PLOT_FRAME_BASE::m_workbook, NewPlotPanel(), NETLIST_EXPORTER_SPICE::OPTION_DEFAULT_FLAGS, DIALOG_SIM_SETTINGS::SetSimCommand(), SIM_WORKBOOK::SetSimCommand(), DIALOG_SIM_SETTINGS::ShowModal(), and ST_DC.

Referenced by SIM_PLOT_FRAME().

◆ onShowNetlist()

void SIM_PLOT_FRAME::onShowNetlist ( wxCommandEvent &  event)
private

Definition at line 1573 of file sim_plot_frame.cpp.

1574{
1575 class NETLIST_VIEW_DIALOG : public DIALOG_SHIM
1576 {
1577 public:
1578 enum
1579 {
1580 MARGIN_LINE_NUMBERS
1581 };
1582
1583 void onClose( wxCloseEvent& evt )
1584 {
1585 wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL ) );
1586 }
1587
1588 NETLIST_VIEW_DIALOG( wxWindow* parent, wxString source) :
1589 DIALOG_SHIM( parent, wxID_ANY, "SPICE Netlist",
1590 wxDefaultPosition, wxDefaultSize,
1591 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER )
1592 {
1593 wxStyledTextCtrl* text = new wxStyledTextCtrl( this, wxID_ANY );
1594 text->SetMinSize( wxSize( 600, 400 ) );
1595
1596 text->SetMarginWidth( MARGIN_LINE_NUMBERS, 50 );
1597 text->StyleSetForeground( wxSTC_STYLE_LINENUMBER, wxColour( 75, 75, 75 ) );
1598 text->StyleSetBackground( wxSTC_STYLE_LINENUMBER, wxColour( 220, 220, 220 ) );
1599 text->SetMarginType( MARGIN_LINE_NUMBERS, wxSTC_MARGIN_NUMBER );
1600
1601 wxFont fixedFont = KIUI::GetMonospacedUIFont();
1602
1603 for( size_t i = 0; i < wxSTC_STYLE_MAX; ++i )
1604 text->StyleSetFont( i, fixedFont );
1605
1606 text->StyleClearAll(); // Addresses a bug in wx3.0 where styles are not correctly set
1607
1608 text->SetWrapMode( wxSTC_WRAP_WORD );
1609
1610 text->SetText( source );
1611
1612 text->SetLexer( wxSTC_LEX_SPICE );
1613
1614 wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
1615 sizer->Add( text, 1, wxEXPAND | wxALL, 5 );
1616 SetSizer( sizer );
1617
1618 Connect( wxEVT_CLOSE_WINDOW, wxCloseEventHandler( NETLIST_VIEW_DIALOG::onClose ),
1619 nullptr, this );
1620
1621 m_scintillaTricks = std::make_unique<SCINTILLA_TRICKS>( text, wxT( "{}" ), false );
1622
1623 finishDialogSettings();
1624 }
1625
1626 std::unique_ptr<SCINTILLA_TRICKS> m_scintillaTricks;
1627 };
1628
1629 if( m_schematicFrame == nullptr || m_simulator == nullptr )
1630 return;
1631
1632 STRING_FORMATTER formatter;
1633 m_circuitModel->GetNetlist( &formatter );
1634
1635 NETLIST_VIEW_DIALOG dlg( this, formatter.GetString() );
1636 dlg.ShowModal();
1637}
Implement an OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:415
const std::string & GetString()
Definition: richio.h:438
wxFont GetMonospacedUIFont()
Definition: ui_common.cpp:85

References KIUI::GetMonospacedUIFont(), STRING_FORMATTER::GetString(), m_circuitModel, 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 1424 of file sim_plot_frame.cpp.

1425{
1426 // Remove signal from the plot panel when double clicked
1427 long idx = m_signals->GetFocusedItem();
1428
1429 if( idx != wxNOT_FOUND )
1430 removePlot( m_signals->GetItemText( idx, 0 ) );
1431}
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 1434 of file sim_plot_frame.cpp.

1435{
1436 int idx = event.GetIndex();
1437
1438 if( idx != wxNOT_FOUND )
1439 m_signals->Select( idx );
1440
1441 idx = m_signals->GetFirstSelected();
1442
1443 if( idx != wxNOT_FOUND )
1444 {
1445 const wxString& netName = m_signals->GetItemText( idx, 0 );
1446 SIGNAL_CONTEXT_MENU ctxMenu( netName, this );
1447 m_signals->PopupMenu( &ctxMenu );
1448 }
1449}

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

Definition at line 1739 of file sim_plot_frame.cpp.

1740{
1741 m_toolBar->SetToolNormalBitmap( ID_SIM_RUN, KiBitmap( BITMAPS::sim_run ) );
1742 SetCursor( wxCURSOR_ARROW );
1743
1744 SIM_TYPE simType = m_circuitModel->GetSimType();
1745
1746 if( simType == ST_UNKNOWN )
1747 return;
1748
1749 SIM_PANEL_BASE* plotPanelWindow = getCurrentPlotWindow();
1750
1751 if( !plotPanelWindow || plotPanelWindow->GetType() != simType )
1752 plotPanelWindow = NewPlotPanel( m_circuitModel->GetSimCommand() );
1753
1754 // Sometimes (for instance with a directive like wrdata my_file.csv "my_signal")
1755 // the simulator is in idle state (simulation is finished), but still running, during
1756 // the time the file is written. So gives a slice of time to fully finish the work:
1757 if( m_simulator->IsRunning() )
1758 {
1759 int max_time = 40; // For a max timeout = 2s
1760
1761 do
1762 {
1763 wxMilliSleep( 50 );
1764 wxYield();
1765
1766 if( max_time )
1767 max_time--;
1768
1769 } while( max_time && m_simulator->IsRunning() );
1770 }
1771 // Is a warning message useful if the simulatior is still running?
1772
1773 // If there are any signals plotted, update them
1774 if( SIM_PANEL_BASE::IsPlottable( simType ) )
1775 {
1776 SIM_PLOT_PANEL* plotPanel = dynamic_cast<SIM_PLOT_PANEL*>( plotPanelWindow );
1777 wxCHECK_RET( plotPanel, "not a SIM_PLOT_PANEL" );
1778
1779 struct TRACE_DESC
1780 {
1781 wxString m_name;
1783 };
1784
1785 std::vector<struct TRACE_DESC> traceInfo;
1786
1787 // Get information about all the traces on the plot, remove and add again
1788 for( auto& trace : plotPanel->GetTraces() )
1789 {
1790 struct TRACE_DESC placeholder;
1791 placeholder.m_name = trace.second->GetName();
1792 placeholder.m_type = trace.second->GetType();
1793
1794 traceInfo.push_back( placeholder );
1795 }
1796
1797 for( auto& trace : traceInfo )
1798 {
1799 if( !updatePlot( trace.m_name, trace.m_type, plotPanel ) )
1800 removePlot( trace.m_name );
1801 }
1802
1804 plotPanel->GetPlotWin()->UpdateAll();
1805 plotPanel->ResetScales();
1806 }
1807 else if( simType == ST_OP )
1808 {
1809 m_simConsole->AppendText( _( "\n\nSimulation results:\n\n" ) );
1810 m_simConsole->SetInsertionPointEnd();
1811
1812 for( const auto& vec : m_simulator->AllPlots() )
1813 {
1814 std::vector<double> val_list = m_simulator->GetRealPlot( vec, 1 );
1815
1816 if( val_list.size() == 0 ) // The list of values can be empty!
1817 continue;
1818
1819 double val = val_list.at( 0 );
1820 wxString outLine, signal;
1821 SIM_PLOT_TYPE type = m_circuitModel->VectorToSignal( vec, signal );
1822
1823 const size_t tab = 25; //characters
1824 size_t padding = ( signal.length() < tab ) ? ( tab - signal.length() ) : 1;
1825
1826 outLine.Printf( wxT( "%s%s" ),
1827 ( signal + wxT( ":" ) ).Pad( padding, wxUniChar( ' ' ) ),
1828 SPICE_VALUE( val ).ToSpiceString() );
1829
1830 outLine.Append( type == SPT_CURRENT ? "A\n" : "V\n" );
1831
1832 m_simConsole->AppendText( outLine );
1833 m_simConsole->SetInsertionPointEnd();
1834
1835 // @todo display calculated values on the schematic
1836 }
1837 }
1838
1839 m_lastSimPlot = plotPanelWindow;
1840 m_simFinished = true;
1841}
void ResetScales()
Update trace line style.
void UpdateAll()
Refresh display.
Definition: mathplot.cpp:2403
@ ST_OP
Definition: sim_types.h:38

References _, getCurrentPlotWindow(), SIM_PLOT_PANEL::GetPlotWin(), SIM_PLOT_PANEL::GetTraces(), SIM_PANEL_BASE::GetType(), ID_SIM_RUN, SIM_PANEL_BASE::IsPlottable(), KiBitmap(), m_circuitModel, m_lastSimPlot, 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, SPICE_VALUE::ToSpiceString(), mpWindow::UpdateAll(), updatePlot(), and updateSignalList().

Referenced by SIM_PLOT_FRAME().

◆ onSimReport()

void SIM_PLOT_FRAME::onSimReport ( wxCommandEvent &  aEvent)
private

Definition at line 1884 of file sim_plot_frame.cpp.

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

References SIM_PLOT_FRAME_BASE::m_simConsole.

Referenced by SIM_PLOT_FRAME().

◆ onSimStarted()

void SIM_PLOT_FRAME::onSimStarted ( wxCommandEvent &  aEvent)
private

Definition at line 1732 of file sim_plot_frame.cpp.

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

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

1465{
1466 if( m_simulator->IsRunning() )
1467 m_simulator->Stop();
1468 else
1470}

References m_simulator, and StartSimulation().

Referenced by SIM_PLOT_FRAME().

◆ onSimUpdate()

void SIM_PLOT_FRAME::onSimUpdate ( wxCommandEvent &  aEvent)
private

Definition at line 1844 of file sim_plot_frame.cpp.

1845{
1846 static bool updateInProgress = false;
1847
1848 // skip update when events are triggered too often and previous call didn't end yet
1849 if( updateInProgress )
1850 return;
1851
1852 updateInProgress = true;
1853
1854 if( m_simulator->IsRunning() )
1855 m_simulator->Stop();
1856
1858 {
1859 // We need to rerun simulation, as the simulator currently stores
1860 // results for another plot
1862 }
1863 else
1864 {
1865 std::unique_lock<std::mutex> simulatorLock( m_simulator->GetMutex(), std::try_to_lock );
1866
1867 if( simulatorLock.owns_lock() )
1868 {
1869 // Incremental update
1870 m_simConsole->Clear();
1871
1872 // Do not export netlist, it is already stored in the simulator
1873 applyTuners();
1874
1875 m_simulator->Run();
1876 }
1877 else
1878 DisplayErrorMessage( this, _( "Another simulation is already running." ) );
1879 }
1880 updateInProgress = false;
1881}
void applyTuners()
Apply component values specified using tuner sliders to the current netlist.

References _, applyTuners(), DisplayErrorMessage(), getCurrentPlotWindow(), m_lastSimPlot, SIM_PLOT_FRAME_BASE::m_simConsole, m_simulator, and StartSimulation().

Referenced by SIM_PLOT_FRAME().

◆ OnSize()

void EDA_BASE_FRAME::OnSize ( wxSizeEvent &  aEvent)
virtualinherited

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

Definition at line 514 of file eda_base_frame.cpp.

515{
516#ifdef __WXMAC__
517 int currentDisplay = wxDisplay::GetFromWindow( this );
518
519 if( m_displayIndex >= 0 && currentDisplay >= 0 && currentDisplay != m_displayIndex )
520 {
521 wxLogTrace( traceDisplayLocation, "OnSize: current display changed %d to %d",
522 m_displayIndex, currentDisplay );
523 m_displayIndex = currentDisplay;
525 }
526#endif
527
528 aEvent.Skip();
529}
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 69 of file eda_dde.cpp.

70{
71 size_t len;
72 wxSocketBase* sock = evt.GetSocket();
73
74 switch( evt.GetSocketEvent() )
75 {
76 case wxSOCKET_INPUT:
77 sock->Read( client_ipc_buffer, 1 );
78
79 if( sock->LastCount() == 0 )
80 break; // No data, occurs on opening connection
81
82 sock->Read( client_ipc_buffer + 1, IPC_BUF_SIZE - 2 );
83 len = 1 + sock->LastCount();
84 client_ipc_buffer[len] = 0;
86 break;
87
88 case wxSOCKET_LOST:
89 return;
90 break;
91
92 default:
93 wxPrintf( wxT( "EDA_DRAW_FRAME::OnSockRequest() error: Invalid event !" ) );
94 break;
95 }
96}
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
#define IPC_BUF_SIZE
Definition: eda_dde.cpp:39
static char client_ipc_buffer[IPC_BUF_SIZE]
Definition: eda_dde.cpp:40

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

◆ OnSockRequestServer()

void KIWAY_PLAYER::OnSockRequestServer ( wxSocketEvent &  evt)
inherited

Definition at line 99 of file eda_dde.cpp.

100{
101 wxSocketBase* socket;
102 wxSocketServer* server = (wxSocketServer*) evt.GetSocket();
103
104 socket = server->Accept();
105
106 if( socket == nullptr )
107 return;
108
109 m_sockets.push_back( socket );
110
111 socket->Notify( true );
112 socket->SetEventHandler( *this, ID_EDA_SOCKET_EVENT );
113 socket->SetNotify( wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG );
114}
std::vector< wxSocketBase * > m_sockets
interprocess communication
Definition: kiway_player.h:219
@ ID_EDA_SOCKET_EVENT
Definition: id.h:164

References ID_EDA_SOCKET_EVENT, and KIWAY_PLAYER::m_sockets.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent &  aEvent)
protectedinherited

Definition at line 1377 of file eda_base_frame.cpp.

1378{
1379 // Call the handler to update the colors used in the frame
1381
1382 // Skip the change event to ensure the rest of the window controls get it
1383 aEvent.Skip();
1384}
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 1556 of file sim_plot_frame.cpp.

1557{
1558 wxCHECK_RET( m_simFinished, "No simulation results available" );
1559
1560 if( m_schematicFrame == nullptr )
1561 return;
1562
1563 wxWindow* blocking_dialog = m_schematicFrame->Kiway().GetBlockingDialog();
1564
1565 if( blocking_dialog )
1566 blocking_dialog->Close( true );
1567
1569 m_schematicFrame->Raise();
1570}
static TOOL_ACTION simTune
Definition: ee_actions.h:249

References KIWAY::GetBlockingDialog(), TOOLS_HOLDER::GetToolManager(), KIWAY_HOLDER::Kiway(), 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 1458 of file sim_plot_frame.cpp.

1459{
1460 updateTitle();
1461}

References updateTitle().

Referenced by SIM_PLOT_FRAME().

◆ onWorkbookModified()

void SIM_PLOT_FRAME::onWorkbookModified ( wxCommandEvent &  event)
private

Definition at line 1452 of file sim_plot_frame.cpp.

1453{
1454 updateTitle();
1455}

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 BM2CMP_FRAME, GERBVIEW_FRAME, PL_EDITOR_FRAME, CVPCB_MAINFRAME, SCH_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_EDIT_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_TEST_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 1297 of file eda_base_frame.cpp.

1298{
1299 return m_redoList.PopCommand();
1300}
PICKED_ITEMS_LIST * PopCommand()

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

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

◆ PopCommandFromUndoList()

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const TOOL_EVENT aEvent)
virtualinherited

Pops a tool from the stack.

Parameters
aEventThe event that started the tool that was pushed to the stack.

Definition at line 65 of file tools_holder.cpp.

66{
67 const std::string& actionName = aEvent.getCommandStr();
68
69 wxASSERT_MSG( !aEvent.getCommandStr().empty(), "Popped Empty Tool Name!" );
70
71 // Push/pop events can get out of order (such as when they're generated by the Simulator
72 // frame but not processed until the mouse is back in the Schematic frame), so make sure
73 // we're popping the right stack frame.
74
75 for( int i = (int) m_toolStack.size() - 1; i >= 0; --i )
76 {
77 if( m_toolStack[ i ] == actionName )
78 {
79 m_toolStack.erase( m_toolStack.begin() + i );
80
81 // If there's something underneath us, and it's now the top of the stack, then
82 // re-activate it
83 if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
84 {
85 std::string back = m_toolStack[ i ];
87
88 if( action )
89 {
90 // Pop the action as running it will push it back onto the stack
91 m_toolStack.pop_back();
92
93 TOOL_EVENT evt = action->MakeEvent();
94 evt.SetHasPosition( false );
95 evt.SetReactivate( true );
96 GetToolManager()->PostEvent( evt );
97 }
98 }
99 else
101
102 return;
103 }
104 }
105
106 wxASSERT_MSG( false, "Popped a Tool Not on the Tool Stack!" );
107}
TOOL_ACTION * FindAction(const std::string &aActionName) const
Find an action with a given name (if there is one available).
virtual void DisplayToolMsg(const wxString &msg)
Definition: tools_holder.h:133
Represent a single user action.
Definition: tool_action.h:68
TOOL_EVENT MakeEvent() const
Return the event associated with the action (i.e.
Definition: tool_action.cpp:72
Generic, UI-independent tool event.
Definition: tool_event.h:156
void SetReactivate(bool aReactivate=true)
Returns information about difference between current mouse cursor position and the place where draggi...
Definition: tool_event.h:256
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:244
const std::string & getCommandStr() const
Definition: tool_event.h:482
void PostEvent(const TOOL_EVENT &aEvent)
Put an event to the event queue to be processed at the end of event processing cycle.
ACTION_MANAGER * GetActionManager() const
Definition: tool_manager.h:196
wxString GetLabel(EDA_UNITS aUnits, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
Get the units string for a given units type.
Definition: eda_units.cpp:129

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_EVENT::getCommandStr(), EDA_UNIT_UTILS::GetLabel(), 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(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_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::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString &  text)
inherited

Definition at line 807 of file eda_base_frame.cpp.

808{
809 SetStatusText( text );
810}

References text.

Referenced by 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}
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:192

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_LIBRARY_MANAGER::addLibrary(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), 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_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), 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(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), 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(), PCB_EDIT_FRAME::GetLastPath(), 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_NAVIGATE_TOOL::HypertextCommand(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FIELDS_GRID_TABLE< T >::initGrid(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SYMBOL_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), PCB_EDIT_FRAME::LoadFootprints(), SCH_EDIT_FRAME::LoadProject(), KICAD_MANAGER_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(), PCB_EDIT_FRAME::onBoardLoaded(), 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_SYMBOL_FIELDS_TABLE::OnExport(), 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_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_SCHEMATIC_SETUP::onPageChanged(), DIALOG_BOARD_SETUP::onPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), DIALOG_TEXT_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_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(), SYMBOL_EDITOR_CONTROL::PinLibrary(), FOOTPRINT_EDITOR_CONTROL::PinLibrary(), LIB_TREE_MODEL_ADAPTER::PinLibrary(), 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(), APPEARANCE_CONTROLS::rebuildNets(), 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(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), PCB_EDIT_FRAME::RunEeschema(), 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(), EDA_BASE_FRAME::SaveSettings(), SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), saveWorkbook(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SCH_BASE_FRAME::SelectSymLibTable(), PCB_EDIT_FRAME::SetBoard(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_EDIT_FRAME::SetLastPath(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SYMBOL_VIEWER_FRAME::ShowModal(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_LIBRARY_MANAGER::symTable(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER_FRAME::takeScreenshot(), PCB_EDIT_FRAME::TestStandalone(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_ASSIGN_NETCLASS::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), FOOTPRINT_EDITOR_CONTROL::UnpinLibrary(), LIB_TREE_MODEL_ADAPTER::UnpinLibrary(), SCH_EDIT_FRAME::updateAutoSaveFile(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), SCH_EDIT_FRAME::UpdateTitle(), updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent &  aEvent)
overrideinherited

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

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

Definition at line 254 of file eda_base_frame.cpp.

255{
256#ifdef __WXMAC__
257 // Apple in its infinite wisdom will raise a disabled window before even passing
258 // us the event, so we have no way to stop it. Instead, we have to catch an
259 // improperly ordered disabled window and quasi-modal dialog here and reorder
260 // them.
261 if( !IsEnabled() && IsActive() )
262 {
263 wxWindow* dlg = findQuasiModalDialog();
264 if( dlg )
265 dlg->Raise();
266 }