KiCad PCB EDA Suite
Loading...
Searching...
No Matches
GERBVIEW_FRAME Class Reference

#include <gerbview_frame.h>

Inheritance diagram for GERBVIEW_FRAME:
EDA_DRAW_FRAME KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER UNITS_PROVIDER

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

 GERBVIEW_FRAME (KIWAY *aKiway, wxWindow *aParent)
 
 ~GERBVIEW_FRAME ()
 
void doCloseWindow () override
 
bool OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl) override
 Open a project or set of files given by aFileList. More...
 
bool LoadListOfGerberAndDrillFiles (const wxString &aPath, const wxArrayString &aFilenameList, std::vector< int > *aFileType)
 Load a list of Gerber and NC drill files and updates the view based on them. More...
 
void ReCreateHToolbar () override
 
void ReCreateAuxiliaryToolbar () override
 
void ReCreateVToolbar () override
 Create or update the right vertical toolbar. More...
 
void ReCreateOptToolbar () override
 Create or update the left vertical toolbar (option toolbar) More...
 
void UpdateStatusBar () override
 Update the status bar information. More...
 
void UpdateToolbarControlSizes () override
 Update the sizes of any controls in the toolbars of the frame. More...
 
GERBVIEW_SETTINGSgvconfig () const
 
void ApplyDisplaySettingsToGAL ()
 Updates the GAL with display settings changes. More...
 
int GetDisplayMode ()
 
void SetDisplayMode (int aMode)
 
bool IsElementVisible (int aLayerID) const
 Test whether a given element category is visible. More...
 
void SetElementVisibility (int aLayerID, bool aNewState)
 Change the visibility of an element category. More...
 
void SetGridVisibility (bool aVisible) override
 
LSET GetVisibleLayers () const
 A proxy function that calls the correspondent function in m_BoardSettings. More...
 
void SetVisibleLayers (LSET aLayerMask)
 A proxy function that calls the correspondent function in m_BoardSettings. More...
 
bool IsLayerVisible (int aLayer) const
 Test whether a given layer is visible. More...
 
COLOR4D GetVisibleElementColor (int aLayerID)
 Return the color of a gerber visible element. More...
 
void SetVisibleElementColor (int aLayerID, const COLOR4D &aColor)
 
COLOR4D GetLayerColor (int aLayer) const
 
void SetLayerColor (int aLayer, const COLOR4D &aColor)
 
void ReFillLayerWidget ()
 Change out all the layers in m_Layers; called upon loading new gerber files. More...
 
void SetActiveLayer (int aLayer, bool doLayerWidgetUpdate=true)
 change the currently active layer to aLayer and update the GERBER_LAYER_WIDGET. More...
 
int GetActiveLayer () const
 Return the active layer. More...
 
int getNextAvailableLayer () const
 Find the next empty layer. More...
 
void syncLayerWidget ()
 Update the currently "selected" layer within the GERBER_LAYER_WIDGET. More...
 
void syncLayerBox (bool aRebuildLayerBox=false)
 Update the currently "selected" layer within m_SelLayerBox. More...
 
void UpdateTitleAndInfo ()
 Display the short filename (if exists) of the selected layer on the caption of the main GerbView window and some other parameters. More...
 
void DisplayGridMsg () override
 Display the current grid pane on the status bar. More...
 
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...
 
COLOR_SETTINGSGetColorSettings (bool aForceRefresh=false) const override
 Returns a pointer to the active color theme settings. More...
 
void ToggleLayerManager ()
 
void ShowChangedLanguage () override
 
void OnSelectHighlightChoice (wxCommandEvent &event)
 Handles the changing of the highlighted component/net/attribute. More...
 
void OnSelectActiveDCode (wxCommandEvent &event)
 Select the active DCode for the current active layer. More...
 
void OnSelectActiveLayer (wxCommandEvent &event)
 Select the active layer: More...
 
void OnSelectDisplayMode (wxCommandEvent &event)
 Called on a display mode selection. More...
 
void OnQuit (wxCommandEvent &event)
 Called on request of application quit. More...
 
void OnUpdateDrawMode (wxUpdateUIEvent &aEvent)
 
void OnUpdateSelectDCode (wxUpdateUIEvent &aEvent)
 
void OnUpdateLayerSelectBox (wxUpdateUIEvent &aEvent)
 
void OnGbrFileHistory (wxCommandEvent &event)
 Delete the current data and loads a Gerber file selected from history list on current layer. More...
 
void OnDrlFileHistory (wxCommandEvent &event)
 Delete the current data and load a drill file in Excellon format selected from history list on current layer. More...
 
void OnZipFileHistory (wxCommandEvent &event)
 Delete the current data and load a zip archive file selected from the history list. More...
 
void OnJobFileHistory (wxCommandEvent &event)
 Delete the current data and load a gerber job file selected from the history list. More...
 
bool unarchiveFiles (const wxString &aFullFileName, REPORTER *aReporter=nullptr)
 Extract gerber and drill files from the zip archive, and load them. More...
 
bool LoadAutodetectedFiles (const wxString &aFileName)
 Load a given file or selected file(s), if the filename is empty. More...
 
bool LoadGerberFiles (const wxString &aFileName)
 Load a given Gerber file or selected file(s), if the filename is empty. More...
 
bool Read_GERBER_File (const wxString &GERBER_FullFileName)
 
bool LoadExcellonFiles (const wxString &aFileName)
 Load a drill (EXCELLON) file or many files. More...
 
bool Read_EXCELLON_File (const wxString &aFullFileName)
 
bool LoadZipArchiveFile (const wxString &aFileName)
 Load a zipped archive file. More...
 
bool LoadGerberJobFile (const wxString &aFileName)
 Load a Gerber job file, and load gerber files found in job files. More...
 
bool Clear_DrawLayers (bool query)
 
void Erase_Current_DrawLayer (bool query)
 
void SortLayersByFileExtension ()
 
void SortLayersByX2Attributes ()
 
void SetLayerDrawPrms ()
 
void RemapLayers (const std::unordered_map< int, int > &remapping)
 Takes a layer remapping and reorders the layers. More...
 
void UpdateXORLayers ()
 Update each layers' differential option. More...
 
void SaveCopyInUndoList (GERBER_DRAW_ITEM *aItemToCopy, UNDO_REDO aTypeCommand=UNDO_REDO::UNSPECIFIED)
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand)
 Create a new entry in undo list of commands and add a list of pickers to handle a list of items. More...
 
void ActivateGalCanvas () override
 Use to start up the GAL drawing canvas. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
 Called after the preferences dialog is run. More...
 
SELECTIONGetCurrentSelection () override
 Get the current selection from the canvas area. More...
 
void SetLayout (GBR_LAYOUT *aLayout)
 Set the m_gerberLayout member in such as way as to ensure deleting any previous GBR_LAYOUT. More...
 
GBR_LAYOUTGetGerberLayout () const
 
GERBER_FILE_IMAGE_LISTGetImagesList () const
 Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data. More...
 
GERBER_FILE_IMAGEGetGbrImage (int aIdx) const
 
unsigned ImagesMaxCount () const
 The max number of file images. More...
 
void SetPageSettings (const PAGE_INFO &aPageSettings) override
 
const PAGE_INFOGetPageSettings () const override
 
const VECTOR2I 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 VECTOR2IGetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const VECTOR2I &aPoint) override
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
int SelectPCBLayer (int aDefaultLayer, int aCopperLayerCount, const wxString &aGerberName)
 Show the dialog box for layer selection. More...
 
COLOR4D GetGridColor () override
 
virtual void SetGridColor (const COLOR4D &aColor) override
 
const BOX2I GetDocumentExtents (bool aIncludeAllVisible=true) const override
 Returns bbox of document with option to not include some items. 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_DATAGetFindReplaceData ()
 
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) override
 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
 
virtual void SetDrawBgColor (const COLOR4D &aColor)
 
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
 
virtual wxString GetFullScreenDesc () const
 
virtual BASE_SCREENGetScreen () const
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
void EraseMsgBox ()
 
bool IsGridVisible () const
 
bool IsGridOverridden () const
 
virtual void SetGridOverrides (bool aOverride)
 
void OnSelectGrid (wxCommandEvent &event)
 Command event handler for selecting grid sizes. More...
 
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...
 
PROPERTIES_PANELGetPropertiesPanel ()
 
void UpdateProperties ()
 
virtual void ToggleProperties ()
 
virtual EDA_ITEMGetItem (const KIID &aId) const
 Fetch an item by KIID. 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...
 
virtual EDA_DRAW_PANEL_GALGetCanvas () const
 Return a pointer to GAL-based canvas of given EDA draw frame. More...
 
void SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)
 
wxWindow * GetToolCanvas () const override
 Canvas access. More...
 
GAL_DISPLAY_OPTIONS_IMPLGetGalDisplayOptions ()
 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...
 
void OnToolbarSizeChanged ()
 Update toolbars if desired toolbar icon changed. More...
 
HOTKEY_CYCLE_POPUPGetHotkeyPopup ()
 
virtual void CreateHotkeyPopup ()
 
bool SaveCanvasImageToFile (const wxString &aFileName, BITMAP_TYPE aBitmapType)
 Save the current view as an image file. 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)
 
ORIGIN_TRANSFORMSGetOriginTransforms () override
 Return a reference to the default ORIGIN_TRANSFORMS object. More...
 
SETTINGS_MANAGERGetSettingsManager () const
 
virtual SEVERITY GetSeverity (int aErrorCode) 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_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program. More...
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 
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_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...
 
void ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...
 
virtual APP_SETTINGS_BASEconfig () const
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
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_SETTINGSGetWindowSettings (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 SaveProjectLocalSettings ()
 Save changes to the project local settings. More...
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
 Fetches the file name from the file history list. More...
 
void ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
 Removes all files from the file history. More...
 
void UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
 Update the list of recently opened files. More...
 
FILE_HISTORYGetFileHistory ()
 Get the frame's main file history. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
virtual wxString GetCurrentFileName () const
 Get the full filename + path of the currently opened file in the frame. More...
 
void ReCreateMenuBar ()
 Recreates the menu bar. More...
 
void SetMenuBar (wxMenuBar *menu_bar) override
 
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 DeleteAutoSaveFile (const wxFileName &aFileName)
 
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_LISTPopCommandFromUndoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual int GetUndoCommandCount () const
 
virtual int GetRedoCommandCount () const
 
virtual wxString GetUndoActionDescription () const
 
virtual wxString GetRedoActionDescription () const
 
int GetMaxUndoItems () const
 
virtual void OnModify ()
 Must be called after a model change in order to set the "modify" flag and do other frame-specific processing. More...
 
bool NonUserClose (bool aForce)
 
virtual void HandleSystemColorChange ()
 Update the UI in response to a change in the system colors. More...
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual 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
 
KIWAYKiway () 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...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 
EDA_UNITS GetUserUnits () const
 
void SetUserUnits (EDA_UNITS aUnits)
 
const EDA_IU_SCALEGetIuScale () const
 
wxString StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
 Converts aValue in internal units into a united string. More...
 
wxString StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false) const
 
wxString MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
 A lower-precision version of StringFromValue(). More...
 
wxString MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true) const
 
wxString MessageTextFromMinOptMax (const MINOPTMAX< int > &aValue) const
 
int ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
 Converts aTextValue in aUnits to internal units used by the frame. More...
 
EDA_ANGLE AngleValueFromString (const wxString &aTextValue) const
 

Static Public Member Functions

static const wxString PropertiesPaneName ()
 
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...
 

Public Attributes

wxChoice * m_SelComponentBox
 
wxChoice * m_SelNetnameBox
 
wxChoice * m_SelAperAttributesBox
 
GBR_LAYER_BOX_SELECTORm_SelLayerBox
 
DCODE_SELECTION_BOXm_DCodeSelector
 
wxTextCtrl * m_TextInfo
 
GERBER_LAYER_WIDGETm_LayersManager
 

Protected Member Functions

void setupUIConditions () override
 Setup the UI conditions for the various actions and their controls in this frame. More...
 
void doReCreateMenuBar () override
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void setupUnits (APP_SETTINGS_BASE *aCfg)
 
std::vector< wxWindow * > findDialogs ()
 
virtual void resolveCanvasType ()
 Determines the Canvas type to load (with prompt if required) and initializes m_canvasType. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting (APP_SETTINGS_BASE *aCfg=nullptr)
 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...
 
virtual void handleActivateEvent (wxActivateEvent &aEvent)
 Handle a window activation event. More...
 
void onActivate (wxActivateEvent &aEvent)
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 An event handler called on a language menu selection. More...
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event. More...
 
virtual void handleIconizeEvent (wxIconizeEvent &aEvent)
 Handle a window iconize 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 bool canCloseWindow (wxCloseEvent &aCloseEvent)
 
void onSystemColorChange (wxSysColourChangedEvent &aEvent)
 
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 saveProjectSettings ()
 Saves any design-related project settings associated with this frame. More...
 
virtual void OnDropFiles (wxDropFilesEvent &aEvent)
 Handles event fired when a file is dropped to the window. More...
 
void AddMenuLanguageList (ACTION_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
 Function AddMenuLanguageList creates a menu list for language choice, and add it as submenu to MasterMenu. More...
 

Static Protected Member Functions

static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

FILE_HISTORY m_zipFileHistory
 
FILE_HISTORY m_drillFileHistory
 
FILE_HISTORY m_jobFileHistory
 
wxString m_lastFileName
 
wxSocketServer * m_socketServer
 Prevents opening same file multiple times. More...
 
std::unique_ptr< LOCKFILEm_file_checker
 
COLOR4D m_gridColor
 
COLOR4D m_drawBgColor
 
int m_undoRedoCountMax
 
bool m_polarCoords
 
bool m_showBorderAndTitleBlock
 
wxChoice * m_gridSelectBox
 
wxChoice * m_zoomSelectBox
 
ACTION_TOOLBARm_mainToolBar
 
ACTION_TOOLBARm_auxiliaryToolBar
 
ACTION_TOOLBARm_drawToolBar
 
ACTION_TOOLBARm_optionsToolBar
 
std::unique_ptr< EDA_SEARCH_DATAm_findReplaceData
 
wxArrayString m_findStringHistoryList
 
wxArrayString m_replaceStringHistoryList
 
EDA_MSG_PANELm_messagePanel
 
int m_msgFrameHeight
 
COLOR_SETTINGSm_colorSettings
 
SEARCH_PANEm_searchPane
 
PROPERTIES_PANELm_propertiesPanel
 
HOTKEY_CYCLE_POPUPm_hotkeyPopup
 The current canvas type. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
 
bool m_modal
 
WX_EVENT_LOOPm_modal_loop
 < Points to nested event_loop. NULL means not modal and dismissed. More...
 
wxWindow * m_modal_resultant_parent
 
wxString m_modal_string
 
bool m_modal_ret_val
 
std::vector< wxSocketBase * > m_sockets
 interprocess communication More...
 
std::vector< wxFileName > m_AcceptedFiles
 
FRAME_T m_ident
 
wxPoint m_framePos
 
wxSize m_frameSize
 
bool m_maximizeByDefault
 
int m_displayIndex
 
wxPoint m_normalFramePos
 
wxSize m_normalFrameSize
 
wxString m_aboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
APPEARANCE_CONTROLS_3Dm_appearancePanel
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_supportsAutoSave
 
bool m_autoSavePending
 
bool m_autoSaveRequired
 
wxTimer * m_autoSaveTimer
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
ORIGIN_TRANSFORMS m_originTransforms
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 < Map containing the UI update handlers registered with wx for each action. More...
 
bool m_isClosing
 Set by NonUserClose() to indicate that the user did not request the current close. More...
 
bool m_isNonUserClose
 
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
 Associates files extensions with action to execute. More...
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
MOUSE_DRAG_ACTION m_dragAction
 
bool m_moveWarpsCursor
 

Static Protected Attributes

static 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 updateComponentListSelectBox ()
 
void updateNetnameListSelectBox ()
 
void updateAperAttributesSelectBox ()
 
void updateDCodeSelectBox ()
 
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 OnClearJobFileHistory (wxCommandEvent &aEvent)
 
void OnClearZipFileHistory (wxCommandEvent &aEvent)
 
void OnClearDrlFileHistory (wxCommandEvent &aEvent)
 
void OnClearGbrFileHistory (wxCommandEvent &aEvent)
 
void DoWithAcceptedFiles () override
 Execute action on accepted dropped file. More...
 
bool LoadFileOrShowDialog (const wxString &aFileName, const wxString &dialogFiletypes, const wxString &dialogTitle, const int filetype)
 Loads the file provided or shows a dialog to get the file(s) from the user. More...
 
void setupTools ()
 
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

int m_displayMode
 
bool m_show_layer_manager_tools
 
GBR_LAYOUTm_gerberLayout
 
int m_activeLayer
 
VECTOR2I m_grid_origin
 
PAGE_INFO m_paper
 
wxStaticText * m_cmpText
 
wxStaticText * m_netText
 
wxStaticText * m_apertText
 
wxStaticText * m_dcodeText
 
BASE_SCREENm_currentScreen
 current used SCREEN More...
 
EDA_DRAW_PANEL_GALm_canvas
 This the frame's interface to setting GAL display options. More...
 
GAL_DISPLAY_OPTIONS_IMPL m_galDisplayOptions
 
int m_lastToolbarIconSize
 
KIWAYm_kiway
 
HOLDER_TYPE m_type
 
const EDA_IU_SCALEm_iuScale
 
EDA_UNITS m_userUnits
 

Detailed Description

Definition at line 53 of file gerbview_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 39 of file kiway_holder.h.

◆ UNDO_REDO_LIST

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

Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 114 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ GERBVIEW_FRAME()

GERBVIEW_FRAME::GERBVIEW_FRAME ( KIWAY aKiway,
wxWindow *  aParent 
)

Definition at line 61 of file gerbview_frame.cpp.

References _, _HKI, LSET::AllLayersMask(), ArchiveFileExtension, EDA_BASE_FRAME::config(), DrillFileExtension, dummy, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, GerberFileExtension, gerbIUScale, LAYER_WIDGET::GetBestSize(), EDA_DRAW_FRAME::GetCanvas(), GERBER_FILE_IMAGE_LIST::GetDisplayName(), EDA_DRAW_FRAME::GetGalDisplayOptions(), GetImagesList(), GetPageSettings(), TOOLS_HOLDER::GetToolManager(), ImagesMaxCount(), EDA_IU_SCALE::IU_PER_MILS, KiBitmap(), GERBVIEW_ACTIONS::loadGerbFiles, LoadSettings(), GERBVIEW_ACTIONS::loadZipFile, EDA_BASE_FRAME::m_aboutTitle, EDA_BASE_FRAME::m_acceptedExts, m_apertText, EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_auxiliaryToolBar, EDA_DRAW_FRAME::m_canvasType, m_cmpText, m_DCodeSelector, m_dcodeText, m_displayMode, m_drillFileHistory, EDA_BASE_FRAME::m_frameSize, m_gerberLayout, m_jobFileHistory, m_LayersManager, EDA_DRAW_FRAME::m_mainToolBar, EDA_BASE_FRAME::m_maximizeByDefault, EDA_DRAW_FRAME::m_messagePanel, m_netText, EDA_DRAW_FRAME::m_optionsToolBar, m_SelAperAttributesBox, m_SelComponentBox, m_SelLayerBox, m_SelNetnameBox, m_show_layer_manager_tools, EDA_DRAW_FRAME::m_showBorderAndTitleBlock, m_zipFileHistory, Pgm(), TOOL_MANAGER::PostAction(), ReCreateAuxiliaryToolbar(), ReCreateHToolbar(), EDA_BASE_FRAME::ReCreateMenuBar(), ReCreateOptToolbar(), GERBER_LAYER_WIDGET::ReFill(), ReFillLayerWidget(), GERBER_LAYER_WIDGET::ReFillRender(), EDA_DRAW_FRAME::resolveCanvasType(), TOOL_MANAGER::RunAction(), SetActiveLayer(), EDA_DRAW_FRAME::SetCanvas(), SetLayout(), FILE_HISTORY::SetMaxFiles(), SetPageSettings(), EDA_DRAW_FRAME::SetScreen(), LAYER_WIDGET::SetSmallestLayerString(), setupTools(), setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), SetVisibleLayers(), EDA_DRAW_FRAME::SwitchCanvas(), UpdateToolbarControlSizes(), and ACTIONS::zoomFitScreen.

◆ ~GERBVIEW_FRAME()

Member Function Documentation

◆ ActivateGalCanvas()

◆ AddMenuLanguageList()

◆ AddStandardHelpMenu()

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

◆ AngleValueFromString()

EDA_ANGLE UNITS_PROVIDER::AngleValueFromString ( const wxString &  aTextValue) const
inlineinherited

◆ AppendMsgPanel()

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

Append a message to the message panel.

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

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

Definition at line 780 of file eda_draw_frame.cpp.

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

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

◆ ApplyDisplaySettingsToGAL()

◆ canCloseWindow()

virtual bool EDA_BASE_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
inlineprotectedvirtualinherited

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName &  aFileName)
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
aFileNameA wxFileName object containing the file name to check.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1316 of file eda_base_frame.cpp.

References _, EDA_BASE_FRAME::DeleteAutoSaveFile(), KIPLATFORM::IO::DuplicatePermissions(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), Pgm(), and traceAutoSave.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ Clear_DrawLayers()

◆ ClearFileHistory()

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

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

virtual void EDA_BASE_FRAME::ClearUndoORRedoList ( UNDO_REDO_LIST  aList,
int  aItemCount = -1 
)
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.
aItemCountnumber 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 545 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::ClearUndoRedoList(), EDA_BASE_FRAME::PushCommandToRedoList(), and EDA_BASE_FRAME::PushCommandToUndoList().

◆ ClearUndoRedoList()

◆ commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T  aFrameType)
privateinherited

◆ CommonSettingsChanged()

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const
virtualinherited

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

Reimplemented in SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 856 of file eda_base_frame.cpp.

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

Referenced by ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), EDA_DRAW_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), SIMULATOR_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), GERBVIEW_FRAME(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), COMMON_TOOLS::GridFastCycle(), gvconfig(), EDA_DRAW_FRAME::IsGridOverridden(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), PCB_CALCULATOR_FRAME::loadPages(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), Read_EXCELLON_File(), EDA_BASE_FRAME::SaveSettings(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetDisplayOptions(), EDA_DRAW_FRAME::SetGridOverrides(), EDA_DRAW_FRAME::SetGridVisibility(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIMULATOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), setupTools(), PL_EDITOR_FRAME::setupTools(), BITMAP2CMP_FRAME::ShowChangedLanguage(), PCB_CALCULATOR_FRAME::ShowChangedLanguage(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), GRID_MENU::update(), ZOOM_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), and BITMAP2CMP_FRAME::~BITMAP2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited

Get the configuration base name.

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

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

Reimplemented from TOOLS_HOLDER.

Definition at line 350 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_configName.

◆ CreateHotkeyPopup()

void EDA_DRAW_FRAME::CreateHotkeyPopup ( )
virtualinherited

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

◆ CreateServer()

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

◆ CurrentToolName()

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

◆ DeleteAutoSaveFile()

void EDA_BASE_FRAME::DeleteAutoSaveFile ( const wxFileName &  aFileName)
virtualinherited

◆ Destroy()

◆ DismissModal()

◆ DisplayConstraintsMsg()

void EDA_DRAW_FRAME::DisplayConstraintsMsg ( const wxString &  msg)
inherited

◆ DisplayGridMsg()

void GERBVIEW_FRAME::DisplayGridMsg ( )
overridevirtual

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 924 of file gerbview_frame.cpp.

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

Referenced by UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 634 of file eda_draw_frame.cpp.

Referenced by PCB_CONTROL::Paste().

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane in the status bar.

Definition at line 660 of file eda_draw_frame.cpp.

References _, and UNITS_PROVIDER::GetUserUnits().

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

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

Returns
true if the auto save was successful otherwise false.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 340 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

◆ doReCreateMenuBar()

void GERBVIEW_FRAME::doReCreateMenuBar ( )
overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 40 of file gerbview/menubar.cpp.

References _, ACTION_MENU::Add(), FILE_HISTORY::AddFilesToMenu(), EDA_BASE_FRAME::AddMenuLanguageList(), ACTION_MENU::AddQuitOrClose(), EDA_BASE_FRAME::AddStandardHelpMenu(), ACTION_MENU::CHECK, GERBVIEW_ACTIONS::clearAllLayers, GERBVIEW_ACTIONS::clearLayer, ACTION_MENU::Clone(), GERBVIEW_ACTIONS::dcodeDisplay, GERBVIEW_ACTIONS::exportToPcbnew, FileHistoryCond, GERBVIEW_ACTIONS::flashedDisplayOutlines, GERBVIEW_ACTIONS::flipGerberView, EDA_BASE_FRAME::GetFileHistory(), TOOL_MANAGER::GetTool(), ACTIONS::highContrastMode, ACTIONS::inchesUnits, Kiface(), GERBVIEW_ACTIONS::linesDisplayOutlines, m_drillFileHistory, m_jobFileHistory, TOOLS_HOLDER::m_toolManager, m_zipFileHistory, ACTIONS::measureTool, ACTIONS::millimetersUnits, ACTIONS::milsUnits, GERBVIEW_ACTIONS::negativeObjectDisplay, GERBVIEW_ACTIONS::openAutodetected, GERBVIEW_ACTIONS::openDrillFile, GERBVIEW_ACTIONS::openGerber, GERBVIEW_ACTIONS::openJobFile, ACTIONS::openPreferences, GERBVIEW_ACTIONS::openZipFile, GERBVIEW_ACTIONS::polygonsDisplayOutlines, ACTIONS::print, EDA_BASE_FRAME::RegisterUIUpdateHandler(), GERBVIEW_ACTIONS::reloadAllLayers, FILE_HISTORY::SetClearText(), ACTION_MENU::SetIcon(), EDA_BASE_FRAME::SetMenuBar(), ACTION_MENU::SetTitle(), GERBVIEW_ACTIONS::showDCodes, GERBVIEW_ACTIONS::showSource, GERBVIEW_ACTIONS::toggleDiffMode, ACTIONS::toggleGrid, GERBVIEW_ACTIONS::toggleLayerManager, ACTIONS::togglePolarCoords, GERBVIEW_ACTIONS::toggleXORMode, FILE_HISTORY::UpdateClearText(), ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, ACTIONS::zoomRedraw, and ACTIONS::zoomTool.

◆ DoWithAcceptedFiles()

void GERBVIEW_FRAME::DoWithAcceptedFiles ( )
overrideprivatevirtual

Execute action on accepted dropped file.

Called in OnDropFiles and should be populated with the action to execute in inherited classes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 680 of file gerbview/files.cpp.

References ArchiveFileExtension, GerberFileExtension, EDA_BASE_FRAME::m_acceptedExts, EDA_BASE_FRAME::m_AcceptedFiles, TOOLS_HOLDER::m_toolManager, and TOOL_MANAGER::RunAction().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )
protectedinherited

Definition at line 705 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ Erase_Current_DrawLayer()

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

◆ ExecuteRemoteCommand()

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

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

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 179 of file kiway_player.h.

Referenced by DIALOG_BOOK_REPORTER::OnErrorLinkClicked(), and KIWAY_PLAYER::OnSockRequest().

◆ findDialogs()

std::vector< wxWindow * > EDA_DRAW_FRAME::findDialogs ( )
protectedinherited

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )
privateinherited

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 893 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::m_auimgr.

Referenced by SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME().

◆ FocusOnLocation()

◆ GetAboutTitle()

const wxString & EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetActiveLayer()

◆ GetAutoSaveFilePrefix()

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inherited

◆ GetCanvas()

virtual EDA_DRAW_PANEL_GAL * EDA_DRAW_FRAME::GetCanvas ( ) const
inlinevirtualinherited

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

Returns
Pointer to GAL-based canvas.

Reimplemented in SCH_BASE_FRAME, PCB_BASE_FRAME, and PL_EDITOR_FRAME.

Definition at line 431 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_canvas.

Referenced by EDA_DRAW_FRAME::ActivateGalCanvas(), ActivateGalCanvas(), ApplyDisplaySettingsToGAL(), EDITOR_CONDITIONS::bboxesFunc(), GERBVIEW_CONTROL::canvas(), COMMON_TOOLS::CenterContents(), Clear_DrawLayers(), CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), DIALOG_PRINT_GERBVIEW::createPrintout(), GERBVIEW_CONTROL::DisplayControl(), DisplayGridMsg(), doCloseWindow(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomToPreset(), Erase_Current_DrawLayer(), EDA_DRAW_FRAME::FocusOnLocation(), GERBVIEW_FRAME(), SCH_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetCanvas(), PL_EDITOR_FRAME::GetCanvas(), EDA_DRAW_FRAME::GetNearestGridPosition(), EDA_DRAW_FRAME::GetNearestHalfGridPosition(), EDA_DRAW_FRAME::GetToolCanvas(), GetVisibleLayers(), COMMON_TOOLS::GridOrigin(), HOTKEY_CYCLE_POPUP::HOTKEY_CYCLE_POPUP(), LoadListOfGerberAndDrillFiles(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), STATUS_POPUP::onCharHook(), GERBER_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerSelect(), GERBER_LAYER_WIDGET::OnLayerVisible(), EDA_DRAW_FRAME::OnMove(), GERBER_LAYER_WIDGET::onPopupSelection(), GERBER_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderEnable(), OnSelectActiveDCode(), OnSelectActiveLayer(), OnSelectDisplayMode(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), Read_EXCELLON_File(), Read_GERBER_File(), GERBER_LAYER_WIDGET::ReFill(), EDA_DRAW_FRAME::RefreshCanvas(), RemapLayers(), EDA_DRAW_FRAME::SaveCanvasImageToFile(), ZOOM_TOOL::selectRegion(), SetActiveLayer(), SetElementVisibility(), SetGridColor(), EDA_DRAW_FRAME::SetGridVisibility(), SetLayerDrawPrms(), SetPageSettings(), setupTools(), SetVisibleLayers(), EDA_DRAW_FRAME::SwitchCanvas(), COMMON_TOOLS::ToggleBoundingBoxes(), HOTKEY_CYCLE_POPUP::TryBefore(), unarchiveFiles(), ZOOM_MENU::update(), UpdateStatusBar(), UpdateXORLayers(), and ~GERBVIEW_FRAME().

◆ GetColorSettings()

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const
inlinevirtualinherited

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

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

Returns
the filename and full path to the open file

Reimplemented in SCH_EDIT_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, and PCB_EDIT_FRAME.

Definition at line 433 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

SELECTION & GERBVIEW_FRAME::GetCurrentSelection ( )
overridevirtual

Get the current selection from the canvas area.

Returns
the current selection.

Reimplemented from TOOLS_HOLDER.

Definition at line 1184 of file gerbview_frame.cpp.

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

Referenced by GERBVIEW_INSPECTION_TOOL::MeasureTool().

◆ GetDisplayMode()

int GERBVIEW_FRAME::GetDisplayMode ( )
inline
Returns
0 for fast mode (not fully compatible with negative objects) 1 for exact mode, write mode 2 for exact mode, OR mode (transparency mode)

Definition at line 102 of file gerbview_frame.h.

References m_displayMode.

Referenced by OnUpdateDrawMode().

◆ GetDocumentExtents()

const BOX2I GERBVIEW_FRAME::GetDocumentExtents ( bool  aIncludeAllVisible = true) const
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
aIncludeAllVisibleTrue to include everything visible in bbox calculations, false to ignore some visible items (program dependent).
Returns
Bounding box of the document (ignoring some items as requested).

Reimplemented from EDA_DRAW_FRAME.

Definition at line 468 of file gerbview_frame.h.

References m_gerberLayout, and EDA_ITEM::ViewBBox().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

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

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

Definition at line 136 of file tools_holder.h.

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const
inlineinherited

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

Definition at line 142 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()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

◆ GetFileFromHistory()

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

Fetches the file name from the file history list.

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

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

Definition at line 976 of file eda_base_frame.cpp.

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

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

◆ GetFileHistory()

FILE_HISTORY & EDA_BASE_FRAME::GetFileHistory ( )
inlineinherited

◆ GetFindHistoryList()

wxArrayString & EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

◆ GetFindReplaceData()

◆ GetFrameType()

◆ GetFullScreenDesc()

wxString EDA_DRAW_FRAME::GetFullScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1082 of file eda_draw_frame.cpp.

Referenced by EDA_DRAW_FRAME::PrintDrawingSheet(), and PCB_EDIT_FRAME::SetPageSettings().

◆ GetGalDisplayOptions()

◆ GetGbrImage()

◆ GetGerberLayout()

◆ GetGridColor()

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 910 of file gerbview_frame.cpp.

References COLOR_SETTINGS::GetColor(), GetColorSettings(), and LAYER_GERBVIEW_GRID.

Referenced by GetVisibleElementColor().

◆ GetGridOrigin()

const VECTOR2I & GERBVIEW_FRAME::GetGridOrigin ( ) const
inlineoverridevirtual

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 435 of file gerbview_frame.h.

References m_grid_origin.

◆ GetHotkeyPopup()

HOTKEY_CYCLE_POPUP * EDA_DRAW_FRAME::GetHotkeyPopup ( )
inlineinherited

◆ GetImagesList()

◆ GetInfoBar()

◆ GetItem()

virtual EDA_ITEM * EDA_DRAW_FRAME::GetItem ( const KIID aId) const
inlinevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 407 of file eda_draw_frame.h.

Referenced by PCB_MARKER::GetMsgPanelInfo(), RC_TREE_MODEL::GetValue(), and EE_SELECTION_TOOL::Main().

◆ GetIuScale()

◆ GetLayerColor()

COLOR4D GERBVIEW_FRAME::GetLayerColor ( int  aLayer) const

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 585 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const
inlineinherited

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

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

Definition at line 148 of file tools_holder.h.

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

◆ GetNearestGridPosition()

VECTOR2I EDA_DRAW_FRAME::GetNearestGridPosition ( const VECTOR2I aPosition) const
inherited

Return the nearest aGridSize location to aPosition.

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

Definition at line 908 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()

VECTOR2I EDA_DRAW_FRAME::GetNearestHalfGridPosition ( const VECTOR2I aPosition) const
inherited

Return the nearest aGridSize / 2 location to aPosition.

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

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

Definition at line 922 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().

◆ getNextAvailableLayer()

int GERBVIEW_FRAME::getNextAvailableLayer ( ) const

Find the next empty layer.

If no empty layers are found, NO_AVAILABLE_LAYERS is return.

Returns
The first empty layer found or NO_AVAILABLE_LAYERS.

Definition at line 493 of file gerbview_frame.cpp.

References GetGbrImage(), ImagesMaxCount(), and NO_AVAILABLE_LAYERS.

Referenced by LoadListOfGerberAndDrillFiles(), and unarchiveFiles().

◆ GetOriginTransforms()

ORIGIN_TRANSFORMS & EDA_BASE_FRAME::GetOriginTransforms ( )
inlineoverridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from UNITS_PROVIDER.

Reimplemented in PCB_BASE_FRAME.

Definition at line 133 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_originTransforms.

Referenced by PGPROPERTY_DISTANCE::DistanceToString(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), and PCB_DIM_LEADER::GetMsgPanelInfo().

◆ GetPageSettings()

const PAGE_INFO & GERBVIEW_FRAME::GetPageSettings ( ) const
overridevirtual

◆ GetPageSizeIU()

const VECTOR2I GERBVIEW_FRAME::GetPageSizeIU ( ) const
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 887 of file gerbview_frame.cpp.

References gerbIUScale, GetPageSettings(), PAGE_INFO::GetSizeIU(), and EDA_IU_SCALE::IU_PER_MILS.

◆ GetPropertiesPanel()

PROPERTIES_PANEL * EDA_DRAW_FRAME::GetPropertiesPanel ( )
inlineinherited

Definition at line 396 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_propertiesPanel.

◆ GetRedoActionDescription()

wxString EDA_BASE_FRAME::GetRedoActionDescription ( ) const
virtualinherited

◆ GetRedoCommandCount()

◆ GetScreen()

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1075 of file eda_draw_frame.cpp.

Referenced by EDA_DRAW_FRAME::PrintDrawingSheet(), and PCB_EDIT_FRAME::SetPageSettings().

◆ GetSettingsManager()

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int  aErrorCode) const
inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 141 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const
inlineinherited

For those frames that support polar coordinates.

Definition at line 127 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_polarCoords.

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

◆ GetTitleBlock()

const TITLE_BLOCK & GERBVIEW_FRAME::GetTitleBlock ( ) const
overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 896 of file gerbview_frame.cpp.

References GBR_LAYOUT::GetTitleBlock(), and m_gerberLayout.

Referenced by SetPageSettings().

◆ GetToolCanvas()

wxWindow * EDA_DRAW_FRAME::GetToolCanvas ( ) const
inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 434 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolManager()

TOOL_MANAGER * TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), SCH_SEARCH_HANDLER::ActivateItem(), PCB_SEARCH_HANDLER::ActivateItem(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_PROPERTIES_PANEL::AfterCommit(), PCB_PROPERTIES_PANEL::AfterCommit(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), SCH_NAVIGATE_TOOL::Back(), SCH_NAVIGATE_TOOL::changeSheet(), TOOLS_HOLDER::CommonSettingsChanged(), EDA_DRAW_FRAME::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(), KIGFX::SCH_VIEW::DisplaySheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIMULATOR_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SCH_FIELD::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), DRAWING_TOOL::DrawVia(), PCB_TUNING_PATTERN::EditStart(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_NAVIGATE_TOOL::Forward(), GERBVIEW_FRAME(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), PCB_TUNING_PATTERN::GetPreviewItems(), SCH_PROPERTIES_PANEL::getPropertyFromEvent(), PCB_PROPERTIES_PANEL::getPropertyFromEvent(), 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_GENERATORS::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnDeleteOneClick(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemSelected(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_GENERATORS::OnItemSelected(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), GERBER_LAYER_WIDGET::onPopupSelection(), DIALOG_GENERATORS::OnRebuildAllClick(), DIALOG_GENERATORS::OnRebuildTypeClick(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_PANE::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), PCB_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected(), PANEL_KICAD_LAUNCHER::PANEL_KICAD_LAUNCHER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), PCB_BASE_FRAME::rebuildConnectivity(), SIMULATOR_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::saveProjectSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), SCH_COMMIT::SCH_COMMIT(), DIALOG_FIND::search(), SCH_SEARCH_HANDLER::SelectItems(), PCB_SEARCH_HANDLER::SelectItems(), CVPCB_MAINFRAME::setupEventHandlers(), FOOTPRINT_EDIT_FRAME::setupTools(), TOOLS_HOLDER::ShowChangedLanguage(), APPEARANCE_CONTROLS::showNetclass(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), SIMULATOR_CONTROL::Tune(), SCH_PROPERTIES_PANEL::UpdateData(), PCB_PROPERTIES_PANEL::UpdateData(), DIALOG_DRC::updateDisplayedCounts(), CVPCB_MAINFRAME::updateFootprintViewerOnIdle(), NET_GRID_TABLE::updateNetVisibility(), SCH_PROPERTIES_PANEL::valueChanged(), PCB_PROPERTIES_PANEL::valueChanged(), SCH_PROPERTIES_PANEL::valueChanging(), PCB_PROPERTIES_PANEL::valueChanging(), DIALOG_IMPORT_NETLIST::~DIALOG_IMPORT_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 46 of file kiway_holder.h.

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoActionDescription()

wxString EDA_BASE_FRAME::GetUndoActionDescription ( ) const
virtualinherited

◆ GetUndoCommandCount()

◆ GetUnitPair()

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

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.

Reimplemented from UNITS_PROVIDER.

Definition at line 1249 of file eda_draw_frame.cpp.

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

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

◆ GetUntranslatedAboutTitle()

const wxString & EDA_BASE_FRAME::GetUntranslatedAboutTitle ( ) const
inlineinherited

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const
inlineinherited

Definition at line 43 of file units_provider.h.

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_BOOK_REPORTER::AddHTMLPage(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), PG_UNIT_EDITOR::CreateControls(), PCB::IFACE::CreateKiWindow(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), PGPROPERTY_DISTANCE::DistanceToString(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), RC_ITEM::GetJsonViolation(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), UNITS_PROVIDER::GetUnitPair(), EDA_DRAW_FRAME::GetUnitPair(), WX_GRID::GetUnitValue(), GetUserUnits(), UNIT_BINDER::init(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromMinOptMax(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), DIALOG_NET_INSPECTOR::onReport(), DIALOG_ERC::OnSaveReport(), PANEL_PREVIEW_3D_MODEL::onUnitsChanged(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_GENERATORS::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), 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(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), EDA_DRAW_FRAME::SaveSettings(), PCB_BASE_FRAME::SetBoard(), 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(), PCB_BASE_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), updateDCodeSelectBox(), PG_UNIT_EDITOR::UpdateFrame(), PL_EDITOR_FRAME::UpdateStatusBar(), DRC_TOOL::userUnits(), GRID::UserUnitsMessageText(), and UNITS_PROVIDER::ValueFromString().

◆ GetVisibleElementColor()

COLOR4D GERBVIEW_FRAME::GetVisibleElementColor ( int  aLayerID)

◆ GetVisibleLayers()

LSET GERBVIEW_FRAME::GetVisibleLayers ( ) const

A proxy function that calls the correspondent function in m_BoardSettings.

Returns
LSET of the visible layers

Definition at line 723 of file gerbview_frame.cpp.

References LSET::AllLayersMask(), GERBER_DRAW_LAYER, GERBER_DRAWLAYERS_COUNT, EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), and KIGFX::VIEW::IsLayerVisible().

Referenced by LoadListOfGerberAndDrillFiles(), and GERBER_LAYER_WIDGET::OnLayerVisible().

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
virtualinherited

Return a pointer to the window settings for this frame.

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

Parameters
aCfgis this frame's config object

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, SIMULATOR_FRAME, SYMBOL_CHOOSER_FRAME, SYMBOL_DIFF_FRAME, SYMBOL_VIEWER_FRAME, FOOTPRINT_CHOOSER_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 850 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()

wxSize EDA_BASE_FRAME::GetWindowSize ( )
inherited

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

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

Returns
the undecorated window size

Definition at line 1508 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().

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const
inherited

Return a human readable value for display in dialogs.

Definition at line 698 of file eda_draw_frame.cpp.

References 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().

◆ gvconfig()

◆ handleActivateEvent()

void EDA_DRAW_FRAME::handleActivateEvent ( wxActivateEvent &  aEvent)
protectedvirtualinherited

◆ handleIconizeEvent()

virtual void EDA_BASE_FRAME::handleIconizeEvent ( wxIconizeEvent &  aEvent)
inlineprotectedvirtualinherited

Handle a window iconize event.

Parameters
aEventis the data for the event.

Reimplemented in EDA_3D_VIEWER_FRAME, SCH_BASE_FRAME, and PCB_BASE_FRAME.

Definition at line 629 of file eda_base_frame.h.

Referenced by EDA_3D_VIEWER_FRAME::handleIconizeEvent(), SCH_BASE_FRAME::handleIconizeEvent(), PCB_BASE_FRAME::handleIconizeEvent(), and EDA_BASE_FRAME::onIconize().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )
virtualinherited

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

Definition at line 1532 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()

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

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

enabled, checked, etc.).

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

Definition at line 389 of file eda_base_frame.cpp.

References _, ACTION_CONDITIONS::checkCondition, ACTIONS::copy, ACTIONS::cut, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), EDA_BASE_FRAME::GetRedoActionDescription(), TOOL_ACTION::GetUIId(), EDA_BASE_FRAME::GetUndoActionDescription(), ACTIONS::paste, ACTIONS::redo, ACTION_CONDITIONS::showCondition, and ACTIONS::undo.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

void EDA_DRAW_FRAME::HardRedraw ( )
virtualinherited

Rebuild the GAL and redraws the screen.

Call when something went wrong.

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

Definition at line 942 of file eda_draw_frame.cpp.

Referenced by COMMON_TOOLS::ZoomRedraw().

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const
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()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 869 of file eda_base_frame.cpp.

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImagesMaxCount()

unsigned GERBVIEW_FRAME::ImagesMaxCount ( ) const

◆ ImportHotkeyConfigFromFile()

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

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

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

◆ initExitKey()

void EDA_BASE_FRAME::initExitKey ( )
protectedinherited

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

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

Definition at line 1390 of file eda_base_frame.cpp.

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const
inlineprotectedvirtualinherited

Return the auto save status of the application.

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

Definition at line 637 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_autoSaveRequired.

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( ) const
virtualinherited

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

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

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

Definition at line 1383 of file eda_base_frame.cpp.

Referenced by Clear_DrawLayers(), EDITOR_CONDITIONS::contentModifiedFunc(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), and SCH_BASE_FRAME::OnSymChangeDebounceTimer().

◆ IsCurrentTool()

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

◆ IsDismissed()

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

Definition at line 166 of file kiway_player.cpp.

References KIWAY_PLAYER::m_modal_loop.

Referenced by SYMBOL_CHOOSER_FRAME::doCloseWindow(), FOOTPRINT_CHOOSER_FRAME::doCloseWindow(), and FOOTPRINT_WIZARD_FRAME::doCloseWindow().

◆ IsElementVisible()

bool GERBVIEW_FRAME::IsElementVisible ( int  aLayerID) const

◆ IsGridOverridden()

bool EDA_DRAW_FRAME::IsGridOverridden ( ) const
inherited

◆ IsGridVisible()

◆ IsLayerVisible()

bool GERBVIEW_FRAME::IsLayerVisible ( int  aLayer) const

Test whether a given layer is visible.

Parameters
aLayerThe layer to be tested (still 0-31!)
Returns
true if the layer is visible.

Definition at line 753 of file gerbview_frame.cpp.

References LAYER_WIDGET::IsLayerVisible(), and m_LayersManager.

Referenced by GERBER_LAYER_WIDGET::ReFill(), RemapLayers(), GERBVIEW_SELECTION_TOOL::selectable(), and DIALOG_DRAW_LAYERS_SETTINGS::TransferDataFromWindow().

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const
inlineoverridevirtualinherited

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

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 156 of file kiway_player.h.

References KIWAY_PLAYER::m_modal.

Referenced by FOOTPRINT_WIZARD_FRAME::doCloseWindow(), KIWAY_PLAYER::ShowModal(), and SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME().

◆ IsScriptingConsoleVisible()

bool EDA_DRAW_FRAME::IsScriptingConsoleVisible ( )
inherited

Gets the current visibility of the scripting console window.

Definition at line 283 of file eda_draw_frame.cpp.

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

Referenced by EDITOR_CONDITIONS::consoleVisibleFunc().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 203 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(), PCB_POINT_EDITOR::changeArcEditMode(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), SYMBOL_EDITOR_CONTROL::DdAddLibrary(), 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(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_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(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), PCB_EDITOR_CONDITIONS::get45degModeFunc(), SCH_BASE_FRAME::GetColorSettings(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), SYMBOL_EDITOR_CONTROL::Init(), CONVERT_TOOL::Init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PCB_BASE_FRAME::loadFootprint(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PROPERTIES_PANEL::rebuildProperties(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), PCB_SELECTION_TOOL::Reset(), SYMBOL_EDITOR_CONTROL::Revert(), SYMBOL_EDITOR_CONTROL::Save(), SCH_COMMIT::SCH_COMMIT(), APPEARANCE_CONTROLS::setVisibleObjects(), EE_INSPECTION_TOOL::ShowDatasheet(), SYMBOL_EDITOR_CONTROL::ToggleProperties(), SYMBOL_EDITOR_CONTROL::ToggleSymbolTree(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), and DRAWING_TOOL::UpdateStatusBar().

◆ IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName &  aFileName,
bool  aVerbose = true 
)
inherited

Checks if aFileName can be written.

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

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

Definition at line 1273 of file eda_base_frame.cpp.

References _, and DisplayErrorMessage().

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

◆ Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 of file kiway_holder.h.

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesList(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), BOARD_INSPECTION_TOOL::constructDiffPanel(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), KIWAY_PLAYER::Destroy(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), PANEL_SYMBOL_CHOOSER::FinishSetup(), IMPORT_PROJ_HELPER::ImportIndividualFile(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), PGM_SINGLE_TOP::MacOpenFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PCB_CALCULATOR_FRAME::OnExit(), SIMULATOR_FRAME::onExit(), SAVE_AS_TRAVERSER::OnFile(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), KIWAY_HOLDER::Prj(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), CVPCB_CONTROL::ShowFootprintViewer(), showFrame(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), FP_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), COMMON_CONTROL::ShowProjectManager(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), SIMULATOR_CONTROL::Tune(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS aEvent)
protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 187 of file kiway_player.cpp.

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

An event handler called on a language menu selection.

Definition at line 194 of file kiway_player.cpp.

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

◆ LibraryFileBrowser()

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

Definition at line 1089 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().

◆ LoadAutodetectedFiles()

bool GERBVIEW_FRAME::LoadAutodetectedFiles ( const wxString &  aFileName)

Load a given file or selected file(s), if the filename is empty.

Parameters
aFileName- file name with full path to open or empty string. if empty string: a dialog will be opened to select one or a set of files
Returns
true if file was opened successfully.

Definition at line 179 of file gerbview/files.cpp.

References _, AllFilesWildcard(), and LoadFileOrShowDialog().

Referenced by GERBVIEW_CONTROL::OpenAutodetected(), and OpenProjectFiles().

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( APP_SETTINGS_BASE aCfg = nullptr)
protectedinherited

Returns the canvas type stored in the application settings.

Parameters
aCfgis the APP_SETTINGS_BASE config storing the canvas type. If nullptr (default) the KifaceSettings() will be used

Definition at line 849 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(), EDA_DRAW_FRAME::resolveCanvasType(), and FOOTPRINT_EDIT_FRAME::resolveCanvasType().

◆ LoadExcellonFiles()

bool GERBVIEW_FRAME::LoadExcellonFiles ( const wxString &  aFileName)

Load a drill (EXCELLON) file or many files.

Parameters
aFileName- void string or file name with full path to open or empty string to open a new file. In this case one one file is loaded if empty string: user will be prompted for filename(s)
Returns
true if file was opened successfully.

Definition at line 229 of file gerbview/files.cpp.

References _, AllFilesWildcard(), DrillFileWildcard(), and LoadFileOrShowDialog().

Referenced by OnDrlFileHistory(), GERBVIEW_CONTROL::OpenDrillFile(), and OpenProjectFiles().

◆ LoadFileOrShowDialog()

bool GERBVIEW_FRAME::LoadFileOrShowDialog ( const wxString &  aFileName,
const wxString &  dialogFiletypes,
const wxString &  dialogTitle,
const int  filetype 
)
private

Loads the file provided or shows a dialog to get the file(s) from the user.

Parameters
aFileNameName of the file to open. Shows a dialog if not specified.
dialogFiletypesFile extensions to pass to the dialog if necessary
dialogTitleDialog title to use if necessary
filetypeType of file for parsing, 0 = gerber, 1 = drill, 2 = autodetect
Returns
true if success opening all files, false otherwise

Definition at line 118 of file gerbview/files.cpp.

References GetImagesList(), GERBER_FILE_IMAGE_LIST::GetLoadedImageCount(), LoadListOfGerberAndDrillFiles(), EDA_BASE_FRAME::m_mruPath, SortLayersByFileExtension(), and EDA_DRAW_FRAME::Zoom_Automatique().

Referenced by LoadAutodetectedFiles(), LoadExcellonFiles(), and LoadGerberFiles().

◆ LoadGerberFiles()

bool GERBVIEW_FRAME::LoadGerberFiles ( const wxString &  aFileName)

Load a given Gerber file or selected file(s), if the filename is empty.

Parameters
aFileName- file name with full path to open or empty string. if empty string: a dialog will be opened to select one or a set of files
Returns
true if file was opened successfully.

Definition at line 187 of file gerbview/files.cpp.

References _, AddFileExtListToFilter(), AllFilesWildcard(), and LoadFileOrShowDialog().

Referenced by OnGbrFileHistory(), GERBVIEW_CONTROL::OpenGerber(), and OpenProjectFiles().

◆ LoadGerberJobFile()

bool GERBVIEW_FRAME::LoadGerberJobFile ( const wxString &  aFileName)

Load a Gerber job file, and load gerber files found in job files.

Parameters
aFileName- void string or file name with full path to open or empty string to open a new file. if empty string: user will be prompted for filename(s)
Returns
true if file(s) was opened successfully.

Definition at line 178 of file job_file_reader.cpp.

References _, Clear_DrawLayers(), EDA_DRAW_FRAME::ClearMsgPanel(), GerberJobFileWildcard(), GERBER_JOBFILE_READER::GetGerberFiles(), HTML_MESSAGE_BOX::ListSet(), LoadListOfGerberAndDrillFiles(), m_jobFileHistory, EDA_BASE_FRAME::m_mruPath, GERBER_JOBFILE_READER::ReadGerberJobFile(), SortLayersByX2Attributes(), EDA_BASE_FRAME::UpdateFileHistory(), and EDA_DRAW_FRAME::Zoom_Automatique().

Referenced by OnJobFileHistory(), GERBVIEW_CONTROL::OpenJobFile(), and OpenProjectFiles().

◆ LoadListOfGerberAndDrillFiles()

bool GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles ( const wxString &  aPath,
const wxArrayString &  aFilenameList,
std::vector< int > *  aFileType 
)

Load a list of Gerber and NC drill files and updates the view based on them.

Parameters
aPathis the base path for the filenames if they are relative
aFilenameListis a list of filenames to load
aFileTypeis a list of type of files to load (0 = Gerber, 1 = NC drill, 2 Autodetect) Successfully autodetected files will have their type changed
Returns
true if every file loaded successfully

Definition at line 240 of file gerbview/files.cpp.

References _, GerberJobFileExtension, GetActiveLayer(), EDA_DRAW_FRAME::GetCanvas(), getNextAvailableLayer(), GetVisibleLayers(), HTML_MESSAGE_BOX::ListSet(), m_drillFileHistory, m_lastFileName, m_LayersManager, MSG_NO_MORE_LAYER, MSG_NOT_LOADED, MSG_OOM, NO_AVAILABLE_LAYERS, Read_EXCELLON_File(), Read_GERBER_File(), ReFillLayerWidget(), EDA_DRAW_PANEL_GAL::Refresh(), WX_STRING_REPORTER::Report(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, SetActiveLayer(), SetVisibleLayers(), syncLayerBox(), EXCELLON_IMAGE::TestFileIsExcellon(), GERBER_FILE_IMAGE::TestFileIsRS274(), EDA_BASE_FRAME::UpdateFileHistory(), LAYER_WIDGET::UpdateLayerIcons(), and visibility.

Referenced by LoadFileOrShowDialog(), LoadGerberJobFile(), and GERBVIEW_CONTROL::ReloadAllLayers().

◆ LoadSettings()

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS aCfg)
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 758 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]

◆ LoadWindowState() [2/2]

◆ LoadZipArchiveFile()

bool GERBVIEW_FRAME::LoadZipArchiveFile ( const wxString &  aFileName)

Load a zipped archive file.

Parameters
aFileName- void string or file name with full path to open or empty string to open a new file. if empty string: user will be prompted for filename(s)
Returns
true if file was opened successfully.

Definition at line 623 of file gerbview/files.cpp.

References _, GetActiveLayer(), HTML_MESSAGE_BOX::ListSet(), m_LayersManager, EDA_BASE_FRAME::m_mruPath, ReFillLayerWidget(), SetActiveLayer(), syncLayerBox(), unarchiveFiles(), LAYER_WIDGET::UpdateLayerIcons(), ZipFileWildcard(), and EDA_DRAW_FRAME::Zoom_Automatique().

Referenced by GERBVIEW_CONTROL::LoadZipfile(), OnZipFileHistory(), OpenProjectFiles(), and GERBVIEW_CONTROL::OpenZipFile().

◆ LockFile()

bool EDA_DRAW_FRAME::LockFile ( const wxString &  aFileName)
inherited

Mark a schematic file as being in use.

Use ReleaseFile() to undo this.

Parameters
aFileNamefull path to the file.
Returns
true if the file is locked or read-only, false otherwise.

Definition at line 227 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_file_checker, and Pgm().

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

◆ MessageTextFromMinOptMax()

wxString UNITS_PROVIDER::MessageTextFromMinOptMax ( const MINOPTMAX< int > &  aValue) const
inlineinherited

◆ MessageTextFromValue() [1/2]

wxString UNITS_PROVIDER::MessageTextFromValue ( const EDA_ANGLE aValue,
bool  aAddUnitLabel = true 
) const
inlineinherited

◆ MessageTextFromValue() [2/2]

wxString UNITS_PROVIDER::MessageTextFromValue ( double  aValue,
bool  aAddUnitLabel = true,
EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE 
) const
inlineinherited

A lower-precision version of StringFromValue().

Should ONLY be used for status text and messages. Not suitable for dialogs, files, etc. where the loss of precision matters.

Definition at line 101 of file units_provider.h.

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::MessageTextFromValue().

Referenced by CheckLibSymbol(), CheckLibSymbolGraphics(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DIALOG_BOARD_REANNOTATE::CoordTowxString(), DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DRAWING_TOOL::DrawBoardCharacteristics(), DRC_ENGINE::EvalRules(), DIALOG_NET_INSPECTOR::formatLength(), DRC_TEST_PROVIDER::formatMsg(), LIB_SHAPE::GetItemDescription(), SCH_LINE::GetItemDescription(), SCH_SHAPE::GetItemDescription(), DS_DRAW_ITEM_LINE::GetItemDescription(), DS_DRAW_ITEM_RECT::GetItemDescription(), PCB_TRACK::GetItemDescription(), LIB_FIELD::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_JUNCTION::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_REFERENCE_IMAGE::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), STROKE_PARAMS::GetMsgPanelInfo(), GetNetNavigatorItemText(), SYMBOL_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), LABEL_SEARCH_HANDLER::getResultCell(), DIALOG_BOARD_REANNOTATE::MakeSampleText(), PCB_BASE_FRAME::MessageTextFromCoord(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DIALOG_BOARD_STATISTICS::saveReportClicked(), TUNING_STATUS_VIEW_ITEM::SetCurrent(), TUNING_STATUS_VIEW_ITEM::SetMinMax(), EDA_SHAPE::ShapeGetMsgPanelInfo(), showCoord(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), VIA_SIZE_MENU::update(), PCB_TUNING_PATTERN::Update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), PCB_CONTROL::UpdateMessagePanel(), PL_EDITOR_FRAME::UpdateMsgPanelInfo(), SCH_BASE_FRAME::UpdateStatusBar(), UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), and DIALOG_BOARD_STATISTICS::updateWidets().

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce)
inlineinherited

Definition at line 593 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onActivate()

void EDA_DRAW_FRAME::onActivate ( wxActivateEvent &  aEvent)
protectedinherited

Definition at line 1294 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::handleActivateEvent().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  aKeyEvent)
virtualinherited

Capture the key event before it is sent to the GUI.

The basic frame does not capture this event. Editor frames should override this event function to capture and filter these keys when they are used as hotkeys, and skip it if the key is not used as hotkey (otherwise the key events will be not sent to menus).

Reimplemented in SYMBOL_VIEWER_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 346 of file eda_base_frame.cpp.

References dump(), and kicadTraceKeyEvent.

◆ OnClearDrlFileHistory()

void GERBVIEW_FRAME::OnClearDrlFileHistory ( wxCommandEvent &  aEvent)
private

Definition at line 79 of file gerbview/files.cpp.

References EDA_BASE_FRAME::ClearFileHistory(), and m_drillFileHistory.

◆ OnClearGbrFileHistory()

void GERBVIEW_FRAME::OnClearGbrFileHistory ( wxCommandEvent &  aEvent)
private

Definition at line 60 of file gerbview/files.cpp.

References EDA_BASE_FRAME::ClearFileHistory().

◆ OnClearJobFileHistory()

void GERBVIEW_FRAME::OnClearJobFileHistory ( wxCommandEvent &  aEvent)
private

Definition at line 112 of file gerbview/files.cpp.

References EDA_BASE_FRAME::ClearFileHistory(), and m_jobFileHistory.

◆ OnClearZipFileHistory()

void GERBVIEW_FRAME::OnClearZipFileHistory ( wxCommandEvent &  aEvent)
private

Definition at line 97 of file gerbview/files.cpp.

References EDA_BASE_FRAME::ClearFileHistory(), and m_zipFileHistory.

◆ OnDrlFileHistory()

void GERBVIEW_FRAME::OnDrlFileHistory ( wxCommandEvent &  event)

Delete the current data and load a drill file in Excellon format selected from history list on current layer.

Definition at line 66 of file gerbview/files.cpp.

References _, EDA_BASE_FRAME::GetFileFromHistory(), LoadExcellonFiles(), and m_drillFileHistory.

◆ OnDropFiles()

void EDA_BASE_FRAME::OnDropFiles ( wxDropFilesEvent &  aEvent)
protectedvirtualinherited

Handles event fired when a file is dropped to the window.

In this base class, stores the path of files accepted. Calls DoWithAcceptedFiles() to execute actions on files.

Definition at line 1241 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::DoWithAcceptedFiles(), GerberFileExtension, IsGerberFileExtension(), EDA_BASE_FRAME::m_acceptedExts, and EDA_BASE_FRAME::m_AcceptedFiles.

◆ OnGbrFileHistory()

void GERBVIEW_FRAME::OnGbrFileHistory ( wxCommandEvent &  event)

Delete the current data and loads a Gerber file selected from history list on current layer.

Definition at line 48 of file gerbview/files.cpp.

References _, EDA_BASE_FRAME::GetFileFromHistory(), and LoadGerberFiles().

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent &  aEvent)
protectedinherited

Definition at line 1558 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::handleIconizeEvent().

◆ OnJobFileHistory()

void GERBVIEW_FRAME::OnJobFileHistory ( wxCommandEvent &  event)

Delete the current data and load a gerber job file selected from the history list.

Definition at line 103 of file gerbview/files.cpp.

References _, EDA_BASE_FRAME::GetFileFromHistory(), LoadGerberJobFile(), and m_jobFileHistory.

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 1034 of file eda_base_frame.cpp.

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent &  aEvent)
inherited

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent &  event)
inherited

The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves.

Definition at line 356 of file eda_base_frame.cpp.

References TOOL_DISPATCHER::DispatchWxEvent(), and TOOLS_HOLDER::m_toolDispatcher.

◆ OnModify()

void EDA_BASE_FRAME::OnModify ( )
virtualinherited

◆ OnMove()

◆ OnPageSettingsChange()

virtual void EDA_DRAW_FRAME::OnPageSettingsChange ( )
inlinevirtualinherited

Called when modifying the page settings.

In derived classes it can be used to modify parameters like draw area size, and any other local parameter related to the page settings.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 333 of file eda_draw_frame.h.

Referenced by DIALOG_PAGES_SETTINGS::TransferDataFromWindow().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 1041 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::ShowPreferences().

◆ OnQuit()

void GERBVIEW_FRAME::OnQuit ( wxCommandEvent &  event)

Called on request of application quit.

Definition at line 167 of file events_called_functions.cpp.

◆ OnSelectActiveDCode()

void GERBVIEW_FRAME::OnSelectActiveDCode ( wxCommandEvent &  event)

◆ OnSelectActiveLayer()

void GERBVIEW_FRAME::OnSelectActiveLayer ( wxCommandEvent &  event)

Select the active layer:

  • if a file is loaded, it is loaded in this layer
  • this layer is displayed on top of other layers

Definition at line 137 of file events_called_functions.cpp.

References KIGFX::COLOR, EDA_DRAW_FRAME::GetCanvas(), KIGFX::VIEW::GetPainter(), DCODE_SELECTION_BOX::GetSelectedDCodeId(), EDA_DRAW_PANEL_GAL::GetView(), m_DCodeSelector, EDA_DRAW_PANEL_GAL::Refresh(), SetActiveLayer(), syncLayerBox(), and KIGFX::VIEW::UpdateAllItems().

◆ OnSelectDisplayMode()

void GERBVIEW_FRAME::OnSelectDisplayMode ( wxCommandEvent &  event)

Called on a display mode selection.

Mode selection can be fast display or exact mode with stacked images or with transparency.

Definition at line 154 of file events_called_functions.cpp.

References EDA_DRAW_FRAME::GetCanvas(), ID_TB_OPTIONS_SHOW_GBR_MODE_0, ID_TB_OPTIONS_SHOW_GBR_MODE_1, ID_TB_OPTIONS_SHOW_GBR_MODE_2, EDA_DRAW_PANEL_GAL::Refresh(), and SetDisplayMode().

◆ OnSelectGrid()

void EDA_DRAW_FRAME::OnSelectGrid ( wxCommandEvent &  event)
inherited

Command event handler for selecting grid sizes.

All commands that set the grid size should eventually end up here. This is where the application setting is saved. If you override this method, make sure you call down to the base class.

Parameters
eventCommand event from the grid size combobox on the toolbar.

Definition at line 469 of file eda_draw_frame.cpp.

References dummy, ACTIONS::gridPreset, ACTIONS::gridProperties, EDA_DRAW_FRAME::m_canvas, EDA_DRAW_FRAME::m_gridSelectBox, TOOLS_HOLDER::m_toolManager, EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), EDA_DRAW_PANEL_GAL::SetFocus(), and EDA_DRAW_FRAME::UpdateStatusBar().

◆ OnSelectHighlightChoice()

void GERBVIEW_FRAME::OnSelectHighlightChoice ( wxCommandEvent &  event)

Handles the changing of the highlighted component/net/attribute.

◆ OnSelectZoom()

void EDA_DRAW_FRAME::OnSelectZoom ( wxCommandEvent &  event)
virtualinherited

Set the zoom factor when selected by the zoom list box in the main tool bar.

Note
List position 0 is fit to page. List position >= 1 = zoom (1 to zoom max). Last list position is custom zoom not in zoom list.

Definition at line 579 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_canvas, TOOLS_HOLDER::m_toolManager, EDA_DRAW_FRAME::m_zoomSelectBox, EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), EDA_DRAW_PANEL_GAL::SetFocus(), EDA_DRAW_FRAME::UpdateStatusBar(), and ACTIONS::zoomPreset.

◆ OnSize()

void EDA_DRAW_FRAME::OnSize ( wxSizeEvent &  event)
overridevirtualinherited

Recalculate the size of toolbars and display panel when the frame size changes.

Reimplemented from EDA_BASE_FRAME.

Reimplemented in SYMBOL_DIFF_FRAME, SYMBOL_VIEWER_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 676 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_frameSize, and EDA_BASE_FRAME::OnSize().

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

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent &  evt)
inherited

Definition at line 69 of file eda_dde.cpp.

References client_ipc_buffer, KIWAY_PLAYER::ExecuteRemoteCommand(), and IPC_BUF_SIZE.

◆ OnSockRequestServer()

void KIWAY_PLAYER::OnSockRequestServer ( wxSocketEvent &  evt)
inherited

Definition at line 99 of file eda_dde.cpp.

References ID_EDA_SOCKET_EVENT, and KIWAY_PLAYER::m_sockets.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent &  aEvent)
protectedinherited

Definition at line 1548 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ OnToolbarSizeChanged()

void EDA_DRAW_FRAME::OnToolbarSizeChanged ( )
inherited

◆ OnUpdateDrawMode()

void GERBVIEW_FRAME::OnUpdateDrawMode ( wxUpdateUIEvent &  aEvent)

◆ OnUpdateLayerSelectBox()

void GERBVIEW_FRAME::OnUpdateLayerSelectBox ( wxUpdateUIEvent &  aEvent)

Definition at line 508 of file toolbars_gerber.cpp.

References GetActiveLayer(), and m_SelLayerBox.

◆ OnUpdateSelectDCode()

void GERBVIEW_FRAME::OnUpdateSelectDCode ( wxUpdateUIEvent &  aEvent)

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent &  aEvent)
inherited

◆ OnUpdateSelectZoom()

void EDA_DRAW_FRAME::OnUpdateSelectZoom ( wxUpdateUIEvent &  aEvent)
inherited

◆ OnZipFileHistory()

void GERBVIEW_FRAME::OnZipFileHistory ( wxCommandEvent &  event)

Delete the current data and load a zip archive file selected from the history list.

The archive is expected containing a set of gerber and drill file

Definition at line 85 of file gerbview/files.cpp.

References _, EDA_BASE_FRAME::GetFileFromHistory(), LoadZipArchiveFile(), and m_zipFileHistory.

◆ OpenProjectFiles()

bool GERBVIEW_FRAME::OpenProjectFiles ( const std::vector< wxString > &  aFileList,
int  aCtl 
)
overridevirtual

Open a project or set of files given by aFileList.

This is generalized in the direction of worst case. In a typical case aFileList will only hold a single file, like "myboard.kicad_pcb" because any KIWAY_PLAYER is only in one KIWAY and the KIWAY owns the PROJECT. Therefore opening files from multiple projects into the same KIWAY_PLAYER is precluded.

Each derived class should handle this in a way specific to its needs. No filename prompting is done inside here for any file or project. There should be no need to call this with aFileList which is empty. However, calling it with a single filename which does not exist should indicate to the implementer that a new session is being started and that the given name is the desired name for the data file at time of save.

This function does not support "appending". Use a different function for that. Any prior project data tree should be cleared before loading the new stuff. Therefore, one of the first things an implementation should do is test for existence of the first file in the list, and if it does not exist, treat it as a new session, possibly with a UI notification to that effect.

After loading the window should update its Title as part of this operation. If the KIWAY_PLAYER needs to, it can load the *.pro file as part of this operation.

If the KIWAY_PLAYER cannot load any of the file(s) in the list, then it should say why through some GUI interface, and return false.

Parameters
aFileListincludes files that this frame should open according to the knowledge in the derived wxFrame. In almost every case, the list will have only a single file in it.
aCtlis a set of bit flags ORed together from the set of KICTL_* #defined above.
Returns
true if all requested files were opened OK, else false.

Reimplemented from KIWAY_PLAYER.

Definition at line 238 of file gerbview_frame.cpp.

References ArchiveFileExtension, GERBER_DRAWLAYERS_COUNT, GerberJobFileExtension, GERBER_FILE_IMAGE_LIST::GetGerberLayerFromFilename(), LoadAutodetectedFiles(), LoadExcellonFiles(), LoadGerberFiles(), LoadGerberJobFile(), LoadZipArchiveFile(), EDA_BASE_FRAME::m_mruPath, path, and EDA_DRAW_FRAME::Zoom_Automatique().

Referenced by GERBVIEW_CONTROL::LoadGerbFiles().

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )
virtualinherited

◆ PopCommandFromUndoList()

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const TOOL_EVENT aEvent)
virtualinherited

Pops a tool from the stack.

Parameters
aEventThe event that started the tool that was pushed to the stack.

Definition at line 77 of file tools_holder.cpp.

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_EVENT::getCommandStr(), TOOLS_HOLDER::GetToolManager(), TOOLS_HOLDER::m_toolManager, TOOLS_HOLDER::m_toolStack, TOOL_ACTION::MakeEvent(), TOOL_MANAGER::PostEvent(), ACTIONS::selectionTool, TOOL_EVENT::SetHasPosition(), and TOOL_EVENT::SetReactivate().

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), SCH_DRAWING_TOOLS::SchImportGraphics(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::SymbolImportGraphics(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintDrawingSheet()

void EDA_DRAW_FRAME::PrintDrawingSheet ( const RENDER_SETTINGS aSettings,
BASE_SCREEN aScreen,
const std::map< wxString, wxString > *  aProperties,
double  aMils2Iu,
const wxString &  aFilename,
const wxString &  aSheetLayer = wxEmptyString 
)
inherited

Prints the drawing-sheet (frame and title block).

Parameters
aScreenscreen to draw.
aPropertiesOptional properties for text variable resolution.
aMils2IuThe mils to Iu conversion factor.
aFilenameThe filename to display in basic inscriptions.
aSheetLayerThe layer displayed from PcbNew.

Definition at line 1045 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::GetFullScreenDesc(), BASE_SCREEN::GetPageCount(), BASE_SCREEN::GetPageNumber(), EDA_DRAW_FRAME::GetPageSettings(), KIGFX::RENDER_SETTINGS::GetPrintDC(), EDA_DRAW_FRAME::GetScreenDesc(), EDA_DRAW_FRAME::GetTitleBlock(), BASE_SCREEN::GetVirtualPageNumber(), EDA_DRAW_FRAME::m_showBorderAndTitleBlock, EDA_DRAW_FRAME::PrintDrawingSheet(), and KIWAY_HOLDER::Prj().

Referenced by EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), PL_EDITOR_FRAME::PrintPage(), PLEDITOR_PRINTOUT::PrintPage(), and SCH_PRINTOUT::PrintPage().

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString &  text)
inherited

Definition at line 875 of file eda_base_frame.cpp.

References text.

Referenced by KICAD_MANAGER_FRAME::OnUnarchiveFiles().

◆ PrintPage()

void EDA_DRAW_FRAME::PrintPage ( const RENDER_SETTINGS aSettings)
virtualinherited

Print the page pointed by current screen, set by the calling print function.

Parameters
aDCwxDC given by the calling print function

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, and PL_EDITOR_FRAME.

Definition at line 463 of file eda_draw_frame.cpp.

References DisplayErrorMessage().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_LIBRARY_MANAGER::addLibrary(), DIALOG_PLOT::applyPlotSettings(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesList(), PCB_BASE_FRAME::canCloseWindow(), SIMULATOR_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), PANEL_SETUP_NETCLASSES::checkReload(), KICAD_MANAGER_FRAME::CloseProject(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), EE_INSPECTION_TOOL::DiffSymbol(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), BOARD_EDITOR_CONTROL::ExportNetlist(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_EDITOR_CONTROL::ExportView(), BACK_ANNOTATE::FetchNetlistFromPCB(), PANEL_SYMBOL_CHOOSER::FinishSetup(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), SIMULATOR_CONTROL::getDefaultFilename(), SIMULATOR_CONTROL::getDefaultPath(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_NAVIGATE_TOOL::HypertextCommand(), SCH_EDITOR_CONTROL::ImportFPAssignments(), PANEL_SETUP_RULES::ImportSettingsFrom(), DIALOG_PLOT::init_Dialog(), DIALOG_EXPORT_SVG::initDialog(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), FIELDS_GRID_TABLE< T >::initGrid(), SIMULATOR_FRAME_UI::InitWorkbook(), EDA_DRAW_FRAME::LibraryFileBrowser(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SIMULATOR_FRAME::LoadSettings(), EDA_BASE_FRAME::LoadWindowState(), SIMULATOR_FRAME_UI::LoadWorkbook(), EDA_3D_VIEWER_FRAME::NewDisplay(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), DIALOG_EXPORT_STEP::onBrowseClicked(), DIALOG_EXPORT_2581::onBrowseClicked(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_IMPORT_NETLIST::onBrowseNetlistFiles(), WX_HTML_REPORT_PANEL::onBtnSaveToFile(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), DIALOG_EXPORT_STEP::onExportButton(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_CONFIG_EQUFILES::OnOkClick(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_FIELDS_TABLE::OnOutputFileBrowseClicked(), DIALOG_SCHEMATIC_SETUP::onPageChanged(), DIALOG_BOARD_SETUP::onPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), SCH_BASE_FRAME::OnSymChange(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SYMBOL_EDITOR_CONTROL::PinLibrary(), FOOTPRINT_EDITOR_CONTROL::PinLibrary(), LIB_TREE_MODEL_ADAPTER::PinLibrary(), SCH_DRAWING_TOOLS::PlaceSymbol(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), EDA_DRAW_FRAME::PrintDrawingSheet(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::readNetListAndFpFiles(), APPEARANCE_CONTROLS::rebuildNets(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SIMULATOR_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), SIMULATOR_CONTROL::SaveWorkbook(), SIMULATOR_FRAME_UI::SaveWorkbook(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), SCH_BASE_FRAME::SelectSymLibTable(), PCB_BASE_FRAME::setFPWatcher(), SetPageSettings(), SCH_BASE_FRAME::setSymWatcher(), DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties(), EE_INSPECTION_TOOL::ShowDatasheet(), PANEL_SYMBOL_CHOOSER::showFootprintFor(), COMMON_CONTROL::ShowHelp(), APPEARANCE_CONTROLS::showNetclass(), SCH_EDITOR_CONTROL::SimProbe(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), EDA_3D_VIEWER_FRAME::takeScreenshot(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_ASSIGN_NETCLASS::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), DIALOG_EXPORT_2581::TransferDataToWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), FOOTPRINT_EDITOR_CONTROL::UnpinLibrary(), LIB_TREE_MODEL_ADAPTER::UnpinLibrary(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), SIMULATOR_FRAME::UpdateTitle(), SIMULATOR_FRAME_UI::UpdateTunerValue(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), DIALOG_EXPORT_SVG::~DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), and PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL().

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent &  aEvent)
overrideinherited

Override the default process event handler to implement the auto save feature.

Warning
If you override this function in a derived class, make sure you call down to this or the auto save feature will be disabled.

Definition at line 277 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::GetAutoSaveInterval(), EDA_BASE_FRAME::isAutoSaveRequired(), EDA_BASE_FRAME::m_autoSavePending, EDA_BASE_FRAME::m_autoSaveTimer, EDA_BASE_FRAME::m_isClosing, EDA_BASE_FRAME::m_supportsAutoSave, Pgm(), and traceAutoSave.

Referenced by SYMBOL_VIEWER_FRAME::onSelectNextSymbol(), SYMBOL_VIEWER_FRAME::onSelectPreviousSymbol(), and KIWAY::ProcessEvent().

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )
inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in KICAD_MANAGER_FRAME, and PCB_EDIT_FRAME.

Definition at line 510 of file eda_base_frame.h.

Referenced by KIWAY::ProjectChanged().

◆ PropertiesPaneName()

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

◆ PushCommandToUndoList()

◆ PushTool()

void TOOLS_HOLDER::PushTool ( const TOOL_EVENT aEvent)
virtualinherited

NB: the definition of "tool" is different at the user level.

The implementation uses a single TOOL_BASE derived class to implement several user "tools", such as rectangle and circle, or wire and bus. So each user-level tool is actually a TOOL_ACTION.

Pushes a tool to the stack.

Parameters
aEventThe event that is starting the tool to be pushed to the stack.

Definition at line 56 of file tools_holder.cpp.

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_EVENT::getCommandStr(), TOOL_ACTION::GetFriendlyName(), TOOLS_HOLDER::m_toolManager, and TOOLS_HOLDER::m_toolStack.

Referenced by EDIT_TOOL::copyToClipboard(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), SCH_DRAWING_TOOLS::SchImportGraphics(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::SymbolImportGraphics(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ Read_EXCELLON_File()

◆ Read_GERBER_File()

◆ ReCreateAuxiliaryToolbar()

◆ ReCreateHToolbar()

◆ ReCreateMenuBar()

void EDA_BASE_FRAME::ReCreateMenuBar ( )
inherited

Recreates the menu bar.

Needed when the language or icons are changed

As of wxWidgets 3.2, recreating the menubar from within an event handler of that menubar will result in memory corruption on macOS. In order to minimize the chance of programmer error causing regressions here, we always wrap calls to ReCreateMenuBar in a CallAfter to ensure that they do not occur within the same event handling call stack.

Definition at line 475 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::doReCreateMenuBar().

Referenced by ActivateGalCanvas(), EDA_BASE_FRAME::ClearFileHistory(), EDA_BASE_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), GERBVIEW_FRAME(), EDA_BASE_FRAME::GetFileFromHistory(), EDA_BASE_FRAME::HandleSystemColorChange(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCRIPTING_TOOL::reloadPlugins(), EDA_BASE_FRAME::ShowChangedLanguage(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), and EDA_BASE_FRAME::UpdateFileHistory().

◆ ReCreateOptToolbar()

◆ RecreateToolbars()

◆ ReCreateVToolbar()

void GERBVIEW_FRAME::ReCreateVToolbar ( )
overridevirtual

Create or update the right vertical toolbar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 218 of file toolbars_gerber.cpp.

◆ ReFillLayerWidget()

◆ RefreshCanvas()

void EDA_DRAW_FRAME::RefreshCanvas ( )
inlineoverridevirtualinherited

◆ RegisterUIUpdateHandler() [1/2]

void TOOLS_HOLDER::RegisterUIUpdateHandler ( const TOOL_ACTION aAction,
const ACTION_CONDITIONS aConditions 
)
virtualinherited

Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls.

Parameters
aActionis the action to register.
aConditionsare the UI conditions to use for the control states.

Definition at line 42 of file tools_holder.cpp.

References TOOL_ACTION::GetUIId(), and TOOLS_HOLDER::RegisterUIUpdateHandler().

Referenced by ACTION_TOOLBAR::doSelectAction(), TOOLS_HOLDER::RegisterUIUpdateHandler(), and ACTION_MANAGER::SetConditions().

◆ RegisterUIUpdateHandler() [2/2]

void EDA_BASE_FRAME::RegisterUIUpdateHandler ( int  aID,
const ACTION_CONDITIONS aConditions 
)
overridevirtualinherited

Register a UI update handler for the control with ID aID.

Parameters
aIDis the control ID to register the handler for
aConditionsare the UI conditions to use for the control states

Reimplemented from TOOLS_HOLDER.

Definition at line 365 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::HandleUpdateUIEvent(), and EDA_BASE_FRAME::m_uiUpdateMap.

Referenced by BITMAP2CMP_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), EDA_BASE_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::setupUIConditions(), and KICAD_MANAGER_FRAME::setupUIConditions().

◆ ReleaseFile()

void EDA_DRAW_FRAME::ReleaseFile ( )
inherited

Release the current file marked in use.

See m_file_checker.

Definition at line 220 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_file_checker.

Referenced by PCB_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Files_io_from_id(), SCH_EDITOR_CONTROL::Revert(), and EDA_DRAW_FRAME::~EDA_DRAW_FRAME().

◆ RemapLayers()

void GERBVIEW_FRAME::RemapLayers ( const std::unordered_map< int, int > &  remapping)

Takes a layer remapping and reorders the layers.

Parameters
remappingA map of old layer number -> new layer number mapping. Generally sourced from the SortImagesBy* functions.

Definition at line 547 of file gerbview_frame.cpp.

References GERBER_DCODE_LAYER, GERBER_DRAW_LAYER, EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), IsLayerVisible(), ReFillLayerWidget(), EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::VIEW::ReorderLayerData(), SetVisibleLayers(), and syncLayerBox().

Referenced by Erase_Current_DrawLayer(), GERBVIEW_CONTROL::MoveLayerDown(), GERBVIEW_CONTROL::MoveLayerUp(), SortLayersByFileExtension(), and SortLayersByX2Attributes().

◆ resolveCanvasType()

void EDA_DRAW_FRAME::resolveCanvasType ( )
protectedvirtualinherited

Determines the Canvas type to load (with prompt if required) and initializes m_canvasType.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 1273 of file eda_draw_frame.cpp.

References EDA_DRAW_PANEL_GAL::GAL_FALLBACK, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, EDA_DRAW_FRAME::loadCanvasTypeSetting(), EDA_DRAW_FRAME::m_canvasType, and EDA_DRAW_FRAME::m_openGLFailureOccured.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), and GERBVIEW_FRAME().

◆ SaveCanvasImageToFile()

bool EDA_DRAW_FRAME::SaveCanvasImageToFile ( const wxString &  aFileName,
BITMAP_TYPE  aBitmapType 
)
inherited

Save the current view as an image file.

Parameters
aFrameThe current draw frame view to save.
aFileNameThe file name to save the image. This will overwrite an existing file.
aBitmapTypeThe type of bitmap create as defined by wxImage.
Returns
True if the file was successfully saved or false if the file failed to be saved.

Definition at line 1302 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::GetCanvas(), and image.

Referenced by SYMBOL_EDITOR_CONTROL::ExportView(), and FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng().

◆ saveCanvasTypeSetting()

bool EDA_DRAW_FRAME::saveCanvasTypeSetting ( EDA_DRAW_PANEL_GAL::GAL_TYPE  aCanvasType)
protectedinherited

◆ SaveCopyInUndoList() [1/2]

void GERBVIEW_FRAME::SaveCopyInUndoList ( const PICKED_ITEMS_LIST aItemsList,
UNDO_REDO  aTypeCommand 
)
inline

Create a new entry in undo list of commands and add a list of pickers to handle a list of items.

Parameters
aItemsList= the list of items modified by the command to undo
aTypeCommand= command type (see enum UNDO_REDO)
aTransformPoint= the reference point of the transformation, for commands like move Use to start up the GAL drawing canvas.

Definition at line 385 of file gerbview_frame.h.

◆ SaveCopyInUndoList() [2/2]

void GERBVIEW_FRAME::SaveCopyInUndoList ( GERBER_DRAW_ITEM aItemToCopy,
UNDO_REDO  aTypeCommand = UNDO_REDO::UNSPECIFIED 
)
inline

Definition at line 373 of file gerbview_frame.h.

◆ SaveProjectLocalSettings()

virtual void EDA_BASE_FRAME::SaveProjectLocalSettings ( )
inlinevirtualinherited

Save changes to the project local settings.

These settings are used to save/restore the view state for a specific project, and should never contain design data. This method is normally called automatically at various points in the workflow so that the user's most recent display settings are automatically persisted.

The method is virtual so you can override it to call the suitable save method. The base method does nothing.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 366 of file eda_base_frame.h.

◆ saveProjectSettings()

virtual void EDA_BASE_FRAME::saveProjectSettings ( )
inlineprotectedvirtualinherited

Saves any design-related project settings associated with this frame.

This method should only be called as the result of direct user action, for example from an explicit "Save Project" command or as a consequence of saving a design document.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 680 of file eda_base_frame.h.

◆ SaveSettings()

void GERBVIEW_FRAME::SaveSettings ( APP_SETTINGS_BASE aCfg)
overridevirtual

Save common frame parameters to a configuration data file.

Don't forget to call the base class's SaveSettings() from your derived SaveSettings() otherwise the frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 367 of file gerbview_frame.cpp.

References GetPageSettings(), PAGE_INFO::GetType(), GERBVIEW_SETTINGS::m_Appearance, m_drillFileHistory, GERBVIEW_SETTINGS::m_DrillFileHistory, m_jobFileHistory, GERBVIEW_SETTINGS::m_JobFileHistory, m_zipFileHistory, GERBVIEW_SETTINGS::m_ZipFileHistory, GERBVIEW_SETTINGS::APPEARANCE::page_type, Pgm(), FILE_HISTORY::Save(), and EDA_DRAW_FRAME::SaveSettings().

◆ SaveWindowSettings()

◆ ScriptingConsoleEnableDisable()

void EDA_DRAW_FRAME::ScriptingConsoleEnableDisable ( )
inherited

Toggles the scripting console visibility.

Definition at line 250 of file eda_draw_frame.cpp.

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

Referenced by SCH_EDITOR_CONTROL::TogglePythonConsole(), and BOARD_EDITOR_CONTROL::TogglePythonConsole().

◆ SelectPCBLayer()

int GERBVIEW_FRAME::SelectPCBLayer ( int  aDefaultLayer,
int  aCopperLayerCount,
const wxString &  aGerberName 
)

Show the dialog box for layer selection.

Providing the option to also display a "(Deselect)" radiobutton makes the GerbView's "Export to Pcbnew" command) more "user friendly", by permitting any layer to be "deselected" immediately after its corresponding radiobutton has been clicked on. (It would otherwise be necessary to first cancel the "Select Layer:" dialog box (invoked after a different radiobutton is clicked on) prior to then clicking on the "Deselect" button provided within the "Layer selection:" dialog box).

Parameters
aDefaultLayer= Preselection (NB_PCB_LAYERS for "(Deselect)" layer)
aCopperLayerCount= number of copper layers
aGerberName= Name of Gerber file to select KiCad layer for
Returns
new layer value (NB_PCB_LAYERS when "(Deselect)" radiobutton selected), or -1 if canceled

Definition at line 78 of file dialog_select_one_pcb_layer.cpp.

References SELECT_LAYER_DIALOG::GetSelectedLayer().

Referenced by LAYERS_MAP_DIALOG::OnSelectLayer().

◆ SetActiveLayer()

◆ SetCanvas()

void EDA_DRAW_FRAME::SetCanvas ( EDA_DRAW_PANEL_GAL aPanel)
inlineinherited

Definition at line 432 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_canvas.

Referenced by SCH_BASE_FRAME::createCanvas(), and GERBVIEW_FRAME().

◆ SetDisplayMode()

void GERBVIEW_FRAME::SetDisplayMode ( int  aMode)
inline
Parameters
aMode= 0 for fast mode 1 for exact mode, write mode 2 for exact mode, OR mode (transparency mode)

Definition at line 109 of file gerbview_frame.h.

References m_displayMode.

Referenced by OnSelectDisplayMode().

◆ SetDrawBgColor()

virtual void EDA_DRAW_FRAME::SetDrawBgColor ( const COLOR4D aColor)
inlinevirtualinherited

◆ SetElementVisibility()

◆ SetGridColor()

void GERBVIEW_FRAME::SetGridColor ( const COLOR4D aColor)
overridevirtual

◆ SetGridOrigin()

void GERBVIEW_FRAME::SetGridOrigin ( const VECTOR2I aPoint)
inlineoverridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 436 of file gerbview_frame.h.

References m_grid_origin.

◆ SetGridOverrides()

void EDA_DRAW_FRAME::SetGridOverrides ( bool  aOverride)
virtualinherited

◆ SetGridVisibility()

void GERBVIEW_FRAME::SetGridVisibility ( bool  aVisible)
overridevirtual
Parameters
aVisibletrue if the grid must be shown.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 787 of file gerbview_frame.cpp.

References LAYER_GERBVIEW_GRID, m_LayersManager, EDA_DRAW_FRAME::SetGridVisibility(), and LAYER_WIDGET::SetRenderState().

Referenced by SetElementVisibility().

◆ SetKiway()

void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
aKiwayis often from a parent window or from KIFACE::CreateKiWindow().

Definition at line 43 of file kiway_holder.cpp.

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by PCB::IFACE::CreateKiWindow(), InvokePcbLibTableEditor(), and InvokeSchEditSymbolLibTable().

◆ SetLayerColor()

void GERBVIEW_FRAME::SetLayerColor ( int  aLayer,
const COLOR4D aColor 
)

◆ SetLayerDrawPrms()

◆ SetLayout()

void GERBVIEW_FRAME::SetLayout ( GBR_LAYOUT aLayout)
inline

Set the m_gerberLayout member in such as way as to ensure deleting any previous GBR_LAYOUT.

Parameters
aLayoutThe GBR_LAYOUT to put into the frame.

Definition at line 406 of file gerbview_frame.h.

References m_gerberLayout.

Referenced by GERBVIEW_FRAME().

◆ SetMenuBar()

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool  aIsModal)
inlineinherited

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString &  aPath)
inlineinherited

◆ SetMsgPanel() [1/3]

void EDA_DRAW_FRAME::SetMsgPanel ( const std::vector< MSG_PANEL_ITEM > &  aList)
inherited

Clear the message panel and populates it with the contents of aList.

Parameters
aListis the list of MSG_PANEL_ITEM objects to fill the message panel.

Definition at line 795 of file eda_draw_frame.cpp.

References EDA_MSG_PANEL::AppendMessage(), EDA_MSG_PANEL::EraseMsgBox(), EDA_BASE_FRAME::m_isClosing, and EDA_DRAW_FRAME::m_messagePanel.

Referenced by BOARD_INSPECTION_TOOL::ClearHighlight(), PCB_BASE_FRAME::Compile_Ratsnest(), PCB_BASE_FRAME::CreateNewFootprint(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::GenIPC2581File(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), DRAWING_TOOL::InteractivePlaceWithPreview(), SCH_EDIT_FRAME::LoadSheetFromFile(), PCB_EDIT_FRAME::onBoardLoaded(), PCB_EDIT_FRAME::OnNetlistChanged(), SCH_PRINTOUT::OnPrintPage(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), PAD_TOOL::pushPadSettings(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveSchematicFile(), EDA_DRAW_FRAME::SetMsgPanel(), SCH_DRAWING_TOOLS::SingleClickPlace(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), ROUTER_TOOL::UpdateMessagePanel(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_EDIT_FRAME::UpdateMsgPanel(), FOOTPRINT_VIEWER_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), PL_EDITOR_FRAME::UpdateMsgPanelInfo(), and EE_POINT_EDITOR::updateParentItem().

◆ SetMsgPanel() [2/3]

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

Helper function that erases the msg panel and then appends a single message.

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

Definition at line 807 of file eda_draw_frame.cpp.

References EDA_MSG_PANEL::AppendMessage(), EDA_MSG_PANEL::EraseMsgBox(), EDA_BASE_FRAME::m_isClosing, and EDA_DRAW_FRAME::m_messagePanel.

◆ SetMsgPanel() [3/3]

void EDA_DRAW_FRAME::SetMsgPanel ( EDA_ITEM aItem)
inherited

◆ SetPageSettings()

◆ SetScreen()

◆ SetShowPolarCoords()

void EDA_DRAW_FRAME::SetShowPolarCoords ( bool  aShow)
inlineinherited

Definition at line 128 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_polarCoords.

Referenced by COMMON_TOOLS::TogglePolarCoords().

◆ SetTitleBlock()

void GERBVIEW_FRAME::SetTitleBlock ( const TITLE_BLOCK aTitleBlock)
overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 903 of file gerbview_frame.cpp.

References m_gerberLayout, and GBR_LAYOUT::SetTitleBlock().

◆ setupTools()

◆ setupUIConditions()

void GERBVIEW_FRAME::setupUIConditions ( )
overrideprotectedvirtual

Setup the UI conditions for the various actions and their controls in this frame.

Reimplemented from EDA_BASE_FRAME.

Definition at line 1057 of file gerbview_frame.cpp.

References CHECK, EDITOR_CONDITIONS::CurrentTool(), GERBVIEW_ACTIONS::dcodeDisplay, GERBVIEW_ACTIONS::flashedDisplayOutlines, GERBVIEW_ACTIONS::flipGerberView, EDITOR_CONDITIONS::FullscreenCursor(), TOOL_MANAGER::GetActionManager(), EDITOR_CONDITIONS::GridVisible(), gvconfig(), ACTIONS::highContrastMode, ACTIONS::inchesUnits, GERBVIEW_ACTIONS::linesDisplayOutlines, GERBVIEW_SETTINGS::m_Appearance, GBR_DISPLAY_OPTIONS::m_DiffMode, GERBVIEW_SETTINGS::m_Display, GBR_DISPLAY_OPTIONS::m_DisplayFlashedItemsFill, GBR_DISPLAY_OPTIONS::m_DisplayLinesFill, GBR_DISPLAY_OPTIONS::m_DisplayPolygonsFill, GBR_DISPLAY_OPTIONS::m_FlipGerberView, GBR_DISPLAY_OPTIONS::m_HighContrastMode, m_show_layer_manager_tools, TOOLS_HOLDER::m_toolManager, GBR_DISPLAY_OPTIONS::m_XORMode, ACTIONS::measureTool, ACTIONS::millimetersUnits, ACTIONS::milsUnits, GERBVIEW_ACTIONS::negativeObjectDisplay, EDITOR_CONDITIONS::PolarCoordinates(), GERBVIEW_ACTIONS::polygonsDisplayOutlines, ACTIONS::selectionTool, ACTION_MANAGER::SetConditions(), EDA_BASE_FRAME::setupUIConditions(), GERBVIEW_SETTINGS::APPEARANCE::show_dcodes, GERBVIEW_SETTINGS::APPEARANCE::show_negative_objects, ACTIONS::toggleCursorStyle, GERBVIEW_ACTIONS::toggleDiffMode, ACTIONS::toggleGrid, GERBVIEW_ACTIONS::toggleLayerManager, ACTIONS::togglePolarCoords, GERBVIEW_ACTIONS::toggleXORMode, EDITOR_CONDITIONS::Units(), and ACTIONS::zoomTool.

Referenced by GERBVIEW_FRAME().

◆ setupUnits()

◆ SetUserUnits()

◆ SetVisibleElementColor()

◆ SetVisibleLayers()

void GERBVIEW_FRAME::SetVisibleLayers ( LSET  aLayerMask)

A proxy function that calls the correspondent function in m_BoardSettings.

Parameters
aLayerMaskThe new set of visible layers

Definition at line 737 of file gerbview_frame.cpp.

References GERBER_DCODE_LAYER, GERBER_DRAW_LAYER, GERBER_DRAWLAYERS_COUNT, EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), gvconfig(), and KIGFX::VIEW::SetLayerVisible().

Referenced by GERBVIEW_FRAME(), LoadListOfGerberAndDrillFiles(), GERBER_LAYER_WIDGET::OnLayerVisible(), GERBER_LAYER_WIDGET::onPopupSelection(), and RemapLayers().

◆ ShowChangedLanguage()

void GERBVIEW_FRAME::ShowChangedLanguage ( )
overridevirtual

◆ ShowInfoBarError() [1/2]

void EDA_BASE_FRAME::ShowInfoBarError ( const wxString &  aErrorMsg,
bool  aShowCloseButton,
std::function< void(void)>  aCallback 
)
inherited

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.

The infobar will be closed after a timeout.

This version accepts a callback which will be called when the infobar is dismissed (either as a result of user action or a timeout). This can be useful when the caller wants to make other decorations in the canvas to highlight the error.

Parameters
aErrorMsgis the message to display.
aShowCloseButtontrue to show a close button on the right of the WX_INFOBAR.
aCallbacka callback to be called when the infobar is dismissed.

Definition at line 921 of file eda_base_frame.cpp.

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), WX_INFOBAR::SetCallback(), and WX_INFOBAR::ShowMessageFor().

◆ ShowInfoBarError() [2/2]

void EDA_BASE_FRAME::ShowInfoBarError ( const wxString &  aErrorMsg,
bool  aShowCloseButton = false,
WX_INFOBAR::MESSAGE_TYPE  aType = WX_INFOBAR::MESSAGE_TYPE::GENERIC 
)
inherited

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.

The infobar will be closed after a timeout.

Parameters
aErrorMsgis the message to display.
aShowCloseButtontrue to show a close button on the right of the WX_INFOBAR.

Definition at line 909 of file eda_base_frame.cpp.

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), MICROWAVE_TOOL::createInductorBetween(), PCB_BASE_EDIT_FRAME::createNewLibrary(), MICROWAVE_TOOL::createPolygonShape(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), BOARD_INSPECTION_TOOL::DiffFootprint(), EE_INSPECTION_TOOL::DiffSymbol(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawVia(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SYMBOL_EDIT_FRAME::ExportSymbol(), SCH_NAVIGATE_TOOL::HypertextCommand(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), ROUTER_TOOL::performRouting(), ROUTER_TOOL::prepareInteractive(), Read_EXCELLON_File(), Read_GERBER_File(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SYMBOL_EDIT_FRAME::saveLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), EE_INSPECTION_TOOL::ShowDatasheet(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields(), SCH_PROPERTIES_PANEL::valueChanging(), and PCB_PROPERTIES_PANEL::valueChanging().

◆ ShowInfoBarMsg()

void EDA_BASE_FRAME::ShowInfoBarMsg ( const wxString &  aMsg,
bool  aShowCloseButton = false 
)
inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters
aErrorMsgis the message to display.
aShowCloseButtontrue to show a close button on the right of the WX_INFOBAR.

Definition at line 947 of file eda_base_frame.cpp.

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_MOVE_TOOL::doMoveSelection(), SCH_DRAWING_TOOLS::DrawSheet(), EDIT_TOOL::FilletTracks(), PL_EDIT_TOOL::Main(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DIALOG_FIND::search(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ShowInfoBarWarning()

void EDA_BASE_FRAME::ShowInfoBarWarning ( const wxString &  aWarningMsg,
bool  aShowCloseButton = false 
)
inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters
aErrorMsgis the message to display.
aShowCloseButtontrue to show a close button on the right of the WX_INFOBAR.

Definition at line 936 of file eda_base_frame.cpp.

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SCH_EDIT_TOOL::RepeatDrawItem().

◆ ShowModal()

bool KIWAY_PLAYER::ShowModal ( wxString *  aResult = nullptr,
wxWindow *  aResultantFocusWindow = nullptr 
)
virtualinherited

Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal().

This is behavior is similar to a modal dialog window. Not all KIWAY_PLAYERs use this interface, so don't call this unless the implementation knows how to call DismissModal() on a button click or double click or some special event which ends the modal behavior.

Parameters
aResultif not NULL, indicates a place to put a resultant string.
aResultantFocusWindowif not NULL, indicates what window to pass focus to on return.
Returns
true if frame implementation called KIWAY_PLAYER::DismissModal() with aRetVal of true.

Reimplemented in FOOTPRINT_CHOOSER_FRAME, SYMBOL_CHOOSER_FRAME, and SYMBOL_DIFF_FRAME.

Definition at line 81 of file kiway_player.cpp.

References KIWAY_PLAYER::IsModal(), KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_resultant_parent, KIWAY_PLAYER::m_modal_ret_val, KIWAY_PLAYER::m_modal_string, and WX_EVENT_LOOP.

Referenced by 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(), FOOTPRINT_CHOOSER_FRAME::ShowModal(), SYMBOL_CHOOSER_FRAME::ShowModal(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ ShowPreferences()

void EDA_BASE_FRAME::ShowPreferences ( wxString  aStartPage,
wxString  aStartParentPage 
)
inherited

Displays the preferences and settings of all opened editors paged dialog, starting with a particular page.

Definition at line 1047 of file eda_base_frame.cpp.

References _, PANEL_HOTKEYS_EDITOR::ActionsList(), WX_TREEBOOK::AddLazyPage(), WX_TREEBOOK::AddLazySubPage(), KIWAY::CommonSettingsChanged(), KIWAY::FACE_GERBVIEW, KIWAY::FACE_PCB, KIWAY::FACE_PL_EDITOR, KIWAY::FACE_SCH, FRAME_FOOTPRINT_EDITOR, FRAME_GERBER, FRAME_PCB_DISPLAY3D, FRAME_PCB_EDITOR, FRAME_PL_EDITOR, FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, KIWAY::GetActions(), KIFACE_BASE::GetActions(), ADVANCED_CFG::GetCfg(), EDA_BASE_FRAME::GetFrameType(), PAGED_DIALOG::GetTreebook(), kiface(), KIWAY::KiFACE(), KIWAY_HOLDER::Kiway(), LAZY_CTOR, ADVANCED_CFG::m_EnableGit, TOOLS_HOLDER::m_toolManager, PANEL_3DV_DISPLAY_OPTIONS, PANEL_3DV_OPENGL, PANEL_3DV_RAYTRACING, PANEL_DS_COLORS, PANEL_DS_DISPLAY_OPTIONS, PANEL_DS_GRIDS, PANEL_FP_COLORS, PANEL_FP_DEFAULT_VALUES, PANEL_FP_DISPLAY_OPTIONS, PANEL_FP_EDIT_OPTIONS, PANEL_FP_GRIDS, PANEL_FP_ORIGINS_AXES, PANEL_GBR_COLORS, PANEL_GBR_DISPLAY_OPTIONS, PANEL_GBR_EXCELLON_OPTIONS, PANEL_PCB_ACTION_PLUGINS, PANEL_PCB_COLORS, PANEL_PCB_DISPLAY_OPTS, PANEL_PCB_EDIT_OPTIONS, PANEL_PCB_GRIDS, PANEL_PCB_ORIGINS_AXES, PANEL_SCH_ANNO_OPTIONS, PANEL_SCH_COLORS, PANEL_SCH_DISP_OPTIONS, PANEL_SCH_EDIT_OPTIONS, PANEL_SCH_FIELD_NAME_TEMPLATES, PANEL_SCH_GRIDS, PANEL_SYM_COLORS, PANEL_SYM_DISP_OPTIONS, PANEL_SYM_EDIT_GRIDS, PANEL_SYM_EDIT_OPTIONS, Pgm(), ReadHotKeyConfigIntoActions(), TOOL_BASE::REDRAW, TOOL_MANAGER::ResetTools(), and PAGED_DIALOG::SetInitialPage().

Referenced by COMMON_TOOLS::GridProperties(), EDA_BASE_FRAME::OnPreferences(), APPEARANCE_CONTROLS::onReadOnlySwatch(), and COMMON_CONTROL::OpenPreferences().

◆ SortLayersByFileExtension()

void GERBVIEW_FRAME::SortLayersByFileExtension ( )

◆ SortLayersByX2Attributes()

void GERBVIEW_FRAME::SortLayersByX2Attributes ( )

◆ StringFromValue() [1/2]

wxString UNITS_PROVIDER::StringFromValue ( const EDA_ANGLE aValue,
bool  aAddUnitLabel = false 
) const
inlineinherited

◆ StringFromValue() [2/2]

wxString UNITS_PROVIDER::StringFromValue ( double  aValue,
bool  aAddUnitLabel = false,
EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE 
) const
inlineinherited

Converts aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters
aValue= value in internal units
aAddUnitLabel= true to add symbol unit to the string value
aTypeis the type of this value, and controls the way the value is converted to a string, and the suitable unit
Returns
A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 81 of file units_provider.h.

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by DIALOG_PLOT::applyPlotSettings(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRAWING_TOOL::DrawSpecificationStackup(), VALIDATION_ERROR_TOO_LARGE< T >::Format(), VALIDATION_ERROR_TOO_SMALL< T >::Format(), DRC_TEST_PROVIDER::formatMsg(), PIN_TABLE_DATA_MODEL::GetValue(), FP_TEXT_GRID_TABLE::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), reportMax(), reportMin(), reportOpt(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), WX_GRID::SetUnitValue(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), PANEL_FP_EDITOR_DEFAULTS::TransferDataFromWindow(), PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ SwitchCanvas()

◆ syncLayerBox()

void GERBVIEW_FRAME::syncLayerBox ( bool  aRebuildLayerBox = false)

Update the currently "selected" layer within m_SelLayerBox.

The currently active layer, as defined by the return value of GetActiveLayer().

Parameters
aRebuildLayerBoxtrue to rebuild the layer box of false to just update the selection.

Definition at line 513 of file gerbview_frame.cpp.

References GetActiveLayer(), GetGbrImage(), m_DCodeSelector, GERBER_FILE_IMAGE::m_Selected_Tool, m_SelLayerBox, GBR_LAYER_BOX_SELECTOR::Resync(), DCODE_SELECTION_BOX::SetDCodeSelection(), and updateDCodeSelectBox().

Referenced by Clear_DrawLayers(), Erase_Current_DrawLayer(), GERBVIEW_CONTROL::HighlightControl(), LoadListOfGerberAndDrillFiles(), LoadZipArchiveFile(), GERBER_LAYER_WIDGET::OnLayerSelect(), OnSelectActiveLayer(), and RemapLayers().

◆ syncLayerWidget()

void GERBVIEW_FRAME::syncLayerWidget ( )

Update the currently "selected" layer within the GERBER_LAYER_WIDGET.

The currently active layer is defined by the return value of GetActiveLayer().

This function cannot be inline without including layer_widget.h in here and we do not want to do that.

Definition at line 507 of file gerbview_frame.cpp.

References GetActiveLayer(), m_LayersManager, and LAYER_WIDGET::SelectLayer().

Referenced by ReFillLayerWidget().

◆ sys_search()

const SEARCH_STACK & EDA_BASE_FRAME::sys_search ( )
virtualinherited

Return a SEARCH_STACK pertaining to entire program.

This is overloaded in KICAD_MANAGER_FRAME

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 863 of file eda_base_frame.cpp.

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

◆ ThemeChanged()

void EDA_BASE_FRAME::ThemeChanged ( )
virtualinherited

◆ ToggleLayerManager()

void GERBVIEW_FRAME::ToggleLayerManager ( )

◆ ToggleProperties()

virtual void EDA_DRAW_FRAME::ToggleProperties ( )
inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 400 of file eda_draw_frame.h.

◆ ToggleUserUnits()

void EDA_DRAW_FRAME::ToggleUserUnits ( )
overridevirtualinherited

◆ ToolStackIsEmpty()

◆ unarchiveFiles()

◆ unitsChangeRefresh()

void GERBVIEW_FRAME::unitsChangeRefresh ( )
overrideprivatevirtual

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.

The default version only updates the status bar. Don't forget to call the default in your derived class or the status bar will not get updated properly.

Reimplemented from EDA_BASE_FRAME.

Definition at line 996 of file gerbview_frame.cpp.

References EDA_DRAW_FRAME::unitsChangeRefresh(), updateDCodeSelectBox(), and EDA_DRAW_FRAME::UpdateGridSelectBox().

◆ UnregisterUIUpdateHandler() [1/2]

void TOOLS_HOLDER::UnregisterUIUpdateHandler ( const TOOL_ACTION aAction)
virtualinherited

Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.

Parameters
aActionis the action to unregister the handler for.

Definition at line 49 of file tools_holder.cpp.

References TOOL_ACTION::GetUIId(), and TOOLS_HOLDER::UnregisterUIUpdateHandler().

Referenced by ACTION_TOOLBAR::doSelectAction(), ACTION_MANAGER::SetConditions(), and TOOLS_HOLDER::UnregisterUIUpdateHandler().

◆ UnregisterUIUpdateHandler() [2/2]

void EDA_BASE_FRAME::UnregisterUIUpdateHandler ( int  aID)
overridevirtualinherited

Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler.

Parameters
aIDis the control ID to unregister the handler for

Reimplemented from TOOLS_HOLDER.

Definition at line 378 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::m_uiUpdateMap.

◆ updateAperAttributesSelectBox()

◆ updateComponentListSelectBox()

◆ updateDCodeSelectBox()

◆ UpdateFileHistory()

void EDA_BASE_FRAME::UpdateFileHistory ( const wxString &  FullFileName,
FILE_HISTORY aFileHistory = nullptr 
)
inherited

Update the list of recently opened files.

The menu is also updated, if FILE_HISTORY::UseMenu was called at init time.

Parameters
FullFileNameThe full file name including the path.
aFileHistoryThe FILE_HISTORY in use. If NULL, the main application file history is used.

Definition at line 958 of file eda_base_frame.cpp.

References FILE_HISTORY::AddFileToHistory(), EDA_BASE_FRAME::m_fileHistory, EDA_BASE_FRAME::m_isClosing, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by SCH_EDIT_FRAME::doCloseWindow(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), LoadGerberJobFile(), LoadListOfGerberAndDrillFiles(), BITMAP2CMP_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), EDA_BASE_FRAME::SaveSettings(), and unarchiveFiles().

◆ UpdateGridSelectBox()

◆ UpdateMsgPanel()

◆ updateNetnameListSelectBox()

◆ UpdateProperties()

◆ UpdateStatusBar()

void GERBVIEW_FRAME::UpdateStatusBar ( )
overridevirtual

Update the status bar information.

The status bar can draw itself. This is not a drawing function per se, but rather updates lines of text held by the components within the status bar which is owned by the wxFrame.

Reimplemented from EDA_BASE_FRAME.

Definition at line 938 of file gerbview_frame.cpp.

References DisplayGridMsg(), EDA_DRAW_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), EDA_DRAW_FRAME::GetScreen(), EDA_DRAW_FRAME::GetShowPolarCoords(), EDA_DRAW_PANEL_GAL::GetViewControls(), BASE_SCREEN::m_LocalOrigin, UNITS_PROVIDER::MessageTextFromValue(), EDA_DRAW_FRAME::UpdateStatusBar(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ UpdateTitleAndInfo()

void GERBVIEW_FRAME::UpdateTitleAndInfo ( )

Display the short filename (if exists) of the selected layer on the caption of the main GerbView window and some other parameters.

  • Name of the layer (found in the gerber file: LN &ltname&gt command) in the status bar
  • Name of the Image (found in the gerber file: IN &ltname&gt command) in the status bar and other data in toolbar

Definition at line 639 of file gerbview_frame.cpp.

References _, EDA_DRAW_FRAME::ClearMsgPanel(), GERBER_FILE_IMAGE::DisplayImageInfo(), KIUI::EnsureTextCtrlWidth(), GetActiveLayer(), GetGbrImage(), GERBER_FILE_IMAGE::GetLayerParams(), info, EDA_BASE_FRAME::m_auimgr, GERBER_FILE_IMAGE::m_FileName, GERBER_FILE_IMAGE::m_FmtLen, GERBER_FILE_IMAGE::m_FmtScale, GERBER_FILE_IMAGE::m_GerbMetric, GERBER_FILE_IMAGE::m_ImageName, GERBER_FILE_IMAGE::m_IsX2_file, GERBER_LAYER::m_LayerName, GERBER_FILE_IMAGE::m_NoTrailingZeros, and m_TextInfo.

Referenced by SetActiveLayer().

◆ UpdateToolbarControlSizes()

◆ UpdateXORLayers()

◆ UpdateZoomSelectBox()

◆ ValueFromString()

int UNITS_PROVIDER::ValueFromString ( const wxString &  aTextValue,
EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE 
) const
inlineinherited

◆ windowClosing()

void EDA_BASE_FRAME::windowClosing ( wxCloseEvent &  event)
privateinherited

(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().

SaveSettings() is called for all derived wxFrames in this base class overload. Calling it from a destructor is deprecated since the wxFrame's position is not available in the destructor on linux. In other words, you should not need to call SaveSettings() anywhere, except in this one function found only in this class.

Definition at line 211 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::canCloseWindow(), EDA_BASE_FRAME::config(), WX_INFOBAR::Dismiss(), EDA_BASE_FRAME::doCloseWindow(), EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::IsModal(), EDA_BASE_FRAME::m_infoBar, EDA_BASE_FRAME::m_isClosing, EDA_BASE_FRAME::m_isNonUserClose, and EDA_BASE_FRAME::SaveSettings().

Referenced by EDA_BASE_FRAME::commonInit().

◆ Zoom_Automatique()

Member Data Documentation

◆ KICAD_AUI_TB_STYLE

◆ m_aboutTitle

◆ m_acceptedExts

std::map<const wxString, TOOL_ACTION*> EDA_BASE_FRAME::m_acceptedExts
protectedinherited

Associates files extensions with action to execute.

Definition at line 788 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::DoWithAcceptedFiles(), DoWithAcceptedFiles(), KICAD_MANAGER_FRAME::DoWithAcceptedFiles(), GERBVIEW_FRAME(), and EDA_BASE_FRAME::OnDropFiles().

◆ m_AcceptedFiles

std::vector<wxFileName> EDA_BASE_FRAME::m_AcceptedFiles
protectedinherited

◆ m_actions

◆ m_activeLayer

int GERBVIEW_FRAME::m_activeLayer
private

Definition at line 548 of file gerbview_frame.h.

Referenced by GetActiveLayer(), and SetActiveLayer().

◆ m_apertText

wxStaticText* GERBVIEW_FRAME::m_apertText
private

Definition at line 555 of file gerbview_frame.h.

Referenced by GERBVIEW_FRAME(), and ReCreateAuxiliaryToolbar().

◆ m_appearancePanel

◆ m_auimgr

wxAuiManager EDA_BASE_FRAME::m_auimgr
protectedinherited

Definition at line 751 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::CreateInfoBar(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), SCH_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::doCloseWindow(), EDA_BASE_FRAME::FinishAUIInitialization(), GERBVIEW_FRAME(), FOOTPRINT_EDIT_FRAME::IsSearchTreeShown(), SYMBOL_EDIT_FRAME::IsSymbolTreeShown(), PCB_EDIT_FRAME::LayerManagerShown(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnResizeHierarchyNavigator(), SCH_EDIT_FRAME::onResizeNetNavigator(), SYMBOL_VIEWER_FRAME::OnSize(), KICAD_MANAGER_FRAME::OnSize(), FOOTPRINT_VIEWER_FRAME::OnSize(), FOOTPRINT_WIZARD_FRAME::OnSize(), SYMBOL_EDIT_FRAME::OnToggleSymbolTree(), EDA_DRAW_FRAME::OnToolbarSizeChanged(), KICAD_MANAGER_FRAME::onToolbarSizeChanged(), PCB_EDIT_FRAME::PropertiesShown(), ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), KICAD_MANAGER_FRAME::RecreateBaseHToolbar(), CVPCB_MAINFRAME::ReCreateHToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), SYMBOL_EDIT_FRAME::ReCreateHToolbar(), SYMBOL_VIEWER_FRAME::ReCreateHToolbar(), ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), EDA_3D_VIEWER_FRAME::ReCreateMainToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_FRAME::ReCreateOptToolbar(), ReCreateOptToolbar(), PL_EDITOR_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateVToolbar(), SYMBOL_EDIT_FRAME::ReCreateVToolbar(), PL_EDITOR_FRAME::ReCreateVToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateVToolbar(), PCB_EDIT_FRAME::ReCreateVToolbar(), ReFillLayerWidget(), CVPCB_MAINFRAME::refreshAfterSymbolSearch(), SCH_EDIT_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), FOOTPRINT_WIZARD_FRAME::SaveSettings(), PCB_EDIT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveWindowSettings(), PCB_BASE_FRAME::SetDrawBgColor(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), ShowChangedLanguage(), FOOTPRINT_EDIT_FRAME::ShowChangedLanguage(), PCB_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), EDA_BASE_FRAME::ThemeChanged(), EDA_3D_VIEWER_FRAME::ToggleAppearanceManager(), ToggleLayerManager(), FOOTPRINT_EDIT_FRAME::ToggleLayersManager(), PCB_EDIT_FRAME::ToggleLayersManager(), SCH_EDIT_FRAME::ToggleNetNavigator(), SCH_EDIT_FRAME::ToggleProperties(), SYMBOL_EDIT_FRAME::ToggleProperties(), PCB_BASE_EDIT_FRAME::ToggleProperties(), SCH_EDIT_FRAME::ToggleSchematicHierarchy(), SCH_EDIT_FRAME::ToggleSearch(), PCB_EDIT_FRAME::ToggleSearch(), FOOTPRINT_EDIT_FRAME::ToggleSearchTree(), updateDCodeSelectBox(), UpdateTitleAndInfo(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), and KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME().

◆ m_autoSavePending

bool EDA_BASE_FRAME::m_autoSavePending
protectedinherited

◆ m_autoSaveRequired

◆ m_autoSaveTimer

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer
protectedinherited

◆ m_auxiliaryToolBar

◆ m_canvas

◆ m_canvasType

◆ m_cmpText

wxStaticText* GERBVIEW_FRAME::m_cmpText
private

Definition at line 551 of file gerbview_frame.h.

Referenced by GERBVIEW_FRAME(), and ReCreateAuxiliaryToolbar().

◆ m_colorSettings

◆ m_configName

wxString EDA_BASE_FRAME::m_configName
protectedinherited

Definition at line 755 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::ConfigBaseName().

◆ m_currentScreen

BASE_SCREEN* EDA_DRAW_FRAME::m_currentScreen
privateinherited

current used SCREEN

Definition at line 568 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::GetScreen(), EDA_DRAW_FRAME::SetScreen(), and EDA_DRAW_FRAME::~EDA_DRAW_FRAME().

◆ m_DCodeSelector

◆ m_dcodeText

wxStaticText* GERBVIEW_FRAME::m_dcodeText
private

Definition at line 557 of file gerbview_frame.h.

Referenced by GERBVIEW_FRAME(), and ReCreateAuxiliaryToolbar().

◆ m_displayIndex

int EDA_BASE_FRAME::m_displayIndex
protectedinherited

Definition at line 743 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::LoadWindowState(), and EDA_BASE_FRAME::OnSize().

◆ m_displayMode

int GERBVIEW_FRAME::m_displayMode
private

Definition at line 535 of file gerbview_frame.h.

Referenced by GERBVIEW_FRAME(), GetDisplayMode(), and SetDisplayMode().

◆ m_dragAction

MOUSE_DRAG_ACTION TOOLS_HOLDER::m_dragAction
protectedinherited

◆ m_drawBgColor

COLOR4D EDA_DRAW_FRAME::m_drawBgColor
protectedinherited

◆ m_drawToolBar

◆ m_drillFileHistory

◆ m_dummySelection

SELECTION TOOLS_HOLDER::m_dummySelection
protectedinherited

Definition at line 169 of file tools_holder.h.

Referenced by TOOLS_HOLDER::GetCurrentSelection().

◆ m_file_checker

std::unique_ptr<LOCKFILE> EDA_DRAW_FRAME::m_file_checker
protectedinherited

◆ m_fileHistory

◆ m_findReplaceData

◆ m_findStringHistoryList

◆ m_framePos

wxPoint EDA_BASE_FRAME::m_framePos
protectedinherited

◆ m_frameSize

◆ m_galDisplayOptions

◆ m_gerberLayout

◆ m_grid_origin

VECTOR2I GERBVIEW_FRAME::m_grid_origin
private

Definition at line 549 of file gerbview_frame.h.

Referenced by GetGridOrigin(), and SetGridOrigin().

◆ m_gridColor

COLOR4D EDA_DRAW_FRAME::m_gridColor
protectedinherited

◆ m_gridSelectBox

◆ m_hotkeyPopup

HOTKEY_CYCLE_POPUP* EDA_DRAW_FRAME::m_hotkeyPopup
protectedinherited

The current canvas type.

Definition at line 559 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::CreateHotkeyPopup(), and EDA_DRAW_FRAME::GetHotkeyPopup().

◆ m_ident

◆ m_immediateActions

bool TOOLS_HOLDER::m_immediateActions
protectedinherited

◆ m_infoBar

◆ m_isClosing

◆ m_isNonUserClose

bool EDA_BASE_FRAME::m_isNonUserClose
protectedinherited

◆ m_iuScale

const EDA_IU_SCALE& UNITS_PROVIDER::m_iuScale
privateinherited

Definition at line 147 of file units_provider.h.

Referenced by UNITS_PROVIDER::GetIuScale().

◆ m_jobFileHistory

FILE_HISTORY GERBVIEW_FRAME::m_jobFileHistory
protected

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway
privateinherited

◆ m_lastFileName

wxString GERBVIEW_FRAME::m_lastFileName
protected

Definition at line 531 of file gerbview_frame.h.

Referenced by LoadListOfGerberAndDrillFiles().

◆ m_lastToolbarIconSize

int EDA_DRAW_FRAME::m_lastToolbarIconSize
privateinherited

◆ m_LayersManager

◆ m_mainToolBar

◆ m_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault
protectedinherited

Definition at line 742 of file eda_base_frame.h.

Referenced by GERBVIEW_FRAME(), and EDA_BASE_FRAME::LoadWindowState().

◆ m_messagePanel

◆ m_modal

bool KIWAY_PLAYER::m_modal
protectedinherited

Definition at line 192 of file kiway_player.h.

Referenced by KIWAY_PLAYER::IsModal(), and KIWAY_PLAYER::SetModal().

◆ m_modal_loop

WX_EVENT_LOOP* KIWAY_PLAYER::m_modal_loop
protectedinherited

< Points to nested event_loop. NULL means not modal and dismissed.

Definition at line 195 of file kiway_player.h.

Referenced by KIWAY_PLAYER::DismissModal(), KIWAY_PLAYER::IsDismissed(), and KIWAY_PLAYER::ShowModal().

◆ m_modal_resultant_parent

wxWindow* KIWAY_PLAYER::m_modal_resultant_parent
protectedinherited

Definition at line 196 of file kiway_player.h.

Referenced by KIWAY_PLAYER::ShowModal().

◆ m_modal_ret_val

bool KIWAY_PLAYER::m_modal_ret_val
protectedinherited

◆ m_modal_string

wxString KIWAY_PLAYER::m_modal_string
protectedinherited

Definition at line 197 of file kiway_player.h.

Referenced by KIWAY_PLAYER::DismissModal(), and KIWAY_PLAYER::ShowModal().

◆ m_moveWarpsCursor

bool TOOLS_HOLDER::m_moveWarpsCursor
protectedinherited

◆ m_mruPath

◆ m_msgFrameHeight

int EDA_DRAW_FRAME::m_msgFrameHeight
protecte