Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer. More...
#include <pcb_base_frame.h>
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 | |
| PCB_BASE_FRAME (KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName) | |
| ~PCB_BASE_FRAME () | |
| EDA_3D_VIEWER_FRAME * | Get3DViewerFrame () |
| virtual void | Update3DView (bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr) |
| Update the 3D view, if the viewer is opened by this frame. More... | |
| FOOTPRINT * | LoadFootprint (const LIB_ID &aFootprintId) |
| Attempt to load aFootprintId from the footprint library table. More... | |
| BOX2I | 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_INFO & | GetPageSettings () 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 VECTOR2I & | GetGridOrigin () const override |
| Return the absolute coordinates of the origin of the snap grid. More... | |
| void | SetGridOrigin (const VECTOR2I &aPoint) override |
| const VECTOR2I & | GetAuxOrigin () const |
| const VECTOR2I | GetUserOrigin () const |
| ORIGIN_TRANSFORMS & | GetOriginTransforms () override |
| Return a reference to the default ORIGIN_TRANSFORMS object. More... | |
| const TITLE_BLOCK & | GetTitleBlock () const override |
| void | SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override |
| virtual BOARD_DESIGN_SETTINGS & | GetDesignSettings () const |
| Returns the BOARD_DESIGN_SETTINGS for the open project. More... | |
| virtual COLOR_SETTINGS * | GetColorSettings (bool aForceRefresh=false) const override |
| Helper to retrieve the current color settings. More... | |
| void | SetDrawBgColor (const COLOR4D &aColor) override |
| const PCB_DISPLAY_OPTIONS & | GetDisplayOptions () 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_SETTINGS & | GetZoneSettings () const |
| void | SetZoneSettings (const ZONE_SETTINGS &aSettings) |
| virtual const PCB_PLOT_PARAMS & | GetPlotSettings () const |
| Return the PCB_PLOT_PARAMS for the BOARD owned by this frame. More... | |
| virtual void | SetPlotSettings (const PCB_PLOT_PARAMS &aSettings) |
| virtual void | SetBoard (BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr) |
| Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD. More... | |
| BOARD * | GetBoard () const |
| void | UpdateUserUnits (BOARD_ITEM *aItem, bool *aSelectedItemsModified=nullptr) |
| Update any references within aItem (or its descendants) to the user units. More... | |
| virtual BOARD_ITEM_CONTAINER * | GetModel () const =0 |
| EDA_ITEM * | GetItem (const KIID &aId) const override |
| Fetch an item by KIID. More... | |
| void | FocusOnItem (BOARD_ITEM *aItem, PCB_LAYER_ID aLayer=UNDEFINED_LAYER) |
| void | FocusOnItems (std::vector< BOARD_ITEM * > aItems, PCB_LAYER_ID aLayer=UNDEFINED_LAYER) |
| void | HideSolderMask () |
| void | ShowSolderMask () |
| virtual void | ReCreateOptToolbar () override |
| virtual void | ShowChangedLanguage () override |
| Redraw the menus and what not in current language. More... | |
| virtual void | UpdateStatusBar () override |
| Update the status bar information. More... | |
| PCB_SCREEN * | GetScreen () const override |
| Return a pointer to a BASE_SCREEN or one of its derivatives. More... | |
| EDA_3D_VIEWER_FRAME * | CreateAndShow3D_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... | |
| FOOTPRINT * | GetFootprintFromBoardByReference () |
| void | OnModify () override |
| Must be called after a change in order to set the "modify" flag and update other data structures and GUI elements. More... | |
| FOOTPRINT * | CreateNewFootprint (const wxString &aFootprintName, bool aQuiet=false) |
| 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) |
| FOOTPRINT * | SelectFootprintFromLibTree (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... | |
| virtual void | SaveCopyInUndoList (EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand)=0 |
| Create a new entry in undo list of commands. More... | |
| virtual void | SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand)=0 |
| Creates a new entry in undo list of commands. More... | |
| virtual void | AppendCopyToUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand)=0 |
| As SaveCopyInUndoList, but appends the changes to the last undo item on the stack. 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 (PCB_LAYER_ID aLayer) |
| Change the active layer in the frame. More... | |
| virtual void | SetActiveLayer (PCB_LAYER_ID aLayer) |
| virtual PCB_LAYER_ID | GetActiveLayer () const |
| SEVERITY | GetSeverity (int aErrorCode) const override |
| virtual void | OnDisplayOptionsChanged () |
| 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... | |
| PCBNEW_SETTINGS * | GetPcbNewSettings () const |
| FOOTPRINT_EDITOR_SETTINGS * | GetFootprintEditorSettings () const |
| virtual PCB_VIEWERS_SETTINGS_BASE * | GetViewerSettingsBase () const |
| virtual MAGNETIC_SETTINGS * | GetMagneticItemsSettings () |
| 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_GAL * | GetCanvas () const override |
| Return a pointer to GAL-based canvas of given EDA draw frame. More... | |
| virtual void | ActivateGalCanvas () override |
| Use to start up the GAL drawing canvas. 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... | |
| EDA_SEARCH_DATA & | 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... | |
| VECTOR2I | GetNearestGridPosition (const VECTOR2I &aPosition) const |
| Return the nearest aGridSize location to aPosition. More... | |
| VECTOR2I | GetNearestHalfGridPosition (const VECTOR2I &aPosition) const |
| Return the nearest aGridSize / 2 location to aPosition. More... | |
| virtual COLOR4D | GetDrawBgColor () const |
| 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 | ReCreateHToolbar ()=0 |
| virtual void | ReCreateVToolbar ()=0 |
| virtual void | ReCreateAuxiliaryToolbar () |
| virtual void | UpdateToolbarControlSizes () |
| Update the sizes of any controls in the toolbars of the frame. More... | |
| bool | IsGridVisible () const |
| virtual void | SetGridVisibility (bool aVisible) |
| 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 wxchoice. More... | |
| void | OnUpdateSelectZoom (wxUpdateUIEvent &aEvent) |
| Update the checked item in the zoom wxchoice. More... | |
| void | UpdateZoomSelectBox () |
| Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More... | |
| const wxString | GetZoomLevelIndicator () const |
| Return a human readable value for display in dialogs. More... | |
| virtual void | OnSelectZoom (wxCommandEvent &event) |
| Set the zoom factor when selected by the zoom list box in the main tool bar. More... | |
| virtual void | OnSize (wxSizeEvent &event) override |
| Recalculate the size of toolbars and display panel when the frame size changes. More... | |
| void | OnMove (wxMoveEvent &aEvent) override |
| virtual void | 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 VECTOR2I &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, const std::map< wxString, wxString > *aProperties, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString) |
| Prints the drawing-sheet (frame and title block). More... | |
| void | DisplayToolMsg (const wxString &msg) override |
| void | DisplayConstraintsMsg (const wxString &msg) |
| virtual void | OnPageSettingsChange () |
| Called when modifying the page settings. More... | |
| void | DisplayUnitsMsg () |
| Display current unit pane in the status bar. More... | |
| void | AppendMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6) |
| Append a message to the message panel. More... | |
| virtual void | ClearMsgPanel () |
| Clear all messages from the message panel. More... | |
| void | SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList) |
| Clear the message panel and populates it with the contents of aList. More... | |
| void | SetMsgPanel (EDA_ITEM *aItem) |
| void | SetMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6) |
| Helper function that erases the msg panel and then appends a single message. More... | |
| virtual void | UpdateMsgPanel () |
| Redraw the message panel. More... | |
| virtual void | PrintPage (const RENDER_SETTINGS *aSettings) |
| Print the page pointed by current screen, set by the calling print function. More... | |
| 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_OPTIONS & | GetGalDisplayOptions () |
| 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 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... | |
| void | ChangeUserUnits (EDA_UNITS aUnits) |
| SETTINGS_MANAGER * | GetSettingsManager () 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) |
| int | GetAutoSaveInterval () const |
| bool | IsType (FRAME_T aType) const |
| FRAME_T | GetFrameType () const |
| virtual const SEARCH_STACK & | sys_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 | ShowPreferences (wxString aStartPage, wxString aStartParentPage) |
| Displays the preferences and settings of all opened editors paged dialog, starting with a particular page. More... | |
| void | PrintMsg (const wxString &text) |
| void | CreateInfoBar () |
| void | FinishAUIInitialization () |
| WX_INFOBAR * | GetInfoBar () |
| 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_BASE * | config () const |
| Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More... | |
| void | LoadWindowState (const wxString &aFileName) |
| virtual void | LoadWindowState (const WINDOW_STATE &aState) |
| Load frame state info from a configuration file. More... | |
| void | LoadWindowSettings (const WINDOW_SETTINGS *aCfg) |
| Load window settings from the given settings object. More... | |
| void | SaveWindowSettings (WINDOW_SETTINGS *aCfg) |
| Save window settings to the given settings object. More... | |
| virtual WINDOW_SETTINGS * | GetWindowSettings (APP_SETTINGS_BASE *aCfg) |
| Return a pointer to the window settings for this frame. More... | |
| wxString | ConfigBaseName () override |
| Get the configuration base name. More... | |
| virtual void | SaveProjectSettings () |
| Save changes to the project settings to the project (.pro) file. More... | |
| void | ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname) |
| Prompt the user for a hotkey file to read, and read it. More... | |
| wxString | GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr) |
| Fetches the file name from the file history list. More... | |
| void | ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr) |
| Removes all files from the file history. More... | |
| void | UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr) |
| Update the list of recently opened files. More... | |
| FILE_HISTORY & | GetFileHistory () |
| 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 | ReCreateMenuBar () |
| Recreates the menu bar. More... | |
| void | AddStandardHelpMenu (wxMenuBar *aMenuBar) |
| Adds the standard KiCad help menu to the menubar. More... | |
| bool | IsWritable (const wxFileName &aFileName, bool aVerbose=true) |
| Checks if aFileName can be written. More... | |
| virtual 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 |
| const wxString & | GetUntranslatedAboutTitle () 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 | ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1) |
| Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. 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_LIST * | PopCommandFromUndoList () |
| Return the last command to undo and remove it from list, nothing is deleted. More... | |
| virtual PICKED_ITEMS_LIST * | PopCommandFromRedoList () |
| Return the last command to undo and remove it from list, nothing is deleted. More... | |
| virtual int | GetUndoCommandCount () const |
| virtual int | GetRedoCommandCount () const |
| int | GetMaxUndoItems () const |
| bool | NonUserClose (bool aForce) |
| virtual void | HandleSystemColorChange () |
| Update the UI in response to a change in the system colors. More... | |
| TOOL_MANAGER * | GetToolManager () const |
| Return the MVC controller. More... | |
| virtual SELECTION & | GetCurrentSelection () |
| Get the current selection from the canvas area. More... | |
| virtual void | PushTool (const TOOL_EVENT &aEvent) |
| NB: the definition of "tool" is different at the user level. More... | |
| virtual void | PopTool (const TOOL_EVENT &aEvent) |
| Pops a tool from the stack. More... | |
| 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 |
| KIWAY & | Kiway () const |
| Return a reference to the KIWAY that this object has an opportunity to participate in. More... | |
| bool | HasKiway () const |
| Safety check before asking for the Kiway reference. More... | |
| PROJECT & | Prj () 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... | |
| EDA_UNITS | GetUserUnits () const |
| void | SetUserUnits (EDA_UNITS aUnits) |
| const EDA_IU_SCALE & | GetIuScale () const |
| wxString | StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) |
| Converts aValue in internal units into a united string. More... | |
| wxString | StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false) |
| wxString | MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) |
| A lower-precision version of StringFromValue(). More... | |
| wxString | MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true) |
| int | ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) |
| Converts aTextValue in aUnits to internal units used by the frame. More... | |
| EDA_ANGLE | AngleValueFromString (const wxString &aTextValue) |
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 | |
| bool | canCloseWindow (wxCloseEvent &aCloseEvent) override |
| void | handleActivateEvent (wxActivateEvent &aEvent) override |
| Handle a window activation event. More... | |
| void | handleIconizeEvent (wxIconizeEvent &aEvent) override |
| Handle a window iconize event. More... | |
| virtual void | doReCreateMenuBar () override |
| FOOTPRINT * | loadFootprint (const LIB_ID &aFootprintId) |
| Attempts to load aFootprintId from the footprint library table. More... | |
| virtual 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... | |
| void | rebuildConnectivity () |
| virtual void | SetScreen (BASE_SCREEN *aScreen) |
| void | setupUnits (APP_SETTINGS_BASE *aCfg) |
| std::vector< wxWindow * > | findDialogs () |
| 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... | |
| void | onIconize (wxIconizeEvent &aEvent) |
| 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... | |
| virtual void | doCloseWindow () |
| 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 () |
| virtual void | OnDropFiles (wxDropFilesEvent &aEvent) |
| Handles event fired when a file is dropped to the window. More... | |
| virtual void | DoWithAcceptedFiles () |
| Execute action on accepted dropped file. More... | |
Static Protected Member Functions | |
| static wxString | GetAutoSaveFilePrefix () |
Static Protected Attributes | |
| static bool | m_openGLFailureOccured = false |
| Has any failure occured when switching to OpenGL in any EDA_DRAW_FRAME? More... | |
| 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 | windowClosing (wxCloseEvent &event) |
| (with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings(). More... | |
| void | commonInit (FRAME_T aFrameType) |
| Collect common initialization functions used in all CTORs. More... | |
| wxWindow * | findQuasiModalDialog () |
Private Attributes | |
| NL_PCBNEW_PLUGIN * | m_spaceMouse |
| BASE_SCREEN * | m_currentScreen |
| current used SCREEN More... | |
| EDA_DRAW_PANEL_GAL * | m_canvas |
| This the frame's interface to setting GAL display options. More... | |
| KIGFX::GAL_DISPLAY_OPTIONS | m_galDisplayOptions |
| KIWAY * | m_kiway |
| HOLDER_TYPE | m_type |
| const EDA_IU_SCALE & | m_iuScale |
| EDA_UNITS | m_userUnits |
Detailed Description
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
Definition at line 69 of file pcb_base_frame.h.
Member Enumeration Documentation
◆ HOLDER_TYPE
|
inherited |
◆ UNDO_REDO_LIST
|
inherited |
Specifies whether we are interacting with the undo or redo stacks.
| Enumerator | |
|---|---|
| UNDO_LIST | |
| REDO_LIST | |
Definition at line 111 of file eda_base_frame.h.
Constructor & Destructor Documentation
◆ PCB_BASE_FRAME()
| PCB_BASE_FRAME::PCB_BASE_FRAME | ( | KIWAY * | aKiway, |
| wxWindow * | aParent, | ||
| FRAME_T | aFrameType, | ||
| const wxString & | aTitle, | ||
| const wxPoint & | aPos, | ||
| const wxSize & | aSize, | ||
| long | aStyle, | ||
| const wxString & | aFrameName | ||
| ) |
Definition at line 74 of file pcb_base_frame.cpp.
◆ ~PCB_BASE_FRAME()
| PCB_BASE_FRAME::~PCB_BASE_FRAME | ( | ) |
Definition at line 85 of file pcb_base_frame.cpp.
References EDA_DRAW_PANEL_GAL::GetBackend(), GetCanvas(), EDA_DRAW_FRAME::m_canvasType, m_pcb, and m_spaceMouse.
Member Function Documentation
◆ ActivateGalCanvas()
|
overridevirtual |
Use to start up the GAL drawing canvas.
Reimplemented from EDA_DRAW_FRAME.
Reimplemented in FOOTPRINT_EDIT_FRAME, PCB_BASE_EDIT_FRAME, and PCB_EDIT_FRAME.
Definition at line 1065 of file pcb_base_frame.cpp.
References EDA_DRAW_FRAME::ActivateGalCanvas(), EDA_BASE_FRAME::config(), TOOL_BASE::GAL_SWITCH, GetCanvas(), GetColorSettings(), GetDisplayOptions(), KIGFX::VIEW::GetPainter(), KIGFX::PCB_PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), KIGFX::PCB_RENDER_SETTINGS::LoadColors(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), m_pcb, m_spaceMouse, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, KIGFX::VIEW::RecacheAllItems(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::SetEnvironment(), EDA_DRAW_PANEL_GAL::SetEventDispatcher(), and EDA_DRAW_PANEL_GAL::StartDrawing().
Referenced by PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), and PCB_DRAW_PANEL_GAL::OnShow().
◆ AddFootprintToBoard()
|
virtual |
Add the given footprint to the board.
- Parameters
-
aDC is the current Device Context, to draw the new footprint (can be NULL ).
Reimplemented in FOOTPRINT_EDIT_FRAME.
Definition at line 231 of file pcb_base_frame.cpp.
References BOARD::Add(), ANGLE_0, APPEND, FOOTPRINT::Flip(), GetBoard(), GetPcbNewSettings(), FOOTPRINT::GetPosition(), IS_NEW, FOOTPRINT::IsFlipped(), EDA_ITEM::SetFlags(), FOOTPRINT::SetOrientation(), FOOTPRINT::SetPosition(), and UpdateUserUnits().
Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard().
◆ AddStandardHelpMenu()
|
inherited |
Adds the standard KiCad help menu to the menubar.
Definition at line 462 of file eda_base_frame.cpp.
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(), CVPCB_MAINFRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), and PCB_EDIT_FRAME::doReCreateMenuBar().
◆ AddStandardSubMenus()
|
inherited |
Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g.
zoom and grid).
Definition at line 576 of file eda_draw_frame.cpp.
References CONDITIONAL_MENU::AddSeparator(), TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::m_toolManager, TOOL_MENU::RegisterSubMenu(), and SELECTION_CONDITIONS::ShowAlways().
Referenced by EE_SELECTION_TOOL::Init(), PICKER_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), ROUTER_TOOL::Init(), PCB_SELECTION_TOOL::Init(), and PCB_VIEWER_TOOLS::Init().
◆ AngleValueFromString()
|
inlineinherited |
Definition at line 116 of file units_provider.h.
References PNS::angle(), DEGREES, DEGREES_T, EDA_UNIT_UTILS::UI::DoubleValueFromString(), and UNITS_PROVIDER::GetIuScale().
Referenced by FP_TEXT_GRID_TABLE::SetValue().
◆ AppendCopyToUndoList()
|
pure virtual |
As SaveCopyInUndoList, but appends the changes to the last undo item on the stack.
Implemented in DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_VIEWER_FRAME, and PCB_BASE_EDIT_FRAME.
Referenced by BOARD_COMMIT::Push().
◆ AppendMsgPanel()
|
inherited |
Append a message to the message panel.
This helper method checks to make sure the message panel exists in the frame and appends a message to it using the message panel AppendMessage() method.
- Parameters
-
aTextUpper The message upper text. aTextLower The message lower text. aPadding Number of spaces to pad between messages.
Definition at line 736 of file eda_draw_frame.cpp.
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()
|
overrideprotectedvirtual |
Reimplemented from EDA_BASE_FRAME.
Reimplemented in PCB_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.
Definition at line 99 of file pcb_base_frame.cpp.
References Get3DViewerFrame(), and KIWAY_HOLDER::Prj().
Referenced by PCB_EDIT_FRAME::canCloseWindow(), and FOOTPRINT_EDIT_FRAME::canCloseWindow().
◆ ChangeUserUnits()
|
inherited |
Definition at line 1352 of file eda_base_frame.cpp.
References UNITS_PROVIDER::SetUserUnits(), and EDA_BASE_FRAME::unitsChangeRefresh().
Referenced by COMMON_TOOLS::SwitchUnits(), and COMMON_TOOLS::ToggleUnits().
◆ CheckForAutoSaveFile()
|
virtualinherited |
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
-
aFileName A wxFileName object containing the file name to check.
Reimplemented in SCH_EDIT_FRAME.
Definition at line 1231 of file eda_base_frame.cpp.
References _, Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), IsGUI(), Pgm(), and traceAutoSave.
Referenced by PCB_EDIT_FRAME::OpenProjectFiles().
◆ ClearFileHistory()
|
inherited |
Removes all files from the file history.
- Parameters
-
aFileHistory The FILE_HISTORY in use. If null, the main application file history is used
Definition at line 969 of file eda_base_frame.cpp.
References FILE_HISTORY::ClearFileHistory(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().
Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), SCH_EDIT_FRAME::OnClearFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), GERBVIEW_FRAME::OnClearGbrFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), and GERBVIEW_FRAME::OnClearZipFileHistory().
◆ ClearMsgPanel()
|
virtualinherited |
Clear all messages from the message panel.
Reimplemented in SYMBOL_EDIT_FRAME.
Definition at line 744 of file eda_draw_frame.cpp.
References EDA_MSG_PANEL::EraseMsgBox(), and EDA_DRAW_FRAME::m_messagePanel.
Referenced by GERBVIEW_CONTROL::ClearAllLayers(), GERBVIEW_CONTROL::ClearLayer(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GENDRILL::GenDrillAndMapFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), DIALOG_BOM::OnRunGenerator(), GERBVIEW_CONTROL::ReloadAllLayers(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), EE_INSPECTION_TOOL::UpdateMessagePanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo(), and GERBVIEW_FRAME::UpdateTitleAndInfo().
◆ ClearUndoORRedoList()
|
inlinevirtualinherited |
Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.
Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN. Commands are deleted from the older to the last.
- Parameters
-
aList = the UNDO_REDO_CONTAINER of commands. aItemCount number of old commands to delete. -1 to remove all old commands this will empty the list of commands.
Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, and PCB_BASE_EDIT_FRAME.
Definition at line 539 of file eda_base_frame.h.
Referenced by EDA_BASE_FRAME::ClearUndoRedoList(), EDA_BASE_FRAME::PushCommandToRedoList(), and EDA_BASE_FRAME::PushCommandToUndoList().
◆ ClearUndoRedoList()
|
virtualinherited |
Clear the undo and redo list using ClearUndoORRedoList()
Picked items are deleted by ClearUndoORRedoList() according to their status.
Definition at line 1297 of file eda_base_frame.cpp.
References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::REDO_LIST, and EDA_BASE_FRAME::UNDO_LIST.
Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_EDIT_FRAME::emptyScreen(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), PCB_EDIT_FRAME::ImportSpecctraSession(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SCH_EDIT_FRAME::OnImportProject(), PL_EDITOR_FRAME::OnNewDrawingSheet(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and EDA_BASE_FRAME::~EDA_BASE_FRAME().
◆ commonInit()
|
privateinherited |
Collect common initialization functions used in all CTORs.
Definition at line 117 of file eda_base_frame.cpp.
References DEFAULT_MAX_UNDO_ITEMS, defaultSize(), PATHS::GetDefaultUserProjectsPath(), ID_AUTO_SAVE_TIMER, minSize(), EDA_BASE_FRAME::onAutoSaveTimer(), Pgm(), and EDA_BASE_FRAME::windowClosing().
Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().
◆ CommonSettingsChanged()
|
overridevirtual |
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 FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and PCB_EDIT_FRAME.
Definition at line 994 of file pcb_base_frame.cpp.
References KIGFX::ALL, KIGFX::COLOR, EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), Get3DViewerFrame(), GetCanvas(), GetColorSettings(), GetDisplayOptions(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::PCB_RENDER_SETTINGS::LoadColors(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), EDA_DRAW_FRAME::RecreateToolbars(), KIGFX::REPAINT, KIGFX::VIEW::UpdateAllItems(), and KIGFX::VIEW::UpdateAllItemsConditionally().
Referenced by FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), FOOTPRINT_VIEWER_FRAME::CommonSettingsChanged(), and PCB_EDIT_FRAME::CommonSettingsChanged().
◆ Compile_Ratsnest()
| void PCB_BASE_FRAME::Compile_Ratsnest | ( | bool | aDisplayStatus | ) |
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
-
aDisplayStatus if true, display the computation results.
Must be called after a board change (changes for pads, footprints or a read netlist ).
- Parameters
-
aDisplayStatus : if true, display the computation results
Definition at line 35 of file ratsnest.cpp.
References GetBoard(), BOARD::GetConnectivity(), m_pcb, EDA_DRAW_FRAME::SetMsgPanel(), and BOARD::UpdateRatsnestExclusions().
Referenced by DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_EDIT_FRAME::OnNetlistChanged(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), PlaceFootprint(), and PCB_BASE_EDIT_FRAME::PutDataInPreviousState().
◆ config()
|
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 809 of file eda_base_frame.cpp.
References Kiface(), and KIFACE_BASE::KifaceSettings().
Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), ActivateGalCanvas(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), SIM_PLOT_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_EDIT_FRAME::GetRotationAngle(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), GERBVIEW_FRAME::gvconfig(), 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_BASE_FRAME::SaveSettings(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), GRID_MENU::update(), ZOOM_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), and BM2CMP_FRAME::~BM2CMP_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 350 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_configName.
◆ CreateAndShow3D_Frame()
| EDA_3D_VIEWER_FRAME * PCB_BASE_FRAME::CreateAndShow3D_Frame | ( | ) |
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 721 of file pcb_base_frame.cpp.
References _, Get3DViewerFrame(), and KIWAY_HOLDER::Kiway().
Referenced by PCB_VIEWER_TOOLS::Show3DViewer().
◆ CreateInfoBar()
|
inherited |
Definition at line 834 of file eda_base_frame.cpp.
References TOOLS_HOLDER::GetToolCanvas(), EDA_BASE_FRAME::m_auimgr, and EDA_BASE_FRAME::m_infoBar.
Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().
◆ CreateNewFootprint()
| FOOTPRINT * PCB_BASE_FRAME::CreateNewFootprint | ( | const wxString & | aFootprintName, |
| bool | aQuiet = false |
||
| ) |
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
-
aFootprintName is the name of the new footprint in library. aQuiet prevents user dialogs from being shown
Definition at line 1247 of file footprint_libraries_utils.cpp.
References _, DisplayInfoMessage(), FP_SMD, FP_THROUGH_HOLE, GetBoard(), 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::SetAttributes(), FOOTPRINT::SetFPID(), EDA_TEXT::SetItalic(), EDA_TEXT::SetKeepUpright(), 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().
◆ CreateServer()
|
inherited |
Definition at line 43 of file eda_dde.cpp.
References HOSTNAME(), ID_EDA_SOCKET_EVENT_SERV, and KIWAY_PLAYER::m_socketServer.
Referenced by SaveFileAs().
◆ CurrentToolName()
|
inherited |
Definition at line 110 of file tools_holder.cpp.
References TOOL_ACTION::GetName(), TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.
Referenced by TOOLS_HOLDER::ShowChangedLanguage().
◆ Destroy()
|
overrideinherited |
Our version of Destroy() which is virtual from wxWidgets.
Definition at line 170 of file kiway_player.cpp.
Referenced by DISPLAY_FOOTPRINTS_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::doCloseWindow(), SYMBOL_VIEWER_FRAME::doCloseWindow(), GERBVIEW_FRAME::doCloseWindow(), PL_EDITOR_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), BM2CMP_FRAME::OnExit(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), SelectFootprintFromLibBrowser(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().
◆ DismissModal()
|
inherited |
Definition at line 182 of file kiway_player.cpp.
References KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_ret_val, and KIWAY_PLAYER::m_modal_string.
Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), and SYMBOL_VIEWER_FRAME::FinishModal().
◆ DisplayConstraintsMsg()
|
inherited |
Definition at line 602 of file eda_draw_frame.cpp.
Referenced by EDIT_TOOL::doMoveSelection(), and DRAWING_TOOL::UpdateStatusBar().
◆ DisplayGridMsg()
|
overridevirtual |
Display the current grid pane on the status bar.
Reimplemented from EDA_DRAW_FRAME.
Definition at line 820 of file pcb_base_frame.cpp.
References GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetGridSize(), UNITS_PROVIDER::MessageTextFromValue(), VECTOR2< T >::x, and VECTOR2< T >::y.
Referenced by UpdateStatusBar().
◆ DisplayToolMsg()
|
overridevirtualinherited |
Reimplemented from TOOLS_HOLDER.
Definition at line 596 of file eda_draw_frame.cpp.
Referenced by EDIT_TOOL::Duplicate(), and PCB_CONTROL::Paste().
◆ DisplayUnitsMsg()
|
inherited |
Display current unit pane in the status bar.
Definition at line 618 of file eda_draw_frame.cpp.
References _, UNITS_PROVIDER::GetUserUnits(), INCHES, MILLIMETRES, and MILS.
Referenced by EDA_DRAW_FRAME::UpdateGridSelectBox(), SCH_BASE_FRAME::UpdateStatusBar(), and EDA_DRAW_FRAME::UpdateStatusBar().
◆ 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 318 of file eda_base_frame.cpp.
Referenced by EDA_BASE_FRAME::onAutoSaveTimer().
◆ doCloseWindow()
|
inlineprotectedvirtualinherited |
Reimplemented in CVPCB_MAINFRAME, DISPLAY_FOOTPRINTS_FRAME, SCH_EDIT_FRAME, SIM_PLOT_FRAME, SYMBOL_EDIT_FRAME, SYMBOL_VIEWER_FRAME, GERBVIEW_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, PCB_BASE_EDIT_FRAME, and PCB_EDIT_FRAME.
Definition at line 638 of file eda_base_frame.h.
Referenced by EDA_BASE_FRAME::windowClosing().
◆ doReCreateMenuBar()
|
overrideprotectedvirtual |
Reimplemented from EDA_DRAW_FRAME.
Reimplemented in FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and PCB_EDIT_FRAME.
Definition at line 706 of file pcb_base_frame.cpp.
◆ DoWithAcceptedFiles()
|
protectedvirtualinherited |
Execute action on accepted dropped file.
Called in OnDropFiles and should be populated with the action to execute in inherited classes.
Reimplemented in GERBVIEW_FRAME, KICAD_MANAGER_FRAME, and PL_EDITOR_FRAME.
Definition at line 1178 of file eda_base_frame.cpp.
References EDA_BASE_FRAME::m_acceptedExts, EDA_BASE_FRAME::m_AcceptedFiles, TOOLS_HOLDER::m_toolManager, and TOOL_MANAGER::RunAction().
Referenced by EDA_BASE_FRAME::OnDropFiles().
◆ ensureWindowIsOnScreen()
|
protectedinherited |
Definition at line 659 of file eda_base_frame.cpp.
References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.
Referenced by EDA_BASE_FRAME::OnSize().
◆ EraseMsgBox()
|
inherited |
Definition at line 345 of file eda_draw_frame.cpp.
References EDA_MSG_PANEL::EraseMsgBox(), and EDA_DRAW_FRAME::m_messagePanel.
Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().
◆ ExecuteRemoteCommand()
|
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 182 of file kiway_player.h.
Referenced by KIWAY_PLAYER::OnSockRequest().
◆ findDialogs()
|
protectedinherited |
Definition at line 925 of file eda_draw_frame.cpp.
Referenced by FocusOnItems(), and EDA_DRAW_FRAME::FocusOnLocation().
◆ findQuasiModalDialog()
|
privateinherited |
Definition at line 169 of file eda_base_frame.cpp.
References FRAME_SCH, DIALOG_SHIM::IsQuasiModal(), and EDA_BASE_FRAME::m_ident.
Referenced by EDA_BASE_FRAME::ProcessEvent(), and EDA_BASE_FRAME::windowClosing().
◆ FinishAUIInitialization()
|
inherited |
Definition at line 846 of file eda_base_frame.cpp.
References EDA_BASE_FRAME::m_auimgr.
Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().
◆ FocusOnItem()
| void PCB_BASE_FRAME::FocusOnItem | ( | BOARD_ITEM * | aItem, |
| PCB_LAYER_ID | aLayer = UNDEFINED_LAYER |
||
| ) |
Definition at line 296 of file pcb_base_frame.cpp.
References FocusOnItems().
Referenced by PCB_SELECTION_TOOL::Main(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::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(), DIALOG_FOOTPRINT_CHECKER::~DIALOG_FOOTPRINT_CHECKER(), and DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES().
◆ FocusOnItems()
| void PCB_BASE_FRAME::FocusOnItems | ( | std::vector< BOARD_ITEM * > | aItems, |
| PCB_LAYER_ID | aLayer = UNDEFINED_LAYER |
||
| ) |
- 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 307 of file pcb_base_frame.cpp.
References SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::BBox(), SHAPE_POLY_SET::BooleanIntersection(), SHAPE_POLY_SET::BooleanSubtract(), BOX2< Vec >::Centre(), SHAPE_POLY_SET::CHAMFER_ACUTE_CORNERS, EDA_ITEM::ClearBrightened(), SHAPE_POLY_SET::Deflate(), ERROR_INSIDE, EDA_DRAW_FRAME::findDialogs(), EDA_DRAW_FRAME::FocusOnLocation(), GetBoard(), GetCanvas(), BOX2< Vec >::GetHeight(), DELETED_BOARD_ITEM::GetInstance(), BOARD::GetItem(), BOX2< Vec >::GetOrigin(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), SHAPE_POLY_SET::IsEmpty(), EDA_IU_SCALE::mmToIU(), SHAPE_POLY_SET::NewOutline(), niluuid, ZONE::Outline(), PCB_ARC_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FOOTPRINT_T, PCB_FP_DIM_ALIGNED_T, PCB_FP_DIM_CENTER_T, PCB_FP_DIM_LEADER_T, PCB_FP_DIM_ORTHOGONAL_T, PCB_FP_DIM_RADIAL_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, pcbIUScale, SHAPE_POLY_SET::PM_FAST, EDA_DRAW_PANEL_GAL::Refresh(), EDA_ITEM::SetBrightened(), KIGFX::VIEW::ToWorld(), ZONE::TransformShapeToPolygon(), EDA_ITEM::Type(), UNDEFINED_LAYER, and KIGFX::PCB_VIEW::Update().
Referenced by FocusOnItem(), and DIALOG_DRC::OnDRCItemSelected().
◆ FocusOnLocation()
|
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
-
aPos is the point to go to.
Definition at line 939 of file eda_draw_frame.cpp.
References BOX2< Vec >::Contains(), EDA_DRAW_FRAME::findDialogs(), 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::doSyncSelection(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_SELECTION_TOOL::FindItem(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_EDIT_FRAME::FocusOnItem(), FocusOnItems(), DIALOG_DRC::OnDRCItemSelected(), and EE_SELECTION_TOOL::SyncSelection().
◆ Get3DViewerFrame()
| EDA_3D_VIEWER_FRAME * PCB_BASE_FRAME::Get3DViewerFrame | ( | ) |
- Returns
- a reference to the child 3D viewer frame, when exists, or NULL
Definition at line 142 of file pcb_base_frame.cpp.
References QUALIFIED_VIEWER3D_FRAMENAME.
Referenced by canCloseWindow(), CommonSettingsChanged(), CreateAndShow3D_Frame(), PCB_EDIT_FRAME::OpenProjectFiles(), Update3DView(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().
◆ GetAboutTitle()
|
inlineinherited |
Definition at line 506 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_aboutTitle.
Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), PGM_SINGLE_TOP::OnPgmInit(), and PGM_KICAD::OnPgmInit().
◆ GetActiveLayer()
|
inlinevirtual |
Definition at line 357 of file pcb_base_frame.h.
References GetScreen(), and PCB_SCREEN::m_Active_Layer.
Referenced by DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), CONVERT_TOOL::CreatePolys(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_SELECTION_TOOL::GetActiveLayer(), GetCollectorsGuide(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), 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::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), APPEARANCE_CONTROLS::OnLayerChanged(), APPEARANCE_CONTROLS::OnLayerContextMenu(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), PCB_DRAW_PANEL_GAL::OnShow(), FOOTPRINT_EDIT_FRAME::OnUpdateLayerSelectBox(), PCB_EDIT_FRAME::OnUpdateLayerSelectBox(), LENGTH_TUNER_TOOL::performTuning(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceStackup(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), ROUTER_TOOL::RouteSelected(), PCB_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SetActiveLayer(), SetDisplayOptions(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), ROUTER_TOOL::switchLayerOnViaPlacement(), PCB_CONTROL::UpdateMessagePanel(), and PCB_EDIT_FRAME::UpdateUserInterface().
◆ GetAutoSaveFilePrefix()
|
inlinestaticprotectedinherited |
- Returns
- the string to prepend to a file name for automatic save.
Definition at line 602 of file eda_base_frame.h.
Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), SCH_EDIT_FRAME::CheckForAutoSaveFile(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveSchematicFile(), and SCH_EDIT_FRAME::updateAutoSaveFile().
◆ GetAutoSaveInterval()
|
inherited |
Definition at line 298 of file eda_base_frame.cpp.
References Pgm().
Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::onAutoSaveTimer(), and EDA_BASE_FRAME::ProcessEvent().
◆ GetAuxOrigin()
| const VECTOR2I & PCB_BASE_FRAME::GetAuxOrigin | ( | ) | const |
Definition at line 605 of file pcb_base_frame.cpp.
References BOARD_DESIGN_SETTINGS::GetAuxOrigin(), BOARD::GetDesignSettings(), and m_pcb.
Referenced by GetUserOrigin().
◆ GetBoard()
|
inline |
Definition at line 191 of file pcb_base_frame.h.
References m_pcb.
Referenced by AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), GRID_CELL_LAYER_SELECTOR::BeginEdit(), DIALOG_BOARD_REANNOTATE::BuildFootprintList(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), PCB_EDIT_FRAME::canCloseWindow(), FOOTPRINT_EDIT_FRAME::canCloseWindow(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_EDIT_FRAME::ClearModify(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), Compile_Ratsnest(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), CreateHeaderInfoData(), CreateNewFootprint(), ZONE_CREATE_HELPER::createNewZone(), PCB_PROPERTIES_PANEL::createPGProperty(), CONVERT_TOOL::CreatePolys(), DIALOG_PRINT_PCBNEW::createPrintout(), FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), PCB_CONTROL::DeleteItemCursor(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), 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_PLOT::DIALOG_PLOT(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), FOOTPRINT_VIEWER_FRAME::displayFootprint(), APPEARANCE_CONTROLS::doApplyLayerPreset(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), PCB_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), PCB_EDIT_FRAME::DoGenFootprintsReport(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::DpDimensionsDialog(), GRID_CELL_LAYER_RENDERER::Draw(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawSpecificationStackup(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::Duplicate(), FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), PCB_EDIT_FRAME::Edit_Zone_Params(), DIALOG_COPPER_ZONE::ensureSelectedNetIsVisible(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), VIA_SIZE_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::ExportSpecctraFile(), PCB_EDIT_FRAME::ExportSVG(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::FindItemsFromSyncSelection(), FocusOnItems(), PCB_EDIT_FRAME::GenD356File(), PCB_EDIT_FRAME::GenFootprintsReport(), EDA_3D_VIEWER_FRAME::GetBoard(), GetBoard(), PCB_EDIT_FRAME::GetCurrentFileName(), 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(), GetFootprintFromBoardByReference(), GetItem(), PCB_EDIT_FRAME::GetLastPath(), DIALOG_TRACK_VIA_PROPERTIES::getLayerDepth(), PCB_LAYER_BOX_SELECTOR::getLayerName(), PCB_LAYER_SELECTOR::getLayerName(), FOOTPRINT_EDIT_FRAME::GetLoadedFPID(), DISPLAY_FOOTPRINTS_FRAME::GetModel(), FOOTPRINT_EDIT_FRAME::GetModel(), FOOTPRINT_VIEWER_FRAME::GetModel(), FOOTPRINT_WIZARD_FRAME::GetModel(), ZONE_SEARCH_HANDLER::GetResultCell(), GetSeverity(), GRID_CELL_LAYER_SELECTOR::GetValue(), PRIVATE_LAYERS_GRID_TABLE::GetValue(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), APPEARANCE_CONTROLS::getVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), PCB_EDITOR_CONDITIONS::hasItemsFunc(), HideSolderMask(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), PCB_EDIT_FRAME::ImportSpecctraSession(), EDIT_TOOL::Init(), DIALOG_PLOT::init_Dialog(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), ARRAY_CREATOR::Invoke(), FOOTPRINT_EDIT_FRAME::IsContentModified(), FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), PCB_EDIT_FRAME::IsElementVisible(), PCB_LAYER_SELECTOR::isLayerEnabled(), PCB_EDIT_FRAME::KiwayMailIn(), LoadBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), DIALOG_IMPORT_NETLIST::loadNetlist(), PCB_EDIT_FRAME::LoadProjectSettings(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), CONVERT_TOOL::makePolysFromClosedGraphics(), CONVERT_TOOL::makePolysFromOpenGraphics(), DIALOG_DRC::OnActivateDlg(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), APPEARANCE_CONTROLS::OnBoardChanged(), DIALOG_NET_INSPECTOR::onBoardChanged(), PCB_SEARCH_PANE::onBoardChanged(), PCB_EDIT_FRAME::onBoardLoaded(), DIALOG_IMPORT_SETTINGS::OnBrowseClicked(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_EXPORT_STEP::onExportButton(), PCB_EDIT_FRAME::OnExportHyperlynx(), PCB_EDIT_FRAME::OnExportIDF3(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_EDIT_FRAME::OnExportVRML(), APPEARANCE_CONTROLS::OnLayerContextMenu(), OnModify(), APPEARANCE_CONTROLS::onNetclassContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), PCB_EDIT_FRAME::OnRemoveTeardropTool(), PCB_EDIT_FRAME::OnRunTeardropTool(), 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(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_SETUP_BOARD_FINISH::PANEL_SETUP_BOARD_FINISH(), 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(), PCB_SEARCH_PANE::PCB_SEARCH_PANE(), DIALOG_UPDATE_PCB::PerformUpdate(), DRAWING_TOOL::PlaceImportedGraphics(), DIALOG_PLOT::Plot(), ROUTER_TOOL::prepareInteractive(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingFootprints(), EDIT_TOOL::Properties(), FOOTPRINT_EDITOR_CONTROL::Properties(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), DIALOG_COPPER_ZONE::readNetInformation(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), NET_GRID_TABLE::Rebuild(), rebuildConnectivity(), APPEARANCE_CONTROLS::rebuildLayerContextMenu(), APPEARANCE_CONTROLS::rebuildLayers(), APPEARANCE_CONTROLS::rebuildNets(), PCB_EDIT_FRAME::RecordDRCExclusions(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), PCB_EDIT_FRAME::redrawNetnames(), DIALOG_PLOT::reInitDialog(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), BOARD_INSPECTION_TOOL::reportHeader(), DRC_TOOL::Reset(), PCB_EDIT_FRAME::ResolveDRCExclusions(), ROUTER_TOOL::RouteSelected(), PCB_EDIT_FRAME::RunActionPlugin(), DIALOG_FOOTPRINT_CHECKER::runChecks(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), DIALOG_FIND::search(), FOOTPRINT_SEARCH_HANDLER::Search(), ZONE_SEARCH_HANDLER::Search(), TEXT_SEARCH_HANDLER::Search(), NETS_SEARCH_HANDLER::Search(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SelectOneLayer(), SetBoard(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), PCB_EDIT_FRAME::SetElementVisibility(), PCB_EDIT_FRAME::SetLastPath(), APPEARANCE_CONTROLS::SetObjectVisible(), PCB_EDIT_FRAME::SetPageSettings(), DIALOG_PLOT::SetPlotFormat(), ZONE_CREATE_HELPER::setUniquePriority(), ZONE_SETTINGS::SetupLayersList(), FOOTPRINT_EDIT_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), APPEARANCE_CONTROLS::showNetclass(), ShowSolderMask(), DIALOG_COPPER_ZONE::sortNetsByPadCount(), PCB_EDIT_FRAME::SwitchLayer(), TEARDROP_DIALOG::TEARDROP_DIALOG(), DIALOG_SWAP_LAYERS::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_UNUSED_PAD_LAYERS::TransferDataFromWindow(), PANEL_SETUP_MASK_AND_PASTE::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), DIALOG_SWAP_LAYERS::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), PANEL_SETUP_MASK_AND_PASTE::TransferDataToWindow(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), VIA_SIZE_MENU::update(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), PCB_CONTROL::UpdateMessagePanel(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), DRC_TOOL::updatePointers(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), PCB_EDIT_FRAME::UpdateTitle(), PCB_EDIT_FRAME::UpdateUserInterface(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_EDIT_FRAME::UpdateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), DIALOG_DRC::writeReport(), DIALOG_FOOTPRINT_CHECKER::~DIALOG_FOOTPRINT_CHECKER(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), and PCB_EDIT_FRAME::~PCB_EDIT_FRAME().
◆ GetBoardBoundingBox()
| BOX2I PCB_BASE_FRAME::GetBoardBoundingBox | ( | bool | aBoardEdgesOnly = false | ) | const |
Calculate the bounding box containing all board items (or board edge segments).
- Parameters
-
aBoardEdgesOnly is true if we are interested in board edge segments only.
- Returns
- the board's bounding box.
Definition at line 681 of file pcb_base_frame.cpp.
References BOARD::GetBoardEdgesBoundingBox(), BOARD::GetBoundingBox(), BOX2< Vec >::GetHeight(), GetPageSizeIU(), BOX2< Vec >::GetWidth(), m_pcb, EDA_DRAW_FRAME::m_showBorderAndTitleBlock, BOX2< Vec >::SetEnd(), and BOX2< Vec >::SetOrigin().
Referenced by GetDocumentExtents(), and FOOTPRINT_EDIT_FRAME::GetDocumentExtents().
◆ GetCanvas()
|
overridevirtual |
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 1059 of file pcb_base_frame.cpp.
References EDA_DRAW_FRAME::GetCanvas().
Referenced by ActivateGalCanvas(), FOOTPRINT_EDIT_FRAME::ActivateGalCanvas(), PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), PCB_EDIT_FRAME::ActivateGalCanvas(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), DIALOG_NET_INSPECTOR::buildNetsList(), PCB_SELECTION_TOOL::canvas(), PCB_TOOL_BASE::canvas(), PCB_VIEWER_TOOLS::canvas(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), FOOTPRINT_VIEWER_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), DIALOG_PRINT_PCBNEW::createPrintout(), PCB_CONTROL::DeleteItemCursor(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DisplayGridMsg(), APPEARANCE_CONTROLS::doApplyLayerPreset(), APPEARANCE_CONTROLS::doApplyViewport(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), PCB_EDIT_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::doSyncSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), DIALOG_DRC::ExcludeMarker(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_SELECTION_TOOL::FindItem(), ROUTER_TOOL::finishInteractive(), PCB_CONTROL::FlipPcbView(), FocusOnItems(), GetCollectorsGuide(), APPEARANCE_CONTROLS::getVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), ROUTER_TOOL::handleLayerSwitch(), FOOTPRINT_EDIT_FRAME::HardRedraw(), HideSolderMask(), PCB_EDIT_FRAME::ImportSpecctraSession(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), PCB_EDIT_FRAME::LoadProjectSettings(), LoadSettings(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), PCB_EDIT_FRAME::onBoardLoaded(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), DIALOG_NET_INSPECTOR::onDeleteNet(), DIALOG_DRC::OnDRCItemRClick(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_SELECTION_TOOL::OnIdle(), APPEARANCE_CONTROLS::OnLayerContextMenu(), APPEARANCE_CONTROLS::onLayerVisibilityToggled(), DIALOG_GROUP_PROPERTIES::OnMemberSelected(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetColorMode(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), DIALOG_GROUP_PROPERTIES::OnRemoveMember(), PCB_EDIT_FRAME::OnRemoveTeardropTool(), DIALOG_NET_INSPECTOR::onRenameNet(), DIALOG_NET_INSPECTOR::onSelChanged(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_NET_INSPECTOR::onSortingChanged(), FOOTPRINT_TREE_PANE::onUpdateUI(), APPEARANCE_CONTROLS::onViewportChanged(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), BOARD_EDITOR_CONTROL::PageSettings(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PlaceFootprint(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), DIALOG_PAD_PROPERTIES::prepareCanvas(), ROUTER_TOOL::prepareInteractive(), PCB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), FOOTPRINT_EDITOR_CONTROL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), NET_GRID_TABLE::Rebuild(), PCB_EDIT_FRAME::RebuildAndRefresh(), rebuildConnectivity(), APPEARANCE_CONTROLS::rebuildNets(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_WIZARD_FRAME::ReCreatePageList(), PCB_EDIT_FRAME::redrawNetnames(), refreshCallback(), DIALOG_DRC::refreshEditor(), DIALOG_FOOTPRINT_CHECKER::refreshEditor(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), PCB_SELECTION_TOOL::RequestSelection(), PCB_EDIT_FRAME::ResolveDRCExclusions(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PCB_BASE_EDIT_FRAME::RollbackFromUndo(), ROUTER_TOOL::RouteSelected(), 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(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), FOOTPRINT_SEARCH_HANDLER::SelectItems(), ZONE_SEARCH_HANDLER::SelectItems(), TEXT_SEARCH_HANDLER::SelectItems(), NETS_SEARCH_HANDLER::SelectItems(), FOOTPRINT_EDIT_FRAME::SelectLayer(), PCB_SELECTION_TOOL::selectMultiple(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), DRAWING_TOOL::SetAnchor(), SetBoard(), PCB_BASE_EDIT_FRAME::SetBoard(), SetDisplayOptions(), PCB_POINT_EDITOR::setEditedPoint(), PCB_EDIT_FRAME::SetElementVisibility(), PCB_EDIT_FRAME::SetGridColor(), APPEARANCE_CONTROLS::SetLayerVisible(), APPEARANCE_CONTROLS::SetObjectVisible(), PCB_EDIT_FRAME::SetPageSettings(), FOOTPRINT_EDIT_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), PCB_BASE_EDIT_FRAME::ShowBitmapPropertiesDialog(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), ShowSolderMask(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), FOOTPRINT_EDIT_FRAME::SwitchCanvas(), SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), NET_GRID_TABLE::updateNetColor(), UpdateStatusBar(), PCB_EDIT_FRAME::UpdateUserInterface(), UpdateUserUnits(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_EDIT_FRAME::UpdateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::zoomFitSelection(), DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_NETLIST::~DIALOG_IMPORT_NETLIST(), DIALOG_NET_INSPECTOR::~DIALOG_NET_INSPECTOR(), DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME(), PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME(), and ~PCB_BASE_FRAME().
◆ GetCollectorsGuide()
| GENERAL_COLLECTORS_GUIDE PCB_BASE_FRAME::GetCollectorsGuide | ( | ) |
- Returns
- global configuration options.
Definition at line 795 of file pcb_base_frame.cpp.
References GetActiveLayer(), GetCanvas(), BOARD::GetVisibleLayers(), BOARD::IsElementVisible(), LAYER_MOD_BK, LAYER_MOD_FR, LAYER_MOD_REFERENCES, LAYER_MOD_TEXT, LAYER_MOD_TEXT_INVISIBLE, LAYER_MOD_VALUES, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_TH, LAYER_TRACKS, LAYER_VIAS, m_pcb, GENERAL_COLLECTORS_GUIDE::SetIgnoreBlindBuriedVias(), GENERAL_COLLECTORS_GUIDE::SetIgnoreMicroVias(), GENERAL_COLLECTORS_GUIDE::SetIgnoreModulesOnBack(), GENERAL_COLLECTORS_GUIDE::SetIgnoreModulesOnFront(), GENERAL_COLLECTORS_GUIDE::SetIgnoreModulesRefs(), GENERAL_COLLECTORS_GUIDE::SetIgnoreModulesVals(), GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsMarkedNoShow(), GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsOnBack(), GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsOnFront(), GENERAL_COLLECTORS_GUIDE::SetIgnorePadsOnBack(), GENERAL_COLLECTORS_GUIDE::SetIgnorePadsOnFront(), GENERAL_COLLECTORS_GUIDE::SetIgnoreThroughHolePads(), GENERAL_COLLECTORS_GUIDE::SetIgnoreThroughVias(), and GENERAL_COLLECTORS_GUIDE::SetIgnoreTracks().
Referenced by PCB_CONTROL::DeleteItemCursor(), PAD_TOOL::EnumeratePads(), and BOARD_INSPECTION_TOOL::highlightNet().
◆ GetColorSettings()
|
inlineoverridevirtual |
Helper to retrieve the current color settings.
Reimplemented from EDA_DRAW_FRAME.
Reimplemented in DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, and PCB_BASE_EDIT_FRAME.
Definition at line 156 of file pcb_base_frame.h.
Referenced by ActivateGalCanvas(), CommonSettingsChanged(), GRID_CELL_LAYER_RENDERER::Draw(), PCB_LAYER_BOX_SELECTOR::getLayerColor(), PCB_LAYER_SELECTOR::getLayerColor(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), APPEARANCE_CONTROLS::rebuildLayers(), APPEARANCE_CONTROLS::rebuildNets(), APPEARANCE_CONTROLS::rebuildObjects(), ZONE_SETTINGS::SetupLayersList(), APPEARANCE_CONTROLS::syncColorsAndVisibility(), APPEARANCE_CONTROLS::syncObjectSettings(), and PCB_DRAW_PANEL_GAL::UpdateColors().
◆ GetCurrentFileName()
|
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 SCH_EDIT_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, and PCB_EDIT_FRAME.
Definition at line 431 of file eda_base_frame.h.
Referenced by EDA_BASE_FRAME::SaveSettings().
◆ GetCurrentSelection()
|
inlinevirtualinherited |
Get the current selection from the canvas area.
- Returns
- the current selection.
Reimplemented in DISPLAY_FOOTPRINTS_FRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, SYMBOL_VIEWER_FRAME, GERBVIEW_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and PCB_EDIT_FRAME.
Definition at line 101 of file tools_holder.h.
References TOOLS_HOLDER::m_dummySelection.
Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent(), ACTION_MANAGER::RunHotKey(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), NL_SCHEMATIC_PLUGIN_IMPL::SetActiveCommand(), and NL_PCBNEW_PLUGIN_IMPL::SetActiveCommand().
◆ GetDesignSettings()
|
virtual |
Returns the BOARD_DESIGN_SETTINGS for the open project.
Reimplemented in FOOTPRINT_EDIT_FRAME.
Definition at line 644 of file pcb_base_frame.cpp.
References BOARD::GetDesignSettings(), and m_pcb.
Referenced by PCB_CONTROL::AppendBoard(), PAD_TOOL::copyPadSettings(), MICROWAVE_TOOL::createBaseFootprint(), MICROWAVE_TOOL::createFootprint(), CreateNewFootprint(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), PCB_EDIT_FRAME::onBoardLoaded(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), PCB_EDIT_FRAME::OnUpdateSelectAutoWidth(), PCB_EDIT_FRAME::OnUpdateSelectTrackWidth(), PCB_EDIT_FRAME::OnUpdateSelectViaSize(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PAD_TOOL::pastePadProperties(), DRAWING_TOOL::PlaceText(), PCB_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), DIALOG_DRC::updateDisplayedCounts(), PCB_EDIT_FRAME::UpdateTrackWidthSelectBox(), and PCB_EDIT_FRAME::UpdateViaSizeSelectBox().
◆ GetDisplayOptions()
|
inline |
Display options control the way tracks, vias, outlines and other things are shown (for instance solid or sketch mode).
Definition at line 168 of file pcb_base_frame.h.
References m_displayOptions.
Referenced by ActivateGalCanvas(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), PAD_TOOL::EditPad(), PCB_CONTROL::HighContrastMode(), PCB_CONTROL::HighContrastModeCycle(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_CONTROL::NetColorModeCycle(), APPEARANCE_CONTROLS::onNetColorMode(), APPEARANCE_CONTROLS::onObjectOpacitySlider(), PCB_DRAW_PANEL_GAL::OnShow(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), PNS::TOOL_BASE::pickSingleItem(), PCB_EDIT_FRAME::Process_Special_Functions(), PAD_TOOL::Reset(), PCB_EDIT_FRAME::SaveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SelectLayer(), PCB_SELECTION_TOOL::selectPoint(), PCB_EDIT_FRAME::SetActiveLayer(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), APPEARANCE_CONTROLS::syncObjectSettings(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), PCB_CONTROL::ZoneDisplayMode(), and PCB_EDITOR_CONDITIONS::zoneDisplayModeFunc().
◆ GetDocumentExtents()
|
inlineoverridevirtual |
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
-
aIncludeAllVisible True 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 109 of file pcb_base_frame.h.
References Edge_Cuts, GetBoardBoundingBox(), BOARD::IsLayerVisible(), and m_pcb.
◆ GetDoImmediateActions()
|
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 141 of file tools_holder.h.
References TOOLS_HOLDER::m_immediateActions.
◆ GetDragAction()
|
inlineinherited |
Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.
Definition at line 147 of file tools_holder.h.
References TOOLS_HOLDER::m_dragAction.
Referenced by EE_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), and PCB_SELECTION_TOOL::Main().
◆ GetDrawBgColor()
|
inlinevirtualinherited |
Reimplemented in SCH_BASE_FRAME.
Definition at line 166 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_drawBgColor.
Referenced by PLEDITOR_PRINTOUT::PrintPage(), PROPERTIES_FRAME::PROPERTIES_FRAME(), PL_EDITOR_FRAME::SaveSettings(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().
◆ GetFileFromHistory()
|
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
-
cmdId The command ID associated with the aFileHistory object. type Please document me! aFileHistory The FILE_HISTORY in use. If null, the main application file history is used
- Returns
- a wxString containing the selected filename
Definition at line 929 of file eda_base_frame.cpp.
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()
|
inlineinherited |
Get the frame's main file history.
- Returns
- the main file history
Definition at line 415 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_fileHistory.
Referenced by SCH_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), and PCB_EDIT_FRAME::doReCreateMenuBar().
◆ GetFindHistoryList()
|
inlineinherited |
Definition at line 106 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_findStringHistoryList.
Referenced by DIALOG_FIND::DIALOG_FIND(), DIALOG_FIND::search(), DIALOG_SCH_FIND::SetFindEntries(), and DIALOG_SCH_FIND::SetReplaceEntries().
◆ GetFindReplaceData()
|
inlineinherited |
Definition at line 105 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_findReplaceData.
Referenced by SCH_FIND_REPLACE_TOOL::FindNext(), SCH_FIND_REPLACE_TOOL::HasMatch(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_FIND_REPLACE_TOOL::ReplaceAndFindNext(), DIALOG_FIND::search(), and SCH_FIND_REPLACE_TOOL::UpdateFind().
◆ GetFootprintEditorSettings()
| FOOTPRINT_EDITOR_SETTINGS * PCB_BASE_FRAME::GetFootprintEditorSettings | ( | ) | const |
Definition at line 961 of file pcb_base_frame.cpp.
References Pgm().
Referenced by PCB_POINT_EDITOR::changeArcEditMode(), FOOTPRINT_EDIT_FRAME::GetColorSettings(), FOOTPRINT_WIZARD_FRAME::GetColorSettings(), and PCB_POINT_EDITOR::OnSelectionChange().
◆ GetFootprintFromBoardByReference()
| FOOTPRINT * PCB_BASE_FRAME::GetFootprintFromBoardByReference | ( | ) |
- 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 463 of file load_select_footprint.cpp.
References FOOTPRINT::Add(), GetBoard(), and DIALOG_GET_FOOTPRINT_BY_NAME::GetValue().
◆ GetFrameType()
|
inlineinherited |
Definition at line 201 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_ident.
Referenced by GetViewerSettingsBase(), and EDA_BASE_FRAME::ShowPreferences().
◆ GetGalDisplayOptions()
|
inlineinherited |
Return a reference to the gal rendering options used by GAL for rendering.
Definition at line 422 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_galDisplayOptions.
Referenced by SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::createCanvas(), EDITOR_CONDITIONS::cursorFunc(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_VIEWER_FRAME::LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), DIALOG_PAD_PROPERTIES::prepareCanvas(), SYMBOL_EDIT_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), COMMON_TOOLS::ToggleCursor(), and COMMON_TOOLS::ToggleCursorStyle().
◆ GetGridColor()
|
inlinevirtualinherited |
Reimplemented in DISPLAY_FOOTPRINTS_FRAME, GERBVIEW_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and PCB_EDIT_FRAME.
Definition at line 216 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_gridColor.
Referenced by PCB_CONTROL::Reset().
◆ GetGridOrigin()
|
overridevirtual |
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 593 of file pcb_base_frame.cpp.
References BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetGridOrigin(), and m_pcb.
Referenced by GetUserOrigin().
◆ GetInfoBar()
|
inlineinherited |
- Returns
- the WX_INFOBAR that can be displayed on the top of the canvas.
Definition at line 234 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_infoBar.
Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), PCB_EDIT_FRAME::CommonSettingsChanged(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SCH_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), APPEARANCE_CONTROLS::onReadOnlySwatch(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), PAD_TOOL::Reset(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SYMBOL_EDIT_FRAME::SetCurSymbol(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), EDA_BASE_FRAME::ShowInfoBarWarning(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), PCB_CONTROL::unfilledZoneCheck(), and ZONE_FILLER_TOOL::ZoneFillDirty().
◆ GetItem()
Fetch an item by KIID.
Frame-type-specific implementation.
Reimplemented from EDA_DRAW_FRAME.
Definition at line 290 of file pcb_base_frame.cpp.
References GetBoard(), and BOARD::GetItem().
Referenced by PAD_TOOL::EditPad().
◆ GetIuScale()
|
inlineinherited |
Definition at line 45 of file units_provider.h.
References UNITS_PROVIDER::m_iuScale.
Referenced by UNITS_PROVIDER::AngleValueFromString(), GRID_MENU::BuildChoiceList(), UNITS_PROVIDER::MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), COMMON_TOOLS::Reset(), UNITS_PROVIDER::StringFromValue(), and UNITS_PROVIDER::ValueFromString().
◆ GetMagneticItemsSettings()
|
virtual |
Reimplemented in DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.
Definition at line 988 of file pcb_base_frame.cpp.
References GetPcbNewSettings(), and PCBNEW_SETTINGS::m_MagneticItems.
Referenced by PNS::TOOL_BASE::checkSnap(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_PICKER_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), and DRAWING_TOOL::SetAnchor().
◆ GetMaxUndoItems()
|
inlineinherited |
Definition at line 576 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_undoRedoCountMax.
Referenced by EDA_DRAW_FRAME::SaveSettings().
◆ GetModel()
|
pure virtual |
- Returns
- the primary data model.
Implemented in DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, and PCB_EDIT_FRAME.
Referenced by ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::DrawSpecificationStackup(), DRAWING_TOOL::DrawZone(), DRAWING_TOOL::InteractivePlaceWithPreview(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), DRAWING_TOOL::SetAnchor(), and PCB_CONTROL::UpdateMessagePanel().
◆ GetMoveWarpsCursor()
|
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 153 of file tools_holder.h.
References TOOLS_HOLDER::m_moveWarpsCursor.
Referenced by EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::InlineDrag(), SCH_MOVE_TOOL::Main(), and SYMBOL_EDITOR_MOVE_TOOL::Main().
◆ GetMruPath()
|
inlineinherited |
Definition at line 422 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_mruPath.
Referenced by AskLoadBoardFileName(), PANEL_HOTKEYS_EDITOR::dumpHotkeys(), GERBVIEW_CONTROL::ExportToPcbnew(), PCB_EDIT_FRAME::Files_io_from_id(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), EDA_DRAW_FRAME::LibraryFileBrowser(), KICAD_MANAGER_CONTROL::NewProject(), KICAD_MANAGER_CONTROL::OpenProject(), SCH_EDIT_FRAME::SaveProject(), and KICAD_MANAGER_CONTROL::SaveProjectAs().
◆ GetNearestGridPosition()
Return the nearest aGridSize location to aPosition.
- Parameters
-
aPosition The position to check.
- Returns
- The nearest grid position.
Definition at line 878 of file eda_draw_frame.cpp.
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 SCH_EDIT_TOOL::ChangeTextType(), and SCH_DRAWING_TOOLS::sizeSheet().
◆ GetNearestHalfGridPosition()
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
-
aPosition The position to check.
- Returns
- The nearest half-grid position.
Definition at line 892 of file eda_draw_frame.cpp.
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 SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Rotate(), and SYMBOL_EDITOR_EDIT_TOOL::Rotate().
◆ GetOriginTransforms()
|
overridevirtual |
Return a reference to the default ORIGIN_TRANSFORMS object.
Reimplemented from EDA_BASE_FRAME.
Definition at line 626 of file pcb_base_frame.cpp.
References m_originTransforms.
◆ GetPageSettings()
|
overridevirtual |
Implements EDA_DRAW_FRAME.
Definition at line 578 of file pcb_base_frame.cpp.
References BOARD::GetPageSettings(), and m_pcb.
Referenced by PCB_CONTROL::Print().
◆ GetPageSizeIU()
|
overridevirtual |
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 584 of file pcb_base_frame.cpp.
References BOARD::GetPageSettings(), PAGE_INFO::GetSizeIU(), EDA_IU_SCALE::IU_PER_MILS, m_pcb, and pcbIUScale.
Referenced by PCB_CONTROL::AppendBoard(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), GetBoardBoundingBox(), and PCB_EDIT_FRAME::OpenProjectFiles().
◆ GetPcbNewSettings()
| PCBNEW_SETTINGS * PCB_BASE_FRAME::GetPcbNewSettings | ( | ) | const |
Definition at line 955 of file pcb_base_frame.cpp.
References Pgm().
Referenced by AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), DIALOG_PLOT::applyPlotSettings(), PCB_POINT_EDITOR::changeArcEditMode(), PCB_EDIT_FRAME::CommonSettingsChanged(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_SELECTION_TOOL::ctrlClickHighlights(), EDIT_TOOL::DeleteItems(), 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_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PCB_TOOL_BASE::displayOptions(), PCB_VIEWER_TOOLS::displayOptions(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), EDIT_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::doSyncSelection(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), EDIT_TOOL::Flip(), PCB_BASE_EDIT_FRAME::GetColorSettings(), GetMagneticItemsSettings(), GetUserOrigin(), BOARD_INSPECTION_TOOL::HighlightItem(), DIALOG_PLOT::init_Dialog(), DIALOG_EXPORT_SVG::initDialog(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_GENDRILL::initDialog(), DIALOG_BOARD_REANNOTATE::InitValues(), ROUTER_TOOL::InlineDrag(), PCB_ORIGIN_TRANSFORMS::invertXAxis(), PCB_ORIGIN_TRANSFORMS::invertYAxis(), PCB_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), DIALOG_COPPER_ZONE::loadPersistentNetSortConfigurations(), PCB_SELECTION_TOOL::Main(), PCB_EDIT_FRAME::onBoardLoaded(), DIALOG_PRINT_PCBNEW::onColorModeClicked(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), PCB_EDIT_FRAME::OnModify(), PCB_EDIT_FRAME::OnNetlistChanged(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_EXPORT_SVG::onPagePerLayerClicked(), APPEARANCE_CONTROLS::onRatsnestMode(), PCB_POINT_EDITOR::OnSelectionChange(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BOARD_COMMIT::Push(), PNS::TOOL_BASE::Reset(), EDIT_TOOL::Rotate(), DIALOG_PRINT_PCBNEW::saveSettings(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::setupUIConditions(), APPEARANCE_CONTROLS::setVisibleObjects(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), DIALOG_COPPER_ZONE::storePersistentNetSortConfigurations(), PCB_EDIT_FRAME::ToggleLayersManager(), PCB_EDIT_FRAME::ToggleProperties(), PCB_EDIT_FRAME::ToggleSearch(), PCB_EDITOR_CONDITIONS::trackFillDisplayFunc(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_IMPORT_GFX::TransferDataFromWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), DIALOG_GENDRILL::UpdateConfig(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), PCB_EDITOR_CONDITIONS::viaFillDisplayFunc(), APPEARANCE_CONTROLS::~APPEARANCE_CONTROLS(), 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_IMPORT_NETLIST::~DIALOG_IMPORT_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().
◆ GetPlotSettings()
|
virtual |
Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.
Reimplemented in FOOTPRINT_EDIT_FRAME.
Definition at line 669 of file pcb_base_frame.cpp.
References BOARD::GetPlotOptions(), and m_pcb.
Referenced by DIALOG_PLOT::CreateDrillFile(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_PLOT::DIALOG_PLOT(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), and PCB_EDIT_FRAME::ToPlotter().
◆ GetRedoCommandCount()
|
inlinevirtualinherited |
Reimplemented in CVPCB_MAINFRAME.
Definition at line 574 of file eda_base_frame.h.
References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_redoList.
Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), EDA_BASE_FRAME::PushCommandToRedoList(), SCH_EDITOR_CONTROL::Redo(), EDITOR_CONDITIONS::redoFunc(), and PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList().
◆ GetScreen()
|
inlineoverridevirtual |
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 221 of file pcb_base_frame.h.
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::drawShape(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExportSpecctraFile(), PCB_EDIT_FRAME::Files_io_from_id(), GetActiveLayer(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), ROUTER_TOOL::handleLayerSwitch(), FOOTPRINT_EDIT_FRAME::IsContentModified(), PCB_EDIT_FRAME::IsContentModified(), PCB_CONTROL::LayerToggle(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EDIT_TOOL::MoveExact(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PCB_EDIT_FRAME::OnExportSTEP(), OnModify(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::PrepareLayerIndicator(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PCB_EDIT_FRAME::SavePcbFile(), DIALOG_FIND::search(), ROUTER_TOOL::SelectCopperLayerPair(), SetActiveLayer(), SetPageSettings(), PCB_EDIT_FRAME::SetPageSettings(), UpdateStatusBar(), and DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME().
◆ GetScreenDesc()
|
virtualinherited |
Reimplemented in SCH_EDIT_FRAME.
Definition at line 1043 of file eda_draw_frame.cpp.
Referenced by EDA_DRAW_FRAME::PrintDrawingSheet(), and PCB_EDIT_FRAME::SetPageSettings().
◆ GetSettingsManager()
|
inlineinherited |
Definition at line 136 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_settingsManager.
Referenced by KICAD_MANAGER_FRAME::canCloseWindow(), EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::CreateNewProject(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_BASE_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_PLOT_SCHEMATIC::getColorSettings(), EESCHEMA_HELPERS::GetSettingsManager(), GetSettingsManager(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), SCH_EDIT_FRAME::OnImportProject(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().
◆ GetSeverity()
|
overridevirtual |
Reimplemented from EDA_BASE_FRAME.
Definition at line 932 of file pcb_base_frame.cpp.
References CLEANUP_FIRST, GetBoard(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::m_DRCSeverities, and RPT_SEVERITY_ACTION.
◆ GetShowPolarCoords()
|
inlineinherited |
For those frames that support polar coordinates.
Definition at line 120 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::m_polarCoords.
Referenced by EDITOR_CONDITIONS::polarCoordFunc(), COMMON_TOOLS::TogglePolarCoords(), GERBVIEW_FRAME::UpdateStatusBar(), and UpdateStatusBar().
◆ GetTitleBlock()
|
overridevirtual |
Implements EDA_DRAW_FRAME.
Definition at line 632 of file pcb_base_frame.cpp.
References BOARD::GetTitleBlock(), and m_pcb.
◆ GetToolCanvas()
|
inlineoverridevirtualinherited |
Canvas access.
Implements TOOLS_HOLDER.
Definition at line 417 of file eda_draw_frame.h.
References EDA_DRAW_FRAME::GetCanvas().
◆ GetToolManager()
|
inlineinherited |
Return the MVC controller.
Definition at line 54 of file tools_holder.h.
References TOOLS_HOLDER::m_toolManager.
Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), PCB_PROPERTIES_PANEL::AfterCommit(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), SCH_NAVIGATE_TOOL::Back(), BOARD_COMMIT::BOARD_COMMIT(), SCH_NAVIGATE_TOOL::changeSheet(), 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::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_NAVIGATE_TOOL::Forward(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineBreakTrack(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnDeleteOneClick(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), GERBER_LAYER_WIDGET::onPopupSelection(), SIM_PLOT_FRAME::onProbe(), PCB_EDIT_FRAME::OnRemoveTeardropTool(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), PCB_EDIT_FRAME::OnRunTeardropTool(), HIERARCHY_PANE::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), PCB_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected(), SIM_PLOT_FRAME::onTune(), PANEL_KICAD_LAUNCHER::PANEL_KICAD_LAUNCHER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), rebuildConnectivity(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), DIALOG_FIND::search(), FOOTPRINT_SEARCH_HANDLER::SelectItems(), ZONE_SEARCH_HANDLER::SelectItems(), TEXT_SEARCH_HANDLER::SelectItems(), CVPCB_MAINFRAME::setupEventHandlers(), TOOLS_HOLDER::ShowChangedLanguage(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), PCB_PROPERTIES_PANEL::UpdateData(), DIALOG_DRC::updateDisplayedCounts(), CVPCB_MAINFRAME::updateFootprintViewerOnIdle(), NET_GRID_TABLE::updateNetVisibility(), PCB_PROPERTIES_PANEL::valueChanged(), DIALOG_IMPORT_NETLIST::~DIALOG_IMPORT_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().
◆ GetType()
|
inlineinherited |
Definition at line 46 of file kiway_holder.h.
References KIWAY_HOLDER::m_type.
Referenced by DIALOG_SHIM::DIALOG_SHIM().
◆ GetUndoCommandCount()
|
inlinevirtualinherited |
Reimplemented in CVPCB_MAINFRAME.
Definition at line 573 of file eda_base_frame.h.
References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_undoList.
Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EDA_BASE_FRAME::PushCommandToUndoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDITOR_CONTROL::Undo(), and EDITOR_CONDITIONS::undoFunc().
◆ GetUnitPair()
|
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 1172 of file eda_draw_frame.cpp.
References COMMON_TOOLS::GetLastImperialUnits(), COMMON_TOOLS::GetLastMetricUnits(), TOOL_MANAGER::GetTool(), UNITS_PROVIDER::GetUserUnits(), EDA_UNIT_UTILS::IsImperialUnit(), TOOLS_HOLDER::m_toolManager, MILLIMETRES, and MILS.
Referenced by GRID_MENU::BuildChoiceList(), and PCB_EDIT_FRAME::UpdateTrackWidthSelectBox().
◆ GetUntranslatedAboutTitle()
|
inlineinherited |
Definition at line 508 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_aboutTitle.
Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), and COMMON_CONTROL::ReportBug().
◆ GetUserOrigin()
| const VECTOR2I PCB_BASE_FRAME::GetUserOrigin | ( | ) | const |
Definition at line 611 of file pcb_base_frame.cpp.
References GetAuxOrigin(), GetGridOrigin(), GetPcbNewSettings(), PCB_ORIGIN_AUX, PCB_ORIGIN_GRID, and PCB_ORIGIN_PAGE.
Referenced by PCB_ORIGIN_TRANSFORMS::getUserXOrigin(), and PCB_ORIGIN_TRANSFORMS::getUserYOrigin().
◆ GetUserUnits()
|
inlineinherited |
Definition at line 42 of file units_provider.h.
References UNITS_PROVIDER::m_userUnits.
Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PG_UNIT_EDITOR::CreateControls(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PROPERTIES_PANEL::extractValueAndWritability(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), PCB_EDIT_FRAME::GenFootprintsReport(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), WX_GRID::GetUnitValue(), GetUserUnits(), UNIT_BINDER::init(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PG_UNIT_EDITOR::PG_UNIT_EDITOR(), PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::PositionRelative(), PROPERTIES_PANEL::rebuildProperties(), DRC_TOOL::RunTests(), SCH_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), WX_GRID::SetUnitsProvider(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), UNITS_PROVIDER::StringFromValue(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PG_UNIT_EDITOR::UpdateFrame(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), UpdateUserUnits(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and UNITS_PROVIDER::ValueFromString().
◆ GetViewerSettingsBase()
|
virtual |
Reimplemented in DISPLAY_FOOTPRINTS_FRAME.
Definition at line 967 of file pcb_base_frame.cpp.
References FRAME_CVPCB, FRAME_CVPCB_DISPLAY, FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_PREVIEW, FRAME_FOOTPRINT_VIEWER, FRAME_FOOTPRINT_VIEWER_MODAL, FRAME_FOOTPRINT_WIZARD, FRAME_PCB_DISPLAY3D, FRAME_PCB_EDITOR, EDA_BASE_FRAME::GetFrameType(), and Pgm().
Referenced by PCB_VIEWER_TOOLS::GraphicOutlines(), PCB_EDITOR_CONDITIONS::graphicsFillDisplayFunc(), PCB_VIEWER_TOOLS::PadDisplayMode(), PCB_EDITOR_CONDITIONS::padFillDisplayFunc(), PCB_EDITOR_CONDITIONS::padNumberDisplayFunc(), PCB_VIEWER_TOOLS::ShowPadNumbers(), PCB_EDITOR_CONDITIONS::textFillDisplayFunc(), and PCB_VIEWER_TOOLS::TextOutlines().
◆ GetWindowSettings()
|
virtualinherited |
Return a pointer to the window settings for this frame.
By default, points to aCfg->m_Window for top-level frames.
- Parameters
-
aCfg is this frame's config object
Reimplemented in DISPLAY_FOOTPRINTS_FRAME, SIM_PLOT_FRAME, SYMBOL_VIEWER_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.
Definition at line 803 of file eda_base_frame.cpp.
References APP_SETTINGS_BASE::m_Window.
Referenced by EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), EDA_BASE_FRAME::SaveSettings(), and EDA_DRAW_FRAME::SaveSettings().
◆ GetWindowSize()
|
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 1387 of file eda_base_frame.cpp.
References KICAD_MAIN_FRAME_T, and EDA_BASE_FRAME::m_ident.
Referenced by EDA_BASE_FRAME::ensureWindowIsOnScreen(), EDA_BASE_FRAME::OnMaximize(), and EDA_BASE_FRAME::SaveWindowSettings().
◆ GetZoneSettings()
| const ZONE_SETTINGS & PCB_BASE_FRAME::GetZoneSettings | ( | ) | const |
Definition at line 657 of file pcb_base_frame.cpp.
References BOARD_DESIGN_SETTINGS::GetDefaultZoneSettings(), BOARD::GetDesignSettings(), and m_pcb.
Referenced by ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), and PCB_EDIT_FRAME::Edit_Zone_Params().
◆ GetZoomLevelIndicator()
|
inherited |
Return a human readable value for display in dialogs.
Definition at line 656 of file eda_draw_frame.cpp.
References Format(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetZoomFactor(), EDA_DRAW_FRAME::m_canvas, and zoom.
Referenced by EDA_DRAW_FRAME::UpdateStatusBar(), and PL_EDITOR_FRAME::UpdateStatusBar().
◆ handleActivateEvent()
|
overrideprotectedvirtual |
Handle a window activation event.
Reimplemented from EDA_DRAW_FRAME.
Reimplemented in PCB_BASE_EDIT_FRAME.
Definition at line 116 of file pcb_base_frame.cpp.
References EDA_DRAW_FRAME::handleActivateEvent(), m_spaceMouse, and NL_PCBNEW_PLUGIN::SetFocus().
Referenced by PCB_BASE_EDIT_FRAME::handleActivateEvent().
◆ handleIconizeEvent()
|
overrideprotectedvirtual |
Handle a window iconize event.
- Parameters
-
aEvent is the data for the event.
Reimplemented from EDA_BASE_FRAME.
Definition at line 129 of file pcb_base_frame.cpp.
References EDA_BASE_FRAME::handleIconizeEvent(), m_spaceMouse, and NL_PCBNEW_PLUGIN::SetFocus().
◆ HandleSystemColorChange()
|
virtualinherited |
Update the UI in response to a change in the system colors.
Definition at line 1411 of file eda_base_frame.cpp.
References GetBitmapStore(), EDA_BASE_FRAME::ReCreateMenuBar(), BITMAP_STORE::ThemeChanged(), and EDA_BASE_FRAME::ThemeChanged().
Referenced by EDA_BASE_FRAME::onSystemColorChange().
◆ HandleUpdateUIEvent()
|
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
-
aEvent is the wxUpdateUIEvent to be processed. aFrame is the frame to get the selection from aCond are the #UI SELECTION_CONDITIONS used
Definition at line 367 of file eda_base_frame.cpp.
References ACTION_CONDITIONS::checkCondition, ACTIONS::copy, ACTIONS::cut, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), TOOL_ACTION::GetUIId(), ACTIONS::paste, and ACTION_CONDITIONS::showCondition.
Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().
◆ HardRedraw()
|
virtualinherited |
Rebuild the GAL and redraws the screen.
Call when something went wrong.
Reimplemented in SCH_BASE_FRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.
Definition at line 912 of file eda_draw_frame.cpp.
Referenced by COMMON_TOOLS::ZoomRedraw().
◆ HasKiway()
|
inlineinherited |
Safety check before asking for the Kiway reference.
- Returns
- true if kiway is non-null
Definition at line 63 of file kiway_holder.h.
References KIWAY_HOLDER::m_kiway.
Referenced by DIALOG_SHIM::~DIALOG_SHIM().
◆ help_name()
|
virtualinherited |
Reimplemented in KICAD_MANAGER_FRAME.
Definition at line 822 of file eda_base_frame.cpp.
References KIFACE_BASE::GetHelpFileName(), and Kiface().
Referenced by COMMON_CONTROL::ShowHelp().
◆ HideSolderMask()
| void PCB_BASE_FRAME::HideSolderMask | ( | ) |
Definition at line 546 of file pcb_base_frame.cpp.
References GetBoard(), GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::HasItem(), and KIGFX::PCB_VIEW::Remove().
Referenced by EDIT_TOOL::doMoveSelection(), and BOARD_COMMIT::Push().
◆ ImportHotkeyConfigFromFile()
|
inherited |
Prompt the user for a hotkey file to read, and read it.
- Parameters
-
aActionMap current hotkey map (over which the imported hotkeys will be applied). aDefaultShortname a default short name (extension not needed) like Eeschema, KiCad...
◆ 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 1288 of file eda_base_frame.cpp.
◆ isAutoSaveRequired()
|
inlineprotectedvirtualinherited |
Return the auto save status of the application.
Override this function if your derived frame supports automatic file saving.
Definition at line 628 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_autoSaveRequired.
Referenced by EDA_BASE_FRAME::ProcessEvent().
◆ IsContentModified()
|
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 CVPCB_MAINFRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.
Definition at line 1281 of file eda_base_frame.cpp.
Referenced by GERBVIEW_FRAME::Clear_DrawLayers(), and EDITOR_CONDITIONS::contentModifiedFunc().
◆ IsCurrentTool()
|
inherited |
Definition at line 119 of file tools_holder.cpp.
References TOOL_ACTION::GetName(), TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.
Referenced by SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().
◆ 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 176 of file kiway_player.cpp.
References KIWAY_PLAYER::m_modal_loop.
Referenced by SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), and FOOTPRINT_WIZARD_FRAME::doCloseWindow().
◆ IsGridVisible()
|
inherited |
Definition at line 486 of file eda_draw_frame.cpp.
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()
|
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 159 of file kiway_player.h.
References KIWAY_PLAYER::m_modal.
Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), KIWAY_PLAYER::ShowModal(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().
◆ IsScriptingConsoleVisible()
|
inherited |
Gets the current visibility of the scripting console window.
Definition at line 260 of file eda_draw_frame.cpp.
References FRAME_PYTHON, KIWAY_HOLDER::Kiway(), and KIWAY::Player().
Referenced by EDITOR_CONDITIONS::consoleVisibleFunc().
◆ IsType()
|
inlineinherited |
Definition at line 200 of file eda_base_frame.h.
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(), PCB_POINT_EDITOR::changeArcEditMode(), CONVERT_TOOL::CreatePolys(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), SYMBOL_EDITOR_CONTROL::DdAddLibrary(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), 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(), PCB_EDITOR_CONDITIONS::get45degModeFunc(), SCH_BASE_FRAME::GetColorSettings(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), DIALOG_FIELD_PROPERTIES::init(), SYMBOL_EDITOR_CONTROL::Init(), CONVERT_TOOL::Init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), loadFootprint(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), PCB_SELECTION_TOOL::Reset(), 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(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), and DRAWING_TOOL::UpdateStatusBar().
◆ IsWritable()
|
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
aFileName The full path and/or file name of the file to test. aVerbose If true will show an error dialog if the file is not writable
- Returns
- False if aFileName cannot be written.
Definition at line 1188 of file eda_base_frame.cpp.
References _, and DisplayErrorMessage().
Referenced by SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProjectSettings(), and SCH_EDIT_FRAME::saveSchematicFile().
◆ Kiway()
|
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.
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(), SCH_EDIT_FRAME::AskToSaveChanges(), IMPORT_PROJ_HELPER::AssociateFileWithProj(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), SCH_EDIT_FRAME::canCloseWindow(), PCB_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), SYMBOL_EDIT_FRAME::DdAddLibrary(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::FetchNetlistFromSchematic(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PGM_SINGLE_TOP::MacOpenFile(), SIM_PLOT_FRAME::menuExit(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), KIGFX::WX_VIEW_CONTROLS::onMotion(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), SIM_PLOT_FRAME::onProbe(), PCB_EDIT_FRAME::OnQuit(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), SIM_PLOT_FRAME::onTune(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SCH_EDITOR_CONTROL::rescueProject(), PCB_EDIT_FRAME::RunEeschema(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), SYMBOL_EDIT_FRAME::saveCurrentSymbol(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), SelectFootprintFromLibBrowser(), SelectLibrary(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), PCB_EDIT_FRAME::SendCrossProbeItem(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), PCB_EDIT_FRAME::SendSelectItemsToSch(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), EDA_BASE_FRAME::ShowPreferences(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDIT_FRAME::TestStandalone(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().
◆ kiway_express()
|
protectedinherited |
event handler, routes to derivative specific virtual KiwayMailIn()
Definition at line 197 of file kiway_player.cpp.
References KIWAY_PLAYER::KiwayMailIn().
◆ KiwayMailIn()
|
virtualinherited |
Receive KIWAY_EXPRESS messages from other players.
Override it in derived classes.
Reimplemented in CVPCB_MAINFRAME, SCH_EDIT_FRAME, PCB_EDIT_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.
Definition at line 87 of file kiway_player.cpp.
Referenced by KIWAY_PLAYER::kiway_express(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), and KIWAY::ProcessEvent().
◆ language_change()
|
protectedinherited |
An event handler called on a language menu selection.
Definition at line 204 of file kiway_player.cpp.
References KIWAY_HOLDER::Kiway(), and KIWAY::SetLanguage().
◆ LibraryFileBrowser()
|
inherited |
- Parameters
-
doOpen if true runs an Open Library browser, otherwise New Library aFilename for New may contain a default name; in both cases return the chosen filename. wildcard a wildcard to filter the displayed files ext the library file extension isDirectory indicates the library files are directories
- Returns
- true for OK; false for Cancel.
Definition at line 1050 of file eda_draw_frame.cpp.
References _, EDA_BASE_FRAME::GetMruPath(), PROJECT::GetProjectPath(), PROJECT::IsNullProject(), KIWAY_HOLDER::Prj(), and EDA_BASE_FRAME::SetMruPath().
Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), PCB_BASE_EDIT_FRAME::createNewLibrary(), and SCH_EDITOR_CONTROL::ExportSymbolsToLibrary().
◆ loadCanvasTypeSetting()
|
protectedinherited |
Returns the canvas type stored in the application settings.
Definition at line 806 of file eda_draw_frame.cpp.
References APP_SETTINGS_BASE::GRAPHICS::canvas_type, 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(), and EDA_DRAW_FRAME::resolveCanvasType().
◆ LoadFootprint()
Attempt to load aFootprintId from the footprint library table.
- Parameters
-
aFootprintId is 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 316 of file load_select_footprint.cpp.
References loadFootprint().
Referenced by BOARD_NETLIST_UPDATER::addNewFootprint(), FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), FOOTPRINT_EDITOR_CONTROL::ExportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), DIALOG_EXCHANGE_FOOTPRINTS::processFootprint(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), BOARD_NETLIST_UPDATER::replaceFootprint(), and FOOTPRINT_EDITOR_CONTROL::SaveAs().
◆ loadFootprint()
Attempts to load aFootprintId from the footprint library table.
- Parameters
-
aFootprintId is 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_ERROR if an I/O error occurs or a PARSE_ERROR if a file parsing error occurs while reading footprint library files.
Definition at line 332 of file load_select_footprint.cpp.
References FOOTPRINT::ClearAllNets(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), FRAME_FOOTPRINT_EDITOR, EDA_BASE_FRAME::IsType(), PROJECT::PcbFootprintLibs(), and KIWAY_HOLDER::Prj().
Referenced by FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), LoadFootprint(), PCB_EDIT_FRAME::LoadFootprints(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), and SelectFootprintFromLibTree().
◆ LoadSettings()
|
overridevirtual |
Load common frame parameters from a configuration file.
Don't forget to call the base method or your frames won't remember their positions and sizes.
Reimplemented from EDA_DRAW_FRAME.
Reimplemented in FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, and PCB_EDIT_FRAME.
Definition at line 898 of file pcb_base_frame.cpp.
References APP_SETTINGS_BASE::DefaultGridSizeList(), GetCanvas(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), PCB_DRAW_PANEL_GAL::GetView(), WINDOW_SETTINGS::grid, APP_SETTINGS_BASE::GRAPHICS::highlight_factor, EDA_DRAW_FRAME::LoadSettings(), APP_SETTINGS_BASE::m_Graphics, EDA_DRAW_FRAME::m_polarCoords, APP_SETTINGS_BASE::m_Window, APP_SETTINGS_BASE::GRAPHICS::select_factor, KIGFX::RENDER_SETTINGS::SetDefaultFont(), KIGFX::RENDER_SETTINGS::SetHighlightFactor(), KIGFX::RENDER_SETTINGS::SetSelectFactor(), GRID_SETTINGS::sizes, WINDOW_SETTINGS::zoom_factors, and ZOOM_LIST_PCBNEW.
Referenced by DISPLAY_FOOTPRINTS_FRAME::LoadSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), FOOTPRINT_WIZARD_FRAME::LoadSettings(), and PCB_EDIT_FRAME::LoadSettings().
◆ LoadWindowSettings()
|
inherited |
Load window settings from the given settings object.
Normally called by LoadSettings() unless the window in question is a child window that* stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.
Definition at line 711 of file eda_base_frame.cpp.
References TOOLS_HOLDER::CommonSettingsChanged(), EDA_BASE_FRAME::LoadWindowState(), EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_perspective, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, and WINDOW_SETTINGS::state.
Referenced by EDA_BASE_FRAME::LoadSettings().
◆ LoadWindowState() [1/2]
|
virtualinherited |
Load frame state info from a configuration file.
Definition at line 565 of file eda_base_frame.cpp.
References PCAD2KICAD::Center, defaultSize(), WINDOW_STATE::display, EDA_BASE_FRAME::m_displayIndex, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_ident, EDA_BASE_FRAME::m_maximizeByDefault, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, minSize(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.
◆ LoadWindowState() [2/2]
|
inherited |
Definition at line 551 of file eda_base_frame.cpp.