KiCad PCB EDA Suite
FOOTPRINT_EDIT_FRAME Class Reference

#include <footprint_edit_frame.h>

Inheritance diagram for FOOTPRINT_EDIT_FRAME:
PCB_BASE_EDIT_FRAME PCB_BASE_FRAME EDA_DRAW_FRAME KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER

Public Types

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

Public Member Functions

 ~FOOTPRINT_EDIT_FRAME ()
 
BOARD_ITEM_CONTAINERGetModel () const override
 
SELECTIONGetCurrentSelection () override
 Get the current selection from the canvas area. More...
 
bool IsContentModified () const override
 Get if any footprints or libraries have been modified but not saved. More...
 
bool IsCurrentFPFromBoard () const
 
FOOTPRINT_EDITOR_SETTINGSGetSettings ()
 
APP_SETTINGS_BASEconfig () const override
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
BOARD_DESIGN_SETTINGSGetDesignSettings () const override
 Returns the BOARD_DESIGN_SETTINGS for the open project. More...
 
const PCB_PLOT_PARAMSGetPlotSettings () const override
 Return the PCB_PLOT_PARAMS for the BOARD owned by this frame. More...
 
void SetPlotSettings (const PCB_PLOT_PARAMS &aSettings) override
 
MAGNETIC_SETTINGSGetMagneticItemsSettings () override
 
void LoadSettings (APP_SETTINGS_BASE *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (APP_SETTINGS_BASE *aCfg) override
 Save common frame parameters to a configuration data file. More...
 
COLOR_SETTINGSGetColorSettings () const override
 Helper to retrieve the current color settings. More...
 
const BOX2I GetDocumentExtents (bool aIncludeAllVisible=true) const override
 Returns bbox of document with option to not include some items. More...
 
bool canCloseWindow (wxCloseEvent &Event) override
 
void doCloseWindow () override
 
void CloseFootprintEditor (wxCommandEvent &Event)
 
void OnExitKiCad (wxCommandEvent &aEvent)
 
void SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) override
 Switch the currently used canvas (Cairo / OpenGL). More...
 
void UpdateUserInterface ()
 Update the layer manager and other widgets from the board setup (layer and items visibility, colors ...). More...
 
void HardRedraw () override
 Refresh the library tree and redraw the window. More...
 
void ReCreateHToolbar () override
 Create the main horizontal toolbar for the footprint editor. More...
 
void ReCreateVToolbar () override
 
void ReCreateOptToolbar () override
 
void UpdateToolbarControlSizes () override
 Update the sizes of any controls in the toolbars of the frame. More...
 
void ReCreateMenuBar () override
 (Re)Create the menubar for the Footprint Editor frame More...
 
void ReCreateLayerBox (bool aForceResizeToolbar=true)
 Re create the layer Box by clearing the old list, and building a new one from the new layers names and layer colors. More...
 
void OnUpdateLayerSelectBox (wxUpdateUIEvent &aEvent)
 
void SelectLayer (wxCommandEvent &event)
 
void setupTools ()
 
void OnSaveFootprintAsPng (wxCommandEvent &event)
 
bool IsSearchTreeShown ()
 
void ToggleSearchTree ()
 
bool SaveLibraryAs (const wxString &aLibraryPath)
 Save a library to a new name and/or library type. More...
 
void OnUpdateLoadFootprintFromBoard (wxUpdateUIEvent &aEvent)
 
void OnUpdateSaveFootprintToBoard (wxUpdateUIEvent &aEvent)
 Install the corresponding dialog editor for the given item. More...
 
void OnEditItemRequest (BOARD_ITEM *aItem) override
 Install the corresponding dialog editor for the given item. More...
 
void LoadFootprintFromBoard (wxCommandEvent &event)
 Called from the main toolbar to load a footprint from board mainly to edit it. More...
 
void SaveFootprintToBoard (wxCommandEvent &event)
 
void LoadFootprintFromLibrary (LIB_ID aFPID)
 
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > & GetLibTreeAdapter ()
 Return the adapter object that provides the stored data. More...
 
bool SaveFootprint (FOOTPRINT *aFootprint)
 Save in an existing library a given footprint. More...
 
bool SaveFootprintAs (FOOTPRINT *aFootprint)
 
bool SaveFootprintToBoard (bool aAddNew)
 
bool SaveFootprintInLibrary (FOOTPRINT *aFootprint, const wxString &aLibraryName)
 
bool RevertFootprint ()
 
void OnModify () override
 Must be called after a footprint change in order to set the "modify" flag of the current screen and prepare, if needed the refresh of the 3D frame showing the footprint. More...
 
bool Clear_Pcb (bool aQuery)
 Delete all and reinitialize the current board. More...
 
LIB_ID GetTreeFPID () const
 Return the LIB_ID of the part or library selected in the footprint tree. More...
 
LIB_TREE_NODEGetCurrentTreeNode () const
 
LIB_ID GetLoadedFPID () const
 Return the LIB_ID of the part being edited. More...
 
LIB_ID GetTargetFPID () const
 Return the LIB_ID of the part selected in the footprint tree, or the loaded part if there is no selection in the tree. More...
 
void ClearModify ()
 
void ExportFootprint (FOOTPRINT *aFootprint)
 Create a file containing only one footprint. More...
 
FOOTPRINTImportFootprint (const wxString &aName=wxT(""))
 Read a file containing only one footprint. More...
 
bool LoadFootprintFromBoard (FOOTPRINT *aFootprint)
 Load a footprint from the main board into the Footprint Editor. More...
 
FOOTPRINTSelectFootprintFromBoard (BOARD *aPcb)
 Display the list of footprints currently existing on the BOARD. More...
 
bool DeleteFootprintFromLibrary (const LIB_ID &aFPID, bool aConfirm)
 Delete the given footprint from its library. More...
 
COLOR4D GetGridColor () override
 
void SetActiveLayer (PCB_LAYER_ID aLayer) override
 
void OnDisplayOptionsChanged () override
 
void ActivateGalCanvas () override
 Use to start up the GAL drawing canvas. More...
 
bool OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl=0) override
 Load a KiCad board (.kicad_pcb) from aFileName. More...
 
void AddFootprintToBoard (FOOTPRINT *aFootprint) override
 Override from PCB_BASE_EDIT_FRAME which adds a footprint to the editor's dummy board, NOT to the user's PCB. More...
 
void InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
 Allow footprint editor to install its preferences panel into the preferences dialog. More...
 
void ShowChangedLanguage () override
 Update visible items after a language change. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
 Called after the preferences dialog is run. More...
 
void SyncLibraryTree (bool aProgress)
 Synchronize the footprint library tree to the current state of the footprint library table. More...
 
void RegenerateLibraryTree ()
 Filter, sort, and redisplay the library tree. More...
 
void RefreshLibraryTree ()
 Redisplay the library tree. More...
 
void UpdateView ()
 
void UpdateTitle ()
 
void FocusOnLibID (const LIB_ID &aLibID)
 
void KiwayMailIn (KIWAY_EXPRESS &mail) override
 Receive KIWAY_EXPRESS messages from other players. More...
 
bool TryBefore (wxEvent &aEvent) override
 
wxString CreateNewLibrary (const wxString &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)
 If a library name is given, creates a new footprint library in the project folder with the given name. More...
 
wxString CreateNewProjectLibrary (const wxString &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)
 
bool AddLibrary (const wxString &aLibName=wxEmptyString, FP_LIB_TABLE *aTable=nullptr)
 Add an existing library to either the global or project library table. More...
 
void SaveCopyInUndoList (EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand) override
 Create a new entry in undo list of commands. More...
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aCommandType) override
 Create a new entry in undo list of commands. More...
 
void RestoreCopyFromRedoList (wxCommandEvent &aEvent)
 Redo the last edit: More...
 
void RestoreCopyFromUndoList (wxCommandEvent &aEvent)
 Undo the last edit: More...
 
void RollbackFromUndo ()
 Perform an undo of the last edit without logging a corresponding redo. More...
 
void PutDataInPreviousState (PICKED_ITEMS_LIST *aList)
 Used in undo or redo command. More...
 
bool UndoRedoBlocked () const
 Check if the undo and redo operations are currently blocked. More...
 
void UndoRedoBlock (bool aBlock=true)
 Enable/disable undo and redo operations. More...
 
void SetGridVisibility (bool aVisible) override
 Override this function in the PCB_BASE_EDIT_FRAME to refill the layer widget. More...
 
void SetObjectVisible (GAL_LAYER_ID aLayer, bool aVisible=true)
 
int GetRotationAngle () const
 Return the angle used for rotate operations. More...
 
void SetRotationAngle (int aRotationAngle)
 Set the angle used for rotate operations. More...
 
void ShowTextPropertiesDialog (BOARD_ITEM *aText)
 
void ShowGraphicItemPropertiesDialog (BOARD_ITEM *aItem)
 
virtual void SetBoard (BOARD *aBoard) override
 Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD. More...
 
void ClearUndoORRedoList (UNDO_REDO_LIST whichList, int aItemCount=-1) override
 Free the undo or redo list from List element. More...
 
wxString GetDesignRulesPath ()
 Return the absolute path to the design rules file for the currently-loaded board. More...
 
APPEARANCE_CONTROLSGetAppearancePanel ()
 
virtual void OnLayerAlphaChanged ()
 Notify the frame that the layer Alpha is being changed. More...
 
EDA_3D_VIEWER_FRAMEGet3DViewerFrame ()
 
virtual void Update3DView (bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
 Update the 3D view, if the viewer is opened by this frame. More...
 
FOOTPRINTLoadFootprint (const LIB_ID &aFootprintId)
 Attempt to load aFootprintId from the footprint library table. More...
 
EDA_RECT GetBoardBoundingBox (bool aBoardEdgesOnly=false) const
 Calculate the bounding box containing all board items (or board edge segments). More...
 
virtual void SetPageSettings (const PAGE_INFO &aPageSettings) override
 
const PAGE_INFOGetPageSettings () const override
 
const wxSize GetPageSizeIU () const override
 Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view. More...
 
const wxPoint & GetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
const wxPoint & GetAuxOrigin () const
 
const wxPoint GetUserOrigin () const
 
ORIGIN_TRANSFORMSGetOriginTransforms () override
 Return a reference to the default ORIGIN_TRANSFORMS object. More...
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
PCBNEW_SETTINGSSettings ()
 
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). More...
 
void SetDisplayOptions (const PCB_DISPLAY_OPTIONS &aOptions, bool aRefresh=true)
 Updates the current display options from the given options struct. More...
 
const ZONE_SETTINGSGetZoneSettings () const
 
void SetZoneSettings (const ZONE_SETTINGS &aSettings)
 
BOARDGetBoard () const
 
EDA_ITEMGetItem (const KIID &aId) const override
 Fetch an item by KIID. More...
 
void FocusOnItem (BOARD_ITEM *aItem)
 
virtual void UpdateStatusBar () override
 Update the status bar information. More...
 
PCB_SCREENGetScreen () const override
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
EDA_3D_VIEWER_FRAMECreateAndShow3D_Frame ()
 Shows the 3D view frame. More...
 
GENERAL_COLLECTORS_GUIDE GetCollectorsGuide ()
 
wxString SelectLibrary (const wxString &aNicknameExisting)
 Put up a dialog and allows the user to pick a library, for unspecified use. More...
 
FOOTPRINTGetFootprintFromBoardByReference ()
 
FOOTPRINTCreateNewFootprint (const wxString &aFootprintName)
 Creates a new footprint, at position 0,0. More...
 
void PlaceFootprint (FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
 Places aFootprint at the current cursor position and updates footprint coordinates with the new position. More...
 
void ShowPadPropertiesDialog (PAD *aPad)
 
FOOTPRINTSelectFootprintFromLibTree (LIB_ID aPreselect=LIB_ID())
 Open a dialog to select a footprint. More...
 
wxString SelectFootprintFromLibBrowser ()
 Launch the footprint viewer to select the name of a footprint to load. More...
 
void Compile_Ratsnest (bool aDisplayStatus)
 Create the entire board ratsnest. More...
 
PCB_LAYER_ID SelectOneLayer (PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
 Show the dialog box for a layer selection. More...
 
virtual void SwitchLayer (wxDC *DC, PCB_LAYER_ID layer)
 
virtual PCB_LAYER_ID GetActiveLayer () const
 
SEVERITY GetSeverity (int aErrorCode) const override
 
PCBNEW_SETTINGSGetPcbNewSettings () const
 
FOOTPRINT_EDITOR_SETTINGSGetFootprintEditorSettings () const
 
void DisplayGridMsg () override
 Display the current grid pane on the status bar. More...
 
PCB_DRAW_PANEL_GALGetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame. More...
 
bool LockFile (const wxString &aFileName)
 Mark a schematic file as being in use. More...
 
void ReleaseFile ()
 Release the current file marked in use. More...
 
void ScriptingConsoleEnableDisable ()
 Toggles the scripting console visibility. More...
 
bool IsScriptingConsoleVisible ()
 Gets the current visibility of the scripting console window. More...
 
wxFindReplaceData & GetFindReplaceData ()
 
wxArrayString & GetFindHistoryList ()
 
bool GetShowPolarCoords () const
 For those frames that support polar coordinates. More...
 
void SetShowPolarCoords (bool aShow)
 
void ToggleUserUnits () override
 
void GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
 Get the pair or units in current use. More...
 
wxPoint GetNearestGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize location to aPosition. More...
 
wxPoint GetNearestHalfGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize / 2 location to aPosition. More...
 
virtual COLOR4D GetDrawBgColor () const
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
 
virtual wxString GetScreenDesc () const
 
void EraseMsgBox ()
 
virtual void ReCreateAuxiliaryToolbar ()
 
bool IsGridVisible () const
 
virtual void SetGridColor (const COLOR4D &aColor)
 
void OnSelectGrid (wxCommandEvent &event)
 Command event handler for selecting grid sizes. More...
 
void OnGridSettings (wxCommandEvent &event)
 
void UpdateGridSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.). More...
 
void OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
 Update the checked item in the grid combobox. More...
 
void UpdateZoomSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
 
void OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
 Update the checked item in the zoom combobox. More...
 
const wxString GetZoomLevelIndicator () const
 Return a human readable value for display in dialogs. More...
 
virtual void OnSelectZoom (wxCommandEvent &event)
 Set the zoom factor when selected by the zoom list box in the main tool bar. More...
 
virtual void OnSize (wxSizeEvent &event) override
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
void OnMove (wxMoveEvent &aEvent) override
 
virtual void Zoom_Automatique (bool aWarpPointer)
 Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...
 
void FocusOnLocation (const wxPoint &aPos)
 Useful to focus on a particular location, in find functions. More...
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g. More...
 
void PrintDrawingSheet (const RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
 Prints the drawing-sheet (frame and title block). More...
 
void DisplayToolMsg (const wxString &msg) override
 
virtual void OnPageSettingsChange ()
 Called when modifying the page settings. More...
 
void DisplayUnitsMsg ()
 Display current unit pane in the status bar. More...
 
void AppendMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
 Append a message to the message panel. More...
 
virtual void ClearMsgPanel ()
 Clear all messages from the message panel. More...
 
void SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
 Clear the message panel and populates it with the contents of aList. More...
 
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. More...
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. More...
 
virtual void PrintPage (const RENDER_SETTINGS *aSettings)
 Print the page pointed by current screen, set by the calling print function. More...
 
void SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)
 
wxWindow * GetToolCanvas () const override
 Canvas access. More...
 
KIGFX::GAL_DISPLAY_OPTIONSGetGalDisplayOptions ()
 Return a reference to the gal rendering options used by GAL for rendering. More...
 
void RefreshCanvas () override
 
void RecreateToolbars ()
 Rebuild all toolbars, and update the checked state of check tools. More...
 
virtual void ParseArgs (wxCmdLineParser &aParser)
 Handle command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=nullptr, wxWindow *aResultantFocusWindow=nullptr)
 Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...
 
bool Destroy () override
 Our version of Destroy() which is virtual from wxWidgets. More...
 
bool IsModal () const override
 Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame. More...
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
void CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242). More...
 
EDA_UNITS GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS aUnits)
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
SETTINGS_MANAGERGetSettingsManager () const
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
virtual void OnCharHook (wxKeyEvent &aKeyEvent)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
virtual void RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
 Register a UI update handler for the control with ID aID. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
 Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...
 
virtual void UnregisterUIUpdateHandler (int aID) override
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
FRAME_T GetFrameType () const
 
virtual const SEARCH_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program. More...
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 Displays the preferences and settings of all opened editors paged dialog. More...
 
void PrintMsg (const wxString &text)
 
void CreateInfoBar ()
 
void FinishAUIInitialization ()
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...
 
void ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...
 
void LoadWindowState (const wxString &aFileName)
 
virtual void LoadWindowState (const WINDOW_STATE &aState)
 Load frame state info from a configuration file. More...
 
void LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
 Load window settings from the given settings object. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Save window settings to the given settings object. More...
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Return a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 Get the configuration base name. More...
 
virtual void SaveProjectSettings ()
 Save changes to the project settings to the project (.pro) file. More...
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
 Fetches the file name from the file history list. More...
 
void ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
 Removes all files from the file history. More...
 
void UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
 Update the list of recently opened files. More...
 
FILE_HISTORYGetFileHistory ()
 Get the frame's main file history. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
virtual wxString GetCurrentFileName () const
 Get the full filename + path of the currently opened file in the frame. More...
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void ThemeChanged ()
 Process light/dark theme change. More...
 
virtual void ProjectChanged ()
 Notification event that the project has changed. More...
 
const wxString & GetAboutTitle () const
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
virtual void ClearUndoRedoList ()
 Clear the undo and redo list using ClearUndoORRedoList() More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Add a command to undo in the undo list. More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Add a command to redo in the redo list. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual int GetUndoCommandCount () const
 
virtual int GetRedoCommandCount () const
 
int GetMaxUndoItems () const
 
bool NonUserClose (bool aForce)
 
virtual void HandleSystemColorChange ()
 Update the UI in response to a change in the system colors. More...
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual void PushTool (const std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
bool GetDoImmediateActions () const
 Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...
 
MOUSE_DRAG_ACTION GetDragAction () const
 Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...
 
bool GetMoveWarpsCursor () const
 Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

static const wxChar * GetFootprintEditorFrameName ()
 
static void HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
 Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g. More...
 

Protected Member Functions

 FOOTPRINT_EDIT_FRAME (KIWAY *aKiway, wxWindow *aParent, EDA_DRAW_PANEL_GAL::GAL_TYPE aBackend)
 protected so only friend PCB::IFACE::CreateWindow() can act as sole factory. More...
 
void initLibraryTree ()
 Make sure the footprint info list is loaded (with a progress dialog) and then initialize the footprint library tree. More...
 
void restoreLastFootprint ()
 
void retainLastFootprint ()
 
void editFootprintProperties (FOOTPRINT *aFootprint)
 Run the Footprint Properties dialog and handle changes made in it. More...
 
void setupUIConditions () override
 Setup the UI conditions for the various actions and their controls in this frame. More...
 
FP_LIB_TABLEselectLibTable (bool aOptional=false)
 Prompts a user to select global or project library tables. More...
 
wxString createNewLibrary (const wxString &aLibName, const wxString &aProposedName, FP_LIB_TABLE *aTable)
 Create a new library in the given table (presumed to be either the global or project library table). More...
 
void handleActivateEvent (wxActivateEvent &aEvent) override
 Handle a window activation event. More...
 
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. More...
 
FOOTPRINTloadFootprint (const LIB_ID &aFootprintId)
 Attempts to load aFootprintId from the footprint library table. More...
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void setupUnits (APP_SETTINGS_BASE *aCfg)
 
void resolveCanvasType ()
 Determines the Canvas type to load (with prompt if required) and initializes m_canvasType. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
void onActivate (wxActivateEvent &aEvent)
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 An event handler called on a language menu selection. More...
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event. More...
 
virtual bool isAutoSaveRequired () const
 Return the auto save status of the application. More...
 
virtual bool doAutoSave ()
 This should be overridden by the derived class to handle the auto save feature. More...
 
void onSystemColorChange (wxSysColourChangedEvent &aEvent)
 
void initExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 
void ensureWindowIsOnScreen ()
 

Static Protected Member Functions

static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

PCB_LAYER_BOX_SELECTORm_selLayerBox
 
FOOTPRINT_EDITOR_SETTINGSm_editorSettings
 
int m_rotationAngle
 
bool m_undoRedoBlocked
 
PANEL_SELECTION_FILTERm_selectionFilterPanel
 
APPEARANCE_CONTROLSm_appearancePanel
 
BOARDm_pcb
 
PCB_DISPLAY_OPTIONS m_displayOptions
 
PCB_ORIGIN_TRANSFORMS m_originTransforms
 
PCBNEW_SETTINGSm_settings
 
wxSocketServer * m_socketServer
 
std::vector< wxSocketBase * > m_sockets
 interprocess communication More...
 
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
 
bool m_showPageLimits
 
COLOR4D m_gridColor
 
COLOR4D m_drawBgColor
 
int m_undoRedoCountMax
 
bool m_polarCoords
 
bool m_showBorderAndTitleBlock
 
long m_firstRunDialogSetting
 
wxChoice * m_gridSelectBox
 
wxChoice * m_zoomSelectBox
 
ACTION_TOOLBARm_mainToolBar
 
ACTION_TOOLBARm_auxiliaryToolBar
 
ACTION_TOOLBARm_drawToolBar
 
ACTION_TOOLBARm_optionsToolBar
 
wxFindReplaceData * m_findReplaceData
 
wxArrayString m_findStringHistoryList
 
wxArrayString m_replaceStringHistoryList
 
EDA_MSG_PANELm_messagePanel
 
int m_msgFrameHeight
 
COLOR_SETTINGSm_colorSettings
 The current canvas type. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
 
bool m_modal
 
WX_EVENT_LOOPm_modal_loop
 < Points to nested event_loop. NULL means not modal and dismissed. More...
 
wxWindow * m_modal_resultant_parent
 
wxString m_modal_string
 
bool m_modal_ret_val
 
FRAME_T m_ident
 
wxPoint m_framePos
 
wxSize m_frameSize
 
bool m_maximizeByDefault
 
int m_displayIndex
 
wxPoint m_normalFramePos
 
wxSize m_normalFrameSize
 
wxString m_aboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 Map containing the UI update handlers registered with wx for each action. More...
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 Set by the close window event handler after frames are asked if they can close. More...
 
bool m_isClosing
 Set by NonUserClose() to indicate that the user did not request the current close. More...
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
MOUSE_DRAG_ACTION m_dragAction
 
bool m_moveWarpsCursor
 

Static Protected Attributes

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

Private Attributes

FOOTPRINT_TREE_PANEm_treePane
 
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTERm_adapter
 
std::unique_ptr< FOOTPRINTm_revertModule
 
wxString m_footprintNameWhenLoaded
 
std::map< KIID, KIIDm_boardFootprintUuids
 

Friends

struct PCB::IFACE
 

Detailed Description

Definition at line 38 of file footprint_edit_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 39 of file kiway_holder.h.

◆ UNDO_REDO_LIST

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

Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 109 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ ~FOOTPRINT_EDIT_FRAME()

FOOTPRINT_EDIT_FRAME::~FOOTPRINT_EDIT_FRAME ( )

Definition at line 308 of file footprint_edit_frame.cpp.

309 {
310  // Shutdown all running tools
311  if( m_toolManager )
313 
314  // save the footprint in the PROJECT
316 
317  delete m_selectionFilterPanel;
318  delete m_appearancePanel;
319 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
APPEARANCE_CONTROLS * m_appearancePanel
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
PANEL_SELECTION_FILTER * m_selectionFilterPanel

References PCB_BASE_EDIT_FRAME::m_appearancePanel, PCB_BASE_EDIT_FRAME::m_selectionFilterPanel, TOOLS_HOLDER::m_toolManager, retainLastFootprint(), and TOOL_MANAGER::ShutdownAllTools().

◆ FOOTPRINT_EDIT_FRAME()

FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME ( KIWAY aKiway,
wxWindow *  aParent,
EDA_DRAW_PANEL_GAL::GAL_TYPE  aBackend 
)
protected

protected so only friend PCB::IFACE::CreateWindow() can act as sole factory.

Definition at line 111 of file footprint_edit_frame.cpp.

112  :
113  PCB_BASE_EDIT_FRAME( aKiway, aParent, FRAME_FOOTPRINT_EDITOR, wxEmptyString,
114  wxDefaultPosition, wxDefaultSize,
116 {
117  m_showBorderAndTitleBlock = false; // true to show the frame references
118  m_canvasType = aBackend;
119  m_aboutTitle = _( "KiCad Footprint Editor" );
120  m_selLayerBox = nullptr;
121  m_editorSettings = nullptr;
122 
123  // Give an icon
124  wxIcon icon;
125  wxIconBundle icon_bundle;
126 
127  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit ) );
128  icon_bundle.AddIcon( icon );
129  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_32 ) );
130  icon_bundle.AddIcon( icon );
131  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_16 ) );
132  icon_bundle.AddIcon( icon );
133 
134  SetIcons( icon_bundle );
135 
136  // Create GAL canvas
137  if( aBackend == EDA_DRAW_PANEL_GAL::GAL_TYPE_UNKNOWN )
139  else
140  m_canvasType = aBackend;
141 
142  PCB_DRAW_PANEL_GAL* drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
144  SetCanvas( drawPanel );
145  SetBoard( new BOARD() );
146 
147 
148  // This board will only be used to hold a footprint for editing
150 
151  // In Footprint Editor, the default net clearance is not known (it depends on the actual
152  // board). So we do not show the default clearance, by setting it to 0. The footprint or
153  // pad specific clearance will be shown.
155 
156  // Don't show the default board solder mask clearance in the footprint editor. Only the
157  // footprint or pad clearance setting should be shown if it is not 0.
159 
160  // restore the last footprint from the project, if any
162 
163  // Ensure all layers and items are visible:
164  // In footprint editor, some layers have no meaning or cannot be used, but we show all of
165  // them, at least to be able to edit a bad layer
167 
168  // However the "no net" mark on pads is useless, because there are no nets in footprint
169  // editor: make it non visible.
171 
173 
174  // In Footprint Editor, set the default paper size to A4 for plot/print
176  SetScreen( new PCB_SCREEN( GetPageSettings().GetSizeIU() ) );
177 
178  // Create the manager and dispatcher & route draw panel events to the dispatcher
179  setupTools();
181 
182  initLibraryTree();
183  m_treePane = new FOOTPRINT_TREE_PANE( this );
184 
185  ReCreateMenuBar();
189 
191  m_appearancePanel = new APPEARANCE_CONTROLS( this, GetCanvas(), true );
192 
193  // LoadSettings() *after* creating m_LayersManager, because LoadSettings() initialize
194  // parameters in m_LayersManager
195  // NOTE: KifaceSettings() will return PCBNEW_SETTINGS if we started from pcbnew
197 
198  // Must be set after calling LoadSettings() to be sure these parameters are not dependent
199  // on what is read in stored settings. Enable one internal layer, because footprints
200  // support keepout areas that can be on internal layers only (therefore on the first internal
201  // layer). This is needed to handle these keepout in internal layers only.
203  GetBoard()->SetEnabledLayers( GetBoard()->GetEnabledLayers().set( In1_Cu ) );
204  GetBoard()->SetVisibleLayers( GetBoard()->GetEnabledLayers() );
205  GetBoard()->SetLayerName( In1_Cu, _( "Inner layers" ) );
206 
208 
209  m_auimgr.SetManagedWindow( this );
210 
211  CreateInfoBar();
212 
213  unsigned int auiFlags = wxAUI_MGR_DEFAULT;
214 #if !defined( _WIN32 )
215  // Windows cannot redraw the UI fast enough during a live resize and may lead to all kinds
216  // of graphical glitches
217  auiFlags |= wxAUI_MGR_LIVE_RESIZE;
218 #endif
219  m_auimgr.SetFlags( auiFlags );
220 
221  // Rows; layers 4 - 6
222  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" )
223  .Top().Layer( 6 ) );
224  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" )
225  .Bottom().Layer( 6 ) );
226 
227  // Columns; layers 1 - 3
228  m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" )
229  .Left().Layer( 3 ) );
230  m_auimgr.AddPane( m_treePane, EDA_PANE().Palette().Name( "Footprints" )
231  .Left().Layer(2)
232  .Caption( _( "Libraries" ) )
233  .MinSize( 250, 400 ).Resizable() );
234 
235  m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" )
236  .Right().Layer(2) );
237 
238  m_auimgr.AddPane( m_appearancePanel, EDA_PANE().Name( "LayersManager" )
239  .Right().Layer( 3 )
240  .Caption( _( "Appearance" ) ).PaneBorder( false )
241  .MinSize( 180, -1 ).BestSize( 180, -1 ) );
242  m_auimgr.AddPane( m_selectionFilterPanel, EDA_PANE().Palette().Name( "SelectionFilter" )
243  .Right().Layer( 3 ).Position( 2 )
244  .Caption( _( "Selection Filter" ) ).PaneBorder( false )
245  .MinSize( 160, -1 ).BestSize( m_selectionFilterPanel->GetBestSize() ) );
246 
247  // Center
248  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" )
249  .Center() );
250 
251  // The selection filter doesn't need to grow in the vertical direction when docked
252  m_auimgr.GetPane( "SelectionFilter" ).dock_proportion = 0;
253 
255 
257 
258  if( m_editorSettings->m_LibWidth > 0 )
259  {
260  wxAuiPaneInfo& treePane = m_auimgr.GetPane( "Footprints" );
261 
262  // wxAUI hack: force width by setting MinSize() and then Fixed()
263  // thanks to ZenJu http://trac.wxwidgets.org/ticket/13180
264  treePane.MinSize( m_editorSettings->m_LibWidth, -1 );
265  treePane.Fixed();
266  m_auimgr.Update();
267 
268  // now make it resizable again
269  treePane.Resizable();
270  m_auimgr.Update();
271 
272  // Note: DO NOT call m_auimgr.Update() anywhere after this; it will nuke the size
273  // back to minimum.
274  treePane.MinSize( 250, -1 );
275  }
276 
277  // Apply saved visibility stuff at the end
281 
283  UpdateTitle();
284  setupUnits( GetSettings() );
285 
286  // Default shutdown reason until a file is loaded
287  KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Footprint changes are unsaved" ) );
288 
289  // Catch unhandled accelerator command characters that were no handled by the library tree
290  // panel.
292  Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
293 
294  // Ensure the window is on top
295  Raise();
296  Show( true );
297 
298  // Register a call to update the toolbar sizes. It can't be done immediately because
299  // it seems to require some sizes calculated that aren't yet (at least on GTK).
300  CallAfter( [&]()
301  {
302  // Ensure the controls on the toolbars all are correctly sized
304  } );
305 }
PCB_BASE_EDIT_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
void ReCreateHToolbar() override
Create the main horizontal toolbar for the footprint editor.
void SetElementVisibility(GAL_LAYER_ID aLayer, bool aNewState)
Change the visibility of an element category.
Definition: board.cpp:538
void ApplyLayerPreset(const wxString &aPresetName)
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void SetActiveLayer(PCB_LAYER_ID aLayer) override
APPEARANCE_CONTROLS * m_appearancePanel
ACTION_TOOLBAR * m_optionsToolBar
virtual void SetScreen(BASE_SCREEN *aScreen)
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
void initLibraryTree()
Make sure the footprint info list is loaded (with a progress dialog) and then initialize the footprin...
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
static TOOL_ACTION zoomFitScreen
Definition: actions.h:96
void SetCopperLayerCount(int aCount)
Definition: board.cpp:460
void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:143
FOOTPRINT_EDITOR_SETTINGS * m_editorSettings
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
Definition: board.cpp:515
wxAuiManager m_auimgr
ACTION_TOOLBAR * m_mainToolBar
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:589
not specified: a GAL engine must be set by the client
bool m_axesEnabled
Fullscreen crosshair or small cross.
void SetShutdownBlockReason(wxWindow *aWindow, const wxString &aReason)
Sets the block reason why the window/application is preventing OS shutdown.
Definition: gtk/app.cpp:83
void ReCreateMenuBar() override
(Re)Create the menubar for the Footprint Editor frame
void SetClearance(int aClearance)
Definition: netclass.h:125
void FinishAUIInitialization()
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of vis...
Definition: board.cpp:498
EDA_MSG_PANEL * m_messagePanel
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:53
bool m_showBorderAndTitleBlock
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.
bool SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)
Changes the name of the layer given by aLayer.
Definition: board.cpp:377
void UpdateToolbarControlSizes() override
Update the sizes of any controls in the toolbars of the frame.
#define _(s)
static const wxChar A4[]
Definition: page_info.h:63
#define KICAD_DEFAULT_DRAWFRAME_STYLE
Footprint Editor pane with footprint library tree.
void SetUserLayerPresets(std::vector< LAYER_PRESET > &aPresetList)
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
Specialization of the wxAuiPaneInfo class for KiCad panels.
PCB_LAYER_BOX_SELECTOR * m_selLayerBox
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:160
show a marker on pads with no nets
Definition: layer_ids.h:202
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting()
Returns the canvas type stored in the application settings.
PANEL_SELECTION_FILTER * m_selectionFilterPanel
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
virtual void SetBoard(BOARD *aBoard) override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
void setupUnits(APP_SETTINGS_BASE *aCfg)
std::vector< LAYER_PRESET > m_LayerPresets
NETCLASS * GetDefault() const
FOOTPRINT_TREE_PANE * m_treePane
const PAGE_INFO & GetPageSettings() const override
virtual void SetPageSettings(const PAGE_INFO &aPageSettings) override
FOOTPRINT_EDITOR_SETTINGS * GetSettings()
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
BOARD * GetBoard() const
void SetEnabledLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:486
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition: board.h:203
wxString m_aboutTitle
static const wxChar * GetFootprintEditorFrameName()
ACTION_TOOLBAR * m_drawToolBar

References _, PAGE_INFO::A4, PCAD2KICAD::Center, TOOL_DISPATCHER::DispatchWxEvent(), F_SilkS, FPHOLDER, EDA_DRAW_PANEL_GAL::GAL_TYPE_UNKNOWN, GetBoard(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), icon_modedit, icon_modedit_16, icon_modedit_32, In1_Cu, KiBitmap(), LAYER_NO_CONNECTS, PCAD2KICAD::Left, FOOTPRINT_EDITOR_SETTINGS::m_ActiveLayerPreset, FOOTPRINT_EDITOR_SETTINGS::m_LayerPresets, BOARD_DESIGN_SETTINGS::m_SolderMaskMargin, PCAD2KICAD::Right, BOARD::SetBoardUse(), NETCLASS::SetClearance(), BOARD::SetCopperLayerCount(), BOARD::SetElementVisibility(), BOARD::SetEnabledLayers(), BOARD::SetLayerName(), KIPLATFORM::APP::SetShutdownBlockReason(), BOARD::SetVisibleAlls(), BOARD::SetVisibleLayers(), and ACTIONS::zoomFitScreen.

Member Function Documentation

◆ ActivateGalCanvas()

void FOOTPRINT_EDIT_FRAME::ActivateGalCanvas ( )
overridevirtual

Use to start up the GAL drawing canvas.

Reimplemented from PCB_BASE_FRAME.

Definition at line 1108 of file footprint_edit_frame.cpp.

1109 {
1111 
1112  // Be sure the axis are enabled
1113  GetCanvas()->GetGAL()->SetAxesEnabled( true );
1114 
1115  UpdateView();
1116 
1117  // Ensure the m_Layers settings are using the canvas type:
1119 }
void ActivateGalCanvas() override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
void SetAxesEnabled(bool aAxesEnabled)
Enable drawing the axes.

References PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::SetAxesEnabled(), UpdateUserInterface(), and UpdateView().

◆ AddFootprintToBoard()

void FOOTPRINT_EDIT_FRAME::AddFootprintToBoard ( FOOTPRINT aFootprint)
overridevirtual

Override from PCB_BASE_EDIT_FRAME which adds a footprint to the editor's dummy board, NOT to the user's PCB.

Reimplemented from PCB_BASE_FRAME.

Definition at line 457 of file footprint_edit_frame.cpp.

458 {
459  m_revertModule.reset( (FOOTPRINT*) aFootprint->Clone() );
460 
462 
464  // Ensure item UUIDs are valide
465  // ("old" footprints can have null uuids that create issues in fp editor)
466  aFootprint->FixUuids();
467 
468  if( IsCurrentFPFromBoard() )
469  {
470  wxString msg;
471  msg.Printf( _( "Editing %s from board. Saving will update the board only." ),
472  aFootprint->GetReference() );
473 
476  GetInfoBar()->ShowMessage( msg, wxICON_INFORMATION );
477  }
478 
479  UpdateMsgPanel();
480 }
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: infobar.cpp:142
const UTF8 & GetLibItemName() const
Definition: lib_id.h:104
bool FixUuids()
Old footprints do not alway have a valid UUID (some can be set to null uuid) However null UUIDs,...
Definition: footprint.cpp:227
const wxString & GetReference() const
Definition: footprint.h:430
#define _(s)
const LIB_ID & GetFPID() const
Definition: footprint.h:194
std::unique_ptr< FOOTPRINT > m_revertModule
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:286
virtual void AddFootprintToBoard(FOOTPRINT *aFootprint)
Add the given footprint to the board.
WX_INFOBAR * GetInfoBar()
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: footprint.cpp:1230
virtual void UpdateMsgPanel()
Redraw the message panel.
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
Definition: infobar.cpp:276

References _, WX_INFOBAR::AddCloseButton(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT::Clone(), FOOTPRINT::FixUuids(), FOOTPRINT::GetFPID(), EDA_BASE_FRAME::GetInfoBar(), LIB_ID::GetLibItemName(), FOOTPRINT::GetReference(), IsCurrentFPFromBoard(), m_footprintNameWhenLoaded, m_revertModule, WX_INFOBAR::RemoveAllButtons(), WX_INFOBAR::ShowMessage(), and EDA_DRAW_FRAME::UpdateMsgPanel().

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), ImportFootprint(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), restoreLastFootprint(), and RevertFootprint().

◆ AddLibrary()

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

Add an existing library to either the global or project library table.

Parameters
aFileNamethe library to add; a file open dialog will be displayed if empty.
Returns
true if successfully added.

Definition at line 539 of file footprint_libraries_utils.cpp.

540 {
541  if( aTable == nullptr )
542  aTable = selectLibTable();
543 
544  if( aTable == nullptr )
545  return wxEmptyString;
546 
547  bool isGlobal = ( aTable == &GFootprintTable );
548 
549  wxFileName fn( aFilename );
550 
551  if( aFilename.IsEmpty() )
552  {
554  KiCadFootprintLibPathExtension, true, isGlobal,
556  {
557  return false;
558  }
559  }
560 
561  wxString libPath = fn.GetFullPath();
562  wxString libName = fn.GetName();
563 
564  if( libName.IsEmpty() )
565  return false;
566 
567  wxString type = IO_MGR::ShowType( IO_MGR::GuessPluginTypeFromLibPath( libPath ) );
568 
569  // try to use path normalized to an environmental variable or project path
570  wxString normalizedPath = NormalizePath( libPath, &Pgm().GetLocalEnvVariables(), &Prj() );
571 
572  if( normalizedPath.IsEmpty() )
573  normalizedPath = libPath;
574 
575  try
576  {
577  FP_LIB_TABLE_ROW* row = new FP_LIB_TABLE_ROW( libName, normalizedPath, type, wxEmptyString );
578  aTable->InsertRow( row );
579 
580  if( isGlobal )
582  else
583  Prj().PcbFootprintLibs()->Save( Prj().FootprintLibTblName() );
584  }
585  catch( const IO_ERROR& ioe )
586  {
587  DisplayError( this, ioe.What() );
588  return false;
589  }
590 
592 
593  if( editor )
594  {
595  LIB_ID libID( libName, wxEmptyString );
596  editor->SyncLibraryTree( true );
597  editor->FocusOnLibID( libID );
598  }
599 
600  auto viewer = (FOOTPRINT_VIEWER_FRAME*) Kiway().Player( FRAME_FOOTPRINT_VIEWER, false );
601 
602  if( viewer )
603  viewer->ReCreateLibraryList();
604 
605  return true;
606 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:271
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
FP_LIB_TABLE GFootprintTable
The global footprint library table.
Definition: cvpcb.cpp:134
Hold a record identifying a library accessed by the appropriate footprint library PLUGIN object in th...
Definition: fp_lib_table.h:40
bool InsertRow(LIB_TABLE_ROW *aRow, bool doReplace=false)
Adds aRow if it does not already exist or if doReplace is true.
bool LibraryFileBrowser(bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
Component library viewer main window.
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:382
static const wxString ShowType(PCB_FILE_T aFileType)
Return a brief name for a plugin given aFileType enum.
Definition: io_mgr.cpp:77
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath)
Return a plugin type given a footprint library's libPath.
Definition: io_mgr.cpp:124
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:283
wxString KiCadFootprintLibPathWildcard()
static wxString GetDefaultUserFootprintsPath()
Gets the default path we point users to create projects.
Definition: paths.cpp:108
FP_LIB_TABLE * selectLibTable(bool aOptional=false)
Prompts a user to select global or project library tables.
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
const std::string KiCadFootprintLibPathExtension
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalize a file path to an environmental variable, if possible.
Definition: env_paths.cpp:69
static wxString GetGlobalTableFileName()

References DisplayError(), editor, FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_VIEWER, PATHS::GetDefaultUserFootprintsPath(), FP_LIB_TABLE::GetGlobalTableFileName(), GFootprintTable, IO_MGR::GuessPluginTypeFromLibPath(), LIB_TABLE::InsertRow(), KiCadFootprintLibPathExtension, KiCadFootprintLibPathWildcard(), KIWAY_HOLDER::Kiway(), EDA_DRAW_FRAME::LibraryFileBrowser(), NormalizePath(), PROJECT::PcbFootprintLibs(), Pgm(), KIWAY::Player(), KIWAY_HOLDER::Prj(), LIB_TABLE::Save(), PCB_BASE_EDIT_FRAME::selectLibTable(), IO_MGR::ShowType(), and IO_ERROR::What().

Referenced by PCB_BASE_EDIT_FRAME::createNewLibrary().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 440 of file eda_base_frame.cpp.

441 {
442  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
443  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
444 
445  helpMenu->Add( ACTIONS::help );
446  helpMenu->Add( ACTIONS::gettingStarted );
447  helpMenu->Add( ACTIONS::listHotKeys );
448  helpMenu->Add( ACTIONS::getInvolved );
449  helpMenu->Add( ACTIONS::donate );
450  helpMenu->Add( ACTIONS::reportBug );
451 
452  helpMenu->AppendSeparator();
453  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
454 
455  // Trailing space keeps OSX from hijacking our menu (and disabling everything in it).
456  aMenuBar->Append( helpMenu, _( "&Help" ) + wxS( " " ) );
457 }
static TOOL_ACTION listHotKeys
Definition: actions.h:178
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
static TOOL_ACTION reportBug
Cursor control event types.
Definition: actions.h:181
static TOOL_ACTION donate
Definition: actions.h:179
#define _(s)
Handle actions that are shared between different applications.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
static TOOL_ACTION help
Definition: actions.h:177
static TOOL_ACTION getInvolved
Definition: actions.h:180
static TOOL_ACTION gettingStarted
Definition: actions.h:176

References _, about, ACTIONS::donate, ACTIONS::getInvolved, ACTIONS::gettingStarted, TOOL_MANAGER::GetTool(), ACTIONS::help, ACTIONS::listHotKeys, TOOLS_HOLDER::m_toolManager, and ACTIONS::reportBug.

Referenced by EDA_3D_VIEWER_FRAME::CreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

◆ 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 494 of file eda_draw_frame.cpp.

495 {
496  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
497  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
498 
499  aMenu.AddSeparator( 1000 );
500 
501  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
502  zoomMenu->SetTool( commonTools );
503  aToolMenu.AddSubMenu( zoomMenu );
504 
505  auto gridMenu = std::make_shared<GRID_MENU>( this );
506  gridMenu->SetTool( commonTools );
507  aToolMenu.AddSubMenu( gridMenu );
508 
509  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
510  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
511 }
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:46
Handles action that are shared between different applications.
Definition: common_tools.h:37
void AddSeparator(int aOrder=ANY_ORDER)
Add a separator to the menu.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158

References CONDITIONAL_MENU::AddSeparator(), TOOL_MENU::AddSubMenu(), TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::m_toolManager, and SELECTION_CONDITIONS::ShowAlways().

Referenced by ROUTER_TOOL::Init(), PL_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PCB_VIEWER_TOOLS::Init(), PL_SELECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), PCB_SELECTION_TOOL::Init(), and PICKER_TOOL::Init().

◆ 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 648 of file eda_draw_frame.cpp.

650 {
651  if( m_messagePanel )
652  m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
653 }
EDA_MSG_PANEL * m_messagePanel
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, int aPadding=6)
Append a message to the message panel.
Definition: msgpanel.cpp:94

References EDA_MSG_PANEL::AppendMessage(), and EDA_DRAW_FRAME::m_messagePanel.

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

◆ canCloseWindow()

bool FOOTPRINT_EDIT_FRAME::canCloseWindow ( wxCloseEvent &  Event)
overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 613 of file footprint_edit_frame.cpp.

614 {
615  if( IsContentModified() )
616  {
617  // Shutdown blocks must be determined and vetoed as early as possible
619  aEvent.GetId() == wxEVT_QUERY_END_SESSION )
620  {
621  aEvent.Veto();
622  return false;
623  }
624 
625  wxString footprintName = GetBoard()->GetFirstFootprint()->GetFPID().GetLibItemName();
626  wxString msg = _( "Save changes to '%s' before closing?" );
627 
628  if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
629  [&]() -> bool
630  {
631  return SaveFootprint( GetBoard()->GetFirstFootprint() );
632  } ) )
633  {
634  aEvent.Veto();
635  return false;
636  }
637  }
638 
639  return PCB_BASE_EDIT_FRAME::canCloseWindow( aEvent );
640 }
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:231
const UTF8 & GetLibItemName() const
Definition: lib_id.h:104
bool canCloseWindow(wxCloseEvent &aCloseEvent) override
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:317
#define _(s)
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: gtk/app.cpp:72
const LIB_ID & GetFPID() const
Definition: footprint.h:194
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
BOARD * GetBoard() const
bool IsContentModified() const override
Get if any footprints or libraries have been modified but not saved.
bool SaveFootprint(FOOTPRINT *aFootprint)
Save in an existing library a given footprint.

References _, PCB_BASE_FRAME::canCloseWindow(), Format(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), FOOTPRINT::GetFPID(), LIB_ID::GetLibItemName(), HandleUnsavedChanges(), IsContentModified(), SaveFootprint(), and KIPLATFORM::APP::SupportsShutdownBlockReason().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 1181 of file eda_base_frame.cpp.

1182 {
1183  SetUserUnits( aUnits );
1185 
1186  wxCommandEvent e( UNITS_CHANGED );
1187  ProcessEventLocally( e );
1188 }
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void SetUserUnits(EDA_UNITS aUnits)

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

Referenced by COMMON_TOOLS::SwitchUnits(), and COMMON_TOOLS::ToggleUnits().

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName &  aFileName)
inherited

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.

Definition at line 1069 of file eda_base_frame.cpp.

1070 {
1071  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
1072 
1073  wxFileName autoSaveFileName = aFileName;
1074 
1075  // Check for auto save file.
1076  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
1077 
1078  wxLogTrace( traceAutoSave,
1079  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
1080 
1081  if( !autoSaveFileName.FileExists() )
1082  return;
1083 
1084  wxString msg = wxString::Format( _(
1085  "Well this is potentially embarrassing!\n"
1086  "It appears that the last time you were editing the file\n"
1087  "\"%s\"\n"
1088  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
1089  aFileName.GetFullName()
1090  );
1091 
1092  int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
1093  this );
1094 
1095  // Make a backup of the current file, delete the file, and rename the auto save file to
1096  // the file name.
1097  if( response == wxYES )
1098  {
1099  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1100  {
1101  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1102  Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1103  }
1104  }
1105  else
1106  {
1107  wxLogTrace( traceAutoSave,
1108  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1109 
1110  // Remove the auto save file when using the previous file as is.
1111  wxRemoveFile( autoSaveFileName.GetFullPath() );
1112  }
1113 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static wxString GetAutoSaveFilePrefix()

References _, Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), Pgm(), and traceAutoSave.

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

◆ Clear_Pcb()

bool FOOTPRINT_EDIT_FRAME::Clear_Pcb ( bool  aQuery)

Delete all and reinitialize the current board.

Parameters
aQuery= true to prompt user for confirmation, false to initialize silently

Definition at line 97 of file initpcb.cpp.

98 {
99  if( GetBoard() == nullptr )
100  return false;
101 
102  bool is_last_fp_from_brd = IsCurrentFPFromBoard();
103 
104  if( aQuery && IsContentModified() )
105  {
106  wxSafeYield( this, true ); // Allow frame to come to front before showing warning.
107 
109  this, _( "The current footprint has been modified. Save changes?" ),
110  [&]() -> bool
111  {
112  return SaveFootprint( GetBoard()->Footprints().front() );
113  } ) )
114  {
115  return false;
116  }
117  }
118 
119  if( is_last_fp_from_brd )
120  m_boardFootprintUuids.clear();
121 
122  // Clear undo and redo lists because we want a full deletion
124  GetScreen()->SetContentModified( false );
125 
126  BOARD* board = new BOARD;
127 
130  SetBoard( board );
131 
132  // This board will only be used to hold a footprint for editing
134 
135  // clear filename, to avoid overwriting an old file
136  GetBoard()->SetFileName( wxEmptyString );
137 
139 
140  return true;
141 }
std::map< KIID, KIID > m_boardFootprintUuids
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:231
BOARD_DESIGN_SETTINGS & GetDesignSettings() const override
Returns the BOARD_DESIGN_SETTINGS for the open project.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:589
void InitDataPoints(const wxSize &aPageSizeInternalUnits)
Definition: base_screen.cpp:46
void SynchronizeNetsAndNetClasses()
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
Definition: board.cpp:1410
#define _(s)
void SetFileName(const wxString &aFileName)
Definition: board.h:226
void SetContentModified(bool aModified=true)
Definition: base_screen.h:59
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
virtual void SetBoard(BOARD *aBoard) override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
const wxSize GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
BOARD * GetBoard() const
bool IsContentModified() const override
Get if any footprints or libraries have been modified but not saved.
bool SaveFootprint(FOOTPRINT *aFootprint)
Save in an existing library a given footprint.
virtual void ClearUndoRedoList()
Clear the undo and redo list using ClearUndoORRedoList()
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition: board.h:203

References _, EDA_BASE_FRAME::ClearUndoRedoList(), FPHOLDER, PCB_BASE_FRAME::GetBoard(), GetDesignSettings(), BOARD::GetDesignSettings(), PCB_BASE_FRAME::GetPageSizeIU(), PCB_BASE_FRAME::GetScreen(), HandleUnsavedChanges(), BASE_SCREEN::InitDataPoints(), IsContentModified(), IsCurrentFPFromBoard(), m_boardFootprintUuids, SaveFootprint(), PCB_BASE_EDIT_FRAME::SetBoard(), BOARD::SetBoardUse(), BASE_SCREEN::SetContentModified(), BOARD::SetFileName(), and BOARD::SynchronizeNetsAndNetClasses().

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), doCloseWindow(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), and RevertFootprint().

◆ ClearFileHistory()

void EDA_BASE_FRAME::ClearFileHistory ( FILE_HISTORY aFileHistory = nullptr)
inherited

Removes all files from the file history.

Parameters
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used

Definition at line 956 of file eda_base_frame.cpp.

957 {
958  if( !aFileHistory )
959  aFileHistory = m_fileHistory;
960 
961  wxASSERT( aFileHistory );
962 
963  aFileHistory->ClearFileHistory();
964 
965  // Update the menubar to update the file history menu
966  if( GetMenuBar() )
967  {
968  ReCreateMenuBar();
969  GetMenuBar()->Refresh();
970  }
971 }
void ClearFileHistory()
Clear all entries from the file history.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), SCH_EDIT_FRAME::OnClearFileHistory(), GERBVIEW_FRAME::OnClearGbrFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), and GERBVIEW_FRAME::OnClearZipFileHistory().

◆ ClearModify()

void FOOTPRINT_EDIT_FRAME::ClearModify ( )

Definition at line 409 of file footprint_edit_frame.cpp.

410 {
411  if( GetBoard()->GetFirstFootprint() )
413 
414  GetScreen()->SetContentModified( false );
415 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:104
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:317
const LIB_ID & GetFPID() const
Definition: footprint.h:194
void SetContentModified(bool aModified=true)
Definition: base_screen.h:59
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), FOOTPRINT::GetFPID(), LIB_ID::GetLibItemName(), PCB_BASE_FRAME::GetScreen(), m_footprintNameWhenLoaded, and BASE_SCREEN::SetContentModified().

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDITOR_CONTROL::Save(), and FOOTPRINT_EDITOR_CONTROL::SaveAs().

◆ 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 553 of file undo_redo.cpp.

554 {
555  if( aItemCount == 0 )
556  return;
557 
558  UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
559  unsigned icnt = list.m_CommandsList.size();
560 
561  if( aItemCount > 0 )
562  icnt = aItemCount;
563 
564  for( unsigned ii = 0; ii < icnt; ii++ )
565  {
566  if( list.m_CommandsList.size() == 0 )
567  break;
568 
569  PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
570  list.m_CommandsList.erase( list.m_CommandsList.begin() );
571 
572  curr_cmd->ClearListAndDeleteItems();
573  delete curr_cmd; // Delete command
574  }
575 }
UNDO_REDO_CONTAINER m_undoList
A holder to handle a list of undo (or redo) commands.
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
A holder to handle information on schematic or board items.
UNDO_REDO_CONTAINER m_redoList
void ClearListAndDeleteItems()
Delete the list of pickers AND the data pointed by #m_PickedItem or #m_PickedItemLink according to th...

References PICKED_ITEMS_LIST::ClearListAndDeleteItems(), and UNDO_REDO_CONTAINER::m_CommandsList.

◆ ClearUndoRedoList()

void EDA_BASE_FRAME::ClearUndoRedoList ( )
virtualinherited

◆ CloseFootprintEditor()

void FOOTPRINT_EDIT_FRAME::CloseFootprintEditor ( wxCommandEvent &  Event)

Definition at line 674 of file footprint_edit_frame.cpp.

675 {
676  Close();
677 }

◆ CommonSettingsChanged()

void FOOTPRINT_EDIT_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged,
bool  aTextVarsChanged 
)
overridevirtual

Called after the preferences dialog is run.

Reimplemented from PCB_BASE_FRAME.

Definition at line 1122 of file footprint_edit_frame.cpp.

1123 {
1124  PCB_BASE_EDIT_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
1125 
1127  GetCanvas()->ForceRefresh();
1128 
1130 
1131  if( aEnvVarsChanged )
1132  SyncLibraryTree( true );
1133 
1134  Layout();
1135  SendSizeEvent();
1136 }
void ForceRefresh()
Force a redraw.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
void SyncLibraryTree(bool aProgress)
Synchronize the footprint library tree to the current state of the footprint library table.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition: view.cpp:775

References PCB_BASE_FRAME::CommonSettingsChanged(), EDA_DRAW_PANEL_GAL::ForceRefresh(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), SyncLibraryTree(), KIGFX::VIEW::UpdateAllLayersColor(), and UpdateUserInterface().

◆ 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
aDCis the current device context (can be NULL).
aDisplayStatusif true, display the computation results.

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

Parameters
aDC= the current device context (can be NULL)
aDisplayStatus: if true, display the computation results

Definition at line 40 of file ratsnest.cpp.

41 {
42  GetBoard()->GetConnectivity()->RecalculateRatsnest();
43 
44  if( aDisplayStatus )
45  SetMsgPanel( m_pcb );
46 }
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:344
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard(), BOARD::GetConnectivity(), PCB_BASE_FRAME::m_pcb, and EDA_DRAW_FRAME::SetMsgPanel().

Referenced by DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCB_EDIT_FRAME::ExportToGenCAD(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_CONTROL::Paste(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ config()

APP_SETTINGS_BASE * FOOTPRINT_EDIT_FRAME::config ( ) const
overridevirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 518 of file footprint_edit_frame.cpp.

519 {
521  : Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
522 }
FOOTPRINT_EDITOR_SETTINGS * m_editorSettings
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106

References m_editorSettings, and Pgm().

Referenced by setupTools().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited

Get the configuration base name.

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

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

Reimplemented from TOOLS_HOLDER.

Definition at line 358 of file eda_base_frame.h.

359  {
360  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
361  return baseCfgName;
362  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateAndShow3D_Frame()

EDA_3D_VIEWER_FRAME * PCB_BASE_FRAME::CreateAndShow3D_Frame ( )
inherited

Shows the 3D view frame.

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

Definition at line 435 of file pcb_base_frame.cpp.

436 {
437  EDA_3D_VIEWER_FRAME* draw3DFrame = Get3DViewerFrame();
438 
439  if( !draw3DFrame )
440  draw3DFrame = new EDA_3D_VIEWER_FRAME( &Kiway(), this, _( "3D Viewer" ) );
441 
442  // Raising the window does not show the window on Windows if iconized. This should work
443  // on any platform.
444  if( draw3DFrame->IsIconized() )
445  draw3DFrame->Iconize( false );
446 
447  draw3DFrame->Raise();
448  draw3DFrame->Show( true );
449 
450  // Raising the window does not set the focus on Linux. This should work on any platform.
451  if( wxWindow::FindFocus() != draw3DFrame )
452  draw3DFrame->SetFocus();
453 
454  // Allocate a slice of time to display the 3D frame
455  // a call to wxSafeYield() should be enough (and better), but on Linux we need
456  // to call wxYield()
457  // otherwise the activity messages are not displayed during the first board loading
458  wxYield();
459 
460  // Note, the caller is responsible to load/update the board 3D view.
461  // after frame creation the board is not automatically created.
462 
463  return draw3DFrame;
464 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
EDA_3D_VIEWER_FRAME * Get3DViewerFrame()
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
#define _(s)

References _, PCB_BASE_FRAME::Get3DViewerFrame(), and KIWAY_HOLDER::Kiway().

Referenced by PCB_VIEWER_TOOLS::Show3DViewer().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

Definition at line 821 of file eda_base_frame.cpp.

822 {
823 #if defined( __WXOSX_MAC__ )
825 #else
826  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
827 
828  m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
829 #endif
830 }
wxAuiManager m_auimgr
virtual wxWindow * GetToolCanvas() const =0
Canvas access.
Specialization of the wxAuiPaneInfo class for KiCad panels.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:73
WX_INFOBAR * m_infoBar

References TOOLS_HOLDER::GetToolCanvas(), EDA_BASE_FRAME::m_auimgr, and EDA_BASE_FRAME::m_infoBar.

◆ CreateNewFootprint()

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

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

Definition at line 1119 of file footprint_libraries_utils.cpp.

1120 {
1121  wxString footprintName = aFootprintName;
1122 
1123  // Ask for the new footprint name
1124  if( footprintName.IsEmpty() )
1125  {
1126  WX_TEXT_ENTRY_DIALOG dlg( this, _( "Enter footprint name:" ), _( "New Footprint" ),
1127  footprintName );
1128  dlg.SetTextValidator( FOOTPRINT_NAME_VALIDATOR( &footprintName ) );
1129 
1130  if( dlg.ShowModal() != wxID_OK )
1131  return nullptr; //Aborted by user
1132  }
1133 
1134  footprintName.Trim( true );
1135  footprintName.Trim( false );
1136 
1137  if( footprintName.IsEmpty() )
1138  {
1139  DisplayInfoMessage( this, _( "No footprint name defined." ) );
1140  return nullptr;
1141  }
1142 
1143  // Creates the new footprint and add it to the head of the linked list of footprints
1144  FOOTPRINT* footprint = new FOOTPRINT( GetBoard() );
1145 
1146  // Update parameters: timestamp ...
1147  footprint->SetLastEditTime();
1148 
1149  // Update its name in lib
1150  footprint->SetFPID( LIB_ID( wxEmptyString, footprintName ) );
1151 
1152  PCB_LAYER_ID txt_layer;
1153  wxPoint default_pos;
1155 
1156  footprint->Reference().SetText( settings.m_DefaultFPTextItems[0].m_Text );
1157  footprint->Reference().SetVisible( settings.m_DefaultFPTextItems[0].m_Visible );
1158  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[0].m_Layer;
1159  footprint->Reference().SetLayer( txt_layer );
1160  default_pos.y -= settings.GetTextSize( txt_layer ).y / 2;
1161  footprint->Reference().SetPosition( default_pos );
1162  default_pos.y += settings.GetTextSize( txt_layer ).y;
1163 
1164  footprint->Value().SetText( settings.m_DefaultFPTextItems[1].m_Text );
1165  footprint->Value().SetVisible( settings.m_DefaultFPTextItems[1].m_Visible );
1166  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[1].m_Layer;
1167  footprint->Value().SetLayer( txt_layer );
1168  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1169  footprint->Value().SetPosition( default_pos );
1170  default_pos.y += settings.GetTextSize( txt_layer ).y;
1171 
1172  for( size_t i = 2; i < settings.m_DefaultFPTextItems.size(); ++i )
1173  {
1174  FP_TEXT* textItem = new FP_TEXT( footprint );
1175  textItem->SetText( settings.m_DefaultFPTextItems[i].m_Text );
1176  textItem->SetVisible( settings.m_DefaultFPTextItems[i].m_Visible );
1177  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[i].m_Layer;
1178  textItem->SetLayer( txt_layer );
1179  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1180  textItem->SetPosition( default_pos );
1181  default_pos.y += settings.GetTextSize( txt_layer ).y;
1182  footprint->GraphicalItems().push_back( textItem );
1183  }
1184 
1185  if( footprint->GetReference().IsEmpty() )
1186  footprint->SetReference( footprintName );
1187 
1188  if( footprint->GetValue().IsEmpty() )
1189  footprint->SetValue( footprintName );
1190 
1191  footprint->RunOnChildren(
1192  [&] ( BOARD_ITEM* aChild )
1193  {
1194  if( aChild->Type() == PCB_FP_TEXT_T )
1195  {
1196  FP_TEXT* textItem = static_cast<FP_TEXT*>( aChild );
1197  PCB_LAYER_ID layer = textItem->GetLayer();
1198 
1199  textItem->SetTextThickness( settings.GetTextThickness( layer ) );
1200  textItem->SetTextSize( settings.GetTextSize( layer ) );
1201  textItem->SetItalic( settings.GetTextItalic( layer ) );
1202  textItem->SetKeepUpright( settings.GetTextUpright( layer ) );
1203  }
1204  } );
1205 
1206  SetMsgPanel( footprint );
1207  return footprint;
1208 }
void SetReference(const wxString &aReference)
Definition: footprint.h:439
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Returns the BOARD_DESIGN_SETTINGS for the open project.
std::vector< TEXT_ITEM_INFO > m_DefaultFPTextItems
class FP_TEXT, text in a footprint
Definition: typeinfo.h:92
virtual void SetPosition(const wxPoint &aPos) override
Definition: fp_text.h:93
const wxString & GetValue() const
Definition: footprint.h:452
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:192
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:80
void SetItalic(bool isItalic)
Definition: eda_text.h:179
A KICAD version of wxTextEntryDialog which supports the various improvements/work-arounds from DIALOG...
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:237
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
int GetTextThickness(PCB_LAYER_ID aLayer) const
Return the default text thickness from the layer class for the given layer.
FP_TEXT & Value()
read/write accessors:
Definition: footprint.h:466
bool GetTextUpright(PCB_LAYER_ID aLayer) const
This class provides a custom wxValidator object for limiting the allowable characters when defining f...
Definition: validators.h:63
FP_TEXT & Reference()
Definition: footprint.h:467
bool GetTextItalic(PCB_LAYER_ID aLayer) const
virtual void SetVisible(bool aVisible)
Definition: eda_text.h:185
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:114
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
const wxString & GetReference() const
Definition: footprint.h:430
#define _(s)
DRAWINGS & GraphicalItems()
Definition: footprint.h:171
void SetValue(const wxString &aValue)
Definition: footprint.h:460
void SetFPID(const LIB_ID &aFPID)
Definition: footprint.h:195
void SetKeepUpright(bool aKeepUpright)
Definition: fp_text.h:115
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:64
void SetLastEditTime(timestamp_t aTime)
Definition: footprint.h:334
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction) const
Invoke a function on all BOARD_ITEMs that belong to the footprint (pads, drawings,...
Definition: footprint.cpp:1236
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.h:159
BOARD * GetBoard() const
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:299
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:171
wxSize GetTextSize(PCB_LAYER_ID aLayer) const
Return the default text size from the layer class for the given layer.
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113
Container for design settings for a BOARD object.

References _, DisplayInfoMessage(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::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_FP_TEXT_T, FOOTPRINT::Reference(), FOOTPRINT::RunOnChildren(), FOOTPRINT::SetFPID(), EDA_TEXT::SetItalic(), FP_TEXT::SetKeepUpright(), FOOTPRINT::SetLastEditTime(), BOARD_ITEM::SetLayer(), EDA_DRAW_FRAME::SetMsgPanel(), FP_TEXT::SetPosition(), FOOTPRINT::SetReference(), EDA_TEXT::SetText(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), WX_TEXT_ENTRY_DIALOG::SetTextValidator(), FOOTPRINT::SetValue(), EDA_TEXT::SetVisible(), EDA_ITEM::Type(), and FOOTPRINT::Value().

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

◆ CreateNewLibrary()

wxString PCB_BASE_EDIT_FRAME::CreateNewLibrary ( const wxString &  aLibName = wxEmptyString,
const wxString &  aProposedName = 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
aProposedNameis 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 385 of file footprint_libraries_utils.cpp.

387 {
388  FP_LIB_TABLE* table = selectLibTable();
389 
390  return createNewLibrary( aLibName, aProposedName, table );
391 }
FP_LIB_TABLE * selectLibTable(bool aOptional=false)
Prompts a user to select global or project library tables.
wxString createNewLibrary(const wxString &aLibName, const wxString &aProposedName, FP_LIB_TABLE *aTable)
Create a new library in the given table (presumed to be either the global or project library table).

References PCB_BASE_EDIT_FRAME::createNewLibrary(), and PCB_BASE_EDIT_FRAME::selectLibTable().

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary().

◆ createNewLibrary()

wxString PCB_BASE_EDIT_FRAME::createNewLibrary ( const wxString &  aLibName,
const wxString &  aProposedName,
FP_LIB_TABLE aTable 
)
protectedinherited

Create a new library in the given table (presumed to be either the global or project library table).

Definition at line 394 of file footprint_libraries_utils.cpp.

397 {
398  // Kicad cannot write legacy format libraries, only .pretty new format because the legacy
399  // format cannot handle current features.
400  // The footprint library is actually a directory.
401 
402  if( aTable == nullptr )
403  return wxEmptyString;
404 
405  wxString initialPath = aProposedName.IsEmpty() ? Prj().GetProjectPath() : aProposedName;
406  wxFileName fn;
407  bool doAdd = false;
408  bool isGlobal = ( aTable == &GFootprintTable );
409 
410  if( aLibName.IsEmpty() )
411  {
412  fn = initialPath;
413 
415  KiCadFootprintLibPathExtension, false, isGlobal,
417  {
418  return wxEmptyString;
419  }
420 
421  doAdd = true;
422  }
423  else
424  {
425  fn = aLibName;
426 
427  if( !fn.IsAbsolute() )
428  {
429  fn.SetName( aLibName );
430  fn.MakeAbsolute( initialPath );
431  }
432 
433  // Enforce the .pretty extension:
434  fn.SetExt( KiCadFootprintLibPathExtension );
435  }
436 
437  // We can save fp libs only using IO_MGR::KICAD_SEXP format (.pretty libraries)
439  wxString libPath = fn.GetFullPath();
440 
441  try
442  {
443  PLUGIN::RELEASER pi( IO_MGR::PluginFind( piType ) );
444 
445  bool writable = false;
446  bool exists = false;
447 
448  try
449  {
450  writable = pi->IsFootprintLibWritable( libPath );
451  exists = true; // no exception was thrown, lib must exist.
452  }
453  catch( const IO_ERROR& )
454  {
455  // best efforts....
456  }
457 
458  if( exists )
459  {
460  if( !writable )
461  {
462  wxString msg = wxString::Format( _( "Library %s is read only." ), libPath );
463  ShowInfoBarError( msg );
464  return wxEmptyString;
465  }
466  else
467  {
468  wxString msg = wxString::Format( _( "Library %s already exists." ), libPath );
469  KIDIALOG dlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
470  dlg.SetOKLabel( _( "Overwrite" ) );
471  dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
472 
473  if( dlg.ShowModal() == wxID_CANCEL )
474  return wxEmptyString;
475 
476  pi->FootprintLibDelete( libPath );
477  }
478  }
479 
480  pi->FootprintLibCreate( libPath );
481  }
482  catch( const IO_ERROR& ioe )
483  {
484  DisplayError( this, ioe.What() );
485  return wxEmptyString;
486  }
487 
488  if( doAdd )
489  AddLibrary( libPath, aTable );
490 
491  return libPath;
492 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:271
FP_LIB_TABLE GFootprintTable
The global footprint library table.
Definition: cvpcb.cpp:134
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
Definition: confirm.h:45
bool LibraryFileBrowser(bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:122
Releases a PLUGIN in the context of a potential thrown exception through its destructor.
Definition: io_mgr.h:555
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 o...
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
#define _(s)
bool AddLibrary(const wxString &aLibName=wxEmptyString, FP_LIB_TABLE *aTable=nullptr)
Add an existing library to either the global or project library table.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
wxString KiCadFootprintLibPathWildcard()
static wxString GetDefaultUserFootprintsPath()
Gets the default path we point users to create projects.
Definition: paths.cpp:108
static PLUGIN * PluginFind(PCB_FILE_T aFileType)
Return a PLUGIN which the caller can use to import, export, save, or load design documents.
Definition: io_mgr.cpp:58
PCB_FILE_T
The set of file types that the IO_MGR knows about, and for which there has been a plugin written.
Definition: io_mgr.h:53
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
const std::string KiCadFootprintLibPathExtension
S-expression Pcbnew file format.
Definition: io_mgr.h:56

References _, PCB_BASE_EDIT_FRAME::AddLibrary(), DisplayError(), KIDIALOG::DoNotShowCheckbox(), Format(), PATHS::GetDefaultUserFootprintsPath(), PROJECT::GetProjectPath(), GFootprintTable, IO_MGR::KICAD_SEXP, KiCadFootprintLibPathExtension, KiCadFootprintLibPathWildcard(), EDA_DRAW_FRAME::LibraryFileBrowser(), IO_MGR::PluginFind(), KIWAY_HOLDER::Prj(), EDA_BASE_FRAME::ShowInfoBarError(), KIDIALOG::ShowModal(), and IO_ERROR::What().

Referenced by PCB_BASE_EDIT_FRAME::CreateNewLibrary(), and PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary().

◆ CreateNewProjectLibrary()

wxString PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary ( const wxString &  aLibName = wxEmptyString,
const wxString &  aProposedName = wxEmptyString 
)
inherited

Definition at line 378 of file footprint_libraries_utils.cpp.

380 {
381  return createNewLibrary( aLibName, aProposedName, Prj().PcbFootprintLibs() );
382 }
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
wxString createNewLibrary(const wxString &aLibName, const wxString &aProposedName, FP_LIB_TABLE *aTable)
Create a new library in the given table (presumed to be either the global or project library table).

References PCB_BASE_EDIT_FRAME::createNewLibrary(), and KIWAY_HOLDER::Prj().

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ CreateServer()

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

Definition at line 43 of file eda_dde.cpp.

44 {
45  wxIPV4address addr;
46 
47  // Set the port number
48  addr.Service( service );
49 
50  // Listen on localhost only if requested
51  if( local )
52  addr.Hostname( HOSTNAME );
53 
54  delete m_socketServer;
55  m_socketServer = new wxSocketServer( addr );
56 
57  m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
58  m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
59  m_socketServer->Notify( true );
60 }
static const wxString HOSTNAME(wxT("localhost"))
wxSocketServer * m_socketServer
Definition: kiway_player.h:218

References HOSTNAME(), ID_EDA_SOCKET_EVENT_SERV, and KIWAY_PLAYER::m_socketServer.

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

◆ CurrentToolName()

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

Definition at line 100 of file tools_holder.cpp.

101 {
102  if( m_toolStack.empty() )
103  return ACTIONS::selectionTool.GetName();
104  else
105  return m_toolStack.back();
106 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:164
static TOOL_ACTION selectionTool
Definition: actions.h:153

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

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

◆ DeleteFootprintFromLibrary()

bool FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary ( const LIB_ID aFPID,
bool  aConfirm 
)

Delete the given footprint from its library.

Definition at line 609 of file footprint_libraries_utils.cpp.

610 {
611  if( !aFPID.IsValid() )
612  return false;
613 
614  wxString nickname = aFPID.GetLibNickname();
615  wxString fpname = aFPID.GetLibItemName();
616 
617  // Legacy libraries are readable, but modifying legacy format is not allowed
618  // So prompt the user if he try to delete a footprint from a legacy lib
619  wxString libfullname = Prj().PcbFootprintLibs()->FindRow( nickname )->GetFullURI();
620 
621  if( IO_MGR::GuessPluginTypeFromLibPath( libfullname ) == IO_MGR::LEGACY )
622  {
624  return false;
625  }
626 
627  if( !Prj().PcbFootprintLibs()->IsFootprintLibWritable( nickname ) )
628  {
629  wxString msg = wxString::Format( _( "Library '%s' is read only." ), nickname );
630  ShowInfoBarError( msg );
631  return false;
632  }
633 
634  // Confirmation
635  wxString msg = wxString::Format( _( "Delete footprint '%s' from library '%s'?" ),
636  fpname.GetData(),
637  nickname.GetData() );
638 
639  if( aConfirm && !IsOK( this, msg ) )
640  return false;
641 
642  try
643  {
644  Prj().PcbFootprintLibs()->FootprintDelete( nickname, fpname );
645  }
646  catch( const IO_ERROR& ioe )
647  {
648  DisplayError( this, ioe.What() );
649  return false;
650  }
651 
652  msg.Printf( _( "Footprint '%s' deleted from library '%s'" ),
653  fpname.GetData(),
654  nickname.GetData() );
655 
656  SetStatusText( msg );
657 
658  return true;
659 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:271
const UTF8 & GetLibItemName() const
Definition: lib_id.h:104
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:159
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath)
Return a plugin type given a footprint library's libPath.
Definition: io_mgr.cpp:124
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
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 o...
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
#define _(s)
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:90
virtual FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:283
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
Legacy Pcbnew file formats prior to s-expression.
Definition: io_mgr.h:55
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an FP_LIB_TABLE_ROW if aNickName is found in this table or in any chained fall back table frag...
static const wxString INFO_LEGACY_LIB_WARN_DELETE(_("Modifying legacy libraries (.mod files) is not allowed\n" "Please save the current library under the new .pretty format\n" "and update your footprint lib table\n" "before deleting a footprint"))
void FootprintDelete(const wxString &aNickname, const wxString &aFootprintName)
Delete the aFootprintName from the library given by aNickname.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:299
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:315

References _, DisplayError(), DisplayInfoMessage(), FP_LIB_TABLE::FindRow(), FP_LIB_TABLE::FootprintDelete(), Format(), LIB_TABLE_ROW::GetFullURI(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), IO_MGR::GuessPluginTypeFromLibPath(), INFO_LEGACY_LIB_WARN_DELETE(), IsOK(), LIB_ID::IsValid(), IO_MGR::LEGACY, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), EDA_BASE_FRAME::ShowInfoBarError(), and IO_ERROR::What().

Referenced by SaveFootprint().

◆ Destroy()

◆ DismissModal()

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

Definition at line 166 of file kiway_player.cpp.

167 {
168  m_modal_ret_val = aRetVal;
169  m_modal_string = aResult;
170 
171  if( m_modal_loop )
172  {
173  m_modal_loop->Exit();
174  m_modal_loop = nullptr; // this marks it as dismissed.
175  }
176 
177  Show( false );
178 }
bool m_modal_ret_val
Definition: kiway_player.h:216
wxString m_modal_string
Definition: kiway_player.h:215
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:213

References KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_ret_val, and KIWAY_PLAYER::m_modal_string.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), and SYMBOL_VIEWER_FRAME::FinishModal().

◆ DisplayGridMsg()

void PCB_BASE_FRAME::DisplayGridMsg ( )
overridevirtualinherited

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 534 of file pcb_base_frame.cpp.

535 {
536  wxString line;
537 
538  line.Printf( "grid X %s Y %s",
539  MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x ),
540  MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().y ) );
541 
542  SetStatusText( line, 4 );
543 }
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:104
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

References PCB_BASE_FRAME::GetCanvas(), EDA_BASE_FRAME::m_userUnits, and MessageTextFromValue().

Referenced by PCB_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 514 of file eda_draw_frame.cpp.

515 {
516  SetStatusText( msg, 6 );
517 }

Referenced by EDIT_TOOL::Duplicate(), and PCB_CONTROL::Paste().

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane in the status bar.

Definition at line 532 of file eda_draw_frame.cpp.

533 {
534  wxString msg;
535 
536  switch( m_userUnits )
537  {
538  case EDA_UNITS::INCHES: msg = _( "inches" ); break;
539  case EDA_UNITS::MILS: msg = _( "mils" ); break;
540  case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
541  default: msg = _( "Units" ); break;
542  }
543 
544  SetStatusText( msg, 5 );
545 }
#define _(s)
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

References _, INCHES, EDA_BASE_FRAME::m_userUnits, MILLIMETRES, and MILS.

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

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

Returns
true if the auto save was successful otherwise false.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 323 of file eda_base_frame.cpp.

324 {
325  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
326 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void FOOTPRINT_EDIT_FRAME::doCloseWindow ( )
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 643 of file footprint_edit_frame.cpp.

644 {
645  // No more vetos
646  GetCanvas()->SetEventDispatcher( nullptr );
647  GetCanvas()->StopDrawing();
648 
649  // Do not show the layer manager during closing to avoid flicker
650  // on some platforms (Windows) that generate useless redraw of items in
651  // the Layer Manager
652  m_auimgr.GetPane( "LayersManager" ).Show( false );
653  m_auimgr.GetPane( "SelectionFilter" ).Show( false );
654 
655  Clear_Pcb( false );
656 
658 
659  if( mgr->IsProjectOpen() && wxFileName::IsDirWritable( Prj().GetProjectPath() ) )
660  {
661  GFootprintList.WriteCacheToFile( Prj().GetProjectPath() + "fp-info-cache" );
662  }
663 
664  mgr->FlushAndRelease( GetSettings() );
665 }
SETTINGS_MANAGER * GetSettingsManager() const
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
FOOTPRINT_LIST_IMPL GFootprintList
The global footprint info table.
Definition: cvpcb.cpp:140
wxAuiManager m_auimgr
bool Clear_Pcb(bool aQuery)
Delete all and reinitialize the current board.
Definition: initpcb.cpp:97
bool IsProjectOpen() const
Helper for checking if we have a project open TODO: This should be deprecated along with Prj() once w...
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
FOOTPRINT_EDITOR_SETTINGS * GetSettings()
void WriteCacheToFile(const wxString &aFilePath) override
void FlushAndRelease(JSON_SETTINGS *aSettings, bool aSave=true)
If the given settings object is registered, save it to disk and unregister it.
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.

References Clear_Pcb(), SETTINGS_MANAGER::FlushAndRelease(), PCB_BASE_FRAME::GetCanvas(), GetSettings(), EDA_BASE_FRAME::GetSettingsManager(), GFootprintList, SETTINGS_MANAGER::IsProjectOpen(), EDA_BASE_FRAME::m_auimgr, KIWAY_HOLDER::Prj(), EDA_DRAW_PANEL_GAL::SetEventDispatcher(), EDA_DRAW_PANEL_GAL::StopDrawing(), and FOOTPRINT_LIST_IMPL::WriteCacheToFile().

◆ editFootprintProperties()

void FOOTPRINT_EDIT_FRAME::editFootprintProperties ( FOOTPRINT aFootprint)
protected

Run the Footprint Properties dialog and handle changes made in it.

Definition at line 139 of file footprint_editor_utils.cpp.

140 {
141  LIB_ID oldFPID = aFootprint->GetFPID();
142 
143  DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR dialog( this, aFootprint );
144  dialog.ShowModal();
145 
146  // Update library tree
147  BASIC_FOOTPRINT_INFO footprintInfo( aFootprint );
148  wxDataViewItem treeItem = m_adapter->FindItem( oldFPID );
149 
150  if( treeItem.IsOk() ) // Can be not found in tree if the current footprint is imported
151  // from file therefore not yet in tree.
152  {
153  static_cast<LIB_TREE_NODE_LIB_ID*>( treeItem.GetID() )->Update( &footprintInfo );
155  }
156 
157  UpdateTitle(); // in case of a name change...
158 
159  UpdateMsgPanel();
160 }
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > m_adapter
const LIB_ID & GetFPID() const
Definition: footprint.h:194
void RefreshLibTree()
Refreshes the tree (mainly to update highlighting and asterisking)
Definition: lib_tree.cpp:234
LIB_TREE * GetLibTree() const
FOOTPRINT_TREE_PANE * m_treePane
virtual void UpdateMsgPanel()
Redraw the message panel.

References FOOTPRINT::GetFPID().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )
protectedinherited

Definition at line 637 of file eda_base_frame.cpp.

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

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 289 of file eda_draw_frame.cpp.

290 {
291  if( m_messagePanel )
293 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:198

References EDA_MSG_PANEL::EraseMsgBox(), and EDA_DRAW_FRAME::m_messagePanel.

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

virtual void KIWAY_PLAYER::ExecuteRemoteCommand ( const char *  cmdline)
inlinevirtualinherited

Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242).

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 196 of file kiway_player.h.

196 {}

Referenced by KIWAY_PLAYER::OnSockRequest().

◆ ExportFootprint()

void FOOTPRINT_EDIT_FRAME::ExportFootprint ( FOOTPRINT aFootprint)

Create a file containing only one footprint.

Definition at line 311 of file footprint_libraries_utils.cpp.

312 {
313  wxFileName fn;
315 
316  if( !aFootprint )
317  return;
318 
319  fn.SetName( aFootprint->GetFPID().GetLibItemName() );
320 
321  wxString wildcard = KiCadFootprintLibFileWildcard();
322 
323  fn.SetExt( KiCadFootprintFileExtension );
324 
325  if( !cfg->m_LastImportExportPath.empty() )
326  fn.SetPath( cfg->m_LastImportExportPath );
327  else
328  fn.SetPath( m_mruPath );
329 
330  wxFileDialog dlg( this, _( "Export Footprint" ), fn.GetPath(), fn.GetFullName(),
331  wildcard, wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
332 
333  if( dlg.ShowModal() == wxID_CANCEL )
334  return;
335 
336  fn = dlg.GetPath();
337  cfg->m_LastImportExportPath = fn.GetPath();
338 
339  try
340  {
341  // Export as *.kicad_pcb format, using a strategy which is specifically chosen
342  // as an example on how it could also be used to send it to the system clipboard.
343 
344  PCB_IO pcb_io( CTL_FOR_LIBRARY );
345 
346  /* This footprint should *already* be "normalized" in a way such that
347  orientation is zero, etc., since it came from the Footprint Editor.
348 
349  aFootprint->SetParent( 0 );
350  aFootprint->SetOrientation( 0 );
351  */
352 
353  pcb_io.Format( aFootprint );
354 
355  FILE* fp = wxFopen( dlg.GetPath(), wxT( "wt" ) );
356 
357  if( fp == nullptr )
358  {
359  wxMessageBox( wxString::Format( _( "Insufficient permissions to write file '%s'." ),
360  dlg.GetPath() ) );
361  return;
362  }
363 
364  fprintf( fp, "%s", pcb_io.GetStringOutput( false ).c_str() );
365  fclose( fp );
366  }
367  catch( const IO_ERROR& ioe )
368  {
369  DisplayError( this, ioe.What() );
370  return;
371  }
372 
373  wxString msg = wxString::Format( _( "Footprint exported to file '%s'." ), dlg.GetPath() );
374  DisplayInfoMessage( this, msg );
375 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:271
const UTF8 & GetLibItemName() const
Definition: lib_id.h:104
A PLUGIN derivation for saving and loading Pcbnew s-expression formatted files.
wxString m_mruPath
const std::string KiCadFootprintFileExtension
#define CTL_FOR_LIBRARY
Format output for a footprint library instead of clipboard or BOARD.
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
#define _(s)
const LIB_ID & GetFPID() const
Definition: footprint.h:194
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
FOOTPRINT_EDITOR_SETTINGS * GetSettings()
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:299
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
wxString KiCadFootprintLibFileWildcard()

References _, CTL_FOR_LIBRARY, DisplayError(), DisplayInfoMessage(), Format(), PCB_IO::Format(), FOOTPRINT::GetFPID(), LIB_ID::GetLibItemName(), GetSettings(), PCB_IO::GetStringOutput(), KiCadFootprintFileExtension, KiCadFootprintLibFileWildcard(), FOOTPRINT_EDITOR_SETTINGS::m_LastImportExportPath, EDA_BASE_FRAME::m_mruPath, and IO_ERROR::What().

Referenced by FOOTPRINT_EDITOR_CONTROL::ExportFootprint().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 833 of file eda_base_frame.cpp.

834 {
835 #if defined( __WXOSX_MAC__ )
836  m_auimgr.Update();
837 #else
838  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
839  // hiding it.
840  m_auimgr.Update();
841 
842  // We don't want the infobar displayed right away
843  m_auimgr.GetPane( "InfoBar" ).Hide();
844  m_auimgr.Update();
845 #endif
846 }
wxAuiManager m_auimgr

References EDA_BASE_FRAME::m_auimgr.

◆ FocusOnItem()

void PCB_BASE_FRAME::FocusOnItem ( BOARD_ITEM aItem)
inherited
Todo:
The Boost entropy exception does not exist prior to 1.67. Once the minimum Boost version is raise to 1.67 or greater, this version check can be removed.

Definition at line 203 of file pcb_base_frame.cpp.

204 {
205  static KIID lastBrightenedItemID( niluuid );
206 
207  BOARD_ITEM* lastItem = nullptr;
208 
211 #if BOOST_VERSION >= 106700
212  try
213  {
214  lastItem = GetBoard()->GetItem( lastBrightenedItemID );
215  }
216  catch( const boost::uuids::entropy_error& )
217  {
218  wxLogError( "A Boost UUID entropy exception was thrown in %s:%s.", __FILE__, __FUNCTION__ );
219  }
220 #else
221  lastItem = GetBoard()->GetItem( lastBrightenedItemID );
222 #endif
223 
224  if( lastItem && lastItem != aItem && lastItem != DELETED_BOARD_ITEM::GetInstance() )
225  {
226  lastItem->ClearBrightened();
227 
228  if( lastItem->Type() == PCB_FOOTPRINT_T )
229  {
230  static_cast<FOOTPRINT*>( lastItem )->RunOnChildren(
231  [&]( BOARD_ITEM* child )
232  {
233  child->ClearBrightened();
234  } );
235  }
236  else if( lastItem->Type() == PCB_GROUP_T )
237  {
238  static_cast<PCB_GROUP*>( lastItem )->RunOnChildren(
239  [&]( BOARD_ITEM* child )
240  {
241  child->ClearBrightened();
242  } );
243  }
244 
245  GetCanvas()->GetView()->Update( lastItem );
246  lastBrightenedItemID = niluuid;
247  GetCanvas()->Refresh();
248  }
249 
250  if( aItem && aItem != DELETED_BOARD_ITEM::GetInstance() )
251  {
252  aItem->SetBrightened();
253 
254  if( aItem->Type() == PCB_FOOTPRINT_T )
255  {
256  static_cast<FOOTPRINT*>( aItem )->RunOnChildren(
257  [&]( BOARD_ITEM* child )
258  {
259  child->SetBrightened();
260  });
261  }
262  else if( aItem->Type() == PCB_GROUP_T )
263  {
264  static_cast<PCB_GROUP*>( aItem )->RunOnChildren(
265  [&]( BOARD_ITEM* child )
266  {
267  child->SetBrightened();
268  });
269  }
270 
271  GetCanvas()->GetView()->Update( aItem );
272  lastBrightenedItemID = aItem->m_Uuid;
273  FocusOnLocation( aItem->GetFocusPosition() );
274  GetCanvas()->Refresh();
275  }
276 }
BOARD_ITEM * GetItem(const KIID &aID) const
Definition: board.cpp:868
KIID niluuid(0)
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:80
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:108
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual const wxPoint GetFocusPosition() const
Similar to GetPosition, but allows items to return their visual center rather than their anchor.
Definition: eda_item.h:259
void SetBrightened()
Definition: eda_item.h:130
void ClearBrightened()
Definition: eda_item.h:133
Definition: kiid.h:44
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: pcb_view.cpp:92
static DELETED_BOARD_ITEM * GetInstance()
Definition: board_item.h:388
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
class FOOTPRINT, a footprint
Definition: typeinfo.h:88
const KIID m_Uuid
Definition: eda_item.h:475
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
BOARD * GetBoard() const
void FocusOnLocation(const wxPoint &aPos)
Useful to focus on a particular location, in find functions.
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References EDA_ITEM::ClearBrightened(), EDA_DRAW_FRAME::FocusOnLocation(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), EDA_ITEM::GetFocusPosition(), DELETED_BOARD_ITEM::GetInstance(), BOARD::GetItem(), PCB_DRAW_PANEL_GAL::GetView(), EDA_ITEM::m_Uuid, niluuid, PCB_FOOTPRINT_T, PCB_GROUP_T, EDA_DRAW_PANEL_GAL::Refresh(), EDA_ITEM::SetBrightened(), EDA_ITEM::Type(), and KIGFX::PCB_VIEW::Update().

Referenced by PCB_SELECTION_TOOL::Main(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_GROUP_PROPERTIES::OnMemberSelected(), DIALOG_GROUP_PROPERTIES::OnRemoveMember(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_DRC::~DIALOG_DRC(), and DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES().

◆ FocusOnLibID()

void FOOTPRINT_EDIT_FRAME::FocusOnLibID ( const LIB_ID aLibID)

Definition at line 908 of file footprint_edit_frame.cpp.

909 {
910  m_treePane->GetLibTree()->SelectLibId( aLibID );
911 }
LIB_TREE * GetLibTree() const
FOOTPRINT_TREE_PANE * m_treePane
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition: lib_tree.cpp:193

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

Referenced by FOOTPRINT_EDITOR_CONTROL::PasteFootprint().

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const wxPoint &  aPos)
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 851 of file eda_draw_frame.cpp.

852 {
853  bool centerView = false;
854  BOX2D r = GetCanvas()->GetView()->GetViewport();
855 
856  // Center if we're off the current view, or within 10% of its edge
857  r.Inflate( - (int) r.GetWidth() / 10 );
858 
859  if( !r.Contains( aPos ) )
860  centerView = true;
861 
862  // Center if we're behind an obscuring dialog, or within 10% of its edge
863  wxWindow* dialog = findDialog( GetChildren() );
864 
865  if( dialog )
866  {
867  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
868  dialog->GetSize() );
869  dialogRect.Inflate( dialogRect.GetWidth() / 10 );
870 
871  if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
872  centerView = true;
873  }
874 
875  if( centerView )
876  {
877  // If a dialog partly obscures the window, then center on the uncovered area.
878  if( dialog )
879  {
880  BOX2D dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
881  dialog->GetSize() );
882  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
883  }
884  else
885  GetCanvas()->GetView()->SetCenter( aPos );
886  }
887 
889 }
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition: view.cpp:515
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:581
coord_type GetWidth() const
Definition: box2.h:180
bool Contains(const Vec &aPoint) const
Definition: box2.h:134
wxWindow * findDialog(wxWindowList &aList)
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Move the graphic crosshair cursor to the requested position expressed in world coordinates.
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:281

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

Referenced by PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindNext(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), and DIALOG_FIND::search().

◆ Get3DViewerFrame()

EDA_3D_VIEWER_FRAME * PCB_BASE_FRAME::Get3DViewerFrame ( )
inherited
Returns
a reference to the child 3D viewer frame, when exists, or NULL

Definition at line 98 of file pcb_base_frame.cpp.

99 {
100  wxWindow* frame = FindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( this ) );
101  return dynamic_cast<EDA_3D_VIEWER_FRAME*>( frame );
102 }
#define QUALIFIED_VIEWER3D_FRAMENAME(parent)

References QUALIFIED_VIEWER3D_FRAMENAME.

Referenced by PCB_BASE_FRAME::canCloseWindow(), PCB_BASE_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::Update3DView(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetActiveLayer()

virtual PCB_LAYER_ID PCB_BASE_FRAME::GetActiveLayer ( ) const
inlinevirtualinherited

Definition at line 355 of file pcb_base_frame.h.

355 { return GetScreen()->m_Active_Layer; }
PCB_LAYER_ID m_Active_Layer
Definition: pcb_screen.h:42
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.

References PCB_BASE_FRAME::GetScreen(), and PCB_SCREEN::m_Active_Layer.

Referenced by DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_BASE_FRAME::GetCollectorsGuide(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), PCB_CONTROL::LayerNext(), PCB_CONTROL::LayerPrev(), PCB_CONTROL::LayerToggle(), ROUTER_TOOL::MainLoop(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), APPEARANCE_CONTROLS::OnLayerAlphaChanged(), APPEARANCE_CONTROLS::OnLayerChanged(), APPEARANCE_CONTROLS::OnLayerContextMenu(), PCB_DRAW_PANEL_GAL::OnShow(), OnUpdateLayerSelectBox(), PCB_EDIT_FRAME::OnUpdateLayerSelectBox(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), DRAWING_TOOL::PlaceText(), PCB_EDIT_FRAME::SaveProjectSettings(), PCB_BASE_FRAME::SetDisplayOptions(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), and ROUTER_TOOL::switchLayerOnViaPlacement().

◆ GetAppearancePanel()

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )
inlinestaticprotectedinherited

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 204 of file eda_base_frame.h.

204 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetAuxOrigin()

const wxPoint & PCB_BASE_FRAME::GetAuxOrigin ( ) const
inherited

Definition at line 315 of file pcb_base_frame.cpp.

316 {
318 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:589
wxPoint m_AuxOrigin
origin for plot exports

References BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::m_AuxOrigin, and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_BASE_FRAME::GetUserOrigin().

◆ GetBoard()

BOARD* PCB_BASE_FRAME::GetBoard ( ) const
inlineinherited

Definition at line 206 of file pcb_base_frame.h.

207  {
208  wxASSERT( m_pcb );
209  return m_pcb;
210  }

References PCB_BASE_FRAME::m_pcb.

Referenced by PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), DIALOG_PLOT::applyPlotSettings(), GRID_CELL_LAYER_SELECTOR::BeginEdit(), DIALOG_BOARD_REANNOTATE::BuildFootprintList(), canCloseWindow(), FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), ClearModify(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), PCB_BASE_FRAME::Compile_Ratsnest(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), CreateHeaderInfoData(), CONVERT_TOOL::CreateLines(), PCB_BASE_FRAME::CreateNewFootprint(), ZONE_CREATE_HELPER::createNewZone(), DIALOG_PRINT_PCBNEW::createPrintout(), PANEL_FP_EDITOR_COLOR_SETTINGS::createSwatches(), PANEL_PCBNEW_COLOR_SETTINGS::createSwatches(), FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), PCB_CONTROL::DeleteItemCursor(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), APPEARANCE_CONTROLS::doApplyLayerPreset(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), PCB_EDIT_FRAME::DoGenFootprintsReport(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), ROUTER_TOOL::DpDimensionsDialog(), GRID_CELL_LAYER_RENDERER::Draw(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawSpecificationStackup(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Edit_Zone_Params(), DIALOG_COPPER_ZONE::ensureSelectedNetIsVisible(), VIA_SIZE_MENU::eventHandler(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_EDITOR_CONTROL::ExportFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), DIALOG_COPPER_ZONE::ExportSetupToOtherCopperZones(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_BASE_FRAME::FocusOnItem(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_EDIT_FRAME::GenD356File(), PCB_EDIT_FRAME::GenFootprintsReport(), GetBoard(), EDA_3D_VIEWER_FRAME::GetBoard(), VECTOR_DRC_ITEMS_PROVIDER::GetCount(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), GetDesignSettings(), GetDocumentExtents(), PCB_LAYER_BOX_SELECTOR::getEnabledLayers(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), PCB_BASE_FRAME::GetItem(), PCB_LAYER_SELECTOR::getLayerName(), PCB_LAYER_BOX_SELECTOR::getLayerName(), GetLoadedFPID(), GetModel(), FOOTPRINT_VIEWER_FRAME::GetModel(), FOOTPRINT_WIZARD_FRAME::GetModel(), DISPLAY_FOOTPRINTS_FRAME::GetModel(), PCB_BASE_FRAME::GetSeverity(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), GRID_CELL_LAYER_SELECTOR::GetValue(), APPEARANCE_CONTROLS::getVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), PCB_EDITOR_CONDITIONS::hasItemsFunc(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), ImportFootprint(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), EDIT_TOOL::Init(), DIALOG_PLOT::init_Dialog(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), ARRAY_CREATOR::Invoke(), IsContentModified(), IsCurrentFPFromBoard(), PCB_LAYER_SELECTOR::isLayerEnabled(), PCB_LAYER_BOX_SELECTOR::isLayerEnabled(), PCB_EDIT_FRAME::KiwayMailIn(), LoadFootprintFromBoard(), DIALOG_NETLIST::loadNetlist(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC::OnActivateDlg(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), DIALOG_NET_INSPECTOR::onBoardChanged(), APPEARANCE_CONTROLS::OnBoardChanged(), DIALOG_IMPORT_SETTINGS::OnBrowseClicked(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_EXPORT_STEP::onExportButton(), PCB_EDIT_FRAME::OnExportIDF3(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_EDIT_FRAME::OnExportVRML(), APPEARANCE_CONTROLS::OnLayerContextMenu(), PCB_BASE_FRAME::OnModify(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), PANEL_SETUP_RULES::onScintillaCharAdded(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), FOOTPRINT_VIEWER_FRAME::OnUpdateFootprintButton(), OnUpdateLoadFootprintFromBoard(), OnUpdateSaveFootprintToBoard(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), PANEL_SETUP_CONSTRAINTS::PANEL_SETUP_CONSTRAINTS(), PANEL_SETUP_LAYERS::PANEL_SETUP_LAYERS(), PANEL_SETUP_MASK_AND_PASTE::PANEL_SETUP_MASK_AND_PASTE(), PANEL_SETUP_TEXT_AND_GRAPHICS::PANEL_SETUP_TEXT_AND_GRAPHICS(), PANEL_SETUP_TRACKS_AND_VIAS::PANEL_SETUP_TRACKS_AND_VIAS(), PCB_CONTROL::Paste(), DIALOG_UPDATE_PCB::PerformUpdate(), DRAWING_TOOL::PlaceImportedGraphics(), DIALOG_PLOT::Plot(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingFootprints(), FOOTPRINT_EDITOR_CONTROL::Properties(), EDIT_TOOL::Properties(), DIALOG_COPPER_ZONE::readNetInformation(), BOARD_REANNOTATE_TOOL::ReannotateDuplicatesInSelection(), NET_GRID_TABLE::Rebuild(), APPEARANCE_CONTROLS::rebuildLayerContextMenu(), APPEARANCE_CONTROLS::rebuildLayers(), APPEARANCE_CONTROLS::rebuildNets(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), Refresh(), DIALOG_PLOT::reInitDialog(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TOOL::Reset(), PCB_EDIT_FRAME::RunActionPlugin(), DIALOG_FOOTPRINT_CHECKER::runChecks(), SaveFootprintToBoard(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), DIALOG_FIND::search(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectOneLayer(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), APPEARANCE_CONTROLS::SetObjectVisible(), DIALOG_PLOT::SetPlotFormat(), VECTOR_DRC_ITEMS_PROVIDER::SetSeverities(), ZONE_SETTINGS::SetupLayersList(), setupTools(), setupUIConditions(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), APPEARANCE_CONTROLS::showNetclass(), DIALOG_COPPER_ZONE::sortNetsByPadCount(), GLOBAL_EDIT_TOOL::SwapLayers(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataFromWindow(), DIALOG_UNUSED_PAD_LAYERS::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), PCB_CONTROL::UpdateMessagePanel(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), DRC_TOOL::updatePointers(), UpdateTitle(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), UpdateView(), DIALOG_DRC::writeReport(), and DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME().

◆ GetBoardBoundingBox()

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

393 {
394  EDA_RECT area = aBoardEdgesOnly ? m_pcb->GetBoardEdgesBoundingBox() : m_pcb->GetBoundingBox();
395 
396  if( area.GetWidth() == 0 && area.GetHeight() == 0 )
397  {
398  wxSize pageSize = GetPageSizeIU();
399 
401  {
402  area.SetOrigin( 0, 0 );
403  area.SetEnd( pageSize.x, pageSize.y );
404  }
405  else
406  {
407  area.SetOrigin( -pageSize.x / 2, -pageSize.y / 2 );
408  area.SetEnd( pageSize.x / 2, pageSize.y / 2 );
409  }
410  }
411 
412  return area;
413 }
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: board.h:728
const EDA_RECT GetBoardEdgesBoundingBox() const
Return the board bounding box calculated using exclusively the board edges (graphics on Edge....
Definition: board.h:742
int GetWidth() const
Definition: eda_rect.h:109
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:121
bool m_showBorderAndTitleBlock
void SetEnd(int x, int y)
Definition: eda_rect.h:182
int GetHeight() const
Definition: eda_rect.h:110
Handle the component boundary box.
Definition: eda_rect.h:42
const wxSize GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...

References BOARD::GetBoardEdgesBoundingBox(), BOARD::GetBoundingBox(), EDA_RECT::GetHeight(), PCB_BASE_FRAME::GetPageSizeIU(), EDA_RECT::GetWidth(), PCB_BASE_FRAME::m_pcb, EDA_DRAW_FRAME::m_showBorderAndTitleBlock, EDA_RECT::SetEnd(), and EDA_RECT::SetOrigin().

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

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

723 {
724  return static_cast<PCB_DRAW_PANEL_GAL*>( EDA_DRAW_FRAME::GetCanvas() );
725 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.

References EDA_DRAW_FRAME::GetCanvas().

Referenced by PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), DIALOG_NET_INSPECTOR::buildNetsList(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), DIALOG_PRINT_PCBNEW::createPrintout(), PCB_CONTROL::DeleteItemCursor(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), PCB_BASE_FRAME::DisplayGridMsg(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), BOARD_INSPECTION_TOOL::doHideNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::EnumeratePads(), DIALOG_DRC::ExcludeMarker(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_SELECTION_TOOL::FindItem(), ROUTER_TOOL::finishInteractive(), PCB_CONTROL::FlipPcbView(), PCB_BASE_FRAME::FocusOnItem(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetCollectorsGuide(), APPEARANCE_CONTROLS::getVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), ROUTER_TOOL::handleLayerSwitch(), HardRedraw(), EDIT_TOOL::Init(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_BASE_FRAME::LoadSettings(), PCB_PICKER_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), DIALOG_NET_INSPECTOR::onDeleteNet(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), PCB_SELECTION_TOOL::OnIdle(), APPEARANCE_CONTROLS::OnLayerAlphaChanged(), APPEARANCE_CONTROLS::OnLayerContextMenu(), APPEARANCE_CONTROLS::onLayerVisibilityChanged(), DIALOG_GROUP_PROPERTIES::OnMemberSelected(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetColorModeChanged(), APPEARANCE_CONTROLS::onNetContextMenu(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), APPEARANCE_CONTROLS::onRatsnestModeChanged(), DIALOG_GROUP_PROPERTIES::OnRemoveMember(), DIALOG_NET_INSPECTOR::onRenameNet(), DIALOG_NET_INSPECTOR::onSelChanged(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_NET_INSPECTOR::onSortingChanged(), FOOTPRINT_TREE_PANE::onUpdateUI(), PCB_EDIT_FRAME::OpenProjectFiles(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DIALOG_PAD_PROPERTIES::prepareCanvas(), ROUTER_TOOL::prepareInteractive(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDITOR_CONTROL::Properties(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), NET_GRID_TABLE::Rebuild(), APPEARANCE_CONTROLS::rebuildNets(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_WIZARD_FRAME::ReCreatePageList(), Refresh(), refreshCallback(), DIALOG_FOOTPRINT_CHECKER::refreshEditor(), DIALOG_DRC::refreshEditor(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), PCB_SELECTION_TOOL::RequestSelection(), RevertFootprint(), DIALOG_FOOTPRINT_CHECKER::runChecks(), DRC_TOOL::RunTests(), SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), DIALOG_FIND::search(), PCB_SELECTION_TOOL::SelectAll(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_SELECTION_TOOL::selectMultiple(), DRAWING_TOOL::SetAnchor(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetDisplayOptions(), PCB_POINT_EDITOR::setEditedPoint(), APPEARANCE_CONTROLS::SetLayerVisible(), APPEARANCE_CONTROLS::SetObjectVisible(), setupTools(), setupUIConditions(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), SwitchCanvas(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), NET_GRID_TABLE::updateNetColor(), PCB_BASE_FRAME::UpdateStatusBar(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), UpdateView(), PCB_SELECTION_TOOL::zoomFitSelection(), DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES(), DIALOG_NET_INSPECTOR::~DIALOG_NET_INSPECTOR(), DIALOG_NETLIST::~DIALOG_NETLIST(), DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB(), 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::~PCB_BASE_FRAME().

◆ GetCollectorsGuide()

GENERAL_COLLECTORS_GUIDE PCB_BASE_FRAME::GetCollectorsGuide ( )
inherited
Returns
global configuration options.

Definition at line 509 of file pcb_base_frame.cpp.

510 {
512  GetCanvas()->GetView() );
513 
514  // account for the globals
516  guide.SetIgnoreMTextsOnBack( ! m_pcb->IsElementVisible( LAYER_MOD_TEXT_BK ) );
517  guide.SetIgnoreMTextsOnFront( ! m_pcb->IsElementVisible( LAYER_MOD_TEXT_FR ) );
518  guide.SetIgnoreModulesOnBack( ! m_pcb->IsElementVisible( LAYER_MOD_BK ) );
519  guide.SetIgnoreModulesOnFront( ! m_pcb->IsElementVisible( LAYER_MOD_FR ) );
520  guide.SetIgnorePadsOnBack( ! m_pcb->IsElementVisible( LAYER_PAD_BK ) );
521  guide.SetIgnorePadsOnFront( ! m_pcb->IsElementVisible( LAYER_PAD_FR ) );
522  guide.SetIgnoreThroughHolePads( ! m_pcb->IsElementVisible( LAYER_PADS_TH ) );
523  guide.SetIgnoreModulesVals( ! m_pcb->IsElementVisible( LAYER_MOD_VALUES ) );
524  guide.SetIgnoreModulesRefs( ! m_pcb->IsElementVisible( LAYER_MOD_REFERENCES ) );
525  guide.SetIgnoreThroughVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
526  guide.SetIgnoreBlindBuriedVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
527  guide.SetIgnoreMicroVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
528  guide.SetIgnoreTracks( ! m_pcb->IsElementVisible( LAYER_TRACKS ) );
529 
530  return guide;
531 }
smd pads, front layer
Definition: layer_ids.h:197
show footprints values (when texts are visible)
Definition: layer_ids.h:205
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
smd pads, back layer
Definition: layer_ids.h:198
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:480
show footprints on back
Definition: layer_ids.h:204
virtual PCB_LAYER_ID GetActiveLayer() const
Meta control for all vias opacity/visibility.
Definition: layer_ids.h:188
text marked as invisible
Definition: layer_ids.h:195
show footprints on front
Definition: layer_ids.h:203
void SetIgnoreMTextsMarkedNoShow(bool ignore)
Definition: collectors.h:499
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition: board.cpp:532
show footprints references (when texts are visible)
Definition: layer_ids.h:206
multilayer pads, usually with holes
Definition: layer_ids.h:208
A general implementation of a COLLECTORS_GUIDE.
Definition: collectors.h:377

References PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), BOARD::GetVisibleLayers(), BOARD::IsElementVisible(), LAYER_MOD_BK, LAYER_MOD_FR, LAYER_MOD_REFERENCES, LAYER_MOD_TEXT_BK, LAYER_MOD_TEXT_FR, LAYER_MOD_TEXT_INVISIBLE, LAYER_MOD_VALUES, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_TH, LAYER_TRACKS, LAYER_VIAS, PCB_BASE_FRAME::m_pcb, and GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsMarkedNoShow().

Referenced by PCB_CONTROL::DeleteItemCursor(), PAD_TOOL::EnumeratePads(), and BOARD_INSPECTION_TOOL::highlightNet().

◆ GetColorSettings()

COLOR_SETTINGS * FOOTPRINT_EDIT_FRAME::GetColorSettings ( ) const
overridevirtual

Helper to retrieve the current color settings.

Returns
a pointer to the active COLOR_SETTINGS.

Reimplemented from PCB_BASE_FRAME.

Definition at line 561 of file footprint_edit_frame.cpp.

562 {
563  wxString currentTheme = GetFootprintEditorSettings()->m_ColorTheme;
564  return Pgm().GetSettingsManager().GetColorSettings( currentTheme );
565 }
FOOTPRINT_EDITOR_SETTINGS * GetFootprintEditorSettings() const
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:184

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

Referenced by SaveSettings().

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const
inlinevirtualinherited

Get the full filename + path of the currently opened file in the frame.

If no file is open, an empty string is returned.

Returns
the filename and full path to the open file

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 439 of file eda_base_frame.h.

439 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

SELECTION & FOOTPRINT_EDIT_FRAME::GetCurrentSelection ( )
overridevirtual

Get the current selection from the canvas area.

Returns
the current selection.

Reimplemented from TOOLS_HOLDER.

Definition at line 328 of file footprint_edit_frame.cpp.

329 {
330  return m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
331 }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
The selection tool: currently supports:

References TOOL_MANAGER::GetTool(), and TOOLS_HOLDER::m_toolManager.

◆ GetCurrentTreeNode()

LIB_TREE_NODE * FOOTPRINT_EDIT_FRAME::GetCurrentTreeNode ( ) const

◆ 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 232 of file pcb_base_edit_frame.cpp.

233 {
234  if( !GetBoard() )
235  return wxEmptyString;
236 
237  wxFileName fn = GetBoard()->GetFileName();
238  fn.SetExt( DesignRulesFileExtension );
239  return Prj().AbsolutePath( fn.GetFullName() );
240 }
const std::string DesignRulesFileExtension
const wxString & GetFileName() const
Definition: board.h:228
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
Definition: project.cpp:269
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
BOARD * GetBoard() const

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

Referenced by DRAWING_TOOL::DrawVia(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), DIALOG_DRC::OnRunDRCClick(), BOARD_INSPECTION_TOOL::reportClearance(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), PANEL_SETUP_RULES::TransferDataFromWindow(), and PANEL_SETUP_RULES::TransferDataToWindow().

◆ GetDesignSettings()

BOARD_DESIGN_SETTINGS & FOOTPRINT_EDIT_FRAME::GetDesignSettings ( ) const
overridevirtual

Returns the BOARD_DESIGN_SETTINGS for the open project.

Overloaded in FOOTPRINT_EDIT_FRAME.

Reimplemented from PCB_BASE_FRAME.

Definition at line 489 of file footprint_edit_frame.cpp.

490 {
491  return GetBoard()->GetDesignSettings();
492 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:589
BOARD * GetBoard() const

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

Referenced by Clear_Pcb(), LoadSettings(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), SaveSettings(), and PANEL_FP_EDITOR_DEFAULTS::TransferDataFromWindow().

◆ GetDisplayOptions()

const PCB_DISPLAY_OPTIONS& PCB_BASE_FRAME::GetDisplayOptions ( ) const
inlineinherited

Display options control the way tracks, vias, outlines and other things are shown (for instance solid or sketch mode).

Definition at line 179 of file pcb_base_frame.h.

179 { return m_displayOptions; }
PCB_DISPLAY_OPTIONS m_displayOptions

References PCB_BASE_FRAME::m_displayOptions.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), PCB_VIEWER_TOOLS::displayOptions(), PCB_TOOL_BASE::displayOptions(), EDIT_TOOL::doMoveSelection(), PAD_TOOL::EditPad(), PCB_BASE_FRAME::GetUserOrigin(), PCB_EDITOR_CONDITIONS::graphicsFillDisplayFunc(), BOARD_INSPECTION_TOOL::HighlightItem(), PCB_EDIT_FRAME::LoadProjectSettings(), APPEARANCE_CONTROLS::onNetColorModeChanged(), APPEARANCE_CONTROLS::onObjectOpacitySlider(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), APPEARANCE_CONTROLS::onRatsnestModeChanged(), PCB_DRAW_PANEL_GAL::OnShow(), PCB_EDITOR_CONDITIONS::padFillDisplayFunc(), PCB_EDITOR_CONDITIONS::padNumberDisplayFunc(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PCB_EDIT_FRAME::SaveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), PCB_SELECTION_TOOL::selectPoint(), setupUIConditions(), APPEARANCE_CONTROLS::setVisibleObjects(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), APPEARANCE_CONTROLS::syncObjectSettings(), PCB_EDITOR_CONDITIONS::textFillDisplayFunc(), PCB_EDITOR_CONDITIONS::trackFillDisplayFunc(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), PANEL_DISPLAY_OPTIONS::TransferDataToWindow(), PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataToWindow(), PANEL_EDIT_OPTIONS::TransferDataToWindow(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), PCB_EDITOR_CONDITIONS::viaFillDisplayFunc(), and PCB_EDITOR_CONDITIONS::zoneDisplayModeFunc().

◆ GetDocumentExtents()

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

Returns bbox 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 PCB_BASE_FRAME.

Definition at line 577 of file footprint_edit_frame.cpp.

578 {
579  FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
580 
581  if( footprint )
582  {
583  bool hasGraphicalItem = footprint->Pads().size() || footprint->Zones().size();
584 
585  if( !hasGraphicalItem )
586  {
587  for( const BOARD_ITEM* item : footprint->GraphicalItems() )
588  {
589  if( item->Type() == PCB_FP_TEXT_T )
590  continue;
591 
592  hasGraphicalItem = true;
593  break;
594  }
595  }
596 
597  if( hasGraphicalItem )
598  {
599  return footprint->GetBoundingBox( false, false );
600  }
601  else
602  {
603  BOX2I newFootprintBB( { 0, 0 }, { 0, 0 } );
604  newFootprintBB.Inflate( Millimeter2iu( 12 ) );
605  return newFootprintBB;
606  }
607  }
608 
609  return GetBoardBoundingBox( false );
610 }
class FP_TEXT, text in a footprint
Definition: typeinfo.h:92
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:80
A 2D bounding box built on top of an origin point and size vector.
Definition: box2.h:41
PADS & Pads()
Definition: footprint.h:168
FP_ZONES & Zones()
Definition: footprint.h:174
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:317
EDA_RECT GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
DRAWINGS & GraphicalItems()
Definition: footprint.h:171
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:281
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: footprint.cpp:676
BOARD * GetBoard() const
static constexpr int Millimeter2iu(double mm)

References PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetBoardBoundingBox(), FOOTPRINT::GetBoundingBox(), BOARD::GetFirstFootprint(), FOOTPRINT::GraphicalItems(), BOX2< Vec >::Inflate(), Millimeter2iu(), FOOTPRINT::Pads(), PCB_FP_TEXT_T, and FOOTPRINT::Zones().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

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

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

Definition at line 129 of file tools_holder.h.

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

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const
inlineinherited

Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.

Definition at line 135 of file tools_holder.h.

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

References TOOLS_HOLDER::m_dragAction.

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

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

◆ GetFileFromHistory()

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

Fetches the file name from the file history list.

This removes the selected file, if this file does not exist. The menu is also updated, if #FILE_HISTORY::UseMenu was called at initialization time.

Parameters
cmdIdThe command ID associated with the aFileHistory object.
typePlease document me!
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used
Returns
a wxString containing the selected filename

Definition at line 916 of file eda_base_frame.cpp.

918 {
919  if( !aFileHistory )
920  aFileHistory = m_fileHistory;
921 
922  wxASSERT( aFileHistory );
923 
924  int baseId = aFileHistory->GetBaseId();
925 
926  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
927 
928  unsigned i = cmdId - baseId;
929 
930  if( i < aFileHistory->GetCount() )
931  {
932  wxString fn = aFileHistory->GetHistoryFile( i );
933 
934  if( wxFileName::FileExists( fn ) )
935  {
936  return fn;
937  }
938  else
939  {
940  DisplayErrorMessage( this, wxString::Format( _( "File '%s' was not found." ), fn ) );
941  aFileHistory->RemoveFileFromHistory( i );
942  }
943  }
944 
945  // Update the menubar to update the file history menu
946  if( GetMenuBar() )
947  {
948  ReCreateMenuBar();
949  GetMenuBar()->Refresh();
950  }
951 
952  return wxEmptyString;
953 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:284
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

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

◆ GetFileHistory()

FILE_HISTORY& EDA_BASE_FRAME::GetFileHistory ( )
inlineinherited

Get the frame's main file history.

Returns
the main file history

Definition at line 423 of file eda_base_frame.h.

424  {
425  return *m_fileHistory;
426  }
FILE_HISTORY * m_fileHistory

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )
inlineinherited

◆ GetFootprintEditorFrameName()

const wxChar * FOOTPRINT_EDIT_FRAME::GetFootprintEditorFrameName ( )
static

Returns
the frame name used when creating the frame used to get a reference to this frame, if exists
the primary data model.

Definition at line 483 of file footprint_edit_frame.cpp.

484 {
486 }
#define FOOTPRINT_EDIT_FRAME_NAME

References FOOTPRINT_EDIT_FRAME_NAME.

◆ GetFootprintEditorSettings()

FOOTPRINT_EDITOR_SETTINGS * PCB_BASE_FRAME::GetFootprintEditorSettings ( ) const
inherited

Definition at line 681 of file pcb_base_frame.cpp.

682 {
683  return Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
684 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106

References Pgm().

Referenced by FOOTPRINT_WIZARD_FRAME::GetColorSettings(), and GetColorSettings().

◆ GetFootprintFromBoardByReference()

FOOTPRINT * PCB_BASE_FRAME::GetFootprintFromBoardByReference ( )
inherited
Returns
a reference to the footprint found by its reference on the current board. The reference is entered by the user from a dialog (by awxTextCtlr, or a list of available references)

Definition at line 458 of file load_select_footprint.cpp.

459 {
460  wxString footprintName;
461  wxArrayString fplist;
462 
463  // Build list of available fp references, to display them in dialog
464  for( auto fp : GetBoard()->Footprints() )
465  fplist.Add( fp->GetReference() + wxT(" ( ") + fp->GetValue() + wxT(" )") );
466 
467  fplist.Sort();
468 
469  DIALOG_GET_FOOTPRINT_BY_NAME dlg( this, fplist );
470 
471  if( dlg.ShowModal() != wxID_OK ) //Aborted by user
472  return nullptr;
473 
474  footprintName = dlg.GetValue();
475  footprintName.Trim( true );
476  footprintName.Trim( false );
477 
478  if( !footprintName.IsEmpty() )
479  {
480  for( auto mod : GetBoard()->Footprints() )
481  {
482  if( mod->GetReference().CmpNoCase( footprintName ) == 0 )
483  return mod;
484  }
485  }
486 
487  return nullptr;
488 }
DIALOG_GET_FOOTPRINT_BY_NAME is a helper dialog to select a footprint by its reference One can enter ...
FOOTPRINTS & Footprints()
Definition: board.h:233
BOARD * GetBoard() const

References FOOTPRINT::Add(), BOARD::Footprints(), GetBoard(), and DIALOG_GET_FOOTPRINT_BY_NAME::GetValue().

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const
inlineinherited

Definition at line 207 of file eda_base_frame.h.

207 { return m_ident; }

References EDA_BASE_FRAME::m_ident.

◆ GetGalDisplayOptions()

◆ GetGridColor()

COLOR4D FOOTPRINT_EDIT_FRAME::GetGridColor ( )
overridevirtual

Returns
the color of the grid

Reimplemented from EDA_DRAW_FRAME.

Definition at line 228 of file footprint_editor_utils.cpp.

229 {
230  return GetColorSettings()->GetColor( LAYER_GRID );
231 }
COLOR_SETTINGS * GetColorSettings() const override
Helper to retrieve the current color settings.
COLOR4D GetColor(int aLayer) const

References LAYER_GRID.

◆ GetGridOrigin()

const wxPoint & 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 303 of file pcb_base_frame.cpp.

304 {
306 }
wxPoint m_GridOrigin
origin for grid offsets
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:589

References BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::m_GridOrigin, and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_BASE_FRAME::GetUserOrigin().

◆ GetInfoBar()

◆ GetItem()

EDA_ITEM * PCB_BASE_FRAME::GetItem ( const KIID aId) const
overridevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 197 of file pcb_base_frame.cpp.

198 {
199  return GetBoard()->GetItem( aId );
200 }
BOARD_ITEM * GetItem(const KIID &aID) const
Definition: board.cpp:868
BOARD * GetBoard() const

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

◆ GetLibTreeAdapter()

wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>& FOOTPRINT_EDIT_FRAME::GetLibTreeAdapter ( )
inline

Return the adapter object that provides the stored data.

Definition at line 166 of file footprint_edit_frame.h.

166 { return m_adapter; }
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > m_adapter

References m_adapter.

Referenced by FOOTPRINT_TREE_PANE::FOOTPRINT_TREE_PANE().

◆ GetLoadedFPID()

LIB_ID FOOTPRINT_EDIT_FRAME::GetLoadedFPID ( ) const

Return the LIB_ID of the part being edited.

Definition at line 398 of file footprint_edit_frame.cpp.

399 {
400  FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
401 
402  if( footprint )
403  return LIB_ID( footprint->GetFPID().GetLibNickname(), m_footprintNameWhenLoaded );
404  else
405  return LIB_ID();
406 }
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:317
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:90
const LIB_ID & GetFPID() const
Definition: footprint.h:194
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), FOOTPRINT::GetFPID(), LIB_ID::GetLibNickname(), and m_footprintNameWhenLoaded.

Referenced by FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), GetTargetFPID(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), OnSaveFootprintAsPng(), retainLastFootprint(), RevertFootprint(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), and UpdateTitle().

◆ GetMagneticItemsSettings()

MAGNETIC_SETTINGS * FOOTPRINT_EDIT_FRAME::GetMagneticItemsSettings ( )
overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 568 of file footprint_edit_frame.cpp.

569 {
570  // Get the actual frame settings for magnetic items
572  wxCHECK( cfg, nullptr );
573  return &cfg->m_MagneticItems;
574 }
FOOTPRINT_EDITOR_SETTINGS * GetSettings()

References GetSettings(), and FOOTPRINT_EDITOR_SETTINGS::m_MagneticItems.

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 581 of file eda_base_frame.h.

581 { return m_undoRedoCountMax; }

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetModel()

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

Implements PCB_BASE_FRAME.

Definition at line 369 of file footprint_edit_frame.cpp.

370 {
371  return GetBoard()->GetFirstFootprint();
372 }
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:317
BOARD * GetBoard() const

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

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

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

◆ GetNearestGridPosition()

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

Return the nearest aGridSize location to aPosition.

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

Definition at line 792 of file eda_draw_frame.cpp.

793 {
794  const wxPoint& gridOrigin = GetGridOrigin();
795  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
796 
797  double xOffset = fmod( gridOrigin.x, gridSize.x );
798  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
799  double yOffset = fmod( gridOrigin.y, gridSize.y );
800  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
801 
802  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
803 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
virtual const wxPoint & GetGridOrigin() const =0
Return the absolute coordinates of the origin of the snap grid.
const VECTOR2D & GetGridSize() const
Return the grid size.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:73

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

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), and SCH_DRAWING_TOOLS::sizeSheet().

◆ GetNearestHalfGridPosition()

wxPoint EDA_DRAW_FRAME::GetNearestHalfGridPosition ( const wxPoint &  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 806 of file eda_draw_frame.cpp.

807 {
808  const wxPoint& gridOrigin = GetGridOrigin();
809  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize() / 2.0;
810 
811  double xOffset = fmod( gridOrigin.x, gridSize.x );
812  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
813  double yOffset = fmod( gridOrigin.y, gridSize.y );
814  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
815 
816  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
817 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
virtual const wxPoint & GetGridOrigin() const =0
Return the absolute coordinates of the origin of the snap grid.
const VECTOR2D & GetGridSize() const
Return the grid size.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:73

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

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Mirror(), and SCH_EDIT_TOOL::Mirror().

◆ GetOriginTransforms()

ORIGIN_TRANSFORMS & PCB_BASE_FRAME::GetOriginTransforms ( )
overridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 337 of file pcb_base_frame.cpp.

338 {
339  return m_originTransforms;
340 }
PCB_ORIGIN_TRANSFORMS m_originTransforms

References PCB_BASE_FRAME::m_originTransforms.

◆ GetPageSettings()

const PAGE_INFO & PCB_BASE_FRAME::GetPageSettings ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 288 of file pcb_base_frame.cpp.

289 {
290  return m_pcb->GetPageSettings();
291 }
const PAGE_INFO & GetPageSettings() const
Definition: board.h:535

References BOARD::GetPageSettings(), and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_CONTROL::Print().

◆ GetPageSizeIU()

const wxSize 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 294 of file pcb_base_frame.cpp.

295 {
296  // this function is only needed because EDA_DRAW_FRAME is not compiled
297  // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
298  // into an application specific source file.
299  return m_pcb->GetPageSettings().GetSizeIU();
300 }
const PAGE_INFO & GetPageSettings() const
Definition: board.h:535

References BOARD::GetPageSettings(), and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_CONTROL::AppendBoard(), Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetBoardBoundingBox(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ GetPcbNewSettings()

PCBNEW_SETTINGS * PCB_BASE_FRAME::GetPcbNewSettings ( ) const
inherited

Definition at line 675 of file pcb_base_frame.cpp.

676 {
677  return Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
678 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106

References Pgm().

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), DIALOG_PLOT::applyPlotSettings(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_BASE_EDIT_FRAME::GetColorSettings(), DIALOG_PLOT::init_Dialog(), DIALOG_GENDRILL::initDialog(), DIALOG_EXPORT_SVG::initDialog(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_DRC::initValues(), DIALOG_BOARD_REANNOTATE::InitValues(), DIALOG_COPPER_ZONE::loadPersistentNetSortConfigurations(), DIALOG_PRINT_PCBNEW::onColorModeClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), DIALOG_EXPORT_SVG::onPagePerLayerClicked(), PNS::TOOL_BASE::Reset(), DIALOG_PRINT_PCBNEW::saveSettings(), DIALOG_COPPER_ZONE::storePersistentNetSortConfigurations(), PCB_EDIT_FRAME::ToggleLayersManager(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataFromWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), PANEL_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), DIALOG_GENDRILL::UpdateConfig(), DIALOG_BOARD_REANNOTATE::~DIALOG_BOARD_REANNOTATE(), DIALOG_CLEANUP_TRACKS_AND_VIAS::~DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_DRC::~DIALOG_DRC(), DIALOG_EXPORT_3DFILE::~DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::~DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::~DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::~DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_IMPORT_GFX::~DIALOG_IMPORT_GFX(), DIALOG_NETLIST::~DIALOG_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetPlotSettings()

const PCB_PLOT_PARAMS & FOOTPRINT_EDIT_FRAME::GetPlotSettings ( ) const
overridevirtual

Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.

Overloaded in FOOTPRINT_EDIT_FRAME.

Reimplemented from PCB_BASE_FRAME.

Definition at line 495 of file footprint_edit_frame.cpp.

496 {
497  wxFAIL_MSG( "Plotting not supported in Footprint Editor" );
498 
500 }
virtual const PCB_PLOT_PARAMS & GetPlotSettings() const
Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.

References PCB_BASE_FRAME::GetPlotSettings().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetRotationAngle()

int PCB_BASE_EDIT_FRAME::GetRotationAngle ( ) const
inlineinherited

Return the angle used for rotate operations.

Definition at line 162 of file pcb_base_edit_frame.h.

References PCB_BASE_EDIT_FRAME::m_rotationAngle.

Referenced by TOOL_EVT_UTILS::GetEventRotationAngle(), and PANEL_EDIT_OPTIONS::TransferDataToWindow().

◆ GetScreen()

PCB_SCREEN* PCB_BASE_FRAME::GetScreen ( ) const
inlineoverridevirtualinherited

Return a pointer to a BASE_SCREEN or one of its derivatives.

It is overloaded by derived classes to return SCH_SCREEN or PCB_SCREEN.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 227 of file pcb_base_frame.h.

227 { return (PCB_SCREEN*) EDA_DRAW_FRAME::GetScreen(); }
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.

References EDA_DRAW_FRAME::GetScreen().

Referenced by Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), ClearModify(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), PCB_EDIT_FRAME::doAutoSave(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Files_io_from_id(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetActiveLayer(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), ROUTER_TOOL::handleLayerSwitch(), IsContentModified(), PCB_CONTROL::LayerToggle(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_BASE_FRAME::OnModify(), DIALOG_POSITION_RELATIVE::OnUseUserOriginClick(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::PrepareLayerIndicator(), RevertFootprint(), PCB_EDIT_FRAME::SavePcbFile(), DIALOG_FIND::search(), ROUTER_TOOL::SelectCopperLayerPair(), PCB_BASE_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPageSettings(), PCB_BASE_FRAME::UpdateStatusBar(), and DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 948 of file eda_draw_frame.cpp.

949 {
950  // Virtual function. Base class implementation returns an empty string.
951  return wxEmptyString;
952 }

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), and EDA_DRAW_FRAME::PrintDrawingSheet().

◆ GetSettings()

◆ GetSettingsManager()

SETTINGS_MANAGER* EDA_BASE_FRAME::GetSettingsManager ( ) const
inlineinherited

Definition at line 140 of file eda_base_frame.h.

140 { return m_settingsManager; }
SETTINGS_MANAGER * m_settingsManager

References EDA_BASE_FRAME::m_settingsManager.

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CreateNewProject(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_PLOT_SCHEMATIC::getColorSettings(), GetSettingsManager(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), SCH_EDIT_FRAME::OnImportProject(), GERBER_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SaveSettings(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetSeverity()

SEVERITY PCB_BASE_FRAME::GetSeverity ( int  aErrorCode) const
overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 649 of file pcb_base_frame.cpp.

650 {
651  if( aErrorCode >= CLEANUP_FIRST )
652  return RPT_SEVERITY_ACTION;
653 
655 
656  return bds.m_DRCSeverities[ aErrorCode ];
657 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:589
std::map< int, SEVERITY > m_DRCSeverities
BOARD * GetBoard() const
Container for design settings for a BOARD object.

References CLEANUP_FIRST, PCB_BASE_FRAME::GetBoard(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::m_DRCSeverities, and RPT_SEVERITY_ACTION.

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const
inlineinherited

For those frames that support polar coordinates.

Definition at line 120 of file eda_draw_frame.h.

120 { return m_polarCoords; }

References EDA_DRAW_FRAME::m_polarCoords.

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

◆ GetTargetFPID()

LIB_ID FOOTPRINT_EDIT_FRAME::GetTargetFPID ( ) const

Return the LIB_ID of the part selected in the footprint tree, or the loaded part if there is no selection in the tree.

Definition at line 387 of file footprint_edit_frame.cpp.

388 {
389  LIB_ID id = GetTreeFPID();
390 
391  if( id.GetLibNickname().empty() )
392  return GetLoadedFPID();
393 
394  return id;
395 }
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
LIB_ID GetLoadedFPID() const
Return the LIB_ID of the part being edited.
static bool empty(const wxTextEntryBase *aCtrl)
LIB_ID GetTreeFPID() const
Return the LIB_ID of the part or library selected in the footprint tree.

References empty(), GetLoadedFPID(), and GetTreeFPID().

Referenced by RegenerateLibraryTree(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), setupUIConditions(), and SyncLibraryTree().

◆ GetTitleBlock()

const TITLE_BLOCK & PCB_BASE_FRAME::GetTitleBlock ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 343 of file pcb_base_frame.cpp.

344 {
345  return m_pcb->GetTitleBlock();
346 }
TITLE_BLOCK & GetTitleBlock()
Definition: board.h:541

References BOARD::GetTitleBlock(), and PCB_BASE_FRAME::m_pcb.

Referenced by CreateHeaderInfoData().

◆ GetToolCanvas()

wxWindow* EDA_DRAW_FRAME::GetToolCanvas ( ) const
inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 425 of file eda_draw_frame.h.

425 { return GetCanvas(); }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 54 of file tools_holder.h.

54 { return m_toolManager; }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), BOARD_COMMIT::BOARD_COMMIT(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SCH_FIELD::DoHypertextMenu(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_NAVIGATE_TOOL::HypertextCommand(), ROUTER_TOOL::InlineBreakTrack(), EDA_3D_VIEWER_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), InstallPreferences(), SYMBOL_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), PCB_EDIT_FRAME::LoadProjectSettings(), LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PANEL_PCBNEW_ACTION_PLUGINS::OnOpenDirectoryButtonClick(), SIM_PLOT_FRAME::onProbe(), PANEL_PCBNEW_ACTION_PLUGINS::OnReloadButtonClick(), DIALOG_ABOUT::onReportBug(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), PL_EDITOR_FRAME::RollbackFromUndo(), SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), SaveSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), DIALOG_FIND::search(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), DIALOG_NETLIST::~DIALOG_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetTreeFPID()

LIB_ID FOOTPRINT_EDIT_FRAME::GetTreeFPID ( ) const

Return the LIB_ID of the part or library selected in the footprint tree.

Definition at line 375 of file footprint_edit_frame.cpp.

376 {
378 }
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit symbols, if the user selects the symbol itself rather than picking an individual unit,...
Definition: lib_tree.cpp:168
LIB_TREE * GetLibTree() const
FOOTPRINT_TREE_PANE * m_treePane

References FOOTPRINT_TREE_PANE::GetLibTree(), LIB_TREE::GetSelectedLibId(), and m_treePane.

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), FOOTPRINT_EDITOR_CONTROL::EditFootprint(), FOOTPRINT_EDITOR_CONTROL::ExportFootprint(), GetTargetFPID(), FOOTPRINT_EDITOR_CONTROL::Init(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), and FOOTPRINT_EDITOR_CONTROL::PasteFootprint().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 46 of file kiway_holder.h.

46 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:76

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const
inlinevirtualinherited

◆ GetUnitPair()

void EDA_DRAW_FRAME::GetUnitPair ( EDA_UNITS aPrimaryUnit,
EDA_UNITS aSecondaryUnits 
)
inherited

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.

Definition at line 1060 of file eda_draw_frame.cpp.

1061 {
1063 
1064  aPrimaryUnit = GetUserUnits();
1065  aSecondaryUnits = EDA_UNITS::MILS;
1066 
1067  if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
1068  {
1069  if( cmnTool )
1070  aSecondaryUnits = cmnTool->GetLastMetricUnits();
1071  else
1072  aSecondaryUnits = EDA_UNITS::MILLIMETRES;
1073  }
1074  else
1075  {
1076  if( cmnTool )
1077  aSecondaryUnits = cmnTool->GetLastImperialUnits();
1078  else
1079  aSecondaryUnits = EDA_UNITS::MILS;
1080  }
1081 }
EDA_UNITS GetLastMetricUnits()
Definition: common_tools.h:74
bool IsImperialUnit(EDA_UNITS aUnit)
Definition: eda_units.cpp:26
EDA_UNITS GetLastImperialUnits()
Definition: common_tools.h:75
Handles action that are shared between different applications.
Definition: common_tools.h:37
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
EDA_UNITS GetUserUnits() const
Return the user units currently in use