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  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 ~FOOTPRINT_EDIT_FRAME ()
 
BOARD_ITEM_CONTAINERGetModel () const override
 

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
 
void OnCloseWindow (wxCloseEvent &Event) 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) 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...
 
void SyncToolbars () override
 Update the toolbars (mostly settings/check buttons/checkboxes) with the current controller state. More...
 
wxString CreateNewLibrary (const wxString &aLibName=wxEmptyString)
 Function CreateNewLibrary 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 (BOARD_ITEM *aItemToCopy, UNDO_REDO_T 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_T 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...
 
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 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
 
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
 
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...
 
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 ()
 
virtual APP_SETTINGS_BASEconfig () const
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
void LoadWindowSettings (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...
 
const wxString & GetAboutTitle () const
 
void SetShutdownBlockReason (const wxString &reason)
 Sets the block reason why the window/application is preventing OS shutdown. More...
 
void RemoveShutdownBlockReason ()
 Removes any shutdown block reason set. More...
 
bool SupportsShutdownBlockReason ()
 Whether or not the window supports setting a shutdown block reason. More...
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual void PushTool (const std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
bool GetDoImmediateActions () const
 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...
 

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 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...
 
BOARDm_Pcb
 
PCB_DISPLAY_OPTIONS m_DisplayOptions
 
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
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
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 39 of file footprint_edit_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ ~FOOTPRINT_EDIT_FRAME()

FOOTPRINT_EDIT_FRAME::~FOOTPRINT_EDIT_FRAME ( )

Definition at line 244 of file footprint_edit_frame.cpp.

245 {
246  // Shutdown all running tools
247  if( m_toolManager )
249 
250  // save the footprint in the PROJECT
252 
253  delete m_Layers;
254 }
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:48

References PCB_BASE_EDIT_FRAME::m_Layers, 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 107 of file footprint_edit_frame.cpp.

108  :
109  PCB_BASE_EDIT_FRAME( aKiway, aParent, FRAME_FOOTPRINT_EDITOR, wxEmptyString,
110  wxDefaultPosition, wxDefaultSize,
112 {
113  m_showBorderAndTitleBlock = false; // true to show the frame references
114  m_canvasType = aBackend;
115  m_AboutTitle = "ModEdit";
116  m_selLayerBox = nullptr;
117  m_settings = nullptr;
118 
119  // Give an icon
120  wxIcon icon;
121  icon.CopyFromBitmap( KiBitmap( icon_modedit_xpm ) );
122  SetIcon( icon );
123 
124  // Create GAL canvas
125  if( aBackend == EDA_DRAW_PANEL_GAL::GAL_TYPE_UNKNOWN )
127  else
128  m_canvasType = aBackend;
129 
130  PCB_DRAW_PANEL_GAL* drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_FrameSize,
132  SetCanvas( drawPanel );
133  SetBoard( new BOARD() );
134 
135  m_Layers = new PCB_LAYER_WIDGET( this, GetCanvas(), true );
136 
137  // LoadSettings() *after* creating m_LayersManager, because LoadSettings() initialize
138  // parameters in m_LayersManager
139  // NOTE: KifaceSettings() will return PCBNEW_SETTINGS if we started from pcbnew
141 
142  // In modedit, the default net clearance is not known (it depends on the actual board).
143  // So we do not show the default clearance, by setting it to 0.
144  // The footprint or pad specific clearance will be shown.
146 
147  // Don't show the default board solder mask clearance in the footprint editor. Only the
148  // footprint or pad clearance setting should be shown if it is not 0.
150 
151  // restore the last footprint from the project, if any
153 
154  // Ensure all layers and items are visible:
155  // In footprint editor, some layers have no meaning or cannot be used, but we show all of
156  // them, at least to be able to edit a bad layer
158 
159  // However the "no net" mark on pads is useless, because there are no nets in footprint
160  // editor: make it non visible.
162 
163  // Must be set after calling LoadSettings() to be sure these parameters are not dependent
164  // on what is read in stored settings. Enable one internal layer, because footprints
165  // support keepout areas that can be on internal layers only (therefore on the first internal
166  // layer). This is needed to handle these keepout in internal layers only.
168  GetBoard()->SetEnabledLayers( GetBoard()->GetEnabledLayers().set( In1_Cu ) );
169  GetBoard()->SetVisibleLayers( GetBoard()->GetEnabledLayers() );
170  GetBoard()->SetLayerName( In1_Cu, _( "Inner layers" ) );
171 
173 
174  // In modedit, set the default paper size to A4 for plot/print
176  SetScreen( new PCB_SCREEN( GetPageSettings().GetSizeIU() ) );
178 
179  // Create the manager and dispatcher & route draw panel events to the dispatcher
180  setupTools();
181 
182  initLibraryTree();
183  m_treePane = new FOOTPRINT_TREE_PANE( this );
184 
185  ReCreateMenuBar();
189 
190  m_Layers->ReFill();
192 
196 
197  // Create the infobar
198  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
199 
200  m_auimgr.SetManagedWindow( this );
201 
202  // Horizontal items; layers 4 - 6
203  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) );
204  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6) );
205  m_auimgr.AddPane( m_infoBar,
206  EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
207 
208  // Vertical items; layers 1 - 3
209  m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" ).Left().Layer(3) );
210  m_auimgr.AddPane( m_treePane, EDA_PANE().Palette().Name( "Footprints" ).Left().Layer(2)
211  .Caption( _( "Libraries" ) ).MinSize( 250, 400 )
212  .BestSize( m_defaultLibWidth, -1 ) );
213 
214  m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" ).Right().Layer(2) );
215  m_auimgr.AddPane( m_Layers, EDA_PANE().Palette().Name( "LayersManager" ).Right().Layer(3)
216  .Caption( _( "Layers Manager" ) ).PaneBorder( false )
217  .MinSize( 80, -1 ).BestSize( m_Layers->GetBestSize() ) );
218 
219  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
220 
222 
223  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
224  // hidding it.
225  m_auimgr.Update();
226 
227  // We don't want the infobar displayed right away
228  m_auimgr.GetPane( "InfoBar" ).Hide();
229  m_auimgr.Update();
230 
232  updateTitle();
233  InitExitKey();
234 
235  // Default shutdown reason until a file is loaded
236  SetShutdownBlockReason( _( "Footprint changes are unsaved" ) );
237 
238  // Ensure the window is on top
239  Raise();
240  Show( true );
241 }
int m_SolderMaskMargin
Solder mask margin.
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.
void SetShutdownBlockReason(const wxString &reason)
Sets the block reason why the window/application is preventing OS shutdown.
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
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:93
void SetCopperLayerCount(int aCount)
void ActivateGalCanvas() override
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:551
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:44
not specified: a GAL engine must be set by the client
bool m_axesEnabled
Whether or not to draw the coordinate system axes
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:170
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:64
#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
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:180
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
void SetMaxUndoItems(int aMax)
Definition: base_screen.h:172
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:74
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(), 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 882 of file footprint_edit_frame.cpp.

883 {
885 
886  // Be sure the axis are enabled
887  GetCanvas()->GetGAL()->SetAxesEnabled( true );
888 
889  updateView();
890 
891  // Ensure the m_Layers settings are using the canvas type:
893 }
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  wxArrayString libTableNames;
494 
495  libTableNames.Add( _( "Global" ) );
496  libTableNames.Add( _( "Project" ) );
497 
498  switch( SelectSingleOption( this, _( "Select Library Table" ),
499  _( "Choose the Library Table to add the library to:" ),
500  libTableNames ) )
501  {
502  case 0: saveInGlobalTable = true; break;
503  case 1: saveInProjectTable = true; break;
504  default: return false;
505  }
506 
507  wxString type = IO_MGR::ShowType( IO_MGR::GuessPluginTypeFromLibPath( libPath ) );
508 
509  // try to use path normalized to an environmental variable or project path
510  wxString normalizedPath = NormalizePath( libPath, &Pgm().GetLocalEnvVariables(), &Prj() );
511 
512  if( normalizedPath.IsEmpty() )
513  normalizedPath = libPath;
514 
515  try
516  {
517  if( saveInGlobalTable )
518  {
519  auto row = new FP_LIB_TABLE_ROW( libName, normalizedPath, type, wxEmptyString );
520  GFootprintTable.InsertRow( row );
522  }
523  else if( saveInProjectTable )
524  {
525  auto row = new FP_LIB_TABLE_ROW( libName, normalizedPath, type, wxEmptyString );
526  Prj().PcbFootprintLibs()->InsertRow( row );
527  Prj().PcbFootprintLibs()->Save( Prj().FootprintLibTblName() );
528  }
529  }
530  catch( const IO_ERROR& ioe )
531  {
532  DisplayError( this, ioe.What() );
533  return false;
534  }
535 
536  auto editor = (FOOTPRINT_EDIT_FRAME*) Kiway().Player( FRAME_FOOTPRINT_EDITOR, false );
537 
538  if( editor )
539  {
540  LIB_ID libID( libName, wxEmptyString );
541  editor->SyncLibraryTree( true );
542  editor->FocusOnLibID( libID );
543  }
544 
545  auto viewer = (FOOTPRINT_VIEWER_FRAME*) Kiway().Player( FRAME_FOOTPRINT_VIEWER, false );
546 
547  if( viewer )
548  viewer->ReCreateLibraryList();
549 
550  return true;
551 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp: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:80
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:127
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:342
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
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 FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:284
wxString KiCadFootprintLibPathWildcard()
#define _(s)
Definition: 3d_actions.cpp:33
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
int SelectSingleOption(wxWindow *aParent, const wxString &aTitle, const wxString &aMessage, const wxArrayString &aOptions)
Displays a dialog with radioboxes asking the user to select an option.
Definition: confirm.cpp: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(), 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 377 of file footprint_edit_frame.cpp.

378 {
379  m_revertModule.reset( (MODULE*) aFootprint->Clone() );
380 
381  m_footprintNameWhenLoaded = aFootprint->GetFPID().GetLibItemName();
382 
383  // Pads are always editable in Footprint Editor
384  aFootprint->SetPadsLocked( false );
385 
387 
388  UpdateMsgPanel();
389 }
virtual void AddModuleToBoard(MODULE *module)
Adds the given module to the board.
std::unique_ptr< MODULE > m_revertModule
virtual void UpdateMsgPanel()
Redraw the message panel.

References PCB_BASE_FRAME::AddModuleToBoard(), MODULE::Clone(), MODULE::GetFPID(), LIB_ID::GetLibItemName(), m_footprintNameWhenLoaded, m_revertModule, MODULE::SetPadsLocked(), 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 297 of file eda_base_frame.cpp.

298 {
299  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
300  ACTION_MENU* helpMenu = new ACTION_MENU( false );
301 
302  helpMenu->SetTool( commonControl );
303 
304  helpMenu->Add( ACTIONS::help );
305  helpMenu->Add( ACTIONS::gettingStarted );
306  helpMenu->Add( ACTIONS::listHotKeys );
307  helpMenu->Add( ACTIONS::getInvolved );
308  helpMenu->Add( ACTIONS::reportBug );
309 
310  helpMenu->AppendSeparator();
311  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
312 
313  aMenuBar->Append( helpMenu, _( "&Help" ) );
314 }
static TOOL_ACTION listHotKeys
Definition: actions.h:171
ACTION_MENU.
Definition: action_menu.h:44
static TOOL_ACTION reportBug
Definition: actions.h:173
const BITMAP_OPAQUE about_xpm[1]
Definition: about.cpp:84
COMMON_CONTROL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:170
static TOOL_ACTION getInvolved
Definition: actions.h:172
static TOOL_ACTION gettingStarted
Definition: actions.h:169

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(), GERBVIEW_FRAME::ReCreateMenuBar(), SCH_EDIT_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 431 of file eda_draw_frame.cpp.

432 {
433  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
434  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
435 
436  aMenu.AddSeparator( 1000 );
438  aMenu.AddItem( ACTIONS::zoomIn, SELECTION_CONDITIONS::ShowAlways, 1000 );
439  aMenu.AddItem( ACTIONS::zoomOut, SELECTION_CONDITIONS::ShowAlways, 1000 );
441 
442  aMenu.AddSeparator( 1000 );
443 
444  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
445  zoomMenu->SetTool( commonTools );
446  aToolMenu.AddSubMenu( zoomMenu );
447 
448  auto gridMenu = std::make_shared<GRID_MENU>( this );
449  gridMenu->SetTool( commonTools );
450  aToolMenu.AddSubMenu( gridMenu );
451 
452  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
453  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
454 }
static bool ShowAlways(const SELECTION &aSelection)
Function ShowAlways The default condition function (always returns true).
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
static TOOL_ACTION zoomFitScreen
Definition: actions.h:93
COMMON_TOOLS.
Definition: common_tools.h:38
void AddSeparator(int aOrder=ANY_ORDER)
Function AddSeparator()
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
static TOOL_ACTION zoomCenter
Definition: actions.h:92
static TOOL_ACTION zoomIn
Definition: actions.h:88
static TOOL_ACTION zoomOut
Definition: actions.h:89

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(), PCB_VIEWER_TOOLS::Init(), PL_DRAWING_TOOLS::Init(), PL_SELECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), EDIT_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 595 of file eda_draw_frame.cpp.

597 {
598  if( m_messagePanel )
599  m_messagePanel->AppendMessage( textUpper, textLower, color, pad );
600 }
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().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 796 of file eda_base_frame.cpp.

797 {
798  SetUserUnits( aUnits );
800 
801  wxCommandEvent e( UNITS_CHANGED );
802  ProcessEventLocally( e );
803 }
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 743 of file eda_base_frame.cpp.

744 {
745  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
746 
747  wxFileName autoSaveFileName = aFileName;
748 
749  // Check for auto save file.
750  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
751 
752  wxLogTrace( traceAutoSave,
753  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
754 
755  if( !autoSaveFileName.FileExists() )
756  return;
757 
758  wxString msg = wxString::Format( _(
759  "Well this is potentially embarrassing!\n"
760  "It appears that the last time you were editing the file\n"
761  "\"%s\"\n"
762  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
763  GetChars( aFileName.GetFullName() )
764  );
765 
766  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
767 
768  // Make a backup of the current file, delete the file, and rename the auto save file to
769  // the file name.
770  if( response == wxYES )
771  {
772  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
773  {
774  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
775  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
776  }
777  }
778  else
779  {
780  wxLogTrace( traceAutoSave,
781  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
782 
783  // Remove the auto save file when using the previous file as is.
784  wxRemoveFile( autoSaveFileName.GetFullPath() );
785  }
786 }
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:205
#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 94 of file initpcb.cpp.

95 {
96  if( GetBoard() == NULL )
97  return false;
98 
99  if( aQuery && IsContentModified() )
100  {
101  wxSafeYield( this, true ); // Allow frame to come to front before showing warning.
102 
103  if( !HandleUnsavedChanges( this, _( "The current footprint has been modified. "
104  "Save changes?" ),
105  [&]() -> bool { return SaveFootprint( GetBoard()->Modules().front() ); } ) )
106  {
107  return false;
108  }
109  }
110 
111  // Clear undo and redo lists because we want a full deletion
113  GetScreen()->ClrModify();
114 
115  BOARD* board = new BOARD;
116 
118  SetBoard( board );
119 
120  // clear filename, to avoid overwriting an old file
121  GetBoard()->SetFileName( wxEmptyString );
122 
124 
125  Zoom_Automatique( false );
126 
127  return true;
128 }
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
bool IsContentModified() override
Get if any footprints or libraries have been modified but not saved.
void InitDataPoints(const wxSize &aPageSizeInternalUnits)
Definition: base_screen.cpp:50
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
virtual void ClearUndoRedoList()
Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are del...
Definition: base_screen.cpp:73
void SetFileName(const wxString &aFileName)
Definition: class_board.h:253
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:180
#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:184
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

References _, BASE_SCREEN::ClearUndoRedoList(), BASE_SCREEN::ClrModify(), PCB_BASE_FRAME::GetBoard(), 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 FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), OnCloseWindow(), 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 640 of file eda_base_frame.cpp.

641 {
642  if( !aFileHistory )
643  aFileHistory = m_fileHistory;
644 
645  wxASSERT( aFileHistory );
646 
647  aFileHistory->ClearFileHistory();
648 
649  // Update the menubar to update the file history menu
650  if( GetMenuBar() )
651  {
652  ReCreateMenuBar();
653  GetMenuBar()->Refresh();
654  }
655 }
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()

◆ CloseModuleEditor()

void FOOTPRINT_EDIT_FRAME::CloseModuleEditor ( wxCommandEvent &  Event)

Definition at line 551 of file footprint_edit_frame.cpp.

552 {
553  Close();
554 }

◆ CommonSettingsChanged()

void FOOTPRINT_EDIT_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged)
overridevirtual

Called after the preferences dialog is run.

Reimplemented from PCB_BASE_FRAME.

Definition at line 896 of file footprint_edit_frame.cpp.

897 {
899 
900  if( aEnvVarsChanged )
901  SyncLibraryTree( true );
902 
903  Layout();
904  SendSizeEvent();
905 }
void CommonSettingsChanged(bool aEnvVarsChanged) 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:355
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_TRACKS_AND_VIAS::doCleanup(), DIALOG_CLEANUP_GRAPHICS::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 557 of file eda_base_frame.cpp.

558 {
559  // KICAD_MANAGER_FRAME overrides this
560  return Kiface().KifaceSettings();
561 }
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_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), 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(), SIM_PLOT_FRAME::onClose(), FOOTPRINT_WIZARD_FRAME::OnCloseWindow(), 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 337 of file eda_base_frame.h.

338  {
339  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
340  return baseCfgName;
341  }
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 359 of file pcb_base_frame.cpp.

360 {
361  EDA_3D_VIEWER* draw3DFrame = Get3DViewerFrame();
362 
363  if( !draw3DFrame )
364  draw3DFrame = new EDA_3D_VIEWER( &Kiway(), this, _( "3D Viewer" ) );
365 
366  // Raising the window does not show the window on Windows if iconized. This should work
367  // on any platform.
368  if( draw3DFrame->IsIconized() )
369  draw3DFrame->Iconize( false );
370 
371  draw3DFrame->Raise();
372  draw3DFrame->Show( true );
373 
374  // Raising the window does not set the focus on Linux. This should work on any platform.
375  if( wxWindow::FindFocus() != draw3DFrame )
376  draw3DFrame->SetFocus();
377 
378  return draw3DFrame;
379 }
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)
inherited

Function CreateNewLibrary 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.

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.

379 {
380  // Kicad cannot write legacy format libraries, only .pretty new format
381  // because the legacy format cannot handle current features.
382  // The footprint library is actually a directory
383 
384  wxString initialPath = wxPathOnly( Prj().GetProjectFullName() );
385  wxFileName fn;
386  bool doAdd = false;
387 
388  if( aLibName.IsEmpty() )
389  {
390  fn = initialPath;
391 
392  if( !LibraryFileBrowser( false, fn,
394  {
395  return wxEmptyString;
396  }
397 
398  doAdd = true;
399  }
400  else
401  {
402  fn = aLibName;
403 
404  if( !fn.IsAbsolute() )
405  {
406  fn.SetName( aLibName );
407  fn.MakeAbsolute( initialPath );
408  }
409 
410  // Enforce the .pretty extension:
411  fn.SetExt( KiCadFootprintLibPathExtension );
412  }
413 
414  // We can save fp libs only using IO_MGR::KICAD_SEXP format (.pretty libraries)
416  wxString libPath = fn.GetFullPath();
417 
418  try
419  {
420  PLUGIN::RELEASER pi( IO_MGR::PluginFind( piType ) );
421 
422  bool writable = false;
423  bool exists = false;
424 
425  try
426  {
427  writable = pi->IsFootprintLibWritable( libPath );
428  exists = true; // no exception was thrown, lib must exist.
429  }
430  catch( const IO_ERROR& )
431  { }
432 
433  if( exists )
434  {
435  if( !writable )
436  {
437  wxString msg = wxString::Format( _( "Library \"%s\" is read only, not writable" ),
438  libPath );
439  DisplayError( this, 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
RELEASER releases a PLUGIN in the context of a potential thrown exception, through its destructor.
Definition: io_mgr.h:579
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
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)
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:205
#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:61
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(), IO_MGR::KICAD_SEXP, KiCadFootprintLibPathExtension, KiCadFootprintLibPathWildcard(), EDA_DRAW_FRAME::LibraryFileBrowser(), IO_MGR::PluginFind(), KIWAY_HOLDER::Prj(), 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 1002 of file footprint_libraries_utils.cpp.

1003 {
1004  wxString moduleName = aModuleName;
1005 
1006  // Ask for the new module name
1007  if( moduleName.IsEmpty() )
1008  {
1009  WX_TEXT_ENTRY_DIALOG dlg( this, _( "Enter footprint name:" ), _( "New Footprint" ),
1010  moduleName );
1011  dlg.SetTextValidator( MODULE_NAME_CHAR_VALIDATOR( &moduleName ) );
1012 
1013  if( dlg.ShowModal() != wxID_OK )
1014  return NULL; //Aborted by user
1015  }
1016 
1017  moduleName.Trim( true );
1018  moduleName.Trim( false );
1019 
1020  if( moduleName.IsEmpty() )
1021  {
1022  DisplayInfoMessage( this, _( "No footprint name defined." ) );
1023  return NULL;
1024  }
1025 
1026  // Creates the new module and add it to the head of the linked list of modules
1027  MODULE* module = new MODULE( GetBoard() );
1028 
1029  // Update parameters: timestamp ...
1030  module->SetLastEditTime();
1031 
1032  // Update its name in lib
1033  module->SetFPID( LIB_ID( wxEmptyString, moduleName ) );
1034 
1035  PCB_LAYER_ID txt_layer;
1036  wxPoint default_pos;
1038 
1039  module->Reference().SetText( settings.m_DefaultFPTextItems[0].m_Text );
1040  module->Reference().SetVisible( settings.m_DefaultFPTextItems[0].m_Visible );
1041  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[0].m_Layer;
1042  module->Reference().SetLayer( txt_layer );
1043  default_pos.y -= settings.GetTextSize( txt_layer ).y / 2;
1044  module->Reference().SetPosition( default_pos );
1045  default_pos.y += settings.GetTextSize( txt_layer ).y;
1046 
1047  module->Value().SetText( settings.m_DefaultFPTextItems[1].m_Text );
1048  module->Value().SetVisible( settings.m_DefaultFPTextItems[1].m_Visible );
1049  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[1].m_Layer;
1050  module->Value().SetLayer( txt_layer );
1051  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1052  module->Value().SetPosition( default_pos );
1053  default_pos.y += settings.GetTextSize( txt_layer ).y;
1054 
1055  for( size_t i = 2; i < settings.m_DefaultFPTextItems.size(); ++i )
1056  {
1057  TEXTE_MODULE* textItem = new TEXTE_MODULE( module );
1058  textItem->SetText( settings.m_DefaultFPTextItems[i].m_Text );
1059  textItem->SetVisible( settings.m_DefaultFPTextItems[i].m_Visible );
1060  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[i].m_Layer;
1061  textItem->SetLayer( txt_layer );
1062  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1063  textItem->SetPosition( default_pos );
1064  default_pos.y += settings.GetTextSize( txt_layer ).y;
1065  module->GraphicalItems().push_back( textItem );
1066  }
1067 
1068  if( module->GetReference().IsEmpty() )
1069  module->SetReference( moduleName );
1070 
1071  if( module->GetValue().IsEmpty() )
1072  module->SetValue( moduleName );
1073 
1074  module->RunOnChildren(
1075  [&] ( BOARD_ITEM* aChild )
1076  {
1077  if( aChild->Type() == PCB_MODULE_TEXT_T )
1078  {
1079  TEXTE_MODULE* textItem = static_cast<TEXTE_MODULE*>( aChild );
1080  PCB_LAYER_ID layer = textItem->GetLayer();
1081 
1082  textItem->SetTextThickness( settings.GetTextThickness( layer ) );
1083  textItem->SetTextSize( settings.GetTextSize( layer ) );
1084  textItem->SetItalic( settings.GetTextItalic( layer ) );
1085  textItem->SetKeepUpright( settings.GetTextUpright( layer ) );
1086  }
1087  } );
1088 
1089  SetMsgPanel( module );
1090  return module;
1091 }
void SetKeepUpright(bool aKeepUpright)
TEXTE_MODULE & Reference()
Definition: class_module.h:474
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:178
void SetVisible(bool aVisible)
Definition: eda_text.h:184
const wxString GetValue() const
Function GetValue.
Definition: class_module.h:458
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:237
DRAWINGS & GraphicalItems()
Definition: class_module.h:179
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:433
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:116
#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:473
void SetLastEditTime(timestamp_t aTime)
Definition: class_module.h:343
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:443
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:467
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.h:157
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:216
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:52
static TOOL_ACTION selectionTool
Definition: actions.h:146

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

555 {
556  if( !aFPID.IsValid() )
557  return false;
558 
559  wxString nickname = aFPID.GetLibNickname();
560  wxString fpname = aFPID.GetLibItemName();
561 
562  // Legacy libraries are readable, but modifying legacy format is not allowed
563  // So prompt the user if he try to delete a footprint from a legacy lib
564  wxString libfullname = Prj().PcbFootprintLibs()->FindRow( nickname )->GetFullURI();
565 
566  if( IO_MGR::GuessPluginTypeFromLibPath( libfullname ) == IO_MGR::LEGACY )
567  {
569  return false;
570  }
571 
572  if( !Prj().PcbFootprintLibs()->IsFootprintLibWritable( nickname ) )
573  {
574  wxString msg = wxString::Format( _( "Library '%s' is read only" ), nickname );
575  DisplayError( this, msg );
576  return false;
577  }
578 
579  // Confirmation
580  wxString msg = wxString::Format( _( "Delete footprint '%s' from library '%s'?" ),
581  fpname.GetData(),
582  nickname.GetData() );
583 
584  if( aConfirm && !IsOK( this, msg ) )
585  return false;
586 
587  try
588  {
589  Prj().PcbFootprintLibs()->FootprintDelete( nickname, fpname );
590  }
591  catch( const IO_ERROR& ioe )
592  {
593  DisplayError( this, ioe.What() );
594  return false;
595  }
596 
597  msg.Printf( _( "Footprint '%s' deleted from library '%s'" ),
598  fpname.GetData(),
599  nickname.GetData() );
600 
601  SetStatusText( msg );
602 
603  return true;
604 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp: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:127
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:33
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
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:284
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:205
#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(), and IO_ERROR::What().

Referenced by SaveFootprint().

◆ Destroy()

◆ DismissModal()

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

Definition at line 160 of file kiway_player.cpp.

161 {
162  m_modal_ret_val = aRetVal;
163  m_modal_string = aResult;
164 
165  if( m_modal_loop )
166  {
167  m_modal_loop->Exit();
168  m_modal_loop = 0; // this marks it as dismissed.
169  }
170 
171  Show( false );
172 }
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_WIZARD_FRAME::ExportSelectedFootprint(), LIB_VIEW_FRAME::FinishModal(), LIB_VIEW_FRAME::OnCloseWindow(), FOOTPRINT_VIEWER_FRAME::OnCloseWindow(), and FOOTPRINT_WIZARD_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 453 of file pcb_base_frame.cpp.

454 {
455  wxString line;
456  wxString gridformatter;
457 
458  switch( m_userUnits )
459  {
460  case EDA_UNITS::INCHES: gridformatter = "grid X %.6f Y %.6f"; break;
461  case EDA_UNITS::MILLIMETRES: gridformatter = "grid X %.6f Y %.6f"; break;
462  default: gridformatter = "grid X %f Y %f"; break;
463  }
464 
465  double grid_x = To_User_Unit( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x );
466  double grid_y = To_User_Unit( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().y );
467  line.Printf( gridformatter, grid_x, grid_y );
468 
469  SetStatusText( line, 4 );
470 }
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 466 of file eda_draw_frame.cpp.

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

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

495 {
496  wxString msg;
497 
498  switch( m_userUnits )
499  {
500  case EDA_UNITS::INCHES: msg = _( "Inches" ); break;
501  case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
502  default: msg = _( "Units" ); break;
503  }
504 
505  SetStatusText( msg, 5 );
506 }
#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 268 of file eda_base_frame.cpp.

269 {
270  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
271 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ editFootprintProperties()

void FOOTPRINT_EDIT_FRAME::editFootprintProperties ( MODULE aFootprint)
protected

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

Definition at line 334 of file footprint_editor_utils.cpp.

335 {
336  LIB_ID oldFPID = aModule->GetFPID();
337 
338  DIALOG_FOOTPRINT_FP_EDITOR dialog( this, aModule );
339  dialog.ShowModal();
340 
341  // Update library tree
342  BASIC_FOOTPRINT_INFO footprintInfo( aModule );
343  wxDataViewItem treeItem = m_adapter->FindItem( oldFPID );
344 
345  if( treeItem.IsOk() ) // Can be not found in tree if the current footprint is imported from file
346  // therefore not yet in tree.
347  {
348  static_cast<LIB_TREE_NODE_LIB_ID*>( treeItem.GetID() )->Update( &footprintInfo );
350  }
351 
352  updateTitle(); // in case of a name change...
353 
354  UpdateMsgPanel();
355 }
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:218
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 223 of file eda_draw_frame.cpp.

224 {
225  if( m_messagePanel )
227 }
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 235 of file eda_draw_frame.h.

235 {}

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:215
#define NULL
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
#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:205
#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 173 of file pcb_base_frame.cpp.

174 {
175  static KIID lastBrightenedItemID( niluuid );
176 
177  BOARD_ITEM* lastItem = GetBoard()->GetItem( lastBrightenedItemID );
178 
179  if( lastItem && lastItem != aItem )
180  {
181  lastItem->ClearBrightened();
182 
183  if( lastItem->Type() == PCB_MODULE_T )
184  {
185  static_cast<MODULE*>( lastItem )->RunOnChildren( [&] ( BOARD_ITEM* child )
186  {
187  child->ClearBrightened();
188  });
189  }
190 
191  GetCanvas()->GetView()->Update( lastItem );
192  lastBrightenedItemID = niluuid;
193  GetCanvas()->Refresh();
194  }
195 
196  if( aItem )
197  {
198  aItem->SetBrightened();
199 
200  if( aItem->Type() == PCB_MODULE_T )
201  {
202  static_cast<MODULE*>( aItem )->RunOnChildren( [&] ( BOARD_ITEM* child )
203  {
204  child->SetBrightened();
205  });
206  }
207 
208  GetCanvas()->GetView()->Update( aItem );
209  lastBrightenedItemID = aItem->m_Uuid;
210  FocusOnLocation( aItem->GetFocusPosition() );
211  GetCanvas()->Refresh();
212  }
213 }
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:91
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
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:344
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
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(), BOARD::GetItem(), PCB_DRAW_PANEL_GAL::GetView(), EDA_ITEM::m_Uuid, niluuid, 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_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), and DIALOG_DRC::~DIALOG_DRC().

◆ FocusOnLibID()

void FOOTPRINT_EDIT_FRAME::FocusOnLibID ( const LIB_ID aLibID)

Definition at line 799 of file footprint_edit_frame.cpp.

800 {
801  m_treePane->GetLibTree()->SelectLibId( aLibID );
802 }
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:177

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

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

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

78 {
79  return dynamic_cast<EDA_3D_VIEWER*>( FindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( this ) ) );
80 }
#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 488 of file eda_base_frame.h.

488 { return m_AboutTitle; }
wxString m_AboutTitle

References EDA_BASE_FRAME::m_AboutTitle.

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

◆ GetActiveLayer()

◆ GetAutoSaveFilePrefix()

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

Definition at line 165 of file eda_base_frame.h.

166  {
167  return wxT( "_autosave-" );
168  }

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 259 of file eda_base_frame.h.

259 { 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 405 of file pcb_base_frame.h.

405 { return false; }

◆ GetBackupSuffix()

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

Definition at line 157 of file eda_base_frame.h.

158  {
159  return wxT( "-bak" );
160  }

◆ GetBoard()

BOARD* PCB_BASE_FRAME::GetBoard ( ) const
inlineinherited

Definition at line 197 of file pcb_base_frame.h.

198  {
199  wxASSERT( m_Pcb );
200  return m_Pcb;
201  }

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(), 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(), DIALOG_PRINT_PCBNEW::createPrintout(), PANEL_MODEDIT_COLOR_SETTINGS::createSwatches(), PANEL_PCBNEW_COLOR_SETTINGS::createSwatches(), FOOTPRINT_EDITOR_TOOLS::CutCopyFootprint(), PCBNEW_CONTROL::DeleteItemCursor(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), 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(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_CLEANUP_GRAPHICS::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(), 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(), Import_Module(), PCB_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), PCB_EDITOR_CONTROL::ImportSpecctraSession(), DIALOG_PLOT::init_Dialog(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), 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(), DIALOG_DRC::OnActivateDlg(), DIALOG_SELECT_NET_FROM_LIST::onBoardChanged(), DIALOG_IMPORT_SETTINGS::OnBrowseClicked(), OnCloseWindow(), 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(), PCB_LAYER_WIDGET::OnLayerVisible(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), PCB_LAYER_WIDGET::OnRenderEnable(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_NETLIST::OnTestFootprintsClick(), 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_NETCLASSES::PANEL_SETUP_NETCLASSES(), 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(), DIALOG_PLOT::Plot(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingModules(), FOOTPRINT_EDITOR_TOOLS::Properties(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), ReCreateMenuBar(), PCB_LAYER_WIDGET::ReFill(), PCB_LAYER_WIDGET::ReFillRender(), Refresh(), DIALOG_PLOT::reInitDialog(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), DRC::Reset(), DRC::RunTests(), SaveFootprintToBoard(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), DIALOG_BOARD_STATISTICS::saveReportClicked(), DIALOG_FIND::search(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLayer(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), SetElementVisibility(), DIALOG_PLOT::SetPlotFormat(), VECTOR_DRC_ITEMS_PROVIDER::SetSeverities(), ZONE_SETTINGS::SetupLayersList(), setupTools(), DRC_ITEM::ShowHtml(), GLOBAL_EDIT_TOOL::SwapLayers(), PCB_EDIT_FRAME::SwitchLayer(), PCB_LAYER_WIDGET::SyncLayerVisibilities(), SyncToolbars(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), PCBNEW_CONTROL::UpdateMessagePanel(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), DRC::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 314 of file pcb_base_frame.cpp.

315 {
316  wxASSERT( m_Pcb );
317 
318  EDA_RECT area = aBoardEdgesOnly ? m_Pcb->GetBoardEdgesBoundingBox() : m_Pcb->GetBoundingBox();
319 
320  if( area.GetWidth() == 0 && area.GetHeight() == 0 )
321  {
322  wxSize pageSize = GetPageSizeIU();
323 
325  {
326  area.SetOrigin( 0, 0 );
327  area.SetEnd( pageSize.x, pageSize.y );
328  }
329  else
330  {
331  area.SetOrigin( -pageSize.x / 2, -pageSize.y / 2 );
332  area.SetEnd( pageSize.x / 2, pageSize.y / 2 );
333  }
334  }
335 
336  return area;
337 }
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: class_board.h:781
const EDA_RECT GetBoardEdgesBoundingBox() const
Function GetBoardEdgesBoundingBox Returns the board bounding box calculated using exclusively the boa...
Definition: class_board.h:793
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 712 of file pcb_base_frame.cpp.

713 {
714  return static_cast<PCB_DRAW_PANEL_GAL*>( EDA_DRAW_FRAME::GetCanvas() );
715 }
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(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_VIEWER_FRAME::ClickOnLibList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), DIALOG_PRINT_PCBNEW::createPrintout(), PCB_BASE_FRAME::DisplayGridMsg(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), PCB_TOOL_BASE::doInteractiveItemPlacement(), 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(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), EDIT_TOOL::Move(), OnCloseWindow(), FOOTPRINT_VIEWER_FRAME::OnCloseWindow(), DIALOG_DRC::OnDRCItemSelected(), PCB_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnLayerSelect(), PCB_LAYER_WIDGET::OnLayerVisible(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), PCB_LAYER_WIDGET::onPopupSelection(), PCB_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_CLEANUP_GRAPHICS::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(), PCB_INSPECTION_TOOL::ratsnestTimer(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_WIZARD_FRAME::ReCreatePageList(), Refresh(), DIALOG_DRC::refreshBoardEditor(), refreshCallback(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), SELECTION_TOOL::RequestSelection(), RevertFootprint(), DRC::RunTests(), SaveFootprintToBoard(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), DIALOG_FIND::search(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), DRAWING_TOOL::SetAnchor(), PCB_BASE_EDIT_FRAME::SetBoard(), POINT_EDITOR::setEditedPoint(), SetElementVisibility(), 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_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_MODEDIT_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_FRAME::UpdateStatusBar(), UpdateUserInterface(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), updateView(), SELECTION_TOOL::zoomFitSelection(), DIALOG_NETLIST::~DIALOG_NETLIST(), DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME(), PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME(), and PCB_BASE_FRAME::~PCB_BASE_FRAME().

◆ GetCollectorsGuide()

GENERAL_COLLECTORS_GUIDE PCB_BASE_FRAME::GetCollectorsGuide ( )
inherited

Function GetCollectorsGuide.

Returns
GENERAL_COLLECTORS_GUIDE - that considers the global configuration options.

Definition at line 425 of file pcb_base_frame.cpp.

426 {
428  GetCanvas()->GetView() );
429 
430  // account for the globals
432  guide.SetIgnoreMTextsOnBack( ! m_Pcb->IsElementVisible( LAYER_MOD_TEXT_BK ) );
433  guide.SetIgnoreMTextsOnFront( ! m_Pcb->IsElementVisible( LAYER_MOD_TEXT_FR ) );
434  guide.SetIgnoreModulesOnBack( ! m_Pcb->IsElementVisible( LAYER_MOD_BK ) );
435  guide.SetIgnoreModulesOnFront( ! m_Pcb->IsElementVisible( LAYER_MOD_FR ) );
436  guide.SetIgnorePadsOnBack( ! m_Pcb->IsElementVisible( LAYER_PAD_BK ) );
437  guide.SetIgnorePadsOnFront( ! m_Pcb->IsElementVisible( LAYER_PAD_FR ) );
438  guide.SetIgnoreThroughHolePads( ! m_Pcb->IsElementVisible( LAYER_PADS_TH ) );
439  guide.SetIgnoreModulesVals( ! m_Pcb->IsElementVisible( LAYER_MOD_VALUES ) );
440  guide.SetIgnoreModulesRefs( ! m_Pcb->IsElementVisible( LAYER_MOD_REFERENCES ) );
441  guide.SetIgnoreThroughVias( ! m_Pcb->IsElementVisible( LAYER_VIA_THROUGH ) );
442  guide.SetIgnoreBlindBuriedVias( ! m_Pcb->IsElementVisible( LAYER_VIA_BBLIND ) );
443  guide.SetIgnoreMicroVias( ! m_Pcb->IsElementVisible( LAYER_VIA_MICROVIA ) );
444  guide.SetIgnoreTracks( ! m_Pcb->IsElementVisible( LAYER_TRACKS ) );
445 
446  return guide;
447 }
to draw blind/buried vias
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
to draw usual through hole vias
void SetIgnoreMTextsMarkedNoShow(bool ignore)
Definition: collectors.h:541
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
A general implementation of a COLLECTORS_GUIDE.
Definition: collectors.h:385
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_VIA_BBLIND, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, 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 454 of file footprint_edit_frame.cpp.

455 {
456  return Pgm().GetSettingsManager().GetColorSettings(
457  GetFootprintEditorSettings()->m_ColorTheme );
458 }
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 418 of file eda_base_frame.h.

418 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

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

399 {
400  return GetBoard()->GetDesignSettings();
401 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:551
BOARD * GetBoard() const

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

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

◆ GetDisplayOptions()

◆ GetDocumentExtents()

const BOX2I FOOTPRINT_EDIT_FRAME::GetDocumentExtents ( ) const
overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 470 of file footprint_edit_frame.cpp.

471 {
472  MODULE* module = GetBoard()->GetFirstModule();
473 
474  if( module )
475  {
476  bool hasGraphicalItem = module->Pads().size() || module->Zones().size();
477 
478  if( !hasGraphicalItem )
479  {
480  for( const BOARD_ITEM* item : module->GraphicalItems() )
481  {
482  if( item->Type() == PCB_MODULE_TEXT_T )
483  continue;
484 
485  hasGraphicalItem = true;
486  break;
487  }
488  }
489 
490  if( hasGraphicalItem )
491  {
492  return module->GetFootprintRect();
493  }
494  else
495  {
496  BOX2I newModuleBB( { 0, 0 }, { 0, 0 } );
497  newModuleBB.Inflate( Millimeter2iu( 12 ) );
498  return newModuleBB;
499  }
500  }
501 
502  return GetBoardBoundingBox( false );
503 }
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
PADS & Pads()
Definition: class_module.h:169
EDA_RECT GetFootprintRect() const
Function GetFootprintRect() Returns the area of the module footprint excluding any text.
DRAWINGS & GraphicalItems()
Definition: class_module.h:179
BOX2 handles a 2-D bounding box, built on top of an origin point and size vector, both of templated c...
Definition: box2.h:42
MODULE * GetFirstModule() const
Gets the first module in the list (used in footprint viewer/editor) or NULL if none.
Definition: class_board.h:330
EDA_RECT GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Function GetBoardBoundingBox calculates the bounding box containing all board items (or board edge se...
const MODULE_ZONE_CONTAINERS & Zones() const
Definition: class_module.h:184
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:301
BOARD * GetBoard() const

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

95 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:59

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

101 { return m_dragSelects; }
bool m_dragSelects
Definition: tools_holder.h:63

References TOOLS_HOLDER::m_dragSelects.

Referenced by EE_SELECTION_TOOL::Main().

◆ GetDrawBgColor()

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

602 {
603  if( !aFileHistory )
604  aFileHistory = m_fileHistory;
605 
606  wxASSERT( aFileHistory );
607 
608  int baseId = aFileHistory->GetBaseId();
609 
610  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
611 
612  unsigned i = cmdId - baseId;
613 
614  if( i < aFileHistory->GetCount() )
615  {
616  wxString fn = aFileHistory->GetHistoryFile( i );
617 
618  if( wxFileName::FileExists( fn ) )
619  return fn;
620  else
621  {
622  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
623  wxMessageBox( msg );
624 
625  aFileHistory->RemoveFileFromHistory( i );
626  }
627  }
628 
629  // Update the menubar to update the file history menu
630  if( GetMenuBar() )
631  {
632  ReCreateMenuBar();
633  GetMenuBar()->Refresh();
634  }
635 
636  return wxEmptyString;
637 }
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:205
#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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

Definition at line 169 of file eda_draw_frame.h.

169 { 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 168 of file eda_draw_frame.h.

168 { 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 392 of file footprint_edit_frame.cpp.

393 {
395 }
#define FOOTPRINT_EDIT_FRAME_NAME

References FOOTPRINT_EDIT_FRAME_NAME.

◆ GetFootprintEditorSettings()

FOOTPRINT_EDITOR_SETTINGS * PCB_BASE_FRAME::GetFootprintEditorSettings ( )
inherited

Definition at line 676 of file pcb_base_frame.cpp.

677 {
678  return Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
679 }
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 439 of file load_select_footprint.cpp.

440 {
441  wxString moduleName;
442  wxArrayString fplist;
443 
444  // Build list of available fp references, to display them in dialog
445  for( auto fp : GetBoard()->Modules() )
446  fplist.Add( fp->GetReference() + wxT(" ( ") + fp->GetValue() + wxT(" )") );
447 
448  fplist.Sort();
449 
450  DIALOG_GET_FOOTPRINT_BY_NAME dlg( this, fplist );
451 
452  if( dlg.ShowModal() != wxID_OK ) //Aborted by user
453  return NULL;
454 
455  moduleName = dlg.GetValue();
456  moduleName.Trim( true );
457  moduleName.Trim( false );
458 
459  if( !moduleName.IsEmpty() )
460  {
461  for( auto mod : GetBoard()->Modules() )
462  {
463  if( mod->GetReference().CmpNoCase( moduleName ) == 0 )
464  return mod;
465  }
466  }
467 
468  return nullptr;
469 }
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:266
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 418 of file footprint_editor_utils.cpp.

419 {
420  return GetColorSettings()->GetColor( LAYER_GRID );
421 }
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 244 of file pcb_base_frame.cpp.

245 {
246  wxASSERT( m_Pcb );
248 }
wxPoint m_GridOrigin
origin for grid offsets
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:551

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

◆ GetInfoBar()

WX_INFOBAR* EDA_BASE_FRAME::GetInfoBar ( )
inlineinherited

Definition at line 277 of file eda_base_frame.h.

277 { return m_infoBar; }
WX_INFOBAR * m_infoBar

References EDA_BASE_FRAME::m_infoBar.

Referenced by PAD_TOOL::EditPad().

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

168 {
169  return GetBoard()->GetItem( aId );
170 }
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 170 of file footprint_edit_frame.h.

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

328 {
329  MODULE* module = GetBoard()->GetFirstModule();
330 
331  if( module )
333  else
334  return LIB_ID();
335 }
const LIB_ID & GetFPID() const
Definition: class_module.h:215
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:330
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(), SyncToolbars(), and updateTitle().

◆ GetMagneticItemsSettings()

MAGNETIC_SETTINGS * FOOTPRINT_EDIT_FRAME::GetMagneticItemsSettings ( )
overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 461 of file footprint_edit_frame.cpp.

462 {
463  // Get the actual frame settings for magnetic items
465  wxCHECK( cfg, nullptr );
466  return &cfg->m_MagneticItems;
467 }
FOOTPRINT_EDITOR_SETTINGS * GetSettings()

References GetSettings(), and FOOTPRINT_EDITOR_SETTINGS::m_MagneticItems.

◆ GetModel()

BOARD_ITEM_CONTAINER * FOOTPRINT_EDIT_FRAME::GetModel ( ) const
overridevirtual

Implements PCB_BASE_FRAME.

Definition at line 298 of file footprint_edit_frame.cpp.

299 {
300  return GetBoard()->GetFirstModule();
301 }
MODULE * GetFirstModule() const
Gets the first module in the list (used in footprint viewer/editor) or NULL if none.
Definition: class_board.h:330
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 107 of file tools_holder.h.

107 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:64

References TOOLS_HOLDER::m_moveWarpsCursor.

Referenced by 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 727 of file eda_draw_frame.cpp.

728 {
729  const wxPoint& gridOrigin = GetGridOrigin();
730  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
731 
732  double xOffset = fmod( gridOrigin.x, gridSize.x );
733  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
734  double yOffset = fmod( gridOrigin.y, gridSize.y );
735  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
736 
737  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
738 }
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().

◆ GetPageSettings()

const PAGE_INFO & PCB_BASE_FRAME::GetPageSettings ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 226 of file pcb_base_frame.cpp.

227 {
228  wxASSERT( m_Pcb );
229  return m_Pcb->GetPageSettings();
230 }
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:572

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

234 {
235  wxASSERT( m_Pcb );
236 
237  // this function is only needed because EDA_DRAW_FRAME is not compiled
238  // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
239  // into an application specific source file.
240  return m_Pcb->GetPageSettings().GetSizeIU();
241 }
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:572

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

671 {
672  return Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
673 }
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_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_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 404 of file footprint_edit_frame.cpp.

405 {
406  wxFAIL_MSG( "Plotting not supported in Footprint Editor" );
407 
409 }
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().

◆ GetRotationAngle()

int PCB_BASE_EDIT_FRAME::GetRotationAngle ( ) const
inlineinherited

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

Definition at line 169 of file pcb_base_edit_frame.h.

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

References PCB_BASE_EDIT_FRAME::m_rotationAngle.

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

◆ GetScreen()

PCB_SCREEN* PCB_BASE_FRAME::GetScreen ( ) const
inlineoverridevirtualinherited

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

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 220 of file pcb_base_frame.h.

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

References EDA_DRAW_FRAME::GetScreen().

Referenced by Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::doAutoSave(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Files_io_from_id(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetActiveLayer(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), IsContentModified(), PCBNEW_CONTROL::LayerToggle(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_BASE_FRAME::OnModify(), DIALOG_POSITION_RELATIVE::OnUseUserOriginClick(), ROUTER_TOOL::onViaCommand(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::PrepareLayerIndicator(), ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), RevertFootprint(), PCB_EDIT_FRAME::SavePcbFile(), DIALOG_FIND::search(), ROUTER_TOOL::SelectCopperLayerPair(), PCB_BASE_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPageSettings(), SyncToolbars(), PCB_EDIT_FRAME::SyncToolbars(), PCB_BASE_FRAME::UpdateStatusBar(), and DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 865 of file eda_draw_frame.cpp.

866 {
867  // Virtual function. Base class implementation returns an empty string.
868  return wxEmptyString;
869 }

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

◆ GetSettings()

FOOTPRINT_EDITOR_SETTINGS * FOOTPRINT_EDIT_FRAME::GetSettings ( )

Definition at line 418 of file footprint_edit_frame.cpp.

419 {
420  if( !m_settings )
421  m_settings = Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
422 
423  return m_settings;
424 }
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(), Export_Module(), GetMagneticItemsSettings(), Import_Module(), LoadSettings(), OnCloseWindow(), 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 644 of file pcb_base_frame.cpp.

645 {
646  if( aErrorCode >= CLEANUP_FIRST )
647  return RPT_SEVERITY_ACTION;
648 
650 
651  return bds.m_DRCSeverities[ aErrorCode ];
652 }
std::map< int, int > m_DRCSeverities
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:551
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()

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

317 {
318  LIB_ID id = GetTreeFPID();
319 
320  if( id.GetLibNickname().empty() )
321  return GetLoadedFPID();
322 
323  return id;
324 }
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 ReCreateMenuBar(), RegenerateLibraryTree(), and SyncLibraryTree().

◆ GetTitleBlock()

const TITLE_BLOCK & PCB_BASE_FRAME::GetTitleBlock ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 258 of file pcb_base_frame.cpp.

259 {
260  wxASSERT( m_Pcb );
261  return m_Pcb->GetTitleBlock();
262 }
TITLE_BLOCK & GetTitleBlock()
Definition: class_board.h:578

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

456 { 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 74 of file tools_holder.h.

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

References TOOLS_HOLDER::m_toolManager.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), LIB_CONTROL::AddSymbolToSchematic(), BOARD_COMMIT::BOARD_COMMIT(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), 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(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LIB_EDIT_FRAME::LoadPart(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_INSPECTOR::onCellClicked(), SIM_PLOT_FRAME::onClose(), SYMBOL_TREE_PANE::onComponentSelected(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_ERC::OnERCItemSelected(), FOOTPRINTS_LISTBOX::OnLeftDClick(), SIM_PLOT_FRAME::onProbe(), DIALOG_PLOT::onRunDRC(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), 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(), EDA_3D_VIEWER::SaveSettings(), DIALOG_FIND::search(), CVPCB_MAINFRAME::setupEventHandlers(), PCB_LAYER_WIDGET::SyncLayerAlphaIndicators(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::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(), 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 304 of file footprint_edit_frame.cpp.

305 {
307 }
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:148
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().

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 209 of file eda_base_frame.h.

210  {
211  return m_userUnits;
212  }
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(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), GERBER_FILE_IMAGE::DisplayImageInfo(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), 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(), LIB_ARC::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), MARKER_PCB::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), TEXTE_PCB::GetMsgPanelInfo(), ZONE_CONTAINER::GetMsgPanelInfo(), WS_DRAW_ITEM_BASE::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), TEXTE_MODULE::GetMsgPanelInfo(), DRAWSEGMENT::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), LIB_PIN::getMsgPanelInfoBase(), PANEL_SETUP_NETCLASSES::getNetclassValue(), GetUserUnits(), RC_TREE_MODEL::GetValue(), GRID_MENU::GRID_MENU(), 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(), ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), DRC_ITEM::ShowHtml(), DISPLAY_FOOTPRINTS_FRAME::SyncToolbars(), FOOTPRINT_VIEWER_FRAME::SyncToolbars(), SyncToolbars(), LIB_EDIT_FRAME::SyncToolbars(), GERBVIEW_FRAME::SyncToolbars(), PCB_EDIT_FRAME::SyncToolbars(), SCH_EDIT_FRAME::SyncToolbars(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), PANEL_EESCHEMA_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_SETTINGS::TransferDataToWindow(), PANEL_EDIT_OPTIONS::TransferDataToWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), GRID_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), GERBVIEW_FRAME::updateDCodeSelectBox(), 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::userUnits(), PANEL_SETUP_TRACKS_AND_VIAS::validateData(), and PANEL_SETUP_NETCLASSES::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 551 of file eda_base_frame.cpp.

552 {
553  return &aCfg->m_Window;
554 }
WINDOW_SETTINGS m_Window
Definition: app_settings.h:153

References APP_SETTINGS_BASE::m_Window.

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

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )
inherited

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

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

Returns
the undecorated window size

Definition at line 828 of file eda_base_frame.cpp.

829 {
830 #ifdef __WXGTK__
831  // GTK includes the window decorations in the normal GetSize call,
832  // so we have to use a GTK-specific sizing call that returns the
833  // non-decorated window size.
834  int width = 0;
835  int height = 0;
836  GTKDoGetSize( &width, &height );
837 
838  wxSize winSize( width, height );
839 #else
840  wxSize winSize = GetSize();
841 #endif
842 
843  return winSize;
844 }

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

◆ GetZoneSettings()

const ZONE_SETTINGS & PCB_BASE_FRAME::GetZoneSettings ( ) const
inherited

Definition at line 286 of file pcb_base_frame.cpp.

287 {
288  wxASSERT( m_Pcb );
290 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:551
ZONE_SETTINGS & GetDefaultZoneSettings()

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

Referenced by PCB_EDIT_FRAME::Edit_Zone_Params().

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const
inherited

Return a human readable value for display in dialogs.

Definition at line 529 of file eda_draw_frame.cpp.

530 {
531  // returns a human readable value which can be displayed as zoom
532  // level indicator in dialogs.
533  double zoom = m_canvas->GetGAL()->GetZoomFactor() / ZOOM_COEFF;
534  return wxString::Format( wxT( "Z %.2f" ), zoom );
535 }
#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:205

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

Referenced by EDA_DRAW_FRAME::UpdateStatusBar().

◆ HardRedraw()

void FOOTPRINT_EDIT_FRAME::HardRedraw ( )
overridevirtual

Refresh the library tree and redraw the window.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 277 of file footprint_edit_frame.cpp.

278 {
279  SyncLibraryTree( true );
280  GetCanvas()->ForceRefresh();
281 }
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 570 of file eda_base_frame.cpp.

571 {
572  return Kiface().GetHelpFileName();
573 }
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:718
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:33
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:269
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:205
#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:216

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,
const wxString &  aDefaultShortname 
)
inherited

Prompt the user for a hotkey file to read, and read it.

Parameters
aActionMap= current hotkey map (over which the imported hotkeys will be applied)
aDefaultShortname= a default short name (extension not needed) like eechema, kicad...

◆ InitExitKey()

void EDA_DRAW_FRAME::InitExitKey ( )
protectedinherited

Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.

This is useful in sub-applications to pass the event up to a non-owning window

Definition at line 457 of file eda_draw_frame.cpp.

458 {
459  wxAcceleratorEntry entries[1];
460  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
461  wxAcceleratorTable accel( 1, entries );
462  SetAcceleratorTable( accel );
463 }

Referenced by FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME().

◆ initLibraryTree()

void FOOTPRINT_EDIT_FRAME::initLibraryTree ( )
protected

Make sure the footprint info list is loaded (with a progress dialog) and then initialize the footprint library tree.

Definition at line 726 of file footprint_edit_frame.cpp.

727 {
728  FP_LIB_TABLE* fpTable = Prj().PcbFootprintLibs();
729 
730  WX_PROGRESS_REPORTER progressReporter( this, _( "Loading Footprint Libraries" ), 2 );
731  GFootprintList.ReadFootprintFiles( fpTable, NULL, &progressReporter );
732  progressReporter.Show( false );
733 
736 
738  auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
739 
740  adapter->AddLibraries();
741 }
void DisplayErrors(wxTopLevelWindow *aCaller=NULL)
FOOTPRINT_LIST_IMPL GFootprintList
The global footprint info table.
#define NULL
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:284
LIB_TREE_MODEL_ADAPTER::PTR m_adapter
#define _(s)
Definition: 3d_actions.cpp:33
unsigned GetErrorCount() const
bool ReadFootprintFiles(FP_LIB_TABLE *aTable, const wxString *aNickname=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr) override
Read all the footprints provided by the combination of aTable and aNickname.
static PTR Create(FOOTPRINT_EDIT_FRAME *aFrame, FP_LIB_TABLE *aLibs)

References _, FP_TREE_SYNCHRONIZING_ADAPTER::Create(), FOOTPRINT_LIST::DisplayErrors(), FOOTPRINT_LIST::GetErrorCount(), GFootprintList, m_adapter, NULL, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), and FOOTPRINT_LIST_IMPL::ReadFootprintFiles().

◆ InstallGraphicItemPropertiesDialog()

void PCB_BASE_EDIT_FRAME::InstallGraphicItemPropertiesDialog ( BOARD_ITEM aItem)
inherited

Definition at line 131 of file dialog_graphic_item_properties.cpp.

132 {
133  wxCHECK_RET( aItem != NULL, wxT( "InstallGraphicItemPropertiesDialog() error: NULL item" ) );
134 
135  DIALOG_GRAPHIC_ITEM_PROPERTIES dlg( this, aItem );
136  dlg.ShowModal();
137 }
#define NULL

References NULL.

Referenced by PCB_EDIT_FRAME::OnEditItemRequest().

◆ InstallPadOptionsFrame()

void PCB_BASE_FRAME::InstallPadOptionsFrame ( D_PAD pad)
inherited

Definition at line 99 of file dialog_pad_properties.cpp.

100 {
101  DIALOG_PAD_PROPERTIES dlg( this, aPad );
102 
103  if( dlg.ShowQuasiModal() == wxID_OK ) // QuasiModal required for NET_SELECTOR
104  {
105  // aPad can be NULL, if the dialog is called from the footprint editor
106  // to set the default pad setup
107  if( aPad )
108  {
109  PAD_TOOL* padTools = m_toolManager->GetTool<PAD_TOOL>();
110 
111  if( padTools )
112  padTools->SetLastPadName( aPad->GetName() );
113  }
114  }
115 }
PAD_TOOL.
Definition: pad_tool.h:37
DIALOG_PAD_PROPERTIES, derived from DIALOG_PAD_PROPERTIES_BASE, created by wxFormBuilder.
void SetLastPadName(const wxString &aPadName)
Definition: pad_tool.h:74
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48

References D_PAD::GetName(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::m_toolManager, PAD_TOOL::SetLastPadName(), and DIALOG_SHIM::ShowQuasiModal().

Referenced by PCB_EDIT_FRAME::OnEditItemRequest().

◆ InstallPreferences()

void FOOTPRINT_EDIT_FRAME::InstallPreferences ( PAGED_DIALOG aParent,
PANEL_HOTKEYS_EDITOR aHotkeysPanel 
)
overridevirtual

Allows Modedit to install its preferences panel into the preferences dialog.

Reimplemented from EDA_BASE_FRAME.

Definition at line 825 of file footprint_edit_frame.cpp.

827 {
828  wxTreebook* book = aParent->GetTreebook();
829 
830  book->AddPage( new wxPanel( book ), _( "Footprint Editor" ) );
831  book->AddSubPage( new PANEL_DISPLAY_OPTIONS( this, aParent ), _( "Display Options" ) );
832  book->AddSubPage( new PANEL_MODEDIT_COLOR_SETTINGS( this, book ), _( "Colors" ) );
833  book->AddSubPage( new PANEL_EDIT_OPTIONS( this, aParent ), _( "Editing Options" ) );
834  book->AddSubPage( new PANEL_MODEDIT_DEFAULTS( this, aParent ), _( "Default Values" ) );
835 
836  aHotkeysPanel->AddHotKeys( GetToolManager() );
837 }
void AddHotKeys(TOOL_MANAGER *aToolMgr)
wxTreebook * GetTreebook()
Definition: paged_dialog.h:45
#define _(s)
Definition: 3d_actions.cpp:33
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:74

References _, PANEL_HOTKEYS_EDITOR::AddHotKeys(), TOOLS_HOLDER::GetToolManager(), and PAGED_DIALOG::GetTreebook().

◆ InstallTextOptionsFrame()

void PCB_BASE_EDIT_FRAME::InstallTextOptionsFrame ( BOARD_ITEM aText)
inherited

Routine for main window class to launch text properties dialog.

Definition at line 205 of file dialog_text_properties.cpp.

206 {
207  DIALOG_TEXT_PROPERTIES dlg( this, aText );
208  dlg.ShowModal();
209 }

Referenced by PCB_EDIT_FRAME::OnEditItemRequest(), and DRAWING_TOOL::PlaceText().

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const
inlineprotectedvirtualinherited

Return the auto save status of the application.

Override this function if your derived frame supports automatic file saving.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 180 of file eda_base_frame.h.

180 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool FOOTPRINT_EDIT_FRAME::IsContentModified ( )
overridevirtual

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

Returns
true if the any changes have not been saved

Reimplemented from EDA_BASE_FRAME.

Definition at line 257 of file footprint_edit_frame.cpp.

258 {
259  return GetScreen() && GetScreen()->IsModify() && GetBoard() && GetBoard()->GetFirstModule();
260 }
MODULE * GetFirstModule() const
Gets the first module in the list (used in footprint viewer/editor) or NULL if none.
Definition: class_board.h:330
bool IsModify() const
Definition: base_screen.h:187
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstModule(), PCB_BASE_FRAME::GetScreen(), and BASE_SCREEN::IsModify().

Referenced by Clear_Pcb(), OnCloseWindow(), ReCreateMenuBar(), and SyncToolbars().

◆ IsCurrentFPFromBoard()

bool FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard ( ) const

Definition at line 338 of file footprint_edit_frame.cpp.

339 {
340  MODULE* module = GetBoard()->GetFirstModule();
341 
342  return ( module && module->GetLink() != niluuid );
343 }
KIID niluuid(0)
MODULE * GetFirstModule() const
Gets the first module in the list (used in footprint viewer/editor) or NULL if none.
Definition: class_board.h:330
KIID GetLink() const
Definition: class_module.h:546
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstModule(), MODULE::GetLink(), and niluuid.

Referenced by FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), ReCreateHToolbar(), ReCreateMenuBar(), SyncToolbars(), and updateTitle().

◆ IsCurrentTool()

bool TOOLS_HOLDER::IsCurrentTool ( const TOOL_ACTION aAction) const
inherited

Definition at line 108 of file tools_holder.cpp.

109 {
110  if( m_toolStack.empty() )
111  return &aAction == &ACTIONS::selectionTool;
112  else
113  return m_toolStack.back() == aAction.GetName();
114 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:52
static TOOL_ACTION selectionTool
Definition: actions.h:146
const std::string & GetName() const
Function GetName() Returns name of the action.
Definition: tool_action.h:78

References TOOL_ACTION::GetName(), TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by PCB_INSPECTION_TOOL::HighlightNetTool(), SCH_EDIT_TOOL::Init(), PCB_EDITOR_CONTROL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), DISPLAY_FOOTPRINTS_FRAME::SyncToolbars(), FOOTPRINT_VIEWER_FRAME::SyncToolbars(), and LIB_EDIT_FRAME::SyncToolbars().

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )
inherited

Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal().

IOW, it will return true if the dialog is not modal or if it is modal and has been dismissed.

Definition at line 154 of file kiway_player.cpp.

155 {
156  return !m_modal_loop;
157 }
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:202

References KIWAY_PLAYER::m_modal_loop.

Referenced by LIB_VIEW_FRAME::OnCloseWindow(), FOOTPRINT_VIEWER_FRAME::OnCloseWindow(), and FOOTPRINT_WIZARD_FRAME::OnCloseWindow().

◆ IsElementVisible()

bool FOOTPRINT_EDIT_FRAME::IsElementVisible ( GAL_LAYER_ID  aElement) const

Test whether a given element category is visible.

Parameters
aElementis from the enum by the same name
Returns
bool - true if the element is visible.
See also
enum PCB_LAYER_ID

Definition at line 805 of file footprint_edit_frame.cpp.

806 {
807  return GetBoard()->IsElementVisible( aElement );
808 }
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Function IsElementVisible tests whether a given element category is visible.
BOARD * GetBoard() const

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

◆ IsGridVisible()

◆ IsModal()

◆ IsSearchTreeShown()

bool FOOTPRINT_EDIT_FRAME::IsSearchTreeShown ( )

Definition at line 292 of file footprint_edit_frame.cpp.

293 {
294  return m_auimgr.GetPane( m_treePane ).IsShown();
295 }
wxAuiManager m_auimgr
FOOTPRINT_TREE_PANE * m_treePane

References EDA_BASE_FRAME::m_auimgr, and m_treePane.

Referenced by ReCreateMenuBar(), SyncToolbars(), and ToggleSearchTree().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 261 of file eda_base_frame.h.

261 { return m_Ident == aType; }

References EDA_BASE_FRAME::m_Ident.

Referenced by LIB_CONTROL::AddLibrary(), PCBNEW_CONTROL::AddLibrary(), LIB_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), EDA_3D_VIEWER::CreateMenuBar(), LIB_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), LIB_CONTROL::DuplicateSymbol(), LIB_CONTROL::EditSymbol(), LIB_CONTROL::ExportSymbol(), MODULE::GetMsgPanelInfo(), LIB_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PICKER_TOOL::Main(), LIB_CONTROL::OnDeMorgan(), PCB_LAYER_WIDGET::OnRenderEnable(), PCBNEW_CONTROL::Paste(), LIB_CONTROL::PinLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), LIB_CONTROL::Revert(), EE_INSPECTION_TOOL::RunERC(), LIB_CONTROL::Save(), LIB_CONTROL::ShowComponentTree(), EE_INSPECTION_TOOL::ShowDatasheet(), LIB_CONTROL::UnpinLibrary(), and COMMON_TOOLS::ZoomFitScreen().

◆ IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName &  aFileName)
inherited

Checks if aFileName can be written.

The function performs a number of tests on aFileName to verify that it can be saved. If aFileName defines a path with no file name, them the path is tested for user write permission. If aFileName defines a file name that does not exist in the path, the path is tested for user write permission. If aFileName defines a file that already exits, the file name is tested for user write permissions.

Note
The file name path must be set or an assertion will be raised on debug builds and return false on release builds.
Parameters
aFileNameThe full path and/or file name of the file to test.
Returns
False if aFileName cannot be written.

Definition at line 699 of file eda_base_frame.cpp.

700 {
701  wxString msg;
702  wxFileName fn = aFileName;
703 
704  // Check for absence of a file path with a file name. Unfortunately KiCad
705  // uses paths relative to the current project path without the ./ part which
706  // confuses wxFileName. Making the file name path absolute may be less than
707  // elegant but it solves the problem.
708  if( fn.GetPath().IsEmpty() && fn.HasName() )
709  fn.MakeAbsolute();
710 
711  wxCHECK_MSG( fn.IsOk(), false,
712  wxT( "File name object is invalid. Bad programmer!" ) );
713  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
714  wxT( "File name object path <" ) + fn.GetFullPath() +
715  wxT( "> is not set. Bad programmer!" ) );
716 
717  if( fn.IsDir() && !fn.IsDirWritable() )
718  {
719  msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
720  GetChars( fn.GetPath() ) );
721  }
722  else if( !fn.FileExists() && !fn.IsDirWritable() )
723  {
724  msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
725  GetChars( fn.GetFullName() ), GetChars( fn.GetPath() ) );
726  }
727  else if( fn.FileExists() && !fn.IsFileWritable() )
728  {
729  msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
730  GetChars( fn.GetFullPath() ) );
731  }
732 
733  if( !msg.IsEmpty() )
734  {
735  wxMessageBox( msg );
736  return false;
737  }
738 
739  return true;
740 }
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
#define _(s)
Definition: 3d_actions.cpp:33

References _, and GetChars().

Referenced by SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::SaveEEFile(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProjectSettings(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:81

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), OnUpdateInsertModuleInBoard(), OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS aEvent)
protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 175 of file kiway_player.cpp.

176 {
177  // logging support
178  KiwayMailIn( aEvent ); // call the virtual, override in derived.
179 }
virtual void KiwayMailIn(KIWAY_EXPRESS &aEvent)
Function KiwayMailIn receives KIWAY_EXPRESS messages from other players.

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void FOOTPRINT_EDIT_FRAME::KiwayMailIn ( KIWAY_EXPRESS aEvent)
overridevirtual

Function KiwayMailIn receives KIWAY_EXPRESS messages from other players.

Merely override it in derived classes.

Reimplemented from KIWAY_PLAYER.

Definition at line 456 of file footprint_editor_utils.cpp.

457 {
458  const std::string& payload = mail.GetPayload();
459 
460  switch( mail.Command() )
461  {
462  case MAIL_FP_EDIT:
463  if( !payload.empty() )
464  {
465  wxFileName fpFileName( payload );
466  wxString libNickname;
467  wxString msg;
468 
469  FP_LIB_TABLE* libTable = Prj().PcbFootprintLibs();
470  const LIB_TABLE_ROW* libTableRow = libTable->FindRowByURI( fpFileName.GetPath() );
471 
472  if( !libTableRow )
473  {
474  msg.Printf( _( "The current configuration does not include the footprint library\n"
475  "\"%s\".\nUse Manage Footprint Libraries to edit the configuration." ),
476  fpFileName.GetPath() );
477  DisplayErrorMessage( this, _( "Library not found in footprint library table." ), msg );
478  break;
479  }
480 
481  libNickname = libTableRow->GetNickName();
482 
483  if( !libTable->HasLibrary( libNickname, true ) )
484  {
485  msg.Printf( _( "The library with the nickname \"%s\" is not enabled\n"
486  "in the current configuration. Use Manage Footprint Libraries to\n"
487  "edit the configuration." ), libNickname );
488  DisplayErrorMessage( this, _( "Footprint library not enabled." ), msg );
489  break;
490  }
491 
492  LIB_ID fpId( libNickname, fpFileName.GetName() );
493 
494  if( m_treePane )
495  {
496  m_treePane->GetLibTree()->SelectLibId( fpId );
497  wxCommandEvent event( COMPONENT_SELECTED );
498  wxPostEvent( m_treePane, event );
499  }
500  }
501 
502  break;
503 
504  default:
505  ;
506  }
507 }
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:252
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
const wxString & GetNickName() const
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
const LIB_TABLE_ROW * FindRowByURI(const wxString &aURI)
LIB_TREE * GetLibTree() const
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:284
#define _(s)
Definition: 3d_actions.cpp:33
FOOTPRINT_TREE_PANE * m_treePane
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition: lib_tree.cpp:177

References _, KIWAY_EXPRESS::Command(), DisplayErrorMessage(), LIB_TABLE::FindRowByURI(), LIB_TABLE_ROW::GetNickName(), KIWAY_EXPRESS::GetPayload(), LIB_TABLE::HasLibrary(), MAIL_FP_EDIT, PROJECT::PcbFootprintLibs(), and Prj().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

Function language_change is an event handler called on a language menu selection.

Definition at line 182 of file kiway_player.cpp.

183 {
184  int id = event.GetId();
185 
186  // tell all the KIWAY_PLAYERs about the language change.
187  Kiway().SetLanguage( id );
188 }
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
VTBL_ENTRY void SetLanguage(int aLanguage)
Function SetLanguage changes the language and then calls ShowChangedLanguage() on all KIWAY_PLAYERs.
Definition: kiway.cpp:436

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

◆ LibraryFileBrowser()

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

Definition at line 871 of file eda_draw_frame.cpp.

874 {
875  wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
876  aFilename.SetExt( ext );
877 
878  if( isDirectory && doOpen )
879  {
880  wxDirDialog dlg( this, prompt, Prj().GetProjectPath(),
881  wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
882 
883  if( dlg.ShowModal() == wxID_CANCEL )
884  return false;
885 
886  aFilename = dlg.GetPath();
887  aFilename.SetExt( ext );
888  }
889  else
890  {
891  wxFileDialog dlg( this, prompt, Prj().GetProjectPath(), aFilename.GetFullName() ,
892  wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
893  : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
894 
895  if( dlg.ShowModal() == wxID_CANCEL )
896  return false;
897 
898  aFilename = dlg.GetPath();
899  aFilename.SetExt( ext );
900  }
901 
902  return true;
903 }
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
#define _(s)
Definition: 3d_actions.cpp:33

References _, and KIWAY_HOLDER::Prj().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_EDIT_FRAME::AddLibraryFile(), and PCB_BASE_EDIT_FRAME::CreateNewLibrary().

◆ Load_Module_From_BOARD()