KiCad PCB EDA Suite
FOOTPRINT_WIZARD_FRAME Class Reference

#include <footprint_wizard_frame.h>

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

Public Types

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

Public Member Functions

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

Static Public Member Functions

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

Protected Member Functions

FP_LIB_TABLEselectLibTable (bool aOptional=false)
 Prompts a user to select global or project library tables. More...
 
wxString createNewLibrary (const wxString &aLibName, const wxString &aProposedName, FP_LIB_TABLE *aTable)
 Create a new library in the given table (presumed to be either the global or project library table). More...
 
void handleActivateEvent (wxActivateEvent &aEvent) override
 Handle a window activation event. More...
 
void unitsChangeRefresh () override
 Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...
 
bool canCloseWindow (wxCloseEvent &aCloseEvent) override
 
FOOTPRINTloadFootprint (const LIB_ID &aFootprintId)
 Attempts to load aFootprintId from the footprint library table. More...
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void setupUnits (APP_SETTINGS_BASE *aCfg)
 
void resolveCanvasType ()
 Determines the Canvas type to load (with prompt if required) and initializes m_canvasType. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
void onActivate (wxActivateEvent &aEvent)
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 An event handler called on a language menu selection. More...
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event. More...
 
virtual bool isAutoSaveRequired () const
 Return the auto save status of the application. More...
 
virtual bool doAutoSave ()
 This should be overridden by the derived class to handle the auto save feature. More...
 
void onSystemColorChange (wxSysColourChangedEvent &aEvent)
 
virtual void setupUIConditions ()
 Setup the UI conditions for the various actions and their controls in this frame. More...
 
void initExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 
void ensureWindowIsOnScreen ()
 

Static Protected Member Functions

static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

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

Static Protected Attributes

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

Private Member Functions

void OnSize (wxSizeEvent &event) override
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
void OnGridSize (wxSizeEvent &aSizeEvent)
 
void UpdateMsgPanel () override
 Redraw the message panel. More...
 
void updateView ()
 Rebuild the GAL view (reint tool manager, colors and drawings) must be run after any footprint change. More...
 
void ExportSelectedFootprint (wxCommandEvent &aEvent)
 Will let the caller exit from the wait loop, and get the built footprint. More...
 
void OnSashDrag (wxSashEvent &event)
 Resize the child windows when dragging a sash window border. More...
 
void ReCreatePageList ()
 Create or recreate the list of parameter pages for the current wizard. More...
 
void ReCreateParameterList ()
 Create the list of parameters for the current page. More...
 
void ResizeParamColumns ()
 Expand the 'Value' column to fill available. More...
 
void initParameterGrid ()
 Prepare the grid where parameters are displayed. More...
 
void SelectFootprintWizard ()
 Show the list of footprint wizards available into the system. More...
 
void ReloadFootprint ()
 Reload the current footprint. More...
 
void DisplayBuildMessage (wxString &aMessage)
 Display the message generated by the python build footprint script. More...
 
FOOTPRINT_WIZARDGetMyWizard ()
 Reloads the wizard by name. More...
 
void Process_Special_Functions (wxCommandEvent &event)
 
void DisplayWizardInfos ()
 Show all the details about the current wizard. More...
 
void doCloseWindow () override
 
void ReCreateHToolbar () override
 
void ReCreateVToolbar () override
 
void ClickOnPageList (wxCommandEvent &event)
 
void LoadSettings (APP_SETTINGS_BASE *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (APP_SETTINGS_BASE *aCfg) override
 Save common frame parameters to a configuration data file. More...
 
WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg) override
 Return a pointer to the window settings for this frame. More...
 
void OnActivate (wxActivateEvent &event)
 Called when the frame frame is activate to reload the libraries and component lists that can be changed by the schematic editor or the library editor. More...
 
void SelectCurrentWizard (wxCommandEvent &event)
 
void DefaultParameters (wxCommandEvent &event)
 
void ParametersUpdated (wxGridEvent &event)
 Update the footprint python parameters values from the values in grid. More...
 
void Update3DView (bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr) override
 Update the 3D view, if the viewer is opened by this frame. More...
 
void SaveCopyInUndoList (EDA_ITEM *, UNDO_REDO) override
 Create a new entry in undo list of commands. More...
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &, UNDO_REDO) override
 Creates a new entry in undo list of commands. More...
 
void OnEditItemRequest (BOARD_ITEM *aItem) override
 Install the corresponding dialog editor for the given item. More...
 

Private Attributes

wxPanel * m_parametersPanel
 Panel for the page list and parameter grid. More...
 
wxListBox * m_pageList
 The list of pages. More...
 
WX_GRIDm_parameterGrid
 The list of parameters. More...
 
int m_parameterGridPage
 the page currently displayed by m_parameterGrid it is most of time the m_pageList selection, but can differ during transitions between pages. More...
 
wxTextCtrl * m_buildMessageBox
 
wxString m_auiPerspective
 Encoded string describing the AUI layout. More...
 
bool m_wizardListShown
 A show-once flag for the wizard list. More...
 

Detailed Description

Definition at line 52 of file footprint_wizard_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 39 of file kiway_holder.h.

◆ UNDO_REDO_LIST

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

Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 109 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_WIZARD_FRAME()

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

◆ ~FOOTPRINT_WIZARD_FRAME()

FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME ( )

Returns
the primary data model.

Definition at line 224 of file footprint_wizard_frame.cpp.

225 {
226  // Delete the GRID_TRICKS.
227  m_parameterGrid->PopEventHandler( true );
228 
229  GetCanvas()->StopDrawing();
230  // Be sure any event cannot be fired after frame deletion:
231  GetCanvas()->SetEvtHandlerEnabled( false );
232 
233  // Be sure a active tool (if exists) is deactivated:
234  if( m_toolManager )
236 
237  EDA_3D_VIEWER_FRAME* draw3DFrame = Get3DViewerFrame();
238 
239  if( draw3DFrame )
240  draw3DFrame->Destroy();
241 
242  // Now this frame can be deleted
243 }
EDA_3D_VIEWER_FRAME * Get3DViewerFrame()
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
WX_GRID * m_parameterGrid
The list of parameters.
void DeactivateTool()
Deactivate the currently active tool.
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.

References TOOL_MANAGER::DeactivateTool(), KIWAY_PLAYER::Destroy(), PCB_BASE_FRAME::Get3DViewerFrame(), PCB_BASE_FRAME::GetCanvas(), m_parameterGrid, TOOLS_HOLDER::m_toolManager, and EDA_DRAW_PANEL_GAL::StopDrawing().

Member Function Documentation

◆ ActivateGalCanvas()

void PCB_BASE_EDIT_FRAME::ActivateGalCanvas ( )
overridevirtualinherited

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

Parameters
aBoardis the BOARD to put into the frame.

Reimplemented from PCB_BASE_FRAME.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 132 of file pcb_base_edit_frame.cpp.

133 {
135 
137 }
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
void SyncLayersVisibility(const BOARD *aBoard)
Update "visibility" property of each layer of a given BOARD.

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

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

◆ AddFootprintToBoard()

void PCB_BASE_FRAME::AddFootprintToBoard ( FOOTPRINT aFootprint)
virtualinherited

Add the given footprint to the board.

Parameters
aDCis the current Device Context, to draw the new footprint (can be NULL ).

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 176 of file pcb_base_frame.cpp.

177 {
178  if( aFootprint )
179  {
180  GetBoard()->Add( aFootprint, ADD_MODE::APPEND );
181 
182  aFootprint->SetFlags( IS_NEW );
183  aFootprint->SetPosition( wxPoint( 0, 0 ) ); // cursor in GAL may not be initialized yet
184 
185  // Put it on FRONT layer (note that it might be stored flipped if the lib is an archive
186  // built from a board)
187  if( aFootprint->IsFlipped() )
188  aFootprint->Flip( aFootprint->GetPosition(), m_settings->m_FlipLeftRight );
189 
190  // Place it in orientation 0 even if it is not saved with orientation 0 in lib (note that
191  // it might be stored in another orientation if the lib is an archive built from a board)
192  aFootprint->SetOrientation( 0 );
193  }
194 }
#define IS_NEW
New item, just created.
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:153
PCBNEW_SETTINGS * m_settings
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Adds an item to the container.
Definition: board.cpp:607
void SetOrientation(double aNewAngle)
Definition: footprint.cpp:1618
void Flip(const wxPoint &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
Definition: footprint.cpp:1428
bool IsFlipped() const
Definition: footprint.h:270
wxPoint GetPosition() const override
Definition: footprint.h:186
BOARD * GetBoard() const
void SetPosition(const wxPoint &aPos) override
Definition: footprint.cpp:1499

References BOARD::Add(), APPEND, FOOTPRINT::Flip(), PCB_BASE_FRAME::GetBoard(), FOOTPRINT::GetPosition(), IS_NEW, FOOTPRINT::IsFlipped(), PCBNEW_SETTINGS::m_FlipLeftRight, PCB_BASE_FRAME::m_settings, EDA_ITEM::SetFlags(), FOOTPRINT::SetOrientation(), and FOOTPRINT::SetPosition().

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard().

◆ AddLibrary()

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

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

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

Definition at line 539 of file footprint_libraries_utils.cpp.

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

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

Referenced by PCB_BASE_EDIT_FRAME::createNewLibrary().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 440 of file eda_base_frame.cpp.

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

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

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

zoom and grid).

Definition at line 494 of file eda_draw_frame.cpp.

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

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

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

◆ AppendMsgPanel()

void EDA_DRAW_FRAME::AppendMsgPanel ( const wxString &  aTextUpper,
const wxString &  aTextLower,
int  aPadding = 6 
)
inherited

Append a message to the message panel.

This helper method checks to make sure the message panel exists in the frame and appends a message to it using the message panel AppendMessage() method.

Parameters
aTextUpperThe message upper text.
aTextLowerThe message lower text.
aPaddingNumber of spaces to pad between messages.

Definition at line 648 of file eda_draw_frame.cpp.

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

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

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

◆ canCloseWindow()

bool PCB_BASE_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
overrideprotectedvirtualinherited

Reimplemented from EDA_BASE_FRAME.

Reimplemented in PCB_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 85 of file pcb_base_frame.cpp.

86 {
87  // Close modeless dialogs. They're trouble when they get destroyed after the frame and/or
88  // board.
89  wxWindow* viewer3D = Get3DViewerFrame();
90 
91  if( viewer3D )
92  viewer3D->Close( true );
93 
94  return true;
95 }
EDA_3D_VIEWER_FRAME * Get3DViewerFrame()

References PCB_BASE_FRAME::Get3DViewerFrame().

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

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 1181 of file eda_base_frame.cpp.

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

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

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

◆ CheckForAutoSaveFile()

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

Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input.

If an auto save file exists for aFileName, the user is prompted if they wish to replace file aFileName with the auto saved file. If the user chooses to replace the file, the backup file of aFileName is removed, aFileName is renamed to the backup file name, and the auto save file is renamed to aFileName. If user chooses to keep the existing version of aFileName, the auto save file is removed.

Parameters
aFileNameA wxFileName object containing the file name to check.

Definition at line 1069 of file eda_base_frame.cpp.

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

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

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

◆ ClearFileHistory()

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

Removes all files from the file history.

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

Definition at line 956 of file eda_base_frame.cpp.

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

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

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

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

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

Free the undo or redo list from List element.

Wrappers are deleted. Data pointed by wrappers are deleted if not in use in schematic i.e. when they are copy of a schematic item or they are no more in use (DELETED). Items are removed from the beginning of the list so this function can be called to remove old commands.

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 553 of file undo_redo.cpp.

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

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

◆ ClearUndoRedoList()

void EDA_BASE_FRAME::ClearUndoRedoList ( )
virtualinherited

◆ ClickOnPageList()

void FOOTPRINT_WIZARD_FRAME::ClickOnPageList ( wxCommandEvent &  event)
private

Definition at line 499 of file footprint_wizard_frame.cpp.

500 {
501  if( m_pageList->GetSelection() >= 0 )
502  {
504  GetCanvas()->Refresh();
506  }
507 }
void DisplayWizardInfos()
Show all the details about the current wizard.
wxListBox * m_pageList
The list of pages.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void ReCreateParameterList()
Create the list of parameters for the current page.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...

References DisplayWizardInfos(), PCB_BASE_FRAME::GetCanvas(), m_pageList, ReCreateParameterList(), and EDA_DRAW_PANEL_GAL::Refresh().

Referenced by Process_Special_Functions().

◆ CommonSettingsChanged()

void PCB_BASE_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged,
bool  aTextVarsChanged 
)
overridevirtualinherited

Notification event that some of the common (suite-wide) settings have changed.

Update menus, toolbars, local variables, etc.

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in PCB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 694 of file pcb_base_frame.cpp.

695 {
696  EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
697 
700 
702 
703  // The 3D viewer isn't in the Kiway, so send its update manually
705 
706  if( viewer )
707  viewer->CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
708 }
EDA_3D_VIEWER_FRAME * Get3DViewerFrame()
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
Definition: view.cpp:1430
void RecreateToolbars()
Rebuild all toolbars, and update the checked state of check tools.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification that common settings are updated.
Color has changed.
Definition: view_item.h:53
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:208
virtual COLOR_SETTINGS * GetColorSettings() const override
Helper to retrieve the current color settings.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
virtual void LoadColors(const COLOR_SETTINGS *aSettings)

References KIGFX::COLOR, EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::Get3DViewerFrame(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetColorSettings(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::RENDER_SETTINGS::LoadColors(), EDA_DRAW_FRAME::RecreateToolbars(), and KIGFX::VIEW::UpdateAllItems().

Referenced by FOOTPRINT_VIEWER_FRAME::CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), and PCB_EDIT_FRAME::CommonSettingsChanged().

◆ Compile_Ratsnest()

void PCB_BASE_FRAME::Compile_Ratsnest ( bool  aDisplayStatus)
inherited

Create the entire board ratsnest.

Function Compile_Ratsnest Create the entire board ratsnest.

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

Parameters
aDCis the current device context (can be NULL).
aDisplayStatusif true, display the computation results.

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

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

Definition at line 40 of file ratsnest.cpp.

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

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

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

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const
virtualinherited

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

Reimplemented in SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 796 of file eda_base_frame.cpp.

797 {
798  // KICAD_MANAGER_FRAME overrides this
799  return Kiface().KifaceSettings();
800 }
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:92

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

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_EXCELLON_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

Get the configuration base name.

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

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

Reimplemented from TOOLS_HOLDER.

Definition at line 358 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateAndShow3D_Frame()

EDA_3D_VIEWER_FRAME * PCB_BASE_FRAME::CreateAndShow3D_Frame ( )
inherited

Shows the 3D view frame.

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

Definition at line 435 of file pcb_base_frame.cpp.

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

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

Referenced by PCB_VIEWER_TOOLS::Show3DViewer().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

Definition at line 821 of file eda_base_frame.cpp.

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

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

◆ CreateNewFootprint()

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

Creates a new footprint, at position 0,0.

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

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

Definition at line 1119 of file footprint_libraries_utils.cpp.

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

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

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

◆ CreateNewLibrary()

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

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

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

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

Definition at line 385 of file footprint_libraries_utils.cpp.

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

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

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary().

◆ createNewLibrary()

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

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

Definition at line 394 of file footprint_libraries_utils.cpp.

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

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

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

◆ CreateNewProjectLibrary()

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

Definition at line 378 of file footprint_libraries_utils.cpp.

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

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ CreateServer()

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

Definition at line 43 of file eda_dde.cpp.

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

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

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

◆ CurrentToolName()

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

Definition at line 100 of file tools_holder.cpp.

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

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

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

◆ DefaultParameters()

void FOOTPRINT_WIZARD_FRAME::DefaultParameters ( wxCommandEvent &  event)
private

Definition at line 201 of file footprint_wizard_frame_functions.cpp.

202 {
203  FOOTPRINT_WIZARD* footprintWizard = GetMyWizard();
204 
205  if ( footprintWizard == nullptr )
206  return;
207 
208  footprintWizard->ResetParameters();
209 
210  // Reload
212  ReloadFootprint();
214 }
void DisplayWizardInfos()
Show all the details about the current wizard.
void ReloadFootprint()
Reload the current footprint.
void ReCreateParameterList()
Create the list of parameters for the current page.
FOOTPRINT_WIZARD * GetMyWizard()
Reloads the wizard by name.
virtual void ResetParameters()=0
Reset all wizard parameters to default values.
The parent class from where any footprint wizard class must derive.

References DisplayWizardInfos(), GetMyWizard(), ReCreateParameterList(), ReloadFootprint(), and FOOTPRINT_WIZARD::ResetParameters().

◆ Destroy()

◆ DismissModal()

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

Definition at line 166 of file kiway_player.cpp.

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

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

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

◆ DisplayBuildMessage()

void FOOTPRINT_WIZARD_FRAME::DisplayBuildMessage ( wxString &  aMessage)
private

Display the message generated by the python build footprint script.

Definition at line 125 of file footprint_wizard_frame_functions.cpp.

126 {
127  m_buildMessageBox->SetValue( aMessage );
128 }

References m_buildMessageBox.

Referenced by GetBuiltFootprint(), and ReloadFootprint().

◆ DisplayGridMsg()

void PCB_BASE_FRAME::DisplayGridMsg ( )
overridevirtualinherited

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 534 of file pcb_base_frame.cpp.

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

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

Referenced by PCB_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 514 of file eda_draw_frame.cpp.

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

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane in the status bar.

Definition at line 532 of file eda_draw_frame.cpp.

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

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

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

◆ DisplayWizardInfos()

void FOOTPRINT_WIZARD_FRAME::DisplayWizardInfos ( )
private

Show all the details about the current wizard.

Definition at line 78 of file footprint_wizard_frame_functions.cpp.

79 {
80  wxString msg;
81 
82  msg = _( "Footprint Wizard" );
83  msg << wxT( " [" );
84 
85  if( !m_wizardName.IsEmpty() )
86  msg << m_wizardName;
87  else
88  msg += _( "no wizard selected" );
89 
90  msg << wxT( "]" );
91 
92  SetTitle( msg );
93 }
wxString m_wizardName
name of the current wizard
#define _(s)

References _, and m_wizardName.

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

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

Returns
true if the auto save was successful otherwise false.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 323 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void FOOTPRINT_WIZARD_FRAME::doCloseWindow ( )
overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 246 of file footprint_wizard_frame.cpp.

247 {
248  SaveSettings( config() );
249 
250  if( IsModal() )
251  {
252  // Only dismiss a modal frame once, so that the return values set by
253  // the prior DismissModal() are not bashed for ShowModal().
254  if( !IsDismissed() )
255  DismissModal( false );
256  }
257 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
bool IsDismissed()
bool IsModal() const override
Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame...
Definition: kiway_player.h:173
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
void DismissModal(bool aRetVal, const wxString &aResult=wxEmptyString)

References EDA_BASE_FRAME::config(), KIWAY_PLAYER::DismissModal(), KIWAY_PLAYER::IsDismissed(), KIWAY_PLAYER::IsModal(), and SaveSettings().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )
protectedinherited

Definition at line 637 of file eda_base_frame.cpp.

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

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 289 of file eda_draw_frame.cpp.

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

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

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

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 196 of file kiway_player.h.

196 {}

Referenced by KIWAY_PLAYER::OnSockRequest().

◆ ExportSelectedFootprint()

void FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint ( wxCommandEvent &  aEvent)
private

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

Definition at line 260 of file footprint_wizard_frame.cpp.

261 {
262  DismissModal( true );
263  Close();
264 }
void DismissModal(bool aRetVal, const wxString &aResult=wxEmptyString)

References KIWAY_PLAYER::DismissModal().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 833 of file eda_base_frame.cpp.

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

References EDA_BASE_FRAME::m_auimgr.

◆ FocusOnItem()

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

Definition at line 203 of file pcb_base_frame.cpp.

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

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

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

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const wxPoint &  aPos)
inherited

Useful to focus on a particular location, in find functions.

Move the graphic cursor (crosshair cursor) at a given coordinate and reframes the drawing if the requested point is out of view or if center on location is requested.

Parameters
aPosis the point to go to.

Definition at line 851 of file eda_draw_frame.cpp.

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

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

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

◆ Get3DViewerFrame()

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

Definition at line 98 of file pcb_base_frame.cpp.

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

References QUALIFIED_VIEWER3D_FRAMENAME.

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

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetActiveLayer()

virtual PCB_LAYER_ID PCB_BASE_FRAME::GetActiveLayer ( ) const
inlinevirtualinherited

Definition at line 355 of file pcb_base_frame.h.

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

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

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

◆ GetAppearancePanel()

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )
inlinestaticprotectedinherited

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 204 of file eda_base_frame.h.

204 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetAuxOrigin()

const wxPoint & PCB_BASE_FRAME::GetAuxOrigin ( ) const
inherited

Definition at line 315 of file pcb_base_frame.cpp.

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

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

Referenced by PCB_BASE_FRAME::GetUserOrigin().

◆ GetBoard()

BOARD* PCB_BASE_FRAME::GetBoard ( ) const
inlineinherited

Definition at line 206 of file pcb_base_frame.h.

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

References PCB_BASE_FRAME::m_pcb.

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

◆ GetBoardBoundingBox()

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

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

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

Definition at line 392 of file pcb_base_frame.cpp.

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

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

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

◆ GetBuiltFootprint()

FOOTPRINT * FOOTPRINT_WIZARD_FRAME::GetBuiltFootprint ( )

Definition at line 148 of file footprint_wizard_frame_functions.cpp.

149 {
151 
152  if( footprintWizard && m_modal_ret_val )
153  {
154  wxString msg;
155  FOOTPRINT* footprint = footprintWizard->GetFootprint( &msg );
156  DisplayBuildMessage( msg );
157 
158  return footprint;
159  }
160 
161  return nullptr;
162 }
bool m_modal_ret_val
Definition: kiway_player.h:216
wxString m_wizardName
name of the current wizard
static FOOTPRINT_WIZARD * GetWizard(const wxString &aName)
virtual FOOTPRINT * GetFootprint(wxString *aMessage)=0
Build the footprint itself and returns it to the caller function.
void DisplayBuildMessage(wxString &aMessage)
Display the message generated by the python build footprint script.
The parent class from where any footprint wizard class must derive.

References DisplayBuildMessage(), FOOTPRINT_WIZARD::GetFootprint(), FOOTPRINT_WIZARD_LIST::GetWizard(), KIWAY_PLAYER::m_modal_ret_val, and m_wizardName.

◆ GetCanvas()

PCB_DRAW_PANEL_GAL * PCB_BASE_FRAME::GetCanvas ( ) const
overridevirtualinherited

Return a pointer to GAL-based canvas of given EDA draw frame.

Returns
Pointer to GAL-based canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 722 of file pcb_base_frame.cpp.

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

References EDA_DRAW_FRAME::GetCanvas().

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

◆ GetCollectorsGuide()

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

Definition at line 509 of file pcb_base_frame.cpp.

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

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

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

◆ GetColorSettings()

COLOR_SETTINGS * FOOTPRINT_WIZARD_FRAME::GetColorSettings ( ) const
overridevirtual

Helper to retrieve the current color settings.

Returns
a pointer to the active COLOR_SETTINGS.

Reimplemented from PCB_BASE_FRAME.

Definition at line 285 of file footprint_wizard_frame.cpp.

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

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

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const
inlinevirtualinherited

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

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

Returns
the filename and full path to the open file

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 439 of file eda_base_frame.h.

439 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

virtual SELECTION& TOOLS_HOLDER::GetCurrentSelection ( )
inlinevirtualinherited

Get the current selection from the canvas area.

Returns
the current selection.

Reimplemented in PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_VIEWER_FRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, DISPLAY_FOOTPRINTS_FRAME, PL_EDITOR_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 101 of file tools_holder.h.

102  {
103  return m_dummySelection;
104  }
SELECTION m_dummySelection
Definition: tools_holder.h:162

References TOOLS_HOLDER::m_dummySelection.

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent(), and ACTION_MANAGER::RunHotKey().

◆ GetDesignRulesPath()

wxString PCB_BASE_EDIT_FRAME::GetDesignRulesPath ( )
inherited

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

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

Definition at line 232 of file pcb_base_edit_frame.cpp.

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

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

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

◆ GetDesignSettings()

◆ GetDisplayOptions()

const PCB_DISPLAY_OPTIONS& PCB_BASE_FRAME::GetDisplayOptions ( ) const
inlineinherited

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

Definition at line 179 of file pcb_base_frame.h.

179 { return m_displayOptions; }
PCB_DISPLAY_OPTIONS m_displayOptions

References PCB_BASE_FRAME::m_displayOptions.

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

◆ GetDocumentExtents()

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

Returns bbox of document with option to not include some items.

Used most commonly by "Zoom to Fit" and "Zoom to Objects". In Eeschema for "Zoom to Fit" it's passed "true" to include drawing sheet border, and "false" by "Zoom To Objects" to ignore drawing sheet border. In Pcbnew, false makes it ignore any items outside the PCB edge such as fabrication notes.

Parameters
aIncludeAllVisibleTrue to include everything visible in bbox calculations, false to ignore some visible items (program dependent).
Returns
Bounding box of the document (ignoring some items as requested).

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 114 of file pcb_base_frame.h.

115  {
116  /* "Zoom to Fit" calls this with "aIncludeAllVisible" as true. Since that feature
117  * always ignored the page and border, this function returns a bbox without them
118  * as well when passed true. This technically is not all things visible, but it
119  * keeps behavior consistent.
120  *
121  * When passed false, this function returns a bbox of just the board edge. This
122  * allows things like fabrication text or anything else outside the board edge to
123  * be ignored, and just zooms up to the board itself.
124  *
125  * Calling "GetBoardBoundingBox(true)" when edge cuts are turned off will return
126  * the entire page and border, so we call "GetBoardBoundingBox(false)" instead.
127  */
128  if( aIncludeAllVisible || !m_pcb->IsLayerVisible( Edge_Cuts ) )
129  return GetBoardBoundingBox( false );
130  else
131  return GetBoardBoundingBox( true );
132  }
EDA_RECT GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer...
Definition: board.cpp:472

References Edge_Cuts, PCB_BASE_FRAME::GetBoardBoundingBox(), BOARD::IsLayerVisible(), and PCB_BASE_FRAME::m_pcb.

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

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

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

Definition at line 129 of file tools_holder.h.

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

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const
inlineinherited

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

Definition at line 135 of file tools_holder.h.

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

References TOOLS_HOLDER::m_dragAction.

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

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

◆ GetFileFromHistory()

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

Fetches the file name from the file history list.

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

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

Definition at line 916 of file eda_base_frame.cpp.

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

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

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

◆ GetFileHistory()

FILE_HISTORY& EDA_BASE_FRAME::GetFileHistory ( )
inlineinherited

Get the frame's main file history.

Returns
the main file history

Definition at line 423 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )
inlineinherited

◆ GetFootprintEditorSettings()

FOOTPRINT_EDITOR_SETTINGS * PCB_BASE_FRAME::GetFootprintEditorSettings ( ) const
inherited

Definition at line 681 of file pcb_base_frame.cpp.

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

References Pgm().

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

◆ GetFootprintFromBoardByReference()

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

Definition at line 458 of file load_select_footprint.cpp.

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

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

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const
inlineinherited

Definition at line 207 of file eda_base_frame.h.

207 { return m_ident; }

References EDA_BASE_FRAME::m_ident.

◆ GetGalDisplayOptions()

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )
inlinevirtualinherited

◆ GetGridOrigin()

const wxPoint & PCB_BASE_FRAME::GetGridOrigin ( ) const
overridevirtualinherited

Return the absolute coordinates of the origin of the snap grid.

This is treated as a relative offset and snapping will occur at multiples of the grid size relative to this point.

Implements EDA_DRAW_FRAME.

Definition at line 303 of file pcb_base_frame.cpp.

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

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

Referenced by PCB_BASE_FRAME::GetUserOrigin().

◆ GetInfoBar()

◆ GetItem()

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

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 197 of file pcb_base_frame.cpp.

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

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

◆ GetMagneticItemsSettings()

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 581 of file eda_base_frame.h.

581 { return m_undoRedoCountMax; }

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetModel()

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

Implements PCB_BASE_FRAME.

Definition at line 630 of file footprint_wizard_frame.cpp.

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

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

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const
inlineinherited

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

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

Definition at line 141 of file tools_holder.h.

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

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

◆ GetMyWizard()

FOOTPRINT_WIZARD * FOOTPRINT_WIZARD_FRAME::GetMyWizard ( )
private

Reloads the wizard by name.

Definition at line 131 of file footprint_wizard_frame_functions.cpp.

132 {
133  if( m_wizardName.Length() == 0 )
134  return nullptr;
135 
137 
138  if( !footprintWizard )
139  {
140  wxMessageBox( _( "Couldn't reload footprint wizard" ) );
141  return nullptr;
142  }
143 
144  return footprintWizard;
145 }
wxString m_wizardName
name of the current wizard
static FOOTPRINT_WIZARD * GetWizard(const wxString &aName)
#define _(s)
The parent class from where any footprint wizard class must derive.

References _, FOOTPRINT_WIZARD_LIST::GetWizard(), and m_wizardName.

Referenced by DefaultParameters(), ParametersUpdated(), ReCreatePageList(), ReCreateParameterList(), and ReloadFootprint().

◆ GetNearestGridPosition()

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

Return the nearest aGridSize location to aPosition.

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

Definition at line 792 of file eda_draw_frame.cpp.

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

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

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

◆ GetNearestHalfGridPosition()

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

Return the nearest aGridSize / 2 location to aPosition.

This is useful when attempting for keep outer points on grid but not the middle point.

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

Definition at line 806 of file eda_draw_frame.cpp.

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

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

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

◆ GetOriginTransforms()

ORIGIN_TRANSFORMS & PCB_BASE_FRAME::GetOriginTransforms ( )
overridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 337 of file pcb_base_frame.cpp.

338 {
339  return m_originTransforms;
340 }
PCB_ORIGIN_TRANSFORMS m_originTransforms

References PCB_BASE_FRAME::m_originTransforms.

◆ GetPageSettings()

const PAGE_INFO & PCB_BASE_FRAME::GetPageSettings ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 288 of file pcb_base_frame.cpp.

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

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

Referenced by PCB_CONTROL::Print().

◆ GetPageSizeIU()

const wxSize PCB_BASE_FRAME::GetPageSizeIU ( ) const
overridevirtualinherited

Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view.

Implements EDA_DRAW_FRAME.

Definition at line 294 of file pcb_base_frame.cpp.

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

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

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

◆ GetPcbNewSettings()

PCBNEW_SETTINGS * PCB_BASE_FRAME::GetPcbNewSettings ( ) const
inherited

Definition at line 675 of file pcb_base_frame.cpp.

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

References Pgm().

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

◆ GetPlotSettings()

const PCB_PLOT_PARAMS & PCB_BASE_FRAME::GetPlotSettings ( ) const
virtualinherited

Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.

Overloaded in FOOTPRINT_EDIT_FRAME.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 380 of file pcb_base_frame.cpp.

381 {
382  return m_pcb->GetPlotOptions();
383 }
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: board.h:538

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

Referenced by DIALOG_PLOT::CreateDrillFile(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_PLOT::DIALOG_PLOT(), and FOOTPRINT_EDIT_FRAME::GetPlotSettings().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetRotationAngle()

int PCB_BASE_EDIT_FRAME::GetRotationAngle ( ) const
inlineinherited

Return the angle used for rotate operations.

Definition at line 162 of file pcb_base_edit_frame.h.

References PCB_BASE_EDIT_FRAME::m_rotationAngle.

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

◆ GetScreen()

PCB_SCREEN* PCB_BASE_FRAME::GetScreen ( ) const
inlineoverridevirtualinherited

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

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 227 of file pcb_base_frame.h.

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

References EDA_DRAW_FRAME::GetScreen().

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

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 948 of file eda_draw_frame.cpp.

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

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

◆ GetSettingsManager()

SETTINGS_MANAGER* EDA_BASE_FRAME::GetSettingsManager ( ) const
inlineinherited

Definition at line 140 of file eda_base_frame.h.

140 { return m_settingsManager; }
SETTINGS_MANAGER * m_settingsManager

References EDA_BASE_FRAME::m_settingsManager.

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

◆ GetSeverity()

SEVERITY PCB_BASE_FRAME::GetSeverity ( int  aErrorCode) const
overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 649 of file pcb_base_frame.cpp.

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

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

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const
inlineinherited

For those frames that support polar coordinates.

Definition at line 120 of file eda_draw_frame.h.

120 { return m_polarCoords; }

References EDA_DRAW_FRAME::m_polarCoords.

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

◆ GetTitleBlock()

const TITLE_BLOCK & PCB_BASE_FRAME::GetTitleBlock ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 343 of file pcb_base_frame.cpp.

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

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

Referenced by CreateHeaderInfoData().

◆ GetToolCanvas()

wxWindow* EDA_DRAW_FRAME::GetToolCanvas ( ) const
inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 425 of file eda_draw_frame.h.

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

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 54 of file tools_holder.h.

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

References TOOLS_HOLDER::m_toolManager.

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 46 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const
inlinevirtualinherited

◆ GetUnitPair()

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

Get the pair or units in current use.

The primary unit is the main unit of the frame, and the secondary unit is the unit of the other system that was used most recently.

Definition at line 1060 of file eda_draw_frame.cpp.

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

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

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

◆ GetUserOrigin()

const wxPoint PCB_BASE_FRAME::GetUserOrigin ( ) const
inherited

Definition at line 321 of file pcb_base_frame.cpp.

322 {
323  auto& displ_opts = GetDisplayOptions();
324  wxPoint origin( 0, 0 );
325 
326  switch( displ_opts.m_DisplayOrigin )
327  {
329  case PCB_DISPLAY_OPTIONS::PCB_ORIGIN_AUX: origin = GetAuxOrigin(); break;
330  case PCB_DISPLAY_OPTIONS::PCB_ORIGIN_GRID: origin = GetGridOrigin(); break;
331  default: wxASSERT( false ); break;
332  }
333 
334  return origin;
335 }
const wxPoint & GetGridOrigin() const override
Return the absolute coordinates of the origin of the snap grid.
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
const wxPoint & GetAuxOrigin() const

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

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

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 126 of file eda_base_frame.h.

127  {
128  return m_userUnits;
129  }
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

References EDA_BASE_FRAME::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), EE_INSPECTION_TOOL::CheckSymbol(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_FP_EDITOR_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), BOARD_INSPECTION_TOOL::getItemDescription(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), PL_EDITOR_LAYOUT::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), PCB_MARKER::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), RC_TREE_MODEL::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_NET_INSPECTOR::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), ROUTER_TOOL::updateMessagePanel(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), GERBVIEW_FRAME::UpdateStatusBar(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), and DRC_TOOL::userUnits().

◆ GetWindowSettings()

WINDOW_SETTINGS * FOOTPRINT_WIZARD_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
overrideprivatevirtual

Return a pointer to the window settings for this frame.

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

Parameters
aCfgis this frame's config object

Reimplemented from EDA_BASE_FRAME.

Definition at line 532 of file footprint_wizard_frame.cpp.

533 {
534  auto cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg );
535  wxASSERT( cfg );
536 
537  return cfg ? &cfg->m_FootprintWizard : nullptr;
538 }

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

1216 {
1217 #ifdef __WXGTK__
1218  // GTK includes the window decorations in the normal GetSize call,
1219  // so we have to use a GTK-specific sizing call that returns the
1220  // non-decorated window size.
1221  int width = 0;
1222  int height = 0;
1223  GTKDoGetSize( &width, &height );
1224 
1225  wxSize winSize( width, height );
1226 #else
1227  wxSize winSize = GetSize();
1228 #endif
1229 
1230  return winSize;
1231 }

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

◆ GetZoneSettings()

const ZONE_SETTINGS & PCB_BASE_FRAME::GetZoneSettings ( ) const
inherited

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const
inherited

Return a human readable value for display in dialogs.

Definition at line 570 of file eda_draw_frame.cpp.

571 {
572  // returns a human readable value which can be displayed as zoom
573  // level indicator in dialogs.
574  double zoom = m_canvas->GetGAL()->GetZoomFactor();
575  return wxString::Format( wxT( "Z %.2f" ), zoom );
576 }
EDA_DRAW_PANEL_GAL * m_canvas
This the frame's interface to setting GAL display options.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
double GetZoomFactor() const
Get the zoom factor.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

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

Referenced by PL_EDITOR_FRAME::UpdateStatusBar(), and EDA_DRAW_FRAME::UpdateStatusBar().

◆ handleActivateEvent()

void PCB_BASE_EDIT_FRAME::handleActivateEvent ( wxActivateEvent &  aEvent)
overrideprotectedvirtualinherited

Handle a window activation event.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 243 of file pcb_base_edit_frame.cpp.

244 {
246 
247  // The text in the collapsible pane headers need to be updated
248  if( m_appearancePanel )
250 }
virtual void handleActivateEvent(wxActivateEvent &aEvent)
Handle a window activation event.
APPEARANCE_CONTROLS * m_appearancePanel
void RefreshCollapsiblePanes()
Function to force a redraw of the collapsible panes in this control.

References EDA_DRAW_FRAME::handleActivateEvent(), PCB_BASE_EDIT_FRAME::m_appearancePanel, and APPEARANCE_CONTROLS::RefreshCollapsiblePanes().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )
virtualinherited

Update the UI in response to a change in the system colors.

Definition at line 1234 of file eda_base_frame.cpp.

1235 {
1236  // Update the icon theme when the system theme changes and update the toolbars
1238  ThemeChanged();
1239 
1240  // This isn't handled by ThemeChanged()
1241  if( GetMenuBar() )
1242  {
1243  // For icons in menus, icon scaling & hotkeys
1244  ReCreateMenuBar();
1245  GetMenuBar()->Refresh();
1246  }
1247 }
void ThemeChanged()
Notifies the store that the icon theme has been changed by the user, so caches must be invalidated.
virtual void ThemeChanged()
Process light/dark theme change.
virtual void ReCreateMenuBar()
Recreates the menu bar.
BITMAP_STORE * GetBitmapStore()
Definition: bitmap.cpp:93

References GetBitmapStore(), EDA_BASE_FRAME::ReCreateMenuBar(), BITMAP_STORE::ThemeChanged(), and EDA_BASE_FRAME::ThemeChanged().

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

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

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

enabled, checked, etc.).

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

Definition at line 372 of file eda_base_frame.cpp.

374 {
375  bool checkRes = false;
376  bool enableRes = true;
377  bool showRes = true;
378  SELECTION& selection = aFrame->GetCurrentSelection();
379 
380  try
381  {
382  checkRes = aCond.checkCondition( selection );
383  enableRes = aCond.enableCondition( selection );
384  showRes = aCond.showCondition( selection );
385  }
386  catch( std::exception& )
387  {
388  // Something broke with the conditions, just skip the event.
389  aEvent.Skip();
390  return;
391  }
392 
393  aEvent.Enable( enableRes );
394  aEvent.Show( showRes );
395 
396  // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
397  // checked, since wxMenuItems don't want to be checked unless they actually are checkable
398 #if wxCHECK_VERSION( 3, 1, 5 )
399  if( aEvent.IsCheckable() )
400  aEvent.Check( checkRes );
401 #else
402  bool canCheck = true;
403 
404  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to
405  // check to see if they can be and can't just universally apply a check in this event.
406  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
407  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
408 
409  if( canCheck )
410  aEvent.Check( checkRes );
411 #endif
412 }
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:101

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

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

void EDA_DRAW_FRAME::HardRedraw ( )
virtualinherited

Rebuild the GAL and redraws the screen.

Call when something went wrong.

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

Definition at line 826 of file eda_draw_frame.cpp.

827 {
828  // To be implemented by subclasses.
829 }

Referenced by EDA_DRAW_FRAME::resolveCanvasType(), and COMMON_TOOLS::ZoomRedraw().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 809 of file eda_base_frame.cpp.

810 {
811  return Kiface().GetHelpFileName();
812 }
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
const wxString & GetHelpFileName() const
Return just the basename portion of the current help file.
Definition: kiface_base.h:109

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

void EDA_BASE_FRAME::ImportHotkeyConfigFromFile ( std::map< std::string, TOOL_ACTION * >  aActionMap,
const wxString &  aDefaultShortname 
)
inherited

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

Parameters
aActionMapcurrent hotkey map (over which the imported hotkeys will be applied).
aDefaultShortnamea default short name (extension not needed) like Eeschema, KiCad...

◆ initExitKey()

void EDA_BASE_FRAME::initExitKey ( )
protectedinherited

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

1124 {
1125  wxAcceleratorEntry entries[1];
1126  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
1127  wxAcceleratorTable accel( 1, entries );
1128  SetAcceleratorTable( accel );
1129 }

◆ initParameterGrid()

void FOOTPRINT_WIZARD_FRAME::initParameterGrid ( )
private

Prepare the grid where parameters are displayed.

Definition at line 321 of file footprint_wizard_frame.cpp.

322 {
323  m_parameterGridPage = -1;
324 
325  // Prepare the grid where parameters are displayed
326 
327  m_parameterGrid->CreateGrid( 0, 3 );
328 
329  m_parameterGrid->SetColLabelValue( WIZ_COL_NAME, _( "Parameter" ) );
330  m_parameterGrid->SetColLabelValue( WIZ_COL_VALUE, _( "Value" ) );
331  m_parameterGrid->SetColLabelValue( WIZ_COL_UNITS, _( "Units" ) );
332 
334  m_parameterGrid->SetColLabelAlignment( wxALIGN_LEFT, wxALIGN_CENTRE );
335  m_parameterGrid->AutoSizeColumns();
336 
337  m_parameterGrid->AutoSizeRows();
338  m_parameterGrid->SetRowLabelSize( 0 );
339 
340  m_parameterGrid->DisableDragGridSize();
341  m_parameterGrid->DisableDragColSize();
342 
343  m_parameterGrid->Connect( wxEVT_SIZE,
344  wxSizeEventHandler( FOOTPRINT_WIZARD_FRAME::OnGridSize ),
345  nullptr, this );
346 }
int m_parameterGridPage
the page currently displayed by m_parameterGrid it is most of time the m_pageList selection,...
WX_GRID * m_parameterGrid
The list of parameters.
#define _(s)
void OnGridSize(wxSizeEvent &aSizeEvent)
void SetColLabelSize(int aHeight)
Hide wxGrid's SetColLabelSize() method with one which makes sure the size is tall enough for the syst...
Definition: wx_grid.cpp:53

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

◆ InstallPreferences()

virtual void EDA_BASE_FRAME::InstallPreferences ( PAGED_DIALOG ,
PANEL_HOTKEYS_EDITOR  
)
inlinevirtualinherited

Allow a frame to load its preference panels (if any) into the preferences dialog.

Parameters
aParenta paged dialog into which the preference panels should be installed.

Reimplemented in SCH_EDIT_FRAME, PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, PL_EDITOR_FRAME, KICAD_MANAGER_FRAME, and EDA_3D_VIEWER_FRAME.

Definition at line 298 of file eda_base_frame.h.

298 { }

Referenced by EDA_BASE_FRAME::OnPreferences().

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

Definition at line 616 of file eda_base_frame.h.

616 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( ) const
virtualinherited

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

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

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

Definition at line 1116 of file eda_base_frame.cpp.

1117 {
1118  // This function should be overridden in child classes
1119  return false;
1120 }

Referenced by GERBVIEW_FRAME::Clear_DrawLayers(), and EDITOR_CONDITIONS::contentModifiedFunc().

◆ IsCurrentTool()

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

Definition at line 109 of file tools_holder.cpp.

110 {
111  if( m_toolStack.empty() )
112  return &aAction == &ACTIONS::selectionTool;
113  else
114  return m_toolStack.back() == aAction.GetName();
115 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:164
static TOOL_ACTION selectionTool
Definition: actions.h:153
const std::string & GetName() const
Return name of the action.
Definition: tool_action.h:101

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

Referenced by SCH_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )
inherited
Returns
false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). True if the dialog is not modal or if it is modal and has been dismissed.

Definition at line 160 of file kiway_player.cpp.

161 {
162  return !m_modal_loop;
163 }
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:213

References KIWAY_PLAYER::m_modal_loop.

Referenced by SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), and doCloseWindow().

◆ IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( ) const
inherited

Definition at line 389 of file eda_draw_frame.cpp.

390 {
391  return config()->m_Window.grid.show;
392 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
GRID_SETTINGS grid
Definition: app_settings.h:89
WINDOW_SETTINGS m_Window
Definition: app_settings.h:181

References EDA_BASE_FRAME::config(), WINDOW_SETTINGS::grid, APP_SETTINGS_BASE::m_Window, and GRID_SETTINGS::show.

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), EDITOR_CONDITIONS::gridFunc(), GERBVIEW_FRAME::IsElementVisible(), PICKER_TOOL::Main(), GERBER_LAYER_WIDGET::OnRenderEnable(), and COMMON_TOOLS::ToggleGrid().

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const
inlineoverridevirtualinherited

Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame.

In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing.

Reimplemented from EDA_BASE_FRAME.

Definition at line 173 of file kiway_player.h.

173 { return m_modal; }

References KIWAY_PLAYER::m_modal.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), doCloseWindow(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), KIWAY_PLAYER::ShowModal(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ IsScriptingConsoleVisible()

bool EDA_DRAW_FRAME::IsScriptingConsoleVisible ( )
inherited

Gets the current visibility of the scripting console window.

Definition at line 246 of file eda_draw_frame.cpp.

247 {
248  KIWAY_PLAYER* frame = Kiway().Player( FRAME_PYTHON, false );
249  return frame && frame->IsVisible();
250 }
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:64
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:382

References FRAME_PYTHON, KIWAY_HOLDER::Kiway(), and KIWAY::Player().

Referenced by EDITOR_CONDITIONS::consoleVisibleFunc().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 206 of file eda_base_frame.h.

206 { return m_ident == aType; }

References EDA_BASE_FRAME::m_ident.

Referenced by SYMBOL_EDITOR_CONTROL::AddLibrary(), PCB_CONTROL::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), CONVERT_TOOL::CreatePolys(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), COMMON_TOOLS::doZoomFit(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbol(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), CONVERT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), DIALOG_FIELD_PROPERTIES::init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SYMBOL_EDITOR_CONTROL::Revert(), SYMBOL_EDITOR_CONTROL::Save(), APPEARANCE_CONTROLS::setVisibleObjects(), EE_INSPECTION_TOOL::ShowDatasheet(), EE_INSPECTION_TOOL::ShowERCDialog(), SYMBOL_EDITOR_CONTROL::ToggleSymbolTree(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

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

1026 {
1027  wxString msg;
1028  wxFileName fn = aFileName;
1029 
1030  // Check for absence of a file path with a file name. Unfortunately KiCad
1031  // uses paths relative to the current project path without the ./ part which
1032  // confuses wxFileName. Making the file name path absolute may be less than
1033  // elegant but it solves the problem.
1034  if( fn.GetPath().IsEmpty() && fn.HasName() )
1035  fn.MakeAbsolute();
1036 
1037  wxCHECK_MSG( fn.IsOk(), false,
1038  wxT( "File name object is invalid. Bad programmer!" ) );
1039  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
1040  wxT( "File name object path <" ) + fn.GetFullPath() +
1041  wxT( "> is not set. Bad programmer!" ) );
1042 
1043  if( fn.IsDir() && !fn.IsDirWritable() )
1044  {
1045  msg.Printf( _( "Insufficient permissions to folder '%s'." ),
1046  fn.GetPath() );
1047  }
1048  else if( !fn.FileExists() && !fn.IsDirWritable() )
1049  {
1050  msg.Printf( _( "Insufficient permissions to save file '%s'." ),
1051  fn.GetFullName(), fn.GetPath() );
1052  }
1053  else if( fn.FileExists() && !fn.IsFileWritable() )
1054  {
1055  msg.Printf( _( "Insufficient permissions to save file '%s'." ),
1056  fn.GetFullPath() );
1057  }
1058 
1059  if( !msg.IsEmpty() )
1060  {
1061  wxMessageBox( msg );
1062  return false;
1063  }
1064 
1065  return true;
1066 }
#define _(s)

References _.

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

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Return a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 of file kiway_holder.h.

54  {
55  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
56  return *m_kiway;
57  }
KIWAY * m_kiway
Definition: kiway_holder.h:75

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), 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(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_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 181 of file kiway_player.cpp.

182 {
183  // logging support
184  KiwayMailIn( aEvent ); // call the virtual, override in derived.
185 }
virtual void KiwayMailIn(KIWAY_EXPRESS &aEvent)
Receive KIWAY_EXPRESS messages from other players.

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS aEvent)
virtualinherited

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

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

Definition at line 71 of file kiway_player.cpp.

72 {
73  // override this in derived classes.
74 }

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

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

An event handler called on a language menu selection.

Definition at line 188 of file kiway_player.cpp.

189 {
190  int id = event.GetId();
191 
192  // tell all the KIWAY_PLAYERs about the language change.
193  Kiway().SetLanguage( id );
194 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
virtual void SetLanguage(int aLanguage)
Change the language and then calls ShowChangedLanguage() on all #KIWAY_PLAYERs.
Definition: kiway.cpp:485

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,
bool  aIsGlobal = false,
const wxString &  aGlobalPath = wxEmptyString 
)
inherited
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 955 of file eda_draw_frame.cpp.

959 {
960  wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
961  aFilename.SetExt( ext );
962 
963  wxString dir = aGlobalPath;
964 
965 
966  if( isDirectory && doOpen )
967  {
968  if( !aIsGlobal )
969  {
970  dir = Prj().GetProjectPath();
971  }
972 
973  wxDirDialog dlg( this, prompt, dir,
974  wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
975 
976  if( dlg.ShowModal() == wxID_CANCEL )
977  return false;
978 
979  aFilename = dlg.GetPath();
980  aFilename.SetExt( ext );
981  }
982  else
983  {
984  // Ensure the file has a dummy name, otherwise GTK will display the regex from the filter
985  if( aFilename.GetName().empty() )
986  aFilename.SetName( "Library" );
987 
988  if( !aIsGlobal )
989  {
990  dir = Prj().IsNullProject() ? aFilename.GetFullPath() : Prj().GetProjectPath();
991  }
992 
993  wxFileDialog dlg( this, prompt, dir, aFilename.GetFullName(),
994  wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
995  : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
996 
997  if( dlg.ShowModal() == wxID_CANCEL )
998  return false;
999 
1000  aFilename = dlg.GetPath();
1001  aFilename.SetExt( ext );
1002  }
1003 
1004  return true;
1005 }
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:122
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
#define _(s)
virtual bool IsNullProject() const
Check if this project is a null project (i.e.
Definition: project.cpp:134

References _, PROJECT::GetProjectPath(), PROJECT::IsNullProject(), and KIWAY_HOLDER::Prj().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), and PCB_BASE_EDIT_FRAME::createNewLibrary().

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )
protectedinherited

Returns the canvas type stored in the application settings.

Definition at line 719 of file eda_draw_frame.cpp.

720 {
721 #ifdef __WXMAC__
722  // Cairo renderer doesn't handle Retina displays so there's really only one game
723  // in town for Mac
725 #endif
726 
729 
730  if( cfg )
731  canvasType = static_cast<EDA_DRAW_PANEL_GAL::GAL_TYPE>( cfg->m_Graphics.canvas_type );
732 
733  if( canvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
734  || canvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
735  {
736  wxASSERT( false );
738  }
739 
740  // Legacy canvas no longer supported. Switch to Cairo, and on the first instantiation
741  // the user will be prompted to switch to OpenGL
742  if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
744 
745  return canvasType;
746 }
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
static constexpr GAL_TYPE GAL_FALLBACK
Sentinel, do not use as a parameter.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:99
GAL not used (the legacy wxDC engine is used)
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:92

References APP_SETTINGS_BASE::GRAPHICS::canvas_type, EDA_DRAW_PANEL_GAL::GAL_FALLBACK, EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, Kiface(), KIFACE_BASE::KifaceSettings(), and APP_SETTINGS_BASE::m_Graphics.

Referenced by SCH_BASE_FRAME::createCanvas(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), and EDA_DRAW_FRAME::resolveCanvasType().

◆ LoadFootprint()

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

Attempt to load aFootprintId from the footprint library table.

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

Definition at line 311 of file load_select_footprint.cpp.

312 {
313  FOOTPRINT* footprint = nullptr;
314 
315  try
316  {
317  footprint = loadFootprint( aFootprintId );
318  }
319  catch( const IO_ERROR& )
320  {
321  }
322 
323  return footprint;
324 }
FOOTPRINT * loadFootprint(const LIB_ID &aFootprintId)
Attempts to load aFootprintId from the footprint library table.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75

Referenced by BOARD_NETLIST_UPDATER::addNewFootprint(), FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), FOOTPRINT_EDITOR_CONTROL::ExportFootprint(), DIALOG_EXCHANGE_FOOTPRINTS::processFootprint(), BOARD_NETLIST_UPDATER::replaceFootprint(), and FOOTPRINT_EDITOR_CONTROL::SaveAs().

◆ loadFootprint()

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

Attempts to load aFootprintId from the footprint library table.

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

Definition at line 327 of file load_select_footprint.cpp.

328 {
329  FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs();
330 
331  wxCHECK_MSG( fptbl, nullptr, wxT( "Cannot look up LIB_ID in NULL FP_LIB_TABLE." ) );
332 
333  FOOTPRINT *footprint = nullptr;
334 
335  // When loading a footprint from a library in the footprint editor
336  // the items UUIDs must be keep and not reinitialized
337  bool keepUUID = IsType( FRAME_FOOTPRINT_EDITOR );
338 
339  try
340  {
341  footprint = fptbl->FootprintLoadWithOptionalNickname( aFootprintId, keepUUID );
342  }
343  catch( const IO_ERROR& )
344  {
345  }
346 
347  // If the footprint is found, clear all net info to be sure there are no broken links to
348  // any netinfo list (should be not needed, but it can be edited from the footprint editor )
349  if( footprint )
350  footprint->ClearAllNets();
351 
352  return footprint;
353 }
void ClearAllNets()
Clear (i.e.
Definition: footprint.cpp:504
FOOTPRINT * FootprintLoadWithOptionalNickname(const LIB_ID &aFootprintId, bool aKeepUUID=false)
Load a footprint having aFootprintId with possibly an empty nickname.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:283
bool IsType(FRAME_T aType) const
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75

References FOOTPRINT::ClearAllNets(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), FRAME_FOOTPRINT_EDITOR, PROJECT::PcbFootprintLibs(), and Prj().

Referenced by FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_EDIT_FRAME::LoadFootprints(), and FOOTPRINT_EDIT_FRAME::restoreLastFootprint().

◆ LoadSettings()

void FOOTPRINT_WIZARD_FRAME::LoadSettings ( APP_SETTINGS_BASE aCfg)
overrideprivatevirtual

Load common frame parameters from a configuration file.

Don't forget to call the