KiCad PCB EDA Suite
Loading...
Searching...
No Matches
CVPCB_MAINFRAME Class Reference

The CvPcb application main window. More...

#include <cvpcb_mainframe.h>

Inheritance diagram for CVPCB_MAINFRAME:
KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER UNITS_PROVIDER

Public Types

enum  CVPCB_FILTER_ACTION { FILTER_DISABLE , FILTER_ENABLE , FILTER_TOGGLE }
 The action to apply to a footprint filter when it is modified. More...
 
enum  CONTROL_TYPE { CONTROL_NONE , CONTROL_LIBRARY , CONTROL_COMPONENT , CONTROL_FOOTPRINT }
 The type of the controls present in the application. More...
 
enum  FOCUS_DIR { CHANGE_FOCUS_RIGHT , CHANGE_FOCUS_LEFT }
 Directions to rotate the focus through the listboxes is. More...
 
enum  ITEM_DIR { ITEM_NEXT , ITEM_PREV }
 Directions to move when selecting items. More...
 
enum  CRITERIA { ALL_COMPONENTS , SEL_COMPONENTS , NA_COMPONENTS , ASSOC_COMPONENTS }
 Criteria to use to identify sets of components. More...
 
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

 ~CVPCB_MAINFRAME ()
 
bool OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl=0) override
 Open a project or set of files given by aFileList.
 
void KiwayMailIn (KIWAY_EXPRESS &aEvent) override
 Receive KIWAY_EXPRESS messages from other players.
 
bool IsContentModified () const override
 Get if the current associations have been modified but not saved.
 
DISPLAY_FOOTPRINTS_FRAMEGetFootprintViewerFrame () const
 
wxWindow * GetToolCanvas () const override
 Canvas access.
 
CVPCB_MAINFRAME::CONTROL_TYPE GetFocusedControl () const
 Find out which control currently has focus.
 
void SetFocusedControl (CVPCB_MAINFRAME::CONTROL_TYPE aControl)
 Set the focus to a specific control.
 
void OnSelectComponent (wxListEvent &event)
 Called when clicking on a component in component list window:
 
void ReCreateHToolbar ()
 
void ShowChangedLanguage () override
 
void AutomaticFootprintMatching ()
 Called by the automatic association button Read *.equ files to try to find corresponding footprint for each component that is not already linked to a footprint ( a "free" component ) format of a line: 'cmp_ref' 'footprint_name'.
 
void SetFootprintFilter (FOOTPRINTS_LISTBOX::FP_FILTER_T aFilter, CVPCB_MAINFRAME::CVPCB_FILTER_ACTION aAction)
 Set a filter criteria to either on/off or toggle the criteria.
 
void UndoAssociation ()
 Undo the most recent associations that were performed.
 
void RedoAssociation ()
 Redo the most recently undone association.
 
int GetUndoCommandCount () const override
 
int GetRedoCommandCount () const override
 
wxString GetUndoActionDescription () const override
 
wxString GetRedoActionDescription () const override
 
void AssociateFootprint (const CVPCB_ASSOCIATION &aAssociation, bool aNewEntry=true, bool aAddUndoItem=true)
 Associate a footprint with a specific component in the list.
 
void BuildFootprintsList ()
 
void BuildLibrariesList ()
 
bool SaveFootprintAssociation (bool doSaveSchematic)
 Save the edits that the user has done by sending them back to Eeschema via the kiway.
 
void LoadSettings (APP_SETTINGS_BASE *aCfg) override
 Load common frame parameters from a configuration file.
 
void SaveSettings (APP_SETTINGS_BASE *aCfg) override
 Save common frame parameters to a configuration data file.
 
void DisplayStatus ()
 Update the information displayed on the status bar at bottom of the main frame.
 
bool LoadFootprintFiles ()
 Read the list of footprint (*.mod files) and generate the list of footprints.
 
void SendComponentSelectionToSch (bool aClearSelectionOnly=false)
 Send a remote command to Eeschema via a socket,.
 
COMPONENTGetSelectedComponent ()
 Get the selected component from the component listbox.
 
void SetSelectedComponent (int aIndex, bool aSkipUpdate=false)
 Set the currently selected component in the components listbox.
 
std::vector< unsigned int > GetComponentIndices (CVPCB_MAINFRAME::CRITERIA aCriteria=CVPCB_MAINFRAME::ALL_COMPONENTS)
 Get the indices for all the components meeting the specified criteria in the components listbox.
 
wxString GetSelectedFootprint ()
 
void RefreshFootprintViewer ()
 
void SetStatusText (const wxString &aText, int aNumber=0) override
 
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().
 
bool Destroy () override
 Our version of Destroy() which is virtual from wxWidgets.
 
bool IsModal () const override
 Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame.
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
void CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242).
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
virtual void ToggleUserUnits ()
 
ORIGIN_TRANSFORMSGetOriginTransforms () override
 Return a reference to the default ORIGIN_TRANSFORMS object.
 
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.
 
virtual void OnCharHook (wxKeyEvent &aKeyEvent)
 Capture the key event before it is sent to the GUI.
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves.
 
virtual void RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
 Register a UI update handler for the control with ID aID.
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
 Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls.
 
virtual void UnregisterUIUpdateHandler (int aID) override
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler.
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.
 
virtual void OnMove (wxMoveEvent &aEvent)
 
virtual void OnSize (wxSizeEvent &aEvent)
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
FRAME_T GetFrameType () const
 
virtual const SEARCH_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program.
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 
void ShowPreferences (wxString aStartPage, wxString aStartParentPage)
 Displays the preferences and settings of all opened editors paged dialog, starting with a particular page.
 
void PrintMsg (const wxString &text)
 
void CreateInfoBar ()
 
void FinishAUIInitialization ()
 
WX_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.
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.
 
void ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar.
 
void ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar.
 
virtual APP_SETTINGS_BASEconfig () const
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
 
void LoadWindowState (const wxString &aFileName)
 
virtual void LoadWindowState (const WINDOW_STATE &aState)
 Load frame state info from a configuration file.
 
void LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
 Load window settings from the given settings object.
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Save window settings to the given settings object.
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Return a pointer to the window settings for this frame.
 
wxString ConfigBaseName () override
 Get the configuration base name.
 
virtual void SaveProjectLocalSettings ()
 Save changes to the project local settings.
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it.
 
wxString GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
 Fetches the file name from the file history list.
 
void ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
 Removes all files from the file history.
 
void UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
 Update the list of recently opened files.
 
FILE_HISTORYGetFileHistory ()
 Get the frame's main file history.
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
virtual wxString GetCurrentFileName () const
 Get the full filename + path of the currently opened file in the frame.
 
void ReCreateMenuBar ()
 Recreates the menu bar.
 
void SetMenuBar (wxMenuBar *menu_bar) override
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar.
 
bool IsWritable (const wxFileName &aFileName, bool aVerbose=true)
 Checks if aFileName can be written.
 
virtual void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input.
 
virtual void DeleteAutoSaveFile (const wxFileName &aFileName)
 
virtual void UpdateStatusBar ()
 Update the status bar information.
 
void CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
 Notification event that some of the common (suite-wide) settings have changed.
 
virtual void ThemeChanged ()
 Process light/dark theme change.
 
virtual void ProjectChanged ()
 Notification event that the project has changed.
 
const wxString & GetAboutTitle () const
 
const wxString & GetUntranslatedAboutTitle () const
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size.
 
virtual void ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)
 Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.
 
virtual void ClearUndoRedoList ()
 Clear the undo and redo list using ClearUndoORRedoList()
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Add a command to undo in the undo list.
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Add a command to redo in the redo list.
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 Return the last command to undo and remove it from list, nothing is deleted.
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 Return the last command to undo and remove it from list, nothing is deleted.
 
int GetMaxUndoItems () const
 
virtual void OnModify ()
 Must be called after a model change in order to set the "modify" flag and do other frame-specific processing.
 
bool NonUserClose (bool aForce)
 
virtual void HandleSystemColorChange ()
 Update the UI in response to a change in the system colors.
 
virtual bool CanAcceptApiCommands ()
 Checks if this frame is ready to accept API commands.
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller.
 
TOOL_DISPATCHERGetToolDispatcher () const
 
virtual SELECTIONGetCurrentSelection ()
 Get the current selection from the canvas area.
 
virtual void PushTool (const TOOL_EVENT &aEvent)
 NB: the definition of "tool" is different at the user level.
 
virtual void PopTool (const TOOL_EVENT &aEvent)
 Pops a tool from the stack.
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
virtual void DisplayToolMsg (const wxString &msg)
 
bool GetDoImmediateActions () const
 Indicate that hotkeys should perform an immediate action even if another tool is currently active.
 
MOUSE_DRAG_ACTION GetDragAction () const
 Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.
 
bool GetMoveWarpsCursor () const
 Indicate that a move operation should warp the mouse pointer to the origin of the move object.
 
virtual void RefreshCanvas ()
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in.
 
bool HasKiway () const
 Safety check before asking for the Kiway reference.
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY.
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*.
 
EDA_UNITS GetUserUnits () const
 
void SetUserUnits (EDA_UNITS aUnits)
 
virtual void GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
 
const EDA_IU_SCALEGetIuScale () const
 
wxString StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
 Converts aValue in internal units into a united string.
 
wxString StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false) const
 
wxString MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
 A lower-precision version of StringFromValue().
 
wxString MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true) const
 
wxString MessageTextFromMinOptMax (const MINOPTMAX< int > &aValue) const
 
int ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
 Converts aTextValue in aUnits to internal units used by the frame.
 
EDA_ANGLE AngleValueFromString (const wxString &aTextValue) const
 

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.
 

Public Attributes

FOOTPRINT_LISTm_FootprintsList
 

Protected Member Functions

 CVPCB_MAINFRAME (KIWAY *aKiway, wxWindow *aParent)
 
void doReCreateMenuBar () override
 
void setupUIConditions () override
 Setup the UI conditions for the various actions and their controls in this frame.
 
bool canCloseWindow (wxCloseEvent &aCloseEvent) override
 
void doCloseWindow () override
 
bool readNetListAndFpFiles (const std::string &aNetlist)
 Load the netlist file built on the fly by Eeschema and loads footprint libraries from fp lib tables.
 
int readSchematicNetlist (const std::string &aNetlist)
 Read the netlist (.net) file built on the fly by Eeschema.
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn()
 
void language_change (wxCommandEvent &event)
 An event handler called on a language menu selection.
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event.
 
virtual void handleIconizeEvent (wxIconizeEvent &aEvent)
 Handle a window iconize event.
 
void onIconize (wxIconizeEvent &aEvent)
 
virtual bool isAutoSaveRequired () const
 Return the auto save status of the application.
 
virtual bool doAutoSave ()
 This should be overridden by the derived class to handle the auto save feature.
 
void onSystemColorChange (wxSysColourChangedEvent &aEvent)
 
virtual void unitsChangeRefresh ()
 Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them.
 
void initExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
 
void ensureWindowIsOnScreen ()
 
virtual void saveProjectSettings ()
 Saves any design-related project settings associated with this frame.
 
virtual void OnDropFiles (wxDropFilesEvent &aEvent)
 Handles event fired when a file is dropped to the window.
 
void AddMenuLanguageList (ACTION_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
 Function AddMenuLanguageList creates a menu list for language choice, and add it as submenu to MasterMenu.
 
virtual void DoWithAcceptedFiles ()
 Execute action on accepted dropped file.
 

Protected Attributes

bool m_modified
 
bool m_skipComponentSelect
 
bool m_initialized
 
bool m_cannotClose
 
bool m_modal
 
wxGUIEventLoop * m_modal_loop
 < Points to nested event_loop. NULL means not modal and dismissed.
 
wxWindow * m_modal_resultant_parent
 
wxString m_modal_string
 
bool m_modal_ret_val
 
wxSocketServer * m_socketServer
 
std::vector< wxSocketBase * > m_sockets
 interprocess communication
 
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
 
APPEARANCE_CONTROLS_3Dm_appearancePanel
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_supportsAutoSave
 
bool m_autoSavePending
 
bool m_autoSaveRequired
 
wxTimer * m_autoSaveTimer
 
int m_undoRedoCountMax
 
wxString m_mruPath
 
ORIGIN_TRANSFORMS m_originTransforms
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 < Map containing the UI update handlers registered with wx for each action.
 
bool m_isClosing
 Set by NonUserClose() to indicate that the user did not request the current close.
 
bool m_isNonUserClose
 
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
 Associates files extensions with action to execute.
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
MOUSE_DRAG_ACTION m_dragAction
 
bool m_moveWarpsCursor
 

Static Protected Attributes

static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 < Default style flags used for wxAUI toolbars.
 

Private Member Functions

wxString formatSymbolDesc (int idx, const wxString &aReference, const wxString &aValue, const wxString &aFootprint)
 
void setupTools ()
 Setup the tool system for the CVPCB main frame.
 
void setupEventHandlers ()
 Setup event handlers.
 
void onTextFilterChanged (wxCommandEvent &event)
 
void updateFootprintViewerOnIdle (wxIdleEvent &aEvent)
 
void onTextFilterChangedTimer (wxTimerEvent &aEvent)
 
int buildEquivalenceList (FOOTPRINT_EQUIVALENCE_LIST &aList, wxString *aErrorMessages=nullptr)
 Read the .equ files and populate the list of equivalents.
 
void refreshAfterSymbolSearch (COMPONENT *aSymbol)
 
void windowClosing (wxCloseEvent &event)
 (with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings().
 
void commonInit (FRAME_T aFrameType)
 Collect common initialization functions used in all CTORs.
 
wxWindow * findQuasiModalDialog ()
 

Private Attributes

NETLIST m_netlist
 
int m_filteringOptions
 
ACTION_TOOLBARm_mainToolBar
 
FOOTPRINTS_LISTBOXm_footprintListBox
 
LIBRARY_LISTBOXm_librariesListBox
 
SYMBOLS_LISTBOXm_symbolsListBox
 
wxTextCtrl * m_tcFilterString
 
wxStaticText * m_statusLine1
 
wxStaticText * m_statusLine2
 
wxStaticText * m_statusLine3
 
wxButton * m_saveAndContinue
 
TOOL_DISPATCHERm_toolDispatcher
 
ACTION_MENUm_footprintContextMenu
 
ACTION_MENUm_symbolsContextMenu
 
CVPCB_UNDO_REDO_LIST m_undoList
 
CVPCB_UNDO_REDO_LIST m_redoList
 
wxTimer * m_filterTimer
 
bool m_viewerPendingUpdate
 
KIWAYm_kiway
 
HOLDER_TYPE m_type
 
const EDA_IU_SCALEm_iuScale
 
EDA_UNITS m_userUnits
 

Friends

struct CV::IFACE
 

Detailed Description

The CvPcb application main window.

Definition at line 55 of file cvpcb_mainframe.h.

Member Enumeration Documentation

◆ CONTROL_TYPE

The type of the controls present in the application.

Enumerator
CONTROL_NONE 

No controls have focus.

CONTROL_LIBRARY 

Library listbox.

CONTROL_COMPONENT 

Component listbox.

CONTROL_FOOTPRINT 

Footprint listbox.

Definition at line 77 of file cvpcb_mainframe.h.

◆ CRITERIA

Criteria to use to identify sets of components.

Enumerator
ALL_COMPONENTS 

All components.

SEL_COMPONENTS 

Selected components.

NA_COMPONENTS 

Not associated components.

ASSOC_COMPONENTS 

Associated components.

Definition at line 285 of file cvpcb_mainframe.h.

◆ CVPCB_FILTER_ACTION

The action to apply to a footprint filter when it is modified.

Enumerator
FILTER_DISABLE 

Turn off the filter.

FILTER_ENABLE 

Turn on the filter.

FILTER_TOGGLE 

Toggle the filter state.

Definition at line 67 of file cvpcb_mainframe.h.

◆ FOCUS_DIR

Directions to rotate the focus through the listboxes is.

Enumerator
CHANGE_FOCUS_RIGHT 
CHANGE_FOCUS_LEFT 

Definition at line 88 of file cvpcb_mainframe.h.

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 41 of file kiway_holder.h.

◆ ITEM_DIR

Directions to move when selecting items.

Enumerator
ITEM_NEXT 

The next item.

ITEM_PREV 

The previous item.

Definition at line 97 of file cvpcb_mainframe.h.

◆ UNDO_REDO_LIST

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

Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 113 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ ~CVPCB_MAINFRAME()

◆ CVPCB_MAINFRAME()

Member Function Documentation

◆ AddMenuLanguageList()

◆ AddStandardHelpMenu()

◆ AngleValueFromString()

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

◆ AssociateFootprint()

void CVPCB_MAINFRAME::AssociateFootprint ( const CVPCB_ASSOCIATION aAssociation,
bool  aNewEntry = true,
bool  aAddUndoItem = true 
)

Associate a footprint with a specific component in the list.

Associations can be chained into a single undo/redo step by setting aNewEntry to false for every association other than the first one. This will create a new list entry for the first association, and add the subsequent associations to that list.

Parameters
aAssociationis the association to perform
aNewEntryspecifies if this association should be a new entry in the undo list
aAddUndoItemspecifies if an undo item should be created for this association

Definition at line 610 of file cvpcb_mainframe.cpp.

References _, SYMBOLS_LISTBOX::AppendWarning(), DisplayErrorMessage(), DisplayStatus(), LIB_ID::empty(), LIB_ID::Format(), formatSymbolDesc(), NETLIST::GetComponent(), CVPCB_ASSOCIATION::GetComponentIndex(), GetComponentIndices(), FOOTPRINT_LIST::GetFootprintInfo(), COMPONENT::GetFPID(), COMPONENT::GetKIIDs(), CVPCB_ASSOCIATION::GetNewFootprint(), COMPONENT::GetReference(), COMPONENT::GetValue(), NETLIST::IsEmpty(), LIB_ID::IsValid(), m_FootprintsList, m_modified, m_netlist, m_redoList, m_symbolsListBox, m_undoList, SYMBOLS_LISTBOX::RemoveWarning(), COMPONENT::SetFPID(), SYMBOLS_LISTBOX::SetString(), and UTF8::wx_str().

Referenced by CVPCB_ASSOCIATION_TOOL::Associate(), AutomaticFootprintMatching(), CVPCB_ASSOCIATION_TOOL::CutAssoc(), CVPCB_ASSOCIATION_TOOL::DeleteAll(), CVPCB_ASSOCIATION_TOOL::DeleteAssoc(), CVPCB_ASSOCIATION_TOOL::PasteAssoc(), RedoAssociation(), and UndoAssociation().

◆ AutomaticFootprintMatching()

void CVPCB_MAINFRAME::AutomaticFootprintMatching ( )

◆ buildEquivalenceList()

int CVPCB_MAINFRAME::buildEquivalenceList ( FOOTPRINT_EQUIVALENCE_LIST aList,
wxString *  aErrorMessages = nullptr 
)
private

Read the .equ files and populate the list of equivalents.

Parameters
aListthe list to populate
aErrorMessagesis a pointer to a wxString to store error messages (can be NULL)
Returns
the error count ( 0 = no error)

Definition at line 79 of file auto_associate.cpp.

References _, From_UTF8(), GetLine(), PROJECT::GetProjectFile(), GetQuotedText(), Kiface(), KIFACE_BASE::KifaceSearch(), FOOTPRINT_EQUIVALENCE::m_ComponentValue, FOOTPRINT_EQUIVALENCE::m_FootprintFPID, KIWAY_HOLDER::Prj(), and project.

Referenced by AutomaticFootprintMatching().

◆ BuildFootprintsList()

◆ BuildLibrariesList()

◆ CanAcceptApiCommands()

virtual bool EDA_BASE_FRAME::CanAcceptApiCommands ( )
inlinevirtualinherited

Checks if this frame is ready to accept API commands.

A frame might not accept commands if a long-running process is underway, a dialog is open, the user is interacting with a tool, etc.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 608 of file eda_base_frame.h.

Referenced by PCB_EDIT_FRAME::CanAcceptApiCommands(), and API_HANDLER_EDITOR::checkForBusy().

◆ canCloseWindow()

bool CVPCB_MAINFRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
overrideprotectedvirtual

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

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

References _, FILEEXT::AutoSaveFilePrefix, EDA_BASE_FRAME::DeleteAutoSaveFile(), KIPLATFORM::IO::DuplicatePermissions(), Pgm(), and traceAutoSave.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ ClearFileHistory()

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

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

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

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), AskLoadBoardFileName(), EDA_DRAW_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), SIMULATOR_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), GERBVIEW_FRAME::GERBVIEW_FRAME(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), COMMON_TOOLS::GridFastCycle(), GERBVIEW_FRAME::gvconfig(), EDA_DRAW_FRAME::IsGridOverridden(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), PCB_CALCULATOR_FRAME::loadPages(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), GERBVIEW_FRAME::Read_EXCELLON_File(), EDA_BASE_FRAME::SaveSettings(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetDisplayOptions(), EDA_DRAW_FRAME::SetGridOverrides(), EDA_DRAW_FRAME::SetGridVisibility(), setupTools(), SCH_EDIT_FRAME::setupTools(), SIMULATOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), BITMAP2CMP_FRAME::ShowChangedLanguage(), PCB_CALCULATOR_FRAME::ShowChangedLanguage(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), GRID_MENU::update(), ZOOM_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), and BITMAP2CMP_FRAME::~BITMAP2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited

Get the configuration base name.

This is usually the name of the frame set by CTOR, except for frames shown in multiple modes in which case the m_configName must be set to the base name so that a single configuration can be used.

Returns
a base name prefix used in Load/Save settings to build the full name of keys used in configuration.

Reimplemented from TOOLS_HOLDER.

Definition at line 349 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_configName.

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

◆ CreateServer()

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

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const
inherited

◆ DeleteAutoSaveFile()

void EDA_BASE_FRAME::DeleteAutoSaveFile ( const wxFileName &  aFileName)
virtualinherited

◆ Destroy()

◆ DismissModal()

◆ DisplayStatus()

void CVPCB_MAINFRAME::DisplayStatus ( )

Update the information displayed on the status bar at bottom of the main frame.

When the library or component list controls have the focus, the footprint assignment status of the components is displayed in the first status bar pane and the list of filters for the selected component is displayed in the second status bar pane. When the footprint list control has the focus, the description of the selected footprint is displayed in the first status bar pane and the key words for the selected footprint are displayed in the second status bar pane. The third status bar pane always displays the current footprint list filtering.

Definition at line 760 of file cvpcb_mainframe.cpp.

References _, CONTROL_COMPONENT, CONTROL_LIBRARY, FOOTPRINTS_LISTBOX::FILTERING_BY_COMPONENT_FP_FILTERS, FOOTPRINTS_LISTBOX::FILTERING_BY_LIBRARY, FOOTPRINTS_LISTBOX::FILTERING_BY_PIN_COUNT, FOOTPRINTS_LISTBOX::GetCount(), FOOTPRINT_INFO::GetDesc(), GetFocusedControl(), COMPONENT::GetFootprintFilters(), FOOTPRINT_LIST::GetFootprintInfo(), COMPONENT::GetFPID(), LIB_TABLE::GetFullURI(), FOOTPRINT_INFO::GetKeywords(), FOOTPRINT_INFO::GetLibNickname(), COMPONENT::GetPinCount(), GetSelectedComponent(), GetSelectedFootprint(), LIBRARY_LISTBOX::GetSelectedLibrary(), LIB_ID::GetUniStringLibNickname(), LIB_TABLE::HasLibrary(), m_filteringOptions, m_footprintListBox, m_FootprintsList, m_initialized, m_librariesListBox, m_tcFilterString, PROJECT_PCB::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), and SetStatusText().

Referenced by AssociateFootprint(), BuildFootprintsList(), CVPCB_ASSOCIATION_TOOL::DeleteAll(), onTextFilterChangedTimer(), readNetListAndFpFiles(), refreshAfterSymbolSearch(), ShowChangedLanguage(), and updateFootprintViewerOnIdle().

◆ DisplayToolMsg()

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

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void CVPCB_MAINFRAME::doCloseWindow ( )
overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 417 of file cvpcb_mainframe.cpp.

References GetFootprintViewerFrame(), m_modified, and SendComponentSelectionToSch().

◆ doReCreateMenuBar()

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

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

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 177 of file kiway_player.h.

Referenced by DIALOG_BOOK_REPORTER::OnErrorLinkClicked(), and KIWAY_PLAYER::OnSockRequest().

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )
privateinherited

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 916 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::m_auimgr.

Referenced by SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME().

◆ formatSymbolDesc()

wxString CVPCB_MAINFRAME::formatSymbolDesc ( int  idx,
const wxString &  aReference,
const wxString &  aValue,
const wxString &  aFootprint 
)
private

Definition at line 589 of file cvpcb_mainframe.cpp.

Referenced by AssociateFootprint(), and readNetListAndFpFiles().

◆ GetAboutTitle()

const wxString & EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetAutoSaveInterval()

◆ GetComponentIndices()

std::vector< unsigned int > CVPCB_MAINFRAME::GetComponentIndices ( CVPCB_MAINFRAME::CRITERIA  aCriteria = CVPCB_MAINFRAME::ALL_COMPONENTS)

Get the indices for all the components meeting the specified criteria in the components listbox.

Parameters
aCriteriais the criteria to use for finding the indices
Returns
a vector containing all the indices

Definition at line 1076 of file cvpcb_mainframe.cpp.

References ALL_COMPONENTS, ASSOC_COMPONENTS, LIB_ID::empty(), NETLIST::GetComponent(), SYMBOLS_LISTBOX::GetCount(), NETLIST::GetCount(), COMPONENT::GetFPID(), NETLIST::IsEmpty(), m_netlist, m_symbolsListBox, NA_COMPONENTS, and SEL_COMPONENTS.

Referenced by CVPCB_ASSOCIATION_TOOL::Associate(), AssociateFootprint(), CVPCB_ASSOCIATION_TOOL::CutAssoc(), CVPCB_ASSOCIATION_TOOL::DeleteAll(), CVPCB_ASSOCIATION_TOOL::DeleteAssoc(), CVPCB_ASSOCIATION_TOOL::PasteAssoc(), and CVPCB_CONTROL::ToNA().

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

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

Indicate that hotkeys should perform an immediate action even if another tool is currently active.

If false, the first hotkey should select the relevant tool.

Definition at line 138 of file tools_holder.h.

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

References TOOLS_HOLDER::m_dragAction.

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

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

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

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), BITMAP2CMP_FRAME::OnFileHistory(), 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

◆ GetFocusedControl()

CVPCB_MAINFRAME::CONTROL_TYPE CVPCB_MAINFRAME::GetFocusedControl ( ) const

Find out which control currently has focus.

Returns
the control that currently has focus

Definition at line 1147 of file cvpcb_mainframe.cpp.

References CONTROL_COMPONENT, CONTROL_FOOTPRINT, CONTROL_LIBRARY, CONTROL_NONE, m_footprintListBox, m_librariesListBox, and m_symbolsListBox.

Referenced by CVPCB_CONTROL::ChangeFocus(), CVPCB_ASSOCIATION_TOOL::CopyAssoc(), CVPCB_ASSOCIATION_TOOL::CutAssoc(), and DisplayStatus().

◆ GetFootprintViewerFrame()

DISPLAY_FOOTPRINTS_FRAME * CVPCB_MAINFRAME::GetFootprintViewerFrame ( ) const
Returns
a pointer on the Footprint Viewer frame, if exists, or NULL

Definition at line 1133 of file cvpcb_mainframe.cpp.

References FOOTPRINTVIEWER_FRAME_NAME.

Referenced by doCloseWindow(), GetToolCanvas(), RefreshFootprintViewer(), CVPCB_CONTROL::ShowFootprintViewer(), and updateFootprintViewerOnIdle().

◆ GetFrameType()

◆ GetInfoBar()

◆ GetIuScale()

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 584 of file eda_base_frame.h.

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

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

◆ GetOriginTransforms()

ORIGIN_TRANSFORMS & EDA_BASE_FRAME::GetOriginTransforms ( )
inlineoverridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from UNITS_PROVIDER.

Reimplemented in PCB_BASE_FRAME.

Definition at line 132 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_originTransforms.

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

◆ GetRedoActionDescription()

wxString CVPCB_MAINFRAME::GetRedoActionDescription ( ) const
inlineoverridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 195 of file cvpcb_mainframe.h.

◆ GetRedoCommandCount()

int CVPCB_MAINFRAME::GetRedoCommandCount ( ) const
inlineoverridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 183 of file cvpcb_mainframe.h.

References m_redoList.

◆ GetSelectedComponent()

COMPONENT * CVPCB_MAINFRAME::GetSelectedComponent ( )

◆ GetSelectedFootprint()

wxString CVPCB_MAINFRAME::GetSelectedFootprint ( )
Returns
the LIB_ID of the selected footprint in footprint listview or a empty string if no selection

Definition at line 1168 of file cvpcb_mainframe.cpp.

References FOOTPRINTS_LISTBOX::GetSelectedFootprint(), and m_footprintListBox.

Referenced by CVPCB_ASSOCIATION_TOOL::Associate(), CVPCB_ASSOCIATION_TOOL::CopyAssoc(), DisplayStatus(), and DISPLAY_FOOTPRINTS_FRAME::InitDisplay().

◆ GetSettingsManager()

◆ GetSeverity()

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

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 140 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetToolCanvas()

wxWindow * CVPCB_MAINFRAME::GetToolCanvas ( ) const
overridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 1141 of file cvpcb_mainframe.cpp.

References GetFootprintViewerFrame().

◆ GetToolDispatcher()

TOOL_DISPATCHER * TOOLS_HOLDER::GetToolDispatcher ( ) const
inlineinherited

Definition at line 57 of file tools_holder.h.

References TOOLS_HOLDER::m_toolDispatcher.

Referenced by LIB_TREE_MODEL_ADAPTER::GetToolDispatcher().

◆ GetToolManager()

TOOL_MANAGER * TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), SCH_SEARCH_HANDLER::ActivateItem(), PCB_SEARCH_HANDLER::ActivateItem(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_PROPERTIES_PANEL::AfterCommit(), PCB_PROPERTIES_PANEL::AfterCommit(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), SCH_NAVIGATE_TOOL::Back(), PCB_EDIT_FRAME::CanAcceptApiCommands(), SCH_NAVIGATE_TOOL::changeSheet(), TOOLS_HOLDER::CommonSettingsChanged(), EDA_DRAW_FRAME::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(), KIGFX::SCH_VIEW::DisplaySheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIMULATOR_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SCH_FIELD::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), SCH_DRAWING_TOOLS::doSyncSheetsPins(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SIMULATOR_CONTROL::ExportPlotToSchematic(), 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(), PCB_TUNING_PATTERN::GetPreviewItems(), SCH_PROPERTIES_PANEL::getPropertyFromEvent(), PCB_PROPERTIES_PANEL::getPropertyFromEvent(), API_HANDLER_PCB::handleInteractiveMoveItems(), API_HANDLER_PCB::handleRefillZones(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineBreakTrack(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_GENERATORS::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnDeleteOneClick(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemRClick(), DIALOG_ERC::OnERCItemSelected(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_GENERATORS::OnItemSelected(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), GERBER_LAYER_WIDGET::onPopupSelection(), DIALOG_GENERATORS::OnRebuildAllClick(), DIALOG_GENERATORS::OnRebuildTypeClick(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_PANE::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), PCB_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected(), PANEL_KICAD_LAUNCHER::PANEL_KICAD_LAUNCHER(), PANEL_SCH_SELECTION_FILTER::PANEL_SCH_SELECTION_FILTER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_PRINTOUT::PrintPage(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), PCB_BASE_FRAME::rebuildConnectivity(), SCH_EDIT_FRAME::RecalculateConnections(), SIMULATOR_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), SCH_COMMIT::SCH_COMMIT(), DIALOG_FIND::search(), SCH_SEARCH_HANDLER::SelectItems(), PCB_SEARCH_HANDLER::SelectItems(), setupEventHandlers(), FOOTPRINT_EDIT_FRAME::setupTools(), TOOLS_HOLDER::ShowChangedLanguage(), APPEARANCE_CONTROLS::showNetclass(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), SIMULATOR_CONTROL::Tune(), SCH_PROPERTIES_PANEL::UpdateData(), PCB_PROPERTIES_PANEL::UpdateData(), DIALOG_DRC::updateDisplayedCounts(), updateFootprintViewerOnIdle(), NET_GRID_TABLE::updateNetVisibility(), SCH_PROPERTIES_PANEL::valueChanged(), PCB_PROPERTIES_PANEL::valueChanged(), SCH_PROPERTIES_PANEL::valueChanging(), PCB_PROPERTIES_PANEL::valueChanging(), DIALOG_IMPORT_NETLIST::~DIALOG_IMPORT_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 48 of file kiway_holder.h.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoActionDescription()

wxString CVPCB_MAINFRAME::GetUndoActionDescription ( ) const
inlineoverridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 190 of file cvpcb_mainframe.h.

◆ GetUndoCommandCount()

int CVPCB_MAINFRAME::GetUndoCommandCount ( ) const
inlineoverridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 178 of file cvpcb_mainframe.h.

References m_undoList.

◆ GetUnitPair()

virtual void UNITS_PROVIDER::GetUnitPair ( EDA_UNITS aPrimaryUnit,
EDA_UNITS aSecondaryUnits 
)
inlinevirtualinherited

◆ GetUntranslatedAboutTitle()

const wxString & EDA_BASE_FRAME::GetUntranslatedAboutTitle ( ) const
inlineinherited

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const
inlineinherited

Definition at line 43 of file units_provider.h.

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_BOOK_REPORTER::AddHTMLPage(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), PG_UNIT_EDITOR::CreateControls(), PCB::IFACE::CreateKiWindow(), 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::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), PCB_NET_INSPECTOR_PANEL::generateReport(), RC_ITEM::GetJsonViolation(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), UNITS_PROVIDER::GetUnitPair(), EDA_DRAW_FRAME::GetUnitPair(), WX_GRID::GetUnitValue(), GetUserUnits(), UNIT_BINDER::init(), FIELDS_GRID_TABLE::initGrid(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromMinOptMax(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), DIALOG_ERC::OnSaveReport(), PANEL_PREVIEW_3D_MODEL::onUnitsChanged(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::onUnitsChanged(), DIALOG_GENERATORS::onUnitsChanged(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PCB_FIELDS_GRID_TABLE::PCB_FIELDS_GRID_TABLE(), PG_UNIT_EDITOR::PG_UNIT_EDITOR(), PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), EDA_DRAW_FRAME::SaveSettings(), PCB_BASE_FRAME::SetBoard(), WX_GRID::SetUnitsProvider(), PIN_TABLE_DATA_MODEL::SetValue(), FIELDS_GRID_TABLE::SetValue(), PCB_FIELDS_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), UNITS_PROVIDER::StringFromValue(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), PCB_BASE_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), PG_UNIT_EDITOR::UpdateFrame(), PL_EDITOR_FRAME::UpdateStatusBar(), DRC_TOOL::userUnits(), GRID::UserUnitsMessageText(), and UNITS_PROVIDER::ValueFromString().

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
virtualinherited

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 in DISPLAY_FOOTPRINTS_FRAME, SIMULATOR_FRAME, SYMBOL_CHOOSER_FRAME, SYMBOL_DIFF_FRAME, SYMBOL_VIEWER_FRAME, FOOTPRINT_CHOOSER_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 873 of file eda_base_frame.cpp.

References APP_SETTINGS_BASE::m_Window.

Referenced by EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), EDA_BASE_FRAME::SaveSettings(), and EDA_DRAW_FRAME::SaveSettings().

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

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

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

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

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

References _, ACTION_CONDITIONS::checkCondition, ACTIONS::copy, ACTIONS::cut, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), EDA_BASE_FRAME::GetRedoActionDescription(), TOOL_ACTION::GetUIId(), EDA_BASE_FRAME::GetUndoActionDescription(), ACTIONS::paste, ACTIONS::redo, ACTION_CONDITIONS::showCondition, and ACTIONS::undo.

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

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 892 of file eda_base_frame.cpp.

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

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const
inlineprotectedvirtualinherited

Return the auto save status of the application.

Override this function if your derived frame supports automatic file saving.

Definition at line 635 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_autoSaveRequired.

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool CVPCB_MAINFRAME::IsContentModified ( ) const
inlineoverridevirtual

Get if the current associations have been modified but not saved.

Returns
true if the any changes have not been saved

Reimplemented from EDA_BASE_FRAME.

Definition at line 108 of file cvpcb_mainframe.h.

References m_modified.

◆ IsCurrentTool()

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

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

References KIWAY_PLAYER::m_modal_loop.

Referenced by SYMBOL_CHOOSER_FRAME::doCloseWindow(), FOOTPRINT_CHOOSER_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 154 of file kiway_player.h.

References KIWAY_PLAYER::m_modal.

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

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 202 of file eda_base_frame.h.

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(), PCB_POINT_EDITOR::changeArcEditMode(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), SYMBOL_EDITOR_CONTROL::DdAddLibrary(), 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(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::DistributeItems(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), COMMON_TOOLS::doZoomFit(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditSymbol(), PCB_EDITOR_CONDITIONS::get45degModeFunc(), SCH_BASE_FRAME::GetColorSettings(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), 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(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_CONTROL::OpenWithTextEditor(), PCB_CONTROL::Paste(), PCB_FIELDS_GRID_TABLE::PCB_FIELDS_GRID_TABLE(), SYMBOL_EDITOR_CONTROL::PinLibrary(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PROPERTIES_PANEL::rebuildProperties(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), PCB_SELECTION_TOOL::Reset(), SYMBOL_EDITOR_CONTROL::Revert(), SYMBOL_EDITOR_CONTROL::Save(), SCH_COMMIT::SCH_COMMIT(), APPEARANCE_CONTROLS::setVisibleObjects(), EE_INSPECTION_TOOL::ShowDatasheet(), SYMBOL_EDITOR_CONTROL::SymbolTreeSearch(), SYMBOL_EDITOR_CONTROL::ToggleProperties(), 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 1319 of file eda_base_frame.cpp.

References _, and DisplayErrorMessage().

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

◆ Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 55 of file kiway_holder.h.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), BuildLibrariesList(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), BOARD_INSPECTION_TOOL::constructDiffPanel(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME(), KIWAY_PLAYER::Destroy(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SIMULATOR_CONTROL::ExportPlotToSchematic(), BACK_ANNOTATE::FetchNetlistFromPCB(), PANEL_SYMBOL_CHOOSER::FinishSetup(), IMPORT_PROJ_HELPER::ImportIndividualFile(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), PGM_SINGLE_TOP::MacOpenFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PCB_CALCULATOR_FRAME::OnExit(), SIMULATOR_FRAME::onExit(), SAVE_AS_TRAVERSER::OnFile(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), KIWAY_HOLDER::Prj(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), SendComponentSelectionToSch(), CVPCB_CONTROL::ShowFootprintViewer(), showFrame(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), FP_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), COMMON_CONTROL::ShowProjectManager(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), DIALOG_ERC::testErc(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), SIMULATOR_CONTROL::Tune(), 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 187 of file kiway_player.cpp.

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void CVPCB_MAINFRAME::KiwayMailIn ( KIWAY_EXPRESS aEvent)
overridevirtual

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

Reimplemented from KIWAY_PLAYER.

Definition at line 1196 of file cvpcb_mainframe.cpp.

References BuildFootprintsList(), BuildLibrariesList(), KIWAY_EXPRESS::Command(), KIWAY_EXPRESS::GetPayload(), LoadFootprintFiles(), m_cannotClose, MAIL_EESCHEMA_NETLIST, MAIL_RELOAD_LIB, and readNetListAndFpFiles().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

An event handler called on a language menu selection.

Definition at line 194 of file kiway_player.cpp.

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

◆ LoadFootprintFiles()

bool CVPCB_MAINFRAME::LoadFootprintFiles ( )

Read the list of footprint (*.mod files) and generate the list of footprints.

For each footprint the following items are stored:

  • the footprint name
  • documentation string
  • associated keywords
Returns
true if libraries are found, false otherwise.

Definition at line 885 of file cvpcb_mainframe.cpp.

References _, FOOTPRINT_LIST::DisplayErrors(), FOOTPRINT_LIST::GetErrorCount(), LIB_TABLE::GetLogicalLibs(), m_FootprintsList, PROJECT_PCB::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), and FOOTPRINT_LIST::ReadFootprintFiles().

Referenced by KiwayMailIn(), and readNetListAndFpFiles().

◆ LoadSettings()

void CVPCB_MAINFRAME::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 526 of file cvpcb_mainframe.cpp.

References EDA_BASE_FRAME::LoadSettings(), CVPCB_SETTINGS::m_FilterFlags, and m_filteringOptions.

Referenced by CVPCB_MAINFRAME().

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

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]

◆ LoadWindowState() [2/2]

◆ MessageTextFromMinOptMax()

wxString UNITS_PROVIDER::MessageTextFromMinOptMax ( const MINOPTMAX< int > &  aValue) const
inlineinherited

◆ MessageTextFromValue() [1/2]

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

◆ MessageTextFromValue() [2/2]

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

A lower-precision version of StringFromValue().

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

Definition at line 101 of file units_provider.h.

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

Referenced by CheckLibSymbol(), CheckLibSymbolGraphics(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DIALOG_BOARD_REANNOTATE::CoordTowxString(), GERBVIEW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DRAWING_TOOL::DrawBoardCharacteristics(), DRC_ENGINE::EvalRules(), PCB_NET_INSPECTOR_PANEL::formatLength(), DRC_TEST_PROVIDER::formatMsg(), SCH_LINE::GetItemDescription(), SCH_SHAPE::GetItemDescription(), DS_DRAW_ITEM_LINE::GetItemDescription(), DS_DRAW_ITEM_RECT::GetItemDescription(), PCB_TRACK::GetItemDescription(), SCH_BITMAP::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_JUNCTION::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_TABLECELL::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_REFERENCE_IMAGE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), STROKE_PARAMS::GetMsgPanelInfo(), GetNetNavigatorItemText(), SYMBOL_SEARCH_HANDLER::getResultCell(), POWER_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), LABEL_SEARCH_HANDLER::getResultCell(), DIALOG_BOARD_REANNOTATE::MakeSampleText(), PCB_BASE_FRAME::MessageTextFromCoord(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DIALOG_BOARD_STATISTICS::saveReportClicked(), TUNING_STATUS_VIEW_ITEM::SetCurrent(), TUNING_STATUS_VIEW_ITEM::SetMinMax(), EDA_SHAPE::ShapeGetMsgPanelInfo(), showCoord(), 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().

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce)
inlineinherited

Definition at line 592 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

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

References dump(), and kicadTraceKeyEvent.

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

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

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent &  aEvent)
protectedinherited

Definition at line 1604 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::handleIconizeEvent().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 1057 of file eda_base_frame.cpp.

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent &  aEvent)
inherited

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

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

◆ OnModify()

void EDA_BASE_FRAME::OnModify ( )
virtualinherited

◆ OnMove()

virtual void EDA_BASE_FRAME::OnMove ( wxMoveEvent &  aEvent)
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 191 of file eda_base_frame.h.

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 1064 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::ShowPreferences().

◆ OnSelectComponent()

void CVPCB_MAINFRAME::OnSelectComponent ( wxListEvent &  event)

Called when clicking on a component in component list window:

  • Updates the filtered footprint list, if the filtered list option is selected
  • Updates the current selected footprint in footprint list
  • Updates the footprint shown in footprint display window (if opened)

Definition at line 469 of file cvpcb_mainframe.cpp.

References COMPONENT::GetFPID(), GetSelectedComponent(), LIBRARY_LISTBOX::GetSelectedLibrary(), ITEMS_LISTBOX_BASE::GetSelection(), LIB_ID::IsValid(), m_filteringOptions, m_footprintListBox, m_FootprintsList, m_librariesListBox, m_skipComponentSelect, m_tcFilterString, refreshAfterSymbolSearch(), RefreshFootprintViewer(), FOOTPRINTS_LISTBOX::SetFootprints(), FOOTPRINTS_LISTBOX::SetSelectedFootprint(), and FOOTPRINTS_LISTBOX::SetSelection().

Referenced by SYMBOLS_LISTBOX::OnSelectComponent(), LIBRARY_LISTBOX::OnSelectLibrary(), and SetFootprintFilter().

◆ OnSize()

void EDA_BASE_FRAME::OnSize ( wxSizeEvent &  aEvent)
virtualinherited

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent &  evt)
inherited

Definition at line 69 of file eda_dde.cpp.

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.

References ID_EDA_SOCKET_EVENT, and KIWAY_PLAYER::m_sockets.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent &  aEvent)
protectedinherited

Definition at line 1594 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ onTextFilterChanged()

void CVPCB_MAINFRAME::onTextFilterChanged ( wxCommandEvent &  event)
private

Definition at line 429 of file cvpcb_mainframe.cpp.

References m_filterTimer.

Referenced by ReCreateHToolbar(), setupEventHandlers(), and ~CVPCB_MAINFRAME().

◆ onTextFilterChangedTimer()

◆ OpenProjectFiles()

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

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

Definition at line 692 of file cvpcb_mainframe.cpp.

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )
virtualinherited

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

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_EVENT::getCommandStr(), 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 SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), 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::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), 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 898 of file eda_base_frame.cpp.

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.

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_LIBRARY_MANAGER::addLibrary(), DIALOG_PLOT::applyPlotSettings(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), DIALOG_FOOTPRINT_CHOOSER::build3DCanvas(), buildEquivalenceList(), BuildLibrariesList(), PCB_BASE_FRAME::canCloseWindow(), SIMULATOR_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), PANEL_SETUP_NETCLASSES::checkReload(), KICAD_MANAGER_FRAME::CloseProject(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), 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_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_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), EE_INSPECTION_TOOL::DiffSymbol(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), DisplayStatus(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), BOARD_EDITOR_CONTROL::ExportNetlist(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_EDITOR_CONTROL::ExportView(), BACK_ANNOTATE::FetchNetlistFromPCB(), PANEL_SYMBOL_CHOOSER::FinishSetup(), FIELDS_GRID_TABLE::GetAttr(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), SIMULATOR_CONTROL::getDefaultFilename(), SIMULATOR_CONTROL::getDefaultPath(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_NAVIGATE_TOOL::HypertextCommand(), SCH_EDITOR_CONTROL::ImportFPAssignments(), PANEL_SETUP_RULES::ImportSettingsFrom(), DIALOG_EXPORT_2581::Init(), DIALOG_PLOT::init_Dialog(), DIALOG_EXPORT_SVG::initDialog(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), FIELDS_GRID_TABLE::initGrid(), SIMULATOR_FRAME_UI::InitWorkbook(), EDA_DRAW_FRAME::LibraryFileBrowser(), PCB_BASE_FRAME::loadFootprint(), LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SIMULATOR_FRAME::LoadSettings(), SIMULATOR_FRAME::LoadSimulator(), EDA_BASE_FRAME::LoadWindowState(), SIMULATOR_FRAME_UI::LoadWorkbook(), EDA_3D_VIEWER_FRAME::NewDisplay(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), DIALOG_EXPORT_STEP::onBrowseClicked(), DIALOG_EXPORT_2581::onBrowseClicked(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_IMPORT_NETLIST::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(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_CONFIG_EQUFILES::OnOkClick(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_FIELDS_TABLE::OnOutputFileBrowseClicked(), DIALOG_SCHEMATIC_SETUP::onPageChanged(), DIALOG_BOARD_SETUP::onPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_BASE_FRAME::OnSymChange(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), FOOTPRINT_EDITOR_CONTROL::OpenWithTextEditor(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SYMBOL_EDITOR_CONTROL::PinLibrary(), FOOTPRINT_EDITOR_CONTROL::PinLibrary(), LIB_TREE_MODEL_ADAPTER::PinLibrary(), SCH_DRAWING_TOOLS::PlaceSymbol(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), EDA_DRAW_FRAME::PrintDrawingSheet(), KICAD_MANAGER_FRAME::PrintPrjInfo(), SCH_EDITOR_CONTROL::prunePastedSymbolInstances(), readNetListAndFpFiles(), APPEARANCE_CONTROLS::rebuildNets(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), SIMULATOR_FRAME::ReloadSimulator(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SIMULATOR_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), SIMULATOR_CONTROL::SaveWorkbook(), SIMULATOR_FRAME_UI::SaveWorkbook(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), SCH_BASE_FRAME::SelectSymLibTable(), PCB_BASE_FRAME::setFPWatcher(), GERBVIEW_FRAME::SetPageSettings(), SCH_BASE_FRAME::setSymWatcher(), DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties(), EE_INSPECTION_TOOL::ShowDatasheet(), PANEL_SYMBOL_CHOOSER::showFootprintFor(), COMMON_CONTROL::ShowHelp(), APPEARANCE_CONTROLS::showNetclass(), SCH_EDITOR_CONTROL::SimProbe(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), EDA_3D_VIEWER_FRAME::takeScreenshot(), DIALOG_ERC::testErc(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_ASSIGN_NETCLASS::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), FOOTPRINT_EDITOR_CONTROL::UnpinLibrary(), LIB_TREE_MODEL_ADAPTER::UnpinLibrary(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), SCH_EDITOR_CONTROL::updatePastedSymbol(), SIMULATOR_FRAME::UpdateTitle(), SIMULATOR_FRAME_UI::UpdateTunerValue(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), DIALOG_EXPORT_SVG::~DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), and PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL().

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

References EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::GetAutoSaveInterval(), EDA_BASE_FRAME::isAutoSaveRequired(), EDA_BASE_FRAME::m_autoSavePending, EDA_BASE_FRAME::m_autoSaveTimer, EDA_BASE_FRAME::m_isClosing, EDA_BASE_FRAME::m_supportsAutoSave, Pgm(), and traceAutoSave.

Referenced by SYMBOL_VIEWER_FRAME::onSelectNextSymbol(), SYMBOL_VIEWER_FRAME::onSelectPreviousSymbol(), KIWAY::ProcessEvent(), and KIWAY::SetLanguage().

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )
inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in KICAD_MANAGER_FRAME, and PCB_EDIT_FRAME.

Definition at line 509 of file eda_base_frame.h.

Referenced by KIWAY::ProjectChanged().

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

◆ PushCommandToUndoList()

◆ PushTool()

void TOOLS_HOLDER::PushTool ( const TOOL_EVENT aEvent)
virtualinherited

NB: the definition of "tool" is different at the user level.

The implementation uses a single TOOL_BASE derived class to implement several user "tools", such as rectangle and circle, or wire and bus. So each user-level tool is actually a TOOL_ACTION.

Pushes a tool to the stack.

Parameters
aEventThe event that is starting the tool to be pushed to the stack.

Definition at line 56 of file tools_holder.cpp.

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_EVENT::getCommandStr(), TOOL_ACTION::GetFriendlyName(), TOOLS_HOLDER::m_toolManager, and TOOLS_HOLDER::m_toolStack.

Referenced by EDIT_TOOL::copyToClipboard(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), 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::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), 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().

◆ readNetListAndFpFiles()

◆ readSchematicNetlist()

int CVPCB_MAINFRAME::readSchematicNetlist ( const std::string &  aNetlist)
protected

Read the netlist (.net) file built on the fly by Eeschema.

Parameters
aNetlistis the netlist buffer filled by Eeschema, in KiCad s-expr format. It is the same netlist as the .net file created by Eeschema. (This method is called by readNetListAndFpFiles)

Definition at line 948 of file cvpcb_mainframe.cpp.

References _, NETLIST::Clear(), NETLIST::GetComponent(), NETLIST::GetCount(), COMPONENT::GetFPID(), LIB_ID::GetLibItemName(), KICAD_NETLIST_READER::LoadNetlist(), m_netlist, COMPONENT::SetFPID(), NETLIST::SortByReference(), and IO_ERROR::What().

Referenced by readNetListAndFpFiles().

◆ ReCreateHToolbar()

◆ ReCreateMenuBar()

void EDA_BASE_FRAME::ReCreateMenuBar ( )
inherited

Recreates the menu bar.

Needed when the language or icons are changed

As of wxWidgets 3.2, recreating the menubar from within an event handler of that menubar will result in memory corruption on macOS. In order to minimize the chance of programmer error causing regressions here, we always wrap calls to ReCreateMenuBar in a CallAfter to ensure that they do not occur within the same event handling call stack.

Definition at line 483 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::doReCreateMenuBar(), and EDA_BASE_FRAME::m_isClosing.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), EDA_BASE_FRAME::ClearFileHistory(), EDA_BASE_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_BASE_FRAME::GetFileFromHistory(), EDA_BASE_FRAME::HandleSystemColorChange(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCRIPTING_TOOL::reloadPlugins(), EDA_BASE_FRAME::ShowChangedLanguage(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), and EDA_BASE_FRAME::UpdateFileHistory().

◆ RedoAssociation()

void CVPCB_MAINFRAME::RedoAssociation ( )

Redo the most recently undone association.

Definition at line 570 of file cvpcb_mainframe.cpp.

References AssociateFootprint(), and m_redoList.

Referenced by CVPCB_ASSOCIATION_TOOL::Redo().

◆ refreshAfterSymbolSearch()

◆ RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 162 of file tools_holder.h.

Referenced by ACTION_TOOLBAR::onPaletteEvent(), and ACTION_TOOLBAR::onToolEvent().

◆ RefreshFootprintViewer()

void CVPCB_MAINFRAME::RefreshFootprintViewer ( )

◆ RegisterUIUpdateHandler() [1/2]

void TOOLS_HOLDER::RegisterUIUpdateHandler ( const TOOL_ACTION aAction,
const ACTION_CONDITIONS aConditions 
)
virtualinherited

Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls.

Parameters
aActionis the action to register.
aConditionsare the UI conditions to use for the control states.

Definition at line 42 of file tools_holder.cpp.

References TOOL_ACTION::GetUIId(), and TOOLS_HOLDER::RegisterUIUpdateHandler().

Referenced by ACTION_TOOLBAR::doSelectAction(), TOOLS_HOLDER::RegisterUIUpdateHandler(), and ACTION_MANAGER::SetConditions().

◆ RegisterUIUpdateHandler() [2/2]

void EDA_BASE_FRAME::RegisterUIUpdateHandler ( int  aID,
const ACTION_CONDITIONS aConditions 
)
overridevirtualinherited

Register a UI update handler for the control with ID aID.

Parameters
aIDis the control ID to register the handler for
aConditionsare the UI conditions to use for the control states

Reimplemented from TOOLS_HOLDER.

Definition at line 373 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::HandleUpdateUIEvent(), and EDA_BASE_FRAME::m_uiUpdateMap.

Referenced by BITMAP2CMP_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), EDA_BASE_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::setupUIConditions(), and KICAD_MANAGER_FRAME::setupUIConditions().

◆ SaveFootprintAssociation()

bool CVPCB_MAINFRAME::SaveFootprintAssociation ( bool  doSaveSchematic)

Save the edits that the user has done by sending them back to Eeschema via the kiway.

Optionally saves the schematic to disk as well.

Definition at line 293 of file readwrite_dlgs.cpp.

References _, KIWAY::ExpressMail(), NETLIST::FormatCvpcbNetlist(), FRAME_SCH, STRING_FORMATTER::GetString(), KIWAY_HOLDER::Kiway(), m_modified, m_netlist, MAIL_ASSIGN_FOOTPRINTS, MAIL_SCH_SAVE, and SetStatusText().

Referenced by canCloseWindow(), CVPCB_CONTROL::SaveAssociationsToFile(), and CVPCB_CONTROL::SaveAssociationsToSchematic().

◆ SaveProjectLocalSettings()

virtual void EDA_BASE_FRAME::SaveProjectLocalSettings ( )
inlinevirtualinherited

Save changes to the project local settings.

These settings are used to save/restore the view state for a specific project, and should never contain design data. This method is normally called automatically at various points in the workflow so that the user's most recent display settings are automatically persisted.

The method is virtual so you can override it to call the suitable save method. The base method does nothing.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 365 of file eda_base_frame.h.

◆ saveProjectSettings()

virtual void EDA_BASE_FRAME::saveProjectSettings ( )
inlineprotectedvirtualinherited

Saves any design-related project settings associated with this frame.

This method should only be called as the result of direct user action, for example from an explicit "Save Project" command or as a consequence of saving a design document.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 678 of file eda_base_frame.h.

◆ SaveSettings()

void CVPCB_MAINFRAME::SaveSettings ( APP_SETTINGS_BASE aCfg)
overridevirtual

Save common frame parameters to a configuration data file.

Don't forget to call the base class's SaveSettings() from your derived SaveSettings() otherwise the frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 536 of file cvpcb_mainframe.cpp.

References CVPCB_SETTINGS::m_FilterFlags, m_filteringOptions, CVPCB_SETTINGS::m_FilterString, m_footprintListBox, CVPCB_SETTINGS::m_FootprintsWidth, m_librariesListBox, CVPCB_SETTINGS::m_LibrariesWidth, m_tcFilterString, and EDA_BASE_FRAME::SaveSettings().

◆ SaveWindowSettings()

◆ SendComponentSelectionToSch()

void CVPCB_MAINFRAME::SendComponentSelectionToSch ( bool  aClearSelectionOnly = false)

Send a remote command to Eeschema via a socket,.

Commands are: $PART: "reference" put cursor on component anchor

Parameters
aClearSelectionOnlyuse true if the message to send is only "clear clear selection" (used when exiting CvPcb)

Definition at line 908 of file cvpcb_mainframe.cpp.

References CTX_IPC, EscapeString(), KIWAY::ExpressMail(), FRAME_SCH, NETLIST::GetComponent(), COMPONENT::GetReference(), ITEMS_LISTBOX_BASE::GetSelection(), NETLIST::IsEmpty(), Kiface(), KIWAY_HOLDER::Kiway(), m_netlist, m_symbolsListBox, MAIL_SELECTION, MSG_TO_SCH, and SendCommand().

Referenced by doCloseWindow(), refreshAfterSymbolSearch(), and SetSelectedComponent().

◆ SetFocusedControl()

void CVPCB_MAINFRAME::SetFocusedControl ( CVPCB_MAINFRAME::CONTROL_TYPE  aControl)

Set the focus to a specific control.

Parameters
aControlthe control to set focus to

Definition at line 1156 of file cvpcb_mainframe.cpp.

References CONTROL_COMPONENT, CONTROL_FOOTPRINT, CONTROL_LIBRARY, m_footprintListBox, m_librariesListBox, and m_symbolsListBox.

Referenced by CVPCB_CONTROL::ChangeFocus().

◆ SetFootprintFilter()

void CVPCB_MAINFRAME::SetFootprintFilter ( FOOTPRINTS_LISTBOX::FP_FILTER_T  aFilter,
CVPCB_MAINFRAME::CVPCB_FILTER_ACTION  aAction 
)

Set a filter criteria to either on/off or toggle the criteria.

Parameters
aFilterThe filter to modify
aActionWhat action (on, off or toggle) to take

Definition at line 742 of file cvpcb_mainframe.cpp.

References FILTER_DISABLE, FILTER_ENABLE, FILTER_TOGGLE, m_filteringOptions, and OnSelectComponent().

Referenced by LIBRARY_LISTBOX::OnSelectLibrary(), and CVPCB_CONTROL::ToggleFootprintFilter().

◆ SetKiway()

void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
aKiwayis often from a parent window or from KIFACE::CreateKiWindow().

Definition at line 43 of file kiway_holder.cpp.

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by PCB::IFACE::CreateKiWindow(), InvokePcbLibTableEditor(), and InvokeSchEditSymbolLibTable().

◆ SetMenuBar()

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool  aIsModal)
inlineinherited

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString &  aPath)
inlineinherited

◆ SetSelectedComponent()

void CVPCB_MAINFRAME::SetSelectedComponent ( int  aIndex,
bool  aSkipUpdate = false 
)

Set the currently selected component in the components listbox.

Parameters
aIndexthe index of the component to select, -1 to clear selection
aSkipUpdateskips running the OnSelectComponent event to update the other windows

Definition at line 1056 of file cvpcb_mainframe.cpp.

References ITEMS_LISTBOX_BASE::DeselectAll(), m_skipComponentSelect, m_symbolsListBox, SendComponentSelectionToSch(), and SYMBOLS_LISTBOX::SetSelection().

Referenced by CVPCB_ASSOCIATION_TOOL::DeleteAll(), and CVPCB_CONTROL::ToNA().

◆ SetStatusText()

void CVPCB_MAINFRAME::SetStatusText ( const wxString &  aText,
int  aNumber = 0 
)
override

◆ setupEventHandlers()

◆ setupTools()

◆ setupUIConditions()

◆ SetUserUnits()

◆ ShowChangedLanguage()

void CVPCB_MAINFRAME::ShowChangedLanguage ( )
overridevirtual

Reimplemented from TOOLS_HOLDER.

Definition at line 1188 of file cvpcb_mainframe.cpp.

References DisplayStatus(), ReCreateHToolbar(), and EDA_BASE_FRAME::ShowChangedLanguage().

◆ ShowInfoBarError() [1/2]

void EDA_BASE_FRAME::ShowInfoBarError ( const wxString &  aErrorMsg,
bool  aShowCloseButton,
std::function< void(void)>  aCallback 
)
inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

The infobar will be closed after a timeout.

This version accepts a callback which will be called when the infobar is dismissed (either as a result of user action or a timeout). This can be useful when the caller wants to make other decorations in the canvas to highlight the error.

Parameters
aErrorMsgis the message to display.
aShowCloseButtontrue to show a close button on the right of the WX_INFOBAR.
aCallbacka callback to be called when the infobar is dismissed.

Definition at line 944 of file eda_base_frame.cpp.

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), WX_INFOBAR::SetCallback(), and WX_INFOBAR::ShowMessageFor().

◆ ShowInfoBarError() [2/2]

void EDA_BASE_FRAME::ShowInfoBarError ( const wxString &  aErrorMsg,
bool  aShowCloseButton = false,
WX_INFOBAR::MESSAGE_TYPE  aType = WX_INFOBAR::MESSAGE_TYPE::GENERIC 
)
inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

The infobar will be closed after a timeout.

Parameters
aErrorMsgis the message to display.
aShowCloseButtontrue to show a close button on the right of the WX_INFOBAR.

Definition at line 932 of file eda_base_frame.cpp.

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), MICROWAVE_TOOL::createInductorBetween(), PCB_BASE_EDIT_FRAME::createNewLibrary(), MICROWAVE_TOOL::createPolygonShape(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), EDIT_TOOL::DeleteItems(), BOARD_INSPECTION_TOOL::DiffFootprint(), EE_INSPECTION_TOOL::DiffSymbol(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawVia(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_NAVIGATE_TOOL::HypertextCommand(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), ROUTER_TOOL::performRouting(), ROUTER_TOOL::prepareInteractive(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SYMBOL_EDIT_FRAME::saveLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), EE_INSPECTION_TOOL::ShowDatasheet(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields(), SCH_PROPERTIES_PANEL::valueChanging(), and PCB_PROPERTIES_PANEL::valueChanging().

◆ ShowInfoBarMsg()

void EDA_BASE_FRAME::ShowInfoBarMsg ( const wxString &  aMsg,
bool  aShowCloseButton = false 
)
inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters
aErrorMsgis the message to display.
aShowCloseButtontrue to show a close button on the right of the WX_INFOBAR.

Definition at line 970 of file eda_base_frame.cpp.

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_MOVE_TOOL::doMoveSelection(), SCH_DRAWING_TOOLS::DrawSheet(), EDIT_TOOL::FilletTracks(), PL_EDIT_TOOL::Main(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DIALOG_FIND::search(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ShowInfoBarWarning()

void EDA_BASE_FRAME::ShowInfoBarWarning ( const wxString &  aWarningMsg,
bool  aShowCloseButton = false 
)
inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters
aErrorMsgis the message to display.
aShowCloseButtontrue to show a close button on the right of the WX_INFOBAR.

Definition at line 959 of file eda_base_frame.cpp.

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by DRAWING_TOOL::PlaceTuningPattern(), and SCH_EDIT_TOOL::RepeatDrawItem().

◆ ShowModal()

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

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

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

Parameters
aResultif not NULL, indicates a place to put a resultant string.
aResultantFocusWindowif not NULL, indicates what window to pass focus to on return.
Returns
true if frame implementation called KIWAY_PLAYER::DismissModal() with aRetVal of true.

Reimplemented in FOOTPRINT_CHOOSER_FRAME, SYMBOL_CHOOSER_FRAME, and SYMBOL_DIFF_FRAME.

Definition at line 81 of file kiway_player.cpp.

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

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

◆ ShowPreferences()

void EDA_BASE_FRAME::ShowPreferences ( wxString  aStartPage,
wxString  aStartParentPage 
)
inherited

Displays the preferences and settings of all opened editors paged dialog, starting with a particular page.

Definition at line 1070 of file eda_base_frame.cpp.

References _, PANEL_HOTKEYS_EDITOR::ActionsList(), WX_TREEBOOK::AddLazyPage(), WX_TREEBOOK::AddLazySubPage(), KIWAY::CommonSettingsChanged(), KIWAY::FACE_GERBVIEW, KIWAY::FACE_PCB, KIWAY::FACE_PL_EDITOR, KIWAY::FACE_SCH, FRAME_FOOTPRINT_EDITOR, FRAME_GERBER, FRAME_PCB_DISPLAY3D, FRAME_PCB_EDITOR, FRAME_PL_EDITOR, FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, KIWAY::GetActions(), KIFACE_BASE::GetActions(), ADVANCED_CFG::GetCfg(), EDA_BASE_FRAME::GetFrameType(), PGM_BASE::GetSettingsManager(), PAGED_DIALOG::GetTreebook(), kiface(), KIWAY::KiFACE(), KIWAY_HOLDER::Kiway(), LAZY_CTOR, ADVANCED_CFG::m_EnableGit, TOOLS_HOLDER::m_toolManager, PANEL_3DV_DISPLAY_OPTIONS, PANEL_3DV_OPENGL, PANEL_3DV_RAYTRACING, PANEL_DS_COLORS, PANEL_DS_DISPLAY_OPTIONS, PANEL_DS_GRIDS, PANEL_FP_COLORS, PANEL_FP_DEFAULT_VALUES, PANEL_FP_DISPLAY_OPTIONS, PANEL_FP_EDIT_OPTIONS, PANEL_FP_GRIDS, PANEL_FP_ORIGINS_AXES, PANEL_GBR_COLORS, PANEL_GBR_DISPLAY_OPTIONS, PANEL_GBR_EXCELLON_OPTIONS, PANEL_GBR_GRIDS, PANEL_PCB_ACTION_PLUGINS, PANEL_PCB_COLORS, PANEL_PCB_DISPLAY_OPTS, PANEL_PCB_EDIT_OPTIONS, PANEL_PCB_GRIDS, 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_SCH_GRIDS, PANEL_SCH_SIMULATOR, PANEL_SYM_COLORS, PANEL_SYM_DISP_OPTIONS, PANEL_SYM_EDIT_GRIDS, PANEL_SYM_EDIT_OPTIONS, Pgm(), ReadHotKeyConfigIntoActions(), TOOL_BASE::REDRAW, TOOL_MANAGER::ResetTools(), SETTINGS_MANAGER::Save(), and PAGED_DIALOG::SetInitialPage().

Referenced by COMMON_TOOLS::GridProperties(), EDA_BASE_FRAME::OnPreferences(), APPEARANCE_CONTROLS::onReadOnlySwatch(), and COMMON_CONTROL::OpenPreferences().

◆ StringFromValue() [1/2]

wxString UNITS_PROVIDER::StringFromValue ( const EDA_ANGLE aValue,
bool  aAddUnitLabel = false 
) const
inlineinherited

◆ StringFromValue() [2/2]

wxString UNITS_PROVIDER::StringFromValue ( double  aValue,
bool  aAddUnitLabel = false,
EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE 
) const
inlineinherited

Converts aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters
aValue= value in internal units
aAddUnitLabel= true to add symbol unit to the string value
aTypeis the type of this value, and controls the way the value is converted to a string, and the suitable unit
Returns
A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 81 of file units_provider.h.

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

Referenced by DIALOG_PLOT::applyPlotSettings(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRAWING_TOOL::DrawSpecificationStackup(), VALIDATION_ERROR_TOO_LARGE< T >::Format(), VALIDATION_ERROR_TOO_SMALL< T >::Format(), DRC_TEST_PROVIDER::formatMsg(), PIN_TABLE_DATA_MODEL::GetValue(), FIELDS_GRID_TABLE::GetValue(), PCB_FIELDS_GRID_TABLE::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), reportMax(), reportMin(), reportOpt(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), WX_GRID::SetUnitValue(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), PANEL_FP_EDITOR_DEFAULTS::TransferDataFromWindow(), PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ sys_search()

const SEARCH_STACK & EDA_BASE_FRAME::sys_search ( )
virtualinherited

Return a SEARCH_STACK pertaining to entire program.

This is overloaded in KICAD_MANAGER_FRAME

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 886 of file eda_base_frame.cpp.

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

◆ ThemeChanged()

void EDA_BASE_FRAME::ThemeChanged ( )
virtualinherited

◆ ToggleUserUnits()

virtual void EDA_BASE_FRAME::ToggleUserUnits ( )
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 127 of file eda_base_frame.h.

Referenced by DIALOG_SHIM::OnCharHook().

◆ ToolStackIsEmpty()

◆ UndoAssociation()

void CVPCB_MAINFRAME::UndoAssociation ( )

Undo the most recent associations that were performed.

Definition at line 549 of file cvpcb_mainframe.cpp.

References AssociateFootprint(), m_redoList, and m_undoList.

Referenced by CVPCB_ASSOCIATION_TOOL::Undo().

◆ unitsChangeRefresh()

virtual void EDA_BASE_FRAME::unitsChangeRefresh ( )
inlineprotectedvirtualinherited

Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them.

The default version only updates the status bar. Don't forget to call the default in your derived class or the status bar will not get updated properly.

Reimplemented in SCH_EDIT_FRAME, GERBVIEW_FRAME, EDA_DRAW_FRAME, PCB_BASE_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 656 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::ChangeUserUnits().

◆ UnregisterUIUpdateHandler() [1/2]

void TOOLS_HOLDER::UnregisterUIUpdateHandler ( const TOOL_ACTION aAction)
virtualinherited

Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.

Parameters
aActionis the action to unregister the handler for.

Definition at line 49 of file tools_holder.cpp.

References TOOL_ACTION::GetUIId(), and TOOLS_HOLDER::UnregisterUIUpdateHandler().

Referenced by ACTION_TOOLBAR::doSelectAction(), ACTION_MANAGER::SetConditions(), and TOOLS_HOLDER::UnregisterUIUpdateHandler().

◆ UnregisterUIUpdateHandler() [2/2]

void EDA_BASE_FRAME::UnregisterUIUpdateHandler ( int  aID)
overridevirtualinherited

Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler.

Parameters
aIDis the control ID to unregister the handler for

Reimplemented from TOOLS_HOLDER.

Definition at line 386 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::m_uiUpdateMap.

◆ UpdateFileHistory()

void EDA_BASE_FRAME::UpdateFileHistory ( const wxString &  FullFileName,
FILE_HISTORY aFileHistory = nullptr 
)
inherited

◆ updateFootprintViewerOnIdle()

◆ UpdateStatusBar()

virtual void EDA_BASE_FRAME::UpdateStatusBar ( )
inlinevirtualinherited

Update the status bar information.

The status bar can draw itself. This is not a drawing function per se, but rather updates lines of text held by the components within the status bar which is owned by the wxFrame.

Reimplemented in SCH_BASE_FRAME, GERBVIEW_FRAME, EDA_DRAW_FRAME, PCB_BASE_FRAME, and PL_EDITOR_FRAME.

Definition at line 488 of file eda_base_frame.h.

Referenced by TOOL_MANAGER::UpdateUI().

◆ ValueFromString()

◆ windowClosing()

void EDA_BASE_FRAME::windowClosing ( wxCloseEvent &  event)
privateinherited

(with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings().

SaveSettings() is called for all derived wxFrames in this base class overload. Calling it from a destructor is deprecated since the wxFrame's position is not available in the destructor on linux. In other words, you should not need to call SaveSettings() anywhere, except in this one function found only in this class.

Definition at line 219 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::canCloseWindow(), EDA_BASE_FRAME::config(), WX_INFOBAR::Dismiss(), EDA_BASE_FRAME::doCloseWindow(), EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::IsModal(), EDA_BASE_FRAME::m_infoBar, EDA_BASE_FRAME::m_isClosing, EDA_BASE_FRAME::m_isNonUserClose, and EDA_BASE_FRAME::SaveSettings().

Referenced by EDA_BASE_FRAME::commonInit().

Friends And Related Function Documentation

◆ CV::IFACE

friend struct CV::IFACE
friend

Definition at line 387 of file cvpcb_mainframe.h.

Member Data Documentation

◆ KICAD_AUI_TB_STYLE

◆ m_aboutTitle

◆ m_acceptedExts

std::map<const wxString, TOOL_ACTION*> EDA_BASE_FRAME::m_acceptedExts
protectedinherited

◆ m_AcceptedFiles

◆ m_actions

◆ m_appearancePanel

◆ m_auimgr

wxAuiManager EDA_BASE_FRAME::m_auimgr
protectedinherited

Definition at line 749 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::CreateInfoBar(), CVPCB_MAINFRAME(), SCH_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::doCloseWindow(), EDA_BASE_FRAME::FinishAUIInitialization(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FOOTPRINT_EDIT_FRAME::IsSearchTreeShown(), SYMBOL_EDIT_FRAME::IsSymbolTreeShown(), PCB_EDIT_FRAME::LayerManagerShown(), PCB_EDIT_FRAME::NetInspectorShown(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnResizeHierarchyNavigator(), SCH_EDIT_FRAME::onResizeNetNavigator(), SYMBOL_VIEWER_FRAME::OnSize(), KICAD_MANAGER_FRAME::OnSize(), FOOTPRINT_VIEWER_FRAME::OnSize(), FOOTPRINT_WIZARD_FRAME::OnSize(), SYMBOL_EDIT_FRAME::OnToggleSymbolTree(), EDA_DRAW_FRAME::OnToolbarSizeChanged(), KICAD_MANAGER_FRAME::onToolbarSizeChanged(), PCB_EDIT_FRAME::PropertiesShown(), GERBVIEW_FRAME::ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), KICAD_MANAGER_FRAME::RecreateBaseHToolbar(), ReCreateHToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), SYMBOL_EDIT_FRAME::ReCreateHToolbar(), SYMBOL_VIEWER_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), EDA_3D_VIEWER_FRAME::ReCreateMainToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_FRAME::ReCreateOptToolbar(), GERBVIEW_FRAME::ReCreateOptToolbar(), PL_EDITOR_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateVToolbar(), SYMBOL_EDIT_FRAME::ReCreateVToolbar(), PL_EDITOR_FRAME::ReCreateVToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateVToolbar(), PCB_EDIT_FRAME::ReCreateVToolbar(), GERBVIEW_FRAME::ReFillLayerWidget(), refreshAfterSymbolSearch(), SCH_EDIT_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), FOOTPRINT_WIZARD_FRAME::SaveSettings(), PCB_EDIT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveWindowSettings(), PCB_BASE_FRAME::SetDrawBgColor(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), GERBVIEW_FRAME::ShowChangedLanguage(), EDA_DRAW_FRAME::ShowChangedLanguage(), FOOTPRINT_EDIT_FRAME::ShowChangedLanguage(), PCB_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), EDA_BASE_FRAME::ThemeChanged(), EDA_3D_VIEWER_FRAME::ToggleAppearanceManager(), GERBVIEW_FRAME::ToggleLayerManager(), FOOTPRINT_EDIT_FRAME::ToggleLayersManager(), PCB_EDIT_FRAME::ToggleLayersManager(), PCB_EDIT_FRAME::ToggleNetInspector(), SCH_EDIT_FRAME::ToggleNetNavigator(), SCH_EDIT_FRAME::ToggleProperties(), SYMBOL_EDIT_FRAME::ToggleProperties(), PCB_BASE_EDIT_FRAME::ToggleProperties(), SCH_EDIT_FRAME::ToggleSchematicHierarchy(), SCH_EDIT_FRAME::ToggleSearch(), PCB_EDIT_FRAME::ToggleSearch(), FOOTPRINT_EDIT_FRAME::ToggleSearchTree(), GERBVIEW_FRAME::updateDCodeSelectBox(), SCH_EDIT_FRAME::updateSelectionFilterVisbility(), SYMBOL_EDIT_FRAME::updateSelectionFilterVisbility(), GERBVIEW_FRAME::UpdateTitleAndInfo(), ~CVPCB_MAINFRAME(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), and KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME().

◆ m_autoSavePending

bool EDA_BASE_FRAME::m_autoSavePending
protectedinherited

◆ m_autoSaveRequired

◆ m_autoSaveTimer

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer
protectedinherited

◆ m_cannotClose

bool CVPCB_MAINFRAME::m_cannotClose
protected

Definition at line 383 of file cvpcb_mainframe.h.

Referenced by canCloseWindow(), CVPCB_MAINFRAME(), and KiwayMailIn().

◆ m_configName

wxString EDA_BASE_FRAME::m_configName
protectedinherited

Definition at line 753 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::ConfigBaseName().

◆ m_displayIndex

int EDA_BASE_FRAME::m_displayIndex
protectedinherited

Definition at line 741 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::LoadWindowState(), and EDA_BASE_FRAME::OnSize().

◆ m_dragAction

MOUSE_DRAG_ACTION TOOLS_HOLDER::m_dragAction
protectedinherited

◆ m_dummySelection

SELECTION TOOLS_HOLDER::m_dummySelection
protectedinherited

Definition at line 171 of file tools_holder.h.

Referenced by TOOLS_HOLDER::GetCurrentSelection().

◆ m_fileHistory

◆ m_filteringOptions

int CVPCB_MAINFRAME::m_filteringOptions
private

◆ m_filterTimer

wxTimer* CVPCB_MAINFRAME::m_filterTimer
private

◆ m_footprintContextMenu

ACTION_MENU* CVPCB_MAINFRAME::m_footprintContextMenu
private

Definition at line 404 of file cvpcb_mainframe.h.

Referenced by setupEventHandlers(), and setupTools().

◆ m_footprintListBox

◆ m_FootprintsList

◆ m_framePos

wxPoint EDA_BASE_FRAME::m_framePos
protectedinherited

◆ m_frameSize

◆ m_ident

◆ m_immediateActions

bool TOOLS_HOLDER::m_immediateActions
protectedinherited

◆ m_infoBar

◆ m_initialized

bool CVPCB_MAINFRAME::m_initialized
protected

Definition at line 382 of file cvpcb_mainframe.h.

Referenced by CVPCB_MAINFRAME(), and DisplayStatus().

◆ m_isClosing

◆ m_isNonUserClose

bool EDA_BASE_FRAME::m_isNonUserClose
protectedinherited

◆ m_iuScale

const EDA_IU_SCALE& UNITS_PROVIDER::m_iuScale
privateinherited

Definition at line 147 of file units_provider.h.

Referenced by UNITS_PROVIDER::GetIuScale().

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway
privateinherited

Definition at line 86 of file kiway_holder.h.

Referenced by KIWAY_HOLDER::SetKiway().

◆ m_librariesListBox

◆ m_mainToolBar

ACTION_TOOLBAR* CVPCB_MAINFRAME::m_mainToolBar
private

Definition at line 391 of file cvpcb_mainframe.h.

Referenced by CVPCB_MAINFRAME(), and ReCreateHToolbar().

◆ m_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault
protectedinherited

◆ m_modal

bool KIWAY_PLAYER::m_modal
protectedinherited

Definition at line 190 of file kiway_player.h.

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

◆ m_modal_loop

wxGUIEventLoop* KIWAY_PLAYER::m_modal_loop
protectedinherited

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

Definition at line 193 of file kiway_player.h.

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

◆ m_modal_resultant_parent

wxWindow* KIWAY_PLAYER::m_modal_resultant_parent
protectedinherited

Definition at line 194 of file kiway_player.h.

Referenced by KIWAY_PLAYER::ShowModal().

◆ m_modal_ret_val

bool KIWAY_PLAYER::m_modal_ret_val
protectedinherited

◆ m_modal_string

wxString KIWAY_PLAYER::m_modal_string
protectedinherited

Definition at line 195 of file kiway_player.h.

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

◆ m_modified

bool CVPCB_MAINFRAME::m_modified
protected

◆ m_moveWarpsCursor

bool TOOLS_HOLDER::m_moveWarpsCursor
protectedinherited

◆ m_mruPath

◆ m_netlist

◆ m_normalFramePos

wxPoint EDA_BASE_FRAME::m_normalFramePos
protectedinherited

◆ m_normalFrameSize

wxSize EDA_BASE_FRAME::m_normalFrameSize
protectedinherited

◆ m_originTransforms

ORIGIN_TRANSFORMS EDA_BASE_FRAME::m_originTransforms
protectedinherited

Definition at line 771 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::GetOriginTransforms().

◆ m_perspective

wxString EDA_BASE_FRAME::m_perspective
protectedinherited

Definition at line 750 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::LoadWindowSettings().

◆ m_redoList

CVPCB_UNDO_REDO_LIST CVPCB_MAINFRAME::m_redoList
private

◆ m_saveAndContinue

wxButton* CVPCB_MAINFRAME::m_saveAndContinue
private

Definition at line 399 of file cvpcb_mainframe.h.

Referenced by CVPCB_MAINFRAME(), and setupEventHandlers().

◆ m_settingsManager

SETTINGS_MANAGER* EDA_BASE_FRAME::m_settingsManager
protectedinherited

Definition at line 756 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::GetSettingsManager().

◆ m_skipComponentSelect

bool CVPCB_MAINFRAME::m_skipComponentSelect
protected

◆ m_sockets

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

interprocess communication

Definition at line 199 of file kiway_player.h.

Referenced by KIWAY_PLAYER::OnSockRequestServer().

◆ m_socketServer

wxSocketServer* KIWAY_PLAYER::m_socketServer
protectedinherited

Definition at line 198 of file kiway_player.h.

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

◆ m_statusLine1

wxStaticText* CVPCB_MAINFRAME::m_statusLine1
private

Definition at line 396 of file cvpcb_mainframe.h.

Referenced by CVPCB_MAINFRAME(), and SetStatusText().

◆ m_statusLine2

wxStaticText* CVPCB_MAINFRAME::m_statusLine2
private

Definition at line 397 of file cvpcb_mainframe.h.

Referenced by CVPCB_MAINFRAME(), and SetStatusText().

◆ m_statusLine3

wxStaticText* CVPCB_MAINFRAME::m_statusLine3
private

Definition at line 398 of file cvpcb_mainframe.h.

Referenced by CVPCB_MAINFRAME(), and SetStatusText().

◆ m_supportsAutoSave

bool EDA_BASE_FRAME::m_supportsAutoSave
protectedinherited

◆ m_symbolsContextMenu

ACTION_MENU* CVPCB_MAINFRAME::m_symbolsContextMenu
private

Definition at line 405 of file cvpcb_mainframe.h.

Referenced by setupEventHandlers(), and setupTools().

◆ m_symbolsListBox

◆ m_tcFilterString

wxTextCtrl* CVPCB_MAINFRAME::m_tcFilterString
private

◆ m_toolDispatcher

TOOL_DISPATCHER* CVPCB_MAINFRAME::m_toolDispatcher
private

Definition at line 401 of file cvpcb_mainframe.h.

Referenced by setupEventHandlers(), setupTools(), and ~CVPCB_MAINFRAME().

◆ m_toolManager

TOOL_MANAGER* TOOLS_HOLDER::m_toolManager
protectedinherited

Definition at line 167 of file tools_holder.h.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), SCH_EDIT_FRAME::AddSheetAndUpdateDisplay(), EDA_BASE_FRAME::AddStandardHelpMenu(), EDA_DRAW_FRAME::AddStandardSubMenus(), SCH_EDIT_FRAME::AnnotateSymbols(), PCB_EDIT_FRAME::CanAcceptApiCommands(), SCH_EDIT_FRAME::canCloseWindow(), PCB_EDIT_FRAME::canCloseWindow(), FOOTPRINT_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::CheckAnnotate(), GERBVIEW_FRAME::Clear_DrawLayers(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SIMULATOR_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), CVPCB_MAINFRAME(), SYMBOL_VIEWER_FRAME::DClickOnSymbolList(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_FRAME::DisplayCurrentSheet(), EDA_DRAW_FRAME::DisplayGridMsg(), SCH_EDIT_FRAME::doCloseWindow(), GERBVIEW_FRAME::doCloseWindow(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), BITMAP2CMP_FRAME::doReCreateMenuBar(), doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SIMULATOR_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), PCB_CALCULATOR_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), EDA_BASE_FRAME::DoWithAcceptedFiles(), GERBVIEW_FRAME::DoWithAcceptedFiles(), KICAD_MANAGER_FRAME::DoWithAcceptedFiles(), SYMBOL_EDIT_FRAME::DuplicateSymbol(), SCH_EDIT_FRAME::EditSheetProperties(), SYMBOL_EDIT_FRAME::emptyScreen(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::FlipBodyStyle(), DISPLAY_FOOTPRINTS_FRAME::GetCurrentSelection(), SCH_EDIT_FRAME::GetCurrentSelection(), SYMBOL_EDIT_FRAME::GetCurrentSelection(), SYMBOL_VIEWER_FRAME::GetCurrentSelection(), GERBVIEW_FRAME::GetCurrentSelection(), PL_EDITOR_FRAME::GetCurrentSelection(), FOOTPRINT_EDIT_FRAME::GetCurrentSelection(), FOOTPRINT_VIEWER_FRAME::GetCurrentSelection(), PCB_EDIT_FRAME::GetCurrentSelection(), TOOLS_HOLDER::GetToolManager(), EDA_DRAW_FRAME::GetUnitPair(), SCH_EDIT_FRAME::HardRedraw(), SYMBOL_EDIT_FRAME::HardRedraw(), PL_EDITOR_FRAME::HardRedraw(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::initScreenZoom(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PCB_EDIT_FRAME::onBoardLoaded(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_EDIT_FRAME::OnFindDialogClose(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), SCH_EDIT_FRAME::OnImportProject(), PL_EDITOR_FRAME::OnNewDrawingSheet(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), EDA_DRAW_FRAME::OnSelectGrid(), SYMBOL_EDIT_FRAME::OnSelectUnit(), EDA_DRAW_FRAME::OnSelectZoom(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::RebuildAndRefresh(), SYMBOL_EDIT_FRAME::RebuildView(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_FRAME::ReCreateOptToolbar(), PL_EDITOR_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateVToolbar(), PCB_EDIT_FRAME::ReCreateVToolbar(), SCH_BASE_FRAME::RefreshZoomDependentItems(), FOOTPRINT_WIZARD_FRAME::RegenerateFootprint(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SYMBOL_EDIT_FRAME::saveLibrary(), EDA_DRAW_FRAME::SaveSettings(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_BASE_FRAME::SCH_BASE_FRAME(), SCH_EDIT_FRAME::SchematicCleanUp(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_EDIT_FRAME::SelectUnit(), GERBVIEW_FRAME::SetActiveLayer(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), SCH_EDIT_FRAME::SetAltPinFunction(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_TEST_FRAME_BASE::SetBoard(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SCH_EDIT_FRAME::SetScreen(), SYMBOL_EDIT_FRAME::SetScreen(), PCB_TEST_FRAME_BASE::SetSelectionHook(), setupTools(), SCH_EDIT_FRAME::setupTools(), SIMULATOR_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), EDA_3D_VIEWER_FRAME::setupUIConditions(), setupUIConditions(), DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SIMULATOR_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), KICAD_MANAGER_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), FOOTPRINT_VIEWER_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowFindDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), EDA_BASE_FRAME::ShowPreferences(), PCB_BASE_EDIT_FRAME::ShowReferenceImagePropertiesDialog(), SCH_BASE_FRAME::SyncView(), EDA_DRAW_FRAME::ToggleUserUnits(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), EDA_DRAW_FRAME::unitsChangeRefresh(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), SCH_EDIT_FRAME::UpdateHierarchyNavigator(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_EDIT_FRAME::UpdateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), EDA_DRAW_FRAME::Zoom_Automatique(), ~CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), FOOTPRINT_EDIT_FRAME::~FOOTPRINT_EDIT_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME(), PCB_EDIT_FRAME::~PCB_EDIT_FRAME(), PL_EDITOR_FRAME::~PL_EDITOR_FRAME(), SYMBOL_DIFF_FRAME::~SYMBOL_DIFF_FRAME(), SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::~SYMBOL_VIEWER_FRAME().

◆ m_toolStack

std::vector<std::string> TOOLS_HOLDER::m_toolStack
protectedinherited

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type
privateinherited

Definition at line 87 of file kiway_holder.h.

◆ m_uiUpdateMap

std::map<int, UIUpdateHandler> EDA_BASE_FRAME::m_uiUpdateMap
protectedinherited

< Map containing the UI update handlers registered with wx for each action.

Set by the close window event handler after frames are asked if they can close. Allows other functions when called to know our state is cleanup.

Definition at line 774 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler(), and EDA_BASE_FRAME::UnregisterUIUpdateHandler().

◆ m_undoList

CVPCB_UNDO_REDO_LIST CVPCB_MAINFRAME::m_undoList
private

Definition at line 407 of file cvpcb_mainframe.h.

Referenced by AssociateFootprint(), GetUndoCommandCount(), and UndoAssociation().

◆ m_undoRedoCountMax

int EDA_BASE_FRAME::m_undoRedoCountMax
protectedinherited

◆ m_userUnits

EDA_UNITS UNITS_PROVIDER::m_userUnits
privateinherited

Definition at line 148 of file units_provider.h.

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

◆ m_viewerPendingUpdate

bool CVPCB_MAINFRAME::m_viewerPendingUpdate
private

Definition at line 411 of file cvpcb_mainframe.h.

Referenced by RefreshFootprintViewer(), and updateFootprintViewerOnIdle().


The documentation for this class was generated from the following files: