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

#include <footprint_wizard_frame.h>

Inheritance diagram for FOOTPRINT_WIZARD_FRAME:
PCB_BASE_EDIT_FRAME PCB_BASE_FRAME EDA_DRAW_FRAME 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

 FOOTPRINT_WIZARD_FRAME (KIWAY *aKiway, wxWindow *parent, FRAME_T aFrameType)
 
 ~FOOTPRINT_WIZARD_FRAME ()
 
BOARD_ITEM_CONTAINERGetModel () const override
 
FOOTPRINTGetBuiltFootprint ()
 
void PythonPluginsReload ()
 Reload the Python plugins if they are newer than the already loaded, and load new plugins if any.
 
COLOR_SETTINGSGetColorSettings (bool aForceRefresh=false) const override
 Helper to retrieve the current color settings.
 
void SelectCurrentWizard (wxCommandEvent &aDummy)
 
void DefaultParameters ()
 
void SelectWizardPreviousPage ()
 
void SelectWizardNextPage ()
 
void ExportSelectedFootprint (wxCommandEvent &aEvent)
 Will let the caller exit from the wait loop, and get the built footprint.
 
bool TryBefore (wxEvent &aEvent) override
 
wxString CreateNewLibrary (const wxString &aDialogTitle, const wxString &aInitialPath=wxEmptyString)
 If a library name is given, creates a new footprint library in the project folder with the given name.
 
wxString CreateNewProjectLibrary (const wxString &aDialogTitle, const wxString &aLibName)
 
wxString SelectLibrary (const wxString &aDialogTitle, const wxString &aListLabel, const std::vector< std::pair< wxString, bool * > > &aExtraCheckboxes={})
 Put up a dialog and allows the user to pick a library, for unspecified use.
 
bool AddLibrary (const wxString &aDialogTitle, const wxString &aLibName=wxEmptyString, FP_LIB_TABLE *aTable=nullptr)
 Add an existing library to either the global or project library table.
 
virtual void OnEditItemRequest (BOARD_ITEM *aItem)
 Install the corresponding dialog editor for the given item.
 
void SaveCopyInUndoList (EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand) override
 Create a new entry in undo list of commands.
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aCommandType) override
 Create a new entry in undo list of commands.
 
void AppendCopyToUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aCommandType) override
 As SaveCopyInUndoList, but appends the changes to the last undo item on the stack.
 
void RestoreCopyFromRedoList (wxCommandEvent &aEvent)
 Redo the last edit:
 
void RestoreCopyFromUndoList (wxCommandEvent &aEvent)
 Undo the last edit:
 
void RollbackFromUndo ()
 Perform an undo of the last edit without logging a corresponding redo.
 
void PutDataInPreviousState (PICKED_ITEMS_LIST *aList)
 Used in undo or redo command.
 
bool UndoRedoBlocked () const
 Check if the undo and redo operations are currently blocked.
 
void UndoRedoBlock (bool aBlock=true)
 Enable/disable undo and redo operations.
 
void SetGridVisibility (bool aVisible) override
 Override this function in the PCB_BASE_EDIT_FRAME to refill the layer widget.
 
void SetObjectVisible (GAL_LAYER_ID aLayer, bool aVisible=true)
 
virtual EDA_ANGLE GetRotationAngle () const
 Return the angle used for rotate operations.
 
void ShowReferenceImagePropertiesDialog (BOARD_ITEM *aBitmap)
 Set the angle used for rotate operations.
 
void ShowTextPropertiesDialog (PCB_TEXT *aText)
 
int ShowTextBoxPropertiesDialog (PCB_TEXTBOX *aTextBox)
 
void ShowGraphicItemPropertiesDialog (PCB_SHAPE *aShape)
 
void ActivateGalCanvas () override
 Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
 
virtual void SetBoard (BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr) override
 Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
 
void ClearUndoORRedoList (UNDO_REDO_LIST whichList, int aItemCount=-1) override
 Free the undo or redo list from List element.
 
void ClearListAndDeleteItems (PICKED_ITEMS_LIST *aList)
 
wxString GetDesignRulesPath ()
 Return the absolute path to the design rules file for the currently-loaded board.
 
APPEARANCE_CONTROLSGetAppearancePanel ()
 
LAYER_PAIR_SETTINGSGetLayerPairSettings ()
 Acess to the layer pair settings controller of the board, if available.
 
void ToggleProperties () override
 
void GetContextualTextVars (BOARD_ITEM *aSourceItem, const wxString &aCrossRef, wxArrayString *aTokens)
 
void HighlightSelectionFilter (const PCB_SELECTION_FILTER_OPTIONS &aOptions)
 
EDA_3D_VIEWER_FRAMEGet3DViewerFrame ()
 
FOOTPRINTLoadFootprint (const LIB_ID &aFootprintId)
 Attempt to load aFootprintId from the footprint library table.
 
BOX2I GetBoardBoundingBox (bool aBoardEdgesOnly=false) const
 Calculate the bounding box containing all board items (or board edge segments).
 
const BOX2I GetDocumentExtents (bool aIncludeAllVisible=true) const override
 Return bounding box of document with option to not include some items.
 
virtual 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 VECTOR2IGetAuxOrigin () const
 
const VECTOR2I GetUserOrigin () const
 
ORIGIN_TRANSFORMSGetOriginTransforms () override
 Return a reference to the default ORIGIN_TRANSFORMS object.
 
wxString MessageTextFromCoord (int aValue, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType) const
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
virtual BOARD_DESIGN_SETTINGSGetDesignSettings () const
 Return the BOARD_DESIGN_SETTINGS for the open project.
 
void SetDrawBgColor (const COLOR4D &aColor) override
 
const PCB_DISPLAY_OPTIONSGetDisplayOptions () const
 Display options control the way tracks, vias, outlines and other things are shown (for instance solid or sketch mode).
 
void SetDisplayOptions (const PCB_DISPLAY_OPTIONS &aOptions, bool aRefresh=true)
 Update the current display options.
 
virtual const PCB_PLOT_PARAMSGetPlotSettings () const
 Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.
 
virtual void SetPlotSettings (const PCB_PLOT_PARAMS &aSettings)
 
virtual void ReloadFootprint (FOOTPRINT *aFootprint)
 Reload the footprint from the library.
 
BOARDGetBoard () const
 
EDA_ITEMResolveItem (const KIID &aId, bool aAllowNullptrReturn=false) const override
 Fetch an item by KIID.
 
void FocusOnItem (EDA_ITEM *aItem, bool aAllowScroll=true) override
 Focus on a particular canvas item.
 
void FocusOnItem (BOARD_ITEM *aItem, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, bool aAllowScroll=true)
 
void FocusOnItems (std::vector< BOARD_ITEM * > aItems, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, bool aAllowScroll=true)
 
void HideSolderMask ()
 
void ShowSolderMask ()
 
virtual void ShowChangedLanguage () override
 Redraw the menus and what not in current language.
 
virtual void UpdateStatusBar () override
 Update the status bar information.
 
PCB_SCREENGetScreen () const override
 Return a pointer to a BASE_SCREEN or one of its derivatives.
 
EDA_3D_VIEWER_FRAMECreateAndShow3D_Frame ()
 Show the 3D view frame.
 
GENERAL_COLLECTORS_GUIDE GetCollectorsGuide ()
 
void OnModify () override
 Must be called after a change in order to set the "modify" flag and update other data structures and GUI elements.
 
FOOTPRINTCreateNewFootprint (wxString aFootprintName, const wxString &aLibName)
 Create a new footprint at position 0,0.
 
void PlaceFootprint (FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
 Place aFootprint at the current cursor position and updates footprint coordinates with the new position.
 
void ShowPadPropertiesDialog (PAD *aPad)
 
FOOTPRINTSelectFootprintFromLibrary (LIB_ID aPreselect=LIB_ID())
 Open a dialog to select a footprint.
 
virtual void AddFootprintToBoard (FOOTPRINT *aFootprint)
 Add the given footprint to the board.
 
void Compile_Ratsnest (bool aDisplayStatus)
 Create the entire board ratsnest.
 
PCB_LAYER_ID SelectOneLayer (PCB_LAYER_ID aDefaultLayer, const LSET &aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
 Show the dialog box for a layer selection.
 
virtual void SwitchLayer (PCB_LAYER_ID aLayer)
 Change the active layer in the frame.
 
virtual void SetActiveLayer (PCB_LAYER_ID aLayer)
 
virtual PCB_LAYER_ID GetActiveLayer () const
 
SEVERITY GetSeverity (int aErrorCode) const override
 
virtual void OnDisplayOptionsChanged ()
 
PCBNEW_SETTINGSGetPcbNewSettings () const
 
FOOTPRINT_EDITOR_SETTINGSGetFootprintEditorSettings () const
 
virtual PCB_VIEWERS_SETTINGS_BASEGetViewerSettingsBase () const
 
virtual MAGNETIC_SETTINGSGetMagneticItemsSettings ()
 
void CommonSettingsChanged (int aFlags) override
 Notification event that some of the common (suite-wide) settings have changed.
 
PCB_DRAW_PANEL_GALGetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame.
 
void AddBoardChangeListener (wxEvtHandler *aListener)
 Add aListener to post #EDA_EVT_BOARD_CHANGED command events to.
 
void RemoveBoardChangeListener (wxEvtHandler *aListener)
 Remove aListener to from the board changed listener list.
 
void OnFPChange (wxFileSystemWatcherEvent &aEvent)
 Handler for FP change events.
 
void OnFpChangeDebounceTimer (wxTimerEvent &aEvent)
 Handler for the filesystem watcher debounce timer.
 
void GetLibraryItemsForListDialog (wxArrayString &aHeaders, std::vector< wxArrayString > &aItemsToDisplay)
 
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.
 
virtual std::unique_ptr< GRID_HELPERMakeGridHelper ()
 
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 COLOR4D GetDrawBgColor () const
 
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
 
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.
 
void OnMove (wxMoveEvent &aEvent) override
 
virtual void HardRedraw ()
 Rebuild the GAL and redraws the screen.
 
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.
 
virtual void ClearMsgPanel ()
 Clear all messages from 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.
 
virtual LIB_TREEGetLibTree () const
 
virtual LIB_ID GetTargetLibId () const
 
virtual bool IsLibraryTreeShown () const
 
virtual void ToggleLibraryTree ()
 
virtual void FocusLibraryTreeInput ()
 
PROPERTIES_PANELGetPropertiesPanel ()
 
void UpdateProperties ()
 
virtual void SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Change the current rendering backend.
 
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().
 
virtual void KiwayMailIn (KIWAY_EXPRESS &aEvent)
 Receive KIWAY_EXPRESS messages from other players.
 
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)
 
SETTINGS_MANAGERGetSettingsManager () 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.
 
virtual APP_SETTINGS_BASEconfig () const
 Return the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
 
void LoadWindowState (const wxString &aFileName)
 
virtual void LoadWindowState (const WINDOW_STATE &aState)
 Load frame state info from a configuration file.
 
void LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
 Load window settings from the given settings object.
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Save window settings to the given settings object.
 
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
 
virtual bool IsContentModified () const
 Get if the contents of the frame have been modified since the last save.
 
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 SELECTIONGetCurrentSelection ()
 Get the current selection from the canvas area.
 
virtual void PushTool (const TOOL_EVENT &aEvent)
 NB: the definition of "tool" is different at the user level.
 
virtual void PopTool (const TOOL_EVENT &aEvent)
 Pops a tool from the stack.
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
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.
 

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.
 

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
 
wxString createNewLibrary (const wxString &aDialogTitle, const wxString &aLibName, const wxString &aInitialPath, FP_LIB_TABLE *aTable)
 Create a new library in the given table.
 
void handleActivateEvent (wxActivateEvent &aEvent) override
 Handle a window activation event.
 
void saveCopyInUndoList (PICKED_ITEMS_LIST *commandToUndo, const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aCommandType)
 
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.
 
virtual void onDarkModeToggle ()
 
bool canCloseWindow (wxCloseEvent &aCloseEvent) override
 
void handleIconizeEvent (wxIconizeEvent &aEvent) override
 Handle a window iconize event.
 
virtual void doReCreateMenuBar () override
 
FOOTPRINTloadFootprint (const LIB_ID &aFootprintId)
 Attempt to load aFootprintId from the footprint library table.
 
void rebuildConnectivity ()
 
void setFPWatcher (FOOTPRINT *aFootprint)
 Create or removes a watcher on the specified footprint.
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
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)
 
virtual void setupUIConditions ()
 Setup the UI conditions for the various actions and their controls in this frame.
 
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

wxString m_wizardName
 name of the current wizard
 
wxString m_wizardDescription
 description of the wizard
 
wxString m_wizardStatus
 current wizard status
 
bool m_undoRedoBlocked
 
PANEL_SELECTION_FILTERm_selectionFilterPanel
 
APPEARANCE_CONTROLSm_appearancePanel
 
std::unique_ptr< LAYER_PAIR_SETTINGSm_layerPairSettings
 
PCB_LAYER_BOX_SELECTORm_SelLayerBox
 
wxAuiNotebook * m_tabbedPanel
 
bool m_darkMode
 Panel with Layers and Object Inspector tabs.
 
BOARDm_pcb
 
PCB_DISPLAY_OPTIONS m_displayOptions
 
PCB_ORIGIN_TRANSFORMS m_originTransforms
 
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
 
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
 
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 Member Functions

void OnSize (wxSizeEvent &event) override
 Recalculate the size of toolbars and display panel when the frame size changes.
 
void OnGridSize (wxSizeEvent &aSizeEvent)
 
void UpdateMsgPanel () override
 Redraw the message panel.
 
void updateView ()
 Rebuild the GAL view (reint tool manager, colors and drawings) must be run after any footprint change.
 
void OnSashDrag (wxSashEvent &event)
 Resize the child windows when dragging a sash window border.
 
void ReCreatePageList ()
 Create or recreate the list of parameter pages for the current wizard.
 
void ReCreateParameterList ()
 Create the list of parameters for the current page.
 
void ResizeParamColumns ()
 Expand the 'Value' column to fill available.
 
void initParameterGrid ()
 Prepare the grid where parameters are displayed.
 
void SelectFootprintWizard ()
 Show the list of footprint wizards available into the system.
 
void RegenerateFootprint ()
 Regenerate the current footprint.
 
void DisplayBuildMessage (wxString &aMessage)
 Display the message generated by the python build footprint script.
 
FOOTPRINT_WIZARDGetMyWizard ()
 Reloads the wizard by name.
 
void DisplayWizardInfos ()
 Show all the details about the current wizard.
 
void doCloseWindow () override
 
void ClickOnPageList (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.
 
WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg) override
 Return a pointer to the window settings for this frame.
 
void OnActivate (wxActivateEvent &event)
 Called when the frame frame is activate to reload the libraries and component lists that can be changed by the schematic editor or the library editor.
 
void ParametersUpdated (wxGridEvent &event)
 Update the footprint python parameters values from the values in grid.
 
void Update3DView (bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr) override
 Update the 3D view, if the viewer is opened by this frame.
 
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

wxPanel * m_parametersPanel
 Panel for the page list and parameter grid.
 
wxListBox * m_pageList
 The list of pages.
 
WX_GRIDm_parameterGrid
 The list of parameters.
 
int m_parameterGridPage
 the page currently displayed by m_parameterGrid it is most of time the m_pageList selection, but can differ during transitions between pages.
 
wxTextCtrl * m_buildMessageBox
 
wxString m_auiPerspective
 Encoded string describing the AUI layout.
 
bool m_wizardListShown
 A show-once flag for the wizard list.
 
std::unique_ptr< NL_PCBNEW_PLUGINm_spaceMouse
 
std::unique_ptr< wxFileSystemWatcherm_watcher
 
wxFileName m_watcherFileName
 
wxDateTime m_watcherLastModified
 
wxTimer m_watcherDebounceTimer
 
bool m_inFpChangeTimerEvent
 
std::vector< wxEvtHandler * > m_boardChangeListeners
 
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
 

Detailed Description

Definition at line 52 of file footprint_wizard_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.

◆ 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

◆ FOOTPRINT_WIZARD_FRAME()

FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME ( KIWAY * aKiway,
wxWindow * parent,
FRAME_T aFrameType )

◆ ~FOOTPRINT_WIZARD_FRAME()

FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME ( )

Member Function Documentation

◆ ActivateGalCanvas()

void PCB_BASE_EDIT_FRAME::ActivateGalCanvas ( )
overridevirtualinherited

Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.

Reimplemented from PCB_BASE_FRAME.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 196 of file pcb_base_edit_frame.cpp.

References PCB_BASE_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::m_pcb, and PCB_DRAW_PANEL_GAL::SyncLayersVisibility().

Referenced by FOOTPRINT_EDIT_FRAME::ActivateGalCanvas(), and PCB_EDIT_FRAME::ActivateGalCanvas().

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

◆ AddBoardChangeListener()

void PCB_BASE_FRAME::AddBoardChangeListener ( wxEvtHandler * aListener)
inherited

Add aListener to post #EDA_EVT_BOARD_CHANGED command events to.

Warning
The caller is responsible for removing any listeners that are no long valid.
Note
This only gets called when the board editor is in stand alone mode. Changing projects in the project manager closes the board editor when a new project is loaded.

Definition at line 206 of file pcb_base_frame.cpp.

References m_boardChangeListeners.

◆ AddFootprintToBoard()

void PCB_BASE_FRAME::AddFootprintToBoard ( FOOTPRINT * aFootprint)
virtualinherited

◆ AddLibrary()

bool PCB_BASE_EDIT_FRAME::AddLibrary ( const wxString & aDialogTitle,
const wxString & aLibName = wxEmptyString,
FP_LIB_TABLE * aTable = nullptr )
inherited

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

◆ AngleValueFromString()

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

◆ AppearancePanelName()

static const wxString EDA_DRAW_FRAME::AppearancePanelName ( )
inlinestaticinherited

◆ AppendCopyToUndoList()

void PCB_BASE_EDIT_FRAME::AppendCopyToUndoList ( const PICKED_ITEMS_LIST & aItemsList,
UNDO_REDO aCommandType )
overridevirtualinherited

As SaveCopyInUndoList, but appends the changes to the last undo item on the stack.

Reimplemented from PCB_BASE_FRAME.

Definition at line 183 of file undo_redo.cpp.

References PICKED_ITEMS_LIST::GetDescription(), EDA_BASE_FRAME::PopCommandFromUndoList(), saveCopyInUndoList(), and PICKED_ITEMS_LIST::SetDescription().

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

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

◆ canCloseWindow()

bool PCB_BASE_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent)
overrideprotectedvirtualinherited

Reimplemented from EDA_BASE_FRAME.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 105 of file pcb_base_frame.cpp.

References PROJECT_PCB::Cleanup3DCache(), Get3DViewerFrame(), and KIWAY_HOLDER::Prj().

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

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

◆ ClearListAndDeleteItems()

void PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems ( PICKED_ITEMS_LIST * aList)
inherited

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

void PCB_BASE_EDIT_FRAME::ClearUndoORRedoList ( UNDO_REDO_LIST whichList,
int aItemCount = -1 )
overridevirtualinherited

Free the undo or redo list from List 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). Items are removed from the beginning of the list so this function can be called to remove old commands.

Parameters
whichListthe UNDO_REDO_CONTAINER to clear.
aItemCountthe count of items to remove. < 0 for all items.

Reimplemented from EDA_BASE_FRAME.

Definition at line 666 of file undo_redo.cpp.

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

Referenced by saveCopyInUndoList().

◆ ClearUndoRedoList()

◆ ClickOnPageList()

void FOOTPRINT_WIZARD_FRAME::ClickOnPageList ( wxCommandEvent & event)
private

◆ commonInit()

◆ CommonSettingsChanged()

◆ Compile_Ratsnest()

void PCB_BASE_FRAME::Compile_Ratsnest ( bool aDisplayStatus)
inherited

Create the entire board ratsnest.

Function Compile_Ratsnest Create the entire board ratsnest.

This must be called after a board change (changes for pads, footprints or a read netlist ).

Parameters
aDisplayStatusif true, display the computation results.

Must be called after a board change (changes for pads, footprints or a read netlist ).

Parameters
aDisplayStatus: if true, display the computation results

Definition at line 35 of file ratsnest.cpp.

References GetBoard(), BOARD::GetConnectivity(), m_pcb, BOARD::OnRatsnestChanged(), CONNECTIVITY_DATA::RecalculateRatsnest(), EDA_DRAW_FRAME::SetMsgPanel(), and BOARD::UpdateRatsnestExclusions().

Referenced by PCB_EDIT_FRAME::OnNetlistChanged(), PlaceFootprint(), and PCB_BASE_EDIT_FRAME::PutDataInPreviousState().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const
virtualinherited

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

Reimplemented in FOOTPRINT_EDIT_FRAME, KICAD_MANAGER_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 1006 of file eda_base_frame.cpp.

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), EDA_DRAW_FRAME::AddApiPluginTools(), PCB_CONTROL::AppendBoard(), PCB_CONTROL::AppendDesignBlock(), AskLoadBoardFileName(), EDA_DRAW_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), SIMULATOR_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), PCB_VIEWER_TOOLS::FootprintAutoZoom(), PCB_EDITOR_CONDITIONS::footprintViewerAutoZoom(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GERBVIEW_FRAME::gvconfig(), EDA_DRAW_FRAME::IsGridOverridden(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), PCB_CALCULATOR_FRAME::loadPages(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), GERBVIEW_FRAME::Read_EXCELLON_File(), RecreateToolbars(), SaveSettings(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetDisplayOptions(), EDA_DRAW_FRAME::SetGridOverrides(), EDA_DRAW_FRAME::SetGridVisibility(), SCH_EDIT_FRAME::SetSchematic(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIMULATOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), BITMAP2CMP_FRAME::ShowChangedLanguage(), PCB_CALCULATOR_FRAME::ShowChangedLanguage(), EDA_DRAW_FRAME::UpdateGridSelectBox(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), windowClosing(), and BITMAP2CMP_FRAME::~BITMAP2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited

Get the configuration base name.

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

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

Reimplemented from TOOLS_HOLDER.

Definition at line 353 of file eda_base_frame.h.

References m_configName.

◆ configureToolbars()

◆ CreateAndShow3D_Frame()

EDA_3D_VIEWER_FRAME * PCB_BASE_FRAME::CreateAndShow3D_Frame ( )
inherited

Show the 3D view frame.

If it does not exist, it is created. If it exists, it is brought to the foreground.

Definition at line 671 of file pcb_base_frame.cpp.

References _, Get3DViewerFrame(), and Kiway.

Referenced by PCB_VIEWER_TOOLS::Show3DViewer(), and FOOTPRINT_CHOOSER_FRAME::Show3DViewerFrame().

◆ CreateHotkeyPopup()

void EDA_DRAW_FRAME::CreateHotkeyPopup ( )
virtualinherited

Definition at line 1261 of file eda_draw_frame.cpp.

References m_hotkeyPopup.

◆ CreateInfoBar()

◆ CreateNewFootprint()

FOOTPRINT * PCB_BASE_FRAME::CreateNewFootprint ( wxString aFootprintName,
const wxString & aLibName )
inherited

Create a new footprint at position 0,0.

The new footprint contains only 2 texts: a reference and a value: Reference = REF** Value = "VAL**" or Footprint name in lib

Note
They are dummy texts which will be replaced by the actual texts when the footprint is placed on a board and a netlist is read.
Parameters
aFootprintNameis the name of the new footprint in library.
aLibNameoptional, if specified is the library for the new footprint

Definition at line 1175 of file footprint_libraries_utils.cpp.

References _, FOOTPRINT, FP_LIB_TABLE::FootprintEnumerate(), FP_LIB_TABLE::FootprintExists(), FP_LIB_TABLE::FootprintLoad(), FP_SMD, FOOTPRINT::GetAttributes(), GetBoard(), GetDesignSettings(), BOARD_ITEM::GetLayer(), FOOTPRINT::GetReference(), BOARD_DESIGN_SETTINGS::GetTextItalic(), BOARD_DESIGN_SETTINGS::GetTextSize(), BOARD_DESIGN_SETTINGS::GetTextThickness(), BOARD_DESIGN_SETTINGS::GetTextUpright(), FOOTPRINT::GetValue(), FOOTPRINT::GraphicalItems(), BOARD_DESIGN_SETTINGS::m_DefaultFPTextItems, PCB_FIELD_T, PCB_TEXT_T, PROJECT_PCB::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), RECURSE, FOOTPRINT::Reference(), FOOTPRINT::RunOnChildren(), FOOTPRINT::SetAttributes(), FOOTPRINT::SetFPID(), EDA_TEXT::SetItalic(), EDA_TEXT::SetKeepUpright(), BOARD_ITEM::SetLayer(), EDA_DRAW_FRAME::SetMsgPanel(), PCB_TEXT::SetPosition(), FOOTPRINT::SetReference(), EDA_TEXT::SetText(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), FOOTPRINT::SetValue(), EDA_TEXT::SetVisible(), EDA_ITEM::Type(), FOOTPRINT::Value(), and VECTOR2< T >::y.

Referenced by MICROWAVE_TOOL::createBaseFootprint(), and MICROWAVE_TOOL::createMicrowaveInductor().

◆ CreateNewLibrary()

wxString PCB_BASE_EDIT_FRAME::CreateNewLibrary ( const wxString & aDialogTitle,
const wxString & aInitialPath = wxEmptyString )
inherited

If a library name is given, creates a new footprint library in the project folder with the given name.

If no library name is given it prompts user for a library path, then creates a new footprint library at that location. If library exists, user is warned about that, and is given a chance to abort the new creation, and in that case existing library is first deleted.

Parameters
aDialogTitletitle for the file browser
aInitialPathis the initial path and filename shown in the file chooser dialog.
Returns
The newly created library path if library was successfully created, else wxEmptyString because user aborted or error.

Definition at line 305 of file footprint_libraries_utils.cpp.

References createNewLibrary().

Referenced by FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveLibraryAs(), and SelectLibrary().

◆ createNewLibrary()

wxString PCB_BASE_EDIT_FRAME::createNewLibrary ( const wxString & aDialogTitle,
const wxString & aLibName,
const wxString & aInitialPath,
FP_LIB_TABLE * aTable )
protectedinherited

◆ CreateNewProjectLibrary()

wxString PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary ( const wxString & aDialogTitle,
const wxString & aLibName )
inherited

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

◆ DefaultParameters()

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

◆ DesignBlocksPaneName()

◆ Destroy()

◆ DismissModal()

◆ DisplayBuildMessage()

void FOOTPRINT_WIZARD_FRAME::DisplayBuildMessage ( wxString & aMessage)
private

Display the message generated by the python build footprint script.

Definition at line 88 of file footprint_wizard_frame_functions.cpp.

References m_buildMessageBox.

Referenced by GetBuiltFootprint(), and RegenerateFootprint().

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

◆ DisplayWizardInfos()

void FOOTPRINT_WIZARD_FRAME::DisplayWizardInfos ( )
private

Show all the details about the current wizard.

Definition at line 41 of file footprint_wizard_frame_functions.cpp.

References _, and m_wizardName.

Referenced by ClickOnPageList(), DefaultParameters(), OnActivate(), ParametersUpdated(), ReCreatePageList(), and SelectFootprintWizard().

◆ 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 FOOTPRINT_WIZARD_FRAME::doCloseWindow ( )
overrideprivatevirtual

◆ doReCreateMenuBar()

void PCB_BASE_FRAME::doReCreateMenuBar ( )
overrideprotectedvirtualinherited

Reimplemented from EDA_BASE_FRAME.

Reimplemented in FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and PCB_EDIT_FRAME.

Definition at line 651 of file pcb_base_frame.cpp.

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

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

◆ ExportSelectedFootprint()

void FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint ( wxCommandEvent & aEvent)

Will let the caller exit from the wait loop, and get the built footprint.

Definition at line 260 of file footprint_wizard_frame.cpp.

References KIWAY_PLAYER::DismissModal().

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

virtual void EDA_DRAW_FRAME::FocusLibraryTreeInput ( )
inlinevirtualinherited

Reimplemented in FOOTPRINT_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 420 of file eda_draw_frame.h.

◆ FocusOnItem() [1/2]

void PCB_BASE_FRAME::FocusOnItem ( BOARD_ITEM * aItem,
PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
bool aAllowScroll = true )
inherited

Definition at line 265 of file pcb_base_frame.cpp.

References FocusOnItems().

◆ FocusOnItem() [2/2]

void PCB_BASE_FRAME::FocusOnItem ( EDA_ITEM * aItem,
bool aAllowScroll = true )
overridevirtualinherited

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 256 of file pcb_base_frame.cpp.

References FocusOnItem(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), and UNDEFINED_LAYER.

Referenced by FocusOnItem().

◆ FocusOnItems()

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

◆ Get3DViewerFrame()

◆ GetAboutTitle()

const wxString & EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetActiveLayer()

◆ GetAppearancePanel()

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inherited

◆ GetAuxOrigin()

const VECTOR2I & PCB_BASE_FRAME::GetAuxOrigin ( ) const
inherited

Definition at line 517 of file pcb_base_frame.cpp.

References m_pcb.

Referenced by GetUserOrigin().

◆ GetBoard()

BOARD * PCB_BASE_FRAME::GetBoard ( ) const
inlineinherited

Definition at line 210 of file pcb_base_frame.h.

References m_pcb.

Referenced by AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_CONTROL::AppendBoard(), FOOTPRINT_CHOOSER_FRAME::build3DCanvas(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), FOOTPRINT_EDIT_FRAME::canCloseWindow(), PCB_EDIT_FRAME::canCloseWindow(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_EDIT_FRAME::ClearModify(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), CommonSettingsChanged(), Compile_Ratsnest(), CONVERT_TOOL::CreateLines(), CreateNewFootprint(), ZONE_CREATE_HELPER::createNewZone(), API_HANDLER_PCB::deleteItemsInternal(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_MULTICHANNEL_REPEAT_LAYOUT::DIALOG_MULTICHANNEL_REPEAT_LAYOUT(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), FOOTPRINT_VIEWER_FRAME::displayFootprint(), PCB_EDIT_FRAME::DoAutoSave(), PCB_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Edit_Zone_Params(), VIA_SIZE_MENU::eventHandler(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), PCB_EDIT_FRAME::ExportSpecctraFile(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::FindItemsFromSyncSelection(), FocusOnItems(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), EDA_3D_VIEWER_FRAME::GetBoard(), PCBNEW_JOBS_HANDLER::getBoard(), PCB_EDIT_FRAME::GetCurrentFileName(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), FOOTPRINT_EDIT_FRAME::GetDesignSettings(), FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), GetFootprintFromBoardByReference(), API_HANDLER_PCB::getItemById(), PCB_EDIT_FRAME::GetLastPath(), FOOTPRINT_EDIT_FRAME::GetLoadedFPID(), DISPLAY_FOOTPRINTS_FRAME::GetModel(), FOOTPRINT_EDIT_FRAME::GetModel(), FOOTPRINT_VIEWER_FRAME::GetModel(), FOOTPRINT_WIZARD_FRAME::GetModel(), GetSeverity(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handleExpandTextVariables(), API_HANDLER_PCB::handleGetBoardOrigin(), API_HANDLER_PCB::handleGetGraphicsDefaults(), API_HANDLER_PCB::handleGetItems(), API_HANDLER_PCB::handleGetNetClassForNets(), API_HANDLER_PCB::handleGetNets(), API_HANDLER_PCB::handleGetStackup(), API_HANDLER_PCB::handleGetTitleBlockInfo(), API_HANDLER_PCB::handleSaveCopyOfDocument(), API_HANDLER_PCB::handleSetVisibleLayers(), FOOTPRINT_VIEWER_FRAME::HardRedraw(), PCB_EDIT_FRAME::HardRedraw(), PCB_EDITOR_CONDITIONS::hasItemsFunc(), HideSolderMask(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), PCB_EDIT_FRAME::ImportSpecctraSession(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), FOOTPRINT_EDIT_FRAME::IsContentModified(), FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), PCB_EDIT_FRAME::IsElementVisible(), PCB_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::LoadDrawingSheet(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), PCB_EDIT_FRAME::OnBoardLoaded(), PCB_EDIT_FRAME::OnCrossProbeFlashTimer(), ARRAY_TOOL::onDialogClosed(), OnFpChangeDebounceTimer(), OnModify(), PCB_EDIT_FRAME::OnNetlistChanged(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_LAYERS::PANEL_SETUP_LAYERS(), EDIT_TOOL::Properties(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::RebuildAndRefresh(), rebuildConnectivity(), PCB_EDIT_FRAME::redrawNetnames(), FOOTPRINT_WIZARD_FRAME::RegenerateFootprint(), DISPLAY_FOOTPRINTS_FRAME::ReloadFootprint(), FOOTPRINT_EDIT_FRAME::ReloadFootprint(), PCB_EDIT_FRAME::ResolveDRCExclusions(), ResolveItem(), PCB_EDIT_FRAME::RunActionPlugin(), PCB_EDIT_FRAME::SaveBoard(), PCB_EDIT_FRAME::SaveBoardAsDesignBlock(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), PCB_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_EDIT_FRAME::saveSelectionToDesignBlock(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SetBoard(), PCB_EDIT_FRAME::SetElementVisibility(), PCB_EDIT_FRAME::SetLastPath(), PCB_EDIT_FRAME::SetPageSettings(), SetPlotSettings(), ZONE_CREATE_HELPER::setUniquePriority(), ZONE_SETTINGS::SetupLayersList(), FOOTPRINT_EDIT_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), FOOTPRINT_VIEWER_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), ShowSolderMask(), PCB_EDIT_FRAME::SwitchLayer(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), unitsChangeRefresh(), VIA_SIZE_MENU::update(), FOOTPRINT_EDIT_FRAME::updateEnabledLayers(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), PCB_EDIT_FRAME::UpdateTitle(), PCB_EDIT_FRAME::UpdateUserInterface(), FOOTPRINT_EDIT_FRAME::UpdateView(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), GLOBAL_EDIT_TOOL::ZonesManager(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), and PCB_EDIT_FRAME::~PCB_EDIT_FRAME().

◆ GetBoardBoundingBox()

BOX2I PCB_BASE_FRAME::GetBoardBoundingBox ( bool aBoardEdgesOnly = false) const
inherited

Calculate the bounding box containing all board items (or board edge segments).

Parameters
aBoardEdgesOnlyis true if we are interested in board edge segments only.
Returns
the board's bounding box.

Definition at line 605 of file pcb_base_frame.cpp.

References BOX2< Vec >::GetHeight(), GetPageSizeIU(), BOX2< Vec >::GetWidth(), m_pcb, EDA_DRAW_FRAME::m_showBorderAndTitleBlock, BOX2< Vec >::SetEnd(), BOX2< Vec >::SetOrigin(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), and GetDocumentExtents().

◆ GetBuiltFootprint()

◆ GetCanvas()

PCB_DRAW_PANEL_GAL * PCB_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 1003 of file pcb_base_frame.cpp.

References EDA_DRAW_FRAME::GetCanvas().

Referenced by FOOTPRINT_EDIT_FRAME::ActivateGalCanvas(), PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), ActivateGalCanvas(), PCB_EDIT_FRAME::ActivateGalCanvas(), AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_SELECTION_TOOL::canvas(), PCB_VIEWER_TOOLS::canvas(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), FOOTPRINT_VIEWER_FRAME::CommonSettingsChanged(), CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), PCB_BASE_EDIT_FRAME::configureToolbars(), ZONE_CREATE_HELPER::createNewZone(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), PCB_EDIT_FRAME::doCloseWindow(), EDIT_TOOL::doMoveSelection(), PCB_EDIT_FRAME::Edit_Zone_Params(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), FocusOnItems(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GetCollectorsGuide(), PCB_TUNING_PATTERN::GetPreviewItems(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), API_HANDLER_PCB::handleSetVisibleLayers(), FOOTPRINT_EDIT_FRAME::HardRedraw(), PCB_EDIT_FRAME::HardRedraw(), HideSolderMask(), PCB_EDIT_FRAME::ImportSpecctraSession(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), PCB_EDIT_FRAME::LoadProjectSettings(), LoadSettings(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_EDIT_FRAME::OnBoardLoaded(), PCB_EDIT_FRAME::OnCrossProbeFlashTimer(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), OnFpChangeDebounceTimer(), PANEL_COMPONENT_CLASS_ASSIGNMENT::OnHighlightItemsClick(), PCB_EDIT_FRAME::OnNetlistChanged(), DIALOG_FP_EDIT_PAD_TABLE::OnSelectCell(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), ROUTER_TOOL::performRouting(), PlaceFootprint(), ROUTER_TOOL::prepareInteractive(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::RebuildAndRefresh(), rebuildConnectivity(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_WIZARD_FRAME::ReCreatePageList(), PCB_EDIT_FRAME::redrawNetnames(), FOOTPRINT_WIZARD_FRAME::RegenerateFootprint(), DISPLAY_FOOTPRINTS_FRAME::ReloadFootprint(), PCB_EDIT_FRAME::ResolveDRCExclusions(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), DIALOG_FP_EDIT_PAD_TABLE::RestoreOriginalPadState(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PCB_BASE_EDIT_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_EDIT_FRAME::SetBoard(), SetBoard(), SetDisplayOptions(), PCB_EDIT_FRAME::SetElementVisibility(), PCB_EDIT_FRAME::SetGridColor(), PCB_EDIT_FRAME::SetPageSettings(), SetPlotSettings(), FOOTPRINT_EDIT_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowReferenceImagePropertiesDialog(), ShowSolderMask(), FOOTPRINT_EDIT_FRAME::SwitchCanvas(), SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), PCB_EDIT_FRAME::ToggleSearch(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), FOOTPRINT_EDIT_FRAME::updateEnabledLayers(), UpdateStatusBar(), PCB_EDIT_FRAME::UpdateUserInterface(), FOOTPRINT_EDIT_FRAME::UpdateView(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), PANEL_ASSIGN_COMPONENT_CLASSES::Validate(), GLOBAL_EDIT_TOOL::ZonesManager(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME(), PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME(), and ~PCB_BASE_FRAME().

◆ GetCollectorsGuide()

◆ GetColorSettings()

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

Helper to retrieve the current color settings.

Reimplemented from PCB_BASE_FRAME.

Definition at line 285 of file footprint_wizard_frame.cpp.

References DEFAULT_THEME, PCB_BASE_FRAME::GetFootprintEditorSettings(), and APP_SETTINGS_BASE::m_ColorTheme.

◆ GetContextualTextVars()

void PCB_BASE_EDIT_FRAME::GetContextualTextVars ( BOARD_ITEM * aSourceItem,
const wxString & aCrossRef,
wxArrayString * aTokens )
inherited

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

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

◆ GetDesignRulesPath()

wxString PCB_BASE_EDIT_FRAME::GetDesignRulesPath ( )
inherited

Return the absolute path to the design rules file for the currently-loaded board.

Note
There is no guarantee that this file actually exists and can be opened! It only makes sense from PcbNew but is needed in PCB_BASE_EDIT_FRAME::SetBoard.

Definition at line 281 of file pcb_base_edit_frame.cpp.

References PROJECT::AbsolutePath(), FILEEXT::DesignRulesFileExtension, PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), and Prj().

Referenced by PCB_EDIT_FRAME::CommonSettingsChanged(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::OnBoardLoaded(), PCB_EDIT_FRAME::OnNetlistChanged(), PCB_EDIT_FRAME::SavePcbCopy(), and PCB_EDIT_FRAME::SavePcbFile().

◆ GetDesignSettings()

◆ GetDisplayOptions()

◆ GetDocumentExtents()

const BOX2I PCB_BASE_FRAME::GetDocumentExtents ( bool aIncludeAllVisible = true) const
overridevirtualinherited

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 629 of file pcb_base_frame.cpp.

References Edge_Cuts, GetBoardBoundingBox(), and m_pcb.

Referenced by NL_PCBNEW_PLUGIN_IMPL::GetModelExtents().

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

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

Reimplemented in SCH_BASE_FRAME.

Definition at line 181 of file eda_draw_frame.h.

References m_drawBgColor.

Referenced by PROPERTIES_FRAME::PROPERTIES_FRAME(), and PL_EDITOR_FRAME::SaveSettings().

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

◆ GetFootprintEditorSettings()

◆ 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 & PCB_BASE_FRAME::GetGridOrigin ( ) const
overridevirtualinherited

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 505 of file pcb_base_frame.cpp.

References m_pcb.

Referenced by GetUserOrigin().

◆ GetHotkeyPopup()

HOTKEY_CYCLE_POPUP * EDA_DRAW_FRAME::GetHotkeyPopup ( )
inlineinherited

Definition at line 493 of file eda_draw_frame.h.

References m_hotkeyPopup.

◆ GetInfoBar()

◆ GetIuScale()

◆ GetLayerPairSettings()

LAYER_PAIR_SETTINGS * PCB_BASE_EDIT_FRAME::GetLayerPairSettings ( )
inlineinherited

Acess to the layer pair settings controller of the board, if available.

Definition at line 242 of file pcb_base_edit_frame.h.

References m_layerPairSettings.

◆ GetLibraryItemsForListDialog()

◆ GetLibTree()

virtual LIB_TREE * EDA_DRAW_FRAME::GetLibTree ( ) const
inlinevirtualinherited

Reimplemented in FOOTPRINT_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 415 of file eda_draw_frame.h.

◆ GetMagneticItemsSettings()

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

◆ GetModel()

BOARD_ITEM_CONTAINER * FOOTPRINT_WIZARD_FRAME::GetModel ( ) const
overridevirtual
Returns
the primary data model.

Implements PCB_BASE_FRAME.

Definition at line 571 of file footprint_wizard_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), and BOARD::GetFirstFootprint().

◆ 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

◆ GetMyWizard()

FOOTPRINT_WIZARD * FOOTPRINT_WIZARD_FRAME::GetMyWizard ( )
private

◆ 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 & PCB_BASE_FRAME::GetOriginTransforms ( )
overridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from EDA_BASE_FRAME.

Definition at line 538 of file pcb_base_frame.cpp.

References m_originTransforms.

◆ 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 & PCB_BASE_FRAME::GetPageSettings ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 490 of file pcb_base_frame.cpp.

References m_pcb.

Referenced by FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME().

◆ GetPageSizeIU()

const VECTOR2I PCB_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 496 of file pcb_base_frame.cpp.

References m_pcb, and pcbIUScale.

Referenced by PCB_CONTROL::AppendBoard(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), GetBoardBoundingBox(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ GetPcbNewSettings()

◆ GetPlotSettings()

const PCB_PLOT_PARAMS & PCB_BASE_FRAME::GetPlotSettings ( ) const
virtualinherited

Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 569 of file pcb_base_frame.cpp.

References m_pcb.

Referenced by FOOTPRINT_EDIT_FRAME::GetPlotSettings().

◆ 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

◆ GetRotationAngle()

EDA_ANGLE PCB_BASE_EDIT_FRAME::GetRotationAngle ( ) const
virtualinherited

Return the angle used for rotate operations.

Reimplemented in FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 189 of file pcb_base_edit_frame.cpp.

References ANGLE_90.

Referenced by TOOL_EVT_UTILS::GetEventRotationAngle().

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

◆ GetSettingsManager()

◆ GetSeverity()

SEVERITY PCB_BASE_FRAME::GetSeverity ( int aErrorCode) const
overridevirtualinherited

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

◆ GetTargetLibId()

virtual LIB_ID EDA_DRAW_FRAME::GetTargetLibId ( ) const
inlinevirtualinherited

Reimplemented in SYMBOL_EDIT_FRAME.

Definition at line 416 of file eda_draw_frame.h.

◆ GetTitleBlock()

const TITLE_BLOCK & PCB_BASE_FRAME::GetTitleBlock ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 544 of file pcb_base_frame.cpp.

References m_pcb.

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

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

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

◆ GetUserOrigin()

const VECTOR2I PCB_BASE_FRAME::GetUserOrigin ( ) const
inherited

◆ GetUserUnits()

◆ GetViewerSettingsBase()

◆ GetWindowSettings()

WINDOW_SETTINGS * FOOTPRINT_WIZARD_FRAME::GetWindowSettings ( APP_SETTINGS_BASE * aCfg)
overrideprivatevirtual

Return a pointer to the window settings for this frame.

By default, points to aCfg->m_Window for top-level frames.

Parameters
aCfgis this frame's config object

Reimplemented from EDA_BASE_FRAME.

Definition at line 526 of file footprint_wizard_frame.cpp.

References APP_SETTINGS_BASE::m_Window.

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )
inherited

Get the undecorated window size that can be used for restoring the window size.

This is needed for GTK, since the normal wxWidgets GetSize() call will return a window size that includes the window decorations added by the window manager.

Returns
the undecorated window size

Definition at line 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 PCB_BASE_EDIT_FRAME::handleActivateEvent ( wxActivateEvent & aEvent)
overrideprotectedvirtualinherited

Handle a window activation event.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 292 of file pcb_base_edit_frame.cpp.

References PCB_BASE_FRAME::handleActivateEvent(), and m_appearancePanel.

◆ handleIconizeEvent()

void PCB_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 131 of file pcb_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 EDA_DRAW_FRAME::HardRedraw ( )
virtualinherited

Rebuild the GAL and redraws the screen.

Call when something went wrong.

Reimplemented in FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, SCH_BASE_FRAME, SCH_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 1036 of file eda_draw_frame.cpp.

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

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

◆ HideSolderMask()

◆ HighlightSelectionFilter()

void PCB_BASE_EDIT_FRAME::HighlightSelectionFilter ( const PCB_SELECTION_FILTER_OPTIONS & aOptions)
inherited

Definition at line 412 of file pcb_base_edit_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...

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

◆ initParameterGrid()

void FOOTPRINT_WIZARD_FRAME::initParameterGrid ( )
private

Prepare the grid where parameters are displayed.

Definition at line 320 of file footprint_wizard_frame.cpp.

References _, m_parameterGrid, m_parameterGridPage, OnGridSize(), WIZ_COL_NAME, WIZ_COL_UNITS, and WIZ_COL_VALUE.

◆ 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 EDA_BASE_FRAME::IsContentModified ( ) const
virtualinherited

Get if the contents of the frame have been modified since the last save.

Returns
true if the contents of the frame have not been saved

Reimplemented in CVPCB_MAINFRAME, FOOTPRINT_EDIT_FRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, SCH_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 1584 of file eda_base_frame.cpp.

Referenced by GERBVIEW_FRAME::Clear_DrawLayers(), EDITOR_CONDITIONS::contentModifiedFunc(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), and SCH_BASE_FRAME::OnSymChangeDebounceTimer().

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

virtual bool EDA_DRAW_FRAME::IsLibraryTreeShown ( ) const
inlinevirtualinherited

Reimplemented in FOOTPRINT_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 418 of file eda_draw_frame.h.

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

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

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS & aEvent)
virtualinherited

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

Reimplemented in CVPCB_MAINFRAME, FOOTPRINT_CHOOSER_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, PCB_EDIT_FRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 89 of file kiway_player.cpp.

Referenced by kiway_express(), and KIWAY::ProcessEvent().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent & event)
protectedinherited

An event handler called on a language menu selection.

Definition at line 186 of file kiway_player.cpp.

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

◆ 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

◆ LoadFootprint()

FOOTPRINT * PCB_BASE_FRAME::LoadFootprint ( const LIB_ID & aFootprintId)
inherited

Attempt to load aFootprintId from the footprint library table.

Parameters
aFootprintIdis the LIB_ID of component footprint to load.
Returns
the FOOTPRINT if found or NULL if aFootprintId not found in any of the libraries in table returned from Prj().PcbFootprintLibs().

Definition at line 225 of file load_select_footprint.cpp.

References loadFootprint().

Referenced by FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary().

◆ loadFootprint()

FOOTPRINT * PCB_BASE_FRAME::loadFootprint ( const LIB_ID & aFootprintId)
protectedinherited

Attempt to load aFootprintId from the footprint library table.

Parameters
aFootprintIdis the LIB_ID of component footprint to load.
Returns
the FOOTPRINT if found or NULL if aFootprintId not found in any of the libraries in the table returned from Prj().PcbFootprintLibs().
Exceptions
IO_ERRORif an I/O error occurs or a PARSE_ERROR if a file parsing error occurs while reading footprint library files.

Definition at line 241 of file load_select_footprint.cpp.

References FOOTPRINT::ApplyDefaultSettings(), FOOTPRINT::ClearAllNets(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), FRAME_FOOTPRINT_EDITOR, EDA_BASE_FRAME::IsType(), m_pcb, BOARD_DESIGN_SETTINGS::m_StyleFPFields, BOARD_DESIGN_SETTINGS::m_StyleFPShapes, BOARD_DESIGN_SETTINGS::m_StyleFPText, PROJECT_PCB::PcbFootprintLibs(), and KIWAY_HOLDER::Prj().

Referenced by LoadFootprint(), PCB_EDIT_FRAME::LoadFootprints(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), and SelectFootprintFromLibrary().

◆ LoadSettings()

void FOOTPRINT_WIZARD_FRAME::LoadSettings ( APP_SETTINGS_BASE * aCfg)
overrideprivatevirtual

Load common frame parameters from a configuration file.

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 504 of file footprint_wizard_frame.cpp.

References PCB_BASE_FRAME::LoadSettings(), m_auiPerspective, PCBNEW_SETTINGS::m_FootprintViewer, and WINDOW_SETTINGS::perspective.

◆ 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 > EDA_DRAW_FRAME::MakeGridHelper ( )
virtualinherited

Reimplemented in FOOTPRINT_EDIT_FRAME, PCB_EDIT_FRAME, SCH_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 576 of file eda_draw_frame.cpp.

◆ MessageTextFromCoord()

wxString PCB_BASE_FRAME::MessageTextFromCoord ( int aValue,
ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType ) const
inlineinherited

Definition at line 149 of file pcb_base_frame.h.

References m_originTransforms, and UNITS_PROVIDER::MessageTextFromValue().

◆ 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 FOOTPRINT_WIZARD_FRAME::OnActivate ( wxActivateEvent & event)
private

Called when the frame frame is activate to reload the libraries and component lists that can be changed by the schematic editor or the library editor.

Definition at line 536 of file footprint_wizard_frame.cpp.

References DisplayWizardInfos(), ID_FOOTPRINT_WIZARD_SELECT_WIZARD, m_wizardListShown, and ReCreatePageList().

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

◆ onDarkModeToggle()

void PCB_BASE_EDIT_FRAME::onDarkModeToggle ( )
protectedvirtualinherited

◆ OnDisplayOptionsChanged()

virtual void PCB_BASE_FRAME::OnDisplayOptionsChanged ( )
inlinevirtualinherited

Reimplemented in FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 354 of file pcb_base_frame.h.

Referenced by SetDisplayOptions().

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

◆ OnEditItemRequest()

virtual void PCB_BASE_EDIT_FRAME::OnEditItemRequest ( BOARD_ITEM * aItem)
inlinevirtualinherited

Install the corresponding dialog editor for the given item.

Parameters
aDCthe current device context.
aItema pointer to the BOARD_ITEM to edit.

Reimplemented in FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 103 of file pcb_base_edit_frame.h.

Referenced by EDIT_TOOL::Properties().

◆ OnFPChange()

void PCB_BASE_FRAME::OnFPChange ( wxFileSystemWatcherEvent & aEvent)
inherited

Handler for FP change events.

Responds to the filesystem watcher set in setFPWatcher.

Definition at line 1175 of file pcb_base_frame.cpp.

References m_watcherDebounceTimer, and m_watcherFileName.

Referenced by setFPWatcher().

◆ OnFpChangeDebounceTimer()

◆ OnGridSize()

void FOOTPRINT_WIZARD_FRAME::OnGridSize ( wxSizeEvent & aSizeEvent)
private

Definition at line 267 of file footprint_wizard_frame.cpp.

References ResizeParamColumns().

Referenced by initParameterGrid().

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

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

◆ OnSashDrag()

void FOOTPRINT_WIZARD_FRAME::OnSashDrag ( wxSashEvent & event)
private

Resize the child windows when dragging a sash window border.

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

◆ 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 FOOTPRINT_WIZARD_FRAME::OnSize ( wxSizeEvent & event)
overrideprivatevirtual

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 276 of file footprint_wizard_frame.cpp.

References EDA_BASE_FRAME::m_auimgr.

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

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

◆ 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

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

◆ ParametersUpdated()

void FOOTPRINT_WIZARD_FRAME::ParametersUpdated ( wxGridEvent & event)
private

◆ PlaceFootprint()

void PCB_BASE_FRAME::PlaceFootprint ( FOOTPRINT * aFootprint,
bool aRecreateRatsnest = true )
inherited

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

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

◆ PutDataInPreviousState()

void PCB_BASE_EDIT_FRAME::PutDataInPreviousState ( PICKED_ITEMS_LIST * aList)
inherited

Used in undo or redo command.

Put data pointed by List in the previous state, i.e. the state memorized by aList.

Parameters
aLista PICKED_ITEMS_LIST pointer to the list of items to undo/redo.

Definition at line 262 of file undo_redo.cpp.

References _, BOARD_ITEM_CONTAINER::Add(), KIGFX::PCB_VIEW::Add(), B_Mask, BOARD::BuildConnectivity(), BULK, BULK_APPEND, CHANGED, EDA_ITEM::ClearFlags(), PCB_BASE_FRAME::Compile_Ratsnest(), DELETED, BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), DRILLORIGIN, F_Mask, FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetBoard(), EDA_ITEM::GetBoundingBox(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetComponentClassManager(), BOARD::GetConnectivity(), PICKED_ITEMS_LIST::GetCount(), ZONE::GetIsRuleArea(), PICKED_ITEMS_LIST::GetItemWrapper(), PCB_BASE_FRAME::GetModel(), BOARD_ITEM::GetParentFootprint(), PCB_BASE_FRAME::GetPcbNewSettings(), PICKED_ITEMS_LIST::GetPickedItem(), PICKED_ITEMS_LIST::GetPickedItemLink(), PICKED_ITEMS_LIST::GetPickedItemStatus(), EDA_ITEM::GetPosition(), TOOLS_HOLDER::GetToolManager(), PCB_DRAW_PANEL_GAL::GetView(), GRIDORIGIN, group, KIGFX::VIEW::Hide(), PCB_BASE_FRAME::HideSolderMask(), image, BOARD::IncrementTimeStamp(), FOOTPRINT::InvalidateComponentClassCache(), COMPONENT_CLASS_MANAGER::InvalidateComponentClasses(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), EDA_BASE_FRAME::IsType(), KI_FALLTHROUGH, PCBNEW_SETTINGS::m_Display, PCB_BASE_FRAME::m_pcb, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_ShowGlobalRatsnest, TOOLS_HOLDER::m_toolManager, EDA_ITEM::m_Uuid, NEWITEM, BOARD::OnItemsCompositeUpdate(), pad, PAGESETTINGS, PCB_ARC_T, PCB_FOOTPRINT_T, PCB_NETINFO_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, TOOL_MANAGER::PostAction(), PCB_SELECTION_TOOL::RebuildSelection(), PCB_ACTIONS::rehatchShapes, BOARD_ITEM_CONTAINER::Remove(), KIGFX::PCB_VIEW::Remove(), PICKED_ITEMS_LIST::RemovePicker(), BOARD::ResolveItem(), PCB_BASE_FRAME::ResolveItem(), DS_PROXY_UNDO_ITEM::Restore(), BOARD::SanitizeNetcodes(), EDA_ITEM::SetFlags(), PICKED_ITEMS_LIST::SetPickedItemStatus(), SHOW_WITH_VIA_ALWAYS, BOARD_ITEM::SwapItemData(), EDA_ITEM::Type(), KIGFX::PCB_VIEW::UpdateCollidingItems(), UR_TRANSIENT, WS_PROXY_UNDO_ITEM_PLUS_T, and WS_PROXY_UNDO_ITEM_T.

Referenced by RestoreCopyFromRedoList(), RestoreCopyFromUndoList(), and RollbackFromUndo().

◆ PythonPluginsReload()

void FOOTPRINT_WIZARD_FRAME::PythonPluginsReload ( )

Reload the Python plugins if they are newer than the already loaded, and load new plugins if any.

Definition at line 577 of file footprint_wizard_frame.cpp.

References FRAME_PCB_EDITOR, TOOLS_HOLDER::GetToolManager(), Kiway, KIWAY::Player(), ACTIONS::pluginsReload, and TOOL_MANAGER::RunAction().

Referenced by DIALOG_FOOTPRINT_WIZARD_LIST::onUpdatePythonModulesClick().

◆ rebuildConnectivity()

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

◆ ReCreatePageList()

void FOOTPRINT_WIZARD_FRAME::ReCreatePageList ( )
private

◆ ReCreateParameterList()

◆ RecreateToolbars()

◆ ReCreateVToolbar()

virtual void EDA_DRAW_FRAME::ReCreateVToolbar ( )
inlinevirtualinherited

Definition at line 218 of file eda_draw_frame.h.

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

◆ RegenerateFootprint()

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

◆ ReloadFootprint()

virtual void PCB_BASE_FRAME::ReloadFootprint ( FOOTPRINT * aFootprint)
inlinevirtualinherited

Reload the footprint from the library.

Parameters
aFootprintis the footprint to reload.

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 199 of file pcb_base_frame.h.

Referenced by OnFpChangeDebounceTimer().

◆ RemoveBoardChangeListener()

void PCB_BASE_FRAME::RemoveBoardChangeListener ( wxEvtHandler * aListener)
inherited

Remove aListener to from the board changed listener list.

Definition at line 216 of file pcb_base_frame.cpp.

References m_boardChangeListeners.

◆ ResizeParamColumns()

void FOOTPRINT_WIZARD_FRAME::ResizeParamColumns ( )
private

Expand the 'Value' column to fill available.

Definition at line 471 of file footprint_wizard_frame.cpp.

References m_parameterGrid, WIZ_COL_NAME, WIZ_COL_UNITS, and WIZ_COL_VALUE.

Referenced by OnGridSize(), and ReCreateParameterList().

◆ resolveCanvasType()

void EDA_DRAW_FRAME::resolveCanvasType ( )
protectedvirtualinherited

◆ ResolveItem()

EDA_ITEM * PCB_BASE_FRAME::ResolveItem ( const KIID & aId,
bool aAllowNullptrReturn = false ) const
overridevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 251 of file pcb_base_frame.cpp.

References GetBoard(), and BOARD::ResolveItem().

Referenced by FocusOnItems(), PCB_EDIT_FRAME::OnCrossProbeFlashTimer(), OnFpChangeDebounceTimer(), and PCB_BASE_EDIT_FRAME::PutDataInPreviousState().

◆ RestoreCopyFromRedoList()

◆ RestoreCopyFromUndoList()

◆ RollbackFromUndo()

void PCB_BASE_EDIT_FRAME::RollbackFromUndo ( )
inherited

Perform an undo of the last edit without logging a corresponding redo.

Used to cancel an in-progress operation.

Definition at line 706 of file undo_redo.cpp.

References ClearListAndDeleteItems(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), PCB_BASE_FRAME::m_pcb, EDA_BASE_FRAME::PopCommandFromUndoList(), PutDataInPreviousState(), EDA_DRAW_PANEL_GAL::Refresh(), undo, and KIGFX::PCB_VIEW::Update().

◆ 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() [1/2]

void PCB_BASE_EDIT_FRAME::SaveCopyInUndoList ( const PICKED_ITEMS_LIST & aItemsList,
UNDO_REDO aCommandType )
overridevirtualinherited

Create a new entry in undo list of commands.

Add a list of pickers to handle a list of items.

Parameters
aItemsListthe list of items modified by the command to undo.
aCommandTypecommand type (see enum UNDO_REDO).

Reimplemented from PCB_BASE_FRAME.

Definition at line 173 of file undo_redo.cpp.

References PICKED_ITEMS_LIST::GetDescription(), saveCopyInUndoList(), and PICKED_ITEMS_LIST::SetDescription().

◆ SaveCopyInUndoList() [2/2]

void PCB_BASE_EDIT_FRAME::SaveCopyInUndoList ( EDA_ITEM * aItemToCopy,
UNDO_REDO aTypeCommand )
overridevirtualinherited

Create a new entry in undo list of commands.

Add a picker to handle aItemToCopy.

Parameters
aItemToCopythe board item modified by the command to undo.
aTypeCommandcommand type (see enum UNDO_REDO).

Reimplemented from PCB_BASE_FRAME.

Definition at line 163 of file undo_redo.cpp.

References PICKED_ITEMS_LIST::PushItem(), and saveCopyInUndoList().

Referenced by PCB_EDIT_FRAME::RunActionPlugin().

◆ saveCopyInUndoList()

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

void FOOTPRINT_WIZARD_FRAME::SaveSettings ( APP_SETTINGS_BASE * aCfg)
overrideprivatevirtual

Save common frame parameters to a configuration data file.

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 515 of file footprint_wizard_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, PCBNEW_SETTINGS::m_FootprintViewer, WINDOW_SETTINGS::perspective, and PCB_BASE_FRAME::SaveSettings().

Referenced by doCloseWindow().

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

◆ SelectCurrentWizard()

void FOOTPRINT_WIZARD_FRAME::SelectCurrentWizard ( wxCommandEvent & aDummy)

◆ SelectFootprintFromLibrary()

FOOTPRINT * PCB_BASE_FRAME::SelectFootprintFromLibrary ( LIB_ID aPreselect = LIB_ID())
inherited

Open a dialog to select a footprint.

Parameters
aPreslectif valid, the LIB_ID to select (otherwise the global history is used).

Definition at line 188 of file load_select_footprint.cpp.

References AddFootprintToHistory(), LIB_ID::Format(), FRAME_FOOTPRINT_CHOOSER, LIB_ID::IsValid(), Kiway, KIWAY_PLAYER::KIWAY_PLAYER(), loadFootprint(), LIB_ID::Parse(), and UTF8::wx_str().

◆ SelectFootprintWizard()

◆ SelectLibrary()

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

Put up a dialog and allows the user to pick a library, for unspecified use.

Parameters
aDialogTitletitle for the dialog window
aListLabellabel for 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 or wxEmptyString on abort.

Definition at line 419 of file footprint_libraries_utils.cpp.

References _, EDA_LIST_DIALOG::AddExtraCheckbox(), CreateNewLibrary(), EDA_LIST_DIALOG::GetExtraCheckboxValues(), PCB_BASE_FRAME::GetLibraryItemsForListDialog(), PROJECT::GetRString(), EDA_LIST_DIALOG::GetTextSelection(), ID_MAKE_NEW_LIBRARY, EDA_LIST_DIALOG_BASE::m_ButtonsSizer, PROJECT::PCB_LIB_NICKNAME, PROJECT::PCB_LIB_PATH, Prj(), EDA_LIST_DIALOG::SetListLabel(), PROJECT::SetRString(), and DIALOG_SHIM::ShowModal().

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary().

◆ SelectOneLayer()

PCB_LAYER_ID PCB_BASE_FRAME::SelectOneLayer ( PCB_LAYER_ID aDefaultLayer,
const LSET & aNotAllowedLayersMask = LSET(),
wxPoint aDlgPosition = wxDefaultPosition )
inherited

Show the dialog box for a layer selection.

Parameters
aDefaultLayeris the default layer to select. Use UNDEFINED_LAYER if no selection is desired.
aNotAllowedLayersMaskis a layer mask for not allowed layers. Use 0 to show all layers in use.
aDlgPositionis the position of dialog (default is centered).
Returns
the selected layer id.

Definition at line 301 of file sel_layer.cpp.

References PCB_ONE_LAYER_SELECTOR::GetLayerSelection(), DIALOG_SHIM::SetPosition(), DIALOG_SHIM::ShowModal(), ToLAYER_ID(), and UNDEFINED_LAYER.

◆ SelectWizardNextPage()

void FOOTPRINT_WIZARD_FRAME::SelectWizardNextPage ( )

◆ SelectWizardPreviousPage()

void FOOTPRINT_WIZARD_FRAME::SelectWizardPreviousPage ( )

◆ SetActiveLayer()

virtual void PCB_BASE_FRAME::SetActiveLayer ( PCB_LAYER_ID aLayer)
inlinevirtualinherited

◆ SetBoard()

◆ SetCanvas()

◆ SetDisplayOptions()

◆ SetDrawBgColor()

void PCB_BASE_FRAME::SetDrawBgColor ( const COLOR4D & aColor)
overridevirtualinherited

Reimplemented from EDA_DRAW_FRAME.

Definition at line 562 of file pcb_base_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, and EDA_DRAW_FRAME::m_drawBgColor.

◆ setFPWatcher()

◆ 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 PCB_BASE_FRAME::SetGridOrigin ( const VECTOR2I & aPoint)
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 511 of file pcb_base_frame.cpp.

References m_pcb.

◆ SetGridOverrides()

void EDA_DRAW_FRAME::SetGridOverrides ( bool aOverride)
virtualinherited

◆ SetGridVisibility()

void PCB_BASE_EDIT_FRAME::SetGridVisibility ( bool aVisible)
overridevirtualinherited

Override this function in the PCB_BASE_EDIT_FRAME to refill the layer widget.

Parameters
aVisibletrue if the grid must be shown.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 257 of file pcb_base_edit_frame.cpp.

References LAYER_GRID, m_appearancePanel, and EDA_DRAW_FRAME::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().

◆ SetObjectVisible()

void PCB_BASE_EDIT_FRAME::SetObjectVisible ( GAL_LAYER_ID aLayer,
bool aVisible = true )
inherited

Definition at line 267 of file pcb_base_edit_frame.cpp.

References m_appearancePanel.

◆ SetPageSettings()

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

◆ SetPlotSettings()

◆ SetScreen()

◆ SetShowPolarCoords()

void EDA_DRAW_FRAME::SetShowPolarCoords ( bool aShow)
inlineinherited

Definition at line 134 of file eda_draw_frame.h.

References m_polarCoords.

◆ SetTitleBlock()

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

Implements EDA_DRAW_FRAME.

Definition at line 550 of file pcb_base_frame.cpp.

References m_pcb.

◆ setupUIConditions()

◆ setupUnits()

◆ SetUserUnits()

◆ ShowChangedLanguage()

void PCB_BASE_FRAME::ShowChangedLanguage ( )
overridevirtualinherited

Redraw the menus and what not in current language.

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 656 of file pcb_base_frame.cpp.

References Get3DViewerFrame(), EDA_BASE_FRAME::RecreateToolbars(), EDA_3D_VIEWER_FRAME::ShowChangedLanguage(), and EDA_DRAW_FRAME::ShowChangedLanguage().

◆ ShowGraphicItemPropertiesDialog()

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

◆ ShowPadPropertiesDialog()

void PCB_BASE_FRAME::ShowPadPropertiesDialog ( PAD * aPad)
inherited

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

◆ ShowReferenceImagePropertiesDialog()

◆ ShowSolderMask()

void PCB_BASE_FRAME::ShowSolderMask ( )
inherited

◆ ShowTextBoxPropertiesDialog()

int PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog ( PCB_TEXTBOX * aTextBox)
inherited

◆ ShowTextPropertiesDialog()

void PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog ( PCB_TEXT * aText)
inherited

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

◆ SwitchCanvas()

◆ SwitchLayer()

void PCB_BASE_FRAME::SwitchLayer ( PCB_LAYER_ID aLayer)
virtualinherited

Change the active layer in the frame.

Parameters
aLayerNew layer to make active.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 703 of file pcb_base_frame.cpp.

References GetActiveLayer(), GetCanvas(), GetDisplayOptions(), IsCopperLayer(), m_pcb, NORMAL, EDA_DRAW_PANEL_GAL::Refresh(), and SetActiveLayer().

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

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

virtual void EDA_DRAW_FRAME::ToggleLibraryTree ( )
inlinevirtualinherited

Reimplemented in FOOTPRINT_EDIT_FRAME, PCB_EDIT_FRAME, SCH_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 419 of file eda_draw_frame.h.

◆ ToggleProperties()

◆ ToggleUserUnits()

void EDA_DRAW_FRAME::ToggleUserUnits ( )
overridevirtualinherited

◆ ToolStackIsEmpty()

bool TOOLS_HOLDER::ToolStackIsEmpty ( )
inlineinherited

◆ TryBefore()

bool PCB_BASE_EDIT_FRAME::TryBefore ( wxEvent & aEvent)
overrideinherited

◆ UndoRedoBlock()

void PCB_BASE_EDIT_FRAME::UndoRedoBlock ( bool aBlock = true)
inlineinherited

Enable/disable undo and redo operations.

Definition at line 171 of file pcb_base_edit_frame.h.

References m_undoRedoBlocked.

◆ UndoRedoBlocked()

bool PCB_BASE_EDIT_FRAME::UndoRedoBlocked ( ) const
inlineinherited

Check if the undo and redo operations are currently blocked.

Definition at line 163 of file pcb_base_edit_frame.h.

References m_undoRedoBlocked.

Referenced by RestoreCopyFromRedoList(), and RestoreCopyFromUndoList().

◆ unitsChangeRefresh()

void PCB_BASE_EDIT_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 PCB_BASE_FRAME.

Definition at line 242 of file pcb_base_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), TOOLS_HOLDER::m_toolManager, EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar(), EVENTS::SelectedItemsModified, PCB_BASE_FRAME::unitsChangeRefresh(), and EDA_DRAW_FRAME::UpdateProperties().

Referenced by PCB_EDIT_FRAME::OnBoardLoaded().

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

◆ Update3DView()

void FOOTPRINT_WIZARD_FRAME::Update3DView ( bool aMarkDirty,
bool aRefresh,
const wxString * aTitle = nullptr )
overrideprivatevirtual

Update the 3D view, if the viewer is opened by this frame.

Parameters
aMarkDirtyalerts the 3D view that data is stale (it may not refresh instantly)
aRefreshwill tell the 3D view to refresh immediately
aTitleis the new title of the 3D frame, or nullptr to do not change the frame title

Reimplemented from PCB_BASE_FRAME.

Definition at line 563 of file footprint_wizard_frame.cpp.

References _, m_wizardName, and PCB_BASE_FRAME::Update3DView().

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

◆ UpdateMsgPanel()

void FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel ( )
overrideprivatevirtual

Redraw the message panel.

Display the current footprint info, or clear the message panel if nothing is loaded.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 302 of file footprint_wizard_frame.cpp.

References EDA_DRAW_FRAME::ClearMsgPanel(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), EDA_ITEM::GetMsgPanelInfo(), and EDA_DRAW_FRAME::SetMsgPanel().

Referenced by updateView().

◆ UpdateProperties()

◆ UpdateStatusBar()

void PCB_BASE_FRAME::UpdateStatusBar ( )
overridevirtualinherited

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

◆ UpdateToolbarControlSizes()

void EDA_BASE_FRAME::UpdateToolbarControlSizes ( )
virtualinherited

◆ updateView()

void FOOTPRINT_WIZARD_FRAME::updateView ( )
private

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

wxString FOOTPRINT_WIZARD_FRAME::m_auiPerspective
private

Encoded string describing the AUI layout.

Definition at line 193 of file footprint_wizard_frame.h.

Referenced by LoadSettings().

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

std::vector<wxEvtHandler*> PCB_BASE_FRAME::m_boardChangeListeners
privateinherited

Definition at line 451 of file pcb_base_frame.h.

Referenced by AddBoardChangeListener(), RemoveBoardChangeListener(), and SetBoard().

◆ m_buildMessageBox

wxTextCtrl* FOOTPRINT_WIZARD_FRAME::m_buildMessageBox
private

Definition at line 191 of file footprint_wizard_frame.h.

Referenced by DisplayBuildMessage().

◆ m_canvas

◆ m_canvasType

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

bool PCB_BASE_EDIT_FRAME::m_darkMode
protectedinherited

Panel with Layers and Object Inspector tabs.

Definition at line 280 of file pcb_base_edit_frame.h.

Referenced by PCB_BASE_EDIT_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_displayOptions

◆ 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_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_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_inFpChangeTimerEvent

bool PCB_BASE_FRAME::m_inFpChangeTimerEvent
privateinherited

Definition at line 449 of file pcb_base_frame.h.

Referenced by OnFpChangeDebounceTimer(), and PCB_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_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_layerPairSettings

std::unique_ptr<LAYER_PAIR_SETTINGS> PCB_BASE_EDIT_FRAME::m_layerPairSettings
protectedinherited

Definition at line 274 of file pcb_base_edit_frame.h.

Referenced by GetLayerPairSettings(), and PCB_EDIT_FRAME::OnBoardLoaded().

◆ 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

PCB_ORIGIN_TRANSFORMS PCB_BASE_FRAME::m_originTransforms
protectedinherited

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

wxListBox* FOOTPRINT_WIZARD_FRAME::m_pageList
private

◆ m_parameterGrid

WX_GRID* FOOTPRINT_WIZARD_FRAME::m_parameterGrid
private

◆ m_parameterGridPage

int FOOTPRINT_WIZARD_FRAME::m_parameterGridPage
private

the page currently displayed by m_parameterGrid it is most of time the m_pageList selection, but can differ during transitions between pages.

Definition at line 188 of file footprint_wizard_frame.h.

Referenced by initParameterGrid(), ParametersUpdated(), and ReCreateParameterList().

◆ m_parametersPanel

wxPanel* FOOTPRINT_WIZARD_FRAME::m_parametersPanel
private

Panel for the page list and parameter grid.

Definition at line 185 of file footprint_wizard_frame.h.

◆ m_pcb

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

wxArrayString EDA_DRAW_FRAME::m_replaceStringHistoryList
protectedinherited

◆ m_searchPane

◆ m_selectionFilterPanel

◆ m_SelLayerBox

◆ 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_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_PCBNEW_PLUGIN> PCB_BASE_FRAME::m_spaceMouse
privateinherited

Definition at line 440 of file pcb_base_frame.h.

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

◆ m_supportsAutoSave

bool EDA_BASE_FRAME::m_supportsAutoSave
protectedinherited

◆ m_tabbedPanel

wxAuiNotebook* PCB_BASE_EDIT_FRAME::m_tabbedPanel
protectedinherited

Definition at line 278 of file pcb_base_edit_frame.h.

Referenced by PCB_BASE_EDIT_FRAME().

◆ 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_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_undoRedoBlocked

bool PCB_BASE_EDIT_FRAME::m_undoRedoBlocked
protectedinherited

Definition at line 270 of file pcb_base_edit_frame.h.

Referenced by PCB_BASE_EDIT_FRAME(), UndoRedoBlock(), and UndoRedoBlocked().

◆ 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_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> PCB_BASE_FRAME::m_watcher
privateinherited

Definition at line 445 of file pcb_base_frame.h.

Referenced by setFPWatcher().

◆ m_watcherDebounceTimer

wxTimer PCB_BASE_FRAME::m_watcherDebounceTimer
privateinherited

Definition at line 448 of file pcb_base_frame.h.

Referenced by OnFPChange(), OnFpChangeDebounceTimer(), and PCB_BASE_FRAME().

◆ m_watcherFileName

wxFileName PCB_BASE_FRAME::m_watcherFileName
privateinherited

Definition at line 446 of file pcb_base_frame.h.

Referenced by OnFPChange(), OnFpChangeDebounceTimer(), and setFPWatcher().

◆ m_watcherLastModified

wxDateTime PCB_BASE_FRAME::m_watcherLastModified
privateinherited

Definition at line 447 of file pcb_base_frame.h.

Referenced by OnFpChangeDebounceTimer(), and setFPWatcher().

◆ m_wizardDescription

wxString FOOTPRINT_WIZARD_FRAME::m_wizardDescription
protected

description of the wizard

Definition at line 181 of file footprint_wizard_frame.h.

Referenced by SelectFootprintWizard().

◆ m_wizardListShown

bool FOOTPRINT_WIZARD_FRAME::m_wizardListShown
private

A show-once flag for the wizard list.

Definition at line 195 of file footprint_wizard_frame.h.

Referenced by OnActivate().

◆ m_wizardName

wxString FOOTPRINT_WIZARD_FRAME::m_wizardName
protected

name of the current wizard

Definition at line 180 of file footprint_wizard_frame.h.

Referenced by DisplayWizardInfos(), GetBuiltFootprint(), GetMyWizard(), SelectFootprintWizard(), and Update3DView().

◆ m_wizardStatus

wxString FOOTPRINT_WIZARD_FRAME::m_wizardStatus
protected

current wizard status

Definition at line 182 of file footprint_wizard_frame.h.

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