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 }
 Function ClearUndoORRedoList (virtual). More...
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 ~FOOTPRINT_EDIT_FRAME ()
 
BOARD_ITEM_CONTAINERGetModel () const override
 

More...
 
SELECTIONGetCurrentSelection () override
 Get the current selection from the canvas area. More...
 
bool IsContentModified () override
 Get if any footprints or libraries have been modified but not saved. More...
 
bool IsCurrentFPFromBoard () const
 
FOOTPRINT_EDITOR_SETTINGSGetSettings ()
 
BOARD_DESIGN_SETTINGSGetDesignSettings () const override
 Returns the BOARD_DESIGN_SETTINGS for the open project Overloaded in FOOTPRINT_EDIT_FRAME. More...
 
const PCB_PLOT_PARAMSGetPlotSettings () const override
 Function GetPlotSettings returns 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
 Saves common frame parameters to a configuration data file. More...
 
COLOR_SETTINGSGetColorSettings () 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
 switches 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 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 le new one, from the new layers names and cole layers. 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 OnUpdateModuleSelected (wxUpdateUIEvent &aEvent)
 
void OnUpdateLoadFootprintFromBoard (wxUpdateUIEvent &aEvent)
 
void OnUpdateSaveFootprintToBoard (wxUpdateUIEvent &aEvent)
 
void OnEditItemRequest (BOARD_ITEM *aItem) override
 

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 ()
 Returns 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 do not forget to call the basic OnModify function to update auxiliary info. 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
 

More...
 
void OnUpdateLayerAlpha (wxUpdateUIEvent &aEvent) override
 

More...
 
void ActivateGalCanvas () override
 

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
 Allows 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 ()
 
void UpdateView ()
 Reloads displayed items and sets view. More...
 
void FocusOnLibID (const LIB_ID &aLibID)
 
void KiwayMailIn (KIWAY_EXPRESS &mail) override
 Function KiwayMailIn receives 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...
 
bool AddLibrary (const wxString &aLibName=wxEmptyString)
 Function AddLibrary Add an existing library to either the global or project library table. More...
 
void SaveCopyInUndoList (EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0)) override
 Function SaveCopyInUndoList Creates a new entry in undo list of commands. More...
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0)) override
 Function SaveCopyInUndoList Creates a new entry in undo list of commands. More...
 
void RestoreCopyFromRedoList (wxCommandEvent &aEvent)
 Function RestoreCopyFromRedoList Redo the last edit: More...
 
void RestoreCopyFromUndoList (wxCommandEvent &aEvent)
 Function RestoreCopyFromUndoList Undo the last edit: More...
 
void RollbackFromUndo ()
 Performs an undo of the last edit WITHOUT logging a corresponding redo. More...
 
void PutDataInPreviousState (PICKED_ITEMS_LIST *aList, bool aRedoCommand, bool aRebuildRatsnet=true)
 Function PutDataInPreviousState Used in undo or redo command. More...
 
bool UndoRedoBlocked () const
 Function UndoRedoBlocked Checks if the undo and redo operations are currently blocked. More...
 
void UndoRedoBlock (bool aBlock=true)
 Function UndoRedoBlock Enables/disable undo and redo operations. More...
 
void SetGridVisibility (bool aVisible) override
 Function SetGridVisibility() More...
 
void SetObjectVisible (GAL_LAYER_ID aLayer, bool aVisible=true)
 
int GetRotationAngle () const
 Function GetRotationAngle() Returns the angle used for rotate operations. More...
 
void SetRotationAngle (int aRotationAngle)
 Function SetRotationAngle() Sets the angle used for rotate operations. More...
 
void ShowTextPropertiesDialog (BOARD_ITEM *aText)
 Routine for main window class to launch text properties dialog. More...
 
void ShowGraphicItemPropertiesDialog (BOARD_ITEM *aItem)
 
virtual void SetBoard (BOARD *aBoard) override
 

More...
 
void ClearUndoORRedoList (UNDO_REDO_LIST whichList, int aItemCount=-1) override
 Function ClearUndoORRedoList free the undo or redo list from List element Wrappers are deleted. More...
 
wxString GetDesignRulesPath ()
 Returns the absolute path to the design rules file for the currently-loaded board. More...
 
EDA_3D_VIEWERGet3DViewerFrame ()
 
virtual void Update3DView (bool aForceReload, const wxString *aTitle=nullptr)
 Update the 3D view, if the viewer is opened by this frame. More...
 
void Redraw3Dview ()
 Request a redraw of 3D-Viewer canvas. More...
 
FOOTPRINTLoadFootprint (const LIB_ID &aFootprintId)
 Function LoadFootprint attempts to load aFootprintId from the footprint library table. More...
 
EDA_RECT GetBoardBoundingBox (bool aBoardEdgesOnly=false) const
 Function GetBoardBoundingBox calculates 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 (COLOR4D aColor) override
 
const PCB_DISPLAY_OPTIONSGetDisplayOptions () const
 Function GetDisplayOptions 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)
 
const ZONE_SETTINGSGetZoneSettings () const
 
void SetZoneSettings (const ZONE_SETTINGS &aSettings)
 
BOARDGetBoard () const
 
EDA_ITEMGetItem (const KIID &aId) 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_VIEWERCreateAndShow3D_Frame ()
 Shows the 3D view frame. More...
 
GENERAL_COLLECTORS_GUIDE GetCollectorsGuide ()
 Function GetCollectorsGuide. More...
 
wxString SelectLibrary (const wxString &aNicknameExisting)
 Function SelectLibrary puts up a dialog and allows the user to pick a library, for unspecified use. More...
 
FOOTPRINTGetFootprintFromBoardByReference ()
 Function GetFootprintFromBoardByReference. More...
 
FOOTPRINTCreateNewFootprint (const wxString &aFootprintName)
 Function CreateNewFootprint 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 fooprint is placed on a board and a netlist is read. More...
 
void PlaceFootprint (FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
 Function PlaceFootprint 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())
 Function SelectFootprintFromLibTree opens a dialog to select a footprint. More...
 
wxString SelectFootprintFromLibBrowser ()
 Function SelectFootprintFromLibBrowser launches the footprint viewer to select the name of a footprint to load. More...
 
void Compile_Ratsnest (bool aDisplayStatus)
 Function Compile_Ratsnest Create the entire board ratsnest. More...
 
PCB_LAYER_ID SelectLayer (PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
 Install the dialog box for layer selection. More...
 
virtual void SwitchLayer (wxDC *DC, PCB_LAYER_ID layer)
 
virtual PCB_LAYER_ID GetActiveLayer () const
 
int GetSeverity (int aErrorCode) const override
 
virtual void OnDisplayOptionsChanged ()
 
PCBNEW_SETTINGSGetPcbNewSettings ()
 
FOOTPRINT_EDITOR_SETTINGSGetFootprintEditorSettings ()
 
void DisplayGridMsg () override
 Function DisplayGridMsg() More...
 
PCB_DRAW_PANEL_GALGetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame. More...
 
virtual void SetAutoZoom (bool aAutoZoom)
 Does nothing. More...
 
virtual bool GetAutoZoom ()
 Always returns false. 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...
 
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...
 
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)
 
virtual wxString GetScreenDesc () const
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242). More...
 
void EraseMsgBox ()
 
virtual void ReCreateAuxiliaryToolbar ()
 
bool IsGridVisible () const
 
virtual void SetGridColor (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)
 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 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. More...
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Function CreateBasicMenu. More...
 
void PrintWorkSheet (RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aScale, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
 Prints the page layout with the frame and the basic inscriptions. 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 CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
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)
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. More...
 
virtual void PrintPage (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)
 Handles command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=NULL, wxWindow *aResultantFocusWindow=NULL)
 Function ShowModal puts up 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 In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing. More...
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). More...
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
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 &event)
 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
 
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)
 
void PrintMsg (const wxString &text)
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg)
 
void ShowInfoBarWarning (const wxString &aWarningMsg)
 
void ShowInfoBarMsg (const wxString &aMsg)
 
virtual APP_SETTINGS_BASEconfig () const
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
void LoadWindowState (const wxString &aFileName)
 
virtual void LoadWindowState (const WINDOW_STATE &aState)
 Load frame state info from a configuration file. More...
 
void LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
 Loads window settings from the given settings object Normally called by LoadSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Saves window settings to the given settings object Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Returns a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 
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 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 ()
 Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status. More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList) More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList) More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 PopCommandFromRedoList 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)
 
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
 Indicates that hotkeys should perform an immediate action even if another tool is currently active. More...
 
bool GetDragSelects () const
 Indicates that a drag should draw a selection rectangle, even when started over an item. More...
 
bool GetMoveWarpsCursor () const
 Indicates that a move operation should warp the mouse pointer to the origin of the move object. More...
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

static const wxChar * GetFootprintEditorFrameName ()
 Function GetFootprintEditorFrameName (static) More...
 
static void HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
 Handles 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 updateTitle ()
 Updates window title according to getLibNickName(). 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...
 
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)
 Function loadFootprint 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 initExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 Function language_change is 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...
 

Static Protected Member Functions

static wxString GetBackupSuffix ()
 
static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

PCB_LAYER_BOX_SELECTORm_selLayerBox
 
FOOTPRINT_EDITOR_SETTINGSm_settings
 
int m_rotationAngle
 User defined rotation angle (in tenths of a degree). More...
 
bool m_undoRedoBlocked
 Is undo/redo operation currently blocked? More...
 
PANEL_SELECTION_FILTERm_selectionFilterPanel
 AUI panel for changing the selection tool filter controls. More...
 
APPEARANCE_CONTROLSm_appearancePanel
 AUI panel for controlling layer and object visibility and appearance. More...
 
BOARDm_pcb
 
PCB_DISPLAY_OPTIONS m_displayOptions
 
PCB_ORIGIN_TRANSFORMS m_originTransforms
 
wxSocketServer * m_socketServer
 
std::vector< wxSocketBase * > m_sockets
 interprocess communication More...
 
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
 prevents opening same file multiple times. More...
 
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
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
 The current canvas type. More...
 
bool m_modal
 
WX_EVENT_LOOPm_modal_loop
 
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
 
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
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 
bool m_isClosing
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
bool m_dragSelects
 
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
 
int m_defaultLibWidth
 

Friends

struct PCB::IFACE
 

Detailed Description

Definition at line 39 of file footprint_edit_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

◆ UNDO_REDO_LIST

Function ClearUndoORRedoList (virtual).

this function must remove the aItemCount old commands from aList and delete commands, pickers and picked items if needed Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN

Parameters
aList= the UNDO_REDO_CONTAINER of commands
aItemCount= number of old commands to delete. -1 to remove all old commands this will empty the list of commands. Commands are deleted from the older to the last.
Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 588 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ ~FOOTPRINT_EDIT_FRAME()

FOOTPRINT_EDIT_FRAME::~FOOTPRINT_EDIT_FRAME ( )

Definition at line 291 of file footprint_edit_frame.cpp.

292 {
293  // Shutdown all running tools
294  if( m_toolManager )
296 
297  // save the footprint in the PROJECT
299 
300  delete m_selectionFilterPanel;
301  delete m_appearancePanel;
302 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
APPEARANCE_CONTROLS * m_appearancePanel
AUI panel for controlling layer and object visibility and appearance.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
PANEL_SELECTION_FILTER * m_selectionFilterPanel
AUI panel for changing the selection tool filter controls.

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

111  :
112  PCB_BASE_EDIT_FRAME( aKiway, aParent, FRAME_FOOTPRINT_EDITOR, wxEmptyString,
113  wxDefaultPosition, wxDefaultSize,
115 {
116  m_showBorderAndTitleBlock = false; // true to show the frame references
117  m_canvasType = aBackend;
118  m_aboutTitle = _( "Footprint Editor" );
119  m_selLayerBox = nullptr;
120  m_settings = nullptr;
121 
122  // Give an icon
123  wxIcon icon;
124  icon.CopyFromBitmap( KiBitmap( icon_modedit_xpm ) );
125  SetIcon( icon );
126 
127  // Create GAL canvas
128  if( aBackend == EDA_DRAW_PANEL_GAL::GAL_TYPE_UNKNOWN )
130  else
131  m_canvasType = aBackend;
132 
133  PCB_DRAW_PANEL_GAL* drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
135  SetCanvas( drawPanel );
136  SetBoard( new BOARD() );
137 
138 
139  // This board will only be used to hold a footprint for editing
141 
142  // In Footprint Editor, the default net clearance is not known (it depends on the actual
143  // board). So we do not show the default clearance, by setting it to 0. The footprint or
144  // pad specific clearance will be shown.
146 
147  // Don't show the default board solder mask clearance in the footprint editor. Only the
148  // footprint or pad clearance setting should be shown if it is not 0.
150 
151  // restore the last footprint from the project, if any
153 
154  // Ensure all layers and items are visible:
155  // In footprint editor, some layers have no meaning or cannot be used, but we show all of
156  // them, at least to be able to edit a bad layer
158 
159  // However the "no net" mark on pads is useless, because there are no nets in footprint
160  // editor: make it non visible.
162 
164 
165  // In Footprint Editor, set the default paper size to A4 for plot/print
167  SetScreen( new PCB_SCREEN( GetPageSettings().GetSizeIU() ) );
168 
169  // Create the manager and dispatcher & route draw panel events to the dispatcher
170  setupTools();
172 
173  initLibraryTree();
174  m_treePane = new FOOTPRINT_TREE_PANE( this );
175 
176  ReCreateMenuBar();
180 
182  m_appearancePanel = new APPEARANCE_CONTROLS( this, GetCanvas(), true );
183 
184  // LoadSettings() *after* creating m_LayersManager, because LoadSettings() initialize
185  // parameters in m_LayersManager
186  // NOTE: KifaceSettings() will return PCBNEW_SETTINGS if we started from pcbnew
188 
189  // Must be set after calling LoadSettings() to be sure these parameters are not dependent
190  // on what is read in stored settings. Enable one internal layer, because footprints
191  // support keepout areas that can be on internal layers only (therefore on the first internal
192  // layer). This is needed to handle these keepout in internal layers only.
194  GetBoard()->SetEnabledLayers( GetBoard()->GetEnabledLayers().set( In1_Cu ) );
195  GetBoard()->SetVisibleLayers( GetBoard()->GetEnabledLayers() );
196  GetBoard()->SetLayerName( In1_Cu, _( "Inner layers" ) );
197 
199 
200  // Create the infobar
201  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
202 
203  m_auimgr.SetManagedWindow( this );
204 
205  unsigned int auiFlags = wxAUI_MGR_DEFAULT;
206 #if !defined( _WIN32 )
207  // Windows cannot redraw the UI fast enough during a live resize and may lead to all kinds of graphical glitches
208  auiFlags |= wxAUI_MGR_LIVE_RESIZE;
209 #endif
210  m_auimgr.SetFlags( auiFlags );
211 
212  // Horizontal items; layers 4 - 6
213  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer( 6 ) );
214  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer( 6 ) );
215  m_auimgr.AddPane( m_infoBar,
216  EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
217 
218  // Vertical items; layers 1 - 3
219  m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" ).Left().Layer( 3 ) );
220  m_auimgr.AddPane( m_treePane, EDA_PANE().Palette().Name( "Footprints" ).Left().Layer(2)
221  .Caption( _( "Libraries" ) ).MinSize( 250, 400 ).Resizable() );
222 
223  m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" ).Right().Layer(2) );
224 
225  m_auimgr.AddPane( m_appearancePanel, EDA_PANE().Name( "LayersManager" ).Right().Layer( 3 )
226  .Caption( _( "Appearance" ) ).PaneBorder( false )
227  .MinSize( 180, -1 ).BestSize( 180, -1 ) );
229  EDA_PANE().Palette().Name( "SelectionFilter" ).Right().Layer( 3 )
230  .Caption( _( "Selection Filter" ) ).PaneBorder( false ).Position( 2 )
231  .MinSize( 160, -1 ).BestSize( m_selectionFilterPanel->GetBestSize() ) );
232 
233  // The selection filter doesn't need to grow in the vertical direction when docked
234  m_auimgr.GetPane( "SelectionFilter" ).dock_proportion = 0;
235 
236  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
237 
239 
240  m_auimgr.GetArtProvider()->SetColour( wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR,
241  wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT ) );
242  m_auimgr.GetArtProvider()->SetColour( wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR,
243  wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT ) );
244 
245  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
246  // hidding it.
247  m_auimgr.Update();
248 
249  // We don't want the infobar displayed right away
250  m_auimgr.GetPane( "InfoBar" ).Hide();
251  m_auimgr.Update();
252 
253  if( m_settings->m_LibWidth > 0 )
254  {
255  wxAuiPaneInfo& treePane = m_auimgr.GetPane( "Footprints" );
256 
257  // wxAUI hack: force width by setting MinSize() and then Fixed()
258  // thanks to ZenJu http://trac.wxwidgets.org/ticket/13180
259  treePane.MinSize( m_settings->m_LibWidth, -1 );
260  treePane.Fixed();
261  m_auimgr.Update();
262 
263  // now make it resizable again
264  treePane.Resizable();
265  m_auimgr.Update();
266 
267  // Note: DO NOT call m_auimgr.Update() anywhere after this; it will nuke the size
268  // back to minimum.
269  treePane.MinSize( 250, -1 );
270  }
271 
272  // Apply saved visibility stuff at the end
276 
278  updateTitle();
279  initExitKey();
280  setupUnits( GetSettings() );
281 
282  // Default shutdown reason until a file is loaded
283  KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Footprint changes are unsaved" ) );
284 
285  // Ensure the window is on top
286  Raise();
287  Show( true );
288 }
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)
show a marker on pads with no nets
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:503
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
AUI panel for controlling layer and object visibility and appearance.
void initExitKey()
Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
ACTION_TOOLBAR * m_optionsToolBar
virtual void SetScreen(BASE_SCREEN *aScreen)
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
The current canvas type.
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:94
void SetCopperLayerCount(int aCount)
Definition: board.cpp:431
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:559
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
Definition: board.cpp:480
wxAuiManager m_auimgr
ACTION_TOOLBAR * m_mainToolBar
not specified: a GAL engine must be set by the client
bool m_axesEnabled
Whether or not to draw the coordinate system axes
void SetShutdownBlockReason(wxWindow *aWindow, const wxString &aReason)
Sets the block reason why the window/application is preventing OS shutdown.
Definition: gtk/app.cpp:51
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:82
void ReCreateMenuBar() override
(Re)Create the menubar for the Footprint Editor frame
void SetClearance(int aClearance)
Definition: netclass.h:160
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of vis...
Definition: board.cpp:463
EDA_MSG_PANEL * m_messagePanel
PAGE_INFO describes the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:54
bool m_showBorderAndTitleBlock
bool SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)
Changes the name of the layer given by aLayer.
Definition: board.cpp:348
FOOTPRINT_EDITOR_SETTINGS * m_settings
static const wxChar A4[]
Definition: page_info.h:65
#define KICAD_DEFAULT_DRAWFRAME_STYLE
Footprint Editor pane with footprint library tree.
void SetUserLayerPresets(std::vector< LAYER_PRESET > &aPresetList)
Updates the current layer presets from those saved in the project file
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
Specialization of the wxAuiPaneInfo class for KiCad panels.
PCB_LAYER_BOX_SELECTOR * m_selLayerBox
const BITMAP_OPAQUE icon_modedit_xpm[1]
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
void updateTitle()
Updates window title according to getLibNickName().
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:70
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting()
Returns the canvas type stored in the application settings.
PANEL_SELECTION_FILTER * m_selectionFilterPanel
AUI panel for changing the selection tool filter controls.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:186
WX_INFOBAR * m_infoBar
#define _(s)
Definition: 3d_actions.cpp:33
virtual void SetBoard(BOARD *aBoard) override
void setupUnits(APP_SETTINGS_BASE *aCfg)
std::vector< LAYER_PRESET > m_LayerPresets
NETCLASS * GetDefault() const
Function GetDefault.
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:76
BOARD * GetBoard() const
void SetEnabledLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings Changes the bit-mask of ena...
Definition: board.cpp:457
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition: board.h:257
wxString m_aboutTitle
static const wxChar * GetFootprintEditorFrameName()
Function GetFootprintEditorFrameName (static)
ACTION_TOOLBAR * m_drawToolBar

References _, PAGE_INFO::A4, PCAD2KICAD::Center, F_SilkS, FPHOLDER, EDA_DRAW_PANEL_GAL::GAL_TYPE_UNKNOWN, GetBoard(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), icon_modedit_xpm, 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

Reimplemented from PCB_BASE_FRAME.

Definition at line 1032 of file footprint_edit_frame.cpp.

1033 {
1035 
1036  // Be sure the axis are enabled
1037  GetCanvas()->GetGAL()->SetAxesEnabled( true );
1038 
1039  UpdateView();
1040 
1041  // Ensure the m_Layers settings are using the canvas type:
1043 }
void ActivateGalCanvas() override
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void UpdateView()
Reloads displayed items and sets view.
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
void SetAxesEnabled(bool aAxesEnabled)
Enables 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 440 of file footprint_edit_frame.cpp.

441 {
442  m_revertModule.reset( (FOOTPRINT*) aFootprint->Clone() );
443 
445 
446  // Pads are always editable in Footprint Editor
447  aFootprint->SetPadsLocked( false );
448 
450 
451  if( IsCurrentFPFromBoard() )
452  {
453  wxString msg;
454  msg.Printf( _( "Editing %s from board. Saving will update the board only." ),
455  aFootprint->GetReference() );
456 
458  GetInfoBar()->ShowMessage( msg, wxICON_INFORMATION );
459  }
460 
461  UpdateMsgPanel();
462 }
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: infobar.cpp:120
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
const LIB_ID & GetFPID() const
Definition: footprint.h:208
const wxString GetReference() const
Function GetReference.
Definition: footprint.h:440
std::unique_ptr< FOOTPRINT > m_revertModule
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:226
#define _(s)
Definition: 3d_actions.cpp:33
virtual void AddFootprintToBoard(FOOTPRINT *aFootprint)
Adds the given footprint to the board.
WX_INFOBAR * GetInfoBar()
void SetPadsLocked(bool aPadsLocked)
Definition: footprint.h:336
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: footprint.cpp:1083
virtual void UpdateMsgPanel()
Redraw the message panel.

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

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

◆ AddLibrary()

bool PCB_BASE_EDIT_FRAME::AddLibrary ( const wxString &  aLibName = wxEmptyString)
inherited

Function AddLibrary 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 464 of file footprint_libraries_utils.cpp.

465 {
466  wxFileName fn( aFilename );
467 
468  if( aFilename.IsEmpty() )
469  {
470  if( !LibraryFileBrowser( true, fn,
472  true ) )
473  {
474  return false;
475  }
476  }
477 
478  wxString libPath = fn.GetFullPath();
479  wxString libName = fn.GetName();
480 
481  if( libName.IsEmpty() )
482  return false;
483 
484  bool saveInGlobalTable = false;
485  bool saveInProjectTable = false;
486 
487  if( Prj().IsNullProject() )
488  {
489  saveInGlobalTable = true;
490  }
491  else
492  {
493  wxArrayString libTableNames;
494 
495  libTableNames.Add( _( "Global" ) );
496  libTableNames.Add( _( "Project" ) );
497 
498  switch( SelectSingleOption( this, _( "Select Library Table" ),
499  _( "Choose the Library Table to add the library to:" ), libTableNames ) )
500  {
501  case 0: saveInGlobalTable = true; break;
502  case 1: saveInProjectTable = true; break;
503  default: return false;
504  }
505  }
506 
507  wxString type = IO_MGR::ShowType( IO_MGR::GuessPluginTypeFromLibPath( libPath ) );
508 
509  // try to use path normalized to an environmental variable or project path
510  wxString normalizedPath = NormalizePath( libPath, &Pgm().GetLocalEnvVariables(), &Prj() );
511 
512  if( normalizedPath.IsEmpty() )
513  normalizedPath = libPath;
514 
515  try
516  {
517  if( saveInGlobalTable )
518  {
519  auto row = new FP_LIB_TABLE_ROW( libName, normalizedPath, type, wxEmptyString );
520  GFootprintTable.InsertRow( row );
522  }
523  else if( saveInProjectTable )
524  {
525  auto row = new FP_LIB_TABLE_ROW( libName, normalizedPath, type, wxEmptyString );
526  Prj().PcbFootprintLibs()->InsertRow( row );
527  Prj().PcbFootprintLibs()->Save( Prj().FootprintLibTblName() );
528  }
529  }
530  catch( const IO_ERROR& ioe )
531  {
532  DisplayError( this, ioe.What() );
533  return false;
534  }
535 
536  auto editor = (FOOTPRINT_EDIT_FRAME*) Kiway().Player( FRAME_FOOTPRINT_EDITOR, false );
537 
538  if( editor )
539  {
540  LIB_ID libID( libName, wxEmptyString );
541  editor->SyncLibraryTree( true );
542  editor->FocusOnLibID( libID );
543  }
544 
545  auto viewer = (FOOTPRINT_VIEWER_FRAME*) Kiway().Player( FRAME_FOOTPRINT_VIEWER, false );
546 
547  if( viewer )
548  viewer->ReCreateLibraryList();
549 
550  return true;
551 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
bool InsertRow(LIB_TABLE_ROW *aRow, bool doReplace=false)
Adds aRow if it does not already exist or if doReplace is true.
FP_LIB_TABLE GFootprintTable
!!!!!!!!!!!!!! This code is obsolete because of the merge into pcbnew, don't bother with it.
Component library viewer main window.
static const wxString ShowType(PCB_FILE_T aFileType)
Function ShowType returns a brief name for a plugin, given aFileType enum.
Definition: io_mgr.cpp:76
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:102
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath)
Function GuessPluginTypeFromLibPath returns a plugin type given a footprint library's libPath.
Definition: io_mgr.cpp:123
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:345
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
bool LibraryFileBrowser(bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
VTBL_ENTRY bool IsNullProject() const
Checks if this project is a null project (i.e.
Definition: project.cpp:134
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:284
wxString KiCadFootprintLibPathWildcard()
#define _(s)
Definition: 3d_actions.cpp:33
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
int SelectSingleOption(wxWindow *aParent, const wxString &aTitle, const wxString &aMessage, const wxArrayString &aOptions)
Displays a dialog with radioboxes asking the user to select an option.
Definition: confirm.cpp:294
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
const std::string KiCadFootprintLibPathExtension
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalizes a file path to an environmental variable, if possible.
Definition: env_paths.cpp:68
static wxString GetGlobalTableFileName()
Function GetGlobalTableFileName.

References _, DisplayError(), FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_VIEWER, FP_LIB_TABLE::GetGlobalTableFileName(), GFootprintTable, IO_MGR::GuessPluginTypeFromLibPath(), LIB_TABLE::InsertRow(), PROJECT::IsNullProject(), KiCadFootprintLibPathExtension, KiCadFootprintLibPathWildcard(), KIWAY_HOLDER::Kiway(), EDA_DRAW_FRAME::LibraryFileBrowser(), NormalizePath(), PROJECT::PcbFootprintLibs(), Pgm(), KIWAY::Player(), KIWAY_HOLDER::Prj(), LIB_TABLE::Save(), SelectSingleOption(), 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 388 of file eda_base_frame.cpp.

389 {
390  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
391  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
392 
393  helpMenu->Add( ACTIONS::help );
394  helpMenu->Add( ACTIONS::gettingStarted );
395  helpMenu->Add( ACTIONS::listHotKeys );
396  helpMenu->Add( ACTIONS::getInvolved );
397  helpMenu->Add( ACTIONS::reportBug );
398 
399  helpMenu->AppendSeparator();
400  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
401 
402  aMenuBar->Append( helpMenu, _( "&Help" ) );
403 }
static TOOL_ACTION listHotKeys
Definition: actions.h:177
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:43
static TOOL_ACTION reportBug
Definition: actions.h:179
const BITMAP_OPAQUE about_xpm[1]
Definition: about.cpp:84
COMMON_CONTROL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:176
static TOOL_ACTION getInvolved
Definition: actions.h:178
static TOOL_ACTION gettingStarted
Definition: actions.h:175

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

Function CreateBasicMenu.

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

Definition at line 436 of file eda_draw_frame.cpp.

437 {
438  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
439  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
440 
441  aMenu.AddSeparator( 1000 );
443  aMenu.AddItem( ACTIONS::zoomIn, SELECTION_CONDITIONS::ShowAlways, 1000 );
444  aMenu.AddItem( ACTIONS::zoomOut, SELECTION_CONDITIONS::ShowAlways, 1000 );
446  if( IsType( FRAME_SCH ) || IsType( FRAME_PCB_EDITOR ) )
448 
449  aMenu.AddSeparator( 1000 );
450 
451  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
452  zoomMenu->SetTool( commonTools );
453  aToolMenu.AddSubMenu( zoomMenu );
454 
455  auto gridMenu = std::make_shared<GRID_MENU>( this );
456  gridMenu->SetTool( commonTools );
457  aToolMenu.AddSubMenu( gridMenu );
458 
459  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
460  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
461 }
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
static TOOL_ACTION zoomFitScreen
Definition: actions.h:94
static TOOL_ACTION zoomFitObjects
Definition: actions.h:95
COMMON_TOOLS.
Definition: common_tools.h:38
void AddSeparator(int aOrder=ANY_ORDER)
Adds a separator to the menu.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
bool IsType(FRAME_T aType) const
static TOOL_ACTION zoomCenter
Definition: actions.h:93
static TOOL_ACTION zoomIn
Definition: actions.h:89
static TOOL_ACTION zoomOut
Definition: actions.h:90

References CONDITIONAL_MENU::AddSeparator(), TOOL_MENU::AddSubMenu(), FRAME_PCB_EDITOR, FRAME_SCH, TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), EDA_BASE_FRAME::IsType(), TOOLS_HOLDER::m_toolManager, SELECTION_CONDITIONS::ShowAlways(), ACTIONS::zoomCenter, ACTIONS::zoomFitObjects, ACTIONS::zoomFitScreen, ACTIONS::zoomIn, and ACTIONS::zoomOut.

Referenced by ROUTER_TOOL::Init(), PL_EDIT_TOOL::Init(), PICKER_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PCB_VIEWER_TOOLS::Init(), PL_SELECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), and SELECTION_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
aTextUpper- The message upper text.
aTextLower- The message lower text.
aPadding- Number of spaces to pad between messages.

Definition at line 604 of file eda_draw_frame.cpp.

606 {
607  if( m_messagePanel )
608  m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
609 }
EDA_MSG_PANEL * m_messagePanel
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, int aPadding=6)
Function AppendMessage appends a message to the message panel.
Definition: msgpanel.cpp:114

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

Referenced by PCB_BASE_FRAME::Compile_Ratsnest(), GERBER_FILE_IMAGE::DisplayImageInfo(), SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_PRINTOUT::OnPrintPage(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::SaveEEFile(), PCB_EDIT_FRAME::SavePcbFile(), and LIB_VIEW_FRAME::updatePreviewSymbol().

◆ canCloseWindow()

bool FOOTPRINT_EDIT_FRAME::canCloseWindow ( wxCloseEvent &  Event)
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 585 of file footprint_edit_frame.cpp.

586 {
587  if( IsContentModified() )
588  {
589  // Shutdown blocks must be determined and vetoed as early as possible
590  if( KIPLATFORM::APP::SupportsShutdownBlockReason() && aEvent.GetId() == wxEVT_QUERY_END_SESSION )
591  {
592  aEvent.Veto();
593  return false;
594  }
595 
596  wxString footprintName = GetBoard()->GetFirstFootprint()->GetFPID().GetLibItemName();
597  wxString msg = _( "Save changes to \"%s\" before closing?" );
598 
599  if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
600  [&]() -> bool
601  {
602  return SaveFootprint( GetBoard()->GetFirstFootprint() );
603  } ) )
604  {
605  aEvent.Veto();
606  return false;
607  }
608  }
609 
610  return true;
611 }
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:202
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
bool IsContentModified() override
Get if any footprints or libraries have been modified but not saved.
FOOTPRINT * GetFirstFootprint() const
Gets the first footprint on the board or nullptr.
Definition: board.h:348
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: gtk/app.cpp:40
const LIB_ID & GetFPID() const
Definition: footprint.h:208
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
BOARD * GetBoard() const
bool SaveFootprint(FOOTPRINT *aFootprint)
Save in an existing library a given footprint.

References _, 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 970 of file eda_base_frame.cpp.

971 {
972  SetUserUnits( aUnits );
974 
975  wxCommandEvent e( UNITS_CHANGED );
976  ProcessEventLocally( e );
977 }
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 868 of file eda_base_frame.cpp.

869 {
870  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
871 
872  wxFileName autoSaveFileName = aFileName;
873 
874  // Check for auto save file.
875  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
876 
877  wxLogTrace( traceAutoSave,
878  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
879 
880  if( !autoSaveFileName.FileExists() )
881  return;
882 
883  wxString msg = wxString::Format( _(
884  "Well this is potentially embarrassing!\n"
885  "It appears that the last time you were editing the file\n"
886  "\"%s\"\n"
887  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
888  aFileName.GetFullName()
889  );
890 
891  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
892 
893  // Make a backup of the current file, delete the file, and rename the auto save file to
894  // the file name.
895  if( response == wxYES )
896  {
897  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
898  {
899  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
900  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
901  }
902  }
903  else
904  {
905  wxLogTrace( traceAutoSave,
906  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
907 
908  // Remove the auto save file when using the previous file as is.
909  wxRemoveFile( autoSaveFileName.GetFullPath() );
910  }
911 }
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:102
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static wxString GetAutoSaveFilePrefix()
#define _(s)
Definition: 3d_actions.cpp:33

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

Referenced by SCH_EDIT_FRAME::OpenProjectFiles(), and PCB_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 94 of file initpcb.cpp.

95 {
96  if( GetBoard() == NULL )
97  return false;
98 
99  if( aQuery && IsContentModified() )
100  {
101  wxSafeYield( this, true ); // Allow frame to come to front before showing warning.
102 
104  this, _( "The current footprint has been modified. Save changes?" ),
105  [&]() -> bool
106  {
107  return SaveFootprint( GetBoard()->Footprints().front() );
108  } ) )
109  {
110  return false;
111  }
112  }
113 
114  // Clear undo and redo lists because we want a full deletion
116  GetScreen()->ClrModify();
117 
118  BOARD* board = new BOARD;
119 
122  SetBoard( board );
123 
124  // This board will only be used to hold a footprint for editing
126 
127  // clear filename, to avoid overwriting an old file
128  GetBoard()->SetFileName( wxEmptyString );
129 
131 
132  return true;
133 }
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:202
BOARD_DESIGN_SETTINGS & GetDesignSettings() const override
Returns the BOARD_DESIGN_SETTINGS for the open project Overloaded in FOOTPRINT_EDIT_FRAME.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:559
bool IsContentModified() override
Get if any footprints or libraries have been modified but not saved.
void InitDataPoints(const wxSize &aPageSizeInternalUnits)
Definition: base_screen.cpp:48
void SynchronizeNetsAndNetClasses()
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
Definition: board.cpp:1379
#define NULL
void SetFileName(const wxString &aFileName)
Definition: board.h:276
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:186
#define _(s)
Definition: 3d_actions.cpp:33
virtual void SetBoard(BOARD *aBoard) override
void ClrModify()
Definition: base_screen.h:121
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 SaveFootprint(FOOTPRINT *aFootprint)
Save in an existing library a given footprint.
virtual void ClearUndoRedoList()
Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are del...
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition: board.h:257

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

Referenced by FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), doCloseWindow(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDITOR_TOOLS::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 765 of file eda_base_frame.cpp.

766 {
767  if( !aFileHistory )
768  aFileHistory = m_fileHistory;
769 
770  wxASSERT( aFileHistory );
771 
772  aFileHistory->ClearFileHistory();
773 
774  // Update the menubar to update the file history menu
775  if( GetMenuBar() )
776  {
777  ReCreateMenuBar();
778  GetMenuBar()->Refresh();
779  }
780 }
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 392 of file footprint_edit_frame.cpp.

393 {
394  if( GetBoard()->GetFirstFootprint() )
396 
397  GetScreen()->ClrModify();
398 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
FOOTPRINT * GetFirstFootprint() const
Gets the first footprint on the board or nullptr.
Definition: board.h:348
const LIB_ID & GetFPID() const
Definition: footprint.h:208
void ClrModify()
Definition: base_screen.h:121
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
BOARD * GetBoard() const

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

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

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

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

Function ClearUndoORRedoList free the undo or redo list from List element Wrappers are deleted.

datas pointed by wrappers are deleted if not in use in schematic i.e. when they are copy of a schematic item or they are no more in use (DELETED)

Parameters
whichList= the UNDO_REDO_CONTAINER to clear
aItemCount= the count of items to remove. < 0 for all items items are removed from the beginning of the list. So this function can be called to remove old commands

Reimplemented from EDA_BASE_FRAME.

Definition at line 604 of file undo_redo.cpp.

605 {
606  if( aItemCount == 0 )
607  return;
608 
609  UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
610  unsigned icnt = list.m_CommandsList.size();
611 
612  if( aItemCount > 0 )
613  icnt = aItemCount;
614 
615  for( unsigned ii = 0; ii < icnt; ii++ )
616  {
617  if( list.m_CommandsList.size() == 0 )
618  break;
619 
620  PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
621  list.m_CommandsList.erase( list.m_CommandsList.begin() );
622 
623  curr_cmd->ClearListAndDeleteItems();
624  delete curr_cmd; // Delete command
625  }
626 }
UNDO_REDO_CONTAINER m_undoList
UNDO_REDO_CONTAINER is a holder to handle alist of undo (or redo) command.
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
UNDO_REDO_CONTAINER m_redoList
void ClearListAndDeleteItems()
Function ClearListAndDeleteItems deletes the list of pickers, AND the data pointed by m_PickedItem or...

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

◆ ClearUndoRedoList()

◆ CloseFootprintEditor()

void FOOTPRINT_EDIT_FRAME::CloseFootprintEditor ( wxCommandEvent &  Event)

Definition at line 638 of file footprint_edit_frame.cpp.

639 {
640  Close();
641 }

◆ 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 1046 of file footprint_edit_frame.cpp.

1047 {
1048  PCB_BASE_EDIT_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
1049 
1051  GetCanvas()->ForceRefresh();
1052 
1054 
1055  if( aEnvVarsChanged )
1056  SyncLibraryTree( true );
1057 
1058  Layout();
1059  SendSizeEvent();
1060 }
void ForceRefresh()
Function ForceRefresh() Forces 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
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:776

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

Function Compile_Ratsnest Create the entire board ratsnest.

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 41 of file pcbnew/ratsnest/ratsnest.cpp.

42 {
43  GetBoard()->GetConnectivity()->RecalculateRatsnest();
44  ClearMsgPanel();
45 
46  if( aDisplayStatus )
47  {
48  std::shared_ptr<CONNECTIVITY_DATA> conn = m_pcb->GetConnectivity();
49  wxString msg;
50 
51  msg.Printf( wxT( " %d" ), conn->GetPadCount() );
52  AppendMsgPanel( _( "Pads" ), msg, RED );
53 
54  msg.Printf( wxT( " %d" ), conn->GetNetCount() - 1 /* Don't include "No Net" in count */ );
55  AppendMsgPanel( _( "Nets" ), msg, CYAN );
56 
57  SetMsgPanel( m_pcb );
58  }
59 }
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:382
Definition: color4d.h:59
virtual void ClearMsgPanel()
Clear all messages from the message panel.
Definition: color4d.h:60
#define _(s)
Definition: 3d_actions.cpp:33
BOARD * GetBoard() const
void AppendMsgPanel(const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
Append a message to the message panel.

References _, EDA_DRAW_FRAME::AppendMsgPanel(), EDA_DRAW_FRAME::ClearMsgPanel(), CYAN, PCB_BASE_FRAME::GetBoard(), BOARD::GetConnectivity(), PCB_BASE_FRAME::m_pcb, RED, and EDA_DRAW_FRAME::SetMsgPanel().

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

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const
virtualinherited

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

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 661 of file eda_base_frame.cpp.

662 {
663  // KICAD_MANAGER_FRAME overrides this
664  return Kiface().KifaceSettings();
665 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:103
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), EDA_DRAW_FRAME::resolveCanvasType(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), setupTools(), LIB_VIEW_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), ZOOM_MENU::ZOOM_MENU(), and BM2CMP_FRAME::~BM2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited
Returns
a base name prefix used in Load/Save settings to build the full name of keys used in config. 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 config can be used.

Reimplemented from TOOLS_HOLDER.

Definition at line 404 of file eda_base_frame.h.

405  {
406  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
407  return baseCfgName;
408  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateAndShow3D_Frame()

EDA_3D_VIEWER * PCB_BASE_FRAME::CreateAndShow3D_Frame ( )
inherited

Shows the 3D view frame.

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

Definition at line 399 of file pcb_base_frame.cpp.

400 {
401  EDA_3D_VIEWER* draw3DFrame = Get3DViewerFrame();
402 
403  if( !draw3DFrame )
404  draw3DFrame = new EDA_3D_VIEWER( &Kiway(), this, _( "3D Viewer" ) );
405 
406  // Raising the window does not show the window on Windows if iconized. This should work
407  // on any platform.
408  if( draw3DFrame->IsIconized() )
409  draw3DFrame->Iconize( false );
410 
411  draw3DFrame->Raise();
412  draw3DFrame->Show( true );
413 
414  // Raising the window does not set the focus on Linux. This should work on any platform.
415  if( wxWindow::FindFocus() != draw3DFrame )
416  draw3DFrame->SetFocus();
417 
418  return draw3DFrame;
419 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
#define _(s)
Definition: 3d_actions.cpp:33
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
Definition: eda_3d_viewer.h:65
EDA_3D_VIEWER * Get3DViewerFrame()

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

Referenced by PCB_VIEWER_TOOLS::Show3DViewer().

◆ CreateNewFootprint()

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

Function CreateNewFootprint 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 fooprint is placed on a board and a netlist is read.

Parameters
aFootprintName= name of the new footprint in library

Definition at line 1018 of file footprint_libraries_utils.cpp.

1019 {
1020  wxString footprintName = aFootprintName;
1021 
1022  // Ask for the new footprint name
1023  if( footprintName.IsEmpty() )
1024  {
1025  WX_TEXT_ENTRY_DIALOG dlg( this, _( "Enter footprint name:" ), _( "New Footprint" ),
1026  footprintName );
1027  dlg.SetTextValidator( FOOTPRINT_NAME_VALIDATOR( &footprintName ) );
1028 
1029  if( dlg.ShowModal() != wxID_OK )
1030  return NULL; //Aborted by user
1031  }
1032 
1033  footprintName.Trim( true );
1034  footprintName.Trim( false );
1035 
1036  if( footprintName.IsEmpty() )
1037  {
1038  DisplayInfoMessage( this, _( "No footprint name defined." ) );
1039  return NULL;
1040  }
1041 
1042  // Creates the new footprint and add it to the head of the linked list of footprints
1043  FOOTPRINT* footprint = new FOOTPRINT( GetBoard() );
1044 
1045  // Update parameters: timestamp ...
1046  footprint->SetLastEditTime();
1047 
1048  // Update its name in lib
1049  footprint->SetFPID( LIB_ID( wxEmptyString, footprintName ) );
1050 
1051  PCB_LAYER_ID txt_layer;
1052  wxPoint default_pos;
1054 
1055  footprint->Reference().SetText( settings.m_DefaultFPTextItems[0].m_Text );
1056  footprint->Reference().SetVisible( settings.m_DefaultFPTextItems[0].m_Visible );
1057  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[0].m_Layer;
1058  footprint->Reference().SetLayer( txt_layer );
1059  default_pos.y -= settings.GetTextSize( txt_layer ).y / 2;
1060  footprint->Reference().SetPosition( default_pos );
1061  default_pos.y += settings.GetTextSize( txt_layer ).y;
1062 
1063  footprint->Value().SetText( settings.m_DefaultFPTextItems[1].m_Text );
1064  footprint->Value().SetVisible( settings.m_DefaultFPTextItems[1].m_Visible );
1065  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[1].m_Layer;
1066  footprint->Value().SetLayer( txt_layer );
1067  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1068  footprint->Value().SetPosition( default_pos );
1069  default_pos.y += settings.GetTextSize( txt_layer ).y;
1070 
1071  for( size_t i = 2; i < settings.m_DefaultFPTextItems.size(); ++i )
1072  {
1073  FP_TEXT* textItem = new FP_TEXT( footprint );
1074  textItem->SetText( settings.m_DefaultFPTextItems[i].m_Text );
1075  textItem->SetVisible( settings.m_DefaultFPTextItems[i].m_Visible );
1076  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[i].m_Layer;
1077  textItem->SetLayer( txt_layer );
1078  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1079  textItem->SetPosition( default_pos );
1080  default_pos.y += settings.GetTextSize( txt_layer ).y;
1081  footprint->GraphicalItems().push_back( textItem );
1082  }
1083 
1084  if( footprint->GetReference().IsEmpty() )
1085  footprint->SetReference( footprintName );
1086 
1087  if( footprint->GetValue().IsEmpty() )
1088  footprint->SetValue( footprintName );
1089 
1090  footprint->RunOnChildren(
1091  [&] ( BOARD_ITEM* aChild )
1092  {
1093  if( aChild->Type() == PCB_FP_TEXT_T )
1094  {
1095  FP_TEXT* textItem = static_cast<FP_TEXT*>( aChild );
1096  PCB_LAYER_ID layer = textItem->GetLayer();
1097 
1098  textItem->SetTextThickness( settings.GetTextThickness( layer ) );
1099  textItem->SetTextSize( settings.GetTextSize( layer ) );
1100  textItem->SetItalic( settings.GetTextItalic( layer ) );
1101  textItem->SetKeepUpright( settings.GetTextUpright( layer ) );
1102  }
1103  } );
1104 
1105  SetMsgPanel( footprint );
1106  return footprint;
1107 }
void SetReference(const wxString &aReference)
Function SetReference.
Definition: footprint.h:450
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Returns the BOARD_DESIGN_SETTINGS for the open project Overloaded in FOOTPRINT_EDIT_FRAME.
std::vector< TEXT_ITEM_INFO > m_DefaultFPTextItems
class FP_TEXT, text in a footprint
Definition: typeinfo.h:93
virtual void SetPosition(const wxPoint &aPos) override
Definition: fp_text.h:91
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
Definition: board_item.h:206
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
const wxString GetValue() const
Function GetValue.
Definition: footprint.h:465
void SetItalic(bool isItalic)
Definition: eda_text.h:185
A KICAD version of wxTextEntryDialog which supports the various improvments/work-arounds from DIALOG_...
void SetVisible(bool aVisible)
Definition: eda_text.h:191
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:244
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
Function GetTextThickness Returns the default text thickness from the layer class for the given layer...
FP_TEXT & Value()
read/write accessors:
Definition: footprint.h:480
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:481
bool GetTextItalic(PCB_LAYER_ID aLayer) const
PCB_LAYER_ID
A quick note on layer IDs:
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:121
#define NULL
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
DRAWINGS & GraphicalItems()
Definition: footprint.h:185
const wxString GetReference() const
Function GetReference.
Definition: footprint.h:440
void SetValue(const wxString &aValue)
Function SetValue.
Definition: footprint.h:474
void SetFPID(const LIB_ID &aFPID)
Definition: footprint.h:209
void SetKeepUpright(bool aKeepUpright)
Definition: fp_text.h:113
#define _(s)
Definition: 3d_actions.cpp:33
void SetLastEditTime(timestamp_t aTime)
Definition: footprint.h:344
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction) const
Function RunOnChildren.
Definition: footprint.cpp:1089
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.h:164
BOARD * GetBoard() const
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:268
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
Definition: board_item.h:185
wxSize GetTextSize(PCB_LAYER_ID aLayer) const
Function GetTextSize Returns the default text size from the layer class for the given layer.
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181
BOARD_DESIGN_SETTINGS contains 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, NULL, 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_TOOLS::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 inital path and filename shown in the file chooser dialog
Returns
wxString - the newly created library path if library was successfully created, else wxEmptyString because user aborted or error.

Definition at line 371 of file footprint_libraries_utils.cpp.

373 {
374  // Kicad cannot write legacy format libraries, only .pretty new format
375  // because the legacy format cannot handle current features.
376  // The footprint library is actually a directory
377 
378  wxString initialPath = aProposedName.IsEmpty() ? Prj().GetProjectPath() : aProposedName;
379  wxFileName fn;
380  bool doAdd = false;
381 
382  if( aLibName.IsEmpty() )
383  {
384  fn = initialPath;
385 
386  if( !LibraryFileBrowser( false, fn,
388  {
389  return wxEmptyString;
390  }
391 
392  doAdd = true;
393  }
394  else
395  {
396  fn = aLibName;
397 
398  if( !fn.IsAbsolute() )
399  {
400  fn.SetName( aLibName );
401  fn.MakeAbsolute( initialPath );
402  }
403 
404  // Enforce the .pretty extension:
405  fn.SetExt( KiCadFootprintLibPathExtension );
406  }
407 
408  // We can save fp libs only using IO_MGR::KICAD_SEXP format (.pretty libraries)
410  wxString libPath = fn.GetFullPath();
411 
412  try
413  {
414  PLUGIN::RELEASER pi( IO_MGR::PluginFind( piType ) );
415 
416  bool writable = false;
417  bool exists = false;
418 
419  try
420  {
421  writable = pi->IsFootprintLibWritable( libPath );
422  exists = true; // no exception was thrown, lib must exist.
423  }
424  catch( const IO_ERROR& )
425  { }
426 
427  if( exists )
428  {
429  if( !writable )
430  {
431  wxString msg = wxString::Format( _( "Library \"%s\" is read only." ), libPath );
432  ShowInfoBarError( msg );
433  return wxEmptyString;
434  }
435  else
436  {
437  wxString msg = wxString::Format( _( "Library %s already exists." ), libPath );
438  KIDIALOG dlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
439  dlg.SetOKLabel( _( "Overwrite" ) );
440  dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
441 
442  if( dlg.ShowModal() == wxID_CANCEL )
443  return wxEmptyString;
444 
445  pi->FootprintLibDelete( libPath );
446  }
447  }
448 
449  pi->FootprintLibCreate( libPath );
450  }
451  catch( const IO_ERROR& ioe )
452  {
453  DisplayError( this, ioe.What() );
454  return wxEmptyString;
455  }
456 
457  if( doAdd )
458  AddLibrary( libPath );
459 
460  return libPath;
461 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
Definition: confirm.h:44
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:122
RELEASER releases a PLUGIN in the context of a potential thrown exception, through its destructor.
Definition: io_mgr.h:575
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
bool AddLibrary(const wxString &aLibName=wxEmptyString)
Function AddLibrary Add an existing library to either the global or project library table.
bool LibraryFileBrowser(bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
void ShowInfoBarError(const wxString &aErrorMsg)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
wxString KiCadFootprintLibPathWildcard()
#define _(s)
Definition: 3d_actions.cpp:33
static PLUGIN * PluginFind(PCB_FILE_T aFileType)
Function PluginFind returns a PLUGIN which the caller can use to import, export, save,...
Definition: io_mgr.cpp:57
PCB_FILE_T
Enum PCB_FILE_T is a set of file types that the IO_MGR knows about, and for which there has been a pl...
Definition: io_mgr.h:54
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
const std::string KiCadFootprintLibPathExtension
S-expression Pcbnew file format.
Definition: io_mgr.h:57

References _, PCB_BASE_EDIT_FRAME::AddLibrary(), DisplayError(), KIDIALOG::DoNotShowCheckbox(), Format(), PROJECT::GetProjectPath(), 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_EDIT_FRAME::ExportFootprintsToLibrary().

◆ CreateServer()

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

Definition at line 48 of file eda_dde.cpp.

49 {
50  wxIPV4address addr;
51 
52  // Set the port number
53  addr.Service( service );
54 
55  // Listen on localhost only if requested
56  if( local )
57  addr.Hostname( HOSTNAME );
58 
59  delete m_socketServer;
60  m_socketServer = new wxSocketServer( addr );
61 
62  m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
63  m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
64  m_socketServer->Notify( true );
65 }
static const wxString HOSTNAME(wxT("localhost"))
wxSocketServer * m_socketServer

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

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

◆ CurrentToolName()

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

Definition at line 99 of file tools_holder.cpp.

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

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

Referenced by TOOL_MANAGER::processEvent().

◆ DeleteFootprintFromLibrary()

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

Delete the given footprint from its library.

Definition at line 554 of file footprint_libraries_utils.cpp.

555 {
556  if( !aFPID.IsValid() )
557  return false;
558 
559  wxString nickname = aFPID.GetLibNickname();
560  wxString fpname = aFPID.GetLibItemName();
561 
562  // Legacy libraries are readable, but modifying legacy format is not allowed
563  // So prompt the user if he try to delete a footprint from a legacy lib
564  wxString libfullname = Prj().PcbFootprintLibs()->FindRow( nickname )->GetFullURI();
565 
566  if( IO_MGR::GuessPluginTypeFromLibPath( libfullname ) == IO_MGR::LEGACY )
567  {
569  return false;
570  }
571 
572  if( !Prj().PcbFootprintLibs()->IsFootprintLibWritable( nickname ) )
573  {
574  wxString msg = wxString::Format( _( "Library '%s' is read only." ), nickname );
575  ShowInfoBarError( msg );
576  return false;
577  }
578 
579  // Confirmation
580  wxString msg = wxString::Format( _( "Delete footprint '%s' from library '%s'?" ),
581  fpname.GetData(),
582  nickname.GetData() );
583 
584  if( aConfirm && !IsOK( this, msg ) )
585  return false;
586 
587  try
588  {
589  Prj().PcbFootprintLibs()->FootprintDelete( nickname, fpname );
590  }
591  catch( const IO_ERROR& ioe )
592  {
593  DisplayError( this, ioe.What() );
594  return false;
595  }
596 
597  msg.Printf( _( "Footprint '%s' deleted from library '%s'" ),
598  fpname.GetData(),
599  nickname.GetData() );
600 
601  SetStatusText( msg );
602 
603  return true;
604 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
bool IsValid() const
Definition: lib_id.h:171
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath)
Function GuessPluginTypeFromLibPath returns a plugin type given a footprint library's libPath.
Definition: io_mgr.cpp:123
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...
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
void ShowInfoBarError(const wxString &aErrorMsg)
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:284
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
Legacy Pcbnew file formats prior to s-expression.
Definition: io_mgr.h:56
#define _(s)
Definition: 3d_actions.cpp:33
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)
Function FootprintDelete.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:268
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:284

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

162 {
163  m_modal_ret_val = aRetVal;
164  m_modal_string = aResult;
165 
166  if( m_modal_loop )
167  {
168  m_modal_loop->Exit();
169  m_modal_loop = 0; // this marks it as dismissed.
170  }
171 
172  Show( false );
173 }
bool m_modal_ret_val
Definition: kiway_player.h:207
wxString m_modal_string
Definition: kiway_player.h:206
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:204

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

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

◆ DisplayGridMsg()

void PCB_BASE_FRAME::DisplayGridMsg ( )
overridevirtualinherited

Function DisplayGridMsg()

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 493 of file pcb_base_frame.cpp.

494 {
495  wxString line;
496 
497  line.Printf( "grid X %s Y %s",
498  MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x ),
499  MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().y ) );
500 
501  SetStatusText( line, 4 );
502 }
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Definition: base_units.cpp:123
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_UNITS m_userUnits

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

474 {
475  SetStatusText( msg, 6 );
476 }

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane in the status bar.

Definition at line 490 of file eda_draw_frame.cpp.

491 {
492  wxString msg;
493 
494  switch( m_userUnits )
495  {
496  case EDA_UNITS::INCHES: msg = _( "inches" ); break;
497  case EDA_UNITS::MILS: msg = _( "mils" ); break;
498  case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
499  default: msg = _( "Units" ); break;
500  }
501 
502  SetStatusText( msg, 5 );
503 }
#define _(s)
Definition: 3d_actions.cpp:33
EDA_UNITS m_userUnits

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

Definition at line 272 of file eda_base_frame.cpp.

273 {
274  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
275 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void FOOTPRINT_EDIT_FRAME::doCloseWindow ( )
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 614 of file footprint_edit_frame.cpp.

615 {
616  // No more vetos
618  GetCanvas()->StopDrawing();
619 
620  // Do not show the layer manager during closing to avoid flicker
621  // on some platforms (Windows) that generate useless redraw of items in
622  // the Layer Manger
623  m_auimgr.GetPane( "LayersManager" ).Show( false );
624  m_auimgr.GetPane( "SelectionFilter" ).Show( false );
625 
626  Pgm().GetSettingsManager().FlushAndRelease( GetSettings() );
627 
628  Clear_Pcb( false );
629 }
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
wxAuiManager m_auimgr
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
bool Clear_Pcb(bool aQuery)
Delete all and reinitialize the current board.
Definition: initpcb.cpp:94
#define NULL
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools.
FOOTPRINT_EDITOR_SETTINGS * GetSettings()
void StopDrawing()
Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDraw...

References Clear_Pcb(), PCB_BASE_FRAME::GetCanvas(), GetSettings(), EDA_BASE_FRAME::m_auimgr, NULL, Pgm(), EDA_DRAW_PANEL_GAL::SetEventDispatcher(), and EDA_DRAW_PANEL_GAL::StopDrawing().

◆ editFootprintProperties()

void FOOTPRINT_EDIT_FRAME::editFootprintProperties ( FOOTPRINT aFootprint)
protected

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

Definition at line 138 of file footprint_editor_utils.cpp.

139 {
140  LIB_ID oldFPID = aFootprint->GetFPID();
141 
142  DIALOG_FOOTPRINT_FP_EDITOR dialog( this, aFootprint );
143  dialog.ShowModal();
144 
145  // Update library tree
146  BASIC_FOOTPRINT_INFO footprintInfo( aFootprint );
147  wxDataViewItem treeItem = m_adapter->FindItem( oldFPID );
148 
149  if( treeItem.IsOk() ) // Can be not found in tree if the current footprint is imported
150  // from file therefore not yet in tree.
151  {
152  static_cast<LIB_TREE_NODE_LIB_ID*>( treeItem.GetID() )->Update( &footprintInfo );
154  }
155 
156  updateTitle(); // in case of a name change...
157 
158  UpdateMsgPanel();
159 }
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:208
void RefreshLibTree()
Refreshes the tree (mainly to update highlighting and asterisking)
Definition: lib_tree.cpp:221
LIB_TREE * GetLibTree() const
void updateTitle()
Updates window title according to getLibNickName().
FOOTPRINT_TREE_PANE * m_treePane
virtual void UpdateMsgPanel()
Redraw the message panel.

References FOOTPRINT::GetFPID().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 228 of file eda_draw_frame.cpp.

229 {
230  if( m_messagePanel )
232 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:210

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

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

Subclasses should override to implement actual command handlers.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 258 of file eda_draw_frame.h.

258 {}

Referenced by EDA_DRAW_FRAME::OnSockRequest().

◆ ExportFootprint()

void FOOTPRINT_EDIT_FRAME::ExportFootprint ( FOOTPRINT aFootprint)

Create a file containing only one footprint.

Definition at line 304 of file footprint_libraries_utils.cpp.

305 {
306  wxFileName fn;
308 
309  if( !aFootprint )
310  return;
311 
312  fn.SetName( aFootprint->GetFPID().GetLibItemName() );
313 
314  wxString wildcard = KiCadFootprintLibFileWildcard();
315 
316  fn.SetExt( KiCadFootprintFileExtension );
317 
318  if( !cfg->m_LastImportExportPath.empty() )
319  fn.SetPath( cfg->m_LastImportExportPath );
320  else
321  fn.SetPath( m_mruPath );
322 
323  wxFileDialog dlg( this, _( "Export Footprint" ), fn.GetPath(), fn.GetFullName(),
324  wildcard, wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
325 
326  if( dlg.ShowModal() == wxID_CANCEL )
327  return;
328 
329  fn = dlg.GetPath();
330  cfg->m_LastImportExportPath = fn.GetPath();
331 
332  try
333  {
334  // Export as *.kicad_pcb format, using a strategy which is specifically chosen
335  // as an example on how it could also be used to send it to the system clipboard.
336 
337  PCB_IO pcb_io( CTL_FOR_LIBRARY );
338 
339  /* This footprint should *already* be "normalized" in a way such that
340  orientation is zero, etc., since it came from the Footprint Editor.
341 
342  aFootprint->SetParent( 0 );
343  aFootprint->SetOrientation( 0 );
344  */
345 
346  pcb_io.Format( aFootprint );
347 
348  FILE* fp = wxFopen( dlg.GetPath(), wxT( "wt" ) );
349 
350  if( fp == NULL )
351  {
352  wxMessageBox( wxString::Format( _( "Unable to create or write file \"%s\"" ),
353  dlg.GetPath() ) );
354  return;
355  }
356 
357  fprintf( fp, "%s", pcb_io.GetStringOutput( false ).c_str() );
358  fclose( fp );
359  }
360  catch( const IO_ERROR& ioe )
361  {
362  DisplayError( this, ioe.What() );
363  return;
364  }
365 
366  wxString msg = wxString::Format( _( "Footprint exported to file \"%s\"" ), dlg.GetPath() );
367  DisplayInfoMessage( this, msg );
368 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
PCB_IO is 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.
#define NULL
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
const LIB_ID & GetFPID() const
Definition: footprint.h:208
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
FOOTPRINT_EDITOR_SETTINGS * GetSettings()
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:268
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
wxString KiCadFootprintLibFileWildcard()

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

Referenced by FOOTPRINT_EDITOR_TOOLS::ExportFootprint().

◆ FocusOnItem()

void PCB_BASE_FRAME::FocusOnItem ( BOARD_ITEM aItem)
inherited

Definition at line 182 of file pcb_base_frame.cpp.

183 {
184  static KIID lastBrightenedItemID( niluuid );
185 
186  BOARD_ITEM* lastItem = GetBoard()->GetItem( lastBrightenedItemID );
187 
188  if( lastItem && lastItem != aItem && lastItem != DELETED_BOARD_ITEM::GetInstance() )
189  {
190  lastItem->ClearBrightened();
191 
192  if( lastItem->Type() == PCB_FOOTPRINT_T )
193  {
194  static_cast<FOOTPRINT*>( lastItem )->RunOnChildren(
195  [&]( BOARD_ITEM* child )
196  {
197  child->ClearBrightened();
198  } );
199  }
200  else if( lastItem->Type() == PCB_GROUP_T )
201  {
202  static_cast<PCB_GROUP*>( lastItem )->RunOnChildren(
203  [&]( BOARD_ITEM* child )
204  {
205  child->ClearBrightened();
206  } );
207  }
208 
209  GetCanvas()->GetView()->Update( lastItem );
210  lastBrightenedItemID = niluuid;
211  GetCanvas()->Refresh();
212  }
213 
214  if( aItem )
215  {
216  aItem->SetBrightened();
217 
218  if( aItem->Type() == PCB_FOOTPRINT_T )
219  {
220  static_cast<FOOTPRINT*>( aItem )->RunOnChildren(
221  [&]( BOARD_ITEM* child )
222  {
223  child->SetBrightened();
224  });
225  }
226  else if( aItem->Type() == PCB_GROUP_T )
227  {
228  static_cast<PCB_GROUP*>( aItem )->RunOnChildren(
229  [&]( BOARD_ITEM* child )
230  {
231  child->SetBrightened();
232  });
233  }
234 
235  GetCanvas()->GetView()->Update( aItem );
236  lastBrightenedItemID = aItem->m_Uuid;
237  FocusOnLocation( aItem->GetFocusPosition() );
238  GetCanvas()->Refresh();
239  }
240 }
BOARD_ITEM * GetItem(const KIID &aID) const
Definition: board.cpp:761
KIID niluuid(0)
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:109
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual const wxPoint GetFocusPosition() const
Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rath...
Definition: eda_item.h:333
void SetBrightened()
Definition: eda_item.h:197
void ClearBrightened()
Definition: eda_item.h:200
Definition: kiid.h:44
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: pcb_view.cpp:94
static DELETED_BOARD_ITEM * GetInstance()
Definition: board_item.h:411
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
class FOOTPRINT, a footprint
Definition: typeinfo.h:89
const KIID m_Uuid
Definition: eda_item.h:151
BOARD * GetBoard() const
void FocusOnLocation(const wxPoint &aPos)
Useful to focus on a particular location, in find functions Move the graphic cursor (crosshair cursor...
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

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 SELECTION_TOOL::Main(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_GROUP_PROPERTIES::OnMemberSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), and DIALOG_DRC::~DIALOG_DRC().

◆ FocusOnLibID()

void FOOTPRINT_EDIT_FRAME::FocusOnLibID ( const LIB_ID aLibID)

Definition at line 860 of file footprint_edit_frame.cpp.

861 {
862  m_treePane->GetLibTree()->SelectLibId( aLibID );
863 }
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:180

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

Referenced by FOOTPRINT_EDITOR_TOOLS::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 780 of file eda_draw_frame.cpp.

781 {
782  bool centerView = false;
783  BOX2D r = GetCanvas()->GetView()->GetViewport();
784 
785  // Center if we're off the current view, or within 10% of its edge
786  r.Inflate( - (int) r.GetWidth() / 10 );
787 
788  if( !r.Contains( aPos ) )
789  centerView = true;
790 
791  // Center if we're behind an obscuring dialog, or within 10% of its edge
792  wxWindow* dialog = findDialog( GetChildren() );
793 
794  if( dialog )
795  {
796  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
797  dialog->GetSize() );
798  dialogRect.Inflate( dialogRect.GetWidth() / 10 );
799 
800  if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
801  centerView = true;
802  }
803 
804  if( centerView )
805  {
806  // If a dialog partly obscures the window, then center on the uncovered area.
807  if( dialog )
808  {
809  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
810  dialog->GetSize() );
811  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
812  }
813  else
814  GetCanvas()->GetView()->SetCenter( aPos );
815  }
816 
818 }
BOX2D GetViewport() const
Function GetViewport() Returns the current viewport visible area rectangle.
Definition: view.cpp:519
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns 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)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:585
coord_type GetWidth() const
Definition: box2.h:197
bool Contains(const Vec &aPoint) const
Function Contains.
Definition: box2.h:151
wxWindow * findDialog(wxWindowList &aList)
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Moves the graphic crosshair cursor to the requested position expressed in world coordinates.
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:302

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 SELECTION_TOOL::findCallback(), SCH_EDITOR_CONTROL::FindNext(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), and DIALOG_FIND::search().

◆ Get3DViewerFrame()

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

Definition at line 75 of file pcb_base_frame.cpp.

76 {
77  return dynamic_cast<EDA_3D_VIEWER*>( FindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( this ) ) );
78 }
#define QUALIFIED_VIEWER3D_FRAMENAME(parent)
Definition: eda_3d_viewer.h:51

References QUALIFIED_VIEWER3D_FRAMENAME.

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

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

Definition at line 554 of file eda_base_frame.h.

554 { return m_aboutTitle; }
wxString m_aboutTitle

References EDA_BASE_FRAME::m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), and COMMON_CONTROL::ReportBug().

◆ GetActiveLayer()

virtual PCB_LAYER_ID PCB_BASE_FRAME::GetActiveLayer ( ) const
inlinevirtualinherited

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )
inlinestaticprotectedinherited
Returns
the string to prepend to a file name for automatic save.

Definition at line 187 of file eda_base_frame.h.

188  {
189  return wxT( "_autosave-" );
190  }

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::OnExportSTEP(), SCH_EDIT_FRAME::SaveEEFile(), and PCB_EDIT_FRAME::SavePcbFile().

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 315 of file eda_base_frame.h.

315 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetAutoZoom()

virtual bool PCB_BASE_FRAME::GetAutoZoom ( )
inlinevirtualinherited

Always returns false.

Should be overriden in derived classes which support autozoom.

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 433 of file pcb_base_frame.h.

433 { return false; }

◆ GetAuxOrigin()

const wxPoint & PCB_BASE_FRAME::GetAuxOrigin ( ) const
inherited

Definition at line 279 of file pcb_base_frame.cpp.

280 {
282 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:559
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().

◆ GetBackupSuffix()

static wxString EDA_BASE_FRAME::GetBackupSuffix ( )
inlinestaticprotectedinherited
Returns
the suffix to be appended to the file extension on backup

Definition at line 179 of file eda_base_frame.h.

180  {
181  return wxT( "-bak" );
182  }

◆ GetBoard()

BOARD* PCB_BASE_FRAME::GetBoard ( ) const
inlineinherited

Definition at line 226 of file pcb_base_frame.h.

227  {
228  wxASSERT( m_pcb );
229  return m_pcb;
230  }

References PCB_BASE_FRAME::m_pcb.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), DIALOG_PLOT::applyPlotSettings(), GRID_CELL_LAYER_SELECTOR::BeginEdit(), DIALOG_COPPER_ZONE::buildAvailableListOfNets(), DIALOG_BOARD_REANNOTATE::BuildFootprintList(), canCloseWindow(), FOOTPRINT_EDITOR_TOOLS::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(), 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_TOOLS::CutCopyFootprint(), PCBNEW_CONTROL::DeleteItemCursor(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), 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_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), PCB_EDIT_FRAME::DoGenFootprintsReport(), ROUTER_TOOL::DpDimensionsDialog(), GRID_CELL_LAYER_RENDERER::Draw(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Edit_Zone_Params(), VIA_SIZE_MENU::eventHandler(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_EDITOR_TOOLS::ExportFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), DIALOG_COPPER_ZONE::ExportSetupToOtherCopperZones(), PCB_EDITOR_CONTROL::ExportSpecctraDSN(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::fixEagleNets(), PCB_BASE_FRAME::FocusOnItem(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_EDIT_FRAME::GenD356File(), PCB_EDIT_FRAME::GenFootprintsReport(), GetBoard(), EDA_3D_VIEWER::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(), FOOTPRINT_VIEWER_FRAME::GetModel(), GetModel(), DISPLAY_FOOTPRINTS_FRAME::GetModel(), FOOTPRINT_WIZARD_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(), PCB_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), ImportFootprint(), PCB_EDITOR_CONTROL::ImportSpecctraSession(), EDIT_TOOL::Init(), DIALOG_PLOT::init_Dialog(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PCB_INSPECTION_TOOL::InspectClearance(), PCB_INSPECTION_TOOL::InspectConstraints(), 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_NETLIST::OnCompileRatsnestClick(), 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(), APPEARANCE_CONTROLS::onNetclassContextMenu(), 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(), OnUpdateModuleSelected(), OnUpdateSaveFootprintToBoard(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), PANEL_SETUP_FEATURE_CONSTRAINTS::PANEL_SETUP_FEATURE_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(), PCBNEW_CONTROL::Paste(), DIALOG_UPDATE_PCB::PerformUpdate(), DRAWING_TOOL::PlaceImportedGraphics(), DIALOG_PLOT::Plot(), CONVERT_TOOL::PolyToLines(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingFootprints(), FOOTPRINT_EDITOR_TOOLS::Properties(), 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(), PCB_INSPECTION_TOOL::reportClearance(), DRC_TOOL::Reset(), 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::SelectLayer(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), DIALOG_PLOT::SetPlotFormat(), VECTOR_DRC_ITEMS_PROVIDER::SetSeverities(), ZONE_SETTINGS::SetupLayersList(), setupTools(), setupUIConditions(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), APPEARANCE_CONTROLS::showNetclass(), GLOBAL_EDIT_TOOL::SwapLayers(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_UNUSED_PAD_LAYERS::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_SWAP_LAYERS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::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(), PCBNEW_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

Function GetBoardBoundingBox calculates the bounding box containing all board items (or board edge segments).

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

Definition at line 356 of file pcb_base_frame.cpp.

357 {
358  EDA_RECT area = aBoardEdgesOnly ? m_pcb->GetBoardEdgesBoundingBox() : m_pcb->GetBoundingBox();
359 
360  if( area.GetWidth() == 0 && area.GetHeight() == 0 )
361  {
362  wxSize pageSize = GetPageSizeIU();
363 
365  {
366  area.SetOrigin( 0, 0 );
367  area.SetEnd( pageSize.x, pageSize.y );
368  }
369  else
370  {
371  area.SetOrigin( -pageSize.x / 2, -pageSize.y / 2 );
372  area.SetEnd( pageSize.x / 2, pageSize.y / 2 );
373  }
374  }
375 
376  return area;
377 }
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: board.h:763
const EDA_RECT GetBoardEdgesBoundingBox() const
Returns the board bounding box calculated using exclusively the board edges (graphics on Edge....
Definition: board.h:777
int GetWidth() const
Definition: eda_rect.h:119
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:131
bool m_showBorderAndTitleBlock
void SetEnd(int x, int y)
Definition: eda_rect.h:192
int GetHeight() const
Definition: eda_rect.h:120
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
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 727 of file pcb_base_frame.cpp.

728 {
729  return static_cast<PCB_DRAW_PANEL_GAL*>( EDA_DRAW_FRAME::GetCanvas() );
730 }
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 DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), 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_VIEWER_FRAME::ClickOnLibList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), DIALOG_PRINT_PCBNEW::createPrintout(), 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(), PCB_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(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SELECTION_TOOL::findCallback(), ROUTER_TOOL::finishInteractive(), PCB_EDITOR_CONTROL::FlipPcbView(), PCB_BASE_FRAME::FocusOnItem(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetCollectorsGuide(), APPEARANCE_CONTROLS::getVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), HardRedraw(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), ROUTER_TOOL::InlineDrag(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_BASE_FRAME::LoadSettings(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), DIALOG_FOOTPRINT_CHECKER::OnDeleteAllClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), 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_NET_INSPECTOR::onRenameNet(), DIALOG_NET_INSPECTOR::onSelChanged(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_NET_INSPECTOR::onSortingChanged(), FOOTPRINT_TREE_PANE::onUpdateUI(), PCB_EDIT_FRAME::OpenProjectFiles(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDITOR_TOOLS::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(), DIALOG_DRC::refreshBoardEditor(), refreshCallback(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), 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(), SELECTION_TOOL::SelectAll(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SELECTION_TOOL::selectMultiple(), DRAWING_TOOL::SetAnchor(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetDisplayOptions(), POINT_EDITOR::setEditedPoint(), APPEARANCE_CONTROLS::SetLayerVisible(), APPEARANCE_CONTROLS::SetObjectVisible(), setupTools(), 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_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::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(), SELECTION_TOOL::zoomFitSelection(), 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

Function GetCollectorsGuide.

Returns
GENERAL_COLLECTORS_GUIDE - that considers the global configuration options.

Definition at line 465 of file pcb_base_frame.cpp.

466 {
468  GetCanvas()->GetView() );
469 
470  // account for the globals
472  guide.SetIgnoreMTextsOnBack( ! m_pcb->IsElementVisible( LAYER_MOD_TEXT_BK ) );
473  guide.SetIgnoreMTextsOnFront( ! m_pcb->IsElementVisible( LAYER_MOD_TEXT_FR ) );
474  guide.SetIgnoreModulesOnBack( ! m_pcb->IsElementVisible( LAYER_MOD_BK ) );
475  guide.SetIgnoreModulesOnFront( ! m_pcb->IsElementVisible( LAYER_MOD_FR ) );
476  guide.SetIgnorePadsOnBack( ! m_pcb->IsElementVisible( LAYER_PAD_BK ) );
477  guide.SetIgnorePadsOnFront( ! m_pcb->IsElementVisible( LAYER_PAD_FR ) );
478  guide.SetIgnoreThroughHolePads( ! m_pcb->IsElementVisible( LAYER_PADS_TH ) );
479  guide.SetIgnoreModulesVals( ! m_pcb->IsElementVisible( LAYER_MOD_VALUES ) );
480  guide.SetIgnoreModulesRefs( ! m_pcb->IsElementVisible( LAYER_MOD_REFERENCES ) );
481  guide.SetIgnoreThroughVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
482  guide.SetIgnoreBlindBuriedVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
483  guide.SetIgnoreMicroVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
484  guide.SetIgnoreTracks( ! m_pcb->IsElementVisible( LAYER_TRACKS ) );
485 
486  return guide;
487 }
multilayer pads, usually with holes
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
show footprints on back
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings Returns a bit-mask of all t...
Definition: board.cpp:451
show footprints values (when texts are visibles)
show footprints on front
virtual PCB_LAYER_ID GetActiveLayer() const
void SetIgnoreMTextsMarkedNoShow(bool ignore)
Definition: collectors.h:532
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns 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:497
smd pads, front layer
Meta control for all vias opacity/visibility.
A general implementation of a COLLECTORS_GUIDE.
Definition: collectors.h:376
show footprints references (when texts are visibles)

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 PCBNEW_CONTROL::DeleteItemCursor(), PAD_TOOL::EnumeratePads(), and PCB_INSPECTION_TOOL::highlightNet().

◆ GetColorSettings()

COLOR_SETTINGS * FOOTPRINT_EDIT_FRAME::GetColorSettings ( )
overridevirtual

Helper to retrieve the current color settings.

Returns
a pointer to the active COLOR_SETTINGS

Reimplemented from PCB_BASE_FRAME.

Definition at line 533 of file footprint_edit_frame.cpp.

534 {
535  return Pgm().GetSettingsManager().GetColorSettings(
536  GetFootprintEditorSettings()->m_ColorTheme );
537 }
FOOTPRINT_EDITOR_SETTINGS * GetFootprintEditorSettings()
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102

References PCB_BASE_FRAME::GetFootprintEditorSettings(), 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 485 of file eda_base_frame.h.

485 { 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 311 of file footprint_edit_frame.cpp.

312 {
313  return m_toolManager->GetTool<SELECTION_TOOL>()->GetSelection();
314 }
SELECTION_TOOL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48

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

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

Note that there is no guarantee that this file actually exists and can be opened! NOTE: only really makes sense from PcbNew, but is needed in PCB_BASE_EDIT_FRAME::SetBoard

Definition at line 220 of file pcb_base_edit_frame.cpp.

221 {
222  if( !GetBoard() )
223  return wxEmptyString;
224 
225  wxFileName fn = GetBoard()->GetFileName();
226  fn.SetExt( DesignRulesFileExtension );
227  return Prj().AbsolutePath( fn.GetFullName() );
228 }
const std::string DesignRulesFileExtension
const wxString & GetFileName() const
Definition: board.h:278
VTBL_ENTRY const wxString AbsolutePath(const wxString &aFileName) const
Function AbsolutePath fixes up aFileName if it is relative to the project's directory to be an absolu...
Definition: project.cpp:270
PROJECT & Prj() const
Function Prj returns 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 PCB_INSPECTION_TOOL::InspectConstraints(), DIALOG_DRC::OnRunDRCClick(), PCB_INSPECTION_TOOL::reportClearance(), DRC_TOOL::Reset(), 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 471 of file footprint_edit_frame.cpp.

472 {
473  return GetBoard()->GetDesignSettings();
474 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:559
BOARD * GetBoard() const

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

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

◆ GetDisplayOptions()

const PCB_DISPLAY_OPTIONS& PCB_BASE_FRAME::GetDisplayOptions ( ) const
inlineinherited

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

Definition at line 204 of file pcb_base_frame.h.

204 { return m_displayOptions; }
PCB_DISPLAY_OPTIONS m_displayOptions

References PCB_BASE_FRAME::m_displayOptions.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), BOARD_NETLIST_UPDATER::addNewComponent(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), PCB_VIEWER_TOOLS::displayOptions(), PCB_TOOL_BASE::displayOptions(), PAD_TOOL::EditPad(), PCB_BASE_FRAME::GetUserOrigin(), PCB_EDITOR_CONDITIONS::graphicsFillDisplayFunc(), 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(), PCB_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::SaveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), SELECTION_TOOL::selectPoint(), setupUIConditions(), 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 worksheet border. It's passed false by "Zoom To Objects" to ignore worksheet border. In Pcbnew, false makes it ignore any items outside the PCB edge such as fabrication notes.

Parameters
aIncludeAllVisible- True = Include everything visible in bbox calculations False = Ignore some visible items (program dependent)
Returns
BOX2I - Bounding box of document (ignoring some items as requested)

Reimplemented from PCB_BASE_FRAME.

Definition at line 549 of file footprint_edit_frame.cpp.

550 {
551  FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
552 
553  if( footprint )
554  {
555  bool hasGraphicalItem = footprint->Pads().size() || footprint->Zones().size();
556 
557  if( !hasGraphicalItem )
558  {
559  for( const BOARD_ITEM* item : footprint->GraphicalItems() )
560  {
561  if( item->Type() == PCB_FP_TEXT_T )
562  continue;
563 
564  hasGraphicalItem = true;
565  break;
566  }
567  }
568 
569  if( hasGraphicalItem )
570  {
571  return footprint->GetFootprintRect();
572  }
573  else
574  {
575  BOX2I newFootprintBB( { 0, 0 }, { 0, 0 } );
576  newFootprintBB.Inflate( Millimeter2iu( 12 ) );
577  return newFootprintBB;
578  }
579  }
580 
581  return GetBoardBoundingBox( false );
582 }
class FP_TEXT, text in a footprint
Definition: typeinfo.h:93
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
BOX2 handles a 2-D bounding box, built on top of an origin point and size vector, both of templated c...
Definition: box2.h:43
PADS & Pads()
Definition: footprint.h:182
EDA_RECT GetFootprintRect() const
Function GetFootprintRect() Build and returns the boundary box of the footprint excluding any text.
Definition: footprint.cpp:579
FP_ZONES & Zones()
Definition: footprint.h:188
FOOTPRINT * GetFirstFootprint() const
Gets the first footprint on the board or nullptr.
Definition: board.h:348
EDA_RECT GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Function GetBoardBoundingBox calculates the bounding box containing all board items (or board edge se...
DRAWINGS & GraphicalItems()
Definition: footprint.h:185
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:302
BOARD * GetBoard() const
static constexpr int Millimeter2iu(double mm)

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

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

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

147 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:61

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragSelects()

bool TOOLS_HOLDER::GetDragSelects ( ) const
inlineinherited

Indicates that a drag should draw a selection rectangle, even when started over an item.

Definition at line 153 of file tools_holder.h.

153 { return m_dragSelects; }
bool m_dragSelects
Definition: tools_holder.h:65

References TOOLS_HOLDER::m_dragSelects.

Referenced by PL_SELECTION_TOOL::Main(), and EE_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 init 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 725 of file eda_base_frame.cpp.

727 {
728  if( !aFileHistory )
729  aFileHistory = m_fileHistory;
730 
731  wxASSERT( aFileHistory );
732 
733  int baseId = aFileHistory->GetBaseId();
734 
735  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
736 
737  unsigned i = cmdId - baseId;
738 
739  if( i < aFileHistory->GetCount() )
740  {
741  wxString fn = aFileHistory->GetHistoryFile( i );
742 
743  if( wxFileName::FileExists( fn ) )
744  return fn;
745  else
746  {
747  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
748  wxMessageBox( msg );
749 
750  aFileHistory->RemoveFileFromHistory( i );
751  }
752  }
753 
754  // Update the menubar to update the file history menu
755  if( GetMenuBar() )
756  {
757  ReCreateMenuBar();
758  GetMenuBar()->Refresh();
759  }
760 
761  return wxEmptyString;
762 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

References _, 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 470 of file eda_base_frame.h.

471  {
472  return *m_fileHistory;
473  }
FILE_HISTORY * m_fileHistory

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

Definition at line 167 of file eda_draw_frame.h.

167 { return m_findStringHistoryList; }
wxArrayString m_findStringHistoryList

References EDA_DRAW_FRAME::m_findStringHistoryList.

Referenced by DIALOG_FIND::DIALOG_FIND(), and DIALOG_FIND::search().

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )
inlineinherited

Definition at line 166 of file eda_draw_frame.h.

166 { return *m_findReplaceData; }
wxFindReplaceData * m_findReplaceData

References EDA_DRAW_FRAME::m_findReplaceData.

Referenced by DIALOG_FIND::search().

◆ GetFootprintEditorFrameName()

const wxChar * FOOTPRINT_EDIT_FRAME::GetFootprintEditorFrameName ( )
static

Function GetFootprintEditorFrameName (static)

Returns
the frame name used when creating the frame used to get a reference to this frame, if exists

Definition at line 465 of file footprint_edit_frame.cpp.

466 {
468 }
#define FOOTPRINT_EDIT_FRAME_NAME

References FOOTPRINT_EDIT_FRAME_NAME.

◆ GetFootprintEditorSettings()

FOOTPRINT_EDITOR_SETTINGS * PCB_BASE_FRAME::GetFootprintEditorSettings ( )
inherited

Definition at line 688 of file pcb_base_frame.cpp.

689 {
690  return Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
691 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102

References Pgm().

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

◆ GetFootprintFromBoardByReference()

FOOTPRINT * PCB_BASE_FRAME::GetFootprintFromBoardByReference ( )
inherited

Function GetFootprintFromBoardByReference.

Returns
a reference to the footprint found by its refence on the curent board. The reference is entered by the user from a dialog (by awxTextCtlr, or a list of available references)

Definition at line 428 of file load_select_footprint.cpp.

429 {
430  wxString footprintName;
431  wxArrayString fplist;
432 
433  // Build list of available fp references, to display them in dialog
434  for( auto fp : GetBoard()->Footprints() )
435  fplist.Add( fp->GetReference() + wxT(" ( ") + fp->GetValue() + wxT(" )") );
436 
437  fplist.Sort();
438 
439  DIALOG_GET_FOOTPRINT_BY_NAME dlg( this, fplist );
440 
441  if( dlg.ShowModal() != wxID_OK ) //Aborted by user
442  return NULL;
443 
444  footprintName = dlg.GetValue();
445  footprintName.Trim( true );
446  footprintName.Trim( false );
447 
448  if( !footprintName.IsEmpty() )
449  {
450  for( auto mod : GetBoard()->Footprints() )
451  {
452  if( mod->GetReference().CmpNoCase( footprintName ) == 0 )
453  return mod;
454  }
455  }
456 
457  return nullptr;
458 }
DIALOG_GET_FOOTPRINT_BY_NAME is a helper dialog to select a footprint by its reference One can enter ...
#define NULL
FOOTPRINTS & Footprints()
Definition: board.h:283
BOARD * GetBoard() const

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

◆ GetGalDisplayOptions()

◆ GetGridColor()

COLOR4D FOOTPRINT_EDIT_FRAME::GetGridColor ( )
overridevirtual
Returns
the color of the grid

Reimplemented from EDA_DRAW_FRAME.

Definition at line 221 of file footprint_editor_utils.cpp.

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

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

268 {
270 }
wxPoint m_GridOrigin
origin for grid offsets
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:559

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)
overridevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 176 of file pcb_base_frame.cpp.

177 {
178  return GetBoard()->GetItem( aId );
179 }
BOARD_ITEM * GetItem(const KIID &aID) const
Definition: board.cpp:761
BOARD * GetBoard() const

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

◆ GetLibTreeAdapter()

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

Returns the adapter object that provides the stored data.

Definition at line 175 of file footprint_edit_frame.h.

175 { 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 381 of file footprint_edit_frame.cpp.

382 {
383  FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
384 
385  if( footprint )
386  return LIB_ID( footprint->GetFPID().GetLibNickname(), m_footprintNameWhenLoaded );
387  else
388  return LIB_ID();
389 }
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
FOOTPRINT * GetFirstFootprint() const
Gets the first footprint on the board or nullptr.
Definition: board.h:348
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
const LIB_ID & GetFPID() const
Definition: footprint.h:208
BOARD * GetBoard() const

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

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

◆ GetMagneticItemsSettings()

MAGNETIC_SETTINGS * FOOTPRINT_EDIT_FRAME::GetMagneticItemsSettings ( )
overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 540 of file footprint_edit_frame.cpp.

541 {
542  // Get the actual frame settings for magnetic items
544  wxCHECK( cfg, nullptr );
545  return &cfg->m_MagneticItems;
546 }
FOOTPRINT_EDITOR_SETTINGS * GetSettings()

References GetSettings(), and FOOTPRINT_EDITOR_SETTINGS::m_MagneticItems.

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 633 of file eda_base_frame.h.

633 { 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

Implements PCB_BASE_FRAME.

Definition at line 352 of file footprint_edit_frame.cpp.

353 {
354  return GetBoard()->GetFirstFootprint();
355 }
FOOTPRINT * GetFirstFootprint() const
Gets the first footprint on the board or nullptr.
Definition: board.h:348
BOARD * GetBoard() const

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

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const
inlineinherited

Indicates that a move operation should warp the mouse pointer to the origin of the move object.

This improves snapping, but some users are alergic to mouse warping.

Definition at line 159 of file tools_holder.h.

159 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:66

References TOOLS_HOLDER::m_moveWarpsCursor.

Referenced by EDIT_TOOL::doMoveSelection(), LIB_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 nearst grid position.

Definition at line 736 of file eda_draw_frame.cpp.

737 {
738  const wxPoint& gridOrigin = GetGridOrigin();
739  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
740 
741  double xOffset = fmod( gridOrigin.x, gridSize.x );
742  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
743  double yOffset = fmod( gridOrigin.y, gridSize.y );
744  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
745 
746  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
747 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns 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
Returns 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:68

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 LIB_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), LIB_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), and SCH_DRAWING_TOOLS::sizeSheet().

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

302 {
303  return m_originTransforms;
304 }
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 252 of file pcb_base_frame.cpp.

253 {
254  return m_pcb->GetPageSettings();
255 }
const PAGE_INFO & GetPageSettings() const
Definition: board.h:574

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

Referenced by PCBNEW_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 258 of file pcb_base_frame.cpp.

259 {
260  // this function is only needed because EDA_DRAW_FRAME is not compiled
261  // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
262  // into an application specific source file.
263  return m_pcb->GetPageSettings().GetSizeIU();
264 }
const PAGE_INFO & GetPageSettings() const
Definition: board.h:574

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

Referenced by PCBNEW_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 ( )
inherited

Definition at line 682 of file pcb_base_frame.cpp.

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

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(), FOOTPRINT_VIEWER_FRAME::GetAutoZoom(), PCB_BASE_EDIT_FRAME::GetColorSettings(), DIALOG_PLOT::init_Dialog(), DIALOG_EXPORT_SVG::initDialog(), DIALOG_GENDRILL::initDialog(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_DRC::initValues(), DIALOG_BOARD_REANNOTATE::InitValues(), DIALOG_PRINT_PCBNEW::onColorModeChanged(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), DIALOG_COPPER_ZONE::OnNetSortingOptionSelected(), PNS::TOOL_BASE::Reset(), DIALOG_PRINT_PCBNEW::saveSettings(), FOOTPRINT_VIEWER_FRAME::SetAutoZoom(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataFromWindow(), PANEL_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), DIALOG_COPPER_ZONE::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

Function GetPlotSettings returns the PCB_PLOT_PARAMS for the BOARD owned by this frame.

Overloaded in FOOTPRINT_EDIT_FRAME.

Reimplemented from PCB_BASE_FRAME.

Definition at line 477 of file footprint_edit_frame.cpp.

478 {
479  wxFAIL_MSG( "Plotting not supported in Footprint Editor" );
480 
482 }
virtual const PCB_PLOT_PARAMS & GetPlotSettings() const
Function GetPlotSettings returns 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

Function GetRotationAngle() Returns the angle used for rotate operations.

Definition at line 177 of file pcb_base_edit_frame.h.

177 { return m_rotationAngle; }
int m_rotationAngle
User defined rotation angle (in tenths of a degree).

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 248 of file pcb_base_frame.h.

248 { 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_TOOLS::CreateFootprint(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), 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(), IsContentModified(), PCBNEW_CONTROL::LayerToggle(), FOOTPRINT_EDITOR_TOOLS::NewFootprint(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_BASE_FRAME::OnModify(), DIALOG_POSITION_RELATIVE::OnUseUserOriginClick(), ROUTER_TOOL::onViaCommand(), 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 876 of file eda_draw_frame.cpp.

877 {
878  // Virtual function. Base class implementation returns an empty string.
879  return wxEmptyString;
880 }

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

◆ GetSettings()

FOOTPRINT_EDITOR_SETTINGS * FOOTPRINT_EDIT_FRAME::GetSettings ( )

Definition at line 491 of file footprint_edit_frame.cpp.

492 {
493  if( !m_settings )
494  m_settings = Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
495 
496  return m_settings;
497 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
FOOTPRINT_EDITOR_SETTINGS * m_settings

References m_settings, and Pgm().

Referenced by DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), doCloseWindow(), ExportFootprint(), GetMagneticItemsSettings(), ImportFootprint(), LoadSettings(), SaveSettings(), PANEL_FP_EDITOR_DEFAULTS::TransferDataFromWindow(), and DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR().

◆ GetSettingsManager()

◆ GetSeverity()

int PCB_BASE_FRAME::GetSeverity ( int  aErrorCode) const
overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 656 of file pcb_base_frame.cpp.

657 {
658  if( aErrorCode >= CLEANUP_FIRST )
659  return RPT_SEVERITY_ACTION;
660 
662 
663  return bds.m_DRCSeverities[ aErrorCode ];
664 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:559
std::map< int, int > m_DRCSeverities
BOARD * GetBoard() const
BOARD_DESIGN_SETTINGS contains 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 181 of file eda_draw_frame.h.

181 { 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 370 of file footprint_edit_frame.cpp.

371 {
372  LIB_ID id = GetTreeFPID();
373 
374  if( id.GetLibNickname().empty() )
375  return GetLoadedFPID();
376 
377  return id;
378 }
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_TOOLS::Save(), FOOTPRINT_EDITOR_TOOLS::SaveAs(), setupUIConditions(), and SyncLibraryTree().

◆ GetTitleBlock()

const TITLE_BLOCK & PCB_BASE_FRAME::GetTitleBlock ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 307 of file pcb_base_frame.cpp.

308 {
309  return m_pcb->GetTitleBlock();
310 }
TITLE_BLOCK & GetTitleBlock()
Definition: board.h:580

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 469 of file eda_draw_frame.h.

469 { 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 76 of file tools_holder.h.

76 { return m_toolManager; }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48

References TOOLS_HOLDER::m_toolManager.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), LIB_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::DisplayWorksheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), SCH_FIELD::DoHypertextMenu(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_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(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), InstallPreferences(), SYMBOL_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SYMBOL_EDIT_FRAME::LoadPart(), PCB_EDIT_FRAME::LoadProjectSettings(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), SYMBOL_TREE_PANE::onComponentSelected(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), DIALOG_INSPECTION_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), SIM_PLOT_FRAME::onProbe(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), DIALOG_FIELDS_EDITOR_GLOBAL::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), EDA_DRAW_FRAME::resolveCanvasType(), PL_EDITOR_FRAME::RollbackFromUndo(), SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), SaveSettings(), EDA_3D_VIEWER::SaveSettings(), DIALOG_FIND::search(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_3D_VIEW_OPTIONS::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 358 of file footprint_edit_frame.cpp.

359 {
361 }
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
Definition: lib_tree.cpp:151
LIB_TREE * GetLibTree() const
FOOTPRINT_TREE_PANE * m_treePane

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

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:82

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

973 {
975 
976  aPrimaryUnit = GetUserUnits();
977  aSecondaryUnits = EDA_UNITS::MILS;
978 
979  if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
980  {
981  if( cmnTool )
982  aSecondaryUnits = cmnTool->GetLastMetricUnits();
983  else
984  aSecondaryUnits = EDA_UNITS::MILLIMETRES;
985  }
986  else
987  {
988  if( cmnTool )
989  aSecondaryUnits = cmnTool->GetLastImperialUnits();
990  else
991  aSecondaryUnits = EDA_UNITS::MILS;
992  }
993 }
EDA_UNITS GetLastMetricUnits()
Definition: common_tools.h:75
bool IsImperialUnit(EDA_UNITS aUnit)
Definition: eda_units.cpp:26
EDA_UNITS GetLastImperialUnits()
Definition: common_tools.h:76
COMMON_TOOLS.
Definition: common_tools.h:38
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

References COMMON_TOOLS::GetLastImperialUnits(), COMMON_TOOLS::GetLastMetricUnits(), TOOL_MANAGER::GetTool(), EDA_BASE_FRAME::GetUserUnits(), EDA_UNIT_UTILS::IsImperialUnit(), TOOLS_HOLDER::m_toolManager, MILLIMETRES, and MILS.

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

◆ GetUserOrigin()

const wxPoint PCB_BASE_FRAME::GetUserOrigin ( ) const
inherited

Definition at line 285 of file pcb_base_frame.cpp.

286 {
287  auto& displ_opts = GetDisplayOptions();
288  wxPoint origin( 0, 0 );
289 
290  switch( displ_opts.m_DisplayOrigin )
291  {
293  case PCB_DISPLAY_OPTIONS::PCB_ORIGIN_AUX: origin = GetAuxOrigin(); break;
294  case PCB_DISPLAY_OPTIONS::PCB_ORIGIN_GRID: origin = GetGridOrigin(); break;
295  default: wxASSERT( false ); break;
296  }
297 
298  return origin;
299 }
const wxPoint & GetGridOrigin() const override
Return the absolute coordinates of the origin of the snap grid.
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Function GetDisplayOptions Display options control the way tracks, vias, outlines and other things ar...
const wxPoint & GetAuxOrigin() const

References PCB_BASE_FRAME::GetAuxOrigin(), PCB_BASE_FRAME::GetDisplayOptions(), PCB_BASE_FRAME::GetGridOrigin(), PCB_DISPLAY_OPTIONS::PCB_ORIGIN_AUX, PCB_DISPLAY_OPTIONS::PCB_ORIGIN_GRID, and PCB_DISPLAY_OPTIONS::PCB_ORIGIN_PAGE.

Referenced by PCB_ORIGIN_TRANSFORMS::GetUserXOrigin(), and PCB_ORIGIN_TRANSFORMS::GetUserYOrigin().

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 239 of file eda_base_frame.h.

240  {
241  return m_userUnits;
242  }
EDA_UNITS m_userUnits

References EDA_BASE_FRAME::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_FP_EDITOR_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), PCB_MARKER::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), WS_DRAW_ITEM_BASE::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), DIMENSION_BASE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), RC_TREE_MODEL::GetValue(), PCB_INSPECTION_TOOL::InspectClearance(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_NET_INSPECTOR::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::onUpdateThicknessValue(), PANEL_PREV_3D::PANEL_PREV_3D(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_FEATURE_CONSTRAINTS::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and PANEL_SETUP_TRACKS_AND_VIAS::validateData().

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
virtualinherited

Returns a pointer to the window settings for this frame.

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

Parameters
aCfgis this frame's config object

Reimplemented in SIM_PLOT_FRAME, FOOTPRINT_WIZARD_FRAME, FOOTPRINT_VIEWER_FRAME, LIB_VIEW_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 655 of file eda_base_frame.cpp.

656 {
657  return &aCfg->m_Window;
658 }
WINDOW_SETTINGS m_Window
Definition: app_settings.h:173

References APP_SETTINGS_BASE::m_Window.

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

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )
inherited

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

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

Returns
the undecorated window size

Definition at line 1002 of file eda_base_frame.cpp.

1003 {
1004 #ifdef __WXGTK__
1005  // GTK includes the window decorations in the normal GetSize call,
1006  // so we have to use a GTK-specific sizing call that returns the
1007  // non-decorated window size.
1008  int width = 0;
1009  int height = 0;
1010  GTKDoGetSize( &width, &height );
1011 
1012  wxSize winSize( width, height );
1013 #else
1014  wxSize winSize = GetSize();
1015 #endif
1016 
1017  return winSize;
1018 }

Referenced by EDA_BASE_FRAME::OnMaximize(), and EDA_BASE_FRAME::SaveWindowSettings().

◆ GetZoneSettings()

const ZONE_SETTINGS & PCB_BASE_FRAME::GetZoneSettings ( ) const
inherited

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const
inherited

Return a human readable value for display in dialogs.

Definition at line 526 of file eda_draw_frame.cpp.

527 {
528  // returns a human readable value which can be displayed as zoom
529  // level indicator in dialogs.
530  double zoom = m_canvas->GetGAL()->GetZoomFactor() / ZOOM_COEFF;
531  return wxString::Format( wxT( "Z %.2f" ), zoom );
532 }
#define ZOOM_COEFF
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
double GetZoomFactor() const
Get the zoom factor.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

References Format(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetZoomFactor(), EDA_DRAW_FRAME::m_canvas, and ZOOM_COEFF.

Referenced by EDA_DRAW_FRAME::UpdateStatusBar().

◆ HandleUpdateUIEvent()

void EDA_BASE_FRAME::HandleUpdateUIEvent ( wxUpdateUIEvent &  aEvent,
EDA_BASE_FRAME aFrame,
ACTION_CONDITIONS  aCond 
)
staticinherited

Handles events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g.

enabled, checked, etc.).

Parameters
aEventis the wxUpdateUIEvent to be processed.
aFrameis the frame to get the selection from
aCondare the UI SELECTION_CONDITIONS used

Definition at line 320 of file eda_base_frame.cpp.

322 {
323  bool checkRes = false;
324  bool enableRes = true;
325  bool showRes = true;
326  SELECTION& selection = aFrame->GetCurrentSelection();
327 
328  try
329  {
330  checkRes = aCond.checkCondition( selection );
331  enableRes = aCond.enableCondition( selection );
332  showRes = aCond.showCondition( selection );
333  }
334  catch( std::exception& )
335  {
336  // Something broke with the conditions, just skip the event.
337  aEvent.Skip();
338  return;
339  }
340 
341  aEvent.Enable( enableRes );
342  aEvent.Show( showRes );
343 
344  // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
345  // checked, since wxMenuItems don't want to be checked unless they actually are checkable
346 #if wxCHECK_VERSION( 3, 1, 5 )
347  if( aEvent.IsCheckable() )
348  aEvent.Check( checkRes );
349 #else
350  bool canCheck = true;
351 
352  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
353  // see if they can be and can't just universally apply a check in this event.
354  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
355  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
356 
357  if( canCheck )
358  aEvent.Check( checkRes );
359 #endif
360 }
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:123

References ACTION_CONDITIONS::checkCondition, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), and ACTION_CONDITIONS::showCondition.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

void FOOTPRINT_EDIT_FRAME::HardRedraw ( )
overridevirtual

Refresh the library tree and redraw the window.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 331 of file footprint_edit_frame.cpp.

332 {
333  SyncLibraryTree( true );
334  GetCanvas()->