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 () const override
 
bool canCloseWindow (wxCloseEvent &Event) override
 
void doCloseWindow () override
 
void CloseModuleEditor (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 Process_Special_Functions (wxCommandEvent &event)
 
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 module 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 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 OnUpdateLoadModuleFromBoard (wxUpdateUIEvent &aEvent)
 
void OnUpdateInsertModuleInBoard (wxUpdateUIEvent &aEvent)
 
void OnEditItemRequest (BOARD_ITEM *aItem) override
 

More...
 
void LoadModuleFromBoard (wxCommandEvent &event)
 Called from the main toolbar to load a footprint from board mainly to edit it. More...
 
void LoadModuleFromLibrary (LIB_ID aFPID)
 
LIB_TREE_MODEL_ADAPTER::PTRGetLibTreeAdapter ()
 Returns the adapter object that provides the stored data. More...
 
bool SaveFootprint (MODULE *aModule)
 Save in an existing library a given footprint. More...
 
bool SaveFootprintAs (MODULE *aModule)
 
bool SaveFootprintToBoard (bool aAddNew)
 
bool SaveFootprintInLibrary (MODULE *aModule, 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 Export_Module (MODULE *aModule)
 Create a file containing only one footprint. More...
 
MODULEImport_Module (const wxString &aName=wxT(""))
 Read a file containing only one footprint. More...
 
bool Load_Module_From_BOARD (MODULE *Module)
 Load in Modedit a footprint from the main board. More...
 
MODULESelectFootprintFromBoard (BOARD *aPcb)
 Display the list of modules currently existing on the BOARD. More...
 
bool DeleteModuleFromLibrary (const LIB_ID &aFPID, bool aConfirm)
 Delete the given module from its library. More...
 
bool IsElementVisible (GAL_LAYER_ID aElement) const
 Test whether a given element category is visible. More...
 
void SetElementVisibility (GAL_LAYER_ID aElement, bool aNewState)
 Function SetElementVisibility changes the visibility of an element category. 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 AddModuleToBoard (MODULE *module) override
 Override from PCB_BASE_EDIT_FRAME which adds a module to the editor's dummy board, NOT to the user's PCB. More...
 
void InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
 Allows Modedit to install its preferences panel into the preferences dialog. More...
 
void ReFillLayerWidget ()
 
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 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...
 
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 InstallTextOptionsFrame (BOARD_ITEM *aText)
 Routine for main window class to launch text properties dialog. More...
 
void InstallGraphicItemPropertiesDialog (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...
 
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...
 
MODULELoadFootprint (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 wxPointGetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
const wxPointGetAuxOrigin () 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...
 
MODULEGetFootprintFromBoardByReference ()
 Function GetFootprintFromBoardByReference. More...
 
MODULECreateNewModule (const wxString &aModuleName)
 Function CreateNewModule Creates a new module or footprint, at position 0,0 The new module 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 PlaceModule (MODULE *aModule, bool aRecreateRatsnest=true)
 Function PlaceModule places aModule at the current cursor position and updates module coordinates with the new position. More...
 
void InstallPadOptionsFrame (D_PAD *pad)
 
MODULESelectFootprintFromLibTree (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
 
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)
 
virtual wxString GetScreenDesc () const
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command send via a socket to the application, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) It called by EDA_DRAW_FRAME::OnSockRequest(). 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 &textUpper, const wxString &textLower, COLOR4D color, int pad=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...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. 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 ckeck 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 (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions) override
 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 RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions)
 Register a UI update handler for the control with ID aID. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction) override
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (int aID)
 Unregister a UI handler for a given ID 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 ()
 
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 updateView ()
 Reloads displayed items and sets view. More...
 
void restoreLastFootprint ()
 
void retainLastFootprint ()
 
void editFootprintProperties (MODULE *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...
 
MODULEloadFootprint (const LIB_ID &aFootprintId)
 Function loadFootprint attempts to load aFootprintId from the footprint library table. More...
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void InitExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. 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...
 
PCB_LAYER_WIDGETm_Layers
 Layer manager. It is the responsibility of the child frames to instantiate this. 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
 
PCBNEW_SETTINGSm_Settings
 
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
 
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
 
bool m_FlagModified
 
bool m_FlagSave
 
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
 
LIB_TREE_MODEL_ADAPTER::PTR m_adapter
 
std::unique_ptr< MODULEm_revertModule
 
wxString m_footprintNameWhenLoaded
 
int m_defaultLibWidth
 

Friends

struct PCB::IFACE
 

Detailed Description

Definition at line 40 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 607 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ ~FOOTPRINT_EDIT_FRAME()

FOOTPRINT_EDIT_FRAME::~FOOTPRINT_EDIT_FRAME ( )

Definition at line 258 of file footprint_edit_frame.cpp.

259 {
260  // Shutdown all running tools
261  if( m_toolManager )
263 
264  // save the footprint in the PROJECT
266 
267  delete m_selectionFilterPanel;
268  delete m_Layers;
269 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
PCB_LAYER_WIDGET * m_Layers
Layer manager. It is the responsibility of the child frames to instantiate this.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
PANEL_SELECTION_FILTER * m_selectionFilterPanel
AUI panel for changing the selection tool filter controls.

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

◆ FOOTPRINT_EDIT_FRAME()

FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard 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 = "ModEdit";
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  m_Layers = new PCB_LAYER_WIDGET( this, GetCanvas(), true );
139 
140  // In modedit, the default net clearance is not known (it depends on the actual board).
141  // So we do not show the default clearance, by setting it to 0.
142  // The footprint or pad specific clearance will be shown.
144 
145  // Don't show the default board solder mask clearance in the footprint editor. Only the
146  // footprint or pad clearance setting should be shown if it is not 0.
148 
149  // restore the last footprint from the project, if any
151 
152  // Ensure all layers and items are visible:
153  // In footprint editor, some layers have no meaning or cannot be used, but we show all of
154  // them, at least to be able to edit a bad layer
156 
157  // However the "no net" mark on pads is useless, because there are no nets in footprint
158  // editor: make it non visible.
160 
162 
163  // In modedit, set the default paper size to A4 for plot/print
165  SetScreen( new PCB_SCREEN( GetPageSettings().GetSizeIU() ) );
166 
167  // Create the manager and dispatcher & route draw panel events to the dispatcher
168  setupTools();
170 
171  initLibraryTree();
172  m_treePane = new FOOTPRINT_TREE_PANE( this );
173 
174  ReCreateMenuBar();
178 
180 
181  // LoadSettings() *after* creating m_LayersManager, because LoadSettings() initialize
182  // parameters in m_LayersManager
183  // NOTE: KifaceSettings() will return PCBNEW_SETTINGS if we started from pcbnew
185 
186  // Must be set after calling LoadSettings() to be sure these parameters are not dependent
187  // on what is read in stored settings. Enable one internal layer, because footprints
188  // support keepout areas that can be on internal layers only (therefore on the first internal
189  // layer). This is needed to handle these keepout in internal layers only.
191  GetBoard()->SetEnabledLayers( GetBoard()->GetEnabledLayers().set( In1_Cu ) );
192  GetBoard()->SetVisibleLayers( GetBoard()->GetEnabledLayers() );
193  GetBoard()->SetLayerName( In1_Cu, _( "Inner layers" ) );
194 
195  m_Layers->ReFill();
197 
201 
202  // Create the infobar
203  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
204 
205  m_auimgr.SetManagedWindow( this );
206  m_auimgr.SetFlags( wxAUI_MGR_DEFAULT | wxAUI_MGR_LIVE_RESIZE );
207 
208  // Horizontal items; layers 4 - 6
209  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) );
210  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6) );
211  m_auimgr.AddPane( m_infoBar,
212  EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
213 
214  // Vertical items; layers 1 - 3
215  m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" ).Left().Layer(3) );
216  m_auimgr.AddPane( m_treePane, EDA_PANE().Palette().Name( "Footprints" ).Left().Layer(2)
217  .Caption( _( "Libraries" ) ).MinSize( 250, 400 )
218  .BestSize( m_defaultLibWidth, -1 ) );
219 
220  m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" ).Right().Layer(2) );
221  m_auimgr.AddPane( m_Layers, EDA_PANE().Palette().Name( "LayersManager" ).Right().Layer(3)
222  .Caption( _( "Layers Manager" ) ).PaneBorder( false )
223  .MinSize( 80, -1 ).BestSize( m_Layers->GetBestSize() ) );
224 
226  EDA_PANE().Palette().Name( "SelectionFilter" ).Right().Layer( 3 )
227  .Caption( _( "Selection Filter" ) ).PaneBorder( false ).Position( 2 )
228  .MinSize( 160, -1 ).BestSize( m_selectionFilterPanel->GetBestSize() ) );
229 
230  // The selection filter doesn't need to grow in the vertical direction when docked
231  m_auimgr.GetPane( "SelectionFilter" ).dock_proportion = 0;
232 
233  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
234 
236 
237  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
238  // hidding it.
239  m_auimgr.Update();
240 
241  // We don't want the infobar displayed right away
242  m_auimgr.GetPane( "InfoBar" ).Hide();
243  m_auimgr.Update();
244 
246  updateTitle();
247  InitExitKey();
248 
249  // Default shutdown reason until a file is loaded
250  KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Footprint changes are unsaved" ) );
251 
252  // Ensure the window is on top
253  Raise();
254  Show( true );
255 }
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)
wxSize GetBestSize() const
Function GetBestSize returns the preferred minimum size, taking into consideration the dynamic conten...
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)
Function SetElementVisibility changes the visibility of an element category.
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.
ACTION_TOOLBAR * m_optionsToolBar
PCB_LAYER_WIDGET is here to implement the abstract functions of LAYER_WIDGET so they may be tied into...
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)
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:140
wxString m_AboutTitle
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting()
Returns the canvas type stored in the application settings.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:531
void SetVisibleAlls()
Function SetVisibleAlls changes the bit-mask of visible element categories and layers.
bool OnLayerSelected()
Function OnLayerSelected ensure the active layer is visible, and other layers not visible when m_alwa...
wxAuiManager m_auimgr
ACTION_TOOLBAR * m_mainToolBar
PCB_LAYER_ID m_Active_Layer
Definition: pcb_screen.h:37
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:80
void ReCreateMenuBar() override
(Re)Create the menubar for the module editor frame
void SetClearance(int aClearance)
Definition: netclass.h:166
void SetVisibleLayers(LSET aLayerMask)
Function SetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
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)
Function SetLayerName changes the name of the layer given by aLayer.
void ReFillRender()
Function ReFillRender rebuilds Render for instance after the config is read.
PCB_LAYER_WIDGET * m_Layers
Layer manager. It is the responsibility of the child frames to instantiate this.
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 InitExitKey()
Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
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:68
PANEL_SELECTION_FILTER * m_selectionFilterPanel
AUI panel for changing the selection tool filter controls.
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:178
WX_INFOBAR * m_infoBar
#define _(s)
Definition: 3d_actions.cpp:33
virtual void SetBoard(BOARD *aBoard) override
NETCLASS * GetDefault() const
Function GetDefault.
FOOTPRINT_TREE_PANE * m_treePane
const PAGE_INFO & GetPageSettings() const override
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
virtual void SetPageSettings(const PAGE_INFO &aPageSettings) override
FOOTPRINT_EDITOR_SETTINGS * GetSettings()
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:78
BOARD * GetBoard() const
void SelectLayer(LAYER_NUM aLayer)
Function SelectLayer changes the row selection in the layer list to aLayer provided.
void SetEnabledLayers(LSET aLayerMask)
Function SetEnabledLayers is a proxy function that calls the correspondent function in m_BoardSetting...
static const wxChar * GetFootprintEditorFrameName()
Function GetFootprintEditorFrameName (static)
ACTION_TOOLBAR * m_drawToolBar

References _, PAGE_INFO::A4, PCAD2KICAD::Center, F_SilkS, 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, BOARD_DESIGN_SETTINGS::m_SolderMaskMargin, PCAD2KICAD::Right, 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 1024 of file footprint_edit_frame.cpp.

1025 {
1027 
1028  // Be sure the axis are enabled
1029  GetCanvas()->GetGAL()->SetAxesEnabled( true );
1030 
1031  updateView();
1032 
1033  // Ensure the m_Layers settings are using the canvas type:
1035 }
void ActivateGalCanvas() override
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
void SetAxesEnabled(bool aAxesEnabled)
Enables drawing the axes.
void updateView()
Reloads displayed items and sets view.

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

◆ 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 471 of file footprint_libraries_utils.cpp.

472 {
473  wxFileName fn( aFilename );
474 
475  if( aFilename.IsEmpty() )
476  {
477  if( !LibraryFileBrowser( true, fn,
479  true ) )
480  {
481  return false;
482  }
483  }
484 
485  wxString libPath = fn.GetFullPath();
486  wxString libName = fn.GetName();
487 
488  if( libName.IsEmpty() )
489  return false;
490 
491  bool saveInGlobalTable = false;
492  bool saveInProjectTable = false;
493 
494  if( Prj().IsNullProject() )
495  {
496  saveInGlobalTable = true;
497  }
498  else
499  {
500  wxArrayString libTableNames;
501 
502  libTableNames.Add( _( "Global" ) );
503  libTableNames.Add( _( "Project" ) );
504 
505  switch( SelectSingleOption( this, _( "Select Library Table" ),
506  _( "Choose the Library Table to add the library to:" ), libTableNames ) )
507  {
508  case 0: saveInGlobalTable = true; break;
509  case 1: saveInProjectTable = true; break;
510  default: return false;
511  }
512  }
513 
514  wxString type = IO_MGR::ShowType( IO_MGR::GuessPluginTypeFromLibPath( libPath ) );
515 
516  // try to use path normalized to an environmental variable or project path
517  wxString normalizedPath = NormalizePath( libPath, &Pgm().GetLocalEnvVariables(), &Prj() );
518 
519  if( normalizedPath.IsEmpty() )
520  normalizedPath = libPath;
521 
522  try
523  {
524  if( saveInGlobalTable )
525  {
526  auto row = new FP_LIB_TABLE_ROW( libName, normalizedPath, type, wxEmptyString );
527  GFootprintTable.InsertRow( row );
529  }
530  else if( saveInProjectTable )
531  {
532  auto row = new FP_LIB_TABLE_ROW( libName, normalizedPath, type, wxEmptyString );
533  Prj().PcbFootprintLibs()->InsertRow( row );
534  Prj().PcbFootprintLibs()->Save( Prj().FootprintLibTblName() );
535  }
536  }
537  catch( const IO_ERROR& ioe )
538  {
539  DisplayError( this, ioe.What() );
540  return false;
541  }
542 
543  auto editor = (FOOTPRINT_EDIT_FRAME*) Kiway().Player( FRAME_FOOTPRINT_EDITOR, false );
544 
545  if( editor )
546  {
547  LIB_ID libID( libName, wxEmptyString );
548  editor->SyncLibraryTree( true );
549  editor->FocusOnLibID( libID );
550  }
551 
552  auto viewer = (FOOTPRINT_VIEWER_FRAME*) Kiway().Player( FRAME_FOOTPRINT_VIEWER, false );
553 
554  if( viewer )
555  viewer->ReCreateLibraryList();
556 
557  return true;
558 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
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
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
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:81
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath)
Function GuessPluginTypeFromLibPath returns a plugin type given a footprint library's libPath.
Definition: io_mgr.cpp:128
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:343
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:136
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:286
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:293
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().

◆ AddModuleToBoard()

void FOOTPRINT_EDIT_FRAME::AddModuleToBoard ( MODULE module)
overridevirtual

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

Reimplemented from PCB_BASE_FRAME.

Definition at line 398 of file footprint_edit_frame.cpp.

399 {
400  m_revertModule.reset( (MODULE*) aFootprint->Clone() );
401 
402  m_footprintNameWhenLoaded = aFootprint->GetFPID().GetLibItemName();
403 
404  // Pads are always editable in Footprint Editor
405  aFootprint->SetPadsLocked( false );
406 
408 
409  if( IsCurrentFPFromBoard() )
410  {
411  wxString msg;
412  msg.Printf( _( "Editing %s from board. Saving will update the board only." ),
413  aFootprint->GetReference() );
414 
416  GetInfoBar()->ShowMessage( msg, wxICON_INFORMATION );
417  }
418 
419  UpdateMsgPanel();
420 }
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: infobar.cpp:119
virtual void AddModuleToBoard(MODULE *module)
Adds the given module to the board.
std::unique_ptr< MODULE > m_revertModule
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:212
#define _(s)
Definition: 3d_actions.cpp:33
WX_INFOBAR * GetInfoBar()
virtual void UpdateMsgPanel()
Redraw the message panel.

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

Referenced by Import_Module(), restoreLastFootprint(), and RevertFootprint().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 372 of file eda_base_frame.cpp.

373 {
374  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
375  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
376 
377  helpMenu->Add( ACTIONS::help );
378  helpMenu->Add( ACTIONS::gettingStarted );
379  helpMenu->Add( ACTIONS::listHotKeys );
380  helpMenu->Add( ACTIONS::getInvolved );
381  helpMenu->Add( ACTIONS::reportBug );
382 
383  helpMenu->AppendSeparator();
384  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
385 
386  aMenuBar->Append( helpMenu, _( "&Help" ) );
387 }
static TOOL_ACTION listHotKeys
Definition: actions.h:175
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:43
static TOOL_ACTION reportBug
Definition: actions.h:177
const BITMAP_OPAQUE about_xpm[1]
Definition: about.cpp:84
COMMON_CONTROL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:174
static TOOL_ACTION getInvolved
Definition: actions.h:176
static TOOL_ACTION gettingStarted
Definition: actions.h:173

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(), LIB_VIEW_FRAME::ReCreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), LIB_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 430 of file eda_draw_frame.cpp.

431 {
432  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
433  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
434 
435  aMenu.AddSeparator( 1000 );
437  aMenu.AddItem( ACTIONS::zoomIn, SELECTION_CONDITIONS::ShowAlways, 1000 );
438  aMenu.AddItem( ACTIONS::zoomOut, SELECTION_CONDITIONS::ShowAlways, 1000 );
440 
441  aMenu.AddSeparator( 1000 );
442 
443  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
444  zoomMenu->SetTool( commonTools );
445  aToolMenu.AddSubMenu( zoomMenu );
446 
447  auto gridMenu = std::make_shared<GRID_MENU>( this );
448  gridMenu->SetTool( commonTools );
449  aToolMenu.AddSubMenu( gridMenu );
450 
451  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
452  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
453 }
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
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:50
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(), TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::m_toolManager, SELECTION_CONDITIONS::ShowAlways(), ACTIONS::zoomCenter, ACTIONS::zoomFitScreen, ACTIONS::zoomIn, and ACTIONS::zoomOut.

Referenced by PICKER_TOOL::Init(), PL_EDIT_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 &  textUpper,
const wxString &  textLower,
COLOR4D  color,
int  pad = 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
textUpper- The message upper text.
textLower- The message lower text.
color- A color ID from the KiCad color list (see colors.h).
pad- Number of spaces to pad between messages (default = 4).

Definition at line 592 of file eda_draw_frame.cpp.

594 {
595  if( m_messagePanel )
596  m_messagePanel->AppendMessage( textUpper, textLower, color, pad );
597 }
int color
Definition: DXF_plotter.cpp:61
EDA_MSG_PANEL * m_messagePanel
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, COLOR4D aColor, int aPad=6)
Function AppendMessage appends a message to the message panel.
Definition: msgpanel.cpp:110

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

Referenced by PCB_BASE_FRAME::Compile_Ratsnest(), LIB_EDIT_FRAME::DisplayCmpDoc(), GERBER_FILE_IMAGE::DisplayImageInfo(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_PRINTOUT::OnPrintPage(), DIALOG_SCH_SHEET_PROPS::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 539 of file footprint_edit_frame.cpp.

540 {
541  if( IsContentModified() )
542  {
543  // Shutdown blocks must be determined and vetoed as early as possible
544  if( KIPLATFORM::APP::SupportsShutdownBlockReason() && aEvent.GetId() == wxEVT_QUERY_END_SESSION )
545  {
546  aEvent.Veto();
547  return false;
548  }
549 
550  wxString footprintName = GetBoard()->GetFirstModule()->GetFPID().GetLibItemName();
551  wxString msg = _( "Save changes to \"%s\" before closing?" );
552 
553  if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
554  [&]() -> bool
555  {
556  return SaveFootprint( GetBoard()->GetFirstModule() );
557  } ) )
558  {
559  aEvent.Veto();
560  return false;
561  }
562  }
563 
564  return true;
565 }
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:201
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
const LIB_ID & GetFPID() const
Definition: class_module.h:221
bool IsContentModified() override
Get if any footprints or libraries have been modified but not saved.
MODULE * GetFirstModule() const
Gets the first module in the list (used in footprint viewer/editor) or NULL if none.
Definition: class_board.h:310
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: gtk/app.cpp:40
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
bool SaveFootprint(MODULE *aModule)
Save in an existing library a given footprint.
BOARD * GetBoard() const

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

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 948 of file eda_base_frame.cpp.

949 {
950  SetUserUnits( aUnits );
952 
953  wxCommandEvent e( UNITS_CHANGED );
954  ProcessEventLocally( e );
955 }
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::ImperialUnits(), COMMON_TOOLS::MetricUnits(), 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 846 of file eda_base_frame.cpp.

847 {
848  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
849 
850  wxFileName autoSaveFileName = aFileName;
851 
852  // Check for auto save file.
853  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
854 
855  wxLogTrace( traceAutoSave,
856  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
857 
858  if( !autoSaveFileName.FileExists() )
859  return;
860 
861  wxString msg = wxString::Format( _(
862  "Well this is potentially embarrassing!\n"
863  "It appears that the last time you were editing the file\n"
864  "\"%s\"\n"
865  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
866  GetChars( aFileName.GetFullName() )
867  );
868 
869  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
870 
871  // Make a backup of the current file, delete the file, and rename the auto save file to
872  // the file name.
873  if( response == wxYES )
874  {
875  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
876  {
877  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
878  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
879  }
880  }
881  else
882  {
883  wxLogTrace( traceAutoSave,
884  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
885 
886  // Remove the auto save file when using the previous file as is.
887  wxRemoveFile( autoSaveFileName.GetFullPath() );
888  }
889 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
static wxString GetAutoSaveFilePrefix()
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:153
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33

References _, Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), GetChars(), 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 95 of file initpcb.cpp.

96 {
97  if( GetBoard() == NULL )
98  return false;
99 
100  if( aQuery && IsContentModified() )
101  {
102  wxSafeYield( this, true ); // Allow frame to come to front before showing warning.
103 
104  if( !HandleUnsavedChanges( this, _( "The current footprint has been modified. "
105  "Save changes?" ),
106  [&]() -> bool { return SaveFootprint( GetBoard()->Modules().front() ); } ) )
107  {
108  return false;
109  }
110  }
111 
112  // Clear undo and redo lists because we want a full deletion
114  GetScreen()->ClrModify();
115 
116  BOARD* board = new BOARD;
117 
120  SetBoard( board );
121 
122  // clear filename, to avoid overwriting an old file
123  GetBoard()->SetFileName( wxEmptyString );
124 
126 
127  Zoom_Automatique( false );
128 
129  return true;
130 }
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:201
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
Function GetDesignSettings.
Definition: class_board.h:531
bool IsContentModified() override
Get if any footprints or libraries have been modified but not saved.
void InitDataPoints(const wxSize &aPageSizeInternalUnits)
Definition: base_screen.cpp:49
void SynchronizeNetsAndNetClasses()
Function SynchronizeNetsAndNetClasses copies NETCLASS info to each NET, based on NET membership in a ...
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.
#define NULL
void SetFileName(const wxString &aFileName)
Definition: class_board.h:242
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:178
#define _(s)
Definition: 3d_actions.cpp:33
virtual void SetBoard(BOARD *aBoard) override
bool SaveFootprint(MODULE *aModule)
Save in an existing library a given footprint.
void ClrModify()
Definition: base_screen.h:101
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
virtual void ClearUndoRedoList()
Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are del...

References _, EDA_BASE_FRAME::ClearUndoRedoList(), BASE_SCREEN::ClrModify(), 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::SetFileName(), BOARD::SynchronizeNetsAndNetClasses(), and EDA_DRAW_FRAME::Zoom_Automatique().

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

744 {
745  if( !aFileHistory )
746  aFileHistory = m_fileHistory;
747 
748  wxASSERT( aFileHistory );
749 
750  aFileHistory->ClearFileHistory();
751 
752  // Update the menubar to update the file history menu
753  if( GetMenuBar() )
754  {
755  ReCreateMenuBar();
756  GetMenuBar()->Refresh();
757  }
758 }
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().

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

599 {
600  if( aItemCount == 0 )
601  return;
602 
603  UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
604  unsigned icnt = list.m_CommandsList.size();
605 
606  if( aItemCount > 0 )
607  icnt = aItemCount;
608 
609  for( unsigned ii = 0; ii < icnt; ii++ )
610  {
611  if( list.m_CommandsList.size() == 0 )
612  break;
613 
614  PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
615  list.m_CommandsList.erase( list.m_CommandsList.begin() );
616 
617  curr_cmd->ClearListAndDeleteItems();
618  delete curr_cmd; // Delete command
619  }
620 }
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()

◆ CloseModuleEditor()

void FOOTPRINT_EDIT_FRAME::CloseModuleEditor ( wxCommandEvent &  Event)

Definition at line 592 of file footprint_edit_frame.cpp.

593 {
594  Close();
595 }

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

1039 {
1040  PCB_BASE_EDIT_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
1041 
1042  if( aEnvVarsChanged )
1043  SyncLibraryTree( true );
1044 
1045  Layout();
1046  SendSizeEvent();
1047 }
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
void SyncLibraryTree(bool aProgress)
Synchronize the footprint library tree to the current state of the footprint library table.

References PCB_BASE_FRAME::CommonSettingsChanged(), and SyncLibraryTree().

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

45 {
46  GetBoard()->GetConnectivity()->RecalculateRatsnest();
47  ClearMsgPanel();
48 
49  if( aDisplayStatus )
50  {
51  std::shared_ptr<CONNECTIVITY_DATA> conn = m_Pcb->GetConnectivity();
52  wxString msg;
53 
54  msg.Printf( wxT( " %d" ), conn->GetPadCount() );
55  AppendMsgPanel( _( "Pads" ), msg, RED );
56 
57  msg.Printf( wxT( " %d" ), conn->GetNetCount() - 1 /* Don't include "No Net" in count */ );
58  AppendMsgPanel( _( "Nets" ), msg, CYAN );
59 
60  SetMsgPanel( m_Pcb );
61  }
62 }
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
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:339
Definition: color4d.h:58
virtual void ClearMsgPanel()
Clear all messages from the message panel.
Definition: color4d.h:59
void AppendMsgPanel(const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
Append a message to the message panel.
#define _(s)
Definition: 3d_actions.cpp:33
BOARD * GetBoard() const

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

643 {
644  // KICAD_MANAGER_FRAME overrides this
645  return Kiface().KifaceSettings();
646 }
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(), 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(), LIB_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 423 of file eda_base_frame.h.

424  {
425  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
426  return baseCfgName;
427  }
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 411 of file pcb_base_frame.cpp.

412 {
413  EDA_3D_VIEWER* draw3DFrame = Get3DViewerFrame();
414 
415  if( !draw3DFrame )
416  draw3DFrame = new EDA_3D_VIEWER( &Kiway(), this, _( "3D Viewer" ) );
417 
418  // Raising the window does not show the window on Windows if iconized. This should work
419  // on any platform.
420  if( draw3DFrame->IsIconized() )
421  draw3DFrame->Iconize( false );
422 
423  draw3DFrame->Raise();
424  draw3DFrame->Show( true );
425 
426  // Raising the window does not set the focus on Linux. This should work on any platform.
427  if( wxWindow::FindFocus() != draw3DFrame )
428  draw3DFrame->SetFocus();
429 
430  return draw3DFrame;
431 }
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().

◆ 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 378 of file footprint_libraries_utils.cpp.

380 {
381  // Kicad cannot write legacy format libraries, only .pretty new format
382  // because the legacy format cannot handle current features.
383  // The footprint library is actually a directory
384 
385  wxString initialPath = aProposedName.IsEmpty() ? Prj().GetProjectPath() : aProposedName;
386  wxFileName fn;
387  bool doAdd = false;
388 
389  if( aLibName.IsEmpty() )
390  {
391  fn = initialPath;
392 
393  if( !LibraryFileBrowser( false, fn,
395  {
396  return wxEmptyString;
397  }
398 
399  doAdd = true;
400  }
401  else
402  {
403  fn = aLibName;
404 
405  if( !fn.IsAbsolute() )
406  {
407  fn.SetName( aLibName );
408  fn.MakeAbsolute( initialPath );
409  }
410 
411  // Enforce the .pretty extension:
412  fn.SetExt( KiCadFootprintLibPathExtension );
413  }
414 
415  // We can save fp libs only using IO_MGR::KICAD_SEXP format (.pretty libraries)
417  wxString libPath = fn.GetFullPath();
418 
419  try
420  {
421  PLUGIN::RELEASER pi( IO_MGR::PluginFind( piType ) );
422 
423  bool writable = false;
424  bool exists = false;
425 
426  try
427  {
428  writable = pi->IsFootprintLibWritable( libPath );
429  exists = true; // no exception was thrown, lib must exist.
430  }
431  catch( const IO_ERROR& )
432  { }
433 
434  if( exists )
435  {
436  if( !writable )
437  {
438  wxString msg = wxString::Format( _( "Library \"%s\" is read only." ), libPath );
439  ShowInfoBarError( msg );
440  return wxEmptyString;
441  }
442  else
443  {
444  wxString msg = wxString::Format( _( "Library %s already exists." ), libPath );
445  KIDIALOG dlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
446  dlg.SetOKLabel( _( "Overwrite" ) );
447  dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
448 
449  if( dlg.ShowModal() == wxID_CANCEL )
450  return wxEmptyString;
451 
452  pi->FootprintLibDelete( libPath );
453  }
454  }
455 
456  pi->FootprintLibCreate( libPath );
457  }
458  catch( const IO_ERROR& ioe )
459  {
460  DisplayError( this, ioe.What() );
461  return wxEmptyString;
462  }
463 
464  if( doAdd )
465  AddLibrary( libPath );
466 
467  return libPath;
468 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
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:124
RELEASER releases a PLUGIN in the context of a potential thrown exception, through its destructor.
Definition: io_mgr.h:580
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)
wxString KiCadFootprintLibPathWildcard()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#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:62
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::ArchiveModulesOnBoard().

◆ CreateNewModule()

MODULE * PCB_BASE_FRAME::CreateNewModule ( const wxString &  aModuleName)
inherited

Function CreateNewModule Creates a new module or footprint, at position 0,0 The new module 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
aModuleName= name of the new footprint in library
Returns
a reference to the new module

Definition at line 1003 of file footprint_libraries_utils.cpp.

1004 {
1005  wxString moduleName = aModuleName;
1006 
1007  // Ask for the new module name
1008  if( moduleName.IsEmpty() )
1009  {
1010  WX_TEXT_ENTRY_DIALOG dlg( this, _( "Enter footprint name:" ), _( "New Footprint" ),
1011  moduleName );
1012  dlg.SetTextValidator( MODULE_NAME_CHAR_VALIDATOR( &moduleName ) );
1013 
1014  if( dlg.ShowModal() != wxID_OK )
1015  return NULL; //Aborted by user
1016  }
1017 
1018  moduleName.Trim( true );
1019  moduleName.Trim( false );
1020 
1021  if( moduleName.IsEmpty() )
1022  {
1023  DisplayInfoMessage( this, _( "No footprint name defined." ) );
1024  return NULL;
1025  }
1026 
1027  // Creates the new module and add it to the head of the linked list of modules
1028  MODULE* module = new MODULE( GetBoard() );
1029 
1030  // Update parameters: timestamp ...
1031  module->SetLastEditTime();
1032 
1033  // Update its name in lib
1034  module->SetFPID( LIB_ID( wxEmptyString, moduleName ) );
1035 
1036  PCB_LAYER_ID txt_layer;
1037  wxPoint default_pos;
1039 
1040  module->Reference().SetText( settings.m_DefaultFPTextItems[0].m_Text );
1041  module->Reference().SetVisible( settings.m_DefaultFPTextItems[0].m_Visible );
1042  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[0].m_Layer;
1043  module->Reference().SetLayer( txt_layer );
1044  default_pos.y -= settings.GetTextSize( txt_layer ).y / 2;
1045  module->Reference().SetPosition( default_pos );
1046  default_pos.y += settings.GetTextSize( txt_layer ).y;
1047 
1048  module->Value().SetText( settings.m_DefaultFPTextItems[1].m_Text );
1049  module->Value().SetVisible( settings.m_DefaultFPTextItems[1].m_Visible );
1050  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[1].m_Layer;
1051  module->Value().SetLayer( txt_layer );
1052  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1053  module->Value().SetPosition( default_pos );
1054  default_pos.y += settings.GetTextSize( txt_layer ).y;
1055 
1056  for( size_t i = 2; i < settings.m_DefaultFPTextItems.size(); ++i )
1057  {
1058  TEXTE_MODULE* textItem = new TEXTE_MODULE( module );
1059  textItem->SetText( settings.m_DefaultFPTextItems[i].m_Text );
1060  textItem->SetVisible( settings.m_DefaultFPTextItems[i].m_Visible );
1061  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[i].m_Layer;
1062  textItem->SetLayer( txt_layer );
1063  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1064  textItem->SetPosition( default_pos );
1065  default_pos.y += settings.GetTextSize( txt_layer ).y;
1066  module->GraphicalItems().push_back( textItem );
1067  }
1068 
1069  if( module->GetReference().IsEmpty() )
1070  module->SetReference( moduleName );
1071 
1072  if( module->GetValue().IsEmpty() )
1073  module->SetValue( moduleName );
1074 
1075  module->RunOnChildren(
1076  [&] ( BOARD_ITEM* aChild )
1077  {
1078  if( aChild->Type() == PCB_MODULE_TEXT_T )
1079  {
1080  TEXTE_MODULE* textItem = static_cast<TEXTE_MODULE*>( aChild );
1081  PCB_LAYER_ID layer = textItem->GetLayer();
1082 
1083  textItem->SetTextThickness( settings.GetTextThickness( layer ) );
1084  textItem->SetTextSize( settings.GetTextSize( layer ) );
1085  textItem->SetItalic( settings.GetTextItalic( layer ) );
1086  textItem->SetKeepUpright( settings.GetTextUpright( layer ) );
1087  }
1088  } );
1089 
1090  SetMsgPanel( module );
1091  return module;
1092 }
void SetKeepUpright(bool aKeepUpright)
TEXTE_MODULE & Reference()
Definition: class_module.h:485
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
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction)
Function RunOnChildren.
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
void SetItalic(bool isItalic)
Definition: eda_text.h:179
void SetVisible(bool aVisible)
Definition: eda_text.h:185
const wxString GetValue() const
Function GetValue.
Definition: class_module.h:469
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:238
DRAWINGS & GraphicalItems()
Definition: class_module.h:184
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...
const wxString GetReference() const
Function GetReference.
Definition: class_module.h:444
bool GetTextUpright(PCB_LAYER_ID aLayer) const
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.
TEXTE_MODULE & Value()
read/write accessors:
Definition: class_module.h:484
void SetLastEditTime(timestamp_t aTime)
Definition: class_module.h:350
This class provides a custom wxValidator object for limiting the allowable characters when defining f...
Definition: validators.h:63
void SetReference(const wxString &aReference)
Function SetReference.
Definition: class_module.h:454
virtual void SetPosition(const wxPoint &aPos) override
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:93
#define _(s)
Definition: 3d_actions.cpp:33
void SetValue(const wxString &aValue)
Function SetValue.
Definition: class_module.h:478
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.h:158
BOARD * GetBoard() const
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:267
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:222
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: base_struct.h:193
BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.

References _, DisplayInfoMessage(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetDesignSettings(), BOARD_ITEM::GetLayer(), MODULE::GetReference(), BOARD_DESIGN_SETTINGS::GetTextItalic(), BOARD_DESIGN_SETTINGS::GetTextSize(), BOARD_DESIGN_SETTINGS::GetTextThickness(), BOARD_DESIGN_SETTINGS::GetTextUpright(), MODULE::GetValue(), MODULE::GraphicalItems(), BOARD_DESIGN_SETTINGS::m_DefaultFPTextItems, NULL, PCB_MODULE_TEXT_T, MODULE::Reference(), MODULE::RunOnChildren(), MODULE::SetFPID(), EDA_TEXT::SetItalic(), TEXTE_MODULE::SetKeepUpright(), MODULE::SetLastEditTime(), BOARD_ITEM::SetLayer(), EDA_DRAW_FRAME::SetMsgPanel(), TEXTE_MODULE::SetPosition(), MODULE::SetReference(), EDA_TEXT::SetText(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), WX_TEXT_ENTRY_DIALOG::SetTextValidator(), MODULE::SetValue(), EDA_TEXT::SetVisible(), EDA_ITEM::Type(), MODULE::Value(), and wxPoint::y.

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

◆ CreateServer()

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

Definition at line 49 of file eda_dde.cpp.

50 {
51  wxIPV4address addr;
52 
53  // Set the port number
54  addr.Service( service );
55 
56  // Listen on localhost only if requested
57  if( local )
58  addr.Hostname( HOSTNAME );
59 
60  delete m_socketServer;
61  m_socketServer = new wxSocketServer( addr );
62 
63  m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
64  m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
65  m_socketServer->Notify( true );
66 }
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:56
static TOOL_ACTION selectionTool
Definition: actions.h:149

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

Referenced by TOOL_MANAGER::processEvent().

◆ DeleteModuleFromLibrary()

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

Delete the given module from its library.

Definition at line 561 of file footprint_libraries_utils.cpp.

562 {
563  if( !aFPID.IsValid() )
564  return false;
565 
566  wxString nickname = aFPID.GetLibNickname();
567  wxString fpname = aFPID.GetLibItemName();
568 
569  // Legacy libraries are readable, but modifying legacy format is not allowed
570  // So prompt the user if he try to delete a footprint from a legacy lib
571  wxString libfullname = Prj().PcbFootprintLibs()->FindRow( nickname )->GetFullURI();
572 
573  if( IO_MGR::GuessPluginTypeFromLibPath( libfullname ) == IO_MGR::LEGACY )
574  {
576  return false;
577  }
578 
579  if( !Prj().PcbFootprintLibs()->IsFootprintLibWritable( nickname ) )
580  {
581  wxString msg = wxString::Format( _( "Library '%s' is read only." ), nickname );
582  ShowInfoBarError( msg );
583  return false;
584  }
585 
586  // Confirmation
587  wxString msg = wxString::Format( _( "Delete footprint '%s' from library '%s'?" ),
588  fpname.GetData(),
589  nickname.GetData() );
590 
591  if( aConfirm && !IsOK( this, msg ) )
592  return false;
593 
594  try
595  {
596  Prj().PcbFootprintLibs()->FootprintDelete( nickname, fpname );
597  }
598  catch( const IO_ERROR& ioe )
599  {
600  DisplayError( this, ioe.What() );
601  return false;
602  }
603 
604  msg.Printf( _( "Footprint '%s' deleted from library '%s'" ),
605  fpname.GetData(),
606  nickname.GetData() );
607 
608  SetStatusText( msg );
609 
610  return true;
611 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
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:128
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:286
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
Legacy Pcbnew file formats prior to s-expression.
Definition: io_mgr.h:56
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#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:267
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:283

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:205
wxString m_modal_string
Definition: kiway_player.h:204
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:202

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

506 {
507  wxString line;
508  wxString gridformatter;
509 
510  switch( m_userUnits )
511  {
512  case EDA_UNITS::INCHES: gridformatter = "grid X %.6f Y %.6f"; break;
513  case EDA_UNITS::MILLIMETRES: gridformatter = "grid X %.6f Y %.6f"; break;
514  default: gridformatter = "grid X %f Y %f"; break;
515  }
516 
517  double grid_x = To_User_Unit( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x );
518  double grid_y = To_User_Unit( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().y );
519  line.Printf( gridformatter, grid_x, grid_y );
520 
521  SetStatusText( line, 4 );
522 }
double To_User_Unit(EDA_UNITS aUnit, double aValue, bool aUseMils)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:92
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(), INCHES, EDA_BASE_FRAME::m_userUnits, MILLIMETRES, and To_User_Unit().

Referenced by PCB_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 465 of file eda_draw_frame.cpp.

466 {
467  SetStatusText( msg, 6 );
468 }

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

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

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

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

264 {
265  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
266 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void FOOTPRINT_EDIT_FRAME::doCloseWindow ( )
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 568 of file footprint_edit_frame.cpp.

569 {
570  // No more vetos
572  GetCanvas()->StopDrawing();
573 
574  // Do not show the layer manager during closing to avoid flicker
575  // on some platforms (Windows) that generate useless redraw of items in
576  // the Layer Manger
577  m_auimgr.GetPane( "LayersManager" ).Show( false );
578  m_auimgr.GetPane( "SelectionFilter" ).Show( false );
579 
580  Pgm().GetSettingsManager().FlushAndRelease( GetSettings() );
581 
582  Clear_Pcb( false );
583 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
wxAuiManager m_auimgr
bool Clear_Pcb(bool aQuery)
Delete all and reinitialize the current board.
Definition: initpcb.cpp:95
#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 ( MODULE aFootprint)
protected

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

Definition at line 337 of file footprint_editor_utils.cpp.

338 {
339  LIB_ID oldFPID = aModule->GetFPID();
340 
341  DIALOG_FOOTPRINT_FP_EDITOR dialog( this, aModule );
342  dialog.ShowModal();
343 
344  // Update library tree
345  BASIC_FOOTPRINT_INFO footprintInfo( aModule );
346  wxDataViewItem treeItem = m_adapter->FindItem( oldFPID );
347 
348  if( treeItem.IsOk() ) // Can be not found in tree if the current footprint is imported
349  // from file therefore not yet in tree.
350  {
351  static_cast<LIB_TREE_NODE_LIB_ID*>( treeItem.GetID() )->Update( &footprintInfo );
353  }
354 
355  updateTitle(); // in case of a name change...
356 
357  UpdateMsgPanel();
358 }
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void RefreshLibTree()
Refreshes the tree (mainly to update highlighting and asterisking)
Definition: lib_tree.cpp:220
LIB_TREE * GetLibTree() const
void updateTitle()
Updates window title according to getLibNickName().
LIB_TREE_MODEL_ADAPTER::PTR m_adapter
FOOTPRINT_TREE_PANE * m_treePane
virtual void UpdateMsgPanel()
Redraw the message panel.

References MODULE::GetFPID().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 222 of file eda_draw_frame.cpp.

223 {
224  if( m_messagePanel )
226 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:216

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 send via a socket to the application, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) It called by EDA_DRAW_FRAME::OnSockRequest().

this is a virtual function becuse the actual commands depends on the application. the basic function do nothing

Parameters
cmdline= received command from socket

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 244 of file eda_draw_frame.h.

244 {}

Referenced by EDA_DRAW_FRAME::OnSockRequest().

◆ Export_Module()

void FOOTPRINT_EDIT_FRAME::Export_Module ( MODULE aModule)

Create a file containing only one footprint.

Used to export a footprint Exported files have the standard ext .emp This is the same format as .mod files but restricted to only one footprint So Create a new lib (which will contains one module) and export a footprint is basically the same thing

Parameters
aModule= the module to export

Definition at line 311 of file footprint_libraries_utils.cpp.

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

175 {
176  static KIID lastBrightenedItemID( niluuid );
177 
178  BOARD_ITEM* lastItem = GetBoard()->GetItem( lastBrightenedItemID );
179 
180  if( lastItem && lastItem != aItem && lastItem != DELETED_BOARD_ITEM::GetInstance() )
181  {
182  lastItem->ClearBrightened();
183 
184  if( lastItem->Type() == PCB_MODULE_T )
185  {
186  static_cast<MODULE*>( lastItem )->RunOnChildren( [&]( BOARD_ITEM* child )
187  {
188  child->ClearBrightened();
189  });
190  }
191  else if( lastItem->Type() == PCB_GROUP_T )
192  {
193  static_cast<PCB_GROUP*>( lastItem )->RunOnChildren( [&] ( BOARD_ITEM* child )
194  {
195  child->ClearBrightened();
196  });
197  }
198 
199  GetCanvas()->GetView()->Update( lastItem );
200  lastBrightenedItemID = niluuid;
201  GetCanvas()->Refresh();
202  }
203 
204  if( aItem )
205  {
206  aItem->SetBrightened();
207 
208  if( aItem->Type() == PCB_MODULE_T )
209  {
210  static_cast<MODULE*>( aItem )->RunOnChildren( [&]( BOARD_ITEM* child )
211  {
212  child->SetBrightened();
213  });
214  }
215  else if( aItem->Type() == PCB_GROUP_T )
216  {
217  static_cast<PCB_GROUP*>( aItem )->RunOnChildren( [&] ( BOARD_ITEM* child )
218  {
219  child->SetBrightened();
220  });
221  }
222 
223  GetCanvas()->GetView()->Update( aItem );
224  lastBrightenedItemID = aItem->m_Uuid;
225  FocusOnLocation( aItem->GetFocusPosition() );
226  GetCanvas()->Refresh();
227  }
228 }
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags) override
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: pcb_view.cpp:93
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
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: base_struct.h:345
void SetBrightened()
Definition: base_struct.h:209
BOARD_ITEM * GetItem(const KIID &aID)
void ClearBrightened()
Definition: base_struct.h:212
Definition: common.h:68
class MODULE, a footprint
Definition: typeinfo.h:89
static DELETED_BOARD_ITEM * GetInstance()
KIID niluuid(0)
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...
const KIID m_Uuid
Definition: base_struct.h:162
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: base_struct.h:193

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_GROUP_T, PCB_MODULE_T, EDA_DRAW_PANEL_GAL::Refresh(), EDA_ITEM::SetBrightened(), EDA_ITEM::Type(), and KIGFX::PCB_VIEW::Update().

Referenced by SELECTION_TOOL::Main(), DIALOG_DRC::OnCancelClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), and DIALOG_DRC::~DIALOG_DRC().

◆ FocusOnLibID()

void FOOTPRINT_EDIT_FRAME::FocusOnLibID ( const LIB_ID aLibID)

Definition at line 842 of file footprint_edit_frame.cpp.

843 {
844  m_treePane->GetLibTree()->SelectLibId( aLibID );
845 }
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:179

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

768 {
769  bool centerView = false;
770  BOX2D r = GetCanvas()->GetView()->GetViewport();
771 
772  // Center if we're off the current view, or within 10% of its edge
773  r.Inflate( - (int) r.GetWidth() / 10 );
774 
775  if( !r.Contains( aPos ) )
776  centerView = true;
777 
778  // Center if we're behind an obscuring dialog, or within 10% of its edge
779  wxWindow* dialog = findDialog( GetChildren() );
780 
781  if( dialog )
782  {
783  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
784  dialog->GetSize() );
785  dialogRect.Inflate( dialogRect.GetWidth() / 10 );
786 
787  if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
788  centerView = true;
789  }
790 
791  if( centerView )
792  {
793  // If a dialog partly obscures the window, then center on the uncovered area.
794  if( dialog )
795  {
796  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
797  dialog->GetSize() );
798  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
799  }
800  else
801  GetCanvas()->GetView()->SetCenter( aPos );
802  }
803 
805 }
BOX2D GetViewport() const
Function GetViewport() Returns the current viewport visible area rectangle.
Definition: view.cpp:537
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:603
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 78 of file pcb_base_frame.cpp.

79 {
80  return dynamic_cast<EDA_3D_VIEWER*>( FindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( this ) ) );
81 }
#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::Update3DView(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

Definition at line 573 of file eda_base_frame.h.

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

Definition at line 376 of file pcb_base_frame.h.

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

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

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_BASE_FRAME::GetCollectorsGuide(), PCB_INSPECTION_TOOL::InspectClearance(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), PCBNEW_CONTROL::LayerNext(), PCBNEW_CONTROL::LayerPrev(), PCBNEW_CONTROL::LayerToggle(), ROUTER_TOOL::MainLoop(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAddField(), APPEARANCE_CONTROLS::OnLayerAlphaChanged(), APPEARANCE_CONTROLS::OnLayerChanged(), APPEARANCE_CONTROLS::OnLayerContextMenu(), PCB_LAYER_WIDGET::onPopupSelection(), PCB_DRAW_PANEL_GAL::OnShow(), OnUpdateLayerSelectBox(), PCB_EDIT_FRAME::OnUpdateLayerSelectBox(), DRAWING_TOOL::PlaceText(), PCB_EDIT_FRAME::PrepareLayerIndicator(), PCB_EDIT_FRAME::SaveProjectSettings(), PCB_BASE_FRAME::SetDisplayOptions(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), ROUTER_TOOL::switchLayerOnViaPlacement(), and UpdateUserInterface().

◆ GetAutoSaveFilePrefix()

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

Definition at line 195 of file eda_base_frame.h.

196  {
197  return wxT( "_autosave-" );
198  }

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

334 { 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 418 of file pcb_base_frame.h.

418 { return false; }

◆ GetAuxOrigin()

const wxPoint & PCB_BASE_FRAME::GetAuxOrigin ( ) const
inherited

Definition at line 273 of file pcb_base_frame.cpp.

274 {
275  wxASSERT( m_Pcb );
277 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:531
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 187 of file eda_base_frame.h.

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

◆ GetBoard()

BOARD* PCB_BASE_FRAME::GetBoard ( ) const
inlineinherited

Definition at line 209 of file pcb_base_frame.h.

210  {
211  wxASSERT( m_Pcb );
212  return m_Pcb;
213  }

References PCB_BASE_FRAME::m_Pcb.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_FRAME::AddModuleToBoard(), PCB_LAYER_WIDGET::AddRightClickMenuItems(), DIALOG_PLOT::applyPlotSettings(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), GRID_CELL_LAYER_SELECTOR::BeginEdit(), DIALOG_COPPER_ZONE::buildAvailableListOfNets(), DIALOG_BOARD_REANNOTATE::BuildModuleList(), canCloseWindow(), Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), PCB_BASE_FRAME::Compile_Ratsnest(), DIALOG_TEXT_PROPERTIES::convertKIIDsToReferences(), DIALOG_TEXT_PROPERTIES::convertReferencesToKIIDs(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), CreateHeaderInfoData(), PCB_BASE_FRAME::CreateNewModule(), ZONE_CREATE_HELPER::createNewZone(), DIALOG_PRINT_PCBNEW::createPrintout(), PANEL_MODEDIT_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_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), 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::Exchange_Module(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_EDITOR_TOOLS::ExportFootprint(), 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(), GetDesignSettings(), GetDocumentExtents(), PCB_LAYER_BOX_SELECTOR::getEnabledLayers(), 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(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), PCB_BASE_FRAME::GetSeverity(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), GRID_CELL_LAYER_SELECTOR::GetValue(), PCB_EDITOR_CONDITIONS::hasItemsFunc(), Import_Module(), PCB_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), PCB_EDITOR_CONTROL::ImportSpecctraSession(), EDIT_TOOL::Init(), DIALOG_PLOT::init_Dialog(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PCB_INSPECTION_TOOL::InspectClearance(), ARRAY_CREATOR::Invoke(), IsContentModified(), IsCurrentFPFromBoard(), IsElementVisible(), PCB_LAYER_SELECTOR::isLayerEnabled(), PCB_LAYER_BOX_SELECTOR::isLayerEnabled(), PCB_EDIT_FRAME::KiwayMailIn(), Load_Module_From_BOARD(), DIALOG_NETLIST::loadNetlist(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC::OnActivateDlg(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), DIALOG_SELECT_NET_FROM_LIST::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::onLayerPresetChanged(), APPEARANCE_CONTROLS::onLayerVisibilityChanged(), PCB_LAYER_WIDGET::OnLayerVisible(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), PCB_LAYER_WIDGET::OnRenderEnable(), PANEL_SETUP_RULES::onScintillaCharAdded(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), FOOTPRINT_VIEWER_FRAME::OnUpdateFootprintButton(), OnUpdateInsertModuleInBoard(), OnUpdateLoadModuleFromBoard(), OnUpdateModuleSelected(), DIALOG_NETLIST::OnUpdatePCB(), 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(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingModules(), FOOTPRINT_EDITOR_TOOLS::Properties(), NET_GRID_TABLE::Rebuild(), APPEARANCE_CONTROLS::rebuildLayerContextMenu(), APPEARANCE_CONTROLS::rebuildLayers(), APPEARANCE_CONTROLS::rebuildNets(), APPEARANCE_CONTROLS::rebuildObjects(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), PCB_LAYER_WIDGET::ReFill(), PCB_LAYER_WIDGET::ReFillRender(), Refresh(), DIALOG_PLOT::reInitDialog(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), PCB_INSPECTION_TOOL::reportCopperClearance(), DRC_TOOL::Reset(), 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(), SetElementVisibility(), APPEARANCE_CONTROLS::SetLayerVisible(), DIALOG_PLOT::SetPlotFormat(), VECTOR_DRC_ITEMS_PROVIDER::SetSeverities(), ZONE_SETTINGS::SetupLayersList(), setupTools(), setupUIConditions(), APPEARANCE_CONTROLS::showNetclass(), GLOBAL_EDIT_TOOL::SwapLayers(), PCB_EDIT_FRAME::SwitchLayer(), APPEARANCE_CONTROLS::syncColorsAndVisibility(), APPEARANCE_CONTROLS::syncLayerPresetSelection(), PCB_LAYER_WIDGET::SyncLayerVisibilities(), APPEARANCE_CONTROLS::syncObjectSettings(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_UNUSED_PAD_LAYERS::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), 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 366 of file pcb_base_frame.cpp.

367 {
368  wxASSERT( m_Pcb );
369 
370  EDA_RECT area = aBoardEdgesOnly ? m_Pcb->GetBoardEdgesBoundingBox() : m_Pcb->GetBoundingBox();
371 
372  if( area.GetWidth() == 0 && area.GetHeight() == 0 )
373  {
374  wxSize pageSize = GetPageSizeIU();
375 
377  {
378  area.SetOrigin( 0, 0 );
379  area.SetEnd( pageSize.x, pageSize.y );
380  }
381  else
382  {
383  area.SetOrigin( -pageSize.x / 2, -pageSize.y / 2 );
384  area.SetEnd( pageSize.x / 2, pageSize.y / 2 );
385  }
386  }
387 
388  return area;
389 }
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: class_board.h:754
const EDA_RECT GetBoardEdgesBoundingBox() const
Function GetBoardEdgesBoundingBox Returns the board bounding box calculated using exclusively the boa...
Definition: class_board.h:766
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 790 of file pcb_base_frame.cpp.

791 {
792  return static_cast<PCB_DRAW_PANEL_GAL*>( EDA_DRAW_FRAME::GetCanvas() );
793 }
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(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_VIEWER_FRAME::ClickOnLibList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), DIALOG_PRINT_PCBNEW::createPrintout(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), PCB_BASE_FRAME::DisplayGridMsg(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::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(), PCB_BASE_FRAME::FocusOnItem(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetCollectorsGuide(), HardRedraw(), DIALOG_SELECT_NET_FROM_LIST::highlightNetOnBoard(), 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_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), APPEARANCE_CONTROLS::OnLayerAlphaChanged(), PCB_LAYER_WIDGET::OnLayerColorChange(), APPEARANCE_CONTROLS::OnLayerContextMenu(), PCB_LAYER_WIDGET::OnLayerSelect(), APPEARANCE_CONTROLS::onLayerVisibilityChanged(), PCB_LAYER_WIDGET::OnLayerVisible(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetColorModeChanged(), APPEARANCE_CONTROLS::onNetContextMenu(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), PCB_LAYER_WIDGET::onPopupSelection(), APPEARANCE_CONTROLS::onRatsnestModeChanged(), DIALOG_SELECT_NET_FROM_LIST::onRenameNet(), PCB_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), 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(), DRC_TOOL::RunTests(), SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), DIALOG_FIND::search(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), DRAWING_TOOL::SetAnchor(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetDisplayOptions(), POINT_EDITOR::setEditedPoint(), SetElementVisibility(), APPEARANCE_CONTROLS::SetLayerVisible(), setupTools(), 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(), PANEL_MODEDIT_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), NET_GRID_TABLE::updateNetColor(), PCB_BASE_FRAME::UpdateStatusBar(), UpdateUserInterface(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), updateView(), SELECTION_TOOL::zoomFitSelection(), DIALOG_NETLIST::~DIALOG_NETLIST(), DIALOG_SELECT_NET_FROM_LIST::~DIALOG_SELECT_NET_FROM_LIST(), 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 477 of file pcb_base_frame.cpp.

478 {
480  GetCanvas()->GetView() );
481 
482  // account for the globals
484  guide.SetIgnoreMTextsOnBack( ! m_Pcb->IsElementVisible( LAYER_MOD_TEXT_BK ) );
485  guide.SetIgnoreMTextsOnFront( ! m_Pcb->IsElementVisible( LAYER_MOD_TEXT_FR ) );
486  guide.SetIgnoreModulesOnBack( ! m_Pcb->IsElementVisible( LAYER_MOD_BK ) );
487  guide.SetIgnoreModulesOnFront( ! m_Pcb->IsElementVisible( LAYER_MOD_FR ) );
488  guide.SetIgnorePadsOnBack( ! m_Pcb->IsElementVisible( LAYER_PAD_BK ) );
489  guide.SetIgnorePadsOnFront( ! m_Pcb->IsElementVisible( LAYER_PAD_FR ) );
490  guide.SetIgnoreThroughHolePads( ! m_Pcb->IsElementVisible( LAYER_PADS_TH ) );
491  guide.SetIgnoreModulesVals( ! m_Pcb->IsElementVisible( LAYER_MOD_VALUES ) );
492  guide.SetIgnoreModulesRefs( ! m_Pcb->IsElementVisible( LAYER_MOD_REFERENCES ) );
493  guide.SetIgnoreThroughVias( ! m_Pcb->IsElementVisible( LAYER_VIAS ) );
494  guide.SetIgnoreBlindBuriedVias( ! m_Pcb->IsElementVisible( LAYER_VIAS ) );
495  guide.SetIgnoreMicroVias( ! m_Pcb->IsElementVisible( LAYER_VIAS ) );
496  guide.SetIgnoreTracks( ! m_Pcb->IsElementVisible( LAYER_TRACKS ) );
497 
498  return guide;
499 }
multilayer pads, usually with holes
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
LSET GetVisibleLayers() const
Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
show modules values (when texts are visibles)
show modules on front
virtual PCB_LAYER_ID GetActiveLayer() const
void SetIgnoreMTextsMarkedNoShow(bool ignore)
Definition: collectors.h:546
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
Function IsElementVisible tests whether a given element category is visible.
smd pads, front layer
Meta control for all vias opacity/visibility.
A general implementation of a COLLECTORS_GUIDE.
Definition: collectors.h:390
show modules 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 487 of file footprint_edit_frame.cpp.

488 {
489  return Pgm().GetSettingsManager().GetColorSettings(
490  GetFootprintEditorSettings()->m_ColorTheme );
491 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
FOOTPRINT_EDITOR_SETTINGS * GetFootprintEditorSettings()

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

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

504 { 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 278 of file footprint_edit_frame.cpp.

279 {
280  return m_toolManager->GetTool<SELECTION_TOOL>()->GetSelection();
281 }
SELECTION_TOOL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50

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

◆ GetCurrentTreeNode()

LIB_TREE_NODE * FOOTPRINT_EDIT_FRAME::GetCurrentTreeNode ( ) const

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

430 {
431  return GetBoard()->GetDesignSettings();
432 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:531
BOARD * GetBoard() const

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

Referenced by Clear_Pcb(), LoadSettings(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), SaveSettings(), and PANEL_MODEDIT_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 187 of file pcb_base_frame.h.

187 { 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(), PCB_LAYER_WIDGET::OnLayerSelect(), APPEARANCE_CONTROLS::onNetColorModeChanged(), APPEARANCE_CONTROLS::onObjectOpacitySlider(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), APPEARANCE_CONTROLS::onRatsnestModeChanged(), PCB_LAYER_WIDGET::OnRenderEnable(), 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_LAYER_WIDGET::ReFillRender(), 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 ( ) const
overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 503 of file footprint_edit_frame.cpp.

504 {
505  MODULE* module = GetBoard()->GetFirstModule();
506 
507  if( module )
508  {
509  bool hasGraphicalItem = module->Pads().size() || module->Zones().size();
510 
511  if( !hasGraphicalItem )
512  {
513  for( const BOARD_ITEM* item : module->GraphicalItems() )
514  {
515  if( item->Type() == PCB_MODULE_TEXT_T )
516  continue;
517 
518  hasGraphicalItem = true;
519  break;
520  }
521  }
522 
523  if( hasGraphicalItem )
524  {
525  return module->GetFootprintRect();
526  }
527  else
528  {
529  BOX2I newModuleBB( { 0, 0 }, { 0, 0 } );
530  newModuleBB.Inflate( Millimeter2iu( 12 ) );
531  return newModuleBB;
532  }
533  }
534 
535  return GetBoardBoundingBox( false );
536 }
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
PADS & Pads()
Definition: class_module.h:174
EDA_RECT GetFootprintRect() const
Function GetFootprintRect() Returns the area of the module footprint excluding any text.
DRAWINGS & GraphicalItems()
Definition: class_module.h:184
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
MODULE * GetFirstModule() const
Gets the first module in the list (used in footprint viewer/editor) or NULL if none.
Definition: class_board.h:310
EDA_RECT GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Function GetBoardBoundingBox calculates the bounding box containing all board items (or board edge se...
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:93
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
MODULE_ZONE_CONTAINERS & Zones()
Definition: class_module.h:194
BOARD * GetBoard() const
static constexpr int Millimeter2iu(double mm)

References PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetBoardBoundingBox(), BOARD::GetFirstModule(), MODULE::GetFootprintRect(), MODULE::GraphicalItems(), BOX2< Vec >::Inflate(), Millimeter2iu(), MODULE::Pads(), PCB_MODULE_TEXT_T, and MODULE::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 128 of file tools_holder.h.

128 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:63

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

134 { return m_dragSelects; }
bool m_dragSelects
Definition: tools_holder.h:67

References TOOLS_HOLDER::m_dragSelects.

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

705 {
706  if( !aFileHistory )
707  aFileHistory = m_fileHistory;
708 
709  wxASSERT( aFileHistory );
710 
711  int baseId = aFileHistory->GetBaseId();
712 
713  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
714 
715  unsigned i = cmdId - baseId;
716 
717  if( i < aFileHistory->GetCount() )
718  {
719  wxString fn = aFileHistory->GetHistoryFile( i );
720 
721  if( wxFileName::FileExists( fn ) )
722  return fn;
723  else
724  {
725  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
726  wxMessageBox( msg );
727 
728  aFileHistory->RemoveFileFromHistory( i );
729  }
730  }
731 
732  // Update the menubar to update the file history menu
733  if( GetMenuBar() )
734  {
735  ReCreateMenuBar();
736  GetMenuBar()->Refresh();
737  }
738 
739  return wxEmptyString;
740 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#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 489 of file eda_base_frame.h.

490  {
491  return *m_fileHistory;
492  }
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 171 of file eda_draw_frame.h.

171 { 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 170 of file eda_draw_frame.h.

170 { 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 423 of file footprint_edit_frame.cpp.

424 {
426 }
#define FOOTPRINT_EDIT_FRAME_NAME

References FOOTPRINT_EDIT_FRAME_NAME.

◆ GetFootprintEditorSettings()

FOOTPRINT_EDITOR_SETTINGS * PCB_BASE_FRAME::GetFootprintEditorSettings ( )
inherited

Definition at line 754 of file pcb_base_frame.cpp.

755 {
756  return Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
757 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104

References Pgm().

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

◆ GetFootprintFromBoardByReference()

MODULE * 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 432 of file load_select_footprint.cpp.

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

References MODULE::Add(), GetBoard(), DIALOG_GET_FOOTPRINT_BY_NAME::GetValue(), BOARD::Modules(), and NULL.

◆ GetGalDisplayOptions()

◆ GetGridColor()

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 420 of file footprint_editor_utils.cpp.

421 {
422  return GetColorSettings()->GetColor( LAYER_GRID );
423 }
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 259 of file pcb_base_frame.cpp.

260 {
261  wxASSERT( m_Pcb );
263 }
wxPoint m_GridOrigin
origin for grid offsets
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:531

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

169 {
170  return GetBoard()->GetItem( aId );
171 }
BOARD_ITEM * GetItem(const KIID &aID)
BOARD * GetBoard() const

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

◆ GetLibTreeAdapter()

LIB_TREE_MODEL_ADAPTER::PTR& FOOTPRINT_EDIT_FRAME::GetLibTreeAdapter ( )
inline

Returns the adapter object that provides the stored data.

Definition at line 173 of file footprint_edit_frame.h.

173 { return m_adapter; }
LIB_TREE_MODEL_ADAPTER::PTR 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 348 of file footprint_edit_frame.cpp.

349 {
350  MODULE* module = GetBoard()->GetFirstModule();
351 
352  if( module )
354  else
355  return LIB_ID();
356 }
const LIB_ID & GetFPID() const
Definition: class_module.h:221
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
MODULE * GetFirstModule() const
Gets the first module in the list (used in footprint viewer/editor) or NULL if none.
Definition: class_board.h:310
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstModule(), MODULE::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(), and updateTitle().

◆ GetMagneticItemsSettings()

MAGNETIC_SETTINGS * FOOTPRINT_EDIT_FRAME::GetMagneticItemsSettings ( )
overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 494 of file footprint_edit_frame.cpp.

495 {
496  // Get the actual frame settings for magnetic items
498  wxCHECK( cfg, nullptr );
499  return &cfg->m_MagneticItems;
500 }
FOOTPRINT_EDITOR_SETTINGS * GetSettings()

References GetSettings(), and FOOTPRINT_EDITOR_SETTINGS::m_MagneticItems.

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 652 of file eda_base_frame.h.

652 { 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 319 of file footprint_edit_frame.cpp.

320 {
321  return GetBoard()->GetFirstModule();
322 }
MODULE * GetFirstModule() const
Gets the first module in the list (used in footprint viewer/editor) or NULL if none.
Definition: class_board.h:310
BOARD * GetBoard() const

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

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

140 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:68

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

724 {
725  const wxPoint& gridOrigin = GetGridOrigin();
726  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
727 
728  double xOffset = fmod( gridOrigin.x, gridSize.x );
729  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
730  double yOffset = fmod( gridOrigin.y, gridSize.y );
731  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
732 
733  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
734 }
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(), wxPoint::x, VECTOR2< T >::x, wxPoint::y, 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 304 of file pcb_base_frame.cpp.

305 {
306  return m_OriginTransforms;
307 }
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 241 of file pcb_base_frame.cpp.

242 {
243  wxASSERT( m_Pcb );
244  return m_Pcb->GetPageSettings();
245 }
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:546

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

249 {
250  wxASSERT( m_Pcb );
251 
252  // this function is only needed because EDA_DRAW_FRAME is not compiled
253  // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
254  // into an application specific source file.
255  return m_Pcb->GetPageSettings().GetSizeIU();
256 }
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:546

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

749 {
750  return Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
751 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104

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_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), 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_KEEPOUT_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_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), 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 435 of file footprint_edit_frame.cpp.

436 {
437  wxFAIL_MSG( "Plotting not supported in Footprint Editor" );
438 
440 }
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 176 of file pcb_base_edit_frame.h.

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

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 861 of file eda_draw_frame.cpp.

862 {
863  // Virtual function. Base class implementation returns an empty string.
864  return wxEmptyString;
865 }

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

◆ GetSettings()

FOOTPRINT_EDITOR_SETTINGS * FOOTPRINT_EDIT_FRAME::GetSettings ( )

Definition at line 449 of file footprint_edit_frame.cpp.

450 {
451  if( !m_settings )
452  m_settings = Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
453 
454  return m_settings;
455 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
FOOTPRINT_EDITOR_SETTINGS * m_settings

References m_settings, and Pgm().

Referenced by DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), doCloseWindow(), Export_Module(), GetMagneticItemsSettings(), Import_Module(), LoadSettings(), SaveSettings(), PANEL_MODEDIT_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 722 of file pcb_base_frame.cpp.

723 {
724  if( aErrorCode >= CLEANUP_FIRST )
725  return RPT_SEVERITY_ACTION;
726 
728 
729  return bds.m_DRCSeverities[ aErrorCode ];
730 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:531
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

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

338 {
339  LIB_ID id = GetTreeFPID();
340 
341  if( id.GetLibNickname().empty() )
342  return GetLoadedFPID();
343 
344  return id;
345 }
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(), setupUIConditions(), and SyncLibraryTree().

◆ GetTitleBlock()

const TITLE_BLOCK & PCB_BASE_FRAME::GetTitleBlock ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 310 of file pcb_base_frame.cpp.

311 {
312  wxASSERT( m_Pcb );
313  return m_Pcb->GetTitleBlock();
314 }
TITLE_BLOCK & GetTitleBlock()
Definition: class_board.h:552

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

465 { 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 78 of file tools_holder.h.

78 { return m_toolManager; }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50

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_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(), 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(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), InstallPreferences(), LIB_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LIB_EDIT_FRAME::LoadPart(), PCB_EDIT_FRAME::LoadProjectSettings(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), SYMBOL_TREE_PANE::onComponentSelected(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnERCItemSelected(), 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(), PL_EDITOR_FRAME::RollbackFromUndo(), SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), SaveSettings(), EDA_3D_VIEWER::SaveSettings(), DIALOG_FIND::search(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), PCB_LAYER_WIDGET::SyncLayerAlphaIndicators(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::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 325 of file footprint_edit_frame.cpp.

326 {
328 }
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:150
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::CutCopyFootprint(), FOOTPRINT_EDITOR_TOOLS::EditFootprint(), FOOTPRINT_EDITOR_TOOLS::ExportFootprint(), GetTargetFPID(), FOOTPRINT_EDITOR_TOOLS::Init(), and FOOTPRINT_EDITOR_TOOLS::PasteFootprint().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
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

◆ GetUserOrigin()

const wxPoint PCB_BASE_FRAME::GetUserOrigin ( ) const
inherited

Definition at line 280 of file pcb_base_frame.cpp.

281 {
282  auto& displ_opts = GetDisplayOptions();
283  wxPoint origin( 0, 0 );
284 
285  switch( displ_opts.m_DisplayOrigin )
286  {
288  // No-op
289  break;
291  origin = GetAuxOrigin();
292  break;
294  origin = GetGridOrigin();
295  break;
296  default:
297  wxASSERT( false );
298  break;
299  }
300 
301  return origin;
302 }
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 247 of file eda_base_frame.h.

248  {
249  return m_userUnits;
250  }
EDA_UNITS m_userUnits

References EDA_BASE_FRAME::m_userUnits.

Referenced by 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_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), GERBER_FILE_IMAGE::DisplayImageInfo(), 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_MODEDIT_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), MARKER_PCB::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), TEXTE_PCB::GetMsgPanelInfo(), WS_DRAW_ITEM_BASE::GetMsgPanelInfo(), ZONE_CONTAINER::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), TEXTE_MODULE::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), DRAWSEGMENT::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), GetUserUnits(), RC_TREE_MODEL::GetValue(), GRID_MENU::GRID_MENU(), SELECTION_TOOL::highlightInternal(), PCB_INSPECTION_TOOL::InspectClearance(), GERBVIEW_FRAME::Liste_D_Codes(), PCB_VIEWER_TOOLS::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_SELECT_NET_FROM_LIST::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(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_EESCHEMA_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_SETTINGS::TransferDataToWindow(), PANEL_EDIT_OPTIONS::TransferDataToWindow(), PANEL_SETUP_FEATURE_CONSTRAINTS::TransferDataToWindow(), SELECTION_TOOL::unhighlightInternal(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), GRID_MENU::update(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), EDA_DRAW_FRAME::UpdateGridSelectBox(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateTrackWidthSelectBox(), 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 636 of file eda_base_frame.cpp.

637 {
638  return &aCfg->m_Window;
639 }
WINDOW_SETTINGS m_Window
Definition: app_settings.h:171

References APP_SETTINGS_BASE::m_Window.

Referenced by EDA_DRAW_FRAME::LoadSettings(), EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::SaveSettings(), and EDA_BASE_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 980 of file eda_base_frame.cpp.

981 {
982 #ifdef __WXGTK__
983  // GTK includes the window decorations in the normal GetSize call,
984  // so we have to use a GTK-specific sizing call that returns the
985  // non-decorated window size.
986  int width = 0;
987  int height = 0;
988  GTKDoGetSize( &width, &height );
989 
990  wxSize winSize( width, height );
991 #else
992  wxSize winSize = GetSize();
993 #endif
994 
995  return winSize;
996 }

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

◆ GetZoneSettings()

const ZONE_SETTINGS & PCB_BASE_FRAME::GetZoneSettings ( ) const
inherited

Definition at line 338 of file pcb_base_frame.cpp.

339 {
340  wxASSERT( m_Pcb );
342 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:531
ZONE_SETTINGS & GetDefaultZoneSettings()

References BOARD_DESIGN_SETTINGS::GetDefaultZoneSettings(), BOARD::GetDesignSettings(), and PCB_BASE_FRAME::m_Pcb.

Referenced by ZONE_CREATE_HELPER::createNewZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), and CONVERT_TOOL::LinesToPoly().

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const
inherited

Return a human readable value for display in dialogs.

Definition at line 528 of file eda_draw_frame.cpp.

529 {
530  // returns a human readable value which can be displayed as zoom
531  // level indicator in dialogs.
532  double zoom = m_canvas->GetGAL()->GetZoomFactor() / ZOOM_COEFF;
533  return wxString::Format( wxT( "Z %.2f" ), zoom );
534 }
#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, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201

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

313 {
314  bool checkRes = false;
315  bool enableRes = true;
316  bool showRes = true;
317  SELECTION& selection = aFrame->GetCurrentSelection();
318 
319  try
320  {
321  checkRes = aCond.checkCondition( selection );
322  enableRes = aCond.enableCondition( selection );
323  showRes = aCond.showCondition( selection );
324  }
325  catch( std::exception& )
326  {
327  // Something broke with the conditions, just skip the event.
328  aEvent.Skip();
329  return;
330  }
331 
332  aEvent.Enable( enableRes );
333  aEvent.Show( showRes );
334 
335  bool canCheck = true;
336 
337  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
338  // see if they can be and can't just universally apply a check in this event.
339  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
340  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
341 
342  if( canCheck )
343  aEvent.Check( checkRes );
344 }
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:104

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

299 {
300  SyncLibraryTree( true );
301  GetCanvas()->ForceRefresh();
302 }
void ForceRefresh()
Function ForceRefresh() Forces a redraw.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void SyncLibraryTree(bool aProgress)
Synchronize the footprint library tree to the current state of the footprint library table.

References EDA_DRAW_PANEL_GAL::ForceRefresh(), PCB_BASE_FRAME::GetCanvas(), and SyncLibraryTree().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 655 of file eda_base_frame.cpp.

656 {
657  return Kiface().GetHelpFileName();
658 }
const wxString & GetHelpFileName() const
Function GetHelpFileName returns just the basename portion of the current help file.
Definition: kiface_i.h:123
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ Import_Module()

MODULE * FOOTPRINT_EDIT_FRAME::Import_Module ( const wxString &  aName = wxT(""))

Read a file containing only one footprint.

Used to import (after exporting) a footprint Exported files have the standard ext .emp This is the same format as .mod files but restricted to only one footprint The import function can also read gpcb footprint file, in Newlib format (One footprint per file, Newlib files have no special ext.)

Definition at line 227 of file footprint_libraries_utils.cpp.

228 {
229  wxString lastOpenedPathForLoading = m_mruPath;
231 
232  if( !cfg->m_LastImportExportPath.empty() )
233  lastOpenedPathForLoading = cfg->m_LastImportExportPath;
234 
235  wxFileName fn;
236 
237  if( aName != wxT("") )
238  fn = aName;
239  else
240  fn = getFootprintFilenameFromUser( this, lastOpenedPathForLoading );
241 
242  if( !fn.IsOk() )
243  return NULL;
244 
245  FILE* fp = wxFopen( fn.GetFullPath(), wxT( "rt" ) );
246 
247  if( !fp )
248  {
249  wxString msg = wxString::Format( _( "File \"%s\" not found" ), fn.GetFullPath() );
250  DisplayError( this, msg );
251  return NULL;
252  }
253 
254  cfg->m_LastImportExportPath = lastOpenedPathForLoading;
255 
256  wxString moduleName;
257  IO_MGR::PCB_FILE_T fileType = detect_file_type( fp, fn.GetFullPath(), &moduleName );
258 
260  {
261  DisplayError( this, _( "Not a footprint file" ) );
262  return NULL;
263  }
264 
265  MODULE* module = NULL;
266 
267  try
268  {
269  module = try_load_footprint( fn, fileType, moduleName );
270 
271  if( !module )
272  {
273  wxString msg = wxString::Format( _( "Unable to load footprint '%s' from '%s'" ),
274  moduleName,
275  fn.GetFullPath() );
276  DisplayError( this, msg );
277  return NULL;
278  }
279  }
280  catch( const IO_ERROR& ioe )
281  {
282  DisplayError( this, ioe.What() );
283 
284  // if the footprint is not loaded, exit.
285  // However, even if an error happens, it can be loaded, because in KICAD and GPCB format,
286  // a fp library is a set of separate files, and the error(s) are not necessary when
287  // reading the selected file
288 
289  if( !module )
290  return NULL;
291  }
292 
293  module->SetFPID( LIB_ID( wxEmptyString, moduleName ) );
294 
295  // Insert footprint in list
296  AddModuleToBoard( module );
297 
298  // Display info :
299  SetMsgPanel( module );
300  PlaceModule( module );
301 
302  module->SetPosition( wxPoint( 0, 0 ) );
303 
305  updateView();
306 
307  return module;
308 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
void BuildListOfNets()
Definition: class_board.h:686
MODULE * try_load_footprint(const wxFileName &aFileName, IO_MGR::PCB_FILE_T aFileType, const wxString &aName)
Try to load a footprint, returning NULL if the file couldn't be accessed.
wxString m_mruPath
static wxFileName getFootprintFilenameFromUser(wxWindow *aParent, const wxString &aLastPath)
Prompt the user for a module file to open.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
#define NULL
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
static IO_MGR::PCB_FILE_T detect_file_type(FILE *aFile, const wxFileName &aFileName, wxString *aName)
Read a file to detect the type.
void SetPosition(const wxPoint &aPos) override
FormatType fileType(const char *aFileName)
Definition: loadmodel.cpp:271
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
void updateView()
Reloads displayed items and sets view.
FOOTPRINT_EDITOR_SETTINGS * GetSettings()
void AddModuleToBoard(MODULE *module) override
Override from PCB_BASE_EDIT_FRAME which adds a module to the editor's dummy board,...
BOARD * GetBoard() const
void PlaceModule(MODULE *aModule, bool aRecreateRatsnest=true)
Function PlaceModule places aModule at the current cursor position and updates module coordinates wit...
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
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:222

References _, AddModuleToBoard(), BOARD::BuildListOfNets(), detect_file_type(), DisplayError(), IO_MGR::FILE_TYPE_NONE, fileType(), Format(), PCB_BASE_FRAME::GetBoard(), getFootprintFilenameFromUser(), GetSettings(), FOOTPRINT_EDITOR_SETTINGS::m_LastImportExportPath, EDA_BASE_FRAME::m_mruPath, NULL, PCB_BASE_FRAME::PlaceModule(), MODULE::SetFPID(), EDA_DRAW_FRAME::SetMsgPanel(), MODULE::SetPosition(), try_load_footprint(), updateView(), and IO_ERROR::What().

Referenced by FOOTPRINT_EDITOR_TOOLS::ImportFootprint().

◆ ImportHotkeyConfigFromFile()

void EDA_BASE_FRAME::ImportHotkeyConfigFromFile ( std::map< std::string, TOOL_ACTION * >  aActionMap,