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

The symbol library editor main window. More...

#include <symbol_edit_frame.h>

Inheritance diagram for SYMBOL_EDIT_FRAME:
SCH_BASE_FRAME EDA_DRAW_FRAME SCHEMATIC_HOLDER KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER UNITS_PROVIDER

Public Types

enum  UNDO_REDO_LIST { UNDO_LIST , REDO_LIST }
 Specify whether we are interacting with the undo or redo stacks. More...
 
enum  HOLDER_TYPE { DIALOG , FRAME , PANEL }
 

Public Member Functions

 SYMBOL_EDIT_FRAME (KIWAY *aKiway, wxWindow *aParent)
 
 ~SYMBOL_EDIT_FRAME () override
 
std::unique_ptr< GRID_HELPERMakeGridHelper () override
 
void SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) override
 Switch currently used canvas ( Cairo / OpenGL).
 
bool IsContentModified () const override
 Get if any symbols or libraries have been modified but not saved.
 
bool HasLibModifications () const
 Check if any pending libraries have been modified.
 
bool CanCloseSymbolFromSchematic (bool doClose)
 
wxString GetCurLib () const
 The nickname of the current library being edited and empty string if none.
 
wxString SetCurLib (const wxString &aLibNickname)
 Set the current library nickname and returns the old library nickname.
 
LIB_TREEGetLibTree () const override
 
LIB_ID GetTreeLIBID (int *aUnit=nullptr) const
 Return the LIB_ID of the library or symbol selected in the symbol tree.
 
int GetTreeSelectionCount () const
 
int GetTreeLIBIDs (std::vector< LIB_ID > &aSelection) const
 
LIB_SYMBOLGetCurSymbol () const
 Return the current symbol being edited or NULL if none selected.
 
void SetCurSymbol (LIB_SYMBOL *aSymbol, bool aUpdateZoom)
 Take ownership of aSymbol and notes that it is the one currently being edited.
 
LIB_SYMBOL_LIBRARY_MANAGERGetLibManager ()
 
SELECTIONGetCurrentSelection () override
 Get the current selection from the canvas area.
 
bool SynchronizePins ()
 
wxString AddLibraryFile (bool aCreateNew)
 Create or add an existing library to the symbol library table.
 
void DdAddLibrary (wxString aLibFile)
 Add a library dropped file to the symbol library table.
 
void CreateNewSymbol (const wxString &newName=wxEmptyString)
 Create a new symbol in the selected library.
 
void ImportSymbol ()
 
void ExportSymbol ()
 
void Save ()
 Save the selected symbol or library.
 
void SaveSymbolCopyAs (bool aOpenCopy)
 Save the currently selected symbol to a new name and/or location.
 
void SaveLibraryAs ()
 Save the currently selected library to a new file.
 
void SaveAll ()
 Save all modified symbols and libraries.
 
void Revert (bool aConfirm=true)
 Revert unsaved changes in a symbol, restoring to the last saved state.
 
void RevertAll ()
 
void DeleteSymbolFromLibrary ()
 
void CopySymbolToClipboard ()
 
void LoadSymbol (const wxString &aLibrary, const wxString &aSymbol, int Unit)
 
void DuplicateSymbol (bool aFromClipboard)
 Insert a duplicate symbol.
 
void OnSelectUnit (wxCommandEvent &event)
 
void OnSelectBodyStyle (wxCommandEvent &event)
 
void ToggleProperties () override
 
void ToggleLibraryTree () override
 
bool IsLibraryTreeShown () const override
 
void FocusLibraryTreeInput () override
 
void FreezeLibraryTree ()
 
void ThawLibraryTree ()
 
void OnUpdateUnitNumber (wxUpdateUIEvent &event)
 
void OnUpdateBodyStyle (wxUpdateUIEvent &event)
 
void UpdateAfterSymbolProperties (wxString *aOldName=nullptr)
 
void RebuildSymbolUnitAndBodyStyleLists ()
 
bool canCloseWindow (wxCloseEvent &aCloseEvent) override
 
void doCloseWindow () override
 
void OnExitKiCad (wxCommandEvent &event)
 
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.
 
SYMBOL_EDITOR_SETTINGSGetSettings () const
 
APP_SETTINGS_BASEconfig () const override
 Return the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
 
COLOR_SETTINGSGetColorSettings (bool aForceRefresh=false) const override
 Returns a pointer to the active color theme settings.
 
void CloseWindow (wxCommandEvent &event)
 Trigger the wxCloseEvent, which is handled by the function given to EVT_CLOSE() macro:
 
void OnModify () override
 Must be called after a schematic change in order to set the "modify" flag of the current symbol.
 
int GetUnit () const
 
void SetUnit (int aUnit)
 
int GetBodyStyle () const
 
void SetBodyStyle (int aBodyStyle)
 
bool GetShowInvisibleFields ()
 
bool GetShowInvisiblePins ()
 
void ClearMsgPanel () override
 Clear all messages from the message panel.
 
void UpdateMsgPanel () override
 Redraw the message panel.
 
void UpdateTitle ()
 Update the main window title bar with the current library name and read only status of the library.
 
bool IsSymbolFromSchematic () const
 
bool IsSymbolFromLegacyLibrary () const
 
void UpdateSymbolMsgPanelInfo ()
 Display the documentation of the selected symbol.
 
void SaveCopyInUndoList (const wxString &aDescription, LIB_SYMBOL *aSymbol, UNDO_REDO aUndoType=UNDO_REDO::LIBEDIT)
 Create a copy of the current symbol, and save it in the undo list.
 
void PushSymbolToUndoList (const wxString &aDescription, LIB_SYMBOL *aSymbolCopy, UNDO_REDO aUndoType=UNDO_REDO::LIBEDIT)
 
void GetSymbolFromUndoList ()
 
void GetSymbolFromRedoList ()
 
void ClearUndoORRedoList (UNDO_REDO_LIST whichList, int aItemCount=-1) override
 Free the undo or redo list from aList element.
 
bool LoadSymbol (const LIB_ID &aLibId, int aUnit, int aBodyStyle)
 Select the currently active library and loads the symbol from aLibId.
 
void SVGPlotSymbol (const wxString &aFullFileName, const VECTOR2I &aOffset)
 Create the SVG print file for the current edited symbol.
 
void SyncLibraries (bool aShowProgress, bool aPreloadCancelled=false, const wxString &aForceRefresh=wxEmptyString)
 Synchronize the library manager to the symbol library table, and then the symbol tree to the library manager.
 
void RefreshLibraryTree ()
 Redisplay the library tree.
 
void UpdateLibraryTree (const wxDataViewItem &aTreeItem, LIB_SYMBOL *aSymbol)
 Update a symbol node in the library tree.
 
LIB_ID GetTargetLibId () const override
 Return either the symbol selected in the symbol tree (if context menu is active) or the symbol on the editor canvas.
 
std::vector< LIB_IDGetSelectedLibIds () const
 
void FocusOnLibId (const LIB_ID &aLibID)
 
void CommonSettingsChanged (int aFlags) override
 Called after the preferences dialog is run.
 
void ShowChangedLanguage () override
 Redraw the menus and what not in current language.
 
void SetScreen (BASE_SCREEN *aScreen) override
 
const BOX2I GetDocumentExtents (bool aIncludeAllVisible=true) const override
 Return bounding box of document with option to not include some items.
 
void RebuildView ()
 
void UpdateItem (EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false) override
 Mark an item for refresh.
 
void HardRedraw () override
 Rebuild the GAL and redraw the screen.
 
void KiwayMailIn (KIWAY_EXPRESS &mail) override
 Receive KIWAY_EXPRESS messages from other players.
 
void FocusOnItem (EDA_ITEM *aItem, bool aAllowScroll=true) override
 Focus on a particular canvas item.
 
void LoadSymbolFromSchematic (SCH_SYMBOL *aSymbol)
 Load a symbol from the schematic to edit in place.
 
bool IsSymbolEditable () const
 Test if a symbol is loaded and can be edited.
 
bool IsSymbolAlias () const
 Return true if aLibId is an alias for the editor screen symbol.
 
bool IsCurrentSymbol (const LIB_ID &aLibId) const
 Restore the empty editor screen, without any symbol or library selected.
 
void emptyScreen ()
 
void createCanvas ()
 
SCH_DRAW_PANELGetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame.
 
SCH_SCREENGetScreen () const override
 Return a pointer to a BASE_SCREEN or one of its derivatives.
 
EESCHEMA_SETTINGSeeconfig () const
 
SYMBOL_EDITOR_SETTINGSlibeditconfig () const
 
APP_SETTINGS_BASEGetViewerSettingsBase () const
 
SCH_RENDER_SETTINGSGetRenderSettings ()
 
COLOR4D GetDrawBgColor () const override
 
virtual bool GetShowAllPins () const
 Allow some frames to show/hide hidden pins.
 
void SetPageSettings (const PAGE_INFO &aPageSettings) override
 
const PAGE_INFOGetPageSettings () const override
 
const VECTOR2I GetPageSizeIU () const override
 Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view.
 
const VECTOR2IGetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid.
 
void SetGridOrigin (const VECTOR2I &aPoint) override
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
void UpdateStatusBar () override
 Update the status bar information.
 
PICKED_SYMBOL PickSymbolFromLibrary (const SYMBOL_LIBRARY_FILTER *aFilter, std::vector< PICKED_SYMBOL > &aHistoryList, std::vector< PICKED_SYMBOL > &aAlreadyPlaced, bool aShowFootprints, const LIB_ID *aHighlight=nullptr, bool aAllowFields=true)
 Call the library viewer to select symbol to import into schematic.
 
LIB_SYMBOLGetLibSymbol (const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
 Load symbol from symbol library table.
 
wxString SelectLibrary (const wxString &aDialogTitle, const wxString &aListLabel, const std::vector< std::pair< wxString, bool * > > &aExtraCheckboxes={})
 Display a list of loaded libraries and allows the user to select a library.
 
virtual void RedrawScreen (const VECTOR2I &aCenterPoint, bool aWarpPointer)
 
void AddToScreen (EDA_ITEM *aItem, SCH_SCREEN *aScreen=nullptr) override
 Add an item to the screen (and view) aScreen is the screen the item is located on, if not the current screen.
 
void RemoveFromScreen (EDA_ITEM *aItem, SCH_SCREEN *aScreen) override
 Remove an item from the screen (and view) aScreen is the screen the item is located on, if not the current screen.
 
void RefreshZoomDependentItems ()
 Mark selected items for refresh.
 
void SyncView ()
 Mark all items for refresh.
 
void ShowFindReplaceDialog (bool aReplace)
 Run the Find or Find & Replace dialog.
 
DIALOG_SCH_FINDGetFindReplaceDialog () const
 
void ShowFindReplaceStatus (const wxString &aMsg, int aStatusTime)
 
void ClearFindReplaceStatus ()
 
void OnFindDialogClose ()
 Notification that the Find dialog has closed.
 
COLOR4D GetLayerColor (SCH_LAYER_ID aLayer)
 Helper to retrieve a layer color from the global color settings.
 
void ActivateGalCanvas () override
 Use to start up the GAL drawing canvas.
 
void OnSymChange (wxFileSystemWatcherEvent &aEvent)
 Handler for Symbol change events.
 
void OnSymChangeDebounceTimer (wxTimerEvent &aEvent)
 Handler for the filesystem watcher debounce timer.
 
void SetSymModificationTime (const wxDateTime &aTime)
 Set the modification time of the symbol library table file.
 
SCH_SELECTION_TOOLGetSelectionTool () override
 
void GetLibraryItemsForListDialog (wxArrayString &aHeaders, std::vector< wxArrayString > &aItemsToDisplay)
 
void HighlightSelectionFilter (const SCH_SELECTION_FILTER_OPTIONS &aOptions)
 
bool LockFile (const wxString &aFileName)
 Mark a schematic file as being in use.
 
void ReleaseFile ()
 Release the current file marked in use.
 
void ScriptingConsoleEnableDisable ()
 Toggle the scripting console visibility.
 
bool IsScriptingConsoleVisible ()
 Get the current visibility of the scripting console window.
 
EDA_SEARCH_DATAGetFindReplaceData ()
 
wxArrayString & GetFindHistoryList ()
 
bool GetShowPolarCoords () const
 For those frames that support polar coordinates.
 
void SetShowPolarCoords (bool aShow)
 
void ToggleUserUnits () override
 
void GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits) override
 Get the pair or units in current use.
 
VECTOR2I GetNearestGridPosition (const VECTOR2I &aPosition) const
 Return the nearest aGridSize location to aPosition.
 
VECTOR2I GetNearestHalfGridPosition (const VECTOR2I &aPosition) const
 Return the nearest aGridSize / 2 location to aPosition.
 
virtual void SetDrawBgColor (const COLOR4D &aColor)
 
bool LibraryFileBrowser (const wxString &aTitle, bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory, FILEDLG_HOOK_NEW_LIBRARY *aFileDlgHook=nullptr)
 
virtual wxString GetScreenDesc () const
 
virtual wxString GetFullScreenDesc () const
 
void EraseMsgBox ()
 
virtual void ReCreateHToolbar ()
 
virtual void ReCreateVToolbar ()
 
virtual void ReCreateLeftToolbar ()
 
virtual void ReCreateAuxiliaryToolbar ()
 
bool IsGridVisible () const
 
virtual void SetGridVisibility (bool aVisible)
 
bool IsGridOverridden () const
 
virtual void SetGridOverrides (bool aOverride)
 
virtual COLOR4D GetGridColor ()
 
virtual void SetGridColor (const COLOR4D &aColor)
 
void OnSelectGrid (wxCommandEvent &event)
 Command event handler for selecting grid sizes.
 
void UpdateGridSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.).
 
void OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
 Update the checked item in the grid wxchoice.
 
void OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
 Update the checked item in the zoom wxchoice.
 
void UpdateZoomSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.)
 
const wxString GetZoomLevelIndicator () const
 Return a human readable value for display in dialogs.
 
virtual void OnSelectZoom (wxCommandEvent &event)
 Set the zoom factor when selected by the zoom list box in the main tool bar.
 
virtual void OnSize (wxSizeEvent &event) override
 Recalculate the size of toolbars and display panel when the frame size changes.
 
void OnMove (wxMoveEvent &aEvent) override
 
virtual void Zoom_Automatique (bool aWarpPointer)
 Redraw the screen with best zoom level and the best centering that shows all the page or the board.
 
void FocusOnLocation (const VECTOR2I &aPos, bool aAllowScroll=true)
 Useful to focus on a particular location, in find functions.
 
virtual void ClearFocus ()
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g.
 
void PrintDrawingSheet (const RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, const std::map< wxString, wxString > *aProperties, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
 Print the drawing-sheet (frame and title block).
 
void DisplayToolMsg (const wxString &msg) override
 
void DisplayConstraintsMsg (const wxString &msg)
 
virtual void OnPageSettingsChange ()
 Called when modifying the page settings.
 
void DisplayUnitsMsg ()
 Display current unit pane in the status bar.
 
virtual void DisplayGridMsg ()
 Display current grid size in the status bar.
 
bool GetOverrideLocks () const
 
void AppendMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
 Append a message to the message panel.
 
void SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
 Clear the message panel and populates it with the contents of aList.
 
void SetMsgPanel (EDA_ITEM *aItem)
 
void SetMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
 Helper function that erases the msg panel and then appends a single message.
 
PROPERTIES_PANELGetPropertiesPanel ()
 
void UpdateProperties ()
 
virtual EDA_ITEMResolveItem (const KIID &aId, bool aAllowNullptrReturn=false) const
 Fetch an item by KIID.
 
void SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)
 
wxWindow * GetToolCanvas () const override
 Canvas access.
 
GAL_DISPLAY_OPTIONS_IMPLGetGalDisplayOptions ()
 Return a reference to the gal rendering options used by GAL for rendering.
 
void RefreshCanvas () override
 
HOTKEY_CYCLE_POPUPGetHotkeyPopup ()
 
virtual void CreateHotkeyPopup ()
 
bool SaveCanvasImageToFile (const wxString &aFileName, BITMAP_TYPE aBitmapType)
 Save the current view as an image file.
 
virtual void OnApiPluginInvoke (wxCommandEvent &aEvent)
 Handler for activating an API plugin (via toolbar or menu).
 
virtual PLUGIN_ACTION_SCOPE PluginActionScope () const
 
virtual void AddApiPluginTools (ACTION_TOOLBAR *aToolbar)
 Append actions from API plugins to the given toolbar.
 
virtual bool OpenProjectFiles (const std::vector< wxString > &aFileList, int aCtl=0)
 Open a project or set of files given by aFileList.
 
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)
 
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.
 
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)
 Display 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.
 
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)
 Fetch the file name from the file history list.
 
virtual void ClearFileHistory ()
 Remove 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.
 
virtual void RecreateToolbars ()
 
void OnToolbarSizeChanged ()
 Update toolbars if desired toolbar icon changed.
 
virtual void UpdateToolbarControlSizes ()
 Update the sizes of any controls in the toolbars of the frame.
 
void RegisterCustomToolbarControlFactory (const ACTION_TOOLBAR_CONTROL &aControlDesc, const ACTION_TOOLBAR_CONTROL_FACTORY &aControlFactory)
 Register a creation factory for toolbar controls that are present in this frame.
 
ACTION_TOOLBAR_CONTROL_FACTORYGetCustomToolbarControlFactory (const std::string &aName)
 
void ReCreateMenuBar ()
 Recreate the menu bar.
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Add the standard KiCad help menu to the menubar.
 
bool IsWritable (const wxFileName &aFileName, bool aVerbose=true)
 Check 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 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 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.
 
virtual int GetUndoCommandCount () const
 
virtual int GetRedoCommandCount () const
 
virtual wxString GetUndoActionDescription () const
 
virtual wxString GetRedoActionDescription () const
 
int GetMaxUndoItems () const
 
bool IsClosing () const
 
bool NonUserClose (bool aForce)
 
virtual void HandleSystemColorChange ()
 Update the UI in response to a change in the system colors.
 
virtual bool CanAcceptApiCommands ()
 Check if this frame is ready to accept API commands.
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller.
 
TOOL_DISPATCHERGetToolDispatcher () const
 
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
 
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.
 
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)
 
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 StringFromOptionalValue (std::optional< int > aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
 Converts an optional aValue in internal units into a united string.
 
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, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) 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.
 
std::optional< int > OptionalValueFromString (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
 
EDA_UNITS GetUnitsFromType (EDA_DATA_TYPE aType) const
 Gets the units to use in the conversion based on the underlying user units.
 
virtual void IntersheetRefUpdate (SCH_GLOBALLABEL *aItem)
 

Static Public Member Functions

static const wxString PropertiesPaneName ()
 
static const wxString NetInspectorPanelName ()
 
static const wxString DesignBlocksPaneName ()
 
static const wxString AppearancePanelName ()
 
static bool IsPluginActionButtonVisible (const PLUGIN_ACTION &aAction, APP_SETTINGS_BASE *aCfg)
 
static std::vector< const PLUGIN_ACTION * > GetOrderedPluginActions (PLUGIN_ACTION_SCOPE aScope, APP_SETTINGS_BASE *aCfg)
 Return ordered list of plugin actions for display in the toolbar.
 
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.
 
static EDA_DATA_TYPE GetTypeFromUnits (const EDA_UNITS aUnits)
 Gets the inferred type from the given units.
 

Public Attributes

bool m_SyncPinEdit
 Set to true to synchronize pins at the same position when editing symbols with multiple units or multiple body styles.
 

Static Public Attributes

static const wxString NullUiString = ""
 The string that is used in the UI to represent a null value.
 

Protected Member Functions

void configureToolbars () override
 
void setupUIConditions () override
 Setup the UI conditions for the various actions and their controls in this frame.
 
void doReCreateMenuBar () override
 
void updateSelectionFilterVisbility () override
 Selection filter panel doesn't have a dedicated visibility control, so show it if any other AUI panel is shown and docked.
 
void handleActivateEvent (wxActivateEvent &aEvent) override
 Handle a window activation event.
 
void handleIconizeEvent (wxIconizeEvent &aEvent) override
 Handle a window iconize event.
 
bool saveSymbolLibTables (bool aGlobal, bool aProject)
 Save Symbol Library Tables to disk.
 
void setSymWatcher (const LIB_ID *aSymbol)
 Creates (or removes) a watcher on the specified symbol library.
 
void unitsChangeRefresh () override
 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 setupUnits (APP_SETTINGS_BASE *aCfg)
 
void updateStatusBarWidths ()
 
std::vector< wxWindow * > findDialogs ()
 
virtual void resolveCanvasType ()
 Determine the canvas type to load (with prompt if required) and initializes m_canvasType.
 
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting ()
 Return the canvas type stored in the application settings.
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Store the canvas type in the application settings.
 
void onActivate (wxActivateEvent &aEvent)
 
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.
 
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)
 
void initExitKey ()
 Set the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
 
void ensureWindowIsOnScreen ()
 
virtual void saveProjectSettings ()
 Save any design-related project settings associated with this frame.
 
virtual void OnDropFiles (wxDropFilesEvent &aEvent)
 Handle event fired when a file is dropped to the window.
 
void AddMenuLanguageList (ACTION_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
 Create a menu list for language choice, and add it as submenu to MasterMenu.
 
virtual void DoWithAcceptedFiles ()
 Execute action on accepted dropped file.
 

Protected Attributes

PANEL_SCH_SELECTION_FILTERm_selectionFilterPanel
 
DIALOG_SCH_FINDm_findReplaceDialog
 
SCHEMATIC_SETTINGS m_base_frame_defaults
 Only used by symbol_editor. Eeschema should be using the one inside the SCHEMATIC.
 
wxSocketServer * m_socketServer
 Prevents opening same file multiple times.
 
std::unique_ptr< LOCKFILEm_file_checker
 
COLOR4D m_gridColor
 
COLOR4D m_drawBgColor
 
int m_undoRedoCountMax
 
bool m_polarCoords
 
bool m_showBorderAndTitleBlock
 
wxChoice * m_gridSelectBox
 
wxChoice * m_zoomSelectBox
 
wxCheckBox * m_overrideLocksCb
 
std::unique_ptr< EDA_SEARCH_DATAm_findReplaceData
 
wxArrayString m_findStringHistoryList
 
wxArrayString m_replaceStringHistoryList
 
EDA_MSG_PANELm_messagePanel
 
int m_msgFrameHeight
 
COLOR_SETTINGSm_colorSettings
 
SEARCH_PANEm_searchPane
 
PROPERTIES_PANELm_propertiesPanel
 
NET_INSPECTOR_PANELm_netInspectorPanel
 
HOTKEY_CYCLE_POPUPm_hotkeyPopup
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
 The current canvas type.
 
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
 
std::vector< wxSocketBase * > m_sockets
 
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
 
bool m_autoSavePermissionError
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
ORIGIN_TRANSFORMS m_originTransforms
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 Map containing the UI update handlers registered with wx for each action.
 
bool m_isClosing
 Set by the close window event handler after frames are asked if they can close.
 
bool m_isNonUserClose
 Set by NonUserClose() to indicate that the user did not request the current close.
 
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
 Associate file extensions with action to execute.
 
TOOLBAR_SETTINGSm_toolbarSettings
 
ACTION_TOOLBARm_tbTopMain
 
ACTION_TOOLBARm_tbTopAux
 
ACTION_TOOLBARm_tbRight
 
ACTION_TOOLBARm_tbLeft
 
std::map< std::string, ACTION_TOOLBAR_CONTROL_FACTORYm_toolbarControlFactories
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
MOUSE_DRAG_ACTION m_dragAction
 
bool m_moveWarpsCursor
 

Static Protected Attributes

static bool m_openGLFailureOccured = false
 Has any failure occurred when switching to OpenGL in any EDA_DRAW_FRAME?
 
static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 Default style flags used for wxAUI toolbars.
 

Private Types

enum  TABLE_SCOPE { GLOBAL_LIB_TABLE , PROJECT_LIB_TABLE }
 

Private Member Functions

void setupTools ()
 
void saveSymbolCopyAs (bool aOpenCopy)
 
bool saveLibrary (const wxString &aLibrary, bool aNewFile)
 Save the changes to the current library.
 
void SelectActiveLibrary (const wxString &aLibrary=wxEmptyString)
 Set the current active library to aLibrary.
 
bool LoadSymbolFromCurrentLib (const wxString &aSymbolName, int aUnit=0, int aBodyStyle=0)
 Load a symbol from the current active library, optionally setting the selected unit and convert.
 
bool LoadOneLibrarySymbolAux (LIB_SYMBOL *aLibEntry, const wxString &aLibrary, int aUnit, int aBodyStyle)
 Create a copy of aLibEntry into memory.
 
bool backupFile (const wxFileName &aOriginalFile, const wxString &aBackupExt)
 Return currently edited symbol.
 
LIB_SYMBOLgetTargetSymbol () const
 Return either the library selected in the symbol tree, if context menu is active or the library that is currently modified.
 
wxString getTargetLib () const
 
void centerItemIdleHandler (wxIdleEvent &aEvent)
 
bool saveAllLibraries (bool aRequireConfirmation)
 Save the current symbol.
 
bool saveCurrentSymbol ()
 Store the currently modified symbol in the library manager buffer.
 
void storeCurrentSymbol ()
 Rename LIB_SYMBOL aliases to avoid conflicts before adding a symbol to a library.
 
void ensureUniqueName (LIB_SYMBOL *aSymbol, const wxString &aLibrary)
 
bool addLibTableEntry (const wxString &aLibFile, TABLE_SCOPE aScope=GLOBAL_LIB_TABLE)
 Add aLibFile to the symbol library table defined by aScope.
 
bool replaceLibTableEntry (const wxString &aLibNickname, const wxString &aLibFile)
 Replace the file path of the symbol library table entry aLibNickname with aLibFile.
 
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

SCH_SCREENm_dummyScreen
 < Helper screen used when no symbol is loaded
 
LIB_SYMBOLm_symbol
 
wxComboBox * m_unitSelectBox
 
wxComboBox * m_bodyStyleSelectBox
 
SYMBOL_TREE_PANEm_treePane
 
LIB_SYMBOL_LIBRARY_MANAGERm_libMgr
 
SYMBOL_EDITOR_SETTINGSm_settings
 
LIB_ID m_centerItemOnIdle
 
int m_unit
 
int m_bodyStyle
 Flag if the symbol being edited was loaded directly from a schematic.
 
bool m_isSymbolFromSchematic
 
KIID m_schematicSymbolUUID
 RefDes of the symbol (only valid if symbol was loaded from schematic)
 
wxString m_reference
 
std::unique_ptr< wxFileSystemWatcherm_watcher
 These are file watchers for the symbol library tables.
 
wxFileName m_watcherFileName
 
wxDateTime m_watcherLastModified
 
wxTimer m_watcherDebounceTimer
 
bool m_inSymChangeTimerEvent
 
std::unique_ptr< NL_SCHEMATIC_PLUGINm_spaceMouse
 
BASE_SCREENm_currentScreen
 current used SCREEN
 
EDA_DRAW_PANEL_GALm_canvas
 
GAL_DISPLAY_OPTIONS_IMPL m_galDisplayOptions
 This the frame's interface to setting GAL display options.
 
int m_lastToolbarIconSize
 
KIWAYm_kiway
 
HOLDER_TYPE m_type
 
const EDA_IU_SCALEm_iuScale
 
EDA_UNITS m_userUnits
 

Static Private Attributes

static bool m_showDeMorgan = false
 

Detailed Description

The symbol library editor main window.

Definition at line 55 of file symbol_edit_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 41 of file kiway_holder.h.

◆ TABLE_SCOPE

Enumerator
GLOBAL_LIB_TABLE 
PROJECT_LIB_TABLE 

Definition at line 496 of file symbol_edit_frame.h.

◆ UNDO_REDO_LIST

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

Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 116 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ SYMBOL_EDIT_FRAME()

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

Definition at line 113 of file symbol_edit_frame.cpp.

References _, _HKI, configureToolbars(), EDA_BASE_FRAME::CreateInfoBar(), ACTIONS::ddAddLibrary, defaultPropertiesPaneInfo(), defaultSchSelectionFilterPaneInfo(), TOOL_DISPATCHER::DispatchWxEvent(), EDA_BASE_FRAME::FinishAUIInitialization(), FRAME_SCH_SYMBOL_EDITOR, GetAppSettings(), SCH_BASE_FRAME::GetCanvas(), GetColorSettings(), SCH_SELECTION_TOOL::GetFilter(), EDA_DRAW_FRAME::GetGalDisplayOptions(), SCH_BASE_FRAME::GetRenderSettings(), SCH_BASE_FRAME::GetScreen(), GetSettings(), GetToolbarSettings(), TOOLS_HOLDER::GetToolManager(), icon_libedit, icon_libedit_16, icon_libedit_32, PROGRESS_REPORTER_BASE::IsCancelled(), KiBitmap(), KICAD_DEFAULT_DRAWFRAME_STYLE, FILEEXT::KiCadSymbolLibFileExtension, LAYER_SCHEMATIC_GRID_AXES, LIB_EDIT_FRAME_NAME, LoadSettings(), EDA_BASE_FRAME::m_aboutTitle, EDA_BASE_FRAME::m_acceptedExts, EDA_BASE_FRAME::m_auimgr, KIGFX::GAL_DISPLAY_OPTIONS::m_axesEnabled, m_bodyStyle, m_bodyStyleSelectBox, EDA_DRAW_FRAME::m_canvasType, EDA_DRAW_FRAME::m_colorSettings, m_dummyScreen, m_isSymbolFromSchematic, m_libMgr, EDA_DRAW_FRAME::m_messagePanel, EDA_DRAW_FRAME::m_propertiesPanel, SCH_BASE_FRAME::m_selectionFilterPanel, m_settings, m_symbol, m_SyncPinEdit, EDA_BASE_FRAME::m_tbLeft, EDA_BASE_FRAME::m_tbRight, EDA_BASE_FRAME::m_tbTopMain, EDA_BASE_FRAME::m_toolbarSettings, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, m_treePane, m_unit, m_unitSelectBox, PR_CAN_ABORT, EDA_DRAW_FRAME::PropertiesPaneName(), RebuildSymbolUnitAndBodyStyleLists(), EDA_BASE_FRAME::ReCreateMenuBar(), EDA_BASE_FRAME::RecreateToolbars(), EDA_DRAW_FRAME::resolveCanvasType(), SCH_BASE_FRAME::SCH_BASE_FRAME(), schIUScale, SetAuiPaneSize(), BOX2< Vec >::SetOrigin(), SetScreen(), KIPLATFORM::APP::SetShutdownBlockReason(), BOX2< Vec >::SetSize(), setupTools(), setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), EDA_BASE_FRAME::ShowInfoBarWarning(), SwitchCanvas(), SYMBOL_EDIT_FRAME(), SyncLibraries(), SCH_BASE_FRAME::SyncView(), updateSelectionFilterVisbility(), UpdateSymbolMsgPanelInfo(), UpdateTitle(), and ACTIONS::zoomFitScreen.

Referenced by SYMBOL_EDIT_FRAME().

◆ ~SYMBOL_EDIT_FRAME()

Member Function Documentation

◆ ActivateGalCanvas()

void SCH_BASE_FRAME::ActivateGalCanvas ( )
overridevirtualinherited

Use to start up the GAL drawing canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 365 of file sch_base_frame.cpp.

References EDA_DRAW_FRAME::ActivateGalCanvas(), GetCanvas(), m_spaceMouse, pcbIUScale, and schIUScale.

Referenced by createCanvas(), and SCH_DRAW_PANEL::OnShow().

◆ AddApiPluginTools()

void EDA_DRAW_FRAME::AddApiPluginTools ( ACTION_TOOLBAR * aToolbar)
virtualinherited

Append actions from API plugins to the given toolbar.

Parameters
aToolbaris the toolbar to add the plugins to

Definition at line 1441 of file eda_draw_frame.cpp.

References API_PLUGIN_MANAGER::ButtonBindings(), EDA_BASE_FRAME::config(), GetOrderedPluginActions(), KIPLATFORM::UI::IsDarkTheme(), IsPluginActionButtonVisible(), OnApiPluginInvoke(), Pgm(), and PluginActionScope().

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

◆ AddLibraryFile()

◆ addLibTableEntry()

bool SYMBOL_EDIT_FRAME::addLibTableEntry ( const wxString & aLibFile,
TABLE_SCOPE aScope = GLOBAL_LIB_TABLE )
private

Add aLibFile to the symbol library table defined by aScope.

Note
The library defined by aLibFile must be a KiCad (s-expression) library.
Parameters
aLibFileis the full path and file name of the symbol library to add to the table.
aScopedefines if aLibFile is added to the global or project library table.
Returns
true if successful or false if a failure occurs.

Definition at line 1893 of file symbol_edit_frame.cpp.

References _, SYMBOL_LIB_TABLE::GetGlobalLibTable(), SYMBOL_LIB_TABLE::GetGlobalTableFileName(), PGM_BASE::GetLocalEnvVariables(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), GLOBAL_LIB_TABLE, LIB_TABLE::HasLibrary(), LIB_TABLE::InsertRow(), NormalizePath(), Pgm(), Prj(), LIB_TABLE::Save(), PROJECT_SCH::SchSymbolLibTable(), LIB_TABLE_ROW::SetFullURI(), LIB_TABLE_ROW::SetNickName(), and IO_ERROR::What().

Referenced by saveLibrary().

◆ AddMenuLanguageList()

◆ AddStandardHelpMenu()

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU & aMenu)
inherited

Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g.

zoom and grid).

Definition at line 642 of file eda_draw_frame.cpp.

References CONDITIONAL_MENU::AddSeparator(), TOOL_MENU::GetMenu(), TOOLS_HOLDER::m_toolManager, TOOL_MENU::RegisterSubMenu(), and SELECTION_CONDITIONS::ShowAlways().

Referenced by PCB_VIEWER_TOOLS::Init().

◆ AddToScreen()

void SCH_BASE_FRAME::AddToScreen ( EDA_ITEM * aItem,
SCH_SCREEN * aScreen = nullptr )
overridevirtualinherited

Add an item to the screen (and view) aScreen is the screen the item is located on, if not the current screen.

Implements SCHEMATIC_HOLDER.

Definition at line 483 of file sch_base_frame.cpp.

References KIGFX::VIEW::Add(), SCH_SCREEN::Append(), GetCanvas(), GetScreen(), SCH_DRAW_PANEL::GetView(), SCH_TABLECELL_T, EDA_ITEM::Type(), and UpdateItem().

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ AngleValueFromString()

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

◆ AppearancePanelName()

static const wxString EDA_DRAW_FRAME::AppearancePanelName ( )
inlinestaticinherited

◆ AppendMsgPanel()

void EDA_DRAW_FRAME::AppendMsgPanel ( const wxString & aTextUpper,
const wxString & aTextLower,
int aPadding = 6 )
inherited

Append a message to the message panel.

This helper method checks to make sure the message panel exists in the frame and appends a message to it using the message panel AppendMessage() method.

Parameters
aTextUpperThe message upper text.
aTextLowerThe message lower text.
aPaddingNumber of spaces to pad between messages.

Definition at line 857 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing, and m_messagePanel.

Referenced by GERBER_FILE_IMAGE::DisplayImageInfo(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), and SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo().

◆ backupFile()

bool SYMBOL_EDIT_FRAME::backupFile ( const wxFileName & aOriginalFile,
const wxString & aBackupExt )
private

Return currently edited symbol.

Definition at line 1359 of file symbol_edit_frame.cpp.

References _, and DisplayError().

Referenced by saveLibrary().

◆ CanAcceptApiCommands()

virtual bool EDA_BASE_FRAME::CanAcceptApiCommands ( )
inlinevirtualinherited

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

Referenced by PCB_EDIT_FRAME::CanAcceptApiCommands().

◆ CanCloseSymbolFromSchematic()

bool SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic ( bool doClose)

◆ canCloseWindow()

bool SYMBOL_EDIT_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent)
overridevirtual

◆ centerItemIdleHandler()

void SYMBOL_EDIT_FRAME::centerItemIdleHandler ( wxIdleEvent & aEvent)
private

Definition at line 215 of file symbol_editor.cpp.

References centerItemIdleHandler(), m_centerItemOnIdle, and m_treePane.

Referenced by centerItemIdleHandler(), and LoadSymbol().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits)
inherited

Definition at line 1673 of file eda_base_frame.cpp.

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

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

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ ClearFileHistory()

◆ ClearFindReplaceStatus()

void SCH_BASE_FRAME::ClearFindReplaceStatus ( )
inherited

Definition at line 605 of file sch_base_frame.cpp.

References EDA_BASE_FRAME::m_infoBar.

◆ ClearFocus()

virtual void EDA_DRAW_FRAME::ClearFocus ( )
inlinevirtualinherited

Definition at line 318 of file eda_draw_frame.h.

References FocusOnItem().

Referenced by SCH_EDIT_FRAME::HardRedraw(), and SCH_EDIT_FRAME::SetCurrentSheet().

◆ ClearMsgPanel()

void SYMBOL_EDIT_FRAME::ClearMsgPanel ( )
inlineoverridevirtual

Clear all messages from the message panel.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 248 of file symbol_edit_frame.h.

References UpdateSymbolMsgPanelInfo().

Referenced by saveLibrary().

◆ ClearUndoORRedoList()

void SYMBOL_EDIT_FRAME::ClearUndoORRedoList ( UNDO_REDO_LIST whichList,
int aItemCount = -1 )
overridevirtual

Free the undo or redo list from aList element.

  • Wrappers are deleted.
  • data pointed by wrappers are deleted if not in use in schematic i.e. when they are copy of a schematic item or they are no more in use (DELETED)
Parameters
whichList= the UNDO_REDO_CONTAINER to clear
aItemCount= the count of items to remove. < 0 for all items items are removed from the beginning of the list. So this function can be called to remove old commands

Reimplemented from EDA_BASE_FRAME.

Definition at line 1761 of file symbol_edit_frame.cpp.

References PICKED_ITEMS_LIST::ClearListAndDeleteItems(), EDA_BASE_FRAME::m_redoList, EDA_BASE_FRAME::m_undoList, and EDA_BASE_FRAME::UNDO_LIST.

Referenced by PushSymbolToUndoList().

◆ ClearUndoRedoList()

◆ CloseWindow()

void SYMBOL_EDIT_FRAME::CloseWindow ( wxCommandEvent & event)
inline

Trigger the wxCloseEvent, which is handled by the function given to EVT_CLOSE() macro:

EVT_CLOSE( SYMBOL_EDIT_FRAME::OnCloseWindow )

Definition at line 227 of file symbol_edit_frame.h.

◆ commonInit()

◆ CommonSettingsChanged()

◆ config()

APP_SETTINGS_BASE * SYMBOL_EDIT_FRAME::config ( ) const
overridevirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 359 of file symbol_edit_frame.cpp.

References GetSettings().

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

References m_configName.

◆ configureToolbars()

◆ CopySymbolToClipboard()

◆ createCanvas()

◆ CreateHotkeyPopup()

void EDA_DRAW_FRAME::CreateHotkeyPopup ( )
virtualinherited

Definition at line 1261 of file eda_draw_frame.cpp.

References m_hotkeyPopup.

◆ CreateInfoBar()

◆ CreateNewSymbol()

void SYMBOL_EDIT_FRAME::CreateNewSymbol ( const wxString & newName = wxEmptyString)

Create a new symbol in the selected library.

Parameters
newNameis the name of the symbol to derive the new symbol from or empty to create a new root symbol.

Definition at line 339 of file symbol_editor.cpp.

References _, NEW_SYMBOL_PROPERTIES::alternateBodyStyle, ACTIONS::cancelInteractive, DIALOG_LIB_NEW_SYMBOL::GetAlternateBodyStyle(), DIALOG_LIB_NEW_SYMBOL::GetIncludeInBom(), DIALOG_LIB_NEW_SYMBOL::GetIncludeOnBoard(), DIALOG_LIB_NEW_SYMBOL::GetKeepContentUserFields(), DIALOG_LIB_NEW_SYMBOL::GetKeepDatasheet(), DIALOG_LIB_NEW_SYMBOL::GetKeepFootprint(), DIALOG_LIB_NEW_SYMBOL::GetName(), DIALOG_LIB_NEW_SYMBOL::GetParentSymbolName(), DIALOG_LIB_NEW_SYMBOL::GetPinNameInside(), DIALOG_LIB_NEW_SYMBOL::GetPinTextPosition(), DIALOG_LIB_NEW_SYMBOL::GetPowerSymbol(), DIALOG_LIB_NEW_SYMBOL::GetReference(), DIALOG_LIB_NEW_SYMBOL::GetShowPinName(), DIALOG_LIB_NEW_SYMBOL::GetShowPinNumber(), getTargetLib(), DIALOG_LIB_NEW_SYMBOL::GetTransferUserFields(), DIALOG_LIB_NEW_SYMBOL::GetUnitCount(), DIALOG_LIB_NEW_SYMBOL::GetUnitsInterchangeable(), NEW_SYMBOL_PROPERTIES::includeInBom, NEW_SYMBOL_PROPERTIES::includeOnBoard, NEW_SYMBOL_PROPERTIES::keepContentUserFields, NEW_SYMBOL_PROPERTIES::keepDatasheet, NEW_SYMBOL_PROPERTIES::keepFootprint, LoadSymbol(), m_libMgr, TOOLS_HOLDER::m_toolManager, NEW_SYMBOL_PROPERTIES::name, NEW_SYMBOL_PROPERTIES::parentSymbolName, NEW_SYMBOL_PROPERTIES::pinNameInside, NEW_SYMBOL_PROPERTIES::pinTextPosition, NEW_SYMBOL_PROPERTIES::powerSymbol, NEW_SYMBOL_PROPERTIES::reference, SCH_BASE_FRAME::SelectLibrary(), DIALOG_SHIM::ShowModal(), KIDIALOG::ShowModal(), NEW_SYMBOL_PROPERTIES::showPinName, NEW_SYMBOL_PROPERTIES::showPinNumber, SyncLibraries(), NEW_SYMBOL_PROPERTIES::transferUserFields, UnescapeString(), NEW_SYMBOL_PROPERTIES::unitCount, and NEW_SYMBOL_PROPERTIES::unitsInterchangeable.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol().

◆ CreateServer()

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

Definition at line 43 of file eda_dde.cpp.

References HOSTNAME(), ID_EDA_SOCKET_EVENT_SERV, and m_socketServer.

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

◆ CurrentToolName()

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

Definition at line 120 of file tools_holder.cpp.

References m_toolStack, and ACTIONS::selectionTool.

Referenced by ShowChangedLanguage().

◆ DdAddLibrary()

void SYMBOL_EDIT_FRAME::DdAddLibrary ( wxString aLibFile)

Add a library dropped file to the symbol library table.

Definition at line 1186 of file symbol_edit_frame.cpp.

References _, DisplayError(), KIWAY::ExpressMail(), FRAME_SCH_SYMBOL_EDITOR, Kiway, m_libMgr, MAIL_LIB_EDIT, Prj(), SCH_BASE_FRAME::saveSymbolLibTables(), and PROJECT_SCH::SchSymbolLibTable().

◆ DeleteAutoSaveFile()

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

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1566 of file eda_base_frame.cpp.

References FILEEXT::AutoSaveFilePrefix, Pgm(), and traceAutoSave.

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

◆ DeleteSymbolFromLibrary()

void SYMBOL_EDIT_FRAME::DeleteSymbolFromLibrary ( )

◆ DesignBlocksPaneName()

◆ Destroy()

◆ DismissModal()

◆ DisplayConstraintsMsg()

void EDA_DRAW_FRAME::DisplayConstraintsMsg ( const wxString & msg)
inherited

Definition at line 671 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing.

Referenced by EDIT_TOOL::doMoveSelection().

◆ DisplayGridMsg()

void EDA_DRAW_FRAME::DisplayGridMsg ( )
virtualinherited

Display current grid size in the status bar.

Reimplemented in GERBVIEW_FRAME, and PL_EDITOR_FRAME.

Definition at line 680 of file eda_draw_frame.cpp.

References _, GRID_SETTINGS::grids, EDA_BASE_FRAME::m_isClosing, and TOOLS_HOLDER::m_toolManager.

Referenced by PCB_BASE_FRAME::UpdateStatusBar(), and SCH_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

void EDA_DRAW_FRAME::DisplayToolMsg ( const wxString & msg)
overridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 662 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing.

Referenced by EDIT_TOOL::Duplicate().

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane in the status bar.

Definition at line 696 of file eda_draw_frame.cpp.

References _, UNITS_PROVIDER::GetUserUnits(), INCH, EDA_BASE_FRAME::m_isClosing, MILS, and MM.

Referenced by UpdateGridSelectBox(), UpdateStatusBar(), and SCH_BASE_FRAME::UpdateStatusBar().

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

Definition at line 364 of file eda_base_frame.cpp.

Referenced by onAutoSaveTimer().

◆ doCloseWindow()

void SYMBOL_EDIT_FRAME::doCloseWindow ( )
overridevirtual

◆ doReCreateMenuBar()

void SYMBOL_EDIT_FRAME::doReCreateMenuBar ( )
overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 36 of file menubar_symbol_editor.cpp.

References _, ACTION_MENU::Add(), ACTION_MENU::AddClose(), ACTIONS::addLibrary, EDA_BASE_FRAME::AddMenuLanguageList(), EDA_BASE_FRAME::AddStandardHelpMenu(), ACTION_MENU::CHECK, SCH_ACTIONS::checkSymbol, ACTIONS::configurePaths, ACTIONS::copy, ACTIONS::copyAsText, ACTIONS::cut, ACTIONS::doDelete, SCH_ACTIONS::drawArc, SCH_ACTIONS::drawBezier, SCH_ACTIONS::drawCircle, SCH_ACTIONS::drawRectangle, SCH_ACTIONS::drawSymbolLines, SCH_ACTIONS::drawSymbolPolygon, SCH_ACTIONS::drawSymbolTextBox, ACTIONS::duplicate, SCH_ACTIONS::editLibSymbolWithLibEdit, export_file, SCH_ACTIONS::exportSymbol, SCH_ACTIONS::exportSymbolAsSVG, SCH_ACTIONS::exportSymbolView, ACTIONS::find, ACTIONS::findAndReplace, import, SCH_ACTIONS::importGraphics, SCH_ACTIONS::importSymbol, IsSymbolFromSchematic(), TOOLS_HOLDER::m_toolManager, ACTIONS::newLibrary, SCH_ACTIONS::newSymbol, ACTION_MENU::NORMAL, ACTIONS::openPreferences, ACTIONS::paste, SCH_ACTIONS::pinTable, SCH_ACTIONS::placeSymbolPin, SCH_ACTIONS::placeSymbolText, ACTIONS::redo, ACTIONS::revert, ACTIONS::save, ACTIONS::saveAll, SCH_ACTIONS::saveLibraryAs, SCH_ACTIONS::saveSymbolAs, SCH_ACTIONS::saveSymbolCopyAs, ACTIONS::selectAll, ACTION_MENU::SetIcon(), ACTION_MENU::SetTitle(), ACTIONS::showDatasheet, SCH_ACTIONS::showHiddenFields, SCH_ACTIONS::showHiddenPins, ACTIONS::showLibraryTree, ACTIONS::showProperties, ACTIONS::showSymbolBrowser, ACTIONS::showSymbolLibTable, SCH_ACTIONS::symbolProperties, SCH_ACTIONS::togglePinAltIcons, ACTIONS::undo, ACTIONS::unselectAll, SCH_ACTIONS::updateSymbolFields, ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, ACTIONS::zoomRedraw, and ACTIONS::zoomTool.

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

References m_acceptedExts, m_AcceptedFiles, and TOOLS_HOLDER::m_toolManager.

Referenced by OnDropFiles().

◆ DuplicateSymbol()

void SYMBOL_EDIT_FRAME::DuplicateSymbol ( bool aFromClipboard)

◆ eeconfig()

◆ emptyScreen()

◆ ensureUniqueName()

void SYMBOL_EDIT_FRAME::ensureUniqueName ( LIB_SYMBOL * aSymbol,
const wxString & aLibrary )
private

Definition at line 1377 of file symbol_editor.cpp.

References LIB_SYMBOL::GetName(), m_libMgr, and LIB_SYMBOL::SetName().

Referenced by DuplicateSymbol().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )
protectedinherited

Definition at line 855 of file eda_base_frame.cpp.

References GetWindowSize(), and traceDisplayLocation.

Referenced by OnSize().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 395 of file eda_draw_frame.cpp.

References m_messagePanel.

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

Definition at line 177 of file kiway_player.h.

Referenced by OnSockRequest().

◆ ExportSymbol()

◆ findDialogs()

std::vector< wxWindow * > EDA_DRAW_FRAME::findDialogs ( )
protectedinherited

Definition at line 1048 of file eda_draw_frame.cpp.

Referenced by PCB_BASE_FRAME::FocusOnItems(), and FocusOnLocation().

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )
privateinherited

Definition at line 211 of file eda_base_frame.cpp.

References findQuasiModalDialog(), FRAME_SCH, and m_ident.

Referenced by findQuasiModalDialog(), ProcessEvent(), and windowClosing().

◆ FinishAUIInitialization()

◆ FocusLibraryTreeInput()

void SYMBOL_EDIT_FRAME::FocusLibraryTreeInput ( )
overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 787 of file symbol_edit_frame.cpp.

References LIB_TREE::FocusSearchFieldIfExists(), and GetLibTree().

◆ FocusOnItem()

void SYMBOL_EDIT_FRAME::FocusOnItem ( EDA_ITEM * aItem,
bool aAllowScroll = true )
overridevirtual

Focus on a particular canvas item.

Parameters
aItemis the item to focus on. nullptr clears the focus.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1544 of file symbol_edit_frame.cpp.

References EDA_ITEM::ClearBrightened(), EDA_DRAW_FRAME::FocusOnLocation(), EDA_ITEM::GetFocusPosition(), EDA_ITEM::IsBrightened(), KIGFX::VIEW_ITEM::IsSCH_ITEM(), m_symbol, EDA_ITEM::m_Uuid, niluuid, pin, EDA_ITEM::SetBrightened(), UpdateItem(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FocusOnLibId()

void SYMBOL_EDIT_FRAME::FocusOnLibId ( const LIB_ID & aLibID)

Definition at line 1342 of file symbol_edit_frame.cpp.

References GetLibTree(), and LIB_TREE::SelectLibId().

Referenced by SYMBOL_EDITOR_CONTROL::RenameSymbol().

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const VECTOR2I & aPos,
bool aAllowScroll = true )
inherited

Useful to focus on a particular location, in find functions.

Move the graphic cursor (crosshair cursor) at a given coordinate and reframes the drawing if the requested point is out of view or if center on location is requested.

Parameters
aPosis the point to go to.

Definition at line 1062 of file eda_draw_frame.cpp.

References BOX2< Vec >::Contains(), findDialogs(), GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), BOX2< Vec >::Inflate(), KIGFX::VIEW::SetCenter(), KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition(), and ToVECTOR2D().

Referenced by PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), SCH_EDIT_FRAME::onNetNavigatorSelection(), and SCH_SELECTION_TOOL::SyncSelection().

◆ FreezeLibraryTree()

void SYMBOL_EDIT_FRAME::FreezeLibraryTree ( )

Definition at line 793 of file symbol_edit_frame.cpp.

References m_libMgr, and m_treePane.

Referenced by KiwayMailIn(), and saveLibrary().

◆ GetAboutTitle()

const wxString & EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inherited

◆ GetBodyStyle()

◆ GetCanvas()

SCH_DRAW_PANEL * SCH_BASE_FRAME::GetCanvas ( ) const
overridevirtualinherited

Return a pointer to GAL-based canvas of given EDA draw frame.

Returns
Pointer to GAL-based canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 337 of file sch_base_frame.cpp.

References EDA_DRAW_FRAME::GetCanvas().

Referenced by ActivateGalCanvas(), AddToScreen(), SCH_EDIT_FRAME::AnnotateSymbols(), SYMBOL_VIEWER_FRAME::ClickOnSymbolList(), CommonSettingsChanged(), SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::DisplayCurrentSheet(), doCloseWindow(), SCH_EDIT_FRAME::GetDocumentExtents(), GetRenderSettings(), HardRedraw(), SCH_EDIT_FRAME::HardRedraw(), SCH_EDIT_FRAME::IntersheetRefUpdate(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_VIEWER_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCH_EDIT_FRAME::OnCrossProbeFlashTimer(), SCH_EDIT_FRAME::OnModify(), SCH_EDIT_FRAME::onNetNavigatorSelection(), SCH_EDIT_FRAME::OnPageSettingsChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OpenProjectFiles(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_EDIT_FRAME::PutDataInPreviousState(), SYMBOL_EDIT_FRAME::RebuildView(), SCH_EDIT_FRAME::RecalculateConnections(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), RedrawScreen(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), RefreshZoomDependentItems(), RemoveFromScreen(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SCH_EDIT_FRAME::SetCurrentSheet(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SCH_EDIT_FRAME::SetSchematic(), SCH_EDIT_FRAME::SetScreen(), SYMBOL_VIEWER_FRAME::SetSelectedLibrary(), SCH_EDIT_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), SCH_EDIT_FRAME::ShowAllIntersheetRefs(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SYMBOL_EDIT_FRAME::SwitchCanvas(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), SyncView(), SCH_EDIT_FRAME::TestDanglingEnds(), SCH_EDIT_FRAME::UpdateHopOveredWires(), UpdateItem(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), UpdateStatusBar(), SCH_EDIT_FRAME::~SCH_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::~SYMBOL_VIEWER_FRAME().

◆ GetColorSettings()

COLOR_SETTINGS * SYMBOL_EDIT_FRAME::GetColorSettings ( bool aForceRefresh = false) const
overridevirtual

Returns a pointer to the active color theme settings.

Reimplemented from SCH_BASE_FRAME.

Definition at line 365 of file symbol_edit_frame.cpp.

References DEFAULT_THEME, GetAppSettings(), GetSettings(), and APP_SETTINGS_BASE::m_ColorTheme.

Referenced by SVGPlotSymbol().

◆ GetCurLib()

wxString SYMBOL_EDIT_FRAME::GetCurLib ( ) const

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

Definition at line 434 of file eda_base_frame.h.

Referenced by SaveSettings().

◆ GetCurrentSelection()

SELECTION & SYMBOL_EDIT_FRAME::GetCurrentSelection ( )
overridevirtual

Get the current selection from the canvas area.

Returns
the current selection.

Reimplemented from TOOLS_HOLDER.

Definition at line 1792 of file symbol_edit_frame.cpp.

References TOOLS_HOLDER::m_toolManager.

◆ GetCurSymbol()

◆ GetCustomToolbarControlFactory()

ACTION_TOOLBAR_CONTROL_FACTORY * EDA_BASE_FRAME::GetCustomToolbarControlFactory ( const std::string & aName)
inherited

Definition at line 506 of file eda_base_frame.cpp.

References m_toolbarControlFactories.

Referenced by ACTION_TOOLBAR::ApplyConfiguration().

◆ GetDocumentExtents()

const BOX2I SYMBOL_EDIT_FRAME::GetDocumentExtents ( bool aIncludeAllVisible = true) const
overridevirtual

Return bounding box of document with option to not include some items.

Used most commonly by "Zoom to Fit" and "Zoom to Objects". In Eeschema for "Zoom to Fit" it's passed "true" to include drawing sheet border, and "false" by "Zoom To Objects" to ignore drawing sheet border. In Pcbnew, false makes it ignore any items outside the PCB edge such as fabrication notes.

Parameters
aIncludeAllVisibleTrue to include everything visible in bbox calculations, false to ignore some visible items (program dependent).
Returns
Bounding box of the document (ignoring some items as requested).

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1527 of file symbol_edit_frame.cpp.

References m_bodyStyle, m_symbol, m_unit, and schIUScale.

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

◆ GetDrawBgColor()

COLOR4D SCH_BASE_FRAME::GetDrawBgColor ( ) const
overridevirtualinherited

Reimplemented from EDA_DRAW_FRAME.

Definition at line 661 of file sch_base_frame.cpp.

References COLOR_SETTINGS::GetColor(), GetColorSettings(), and LAYER_SCHEMATIC_BACKGROUND.

◆ GetFileFromHistory()

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

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

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

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), BITMAP2CMP_FRAME::OnFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), SCH_EDIT_FRAME::OnLoadFile(), and GERBVIEW_FRAME::OnZipFileHistory().

◆ GetFileHistory()

FILE_HISTORY & EDA_BASE_FRAME::GetFileHistory ( )
inlineinherited

◆ GetFindHistoryList()

wxArrayString & EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

Definition at line 119 of file eda_draw_frame.h.

References m_findStringHistoryList.

◆ GetFindReplaceData()

EDA_SEARCH_DATA & EDA_DRAW_FRAME::GetFindReplaceData ( )
inlineinherited

Definition at line 118 of file eda_draw_frame.h.

References m_findReplaceData.

◆ GetFindReplaceDialog()

DIALOG_SCH_FIND * SCH_BASE_FRAME::GetFindReplaceDialog ( ) const
inlineinherited

Definition at line 246 of file sch_base_frame.h.

References m_findReplaceDialog.

◆ GetFrameType()

◆ GetFullScreenDesc()

wxString EDA_DRAW_FRAME::GetFullScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1174 of file eda_draw_frame.cpp.

Referenced by PrintDrawingSheet(), and PCB_EDIT_FRAME::SetPageSettings().

◆ GetGalDisplayOptions()

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )
inlinevirtualinherited

◆ GetGridOrigin()

const VECTOR2I & SCH_BASE_FRAME::GetGridOrigin ( ) const
inlineoverridevirtualinherited

Return the absolute coordinates of the origin of the snap grid.

This is treated as a relative offset and snapping will occur at multiples of the grid size relative to this point.

Implements EDA_DRAW_FRAME.

Definition at line 147 of file sch_base_frame.h.

◆ GetHotkeyPopup()

HOTKEY_CYCLE_POPUP * EDA_DRAW_FRAME::GetHotkeyPopup ( )
inlineinherited

Definition at line 493 of file eda_draw_frame.h.

References m_hotkeyPopup.

◆ GetInfoBar()

◆ GetIuScale()

◆ GetLayerColor()

COLOR4D SCH_BASE_FRAME::GetLayerColor ( SCH_LAYER_ID aLayer)
inherited

Helper to retrieve a layer color from the global color settings.

Definition at line 534 of file sch_base_frame.cpp.

References COLOR_SETTINGS::GetColor(), and GetColorSettings().

◆ GetLibManager()

◆ GetLibraryItemsForListDialog()

◆ GetLibSymbol()

LIB_SYMBOL * SCH_BASE_FRAME::GetLibSymbol ( const LIB_ID & aLibId,
bool aUseCacheLib = false,
bool aShowErrorMsg = false )
inherited

Load symbol from symbol library table.

Parameters
aLibIdis the symbol library identifier to load.
aUseCacheLibset to true to fall back to cache library if symbol is not found in symbol library table.
aShowErrorMessageset to true to show any error messages.
Returns
The symbol found in the library or NULL if the symbol was not found.

Definition at line 265 of file sch_base_frame.cpp.

References KIWAY_HOLDER::Prj(), SchGetLibSymbol(), PROJECT_SCH::SchLibs(), and PROJECT_SCH::SchSymbolLibTable().

Referenced by SCH_EDIT_FRAME::CreateArchiveLibrary(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_EDIT_FRAME::SelectUnit(), and DIALOG_CHANGE_SYMBOLS::updateFieldsList().

◆ GetLibTree()

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 613 of file eda_base_frame.h.

References 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 m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const
inlineinherited

◆ GetNearestGridPosition()

VECTOR2I EDA_DRAW_FRAME::GetNearestGridPosition ( const VECTOR2I & aPosition) const
inherited

Return the nearest aGridSize location to aPosition.

Parameters
aPositionThe position to check.
Returns
The nearest grid position.

Definition at line 1002 of file eda_draw_frame.cpp.

References GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), GetGridOrigin(), KIGFX::GAL::GetGridSize(), KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetNearestHalfGridPosition()

VECTOR2I EDA_DRAW_FRAME::GetNearestHalfGridPosition ( const VECTOR2I & aPosition) const
inherited

Return the nearest aGridSize / 2 location to aPosition.

This is useful when attempting for keep outer points on grid but not the middle point.

Parameters
aPositionThe position to check.
Returns
The nearest half-grid position.

Definition at line 1016 of file eda_draw_frame.cpp.

References GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), GetGridOrigin(), KIGFX::GAL::GetGridSize(), KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetOrderedPluginActions()

std::vector< const PLUGIN_ACTION * > EDA_DRAW_FRAME::GetOrderedPluginActions ( PLUGIN_ACTION_SCOPE aScope,
APP_SETTINGS_BASE * aCfg )
staticinherited

Return ordered list of plugin actions for display in the toolbar.

Must be static at the moment because this needs to be called from the preferences dialog, which can exist without the frame in question actually being created.

Parameters
aCfgis the settings to read the plugin ordering from.

Definition at line 1403 of file eda_draw_frame.cpp.

References APP_SETTINGS_BASE::PLUGINS::actions, API_PLUGIN_MANAGER::GetActionsForScope(), APP_SETTINGS_BASE::m_Plugins, and Pgm().

Referenced by AddApiPluginTools(), and PCB_EDIT_FRAME::GetOrderedActionPlugins().

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

References m_originTransforms.

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

◆ GetOverrideLocks()

bool EDA_DRAW_FRAME::GetOverrideLocks ( ) const
inherited

Definition at line 521 of file eda_draw_frame.cpp.

References m_overrideLocksCb.

◆ GetPageSettings()

const PAGE_INFO & SCH_BASE_FRAME::GetPageSettings ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 208 of file sch_base_frame.cpp.

References SCH_SCREEN::GetPageSettings(), and GetScreen().

Referenced by SCH_EDIT_FRAME::InitSheet().

◆ GetPageSizeIU()

const VECTOR2I SCH_BASE_FRAME::GetPageSizeIU ( ) const
overridevirtualinherited

Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view.

Implements EDA_DRAW_FRAME.

Definition at line 214 of file sch_base_frame.cpp.

References SCH_SCREEN::GetPageSettings(), GetScreen(), PAGE_INFO::GetSizeIU(), and schIUScale.

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard().

◆ GetPropertiesPanel()

PROPERTIES_PANEL * EDA_DRAW_FRAME::GetPropertiesPanel ( )
inlineinherited

Definition at line 422 of file eda_draw_frame.h.

References m_propertiesPanel.

◆ GetRedoActionDescription()

wxString EDA_BASE_FRAME::GetRedoActionDescription ( ) const
virtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 1658 of file eda_base_frame.cpp.

References GetRedoCommandCount(), and m_redoList.

Referenced by HandleUpdateUIEvent().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetRenderSettings()

◆ GetScreen()

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1167 of file eda_draw_frame.cpp.

Referenced by PrintDrawingSheet(), and PCB_EDIT_FRAME::SetPageSettings().

◆ GetSelectedLibIds()

std::vector< LIB_ID > SYMBOL_EDIT_FRAME::GetSelectedLibIds ( ) const
Returns
a list of selected items in the symbol tree

Definition at line 1258 of file symbol_edit_frame.cpp.

References GetTreeLIBIDs().

Referenced by SYMBOL_EDITOR_CONTROL::CutCopyDelete(), DeleteSymbolFromLibrary(), and SYMBOL_EDITOR_CONTROL::Init().

◆ GetSelectionTool()

SCH_SELECTION_TOOL * SCH_BASE_FRAME::GetSelectionTool ( )
overridevirtualinherited

Reimplemented from SCHEMATIC_HOLDER.

Definition at line 939 of file sch_base_frame.cpp.

References TOOLS_HOLDER::m_toolManager.

◆ GetSettings()

◆ GetSettingsManager()

◆ GetSeverity()

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

Reimplemented in PCB_BASE_FRAME, and SCH_EDIT_FRAME.

Definition at line 143 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

◆ GetShowAllPins()

virtual bool SCH_BASE_FRAME::GetShowAllPins ( ) const
inlinevirtualinherited

Allow some frames to show/hide hidden pins.

The default impl shows all pins.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 141 of file sch_base_frame.h.

◆ GetShowInvisibleFields()

bool SYMBOL_EDIT_FRAME::GetShowInvisibleFields ( )

◆ GetShowInvisiblePins()

bool SYMBOL_EDIT_FRAME::GetShowInvisiblePins ( )

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const
inlineinherited

For those frames that support polar coordinates.

Definition at line 133 of file eda_draw_frame.h.

References m_polarCoords.

Referenced by EDITOR_CONDITIONS::polarCoordFunc(), GERBVIEW_FRAME::UpdateStatusBar(), and PCB_BASE_FRAME::UpdateStatusBar().

◆ GetSymbolFromRedoList()

◆ GetSymbolFromUndoList()

◆ getTargetLib()

wxString SYMBOL_EDIT_FRAME::getTargetLib ( ) const
private

Definition at line 1266 of file symbol_edit_frame.cpp.

References LIB_ID::GetLibNickname(), and GetTargetLibId().

Referenced by CreateNewSymbol(), ImportSymbol(), and saveLibrary().

◆ GetTargetLibId()

LIB_ID SYMBOL_EDIT_FRAME::GetTargetLibId ( ) const
overridevirtual

Return either the symbol selected in the symbol tree (if context menu is active) or the symbol on the editor canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1244 of file symbol_edit_frame.cpp.

References empty(), GetTreeLIBID(), IsLibraryTreeShown(), and m_symbol.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), DeleteSymbolFromLibrary(), DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::FlattenSymbol(), getTargetLib(), Revert(), SaveLibraryAs(), and setupUIConditions().

◆ getTargetSymbol()

LIB_SYMBOL * SYMBOL_EDIT_FRAME::getTargetSymbol ( ) const
private

Return either the library selected in the symbol tree, if context menu is active or the library that is currently modified.

Definition at line 1230 of file symbol_edit_frame.cpp.

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), GetTreeLIBID(), IsLibraryTreeShown(), LIB_ID::IsValid(), m_libMgr, and m_symbol.

Referenced by ExportSymbol(), saveSymbolCopyAs(), and setupUIConditions().

◆ GetTitleBlock()

const TITLE_BLOCK & SCH_BASE_FRAME::GetTitleBlock ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 221 of file sch_base_frame.cpp.

References GetScreen(), and SCH_SCREEN::GetTitleBlock().

◆ GetToolCanvas()

wxWindow * EDA_DRAW_FRAME::GetToolCanvas ( ) const
inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 462 of file eda_draw_frame.h.

References GetCanvas().

◆ GetToolDispatcher()

TOOL_DISPATCHER * TOOLS_HOLDER::GetToolDispatcher ( ) const
inlineinherited

Definition at line 57 of file tools_holder.h.

References m_toolDispatcher.

◆ GetToolManager()

TOOL_MANAGER * TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

References m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), PCB_EDIT_FRAME::CanAcceptApiCommands(), EDA_DRAW_FRAME::CommonSettingsChanged(), CommonSettingsChanged(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), SCH_FIELD::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), PCB_TUNING_PATTERN::GetPreviewItems(), PCBNEW_JOBS_HANDLER::getToolManager(), API_HANDLER_PCB::handleAddToSelection(), API_HANDLER_PCB::handleClearSelection(), API_HANDLER_PCB::handleGetSelection(), API_HANDLER_PCB::handleInteractiveMoveItems(), API_HANDLER_PCB::handleRefillZones(), API_HANDLER_PCB::handleRemoveFromSelection(), API_HANDLER_PCB::handleSaveSelectionToString(), API_HANDLER_PCB::handleSetBoardOrigin(), PCB_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PCB_EDIT_FRAME::OnCrossProbeFlashTimer(), SCH_EDIT_FRAME::OnCrossProbeFlashTimer(), FOOTPRINT_CHOOSER_FRAME::onFpChanged(), PANEL_COMPONENT_CLASS_ASSIGNMENT::OnHighlightItemsClick(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), PCB_EDIT_FRAME::OnNetlistChanged(), SCH_EDIT_FRAME::onNetNavigatorSelection(), DIALOG_PLOT::onRunDRC(), PCB_EDIT_FRAME::onSize(), SCH_EDIT_FRAME::onSize(), PCB_DESIGN_BLOCK_PANE::PCB_DESIGN_BLOCK_PANE(), PopTool(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), PCB_BASE_FRAME::rebuildConnectivity(), SCH_EDIT_FRAME::RecalculateConnections(), FOOTPRINT_EDIT_FRAME::ReloadFootprint(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), SCH_COMMIT::SCH_COMMIT(), SCH_DESIGN_BLOCK_PANE::SCH_DESIGN_BLOCK_PANE(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), NL_GERBVIEW_PLUGIN_IMPL::SetActiveCommand(), NL_PCBNEW_PLUGIN_IMPL::SetActiveCommand(), NL_PL_EDITOR_PLUGIN_IMPL::SetActiveCommand(), NL_SCHEMATIC_PLUGIN_IMPL::SetActiveCommand(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_MAINFRAME::setupEventHandlers(), FOOTPRINT_EDIT_FRAME::setupTools(), ShowChangedLanguage(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), CVPCB_MAINFRAME::updateFootprintViewerOnIdle(), and GLOBAL_EDIT_TOOL::ZonesManager().

◆ GetTreeLIBID()

LIB_ID SYMBOL_EDIT_FRAME::GetTreeLIBID ( int * aUnit = nullptr) const

◆ GetTreeLIBIDs()

int SYMBOL_EDIT_FRAME::GetTreeLIBIDs ( std::vector< LIB_ID > & aSelection) const

Definition at line 1224 of file symbol_edit_frame.cpp.

References GetLibTree(), and LIB_TREE::GetSelectedLibIds().

Referenced by CopySymbolToClipboard(), and GetSelectedLibIds().

◆ GetTreeSelectionCount()

int SYMBOL_EDIT_FRAME::GetTreeSelectionCount ( ) const

Definition at line 1219 of file symbol_edit_frame.cpp.

References GetLibTree(), and LIB_TREE::GetSelectionCount().

Referenced by SYMBOL_EDITOR_CONTROL::Init().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

◆ GetTypeFromUnits()

static EDA_DATA_TYPE UNITS_PROVIDER::GetTypeFromUnits ( const EDA_UNITS aUnits)
inlinestaticinherited

Gets the inferred type from the given units.

Note: will always return the most simple type (e.g. a DISTANCE rather than AREA or VOLUME for a measurement unit).

Definition at line 219 of file units_provider.h.

References CM, DEGREES, DISTANCE, FS, INCH, LENGTH_DELAY, MILS, MM, PERCENT, PS, PS_PER_CM, PS_PER_INCH, PS_PER_MM, TIME, UM, UNITLESS, and UNSCALED.

Referenced by DRC_RULES_PARSER::parseConstraint(), and WX_GRID::SetAutoEvalColUnits().

◆ GetUndoActionDescription()

wxString EDA_BASE_FRAME::GetUndoActionDescription ( ) const
virtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 1649 of file eda_base_frame.cpp.

References GetUndoCommandCount(), and m_undoList.

Referenced by HandleUpdateUIEvent().

◆ GetUndoCommandCount()

◆ GetUnit()

◆ GetUnitPair()

void EDA_DRAW_FRAME::GetUnitPair ( EDA_UNITS & aPrimaryUnit,
EDA_UNITS & aSecondaryUnits )
overridevirtualinherited

Get the pair or units in current use.

The primary unit is the main unit of the frame, and the secondary unit is the unit of the other system that was used most recently.

Reimplemented from UNITS_PROVIDER.

Definition at line 1301 of file eda_draw_frame.cpp.

References COMMON_TOOLS::GetLastImperialUnits(), COMMON_TOOLS::GetLastMetricUnits(), UNITS_PROVIDER::GetUserUnits(), EDA_UNIT_UTILS::IsImperialUnit(), TOOLS_HOLDER::m_toolManager, MILS, and MM.

Referenced by GRID_MENU::BuildChoiceList(), and PCB_EDIT_FRAME::UpdateTrackWidthSelectBox().

◆ GetUnitsFromType()

EDA_UNITS UNITS_PROVIDER::GetUnitsFromType ( EDA_DATA_TYPE aType) const
inlineinherited

Gets the units to use in the conversion based on the underlying user units.

Definition at line 197 of file units_provider.h.

References GetUserUnits(), EDA_UNIT_UTILS::IsMetricUnit(), LENGTH_DELAY, PS, PS_PER_CM, PS_PER_INCH, and TIME.

Referenced by MessageTextFromMinOptMax(), MessageTextFromValue(), OptionalValueFromString(), StringFromOptionalValue(), StringFromValue(), and ValueFromString().

◆ GetUntranslatedAboutTitle()

const wxString & EDA_BASE_FRAME::GetUntranslatedAboutTitle ( ) const
inlineinherited

Definition at line 542 of file eda_base_frame.h.

References m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetUserUnits()

◆ GetViewerSettingsBase()

APP_SETTINGS_BASE * SCH_BASE_FRAME::GetViewerSettingsBase ( ) const
inherited

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

Definition at line 1000 of file eda_base_frame.cpp.

References APP_SETTINGS_BASE::m_Window.

Referenced by LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), 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 1709 of file eda_base_frame.cpp.

References KICAD_MAIN_FRAME_T, and m_ident.

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

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const
inherited

Return a human readable value for display in dialogs.

Definition at line 781 of file eda_draw_frame.cpp.

References m_canvas, and zoom.

Referenced by UpdateStatusBar(), and PL_EDITOR_FRAME::UpdateStatusBar().

◆ handleActivateEvent()

void SCH_BASE_FRAME::handleActivateEvent ( wxActivateEvent & aEvent)
overrideprotectedvirtualinherited

Handle a window activation event.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 667 of file sch_base_frame.cpp.

References EDA_DRAW_FRAME::handleActivateEvent(), and m_spaceMouse.

◆ handleIconizeEvent()

void SCH_BASE_FRAME::handleIconizeEvent ( wxIconizeEvent & aEvent)
overrideprotectedvirtualinherited

Handle a window iconize event.

Parameters
aEventis the data for the event.

Reimplemented from EDA_BASE_FRAME.

Definition at line 676 of file sch_base_frame.cpp.

References EDA_BASE_FRAME::handleIconizeEvent(), and m_spaceMouse.

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )
virtualinherited

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

Definition at line 1733 of file eda_base_frame.cpp.

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

Referenced by 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 413 of file eda_base_frame.cpp.

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

Referenced by RegisterUIUpdateHandler().

◆ HardRedraw()

void SYMBOL_EDIT_FRAME::HardRedraw ( )
overridevirtual

Rebuild the GAL and redraw the screen.

Call when something went wrong.

Reimplemented from SCH_BASE_FRAME.

Definition at line 1503 of file symbol_edit_frame.cpp.

References alg::contains(), SCH_SELECTION_TOOL::GetSelection(), m_symbol, TOOLS_HOLDER::m_toolManager, RebuildView(), and SyncLibraries().

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

References m_kiway.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ HasLibModifications()

bool SYMBOL_EDIT_FRAME::HasLibModifications ( ) const

Check if any pending libraries have been modified.

This only checks for modified libraries. If a new symbol was created and modified and no libraries have been modified, the return value will be false.

Returns
True if there are any pending library modifications.

Definition at line 1734 of file symbol_edit_frame.cpp.

References m_libMgr.

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 1019 of file eda_base_frame.cpp.

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

◆ HighlightSelectionFilter()

void SCH_BASE_FRAME::HighlightSelectionFilter ( const SCH_SELECTION_FILTER_OPTIONS & aOptions)
inherited

Definition at line 948 of file sch_base_frame.cpp.

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

◆ ImportSymbol()

◆ initExitKey()

void EDA_BASE_FRAME::initExitKey ( )
protectedinherited

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

Referenced by commonInit().

◆ IntersheetRefUpdate()

virtual void SCHEMATIC_HOLDER::IntersheetRefUpdate ( SCH_GLOBALLABEL * aItem)
inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 47 of file schematic_holder.h.

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

References m_autoSaveRequired.

Referenced by ProcessEvent().

◆ IsClosing()

bool EDA_BASE_FRAME::IsClosing ( ) const
inlineinherited

Definition at line 621 of file eda_base_frame.h.

References m_isClosing.

◆ IsContentModified()

bool SYMBOL_EDIT_FRAME::IsContentModified ( ) const
overridevirtual

Get if any symbols or libraries have been modified but not saved.

Returns
true if the any changes have not been saved

Reimplemented from EDA_BASE_FRAME.

Definition at line 1742 of file symbol_edit_frame.cpp.

References GetCurSymbol(), SCH_BASE_FRAME::GetScreen(), IsContentModified(), and m_libMgr.

Referenced by CanCloseSymbolFromSchematic(), canCloseWindow(), IsContentModified(), LoadSymbol(), LoadSymbol(), storeCurrentSymbol(), and UpdateTitle().

◆ IsCurrentSymbol()

bool SYMBOL_EDIT_FRAME::IsCurrentSymbol ( const LIB_ID & aLibId) const

Restore the empty editor screen, without any symbol or library selected.

Definition at line 1388 of file symbol_edit_frame.cpp.

References LIB_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), m_libMgr, and m_symbol.

Referenced by DeleteSymbolFromLibrary(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), and Revert().

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

References m_modal_loop.

Referenced by FOOTPRINT_CHOOSER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), and SYMBOL_CHOOSER_FRAME::doCloseWindow().

◆ IsGridOverridden()

bool EDA_DRAW_FRAME::IsGridOverridden ( ) const
inherited

◆ IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( ) const
inherited

◆ IsLibraryTreeShown()

bool SYMBOL_EDIT_FRAME::IsLibraryTreeShown ( ) const
overridevirtual

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

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

◆ IsPluginActionButtonVisible()

bool EDA_DRAW_FRAME::IsPluginActionButtonVisible ( const PLUGIN_ACTION & aAction,
APP_SETTINGS_BASE * aCfg )
staticinherited

◆ IsScriptingConsoleVisible()

bool EDA_DRAW_FRAME::IsScriptingConsoleVisible ( )
inherited

Get the current visibility of the scripting console window.

Definition at line 300 of file eda_draw_frame.cpp.

References FRAME_PYTHON, KIWAY_HOLDER::Kiway(), KIWAY_PLAYER::KIWAY_PLAYER(), and KIWAY::Player().

Referenced by EDITOR_CONDITIONS::consoleVisibleFunc().

◆ IsSymbolAlias()

bool SYMBOL_EDIT_FRAME::IsSymbolAlias ( ) const

Return true if aLibId is an alias for the editor screen symbol.

Definition at line 2005 of file symbol_edit_frame.cpp.

References m_symbol.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), RebuildView(), SCH_SELECTION_TOOL::Selectable(), SetCurSymbol(), and setupUIConditions().

◆ IsSymbolEditable()

bool SYMBOL_EDIT_FRAME::IsSymbolEditable ( ) const

Test if a symbol is loaded and can be edited.

The following conditions are required for a symbol to be editable:

  • The symbol must selected from either a library or the schematic.
  • The symbol must not be from a legacy library.

Note that many things are not editable in a non-root symbol (ie: an alias), but others are so this routine no longer returns false for an alias.

Definition at line 2011 of file symbol_edit_frame.cpp.

References IsSymbolFromLegacyLibrary(), IsSymbolFromSchematic(), and m_symbol.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), and setupUIConditions().

◆ IsSymbolFromLegacyLibrary()

◆ IsSymbolFromSchematic()

◆ IsType()

◆ IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName & aFileName,
bool aVerbose = true )
inherited

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

References _, and DisplayErrorMessage().

Referenced by PCB_EDIT_FRAME::DoAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::saveBoardAsFile(), 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.

References m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), IMPORT_PROJ_HELPER::addLocalLibraries(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesList(), KICAD_MANAGER_FRAME::CloseProject(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), KIWAY_PLAYER::Destroy(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), PGM_SINGLE_TOP::MacOpenFile(), PCB_CALCULATOR_FRAME::OnExit(), SIMULATOR_FRAME::onExit(), EDA_3D_CANVAS::OnLeftDown(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::PCB_DESIGN_BLOCK_PREVIEW_WIDGET(), Prj(), SCH_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), BOARD_EDITOR_CONTROL::ShowEeschema(), CVPCB_CONTROL::ShowFootprintViewer(), showFrame(), EDA_BASE_FRAME::ShowPreferences(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), KICAD_MANAGER_FRAME::UnarchiveFiles(), 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 179 of file kiway_player.cpp.

References KiwayMailIn().

◆ KiwayMailIn()

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent & event)
protectedinherited

An event handler called on a language menu selection.

Definition at line 186 of file kiway_player.cpp.

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

◆ libeditconfig()

◆ LibraryFileBrowser()

bool EDA_DRAW_FRAME::LibraryFileBrowser ( const wxString & aTitle,
bool doOpen,
wxFileName & aFilename,
const wxString & wildcard,
const wxString & ext,
bool isDirectory,
FILEDLG_HOOK_NEW_LIBRARY * aFileDlgHook = nullptr )
inherited
Parameters
aTitledialog title
doOpenif true runs an Open Library browser, otherwise New Library
aFilenamefor New may contain a default name; in both cases return the chosen filename.
wildcarda wildcard to filter the displayed files
extthe library file extension
isDirectoryindicates the library files are directories
aFileDlgHookoptional; adds customized controls to dialog
Returns
true for OK; false for Cancel.

Definition at line 1181 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::GetMruPath(), and EDA_BASE_FRAME::SetMruPath().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), PCB_BASE_EDIT_FRAME::createNewLibrary(), and SCH_BASE_FRAME::SelectLibrary().

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )
protectedinherited

◆ LoadOneLibrarySymbolAux()

bool SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux ( LIB_SYMBOL * aLibEntry,
const wxString & aLibrary,
int aUnit,
int aBodyStyle )
private

Create a copy of aLibEntry into memory.

Parameters
aLibEntryA pointer to the LIB_SYMBOL object to an already loaded symbol.
aLibrarythe path to the library file that aLibEntry was loaded from. This is for error messaging purposes only.
aUnitthe initial unit to show.
aBodyStylethe initial DeMorgan variant to show.
Returns
True if a copy of aLibEntry was successfully copied. Create a backup copy of a file with requested extension.

Definition at line 257 of file symbol_editor.cpp.

References KIGFX::ALL, ACTIONS::cancelInteractive, EDA_BASE_FRAME::ClearUndoRedoList(), WX_INFOBAR::Dismiss(), SCH_BASE_FRAME::GetCanvas(), GetCurSymbol(), EDA_BASE_FRAME::GetInfoBar(), LIB_SYMBOL::GetLibId(), LIB_SYMBOL::GetName(), SCH_BASE_FRAME::GetScreen(), SCH_DRAW_PANEL::GetView(), IsSymbolFromSchematic(), m_bodyStyle, m_dummyScreen, m_isSymbolFromSchematic, m_libMgr, m_symbol, TOOLS_HOLDER::m_toolManager, m_unit, TOOL_BASE::MODEL_RELOAD, RebuildSymbolUnitAndBodyStyleLists(), EDA_BASE_FRAME::ReCreateMenuBar(), EDA_BASE_FRAME::RecreateToolbars(), Refresh(), SetCurLib(), SetCurSymbol(), SetScreen(), SCH_BASE_FRAME::setSymWatcher(), KIGFX::VIEW::UpdateAllItems(), UpdateMsgPanel(), and UpdateTitle().

Referenced by DuplicateSymbol(), LoadSymbol(), and LoadSymbolFromCurrentLib().

◆ LoadSettings()

void SYMBOL_EDIT_FRAME::LoadSettings ( APP_SETTINGS_BASE * aCfg)
overridevirtual

Load common frame parameters from a configuration file.

Don't forget to call the base method or your frames won't remember their positions and sizes.

Reimplemented from SCH_BASE_FRAME.

Definition at line 319 of file symbol_edit_frame.cpp.

References SCH_BASE_FRAME::GetRenderSettings(), GetSettings(), SCH_BASE_FRAME::LoadSettings(), m_settings, SCH_RENDER_SETTINGS::m_ShowHiddenFields, SCH_RENDER_SETTINGS::m_ShowHiddenPins, SCH_RENDER_SETTINGS::m_ShowPinAltIcons, SCH_RENDER_SETTINGS::m_ShowPinsElectricalType, and KIGFX::RENDER_SETTINGS::SetDefaultFont().

Referenced by SYMBOL_EDIT_FRAME().

◆ LoadSymbol() [1/2]

bool SYMBOL_EDIT_FRAME::LoadSymbol ( const LIB_ID & aLibId,
int aUnit,
int aBodyStyle )

◆ LoadSymbol() [2/2]

◆ LoadSymbolFromCurrentLib()

bool SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib ( const wxString & aSymbolName,
int aUnit = 0,
int aBodyStyle = 0 )
private

Load a symbol from the current active library, optionally setting the selected unit and convert.

Parameters
aSymbolNameThe symbol alias name to load from the current library.
aUnitUnit to be selected
aBodyStyleConvert to be selected
Returns
true if the symbol loaded correctly.

Definition at line 222 of file symbol_editor.cpp.

References _, EDA_BASE_FRAME::ClearUndoRedoList(), DisplayErrorMessage(), GetCurLib(), GetCurSymbol(), LIB_SYMBOL::IsMultiUnit(), LoadOneLibrarySymbolAux(), SYMBOL_LIB_TABLE::LoadSymbol(), m_SyncPinEdit, TOOLS_HOLDER::m_toolManager, Prj(), RebuildSymbolUnitAndBodyStyleLists(), PROJECT_SCH::SchSymbolLibTable(), LIB_SYMBOL::UnitsLocked(), IO_ERROR::What(), and ACTIONS::zoomFitScreen.

Referenced by LoadSymbol(), and SetCurSymbol().

◆ LoadSymbolFromSchematic()

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

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

Referenced by LoadSettings().

◆ LoadWindowState() [1/2]

◆ LoadWindowState() [2/2]

◆ LockFile()

bool EDA_DRAW_FRAME::LockFile ( const wxString & aFileName)
inherited

Mark a schematic file as being in use.

Use ReleaseFile() to undo this.

Parameters
aFileNamefull path to the file.
Returns
true if the file is locked or read-only, false otherwise.

Definition at line 244 of file eda_draw_frame.cpp.

References m_file_checker, and Pgm().

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

◆ MakeGridHelper()

std::unique_ptr< GRID_HELPER > SYMBOL_EDIT_FRAME::MakeGridHelper ( )
overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1717 of file symbol_edit_frame.cpp.

References TOOLS_HOLDER::m_toolManager.

◆ MessageTextFromMinOptMax()

wxString UNITS_PROVIDER::MessageTextFromMinOptMax ( const MINOPTMAX< int > & aValue,
EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) 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 123 of file units_provider.h.

References DISTANCE, GetIuScale(), GetUnitsFromType(), and EDA_UNIT_UTILS::UI::MessageTextFromValue().

Referenced by CheckDuplicatePins(), CheckLibSymbol(), CheckLibSymbolGraphics(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), GERBVIEW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DRC_ENGINE::EvalRules(), DRC_TEST_PROVIDER::formatMsg(), DRC_TEST_PROVIDER::formatMsg(), DS_DRAW_ITEM_LINE::GetItemDescription(), DS_DRAW_ITEM_RECT::GetItemDescription(), PCB_TRACK::GetItemDescription(), SCH_LINE::GetItemDescription(), SCH_SHAPE::GetItemDescription(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_POINT::GetMsgPanelInfo(), PCB_REFERENCE_IMAGE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), 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(), STROKE_PARAMS::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), GetNetNavigatorItemText(), PCB_BASE_FRAME::MessageTextFromCoord(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), EDA_SHAPE::ShapeGetMsgPanelInfo(), showCoord(), DRC_TEST_PROVIDER_MISC::testOutline(), VIA_SIZE_MENU::update(), PL_EDITOR_FRAME::UpdateMsgPanelInfo(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), and SCH_BASE_FRAME::UpdateStatusBar().

◆ NetInspectorPanelName()

static const wxString EDA_DRAW_FRAME::NetInspectorPanelName ( )
inlinestaticinherited

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce)
inlineinherited

Definition at line 623 of file eda_base_frame.h.

References m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onActivate()

void EDA_DRAW_FRAME::onActivate ( wxActivateEvent & aEvent)
protectedinherited

Definition at line 1346 of file eda_draw_frame.cpp.

References handleActivateEvent().

◆ OnApiPluginInvoke()

void EDA_DRAW_FRAME::OnApiPluginInvoke ( wxCommandEvent & aEvent)
virtualinherited

Handler for activating an API plugin (via toolbar or menu).

Definition at line 1472 of file eda_draw_frame.cpp.

References API_PLUGIN_MANAGER::ButtonBindings(), API_PLUGIN_MANAGER::InvokeAction(), and Pgm().

Referenced by AddApiPluginTools().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 350 of file eda_base_frame.cpp.

References doAutoSave(), GetAutoSaveInterval(), ID_AUTO_SAVE_TIMER, and m_autoSaveTimer.

Referenced by commonInit(), and ~EDA_BASE_FRAME().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent & aKeyEvent)
virtualinherited

Capture the key event before it is sent to the GUI.

The basic frame does not capture this event. Editor frames should override this event function to capture and filter these keys when they are used as hotkeys, and skip it if the key is not used as hotkey (otherwise the key events will be not sent to menus).

Reimplemented in FOOTPRINT_VIEWER_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 370 of file eda_base_frame.cpp.

References dump(), and kicadTraceKeyEvent.

◆ OnDropFiles()

void EDA_BASE_FRAME::OnDropFiles ( wxDropFilesEvent & aEvent)
protectedvirtualinherited

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

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

◆ OnExitKiCad()

void SYMBOL_EDIT_FRAME::OnExitKiCad ( wxCommandEvent & event)

Definition at line 807 of file symbol_edit_frame.cpp.

References Kiway, and KIWAY::OnKiCadExit().

◆ OnFindDialogClose()

void SCH_BASE_FRAME::OnFindDialogClose ( )
inherited

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent & aEvent)
protectedinherited

Definition at line 1759 of file eda_base_frame.cpp.

References handleIconizeEvent().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event)
inherited

Definition at line 1181 of file eda_base_frame.cpp.

References EDA_BASE_FRAME(), and 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 380 of file eda_base_frame.cpp.

References TOOLS_HOLDER::m_toolDispatcher.

◆ OnModify()

void SYMBOL_EDIT_FRAME::OnModify ( )
overridevirtual

◆ OnMove()

void EDA_DRAW_FRAME::OnMove ( wxMoveEvent & aEvent)
overridevirtualinherited

◆ OnPageSettingsChange()

virtual void EDA_DRAW_FRAME::OnPageSettingsChange ( )
inlinevirtualinherited

Called when modifying the page settings.

In derived classes it can be used to modify parameters like draw area size, and any other local parameter related to the page settings.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 350 of file eda_draw_frame.h.

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event)
inherited

Definition at line 1188 of file eda_base_frame.cpp.

References ShowPreferences().

◆ OnSelectBodyStyle()

void SYMBOL_EDIT_FRAME::OnSelectBodyStyle ( wxCommandEvent & event)

Definition at line 834 of file symbol_edit_frame.cpp.

References SetBodyStyle().

◆ OnSelectGrid()

void EDA_DRAW_FRAME::OnSelectGrid ( wxCommandEvent & event)
inherited

Command event handler for selecting grid sizes.

All commands that set the grid size should eventually end up here. This is where the application setting is saved. If you override this method, make sure you call down to the base class.

Parameters
eventCommand event from the grid size combobox on the toolbar.

Definition at line 481 of file eda_draw_frame.cpp.

References dummy, ACTIONS::gridPreset, ACTIONS::gridProperties, m_canvas, m_gridSelectBox, TOOLS_HOLDER::m_toolManager, OnUpdateSelectGrid(), and UpdateStatusBar().

◆ OnSelectUnit()

void SYMBOL_EDIT_FRAME::OnSelectUnit ( wxCommandEvent & event)

Definition at line 819 of file symbol_edit_frame.cpp.

References SetUnit().

◆ OnSelectZoom()

void EDA_DRAW_FRAME::OnSelectZoom ( wxCommandEvent & event)
virtualinherited

Set the zoom factor when selected by the zoom list box in the main tool bar.

Note
List position 0 is fit to page. List position >= 1 = zoom (1 to zoom max). Last list position is custom zoom not in zoom list.

Definition at line 607 of file eda_draw_frame.cpp.

References m_canvas, TOOLS_HOLDER::m_toolManager, m_zoomSelectBox, UpdateStatusBar(), and ACTIONS::zoomPreset.

◆ OnSize()

void EDA_DRAW_FRAME::OnSize ( wxSizeEvent & event)
overridevirtualinherited

Recalculate the size of toolbars and display panel when the frame size changes.

Reimplemented from EDA_BASE_FRAME.

Reimplemented in FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 715 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_frameSize, and EDA_BASE_FRAME::OnSize().

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

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent & evt)
inherited

Definition at line 69 of file eda_dde.cpp.

References client_ipc_buffer, 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 m_sockets.

◆ OnSymChange()

void SCH_BASE_FRAME::OnSymChange ( wxFileSystemWatcherEvent & aEvent)
inherited

Handler for Symbol change events.

Responds to the filesystem watcher set in setSymWatcher.

Definition at line 875 of file sch_base_frame.cpp.

References m_watcher, m_watcherDebounceTimer, m_watcherFileName, KIWAY_HOLDER::Prj(), and PROJECT_SCH::SchLibs().

Referenced by setSymWatcher().

◆ OnSymChangeDebounceTimer()

void SCH_BASE_FRAME::OnSymChangeDebounceTimer ( wxTimerEvent & aEvent)
inherited

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent & aEvent)
protectedinherited

Definition at line 1749 of file eda_base_frame.cpp.

References HandleSystemColorChange().

◆ OnToolbarSizeChanged()

void EDA_BASE_FRAME::OnToolbarSizeChanged ( )
inherited

Update toolbars if desired toolbar icon changed.

Definition at line 610 of file eda_base_frame.cpp.

References m_auimgr, m_tbLeft, m_tbRight, m_tbTopAux, and m_tbTopMain.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged().

◆ OnUpdateBodyStyle()

void SYMBOL_EDIT_FRAME::OnUpdateBodyStyle ( wxUpdateUIEvent & event)

Definition at line 828 of file symbol_edit_frame.cpp.

References m_symbol.

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent & aEvent)
inherited

Update the checked item in the grid wxchoice.

Definition at line 428 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::config(), WINDOW_SETTINGS::grid, GRID_SETTINGS::last_size_idx, m_gridSelectBox, and APP_SETTINGS_BASE::m_Window.

Referenced by OnSelectGrid().

◆ OnUpdateSelectZoom()

void EDA_DRAW_FRAME::OnUpdateSelectZoom ( wxUpdateUIEvent & aEvent)
inherited

◆ OnUpdateUnitNumber()

void SYMBOL_EDIT_FRAME::OnUpdateUnitNumber ( wxUpdateUIEvent & event)

Definition at line 813 of file symbol_edit_frame.cpp.

References m_symbol.

◆ OpenProjectFiles()

virtual bool KIWAY_PLAYER::OpenProjectFiles ( const std::vector< wxString > & aFileList,
int aCtl = 0 )
inlinevirtualinherited

Open a project or set of files given by aFileList.

This is generalized in the direction of worst case. In a typical case aFileList will only hold a single file, like "myboard.kicad_pcb" because any KIWAY_PLAYER is only in one KIWAY and the KIWAY owns the PROJECT. Therefore opening files from multiple projects into the same KIWAY_PLAYER is precluded.

Each derived class should handle this in a way specific to its needs. No filename prompting is done inside here for any file or project. There should be no need to call this with aFileList which is empty. However, calling it with a single filename which does not exist should indicate to the implementer that a new session is being started and that the given name is the desired name for the data file at time of save.

This function does not support "appending". Use a different function for that. Any prior project data tree should be cleared before loading the new stuff. Therefore, one of the first things an implementation should do is test for existence of the first file in the list, and if it does not exist, treat it as a new session, possibly with a UI notification to that effect.

After loading the window should update its Title as part of this operation. If the KIWAY_PLAYER needs to, it can load the *.pro file as part of this operation.

If the KIWAY_PLAYER cannot load any of the file(s) in the list, then it should say why through some GUI interface, and return false.

Parameters
aFileListincludes files that this frame should open according to the knowledge in the derived wxFrame. In almost every case, the list will have only a single file in it.
aCtlis a set of bit flags ORed together from the set of KICTL_* #defined above.
Returns
true if all requested files were opened OK, else false.

Reimplemented in BITMAP2CMP_FRAME, CVPCB_MAINFRAME, FOOTPRINT_EDIT_FRAME, GERBVIEW_FRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, and SCH_EDIT_FRAME.

Definition at line 113 of file kiway_player.h.

Referenced by PANEL_JOBSET::EnsurePcbSchFramesOpen(), BACK_ANNOTATE::FetchNetlistFromPCB(), PGM_SINGLE_TOP::MacOpenFile(), PGM_TEST_FRAME::MacOpenFile(), SCH_EDIT_FRAME::OnOpenPcbnew(), PGM_KICAD::OnPgmInit(), PGM_SINGLE_TOP::OnPgmInit(), SCH_EDIT_FRAME::OnUpdatePCB(), and PCB_EDIT_FRAME::TestStandalone().

◆ OptionalValueFromString()

std::optional< int > UNITS_PROVIDER::OptionalValueFromString ( const wxString & aTextValue,
EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const
inlineinherited

Converts aTextValue in aUnits to internal units used by the frame.

Allows the return of an empty optional if the string represents a null value (currently empty string)

Warning
This utilizes the current locale and will break if decimal formats differ
Parameters
aTypeis the type of this value, and controls the way the string is converted to a value
aTextValueA reference to a wxString object containing the string to convert.
Returns
internal units value

Definition at line 173 of file units_provider.h.

References DISTANCE, EDA_UNIT_UTILS::UI::DoubleValueFromString(), GetIuScale(), GetUnitsFromType(), KiROUND(), and NullUiString.

Referenced by WX_GRID::GetOptionalUnitValue(), and WX_GRID::onCellEditorHidden().

◆ PickSymbolFromLibrary()

PICKED_SYMBOL SCH_BASE_FRAME::PickSymbolFromLibrary ( const SYMBOL_LIBRARY_FILTER * aFilter,
std::vector< PICKED_SYMBOL > & aHistoryList,
std::vector< PICKED_SYMBOL > & aAlreadyPlaced,
bool aShowFootprints,
const LIB_ID * aHighlight = nullptr,
bool aAllowFields = true )
inherited

Call the library viewer to select symbol to import into schematic.

If the library viewer is currently running, it is closed and reopened in modal mode.

aAllowFields chooses whether or not features that permit the user to edit fields (e.g. footprint selection) should be enabled. This should be false when they would have no effect, for example loading a part into symbol_editor.

Parameters
aFilteris an optional SYMBOL_LIBRARY_FILTER filter to pass the allowed library names and/or the library name to load the symbol from and/or some other filter
aHistoryListis the list of previously loaded symbols - will be edited
aHighlightis the name of symbol to highlight in the list. highlights none if there isn't one by that name.
aShowFootprintsis the whether to show footprints in the dialog.
aAllowFieldsis whether to allow field editing in the dialog.
Returns
the selected symbol

Definition at line 51 of file picksymbol.cpp.

References PICKED_SYMBOL::Fields, DIALOG_SYMBOL_CHOOSER::g_Mutex, DIALOG_SYMBOL_CHOOSER::GetFields(), DIALOG_SYMBOL_CHOOSER::GetKeepSymbol(), DIALOG_SYMBOL_CHOOSER::GetPlaceAllUnits(), DIALOG_SYMBOL_CHOOSER::GetSelectedLibId(), LIB_ID::IsValid(), PICKED_SYMBOL::KeepSymbol, PICKED_SYMBOL::LibId, PICKED_SYMBOL::PlaceAllUnits, DIALOG_SHIM::ShowModal(), and PICKED_SYMBOL::Unit.

Referenced by DIALOG_EDIT_SYMBOLS_LIBID::setLibIdByBrowser().

◆ PluginActionScope()

virtual PLUGIN_ACTION_SCOPE EDA_DRAW_FRAME::PluginActionScope ( ) const
inlinevirtualinherited

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 513 of file eda_draw_frame.h.

References INVALID.

Referenced by AddApiPluginTools().

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )
virtualinherited

Return the last command to undo and remove it from list, nothing is deleted.

Definition at line 1643 of file eda_base_frame.cpp.

References m_redoList.

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

◆ PopCommandFromUndoList()

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const TOOL_EVENT & aEvent)
virtualinherited

◆ PrintDrawingSheet()

void EDA_DRAW_FRAME::PrintDrawingSheet ( const RENDER_SETTINGS * aSettings,
BASE_SCREEN * aScreen,
const std::map< wxString, wxString > * aProperties,
double aMils2Iu,
const wxString & aFilename,
const wxString & aSheetLayer = wxEmptyString )
inherited

Print the drawing-sheet (frame and title block).

Parameters
aScreenscreen to draw.
aPropertiesOptional properties for text variable resolution.
aMils2IuThe mils to Iu conversion factor.
aFilenameThe filename to display in basic inscriptions.
aSheetLayerThe layer displayed from PcbNew.

Definition at line 1137 of file eda_draw_frame.cpp.

References GetFullScreenDesc(), BASE_SCREEN::GetPageCount(), BASE_SCREEN::GetPageNumber(), GetPageSettings(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GetScreenDesc(), GetTitleBlock(), BASE_SCREEN::GetVirtualPageNumber(), m_showBorderAndTitleBlock, PrintDrawingSheet(), and KIWAY_HOLDER::Prj().

Referenced by PrintDrawingSheet().

◆ PrintMsg()

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

Definition at line 1025 of file eda_base_frame.cpp.

References text.

Referenced by KICAD_MANAGER_FRAME::UnarchiveFiles().

◆ 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(), and KIWAY::Prj().

Referenced by DESIGN_BLOCK_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesList(), PCB_BASE_FRAME::canCloseWindow(), SIMULATOR_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), CVPCB_MAINFRAME::DisplayStatus(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TABLECELL_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), EDA_3D_VIEWER_FRAME::getExportFileName(), PCB_BASE_FRAME::GetLibraryItemsForListDialog(), SCH_BASE_FRAME::GetLibraryItemsForListDialog(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), API_HANDLER_PCB::handleRevertDocument(), FIELDS_GRID_TABLE::initGrid(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SIMULATOR_FRAME::LoadSettings(), SIMULATOR_FRAME::LoadSimulator(), EDA_BASE_FRAME::LoadWindowState(), EDA_3D_VIEWER_FRAME::NewDisplay(), DIALOG_SIM_MODEL< T >::onBrowseButtonClick(), DIALOG_EXPORT_2581::onBrowseClicked(), DIALOG_EXPORT_ODBPP::onBrowseClicked(), DIALOG_EXPORT_STEP::onBrowseClicked(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowseClicked(), DIALOG_IMPORT_NETLIST::onBrowseNetlistFiles(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), DIALOG_EXPORT_STEP::onExportButton(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), DIALOG_GENDRILL::onGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_CONFIG_EQUFILES::OnOkClick(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_PLOT::onOpenOutputDirectory(), DIALOG_GEN_FOOTPRINT_POSITION::onOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::onOutputDirectoryBrowseClicked(), DIALOG_PLOT::onOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::onOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_FIELDS_TABLE::OnOutputFileBrowseClicked(), DIALOG_BOARD_SETUP::onPageChanged(), DIALOG_SCHEMATIC_SETUP::onPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_DRC::OnSaveReport(), DIALOG_ERC::OnSaveReport(), SCH_BASE_FRAME::OnSymChange(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), EDA_DRAW_FRAME::PrintDrawingSheet(), KICAD_MANAGER_FRAME::PrintPrjInfo(), KICAD_MANAGER_FRAME::ProjectChanged(), CVPCB_MAINFRAME::readNetListAndFpFiles(), EDA_3D_VIEWER_FRAME::ReloadRequest(), SIMULATOR_FRAME::ReloadSimulator(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), SAVE_SYMBOL_AS_DIALOG::SAVE_SYMBOL_AS_DIALOG(), KICAD_MANAGER_FRAME::SaveOpenJobSetsToLocalSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SIMULATOR_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), SCH_BASE_FRAME::SelectLibrary(), PCB_BASE_FRAME::setFPWatcher(), GERBVIEW_FRAME::SetPageSettings(), SCH_BASE_FRAME::setSymWatcher(), DIALOG_LIB_FIELDS_TABLE::SetupColumnProperties(), DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties(), BOARD_EDITOR_CONTROL::ShowEeschema(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_SIM_MODEL< T >::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataToWindow(), KICAD_MANAGER_FRAME::UnarchiveFiles(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), SIMULATOR_FRAME::UpdateTitle(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), and EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME().

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent & aEvent)
overrideinherited

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

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

Definition at line 300 of file eda_base_frame.cpp.

References findQuasiModalDialog(), GetAutoSaveInterval(), isAutoSaveRequired(), m_autoSavePending, m_autoSaveTimer, m_isClosing, 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 538 of file eda_base_frame.h.

Referenced by KIWAY::ProjectChanged().

◆ PropertiesPaneName()

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST * aItem)
virtualinherited

Add a command to redo in the redo list.

Delete the very old commands when the max count of redo commands is reached.

Definition at line 1622 of file eda_base_frame.cpp.

References ClearUndoORRedoList(), GetRedoCommandCount(), m_redoList, m_undoRedoCountMax, and REDO_LIST.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), and PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList().

◆ PushCommandToUndoList()

◆ PushSymbolToUndoList()

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

References DisplayToolMsg(), TOOL_EVENT::getCommandStr(), TOOL_ACTION::GetFriendlyName(), m_toolManager, and m_toolStack.

Referenced by EDIT_TOOL::doMoveSelection(), PCB_VIEWER_TOOLS::MeasureTool(), and EDIT_TOOL::Remove().

◆ RebuildSymbolUnitAndBodyStyleLists()

◆ RebuildView()

◆ ReCreateAuxiliaryToolbar()

virtual void EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar ( )
inlinevirtualinherited

◆ ReCreateHToolbar()

virtual void EDA_DRAW_FRAME::ReCreateHToolbar ( )
inlinevirtualinherited

◆ ReCreateLeftToolbar()

virtual void EDA_DRAW_FRAME::ReCreateLeftToolbar ( )
inlinevirtualinherited

Definition at line 219 of file eda_draw_frame.h.

◆ ReCreateMenuBar()

◆ RecreateToolbars()

◆ ReCreateVToolbar()

virtual void EDA_DRAW_FRAME::ReCreateVToolbar ( )
inlinevirtualinherited

Definition at line 218 of file eda_draw_frame.h.

◆ RedrawScreen()

void SCH_BASE_FRAME::RedrawScreen ( const VECTOR2I & aCenterPoint,
bool aWarpPointer )
virtualinherited

◆ RefreshCanvas()

void EDA_DRAW_FRAME::RefreshCanvas ( )
inlineoverridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 469 of file eda_draw_frame.h.

References GetCanvas(), and EDA_DRAW_PANEL_GAL::Refresh().

Referenced by SCH_EDIT_FRAME::OnImportProject().

◆ RefreshLibraryTree()

void SYMBOL_EDIT_FRAME::RefreshLibraryTree ( )

Redisplay the library tree.

Used after changing modified states, descriptions, etc.

Definition at line 1336 of file symbol_edit_frame.cpp.

References GetLibTree(), and LIB_TREE::RefreshLibTree().

Referenced by KiwayMailIn().

◆ RefreshZoomDependentItems()

◆ RegisterCustomToolbarControlFactory()

void EDA_BASE_FRAME::RegisterCustomToolbarControlFactory ( const ACTION_TOOLBAR_CONTROL & aControlDesc,
const ACTION_TOOLBAR_CONTROL_FACTORY & aControlFactory )
inherited

Register a creation factory for toolbar controls that are present in this frame.

The factory function takes a single argument of type ACTION_TOOLBAR*, which is the toolbar to add the controls to.

Parameters
aControlDescis the control descriptor
aControlFactoryA functor that creates the custom controls and then adds them to the toolbar

Definition at line 499 of file eda_base_frame.cpp.

References ACTION_TOOLBAR_CONTROL::GetName(), and m_toolbarControlFactories.

Referenced by CVPCB_MAINFRAME::configureToolbars(), EDA_DRAW_FRAME::configureToolbars(), GERBVIEW_FRAME::configureToolbars(), PCB_BASE_EDIT_FRAME::configureToolbars(), PCB_EDIT_FRAME::configureToolbars(), PL_EDITOR_FRAME::configureToolbars(), SCH_EDIT_FRAME::configureToolbars(), SYMBOL_EDIT_FRAME::configureToolbars(), and SYMBOL_VIEWER_FRAME::configureToolbars().

◆ RegisterUIUpdateHandler() [1/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 389 of file eda_base_frame.cpp.

References HandleUpdateUIEvent(), and m_uiUpdateMap.

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

◆ RegisterUIUpdateHandler() [2/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 43 of file tools_holder.cpp.

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

Referenced by RegisterUIUpdateHandler().

◆ ReleaseFile()

void EDA_DRAW_FRAME::ReleaseFile ( )
inherited

Release the current file marked in use.

See m_file_checker.

Definition at line 237 of file eda_draw_frame.cpp.

References m_file_checker.

Referenced by PCB_EDIT_FRAME::Clear_Pcb(), API_HANDLER_PCB::handleRevertDocument(), and ~EDA_DRAW_FRAME().

◆ RemoveFromScreen()

void SCH_BASE_FRAME::RemoveFromScreen ( EDA_ITEM * aItem,
SCH_SCREEN * aScreen )
overridevirtualinherited

Remove an item from the screen (and view) aScreen is the screen the item is located on, if not the current screen.

Implements SCHEMATIC_HOLDER.

Definition at line 506 of file sch_base_frame.cpp.

References GetCanvas(), GetScreen(), SCH_DRAW_PANEL::GetView(), KIGFX::VIEW::Remove(), SCH_TABLECELL_T, EDA_ITEM::Type(), and UpdateItem().

Referenced by SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_FRAME::PutDataInPreviousState(), and SCH_EDIT_FRAME::TrimWire().

◆ replaceLibTableEntry()

bool SYMBOL_EDIT_FRAME::replaceLibTableEntry ( const wxString & aLibNickname,
const wxString & aLibFile )
private

Replace the file path of the symbol library table entry aLibNickname with aLibFile.

Note
The library defined by aLibFile must be a KiCad (s-expression) library.
Parameters
aLibNickmaneis the nickname of an existing library table entry.
aLibFileis the full path and file name of the symbol library to replace in the table.
Returns
true if successful or false if a failure occurs.

Definition at line 1953 of file symbol_edit_frame.cpp.

References _, SYMBOL_LIB_TABLE::FindRow(), SYMBOL_LIB_TABLE::GetGlobalLibTable(), SYMBOL_LIB_TABLE::GetGlobalTableFileName(), PGM_BASE::GetLocalEnvVariables(), PROJECT::GetProjectPath(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), NormalizePath(), Pgm(), Prj(), LIB_TABLE::Save(), PROJECT_SCH::SchSymbolLibTable(), LIB_TABLE_ROW::SetFullURI(), SYMBOL_LIB_TABLE_ROW::SetType(), and IO_ERROR::What().

Referenced by saveLibrary().

◆ resolveCanvasType()

void EDA_DRAW_FRAME::resolveCanvasType ( )
protectedvirtualinherited

◆ ResolveItem()

virtual EDA_ITEM * EDA_DRAW_FRAME::ResolveItem ( const KIID & aId,
bool aAllowNullptrReturn = false ) const
inlinevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented in PCB_BASE_FRAME, and SCH_EDIT_FRAME.

Definition at line 439 of file eda_draw_frame.h.

Referenced by PCB_MARKER::GetMsgPanelInfo(), and SCH_MARKER::GetMsgPanelInfo().

◆ Revert()

void SYMBOL_EDIT_FRAME::Revert ( bool aConfirm = true)

◆ RevertAll()

void SYMBOL_EDIT_FRAME::RevertAll ( )

Definition at line 1452 of file symbol_editor.cpp.

References m_libMgr, and Revert().

◆ Save()

void SYMBOL_EDIT_FRAME::Save ( )

◆ SaveAll()

void SYMBOL_EDIT_FRAME::SaveAll ( )

Save all modified symbols and libraries.

Definition at line 332 of file symbol_editor.cpp.

References m_treePane, and saveAllLibraries().

Referenced by SYMBOL_EDITOR_CONTROL::Save().

◆ saveAllLibraries()

bool SYMBOL_EDIT_FRAME::saveAllLibraries ( bool aRequireConfirmation)
private

Save the current symbol.

Definition at line 1621 of file symbol_editor.cpp.

References _, EDA_BASE_FRAME::m_infoBar, m_libMgr, OKOrCancelDialog(), saveLibrary(), UnsavedChangesDialog(), and UpdateTitle().

Referenced by canCloseWindow(), and SaveAll().

◆ SaveCanvasImageToFile()

bool EDA_DRAW_FRAME::SaveCanvasImageToFile ( const wxString & aFileName,
BITMAP_TYPE aBitmapType )
inherited

Save the current view as an image file.

Parameters
aFrameThe current draw frame view to save.
aFileNameThe file name to save the image. This will overwrite an existing file.
aBitmapTypeThe type of bitmap create as defined by wxImage.
Returns
True if the file was successfully saved or false if the file failed to be saved.

Definition at line 1354 of file eda_draw_frame.cpp.

References BMP, GetCanvas(), image, JPG, and PNG.

Referenced by SYMBOL_EDITOR_CONTROL::ExportView(), and FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng().

◆ saveCanvasTypeSetting()

bool EDA_DRAW_FRAME::saveCanvasTypeSetting ( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
protectedinherited

◆ SaveCopyInUndoList()

void SYMBOL_EDIT_FRAME::SaveCopyInUndoList ( const wxString & aDescription,
LIB_SYMBOL * aSymbol,
UNDO_REDO aUndoType = UNDO_REDO::LIBEDIT )

Create a copy of the current symbol, and save it in the undo list.

Because a symbol in library editor does not have a lot of primitives, the full data is duplicated. It is not worth to try to optimize this save function.

Definition at line 56 of file symbol_editor_undo_redo.cpp.

References PushSymbolToUndoList().

◆ saveCurrentSymbol()

◆ saveLibrary()

◆ SaveLibraryAs()

void SYMBOL_EDIT_FRAME::SaveLibraryAs ( )

Save the currently selected library to a new file.

Definition at line 449 of file symbol_editor.cpp.

References LIB_ID::GetLibNickname(), GetTargetLibId(), m_treePane, and saveLibrary().

Referenced by SYMBOL_EDITOR_CONTROL::Save(), and SetCurSymbol().

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

Definition at line 370 of file eda_base_frame.h.

◆ saveProjectSettings()

virtual void EDA_BASE_FRAME::saveProjectSettings ( )
inlineprotectedvirtualinherited

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

Definition at line 713 of file eda_base_frame.h.

◆ SaveSettings()

◆ SaveSymbolCopyAs()

void SYMBOL_EDIT_FRAME::SaveSymbolCopyAs ( bool aOpenCopy)

Save the currently selected symbol to a new name and/or location.

Definition at line 461 of file symbol_editor.cpp.

References m_treePane, and saveSymbolCopyAs().

Referenced by SYMBOL_EDITOR_CONTROL::Save(), and SetCurSymbol().

◆ saveSymbolCopyAs()

◆ saveSymbolLibTables()

bool SCH_BASE_FRAME::saveSymbolLibTables ( bool aGlobal,
bool aProject )
protectedinherited

Save Symbol Library Tables to disk.

Parameters
aGlobalwhen true, the Global Table is saved.
aProjectwhen true, the Project Table is saved.
Returns
True when all requested actions succeeded.

Definition at line 276 of file sch_base_frame.cpp.

References _, DisplayErrorMessage(), SYMBOL_LIB_TABLE::GetGlobalLibTable(), SYMBOL_LIB_TABLE::GetGlobalTableFileName(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), KIWAY_HOLDER::Prj(), LIB_TABLE::Save(), PROJECT_SCH::SchSymbolLibTable(), and IO_ERROR::What().

Referenced by SYMBOL_EDIT_FRAME::AddLibraryFile(), and SYMBOL_EDIT_FRAME::DdAddLibrary().

◆ SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings ( WINDOW_SETTINGS * aCfg)
inherited

Save window settings to the given settings object.

Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.

Definition at line 919 of file eda_base_frame.cpp.

References WINDOW_STATE::display, GetWindowSize(), m_auimgr, m_framePos, m_frameSize, m_mruPath, m_normalFramePos, m_normalFrameSize, WINDOW_STATE::maximized, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, WINDOW_SETTINGS::state, and traceDisplayLocation.

Referenced by SaveSettings().

◆ ScriptingConsoleEnableDisable()

void EDA_DRAW_FRAME::ScriptingConsoleEnableDisable ( )
inherited

Toggle the scripting console visibility.

Definition at line 267 of file eda_draw_frame.cpp.

References center, FRAME_PYTHON, KIWAY_HOLDER::Kiway(), KIWAY_PLAYER::KIWAY_PLAYER(), and KIWAY::Player().

◆ SelectActiveLibrary()

void SYMBOL_EDIT_FRAME::SelectActiveLibrary ( const wxString & aLibrary = wxEmptyString)
private

Set the current active library to aLibrary.

Parameters
aLibrarythe nickname of the library in the symbol library table. If empty, display list of available libraries to select from.

Definition at line 88 of file symbol_editor.cpp.

References _, SCH_BASE_FRAME::SelectLibrary(), SetCurLib(), and UpdateTitle().

Referenced by LoadSymbol().

◆ SelectLibrary()

wxString SCH_BASE_FRAME::SelectLibrary ( const wxString & aDialogTitle,
const wxString & aListLabel,
const std::vector< std::pair< wxString, bool * > > & aExtraCheckboxes = {} )
inherited

Display a list of loaded libraries and allows the user to select a library.

Parameters
aDialogTitletitle for the dialog window
aListLabellabel over the list of libraries
aExtraCheckboxes[optional] list of label/valuePointer pairs from which to construct extra checkboxes in the dialog. Values are written back to the pointers when the dialog is finished.
Returns
the library nickname used in the symbol library table.

Definition at line 724 of file sch_base_frame.cpp.

References _, EDA_LIST_DIALOG::AddExtraCheckbox(), SYMBOL_LIBRARY_MANAGER::CreateLibrary(), DisplayError(), EDA_LIST_DIALOG::GetExtraCheckboxValues(), SYMBOL_LIB_TABLE::GetGlobalLibTable(), GetLibraryItemsForListDialog(), PROJECT::GetRString(), EDA_LIST_DIALOG::GetTextSelection(), FILEDLG_HOOK_NEW_LIBRARY::GetUseGlobalTable(), LIB_TABLE::HasLibrary(), ID_MAKE_NEW_LIBRARY, FILEEXT::KiCadSymbolLibFileExtension, FILEEXT::KiCadSymbolLibFileWildcard(), EDA_DRAW_FRAME::LibraryFileBrowser(), EDA_LIST_DIALOG_BASE::m_ButtonsSizer, KIWAY_HOLDER::Prj(), PROJECT::SCH_LIB_PATH, PROJECT::SCH_LIB_SELECT, PROJECT_SCH::SchSymbolLibTable(), EDA_LIST_DIALOG::SetListLabel(), PROJECT::SetRString(), and DIALOG_SHIM::ShowModal().

Referenced by SYMBOL_EDIT_FRAME::CreateNewSymbol(), SYMBOL_EDIT_FRAME::ImportSymbol(), and SYMBOL_EDIT_FRAME::SelectActiveLibrary().

◆ SetBodyStyle()

◆ SetCanvas()

◆ SetCurLib()

wxString SYMBOL_EDIT_FRAME::SetCurLib ( const wxString & aLibNickname)

Set the current library nickname and returns the old library nickname.

Definition at line 874 of file symbol_edit_frame.cpp.

References GetCurLib(), Prj(), PROJECT::SCH_LIBEDIT_CUR_LIB, PROJECT_SCH::SchSymbolLibTable(), and PROJECT::SetRString().

Referenced by emptyScreen(), KiwayMailIn(), LoadOneLibrarySymbolAux(), and SelectActiveLibrary().

◆ SetCurSymbol()

void SYMBOL_EDIT_FRAME::SetCurSymbol ( LIB_SYMBOL * aSymbol,
bool aUpdateZoom )

Take ownership of aSymbol and notes that it is the one currently being edited.

Definition at line 887 of file symbol_edit_frame.cpp.

References _, WX_INFOBAR::AddButton(), KIGFX::VIEW::Clear(), KIGFX::SCH_VIEW::ClearHiddenFlags(), WX_INFOBAR::Dismiss(), SCH_DRAW_PANEL::DisplaySymbol(), SCH_ACTIONS::editLibSymbolWithLibEdit, GetBodyStyle(), SCH_BASE_FRAME::GetCanvas(), EDA_BASE_FRAME::GetInfoBar(), GetLibTree(), SCH_BASE_FRAME::GetRenderSettings(), TOOLS_HOLDER::GetToolManager(), GetUnit(), SCH_DRAW_PANEL::GetView(), KIGFX::SCH_VIEW::HideDrawingSheet(), InvokeSchEditSymbolLibTable(), LIB_SYMBOL::IsMultiUnit(), LIB_SYMBOL::IsRoot(), IsSymbolAlias(), IsSymbolFromLegacyLibrary(), IsSymbolFromSchematic(), Kiway, LoadSymbolFromCurrentLib(), m_bodyStyle, m_libMgr, m_reference, SCH_RENDER_SETTINGS::m_ShowBodyStyle, SCH_RENDER_SETTINGS::m_ShowDisabled, SCH_RENDER_SETTINGS::m_ShowGraphicsDisabled, SCH_RENDER_SETTINGS::m_ShowUnit, m_symbol, m_SyncPinEdit, TOOLS_HOLDER::m_toolManager, m_unit, TOOL_BASE::MODEL_RELOAD, Prj(), EDA_DRAW_PANEL_GAL::Refresh(), WX_INFOBAR::RemoveAllButtons(), TOOL_MANAGER::RunAction(), SaveLibraryAs(), SaveSymbolCopyAs(), PROJECT::SCH_LIBEDIT_CUR_SYMBOL, ACTIONS::selectionClear, LIB_TREE::SelectLibId(), PROJECT::SetRString(), WX_INFOBAR::ShowMessage(), KIDIALOG::ShowModal(), UnescapeString(), LIB_SYMBOL::UnitsLocked(), LIB_TREE::Unselect(), and ACTIONS::zoomFitScreen.

Referenced by CanCloseSymbolFromSchematic(), emptyScreen(), KiwayMailIn(), LoadOneLibrarySymbolAux(), LoadSymbolFromSchematic(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), and SCH_COMMIT::revertLibEdit().

◆ SetDrawBgColor()

virtual void EDA_DRAW_FRAME::SetDrawBgColor ( const COLOR4D & aColor)
inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME.

Definition at line 182 of file eda_draw_frame.h.

References m_drawBgColor.

Referenced by PL_EDITOR_FRAME::LoadSettings(), and GERBVIEW_FRAME::SetVisibleElementColor().

◆ SetGridColor()

virtual void EDA_DRAW_FRAME::SetGridColor ( const COLOR4D & aColor)
inlinevirtualinherited

Reimplemented in GERBVIEW_FRAME, and PCB_EDIT_FRAME.

Definition at line 234 of file eda_draw_frame.h.

References m_gridColor.

◆ SetGridOrigin()

void SCH_BASE_FRAME::SetGridOrigin ( const VECTOR2I & aPoint)
inlineoverridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 152 of file sch_base_frame.h.

◆ SetGridOverrides()

void EDA_DRAW_FRAME::SetGridOverrides ( bool aOverride)
virtualinherited

◆ SetGridVisibility()

◆ 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(), m_kiway, and name.

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

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool aIsModal)
inlineinherited

◆ SetMruPath()

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

◆ SetMsgPanel() [1/3]

◆ SetMsgPanel() [2/3]

void EDA_DRAW_FRAME::SetMsgPanel ( const wxString & aTextUpper,
const wxString & aTextLower,
int aPadding = 6 )
inherited

Helper function that erases the msg panel and then appends a single message.

Parameters
aTextUpperThe message upper text.
aTextLowerThe message lower text.
aPaddingNumber of spaces to pad between messages.

Definition at line 884 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing, and m_messagePanel.

◆ SetMsgPanel() [3/3]

void EDA_DRAW_FRAME::SetMsgPanel ( EDA_ITEM * aItem)
inherited

Definition at line 895 of file eda_draw_frame.cpp.

References EDA_ITEM::GetMsgPanelInfo(), and SetMsgPanel().

◆ SetPageSettings()

void SCH_BASE_FRAME::SetPageSettings ( const PAGE_INFO & aPageSettings)
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 202 of file sch_base_frame.cpp.

References GetScreen(), and SCH_SCREEN::SetPageSettings().

◆ SetScreen()

void SYMBOL_EDIT_FRAME::SetScreen ( BASE_SCREEN * aScreen)
overridevirtual

◆ SetShowPolarCoords()

void EDA_DRAW_FRAME::SetShowPolarCoords ( bool aShow)
inlineinherited

Definition at line 134 of file eda_draw_frame.h.

References m_polarCoords.

◆ SetSymModificationTime()

void SCH_BASE_FRAME::SetSymModificationTime ( const wxDateTime & aTime)
inlineinherited

Set the modification time of the symbol library table file.

This is used to detect changes to the symbol library table file.

Parameters
aTimeis the modification time of the symbol library table file.

Definition at line 284 of file sch_base_frame.h.

References m_watcherLastModified.

Referenced by SYMBOL_EDIT_FRAME::saveLibrary().

◆ setSymWatcher()

void SCH_BASE_FRAME::setSymWatcher ( const LIB_ID * aSymbol)
protectedinherited

◆ SetTitleBlock()

void SCH_BASE_FRAME::SetTitleBlock ( const TITLE_BLOCK & aTitleBlock)
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 228 of file sch_base_frame.cpp.

References GetScreen(), and SCH_SCREEN::SetTitleBlock().

◆ SetUnit()

◆ setupTools()

◆ setupUIConditions()

void SYMBOL_EDIT_FRAME::setupUIConditions ( )
overrideprotectedvirtual

Setup the UI conditions for the various actions and their controls in this frame.

Reimplemented from EDA_BASE_FRAME.

Definition at line 411 of file symbol_edit_frame.cpp.

References EDITOR_CONDITIONS::BoundingBoxes(), CHECK, ACTIONS::copy, ACTIONS::copyAsText, EDITOR_CONDITIONS::CurrentTool(), EDITOR_CONDITIONS::Cursor45Crosshairs(), ACTIONS::cursor45Crosshairs, EDITOR_CONDITIONS::CursorFullCrosshairs(), ACTIONS::cursorFullCrosshairs, EDITOR_CONDITIONS::CursorSmallCrosshairs(), ACTIONS::cursorSmallCrosshairs, ACTIONS::cut, SCH_ACTIONS::cycleBodyStyle, ACTIONS::deleteTool, ACTIONS::doDelete, SCH_ACTIONS::drawArc, SCH_ACTIONS::drawBezier, SCH_ACTIONS::drawCircle, SCH_ACTIONS::drawRectangle, SCH_ACTIONS::drawSymbolLines, SCH_ACTIONS::drawSymbolPolygon, SCH_ACTIONS::drawSymbolTextBox, ACTIONS::duplicate, EDIT_TOOL, SCH_ACTIONS::editLibSymbolWithLibEdit, UTF8::empty(), ENABLE, LIB_ID::GetLibNickname(), GetTargetLibId(), getTargetSymbol(), EDITOR_CONDITIONS::GridOverrides(), EDITOR_CONDITIONS::GridVisible(), SELECTION_CONDITIONS::Idle(), SCH_ACTIONS::importGraphics, SCH_ACTIONS::importSymbol, INCH, ACTIONS::inchesUnits, IsLibraryTreeShown(), IsSymbolAlias(), IsSymbolEditable(), IsSymbolFromLegacyLibrary(), IsSymbolFromSchematic(), SCH_BASE_FRAME::libeditconfig(), EDA_BASE_FRAME::m_auimgr, m_libMgr, SYMBOL_EDITOR_SETTINGS::m_ShowHiddenFields, SYMBOL_EDITOR_SETTINGS::m_ShowHiddenPins, SYMBOL_EDITOR_SETTINGS::m_ShowPinAltIcons, SYMBOL_EDITOR_SETTINGS::m_ShowPinElectricalType, m_symbol, m_SyncPinEdit, TOOLS_HOLDER::m_toolManager, ACTIONS::millimetersUnits, MILS, ACTIONS::milsUnits, SCH_ACTIONS::mirrorH, SCH_ACTIONS::mirrorV, MM, SCH_ACTIONS::newSymbol, EDITOR_CONDITIONS::NoActiveTool(), ACTIONS::paste, SCH_ACTIONS::pinTable, SCH_ACTIONS::placeSymbolAnchor, SCH_ACTIONS::placeSymbolPin, SCH_ACTIONS::placeSymbolText, EDA_DRAW_FRAME::PropertiesPaneName(), ACTIONS::redo, EDITOR_CONDITIONS::RedoAvailable(), ACTIONS::revert, SCH_ACTIONS::rotateCCW, SCH_ACTIONS::rotateCW, SCH_ACTIONS::runERC, ACTIONS::save, ACTIONS::saveAll, SCH_ACTIONS::saveLibraryAs, SCH_ACTIONS::saveSymbolAs, SCH_ACTIONS::saveSymbolCopyAs, ACTIONS::selectAll, ACTIONS::selectionTool, ACTION_MANAGER::SetConditions(), EDA_BASE_FRAME::setupUIConditions(), SELECTION_CONDITIONS::ShowAlways(), ACTIONS::showDatasheet, SCH_ACTIONS::showElectricalTypes, SCH_ACTIONS::showHiddenFields, SCH_ACTIONS::showHiddenPins, ACTIONS::showLibraryTree, ACTIONS::showProperties, SCH_ACTIONS::symbolProperties, ACTIONS::toggleBoundingBoxes, ACTIONS::toggleGrid, ACTIONS::toggleGridOverrides, SCH_ACTIONS::togglePinAltIcons, SCH_ACTIONS::toggleSyncedPinsMode, ACTIONS::undo, EDITOR_CONDITIONS::UndoAvailable(), EDITOR_CONDITIONS::Units(), ACTIONS::unselectAll, and ACTIONS::zoomTool.

Referenced by SYMBOL_EDIT_FRAME().

◆ setupUnits()

◆ SetUserUnits()

◆ ShowChangedLanguage()

◆ ShowFindReplaceDialog()

◆ ShowFindReplaceStatus()

void SCH_BASE_FRAME::ShowFindReplaceStatus ( const wxString & aMsg,
int aStatusTime )
inherited

Definition at line 595 of file sch_base_frame.cpp.

References EDA_BASE_FRAME::m_infoBar.

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

References GetInfoBar(), m_infoBar, 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 1059 of file eda_base_frame.cpp.

References GetInfoBar(), m_infoBar, and WX_INFOBAR::ShowMessageFor().

Referenced by MICROWAVE_TOOL::createInductorBetween(), PCB_BASE_EDIT_FRAME::createNewLibrary(), MICROWAVE_TOOL::createPolygonShape(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), EDIT_TOOL::DeleteItems(), SYMBOL_EDIT_FRAME::ExportSymbol(), PCB_EDIT_FRAME::LoadDrawingSheet(), SCH_EDIT_FRAME::LoadDrawingSheet(), ROUTER_TOOL::prepareInteractive(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), and SYMBOL_EDIT_FRAME::saveLibrary().

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

References GetInfoBar(), m_infoBar, and WX_INFOBAR::ShowMessageFor().

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

References GetInfoBar(), m_infoBar, and WX_INFOBAR::ShowMessageFor().

Referenced by SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME().

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

Definition at line 95 of file kiway_player.cpp.

References IsModal(), m_modal_loop, m_modal_resultant_parent, m_modal_ret_val, and 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

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

Definition at line 1194 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, ACTION_MANAGER::GetActions(), ADVANCED_CFG::GetCfg(), GetFrameType(), PGM_BASE::GetSettingsManager(), PAGED_DIALOG::GetTreebook(), HOTKEYS_CHANGED, KICAD_MANAGER_FRAME_NAME, kiface(), KIWAY_HOLDER::Kiway(), LAZY_CTOR, TOOLS_HOLDER::m_toolManager, name, PANEL_3DV_DISPLAY_OPTIONS, PANEL_3DV_OPENGL, PANEL_3DV_RAYTRACING, PANEL_3DV_TOOLBARS, PANEL_DS_COLORS, PANEL_DS_DISPLAY_OPTIONS, PANEL_DS_GRIDS, PANEL_DS_TOOLBARS, PANEL_FP_COLORS, PANEL_FP_DEFAULT_FIELDS, PANEL_FP_DEFAULT_GRAPHICS_VALUES, PANEL_FP_DISPLAY_OPTIONS, PANEL_FP_EDIT_OPTIONS, PANEL_FP_GRIDS, PANEL_FP_ORIGINS_AXES, PANEL_FP_TOOLBARS, PANEL_GBR_COLORS, PANEL_GBR_DISPLAY_OPTIONS, PANEL_GBR_EXCELLON_OPTIONS, PANEL_GBR_GRIDS, PANEL_GBR_TOOLBARS, PANEL_PCB_ACTION_PLUGINS, PANEL_PCB_COLORS, PANEL_PCB_DISPLAY_OPTS, PANEL_PCB_EDIT_OPTIONS, PANEL_PCB_GRIDS, PANEL_PCB_ORIGINS_AXES, PANEL_PCB_TOOLBARS, PANEL_SCH_COLORS, PANEL_SCH_DISP_OPTIONS, PANEL_SCH_EDIT_OPTIONS, PANEL_SCH_FIELD_NAME_TEMPLATES, PANEL_SCH_GRIDS, PANEL_SCH_SIMULATOR, PANEL_SCH_TOOLBARS, PANEL_SYM_COLORS, PANEL_SYM_DISP_OPTIONS, PANEL_SYM_EDIT_GRIDS, PANEL_SYM_EDIT_OPTIONS, PANEL_SYM_TOOLBARS, Pgm(), ReadHotKeyConfigIntoActions(), TOOL_BASE::REDRAW, SETTINGS_MANAGER::Save(), PAGED_DIALOG::SetInitialPage(), and DIALOG_SHIM::ShowModal().

Referenced by OnPreferences().

◆ storeCurrentSymbol()

void SYMBOL_EDIT_FRAME::storeCurrentSymbol ( )
private

Rename LIB_SYMBOL aliases to avoid conflicts before adding a symbol to a library.

Definition at line 1381 of file symbol_edit_frame.cpp.

References GetCurLib(), SCH_BASE_FRAME::GetScreen(), IsContentModified(), m_libMgr, and m_symbol.

Referenced by OnModify().

◆ StringFromOptionalValue()

wxString UNITS_PROVIDER::StringFromOptionalValue ( std::optional< int > aValue,
bool aAddUnitLabel = false,
EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const
inlineinherited

Converts an optional 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= optional 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 100 of file units_provider.h.

References DISTANCE, GetIuScale(), GetUnitsFromType(), NullUiString, and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by WX_GRID::onCellEditorHidden().

◆ 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 79 of file units_provider.h.

References DISTANCE, GetIuScale(), GetUnitsFromType(), and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), PAD::doCheckPad(), VALIDATION_ERROR_TOO_LARGE< T >::Format(), VALIDATION_ERROR_TOO_SMALL< T >::Format(), formatBBox(), DRC_TEST_PROVIDER::formatMsg(), DRC_TEST_PROVIDER::formatMsg(), WX_GRID::onCellEditorHidden(), reportMax(), reportMin(), reportOpt(), and PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow().

◆ SVGPlotSymbol()

◆ SwitchCanvas()

void SYMBOL_EDIT_FRAME::SwitchCanvas ( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
overridevirtual

◆ SynchronizePins()

bool SYMBOL_EDIT_FRAME::SynchronizePins ( )

Definition at line 1121 of file symbol_edit_frame.cpp.

References m_symbol, and m_SyncPinEdit.

◆ SyncLibraries()

void SYMBOL_EDIT_FRAME::SyncLibraries ( bool aShowProgress,
bool aPreloadCancelled = false,
const wxString & aForceRefresh = wxEmptyString )

◆ SyncView()

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

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

◆ ThawLibraryTree()

void SYMBOL_EDIT_FRAME::ThawLibraryTree ( )

Definition at line 800 of file symbol_edit_frame.cpp.

References m_libMgr, and m_treePane.

Referenced by KiwayMailIn(), and saveLibrary().

◆ ThemeChanged()

void EDA_BASE_FRAME::ThemeChanged ( )
virtualinherited

Process light/dark theme change.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 712 of file eda_base_frame.cpp.

References ClearScaledBitmapCache(), and m_auimgr.

Referenced by CommonSettingsChanged(), HandleSystemColorChange(), and PCB_EDIT_FRAME::ThemeChanged().

◆ ToggleLibraryTree()

void SYMBOL_EDIT_FRAME::ToggleLibraryTree ( )
overridevirtual

◆ ToggleProperties()

void SYMBOL_EDIT_FRAME::ToggleProperties ( )
overridevirtual

◆ ToggleUserUnits()

void EDA_DRAW_FRAME::ToggleUserUnits ( )
overridevirtualinherited

◆ ToolStackIsEmpty()

bool TOOLS_HOLDER::ToolStackIsEmpty ( )
inlineinherited

◆ unitsChangeRefresh()

void EDA_DRAW_FRAME::unitsChangeRefresh ( )
overrideprotectedvirtualinherited

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

Reimplemented in GERBVIEW_FRAME, PCB_BASE_EDIT_FRAME, PCB_BASE_FRAME, and SCH_EDIT_FRAME.

Definition at line 307 of file eda_draw_frame.cpp.

References TOOLS_HOLDER::m_toolManager, UpdateMsgPanel(), UpdateProperties(), UpdateStatusBar(), and ACTIONS::updateUnits.

Referenced by ToggleUserUnits(), GERBVIEW_FRAME::unitsChangeRefresh(), and PCB_BASE_FRAME::unitsChangeRefresh().

◆ UnregisterUIUpdateHandler() [1/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 402 of file eda_base_frame.cpp.

References m_uiUpdateMap.

◆ UnregisterUIUpdateHandler() [2/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 50 of file tools_holder.cpp.

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

Referenced by UnregisterUIUpdateHandler().

◆ UpdateAfterSymbolProperties()

void SYMBOL_EDIT_FRAME::UpdateAfterSymbolProperties ( wxString * aOldName = nullptr)

◆ UpdateFileHistory()

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

Update the list of recently opened files.

The menu is also updated, if FILE_HISTORY::UseMenu was called at init time.

Parameters
FullFileNameThe full file name including the path.
aFileHistoryThe FILE_HISTORY in use. If NULL, the main application file history is used.

Definition at line 1108 of file eda_base_frame.cpp.

References FILE_HISTORY::AddFileToHistory(), m_fileHistory, m_isClosing, and ReCreateMenuBar().

Referenced by SCH_EDIT_FRAME::doCloseWindow(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), BITMAP2CMP_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SaveSettings(), and GERBVIEW_FRAME::unarchiveFiles().

◆ UpdateGridSelectBox()

void EDA_DRAW_FRAME::UpdateGridSelectBox ( )
inherited

Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.).

Definition at line 402 of file eda_draw_frame.cpp.

References _, GRID_MENU::BuildChoiceList(), EDA_BASE_FRAME::config(), DisplayUnitsMsg(), grid, m_gridSelectBox, and UpdateStatusBar().

Referenced by CommonSettingsChanged(), configureToolbars(), GERBVIEW_FRAME::unitsChangeRefresh(), and PCB_BASE_FRAME::unitsChangeRefresh().

◆ UpdateItem()

void SYMBOL_EDIT_FRAME::UpdateItem ( EDA_ITEM * aItem,
bool isAddOrDelete = false,
bool aUpdateRtree = false )
overridevirtual

Mark an item for refresh.

Reimplemented from SCH_BASE_FRAME.

Definition at line 2017 of file symbol_edit_frame.cpp.

References SCH_BASE_FRAME::UpdateItem().

Referenced by FocusOnItem().

◆ UpdateLibraryTree()

void SYMBOL_EDIT_FRAME::UpdateLibraryTree ( const wxDataViewItem & aTreeItem,
LIB_SYMBOL * aSymbol )

Update a symbol node in the library tree.

Definition at line 1348 of file symbol_edit_frame.cpp.

References GetLibTree(), LIB_TREE::RefreshLibTree(), and LIB_TREE_NODE_ITEM::Update().

Referenced by SYMBOL_EDITOR_CONTROL::FlattenSymbol(), and SYMBOL_EDITOR_CONTROL::RenameSymbol().

◆ UpdateMsgPanel()

void SYMBOL_EDIT_FRAME::UpdateMsgPanel ( )
inlineoverridevirtual

Redraw the message panel.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 253 of file symbol_edit_frame.h.

References UpdateSymbolMsgPanelInfo().

Referenced by LoadOneLibrarySymbolAux(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), ShowChangedLanguage(), and UpdateAfterSymbolProperties().

◆ UpdateProperties()

◆ updateSelectionFilterVisbility()

void SYMBOL_EDIT_FRAME::updateSelectionFilterVisbility ( )
overrideprotectedvirtual

Selection filter panel doesn't have a dedicated visibility control, so show it if any other AUI panel is shown and docked.

Reimplemented from SCH_BASE_FRAME.

Definition at line 2029 of file symbol_edit_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, m_treePane, and EDA_DRAW_FRAME::PropertiesPaneName().

Referenced by SYMBOL_EDIT_FRAME(), ToggleLibraryTree(), and ToggleProperties().

◆ UpdateStatusBar()

void SCH_BASE_FRAME::UpdateStatusBar ( )
overridevirtualinherited

Update the status bar information.

The EDA_DRAW_FRAME level updates the absolute and relative coordinates and the zoom information. If you override this virtual method, make sure to call this subclassed method.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 235 of file sch_base_frame.cpp.

References EDA_DRAW_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), GetScreen(), EDA_DRAW_PANEL_GAL::GetViewControls(), BASE_SCREEN::m_LocalOrigin, UNITS_PROVIDER::MessageTextFromValue(), EDA_DRAW_FRAME::UpdateStatusBar(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ updateStatusBarWidths()

void EDA_DRAW_FRAME::updateStatusBarWidths ( )
protectedinherited

Definition at line 725 of file eda_draw_frame.cpp.

References _, arrayDim(), and KIUI::GetTextSize().

Referenced by EDA_DRAW_FRAME().

◆ UpdateSymbolMsgPanelInfo()

void SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo ( )

◆ UpdateTitle()

◆ UpdateToolbarControlSizes()

void EDA_BASE_FRAME::UpdateToolbarControlSizes ( )
virtualinherited

◆ UpdateZoomSelectBox()

void EDA_DRAW_FRAME::UpdateZoomSelectBox ( )
inherited

Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.)

Definition at line 582 of file eda_draw_frame.cpp.

References _, EDA_BASE_FRAME::config(), m_canvas, APP_SETTINGS_BASE::m_Window, m_zoomSelectBox, zoom, and WINDOW_SETTINGS::zoom_factors.

Referenced by configureToolbars().

◆ ValueFromString()

int UNITS_PROVIDER::ValueFromString ( const wxString & aTextValue,
EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const
inlineinherited

Converts aTextValue in aUnits to internal units used by the frame.

Warning
This utilizes the current locale and will break if decimal formats differ
Parameters
aTypeis the type of this value, and controls the way the string is converted to a value
aTextValueA reference to a wxString object containing the string to convert.
Returns
internal units value

Definition at line 152 of file units_provider.h.

References DISTANCE, EDA_UNIT_UTILS::UI::DoubleValueFromString(), GetIuScale(), GetUnitsFromType(), and KiROUND().

Referenced by PIN_TABLE_DATA_MODEL::compare(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), WX_GRID::GetUnitValue(), and WX_GRID::onCellEditorHidden().

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

References canCloseWindow(), config(), doCloseWindow(), findQuasiModalDialog(), IsModal(), m_infoBar, m_isClosing, m_isNonUserClose, and SaveSettings().

Referenced by commonInit(), and ~EDA_BASE_FRAME().

◆ Zoom_Automatique()

Member Data Documentation

◆ KICAD_AUI_TB_STYLE

int EDA_BASE_FRAME::KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
staticconstexprprotectedinherited

Default style flags used for wxAUI toolbars.

Definition at line 644 of file eda_base_frame.h.

Referenced by RecreateToolbars().

◆ m_aboutTitle

◆ m_acceptedExts

◆ m_AcceptedFiles

std::vector<wxFileName> EDA_BASE_FRAME::m_AcceptedFiles
protectedinherited

◆ m_actions

◆ m_appearancePanel

◆ m_auimgr

wxAuiManager EDA_BASE_FRAME::m_auimgr
protectedinherited

Definition at line 791 of file eda_base_frame.h.

Referenced by SCH_EDIT_FRAME::CaptureHierarchyPaneSize(), commonInit(), CreateInfoBar(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), FinishAUIInitialization(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FOOTPRINT_EDIT_FRAME::IsLibraryTreeShown(), SYMBOL_EDIT_FRAME::IsLibraryTreeShown(), PCB_EDIT_FRAME::IsSearchPaneShown(), SCH_EDIT_FRAME::IsSearchPaneShown(), PCB_EDIT_FRAME::LayerManagerShown(), PCB_EDIT_FRAME::NetInspectorShown(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::onResizeNetNavigator(), FOOTPRINT_VIEWER_FRAME::OnSize(), FOOTPRINT_WIZARD_FRAME::OnSize(), KICAD_MANAGER_FRAME::OnSize(), SYMBOL_VIEWER_FRAME::OnSize(), OnToolbarSizeChanged(), KICAD_MANAGER_FRAME::onToolbarSizeChanged(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PCB_EDIT_FRAME::PropertiesShown(), RecreateToolbars(), GERBVIEW_FRAME::ReFillLayerWidget(), CVPCB_MAINFRAME::refreshAfterSymbolSearch(), FOOTPRINT_WIZARD_FRAME::SaveSettings(), PCB_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), SaveWindowSettings(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), PCB_BASE_FRAME::SetDrawBgColor(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::ShowChangedLanguage(), EDA_DRAW_FRAME::ShowChangedLanguage(), FOOTPRINT_EDIT_FRAME::ShowChangedLanguage(), GERBVIEW_FRAME::ShowChangedLanguage(), KICAD_MANAGER_FRAME::ShowChangedLanguage(), PCB_EDIT_FRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), ThemeChanged(), EDA_3D_VIEWER_FRAME::ToggleAppearanceManager(), GERBVIEW_FRAME::ToggleLayerManager(), FOOTPRINT_EDIT_FRAME::ToggleLayersManager(), PCB_EDIT_FRAME::ToggleLayersManager(), FOOTPRINT_EDIT_FRAME::ToggleLibraryTree(), PCB_EDIT_FRAME::ToggleLibraryTree(), SCH_EDIT_FRAME::ToggleLibraryTree(), SYMBOL_EDIT_FRAME::ToggleLibraryTree(), PCB_EDIT_FRAME::ToggleNetInspector(), SCH_EDIT_FRAME::ToggleNetNavigator(), PCB_BASE_EDIT_FRAME::ToggleProperties(), SCH_EDIT_FRAME::ToggleProperties(), SYMBOL_EDIT_FRAME::ToggleProperties(), SCH_EDIT_FRAME::ToggleSchematicHierarchy(), PCB_EDIT_FRAME::ToggleSearch(), SCH_EDIT_FRAME::ToggleSearch(), GERBVIEW_FRAME::updateDCodeSelectBox(), SCH_EDIT_FRAME::updateSelectionFilterVisbility(), SYMBOL_EDIT_FRAME::updateSelectionFilterVisbility(), GERBVIEW_FRAME::UpdateTitleAndInfo(), CVPCB_MAINFRAME::~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_autoSavePermissionError

bool EDA_BASE_FRAME::m_autoSavePermissionError
protectedinherited

◆ m_autoSaveRequired

bool EDA_BASE_FRAME::m_autoSaveRequired
protectedinherited

◆ m_autoSaveTimer

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer
protectedinherited

◆ m_base_frame_defaults

SCHEMATIC_SETTINGS SCH_BASE_FRAME::m_base_frame_defaults
protectedinherited

Only used by symbol_editor. Eeschema should be using the one inside the SCHEMATIC.

Definition at line 328 of file sch_base_frame.h.

Referenced by SCH_BASE_FRAME().

◆ m_bodyStyle

int SYMBOL_EDIT_FRAME::m_bodyStyle
private

Flag if the symbol being edited was loaded directly from a schematic.

Definition at line 570 of file symbol_edit_frame.h.

Referenced by GetBodyStyle(), GetDocumentExtents(), LoadOneLibrarySymbolAux(), LoadSymbolFromSchematic(), RebuildSymbolUnitAndBodyStyleLists(), RebuildView(), SetBodyStyle(), SetCurSymbol(), and SYMBOL_EDIT_FRAME().

◆ m_bodyStyleSelectBox

wxComboBox* SYMBOL_EDIT_FRAME::m_bodyStyleSelectBox
private

◆ m_canvas

◆ m_canvasType

◆ m_centerItemOnIdle

LIB_ID SYMBOL_EDIT_FRAME::m_centerItemOnIdle
private

Definition at line 564 of file symbol_edit_frame.h.

Referenced by centerItemIdleHandler(), and LoadSymbol().

◆ m_colorSettings

◆ m_configName

wxString EDA_BASE_FRAME::m_configName
protectedinherited

Definition at line 795 of file eda_base_frame.h.

Referenced by ConfigBaseName(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ m_currentScreen

BASE_SCREEN* EDA_DRAW_FRAME::m_currentScreen
privateinherited

current used SCREEN

Definition at line 615 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), GetScreen(), SetScreen(), and ~EDA_DRAW_FRAME().

◆ m_displayIndex

int EDA_BASE_FRAME::m_displayIndex
protectedinherited

Definition at line 783 of file eda_base_frame.h.

Referenced by commonInit(), LoadWindowState(), and OnSize().

◆ m_dragAction

MOUSE_DRAG_ACTION TOOLS_HOLDER::m_dragAction
protectedinherited

Definition at line 188 of file tools_holder.h.

Referenced by CommonSettingsChanged(), GetDragAction(), and TOOLS_HOLDER().

◆ m_drawBgColor

COLOR4D EDA_DRAW_FRAME::m_drawBgColor
protectedinherited

◆ m_dummyScreen

SCH_SCREEN* SYMBOL_EDIT_FRAME::m_dummyScreen
private

< Helper screen used when no symbol is loaded

Definition at line 553 of file symbol_edit_frame.h.

Referenced by emptyScreen(), KiwayMailIn(), LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME(), and ~SYMBOL_EDIT_FRAME().

◆ m_dummySelection

SELECTION TOOLS_HOLDER::m_dummySelection
protectedinherited

Definition at line 175 of file tools_holder.h.

Referenced by GetCurrentSelection().

◆ m_file_checker

std::unique_ptr<LOCKFILE> EDA_DRAW_FRAME::m_file_checker
protectedinherited

◆ m_fileHistory

◆ m_findReplaceData

◆ m_findReplaceDialog

DIALOG_SCH_FIND* SCH_BASE_FRAME::m_findReplaceDialog
protectedinherited

◆ m_findStringHistoryList

wxArrayString EDA_DRAW_FRAME::m_findStringHistoryList
protectedinherited

◆ m_framePos

wxPoint EDA_BASE_FRAME::m_framePos
protectedinherited

◆ m_frameSize

◆ m_galDisplayOptions

GAL_DISPLAY_OPTIONS_IMPL EDA_DRAW_FRAME::m_galDisplayOptions
privateinherited

This the frame's interface to setting GAL display options.

Definition at line 619 of file eda_draw_frame.h.

Referenced by CommonSettingsChanged(), GetGalDisplayOptions(), LoadSettings(), OnMove(), and SaveSettings().

◆ m_gridColor

COLOR4D EDA_DRAW_FRAME::m_gridColor
protectedinherited

◆ m_gridSelectBox

wxChoice* EDA_DRAW_FRAME::m_gridSelectBox
protectedinherited

◆ m_hotkeyPopup

HOTKEY_CYCLE_POPUP* EDA_DRAW_FRAME::m_hotkeyPopup
protectedinherited

Definition at line 606 of file eda_draw_frame.h.

Referenced by CreateHotkeyPopup(), EDA_DRAW_FRAME(), and GetHotkeyPopup().

◆ m_ident

FRAME_T EDA_BASE_FRAME::m_ident
protectedinherited

◆ m_immediateActions

bool TOOLS_HOLDER::m_immediateActions
protectedinherited

Definition at line 184 of file tools_holder.h.

Referenced by CommonSettingsChanged(), GetDoImmediateActions(), and TOOLS_HOLDER().

◆ m_infoBar

◆ m_inSymChangeTimerEvent

bool SCH_BASE_FRAME::m_inSymChangeTimerEvent
privateinherited

Definition at line 337 of file sch_base_frame.h.

Referenced by OnSymChangeDebounceTimer(), and SCH_BASE_FRAME().

◆ m_isClosing

◆ m_isNonUserClose

bool EDA_BASE_FRAME::m_isNonUserClose
protectedinherited

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

Definition at line 824 of file eda_base_frame.h.

Referenced by commonInit(), NonUserClose(), SaveSettings(), and windowClosing().

◆ m_isSymbolFromSchematic

bool SYMBOL_EDIT_FRAME::m_isSymbolFromSchematic
private

◆ m_iuScale

const EDA_IU_SCALE& UNITS_PROVIDER::m_iuScale
privateinherited

Definition at line 251 of file units_provider.h.

Referenced by GetIuScale(), and UNITS_PROVIDER().

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway
privateinherited

Definition at line 86 of file kiway_holder.h.

Referenced by HasKiway(), Kiway(), KIWAY_HOLDER(), and SetKiway().

◆ m_lastToolbarIconSize

int EDA_DRAW_FRAME::m_lastToolbarIconSize
privateinherited

Definition at line 621 of file eda_draw_frame.h.

Referenced by CommonSettingsChanged(), EDA_DRAW_FRAME(), and LoadSettings().

◆ m_libMgr

◆ m_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault
protectedinherited

◆ m_messagePanel

◆ m_modal

bool KIWAY_PLAYER::m_modal
protectedinherited

Definition at line 190 of file kiway_player.h.

Referenced by IsModal(), KIWAY_PLAYER(), and 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 DismissModal(), IsDismissed(), KIWAY_PLAYER(), and 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(), and 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 DismissModal(), and ShowModal().

◆ m_moveWarpsCursor

bool TOOLS_HOLDER::m_moveWarpsCursor
protectedinherited

Definition at line 190 of file tools_holder.h.

Referenced by CommonSettingsChanged(), GetMoveWarpsCursor(), and TOOLS_HOLDER().

◆ m_mruPath

◆ m_msgFrameHeight

int EDA_DRAW_FRAME::m_msgFrameHeight
protectedinherited

Definition at line 599 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME().

◆ m_netInspectorPanel

◆ m_normalFramePos

wxPoint EDA_BASE_FRAME::m_normalFramePos
protectedinherited

Definition at line 786 of file eda_base_frame.h.

Referenced by LoadWindowState(), OnMaximize(), and SaveWindowSettings().

◆ m_normalFrameSize

wxSize EDA_BASE_FRAME::m_normalFrameSize
protectedinherited

Definition at line 787 of file eda_base_frame.h.

Referenced by LoadWindowState(), OnMaximize(), and SaveWindowSettings().

◆ m_openGLFailureOccured

bool EDA_DRAW_FRAME::m_openGLFailureOccured = false
staticprotectedinherited

Has any failure occurred when switching to OpenGL in any EDA_DRAW_FRAME?

Definition at line 611 of file eda_draw_frame.h.

Referenced by CommonSettingsChanged(), resolveCanvasType(), FOOTPRINT_EDIT_FRAME::resolveCanvasType(), and ~EDA_DRAW_FRAME().

◆ m_originTransforms

ORIGIN_TRANSFORMS EDA_BASE_FRAME::m_originTransforms
protectedinherited

Definition at line 814 of file eda_base_frame.h.

Referenced by GetOriginTransforms().

◆ m_overrideLocksCb

wxCheckBox* EDA_DRAW_FRAME::m_overrideLocksCb
protectedinherited

Definition at line 592 of file eda_draw_frame.h.

Referenced by configureToolbars(), EDA_DRAW_FRAME(), and GetOverrideLocks().

◆ m_perspective

wxString EDA_BASE_FRAME::m_perspective
protectedinherited

Definition at line 792 of file eda_base_frame.h.

Referenced by LoadWindowSettings().

◆ m_polarCoords

bool EDA_DRAW_FRAME::m_polarCoords
protectedinherited

◆ m_propertiesPanel

◆ m_redoList

◆ m_reference

wxString SYMBOL_EDIT_FRAME::m_reference
private

◆ m_replaceStringHistoryList

wxArrayString EDA_DRAW_FRAME::m_replaceStringHistoryList
protectedinherited

◆ m_schematicSymbolUUID

KIID SYMBOL_EDIT_FRAME::m_schematicSymbolUUID
private

RefDes of the symbol (only valid if symbol was loaded from schematic)

Definition at line 574 of file symbol_edit_frame.h.

Referenced by CanCloseSymbolFromSchematic(), LoadSymbolFromSchematic(), and saveCurrentSymbol().

◆ m_searchPane

◆ m_selectionFilterPanel

◆ m_settings

SYMBOL_EDITOR_SETTINGS* SYMBOL_EDIT_FRAME::m_settings
private

◆ m_settingsManager

SETTINGS_MANAGER* EDA_BASE_FRAME::m_settingsManager
protectedinherited

Definition at line 798 of file eda_base_frame.h.

Referenced by commonInit(), and GetSettingsManager().

◆ m_showBorderAndTitleBlock

◆ m_showDeMorgan

bool SYMBOL_EDIT_FRAME::m_showDeMorgan = false
staticprivate

Definition at line 582 of file symbol_edit_frame.h.

◆ m_sockets

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

Definition at line 199 of file kiway_player.h.

Referenced by OnSockRequestServer(), and ~KIWAY_PLAYER().

◆ m_socketServer

wxSocketServer* EDA_DRAW_FRAME::m_socketServer
protectedinherited

Prevents opening same file multiple times.

Definition at line 575 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME().

◆ m_spaceMouse

std::unique_ptr<NL_SCHEMATIC_PLUGIN> SCH_BASE_FRAME::m_spaceMouse
privateinherited

Definition at line 340 of file sch_base_frame.h.

Referenced by ActivateGalCanvas(), handleActivateEvent(), and handleIconizeEvent().

◆ m_supportsAutoSave

bool EDA_BASE_FRAME::m_supportsAutoSave
protectedinherited

◆ m_symbol

◆ m_SyncPinEdit

bool SYMBOL_EDIT_FRAME::m_SyncPinEdit

Set to true to synchronize pins at the same position when editing symbols with multiple units or multiple body styles.

Deleting or moving pins will affect all pins at the same location. When units are interchangeable, synchronizing editing of pins is usually the best way, because if units are interchangeable, it implies that all similar pins are at the same location. When units are not interchangeable, do not synchronize editing of pins, because each symbol is specific, and there are no (or few) similar pins between units.

Setting this to false allows editing each pin per symbol or body style regardless other pins at the same location. This requires the user to open each symbol or body style to make changes to the other pins at the same location.

To know if others pins must be coupled when editing a pin, use SynchronizePins() instead of m_syncPinEdit, because SynchronizePins() is more reliable (takes in account the fact units are interchangeable, there are more than one unit).

Todo
Determine why this member variable is public when all the rest are private and either make it private or document why it needs to be public.

Definition at line 549 of file symbol_edit_frame.h.

Referenced by LoadSymbolFromCurrentLib(), SetCurSymbol(), setupUIConditions(), SYMBOL_EDIT_FRAME(), SynchronizePins(), and SYMBOL_EDITOR_CONTROL::ToggleSyncedPinsMode().

◆ m_tbLeft

◆ m_tbRight

◆ m_tbTopAux

◆ m_tbTopMain

◆ m_toolbarControlFactories

std::map<std::string, ACTION_TOOLBAR_CONTROL_FACTORY> EDA_BASE_FRAME::m_toolbarControlFactories
protectedinherited

◆ m_toolbarSettings

◆ m_toolDispatcher

◆ m_toolManager

TOOL_MANAGER* TOOLS_HOLDER::m_toolManager
protectedinherited

Definition at line 171 of file tools_holder.h.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::AddFootprintToBoard(), EDA_BASE_FRAME::AddStandardHelpMenu(), EDA_DRAW_FRAME::AddStandardSubMenus(), SCH_EDIT_FRAME::AnnotateSymbols(), BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), PCB_EDIT_FRAME::CanAcceptApiCommands(), FOOTPRINT_EDIT_FRAME::canCloseWindow(), PCB_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::CheckAnnotate(), GERBVIEW_FRAME::Clear_DrawLayers(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), EDA_DRAW_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), SYMBOL_VIEWER_FRAME::DClickOnSymbolList(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_EDIT_FRAME::DeleteJunction(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), SCH_EDIT_FRAME::DisplayCurrentSheet(), FOOTPRINT_VIEWER_FRAME::displayFootprint(), EDA_DRAW_FRAME::DisplayGridMsg(), CVPCB_MAINFRAME::doCloseWindow(), GERBVIEW_FRAME::doCloseWindow(), SCH_BASE_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::doCloseWindow(), SYMBOL_VIEWER_FRAME::doCloseWindow(), BITMAP2CMP_FRAME::doReCreateMenuBar(), CVPCB_MAINFRAME::doReCreateMenuBar(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_CALCULATOR_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SIMULATOR_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_VIEWER_FRAME::doReCreateMenuBar(), EDA_BASE_FRAME::DoWithAcceptedFiles(), GERBVIEW_FRAME::DoWithAcceptedFiles(), KICAD_MANAGER_FRAME::DoWithAcceptedFiles(), SCH_EDIT_FRAME::EditSheetProperties(), SYMBOL_EDIT_FRAME::emptyScreen(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetCurrentSelection(), FOOTPRINT_EDIT_FRAME::GetCurrentSelection(), FOOTPRINT_VIEWER_FRAME::GetCurrentSelection(), GERBVIEW_FRAME::GetCurrentSelection(), PCB_EDIT_FRAME::GetCurrentSelection(), PL_EDITOR_FRAME::GetCurrentSelection(), SCH_EDIT_FRAME::GetCurrentSelection(), SYMBOL_EDIT_FRAME::GetCurrentSelection(), SYMBOL_VIEWER_FRAME::GetCurrentSelection(), SCH_BASE_FRAME::GetSelectionTool(), GetToolManager(), EDA_DRAW_FRAME::GetUnitPair(), PL_EDITOR_FRAME::HardRedraw(), SCH_EDIT_FRAME::HardRedraw(), SYMBOL_EDIT_FRAME::HardRedraw(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::initScreenZoom(), PCB_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), FOOTPRINT_EDIT_FRAME::MakeGridHelper(), PCB_EDIT_FRAME::MakeGridHelper(), SCH_EDIT_FRAME::MakeGridHelper(), SYMBOL_EDIT_FRAME::MakeGridHelper(), PCB_EDIT_FRAME::OnBoardLoaded(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_BASE_FRAME::OnFindDialogClose(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), SCH_EDIT_FRAME::OnImportProject(), PCB_EDIT_FRAME::OnNetlistChanged(), PL_EDITOR_FRAME::OnNewDrawingSheet(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), EDA_DRAW_FRAME::OnSelectGrid(), EDA_DRAW_FRAME::OnSelectZoom(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), PopTool(), PushTool(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::RebuildAndRefresh(), SYMBOL_EDIT_FRAME::RebuildView(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_BASE_FRAME::RefreshZoomDependentItems(), FOOTPRINT_WIZARD_FRAME::RegenerateFootprint(), DISPLAY_FOOTPRINTS_FRAME::ReloadFootprint(), 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(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), EDA_DRAW_FRAME::SaveSettings(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_BASE_FRAME::SCH_BASE_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_EDIT_FRAME::SelectBodyStyle(), SCH_EDIT_FRAME::SelectUnit(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), GERBVIEW_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), SCH_EDIT_FRAME::SetAltPinFunction(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_TEST_FRAME_BASE::SetBoard(), SYMBOL_EDIT_FRAME::SetBodyStyle(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SCH_EDIT_FRAME::SetSchematic(), SCH_EDIT_FRAME::SetScreen(), SYMBOL_EDIT_FRAME::SetScreen(), PCB_TEST_FRAME_BASE::SetSelectionHook(), SYMBOL_EDIT_FRAME::SetUnit(), CVPCB_MAINFRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIMULATOR_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupUIConditions(), DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::setupUIConditions(), FOOTPRINT_CHOOSER_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), FOOTPRINT_VIEWER_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), KICAD_MANAGER_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SIMULATOR_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowFindDialog(), SCH_BASE_FRAME::ShowFindReplaceDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), EDA_BASE_FRAME::ShowPreferences(), PCB_BASE_EDIT_FRAME::ShowReferenceImagePropertiesDialog(), SIMULATOR_FRAME::SIMULATOR_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SCH_BASE_FRAME::SyncView(), EDA_DRAW_FRAME::ToggleUserUnits(), TOOLS_HOLDER(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), SCH_EDIT_FRAME::TrimWire(), EDA_DRAW_FRAME::unitsChangeRefresh(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), SCH_EDIT_FRAME::UpdateHierarchyNavigator(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), FOOTPRINT_EDIT_FRAME::UpdateView(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), EDA_DRAW_FRAME::Zoom_Automatique(), CVPCB_MAINFRAME::~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_CALCULATOR_FRAME::~PCB_CALCULATOR_FRAME(), PCB_EDIT_FRAME::~PCB_EDIT_FRAME(), PL_EDITOR_FRAME::~PL_EDITOR_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

Definition at line 177 of file tools_holder.h.

Referenced by CurrentToolName(), IsCurrentTool(), PopTool(), PushTool(), and ToolStackIsEmpty().

◆ m_treePane

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type
privateinherited

Definition at line 87 of file kiway_holder.h.

Referenced by GetType(), and KIWAY_HOLDER().

◆ m_uiUpdateMap

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

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

Definition at line 817 of file eda_base_frame.h.

Referenced by RegisterUIUpdateHandler(), and UnregisterUIUpdateHandler().

◆ m_undoList

◆ m_undoRedoCountMax

int EDA_DRAW_FRAME::m_undoRedoCountMax
protectedinherited

Definition at line 583 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), and LoadSettings().

◆ m_unit

◆ m_unitSelectBox

wxComboBox* SYMBOL_EDIT_FRAME::m_unitSelectBox
private

◆ m_userUnits

EDA_UNITS UNITS_PROVIDER::m_userUnits
privateinherited

Definition at line 252 of file units_provider.h.

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

◆ m_watcher

std::unique_ptr<wxFileSystemWatcher> SCH_BASE_FRAME::m_watcher
privateinherited

These are file watchers for the symbol library tables.

Definition at line 333 of file sch_base_frame.h.

Referenced by OnSymChange(), and setSymWatcher().

◆ m_watcherDebounceTimer

wxTimer SCH_BASE_FRAME::m_watcherDebounceTimer
privateinherited

Definition at line 336 of file sch_base_frame.h.

Referenced by OnSymChange(), OnSymChangeDebounceTimer(), and SCH_BASE_FRAME().

◆ m_watcherFileName

wxFileName SCH_BASE_FRAME::m_watcherFileName
privateinherited

Definition at line 334 of file sch_base_frame.h.

Referenced by OnSymChange(), OnSymChangeDebounceTimer(), and setSymWatcher().

◆ m_watcherLastModified

wxDateTime SCH_BASE_FRAME::m_watcherLastModified
privateinherited

◆ m_zoomSelectBox

wxChoice* EDA_DRAW_FRAME::m_zoomSelectBox
protectedinherited

◆ NullUiString

const wxString UNITS_PROVIDER::NullUiString = ""
inlinestaticinherited

The string that is used in the UI to represent a null value.

Definition at line 248 of file units_provider.h.

Referenced by WX_GRID::GetOptionalUnitValue(), WX_GRID::onCellEditorHidden(), OptionalValueFromString(), and StringFromOptionalValue().


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