KiCad PCB EDA Suite
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

Public Types

enum  UNDO_REDO_LIST { UNDO_LIST, REDO_LIST }
 Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. 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, const std::vector< int > *aFileType=nullptr)
 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 ReCreateMenuBar () override
 Recreates the menu bar. 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...
 
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, COLOR4D aColor)
 
COLOR4D GetLayerColor (int aLayer) const
 
void SetLayerColor (int aLayer, COLOR4D aColor)
 
COLOR4D GetNegativeItemsColor ()
 This is usually the background color, but can be another color in order to see negative objects. More...
 
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 (int aLayer=0) const
 Find the next empty layer starting at aLayer and returns it to the caller. 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...
 
void ToggleLayerManager ()
 
void ShowChangedLanguage () override
 Redraw the menus and what not in current language. More...
 
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 LoadGerberFiles (const wxString &aFileName)
 Load a photoplot (Gerber) file or many files. 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 SortLayersByX2Attributes ()
 
void UpdateDisplayOptions (const GBR_DISPLAY_OPTIONS &aOptions)
 Update the display options and refreshes the view as needed. 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 InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
 Allow Gerbview to install its preferences panels into the preferences dialog. 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...
 
const GBR_DISPLAY_OPTIONSGetDisplayOptions () const
 
void SetDisplayOptions (const GBR_DISPLAY_OPTIONS &aOptions)
 
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 wxSize GetPageSizeIU () const override
 Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view. More...
 
const wxPoint & GetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
int SelectPCBLayer (int aDefaultLayer, int aCopperLayerCount, wxString aGerberName)
 Show the dialog box for layer selection. More...
 
COLOR4D GetGridColor () override
 
virtual void SetGridColor (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...
 
wxFindReplaceData & GetFindReplaceData ()
 
wxArrayString & GetFindHistoryList ()
 
bool GetShowPolarCoords () const
 For those frames that support polar coordinates. More...
 
void SetShowPolarCoords (bool aShow)
 
void ToggleUserUnits () override
 
void GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
 Get the pair or units in current use. More...
 
wxPoint GetNearestGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize location to aPosition. More...
 
wxPoint GetNearestHalfGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize / 2 location to aPosition. More...
 
virtual ORIGIN_TRANSFORMSGetOriginTransforms ()
 Return a reference to the default ORIGIN_TRANSFORMS object. More...
 
virtual COLOR4D GetDrawBgColor () const
 
virtual void SetDrawBgColor (COLOR4D aColor)
 
virtual COLOR_SETTINGSGetColorSettings () const
 Returns a pointer to the active color theme settings. More...
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
 
virtual wxString GetScreenDesc () const
 
virtual BASE_SCREENGetScreen () const
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242). More...
 
void EraseMsgBox ()
 
bool IsGridVisible () const
 
void OnSelectGrid (wxCommandEvent &event)
 Command event handler for selecting grid sizes. More...
 
void OnGridSettings (wxCommandEvent &event)
 
void UpdateGridSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.). More...
 
void OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
 Update the checked item in the grid combobox. More...
 
void UpdateZoomSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
 
void OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
 Update the checked item in the zoom combobox. More...
 
const wxString GetZoomLevelIndicator () const
 Return a human readable value for display in dialogs. More...
 
virtual void OnSelectZoom (wxCommandEvent &event)
 Set the zoom factor when selected by the zoom list box in the main tool bar. More...
 
virtual void OnSize (wxSizeEvent &event)
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
void OnMove (wxMoveEvent &aEvent) override
 
virtual void HardRedraw ()
 Rebuild the GAL and redraws the screen. More...
 
virtual void Zoom_Automatique (bool aWarpPointer)
 Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...
 
void FocusOnLocation (const wxPoint &aPos)
 Useful to focus on a particular location, in find functions. More...
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g. More...
 
void PrintDrawingSheet (const RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
 Prints the drawing-sheet (frame and title block). More...
 
void DisplayToolMsg (const wxString &msg) override
 
virtual void OnPageSettingsChange ()
 Called when modifying the page settings. More...
 
void DisplayUnitsMsg ()
 Display current unit pane in the status bar. More...
 
void CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
void AppendMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
 Append a message to the message panel. More...
 
virtual void ClearMsgPanel ()
 Clear all messages from the message panel. More...
 
void SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
 Clear the message panel and populates it with the contents of aList. More...
 
void SetMsgPanel (EDA_ITEM *aItem)
 
void SetMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
 Helper function that erases the msg panel and then appends a single message. More...
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. More...
 
virtual 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...
 
KIGFX::GAL_DISPLAY_OPTIONSGetGalDisplayOptions ()
 Return a reference to the gal rendering options used by GAL for rendering. More...
 
void RefreshCanvas () override
 
void RecreateToolbars ()
 Rebuild all toolbars, and update the checked state of check tools. More...
 
virtual void ParseArgs (wxCmdLineParser &aParser)
 Handle command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=nullptr, wxWindow *aResultantFocusWindow=nullptr)
 Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...
 
virtual void KiwayMailIn (KIWAY_EXPRESS &aEvent)
 Receive KIWAY_EXPRESS messages from other players. More...
 
bool Destroy () override
 Our version of Destroy() which is virtual from wxWidgets. More...
 
bool IsModal () const override
 Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame. More...
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
EDA_UNITS GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS aUnits)
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
SETTINGS_MANAGERGetSettingsManager () const
 
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 &event)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
virtual void RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
 Register a UI update handler for the control with ID aID. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
 Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...
 
virtual void UnregisterUIUpdateHandler (int aID) override
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
virtual const SEARCH_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program. More...
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 
void PrintMsg (const wxString &text)
 
void CreateInfoBar ()
 
void FinishAUIInitialization ()
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false)
 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 SaveProjectSettings ()
 Save changes to the project settings to the project (.pro) file. More...
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
 Fetches the file name from the file history list. More...
 
void ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
 Removes all files from the file history. More...
 
void UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
 Update the list of recently opened files. More...
 
FILE_HISTORYGetFileHistory ()
 Get the frame's main file history. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
virtual wxString GetCurrentFileName () const
 Get the full filename + path of the currently opened file in the frame. More...
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void ThemeChanged ()
 Process light/dark theme change. More...
 
virtual void ProjectChanged ()
 Notification event that the project has changed. More...
 
const wxString & GetAboutTitle () const
 
virtual bool IsContentModified ()
 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)
 
virtual void ClearUndoRedoList ()
 Clear the undo and redo list using ClearUndoORRedoList() More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Add a command to undo in the undo list. More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Add a command to redo in the redo list. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual int GetUndoCommandCount () const
 
virtual int GetRedoCommandCount () const
 
int GetMaxUndoItems () const
 
bool NonUserClose (bool aForce)
 
virtual void HandleSystemColorChange ()
 Update the UI in response to a change in the system colors. More...
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual void PushTool (const std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
bool GetDoImmediateActions () const
 Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...
 
MOUSE_DRAG_ACTION GetDragAction () const
 Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...
 
bool GetMoveWarpsCursor () const
 Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

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

Public Attributes

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

Protected Member Functions

void setupUIConditions () override
 Setup the UI conditions for the various actions and their controls in this frame. More...
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void setupUnits (APP_SETTINGS_BASE *aCfg)
 
void resolveCanvasType ()
 Determines the Canvas type to load (with prompt if required) and initializes m_canvasType. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
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 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...
 

Static Protected Member Functions

static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

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

Static Protected Attributes

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

Private Member Functions

void 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 setupTools ()
 
void applyDisplaySettingsToGAL ()
 Updates the GAL with display settings changes. More...
 

Private Attributes

int m_displayMode
 
bool m_show_layer_manager_tools
 
GBR_LAYOUTm_gerberLayout
 
int m_activeLayer
 
wxPoint m_grid_origin
 
PAGE_INFO m_paper
 
GBR_DISPLAY_OPTIONS m_DisplayOptions
 
wxStaticText * m_cmpText
 
wxStaticText * m_netText
 
wxStaticText * m_apertText
 
wxStaticText * m_dcodeText
 

Detailed Description

Definition at line 55 of file gerbview_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

◆ UNDO_REDO_LIST

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.
Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 524 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ GERBVIEW_FRAME()

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

Definition at line 67 of file gerbview_frame.cpp.

68  : EDA_DRAW_FRAME( aKiway, aParent, FRAME_GERBER, wxT( "GerbView" ), wxDefaultPosition,
70  m_TextInfo( nullptr ),
72  ID_GERBVIEW_ZIP_FILE_LIST_CLEAR, _( "Clear Recent Zip Files" ) ),
74  ID_GERBVIEW_DRILL_FILE_LIST_CLEAR, _( "Clear Recent Drill Files" ) ),
76  ID_GERBVIEW_JOB_FILE_LIST_CLEAR, _( "Clear Recent Job Files" ) ),
77  m_activeLayer( 0 )
78 {
79  m_maximizeByDefault = true;
80  m_gerberLayout = nullptr;
82  m_showBorderAndTitleBlock = false; // true for reference drawings.
83  m_SelLayerBox = nullptr;
84  m_DCodeSelector = nullptr;
85  m_SelComponentBox = nullptr;
86  m_SelNetnameBox = nullptr;
87  m_SelAperAttributesBox = nullptr;
88  m_cmpText = nullptr;
89  m_netText = nullptr;
90  m_apertText = nullptr;
91  m_dcodeText = nullptr;
92  m_displayMode = 0;
93  m_aboutTitle = _( "KiCad Gerber Viewer" );
94 
95  SHAPE_POLY_SET dummy; // A ugly trick to force the linker to include
96  // some methods in code and avoid link errors
97 
98  int fileHistorySize = Pgm().GetCommonSettings()->m_System.file_history_size;
99  m_drillFileHistory.SetMaxFiles( fileHistorySize );
100  m_zipFileHistory.SetMaxFiles( fileHistorySize );
101  m_jobFileHistory.SetMaxFiles( fileHistorySize );
102 
103  auto* galCanvas = new GERBVIEW_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
106 
107  SetCanvas( galCanvas );
108 
109  // GerbView requires draw priority for rendering negative objects
110  galCanvas->GetView()->UseDrawPriority( true );
111 
112  // Give an icon
113  wxIcon icon;
114  wxIconBundle icon_bundle;
115 
116  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview ) );
117  icon_bundle.AddIcon( icon );
118  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview_32 ) );
119  icon_bundle.AddIcon( icon );
120  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview_16 ) );
121  icon_bundle.AddIcon( icon );
122 
123  SetIcons( icon_bundle );
124 
125  // Be sure a page info is set. this default value will be overwritten later.
126  PAGE_INFO pageInfo( wxT( "GERBER" ) );
127  SetLayout( new GBR_LAYOUT() );
128  SetPageSettings( pageInfo );
129 
130  SetVisibleLayers( LSET::AllLayersMask() ); // All draw layers visible.
131 
132  SetScreen( new BASE_SCREEN( GetPageSettings().GetSizeIU() ) );
133 
134  // Create the PCB_LAYER_WIDGET *after* SetLayout():
136 
137  // Update the minimum string length in the layer panel with the length of the last default layer
138  wxString lyrName = GetImagesList()->GetDisplayName( GetImagesList()->ImagesMaxCount(), false, true );
140 
141  // LoadSettings() *after* creating m_LayersManager, because LoadSettings()
142  // initialize parameters in m_LayersManager
143  LoadSettings( config() );
144 
145  setupTools();
147  ReCreateMenuBar();
151 
152  m_auimgr.SetManagedWindow( this );
153 
154  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer( 6 ) );
155  m_auimgr.AddPane( m_auxiliaryToolBar, EDA_PANE().HToolbar().Name( "AuxToolbar" ).Top()
156  .Layer(4) );
157  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom()
158  .Layer( 6 ) );
159  m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" ).Left()
160  .Layer( 3 ) );
161  m_auimgr.AddPane( m_LayersManager, EDA_PANE().Palette().Name( "LayersManager" ).Right()
162  .Layer( 3 ).Caption( _( "Layers Manager" ) ).PaneBorder( false )
163  .MinSize( 80, -1 ).BestSize( m_LayersManager->GetBestSize() ) );
164 
165  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
166 
167  m_auimgr.GetArtProvider()->SetColour( wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR,
168  wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT ) );
169  m_auimgr.GetArtProvider()->SetColour( wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR,
170  wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT ) );
171 
172  ReFillLayerWidget(); // this is near end because contents establish size
173  m_auimgr.Update();
174 
175  SetActiveLayer( 0, true );
177 
179 
181 
182  setupUnits( config() );
183 
184  // Enable the axes to match legacy draw style
185  auto& galOptions = GetGalDisplayOptions();
186  galOptions.m_axesEnabled = true;
187  galOptions.NotifyChanged();
188 
190  m_LayersManager->ReFillRender(); // Update colors in Render after the config is read
191 
193 
194  // Ensure the window is on top
195  Raise();
196 
197  // Register a call to update the toolbar sizes. It can't be done immediately because
198  // it seems to require some sizes calculated that aren't yet (at least on GTK).
199  CallAfter( [&]()
200  {
201  // Ensure the controls on the toolbars all are correctly sized
203  } );
204 }
A list of GERBER_DRAW_ITEM objects currently loaded.
Definition: gbr_layout.h:45
wxSize GetBestSize() const
Function GetBestSize returns the preferred minimum size, taking into consideration the dynamic conten...
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
ACTION_TOOLBAR * m_auxiliaryToolBar
ACTION_TOOLBAR * m_optionsToolBar
virtual void SetScreen(BASE_SCREEN *aScreen)
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
FILE_HISTORY m_jobFileHistory
void SetPageSettings(const PAGE_INFO &aPageSettings) override
GERBER_LAYER_WIDGET * m_LayersManager
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetActiveLayer(int aLayer, bool doLayerWidgetUpdate=true)
change the currently active layer to aLayer and update the GERBER_LAYER_WIDGET.
static TOOL_ACTION zoomFitScreen
Definition: actions.h:99
GBR_LAYER_BOX_SELECTOR * m_SelLayerBox
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
void resolveCanvasType()
Determines the Canvas type to load (with prompt if required) and initializes m_canvasType.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: sch_symbol.cpp:69
wxAuiManager m_auimgr
ACTION_TOOLBAR * m_mainToolBar
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void SetSmallestLayerString(const wxString &aString)
Set the string that is used for determining the smallest string displayed in the layer's tab.
Definition: layer_widget.h:279
wxChoice * m_SelNetnameBox
EDA_DRAW_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
void UpdateToolbarControlSizes() override
Update the sizes of any controls in the toolbars of the frame.
void ReCreateHToolbar() override
FILE_HISTORY m_zipFileHistory
unsigned ImagesMaxCount() const
The max number of file images.
void ReCreateAuxiliaryToolbar() override
Represent a set of closed polygons.
EDA_MSG_PANEL * m_messagePanel
GAL not used (the legacy wxDC engine is used)
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:53
bool m_showBorderAndTitleBlock
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:40
GBR_LAYOUT * m_gerberLayout
static LSET AllLayersMask()
Definition: lset.cpp:787
GERBER_LAYER_WIDGET is here to implement the abtract functions of LAYER_WIDGET so they may be tied in...
#define KICAD_DEFAULT_DRAWFRAME_STYLE
FILE_HISTORY m_drillFileHistory
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
#define GERBVIEW_FRAME_NAME
The main window used in GerbView.
Specialization of the wxAuiPaneInfo class for KiCad panels.
wxTextCtrl * m_TextInfo
DCODE_SELECTION_BOX * m_DCodeSelector
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
const PAGE_INFO & GetPageSettings() const override
void SetMaxFiles(size_t aMaxFiles)
Update the number of files that will be contained inside the file history.
Definition: filehistory.cpp:85
wxStaticText * m_cmpText
wxChoice * m_SelAperAttributesBox
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Changes the current rendering backend.
#define _(s)
Definition: 3d_actions.cpp:33
void setupUnits(APP_SETTINGS_BASE *aCfg)
#define DEFAULT_FILE_HISTORY_SIZE
IDs range for menuitems file history: The default range file history size is 9 (compatible with defau...
Definition: id.h:69
wxStaticText * m_dcodeText
wxChoice * m_SelComponentBox
wxStaticText * m_netText
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
void ReFillRender()
Function ReFillRender Rebuild Render for instance after the config is read.
bool m_show_layer_manager_tools
void ReCreateMenuBar() override
Recreates the menu bar.
wxStaticText * m_apertText
void SetLayout(GBR_LAYOUT *aLayout)
Set the m_gerberLayout member in such as way as to ensure deleting any previous GBR_LAYOUT.
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data.
const wxString GetDisplayName(int aIdx, bool aNameOnly=false, bool aFullName=false)
Get the display name for the layer at aIdx.
void ReFillLayerWidget()
Change out all the layers in m_Layers; called upon loading new gerber files.
wxString m_aboutTitle
wxBitmap KiBitmap(BITMAPS aBitmap)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:104
void ReCreateOptToolbar() override
Create or update the left vertical toolbar (option toolbar)

References _, LSET::AllLayersMask(), PCAD2KICAD::Center, EDA_BASE_FRAME::config(), dummy(), EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, LAYER_WIDGET::GetBestSize(), EDA_DRAW_FRAME::GetCanvas(), GERBER_FILE_IMAGE_LIST::GetDisplayName(), EDA_DRAW_FRAME::GetGalDisplayOptions(), GetImagesList(), GetPageSettings(), TOOLS_HOLDER::GetToolManager(), icon_gerbview, icon_gerbview_16, icon_gerbview_32, ImagesMaxCount(), KiBitmap(), PCAD2KICAD::Left, LoadSettings(), EDA_BASE_FRAME::m_aboutTitle, 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(), ReCreateAuxiliaryToolbar(), ReCreateHToolbar(), ReCreateMenuBar(), ReCreateOptToolbar(), GERBER_LAYER_WIDGET::ReFill(), ReFillLayerWidget(), GERBER_LAYER_WIDGET::ReFillRender(), EDA_DRAW_FRAME::resolveCanvasType(), PCAD2KICAD::Right, 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()

GERBVIEW_FRAME::~GERBVIEW_FRAME ( )

Definition at line 207 of file gerbview_frame.cpp.

208 {
209  // Shutdown all running tools
210  if( m_toolManager )
212 
213  GetCanvas()->GetView()->Clear();
214 
216  delete m_gerberLayout;
217 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
void DeleteAllImages()
Remove all loaded data in list, and delete all images, freeing the memory.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void Clear()
Remove all items from the view.
Definition: view.cpp:1091
GBR_LAYOUT * m_gerberLayout
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
GBR_LAYOUT * GetGerberLayout() const
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Definition: gbr_layout.cpp:41

References KIGFX::VIEW::Clear(), GERBER_FILE_IMAGE_LIST::DeleteAllImages(), EDA_DRAW_FRAME::GetCanvas(), GetGerberLayout(), GBR_LAYOUT::GetImagesList(), EDA_DRAW_PANEL_GAL::GetView(), m_gerberLayout, TOOLS_HOLDER::m_toolManager, and TOOL_MANAGER::ShutdownAllTools().

Member Function Documentation

◆ ActivateGalCanvas()

void GERBVIEW_FRAME::ActivateGalCanvas ( )
overridevirtual

Use to start up the GAL drawing canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 979 of file gerbview_frame.cpp.

980 {
982 
983  EDA_DRAW_PANEL_GAL* galCanvas = GetCanvas();
984 
985  if( m_toolManager )
986  {
988  GetCanvas()->GetViewControls(), config(), this );
990  }
991 
993 
995 
996  galCanvas->GetView()->RecacheAllItems();
997  galCanvas->SetEventDispatcher( m_toolDispatcher );
998  galCanvas->StartDrawing();
999 
1002 
1004  ReCreateMenuBar();
1005 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
void SetPageSettings(const PAGE_INFO &aPageSettings) override
GERBER_LAYER_WIDGET * m_LayersManager
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void RecacheAllItems()
Rebuild GAL display lists.
Definition: view.cpp:1380
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Reset all tools (i.e.
GBR_LAYOUT * m_gerberLayout
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
virtual void ActivateGalCanvas()
Use to start up the GAL drawing canvas.
void StartDrawing()
Begin drawing if it was stopped previously.
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:159
const PAGE_INFO & GetPageSettings() const override
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, APP_SETTINGS_BASE *aSettings, TOOLS_HOLDER *aFrame)
Set the work environment (model, view, view controls and the parent window).
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
COLOR4D GetLayerColor(int aLayer) const
void ReFillRender()
Function ReFillRender Rebuild Render for instance after the config is read.
void ReCreateMenuBar() override
Recreates the menu bar.
Rendering engine changes.
Definition: tool_base.h:82
void ReCreateOptToolbar() override
Create or update the left vertical toolbar (option toolbar)

References EDA_DRAW_FRAME::ActivateGalCanvas(), EDA_BASE_FRAME::config(), TOOL_BASE::GAL_SWITCH, EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), GetLayerColor(), GetPageSettings(), EDA_DRAW_PANEL_GAL::GetView(), LAYER_GERBVIEW_GRID, m_gerberLayout, m_LayersManager, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, KIGFX::VIEW::RecacheAllItems(), ReCreateMenuBar(), ReCreateOptToolbar(), GERBER_LAYER_WIDGET::ReFill(), GERBER_LAYER_WIDGET::ReFillRender(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::SetEnvironment(), EDA_DRAW_PANEL_GAL::SetEventDispatcher(), KIGFX::GAL::SetGridColor(), SetPageSettings(), and EDA_DRAW_PANEL_GAL::StartDrawing().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 417 of file eda_base_frame.cpp.

418 {
419  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
420  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
421 
422  helpMenu->Add( ACTIONS::help );
423  helpMenu->Add( ACTIONS::gettingStarted );
424  helpMenu->Add( ACTIONS::listHotKeys );
425  helpMenu->Add( ACTIONS::getInvolved );
426  helpMenu->Add( ACTIONS::donate );
427  helpMenu->Add( ACTIONS::reportBug );
428 
429  helpMenu->AppendSeparator();
430  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
431 
432  aMenuBar->Append( helpMenu, _( "&Help" ) );
433 }
static TOOL_ACTION listHotKeys
Definition: actions.h:180
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:47
static TOOL_ACTION reportBug
Cursor control event types.
Definition: actions.h:183
static TOOL_ACTION donate
Definition: actions.h:181
Handle actions that are shared between different applications.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:179
static TOOL_ACTION getInvolved
Definition: actions.h:182
static TOOL_ACTION gettingStarted
Definition: actions.h:178

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

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

zoom and grid).

Definition at line 443 of file eda_draw_frame.cpp.

444 {
445  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
446  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
447 
448  aMenu.AddSeparator( 1000 );
449 
450  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
451  zoomMenu->SetTool( commonTools );
452  aToolMenu.AddSubMenu( zoomMenu );
453 
454  auto gridMenu = std::make_shared<GRID_MENU>( this );
455  gridMenu->SetTool( commonTools );
456  aToolMenu.AddSubMenu( gridMenu );
457 
458  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
459  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
460 }
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:46
Handles action that are shared between different applications.
Definition: common_tools.h:37
void AddSeparator(int aOrder=ANY_ORDER)
Add a separator to the menu.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157

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

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

◆ AppendMsgPanel()

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

Append a message to the message panel.

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

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

Definition at line 594 of file eda_draw_frame.cpp.

596 {
597  if( m_messagePanel )
598  m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
599 }
EDA_MSG_PANEL * m_messagePanel
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, int aPadding=6)
Function AppendMessage appends a message to the message panel.
Definition: msgpanel.cpp:119

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

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

◆ applyDisplaySettingsToGAL()

void GERBVIEW_FRAME::applyDisplaySettingsToGAL ( )
private

Updates the GAL with display settings changes.

Definition at line 453 of file gerbview_frame.cpp.

454 {
455  auto painter = static_cast<KIGFX::GERBVIEW_PAINTER*>( GetCanvas()->GetView()->GetPainter() );
456  KIGFX::GERBVIEW_RENDER_SETTINGS* settings = painter->GetSettings();
459 
461 }
SETTINGS_MANAGER * GetSettingsManager() const
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:574
GBR_DISPLAY_OPTIONS m_DisplayOptions
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
GERBVIEW_RENDER_SETTINGS Stores GerbView specific render settings.
void LoadColors(const COLOR_SETTINGS *aSettings) override
void LoadDisplayOptions(const GBR_DISPLAY_OPTIONS &aOptions)
Function LoadDisplayOptions Loads settings related to display options.
virtual COLOR_SETTINGS * GetColorSettings() const
Returns a pointer to the active color theme settings.

References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_FRAME::GetColorSettings(), EDA_BASE_FRAME::GetSettingsManager(), EDA_DRAW_PANEL_GAL::GetView(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadDisplayOptions(), m_DisplayOptions, KIGFX::VIEW::MarkTargetDirty(), Pgm(), and KIGFX::TARGET_NONCACHED.

Referenced by SetElementVisibility(), SetLayerColor(), and UpdateDisplayOptions().

◆ canCloseWindow()

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

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 1084 of file eda_base_frame.cpp.

1085 {
1086  SetUserUnits( aUnits );
1088 
1089  wxCommandEvent e( UNITS_CHANGED );
1090  ProcessEventLocally( e );
1091 }
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void SetUserUnits(EDA_UNITS aUnits)

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

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

◆ CheckForAutoSaveFile()

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

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

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

Parameters
aFileNameA wxFileName object containing the file name to check.

Definition at line 972 of file eda_base_frame.cpp.

973 {
974  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
975 
976  wxFileName autoSaveFileName = aFileName;
977 
978  // Check for auto save file.
979  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
980 
981  wxLogTrace( traceAutoSave,
982  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
983 
984  if( !autoSaveFileName.FileExists() )
985  return;
986 
987  wxString msg = wxString::Format( _(
988  "Well this is potentially embarrassing!\n"
989  "It appears that the last time you were editing the file\n"
990  "\"%s\"\n"
991  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
992  aFileName.GetFullName()
993  );
994 
995  int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
996  this );
997 
998  // Make a backup of the current file, delete the file, and rename the auto save file to
999  // the file name.
1000  if( response == wxYES )
1001  {
1002  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1003  {
1004  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1005  Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1006  }
1007  }
1008  else
1009  {
1010  wxLogTrace( traceAutoSave,
1011  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1012 
1013  // Remove the auto save file when using the previous file as is.
1014  wxRemoveFile( autoSaveFileName.GetFullPath() );
1015  }
1016 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static wxString GetAutoSaveFilePrefix()
#define _(s)
Definition: 3d_actions.cpp:33

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

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

◆ Clear_DrawLayers()

bool GERBVIEW_FRAME::Clear_DrawLayers ( bool  query)

Definition at line 40 of file clear_gbr_drawlayers.cpp.

41 {
42  if( GetGerberLayout() == NULL )
43  return false;
44 
45  if( query && GetScreen()->IsModify() )
46  {
47  if( !IsOK( this, _( "Current data will be lost?" ) ) )
48  return false;
49  }
50 
51  if( GetCanvas() )
52  {
53  if( m_toolManager )
55 
56  GetCanvas()->GetView()->Clear();
57 
58  // Reinit the drawing-sheet view, cleared by GetView()->Clear():
60  }
61 
63 
65 
66  SetActiveLayer( 0 );
68  syncLayerBox();
69  return true;
70 }
void DeleteAllImages()
Remove all loaded data in list, and delete all images, freeing the memory.
Model changes (required full reload)
Definition: tool_base.h:81
void syncLayerBox(bool aRebuildLayerBox=false)
Update the currently "selected" layer within m_SelLayerBox.
void SetPageSettings(const PAGE_INFO &aPageSettings) override
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetActiveLayer(int aLayer, bool doLayerWidgetUpdate=true)
change the currently active layer to aLayer and update the GERBER_LAYER_WIDGET.
void SetBoundingBox(const EDA_RECT &aBox)
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: gbr_layout.h:83
#define NULL
void Clear()
Remove all items from the view.
Definition: view.cpp:1091
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Reset all tools (i.e.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
GBR_LAYOUT * GetGerberLayout() const
const PAGE_INFO & GetPageSettings() const override
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
#define _(s)
Definition: 3d_actions.cpp:33
Handle the component boundary box.
Definition: eda_rect.h:42
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:296
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
void ReFillLayerWidget()
Change out all the layers in m_Layers; called upon loading new gerber files.

References _, KIGFX::VIEW::Clear(), GERBER_FILE_IMAGE_LIST::DeleteAllImages(), EDA_DRAW_FRAME::GetCanvas(), GetGerberLayout(), GetImagesList(), GetPageSettings(), EDA_DRAW_FRAME::GetScreen(), EDA_DRAW_PANEL_GAL::GetView(), IsOK(), TOOLS_HOLDER::m_toolManager, TOOL_BASE::MODEL_RELOAD, NULL, ReFillLayerWidget(), TOOL_MANAGER::ResetTools(), SetActiveLayer(), GBR_LAYOUT::SetBoundingBox(), SetPageSettings(), and syncLayerBox().

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

◆ ClearFileHistory()

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

Removes all files from the file history.

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

Definition at line 869 of file eda_base_frame.cpp.

870 {
871  if( !aFileHistory )
872  aFileHistory = m_fileHistory;
873 
874  wxASSERT( aFileHistory );
875 
876  aFileHistory->ClearFileHistory();
877 
878  // Update the menubar to update the file history menu
879  if( GetMenuBar() )
880  {
881  ReCreateMenuBar();
882  GetMenuBar()->Refresh();
883  }
884 }
void ClearFileHistory()
Clear all entries from the file history.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

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

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

virtual void EDA_BASE_FRAME::ClearUndoORRedoList ( UNDO_REDO_LIST  aList,
int  aItemCount = -1 
)
inlinevirtualinherited

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

void GERBVIEW_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged,
bool  aTextVarsChanged 
)
overridevirtual

Called after the preferences dialog is run.

Reimplemented from TOOLS_HOLDER.

Definition at line 1146 of file gerbview_frame.cpp.

1147 {
1148  EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
1149 
1150  RecreateToolbars();
1151  Layout();
1152  SendSizeEvent();
1153 }
void RecreateToolbars()
Rebuild all toolbars, and update the checked state of check tools.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.

References EDA_DRAW_FRAME::CommonSettingsChanged(), and EDA_DRAW_FRAME::RecreateToolbars().

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

711 {
712  // KICAD_MANAGER_FRAME overrides this
713  return Kiface().KifaceSettings();
714 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:92
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), ZOOM_MENU::ZOOM_MENU(), and BM2CMP_FRAME::~BM2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited

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

339  {
340  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
341  return baseCfgName;
342  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

Definition at line 735 of file eda_base_frame.cpp.

736 {
737 #if defined( __WXOSX_MAC__ )
739 #else
740  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
741 
742  m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
743 #endif
744 }
wxAuiManager m_auimgr
virtual wxWindow * GetToolCanvas() const =0
Canvas access.
Specialization of the wxAuiPaneInfo class for KiCad panels.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:71
WX_INFOBAR * m_infoBar

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

◆ CreateServer()

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

Definition at line 48 of file eda_dde.cpp.

49 {
50  wxIPV4address addr;
51 
52  // Set the port number
53  addr.Service( service );
54 
55  // Listen on localhost only if requested
56  if( local )
57  addr.Hostname( HOSTNAME );
58 
59  delete m_socketServer;
60  m_socketServer = new wxSocketServer( addr );
61 
62  m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
63  m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
64  m_socketServer->Notify( true );
65 }
static const wxString HOSTNAME(wxT("localhost"))
wxSocketServer * m_socketServer

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

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

◆ CurrentToolName()

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

Definition at line 99 of file tools_holder.cpp.

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

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

Referenced by TOOL_MANAGER::processEvent().

◆ Destroy()

◆ DismissModal()

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

Definition at line 161 of file kiway_player.cpp.

162 {
163  m_modal_ret_val = aRetVal;
164  m_modal_string = aResult;
165 
166  if( m_modal_loop )
167  {
168  m_modal_loop->Exit();
169  m_modal_loop = 0; // this marks it as dismissed.
170  }
171 
172  Show( false );
173 }
bool m_modal_ret_val
Definition: kiway_player.h:199
wxString m_modal_string
Definition: kiway_player.h:198
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:196

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

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

◆ DisplayGridMsg()

void GERBVIEW_FRAME::DisplayGridMsg ( )
overridevirtual

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 899 of file gerbview_frame.cpp.

900 {
901  wxString line;
902 
903  line.Printf( "grid X %s Y %s",
904  MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x ),
905  MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().y ) );
906 
907  SetStatusText( line, 4 );
908 }
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:90
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

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

Referenced by UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 463 of file eda_draw_frame.cpp.

464 {
465  SetStatusText( msg, 6 );
466 }

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane in the status bar.

Definition at line 480 of file eda_draw_frame.cpp.

481 {
482  wxString msg;
483 
484  switch( m_userUnits )
485  {
486  case EDA_UNITS::INCHES: msg = _( "inches" ); break;
487  case EDA_UNITS::MILS: msg = _( "mils" ); break;
488  case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
489  default: msg = _( "Units" ); break;
490  }
491 
492  SetStatusText( msg, 5 );
493 }
#define _(s)
Definition: 3d_actions.cpp:33
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

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

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

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

302 {
303  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
304 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void GERBVIEW_FRAME::doCloseWindow ( )
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 220 of file gerbview_frame.cpp.

221 {
222  // No more vetos
223  m_isClosing = true;
224  GetCanvas()->StopDrawing();
225  GetCanvas()->GetView()->Clear();
226 
227  if( m_toolManager )
229 
230  // Be sure any OpenGL event cannot be fired after frame deletion:
231  GetCanvas()->SetEvtHandlerEnabled( false );
232 
233  Destroy();
234 }
bool m_isClosing
Set by NonUserClose() to indicate that the user did not request the current close.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void DeactivateTool()
Deactivate the currently active tool.
void Clear()
Remove all items from the view.
Definition: view.cpp:1091
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.

References KIGFX::VIEW::Clear(), TOOL_MANAGER::DeactivateTool(), KIWAY_PLAYER::Destroy(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), EDA_BASE_FRAME::m_isClosing, TOOLS_HOLDER::m_toolManager, and EDA_DRAW_PANEL_GAL::StopDrawing().

◆ Erase_Current_DrawLayer()

void GERBVIEW_FRAME::Erase_Current_DrawLayer ( bool  query)

Definition at line 73 of file clear_gbr_drawlayers.cpp.

74 {
75  int layer = GetActiveLayer();
76  wxString msg;
77 
78  msg.Printf( _( "Clear layer %d?" ), layer + 1 );
79 
80  if( query && !IsOK( this, msg ) )
81  return;
82 
83  if( m_toolManager )
85 
86  GetImagesList()->DeleteImage( layer );
87 
89  syncLayerBox();
90  GetCanvas()->Refresh();
91 }
Model changes (required full reload)
Definition: tool_base.h:81
void syncLayerBox(bool aRebuildLayerBox=false)
Update the currently "selected" layer within m_SelLayerBox.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Reset all tools (i.e.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
int GetActiveLayer() const
Return the active layer.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
#define _(s)
Definition: 3d_actions.cpp:33
void DeleteImage(int aIdx)
Delete the loaded data of image aIdx, freeing the memory.
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:296
void ReFillLayerWidget()
Change out all the layers in m_Layers; called upon loading new gerber files.

References _, GERBER_FILE_IMAGE_LIST::DeleteImage(), GetActiveLayer(), EDA_DRAW_FRAME::GetCanvas(), GetImagesList(), IsOK(), TOOLS_HOLDER::m_toolManager, TOOL_BASE::MODEL_RELOAD, ReFillLayerWidget(), EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::ResetTools(), and syncLayerBox().

Referenced by GERBVIEW_CONTROL::ClearLayer(), LoadGerberFiles(), OnDrlFileHistory(), OnGbrFileHistory(), OnZipFileHistory(), Read_EXCELLON_File(), and Read_GERBER_File().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 232 of file eda_draw_frame.cpp.

233 {
234  if( m_messagePanel )
236 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:223

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

Execute a remote command 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 200 of file eda_draw_frame.h.

200 {}

Referenced by EDA_DRAW_FRAME::OnSockRequest().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 747 of file eda_base_frame.cpp.

748 {
749 #if defined( __WXOSX_MAC__ )
750  m_auimgr.Update();
751 #else
752  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
753  // hiding it.
754  m_auimgr.Update();
755 
756  // We don't want the infobar displayed right away
757  m_auimgr.GetPane( "InfoBar" ).Hide();
758  m_auimgr.Update();
759 #endif
760 }
wxAuiManager m_auimgr

References EDA_BASE_FRAME::m_auimgr.

◆ FocusOnLocation()

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

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

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

Parameters
aPosis the point to go to.

Definition at line 796 of file eda_draw_frame.cpp.

797 {
798  bool centerView = false;
799  BOX2D r = GetCanvas()->GetView()->GetViewport();
800 
801  // Center if we're off the current view, or within 10% of its edge
802  r.Inflate( - (int) r.GetWidth() / 10 );
803 
804  if( !r.Contains( aPos ) )
805  centerView = true;
806 
807  // Center if we're behind an obscuring dialog, or within 10% of its edge
808  wxWindow* dialog = findDialog( GetChildren() );
809 
810  if( dialog )
811  {
812  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
813  dialog->GetSize() );
814  dialogRect.Inflate( dialogRect.GetWidth() / 10 );
815 
816  if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
817  centerView = true;
818  }
819 
820  if( centerView )
821  {
822  // If a dialog partly obscures the window, then center on the uncovered area.
823  if( dialog )
824  {
825  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
826  dialog->GetSize() );
827  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
828  }
829  else
830  GetCanvas()->GetView()->SetCenter( aPos );
831  }
832 
834 }
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition: view.cpp:514
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:580
coord_type GetWidth() const
Definition: box2.h:197
bool Contains(const Vec &aPoint) const
Function Contains.
Definition: box2.h:151
wxWindow * findDialog(wxWindowList &aList)
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Move the graphic crosshair cursor to the requested position expressed in world coordinates.
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:302

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

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

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetActiveLayer()

◆ GetAutoSaveFilePrefix()

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

Definition at line 582 of file eda_base_frame.h.

583  {
584  return wxT( "_autosave-" );
585  }

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 190 of file eda_base_frame.h.

190 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ 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 PCB_BASE_FRAME, PL_EDITOR_FRAME, and SCH_BASE_FRAME.

Definition at line 423 of file eda_draw_frame.h.

423 { return m_canvas; }
EDA_DRAW_PANEL_GAL * m_canvas
This the frame's interface to setting GAL display options.

References EDA_DRAW_FRAME::m_canvas.

Referenced by ActivateGalCanvas(), EDA_DRAW_FRAME::ActivateGalCanvas(), applyDisplaySettingsToGAL(), GERBVIEW_CONTROL::canvas(), COMMON_TOOLS::CenterContents(), Clear_DrawLayers(), EDA_DRAW_FRAME::CommonSettingsChanged(), DIALOG_PRINT_GERBVIEW::createPrintout(), DisplayGridMsg(), EDA_DRAW_FRAME::DisplayGridMsg(), doCloseWindow(), COMMON_TOOLS::doZoomFit(), Erase_Current_DrawLayer(), EDA_DRAW_FRAME::FocusOnLocation(), GERBVIEW_FRAME(), SCH_BASE_FRAME::GetCanvas(), PL_EDITOR_FRAME::GetCanvas(), PCB_BASE_FRAME::GetCanvas(), EDA_DRAW_FRAME::GetNearestGridPosition(), EDA_DRAW_FRAME::GetNearestHalfGridPosition(), EDA_DRAW_FRAME::GetToolCanvas(), GetVisibleLayers(), LoadListOfGerberAndDrillFiles(), ZOOM_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), STATUS_POPUP::onCharHook(), EDA_DRAW_FRAME::OnGridSettings(), 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(), EDA_DRAW_FRAME::resolveCanvasType(), SaveCanvasImageToFile(), ZOOM_TOOL::selectRegion(), SetActiveLayer(), SetElementVisibility(), SetGridColor(), EDA_DRAW_FRAME::SetGridVisibility(), SetPageSettings(), setupTools(), SetVisibleLayers(), SortLayersByX2Attributes(), EDA_DRAW_FRAME::SwitchCanvas(), PANEL_GAL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), GAL_OPTIONS_PANEL::TransferDataFromWindow(), GAL_OPTIONS_PANEL::TransferDataToWindow(), ZOOM_MENU::update(), UpdateDisplayOptions(), UpdateStatusBar(), and ~GERBVIEW_FRAME().

◆ GetColorSettings()

COLOR_SETTINGS * EDA_DRAW_FRAME::GetColorSettings ( ) const
virtualinherited

Returns a pointer to the active color theme settings.

Reimplemented in SCH_BASE_FRAME, SYMBOL_EDIT_FRAME, PCB_BASE_EDIT_FRAME, PCB_BASE_FRAME, FOOTPRINT_WIZARD_FRAME, FOOTPRINT_VIEWER_FRAME, DISPLAY_FOOTPRINTS_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 969 of file eda_draw_frame.cpp.

970 {
971  if( !m_colorSettings )
972  {
973  COLOR_SETTINGS* colorSettings = Pgm().GetSettingsManager().GetColorSettings();
974 
975  const_cast<EDA_DRAW_FRAME*>( this )->m_colorSettings = colorSettings;
976  }
977 
978  return m_colorSettings;
979 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
COLOR_SETTINGS * m_colorSettings
The current canvas type.
Color settings are a bit different than most of the settings objects in that there can be more than o...

References EDA_DRAW_FRAME::m_colorSettings, and Pgm().

Referenced by applyDisplaySettingsToGAL(), GERBVIEW_CONTROL::Print(), and DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample().

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const
inlinevirtualinherited

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

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

Returns
the filename and full path to the open file

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 419 of file eda_base_frame.h.

419 { return wxEmptyString; }

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 1156 of file gerbview_frame.cpp.

1157 {
1158  return m_toolManager->GetTool<GERBVIEW_SELECTION_TOOL>()->GetSelection();
1159 }
Selection tool for GerbView, based on the one in Pcbnew.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157

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

101 { return m_displayMode; }

References m_displayMode.

Referenced by OnUpdateDrawMode().

◆ GetDisplayOptions()

◆ 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 worksheet border. It's passed false by "Zoom To Objects" to ignore worksheet 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 462 of file gerbview_frame.h.

463  {
464  wxASSERT( m_gerberLayout );
465  return m_gerberLayout->ViewBBox();
466  }
GBR_LAYOUT * m_gerberLayout
virtual const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition: eda_item.cpp:190

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

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

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

134 { return m_dragAction; }
MOUSE_DRAG_ACTION m_dragAction
Definition: tools_holder.h:174

References TOOLS_HOLDER::m_dragAction.

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

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

◆ GetFileFromHistory()

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

Fetches the file name from the file history list.

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

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

Definition at line 829 of file eda_base_frame.cpp.

831 {
832  if( !aFileHistory )
833  aFileHistory = m_fileHistory;
834 
835  wxASSERT( aFileHistory );
836 
837  int baseId = aFileHistory->GetBaseId();
838 
839  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
840 
841  unsigned i = cmdId - baseId;
842 
843  if( i < aFileHistory->GetCount() )
844  {
845  wxString fn = aFileHistory->GetHistoryFile( i );
846 
847  if( wxFileName::FileExists( fn ) )
848  return fn;
849  else
850  {
851  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
852  wxMessageBox( msg );
853 
854  aFileHistory->RemoveFileFromHistory( i );
855  }
856  }
857 
858  // Update the menubar to update the file history menu
859  if( GetMenuBar() )
860  {
861  ReCreateMenuBar();
862  GetMenuBar()->Refresh();
863  }
864 
865  return wxEmptyString;
866 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

Referenced by OnDrlFileHistory(), 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

Get the frame's main file history.

Returns
the main file history

Definition at line 403 of file eda_base_frame.h.

404  {
405  return *m_fileHistory;
406  }
FILE_HISTORY * m_fileHistory

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

Definition at line 94 of file eda_draw_frame.h.

94 { return m_findStringHistoryList; }
wxArrayString m_findStringHistoryList

References EDA_DRAW_FRAME::m_findStringHistoryList.

Referenced by DIALOG_FIND::DIALOG_FIND(), and DIALOG_FIND::search().

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )
inlineinherited

Definition at line 93 of file eda_draw_frame.h.

93 { return *m_findReplaceData; }
wxFindReplaceData * m_findReplaceData

References EDA_DRAW_FRAME::m_findReplaceData.

Referenced by DIALOG_FIND::search().

◆ GetGalDisplayOptions()

◆ GetGbrImage()

◆ GetGerberLayout()

◆ GetGridColor()

COLOR4D GERBVIEW_FRAME::GetGridColor ( )
overridevirtual

Returns
the color of the grid

Reimplemented from EDA_DRAW_FRAME.

Definition at line 882 of file gerbview_frame.cpp.

883 {
884  return Pgm().GetSettingsManager().GetColorSettings()->GetColor( LAYER_GRID );
885 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106

References LAYER_GRID, and Pgm().

Referenced by GetVisibleElementColor().

◆ GetGridOrigin()

const wxPoint& 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 429 of file gerbview_frame.h.

429 { return m_grid_origin; }
wxPoint m_grid_origin

References m_grid_origin.

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

399 { return nullptr; }

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

◆ GetLayerColor()

COLOR4D GERBVIEW_FRAME::GetLayerColor ( int  aLayer) const

Definition at line 797 of file gerbview_frame.cpp.

798 {
799  return Pgm().GetSettingsManager().GetColorSettings()->GetColor( aLayer );
800 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106

References Pgm().

Referenced by ActivateGalCanvas(), GBR_LAYER_BOX_SELECTOR::getLayerColor(), and GERBER_LAYER_WIDGET::ReFill().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 562 of file eda_base_frame.h.

562 { return m_undoRedoCountMax; }

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

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

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

◆ GetNearestGridPosition()

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

Return the nearest aGridSize location to aPosition.

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

Definition at line 738 of file eda_draw_frame.cpp.

739 {
740  const wxPoint& gridOrigin = GetGridOrigin();
741  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
742 
743  double xOffset = fmod( gridOrigin.x, gridSize.x );
744  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
745  double yOffset = fmod( gridOrigin.y, gridSize.y );
746  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
747 
748  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
749 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
virtual const wxPoint & GetGridOrigin() const =0
Return the absolute coordinates of the origin of the snap grid.
const VECTOR2D & GetGridSize() const
Return the grid size.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

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

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

◆ GetNearestHalfGridPosition()

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

Return the nearest aGridSize / 2 location to aPosition.

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

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

Definition at line 752 of file eda_draw_frame.cpp.

753 {
754  const wxPoint& gridOrigin = GetGridOrigin();
755  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize() / 2.0;
756 
757  double xOffset = fmod( gridOrigin.x, gridSize.x );
758  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
759  double yOffset = fmod( gridOrigin.y, gridSize.y );
760  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
761 
762  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
763 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
virtual const wxPoint & GetGridOrigin() const =0
Return the absolute coordinates of the origin of the snap grid.
const VECTOR2D & GetGridSize() const
Return the grid size.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

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

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

◆ GetNegativeItemsColor()

COLOR4D GERBVIEW_FRAME::GetNegativeItemsColor ( )

This is usually the background color, but can be another color in order to see negative objects.

Returns
the color of negative items.

Definition at line 788 of file gerbview_frame.cpp.

789 {
792  else
793  return GetDrawBgColor();
794 }
COLOR4D GetVisibleElementColor(int aLayerID)
Return the color of a gerber visible element.
bool IsElementVisible(int aLayerID) const
Test whether a given element category is visible.
virtual COLOR4D GetDrawBgColor() const

References EDA_DRAW_FRAME::GetDrawBgColor(), GetVisibleElementColor(), IsElementVisible(), and LAYER_NEGATIVE_OBJECTS.

◆ getNextAvailableLayer()

int GERBVIEW_FRAME::getNextAvailableLayer ( int  aLayer = 0) const

Find the next empty layer starting at aLayer and returns it to the caller.

If no empty layers are found, NO_AVAILABLE_LAYERS is return.

Parameters
aLayerThe first layer to search.
Returns
The first empty layer found or NO_AVAILABLE_LAYERS.

Definition at line 464 of file gerbview_frame.cpp.

465 {
466  int layer = aLayer;
467 
468  for( unsigned i = 0; i < ImagesMaxCount(); ++i )
469  {
470  const GERBER_FILE_IMAGE* gerber = GetGbrImage( layer );
471 
472  if( gerber == NULL ) // this graphic layer is available: use it
473  return layer;
474 
475  ++layer; // try next graphic layer
476 
477  if( layer >= (int)ImagesMaxCount() )
478  layer = 0;
479  }
480 
481  return NO_AVAILABLE_LAYERS;
482 }
Hold the image data and parameters for one gerber file and layer parameters.
unsigned ImagesMaxCount() const
The max number of file images.
#define NULL
#define NO_AVAILABLE_LAYERS
GERBER_FILE_IMAGE * GetGbrImage(int aIdx) const

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

Referenced by LoadExcellonFiles(), LoadListOfGerberAndDrillFiles(), and unarchiveFiles().

◆ GetOriginTransforms()

virtual ORIGIN_TRANSFORMS& EDA_DRAW_FRAME::GetOriginTransforms ( )
inlinevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented in PCB_BASE_FRAME.

Definition at line 152 of file eda_draw_frame.h.

153  { return m_originTransforms; }
ORIGIN_TRANSFORMS m_originTransforms

References EDA_DRAW_FRAME::m_originTransforms.

Referenced by DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), and LEADER::GetMsgPanelInfo().

◆ GetPageSettings()

const PAGE_INFO & GERBVIEW_FRAME::GetPageSettings ( ) const
overridevirtual

◆ GetPageSizeIU()

const wxSize 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 859 of file gerbview_frame.cpp.

860 {
861  // this function is only needed because EDA_DRAW_FRAME is not compiled
862  // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
863  // into an application specific source file.
864  return GetPageSettings().GetSizeIU();
865 }
const PAGE_INFO & GetPageSettings() const override

References GetPageSettings().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetScreen()

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 892 of file eda_draw_frame.cpp.

893 {
894  // Virtual function. Base class implementation returns an empty string.
895  return wxEmptyString;
896 }

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

◆ GetSettingsManager()

◆ GetSeverity()

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

Reimplemented in PCB_BASE_FRAME.

Definition at line 130 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 108 of file eda_draw_frame.h.

108 { return m_polarCoords; }

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 868 of file gerbview_frame.cpp.

869 {
870  wxASSERT( m_gerberLayout );
871  return m_gerberLayout->GetTitleBlock();
872 }
TITLE_BLOCK & GetTitleBlock()
Definition: gbr_layout.h:68
GBR_LAYOUT * m_gerberLayout

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

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

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

55 { return m_toolManager; }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157

References TOOLS_HOLDER::m_toolManager.

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:79

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const
inlinevirtualinherited

◆ GetUnitPair()

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

Get the pair or units in current use.

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

Definition at line 1004 of file eda_draw_frame.cpp.

1005 {
1007 
1008  aPrimaryUnit = GetUserUnits();
1009  aSecondaryUnits = EDA_UNITS::MILS;
1010 
1011  if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
1012  {
1013  if( cmnTool )
1014  aSecondaryUnits = cmnTool->GetLastMetricUnits();
1015  else
1016  aSecondaryUnits = EDA_UNITS::MILLIMETRES;
1017  }
1018  else
1019  {
1020  if( cmnTool )
1021  aSecondaryUnits = cmnTool->GetLastImperialUnits();
1022  else
1023  aSecondaryUnits = EDA_UNITS::MILS;
1024  }
1025 }
EDA_UNITS GetLastMetricUnits()
Definition: common_tools.h:74
bool IsImperialUnit(EDA_UNITS aUnit)
Definition: eda_units.cpp:26
EDA_UNITS GetLastImperialUnits()
Definition: common_tools.h:75
Handles action that are shared between different applications.
Definition: common_tools.h:37
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

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

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

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 114 of file eda_base_frame.h.

115  {
116  return m_userUnits;
117  }
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

References EDA_BASE_FRAME::m_userUnits.

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

◆ GetVisibleElementColor()

COLOR4D GERBVIEW_FRAME::GetVisibleElementColor ( int  aLayerID)

Return the color of a gerber visible element.

Definition at line 718 of file gerbview_frame.cpp.

719 {
720  COLOR4D color = COLOR4D::UNSPECIFIED;
721  COLOR_SETTINGS* settings = Pgm().GetSettingsManager().GetColorSettings();
722 
723  switch( aLayerID )
724  {
726  case LAYER_DCODES:
729  color = settings->GetColor( aLayerID );
730  break;
731 
732  case LAYER_GERBVIEW_GRID:
733  color = GetGridColor();
734  break;
735 
736  default:
737  wxFAIL_MSG( wxString::Format( "GERBVIEW_FRAME::GetVisibleElementColor(): bad arg %d",
738  aLayerID ) );
739  }
740 
741  return color;
742 }
int color
Definition: DXF_plotter.cpp:60
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
COLOR4D GetGridColor() override
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
COLOR4D GetColor(int aLayer) const
Color settings are a bit different than most of the settings objects in that there can be more than o...
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

References color, Format(), COLOR_SETTINGS::GetColor(), GetGridColor(), LAYER_DCODES, LAYER_GERBVIEW_BACKGROUND, LAYER_GERBVIEW_DRAWINGSHEET, LAYER_GERBVIEW_GRID, LAYER_NEGATIVE_OBJECTS, and Pgm().

Referenced by GetNegativeItemsColor(), and GERBER_LAYER_WIDGET::ReFillRender().

◆ 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 682 of file gerbview_frame.cpp.

683 {
684  LSET visible = LSET::AllLayersMask();
685 
686  if( GetCanvas() )
687  {
688  for( int i = 0; i < GERBER_DRAWLAYERS_COUNT; i++ )
689  visible[i] = GetCanvas()->GetView()->IsLayerVisible( GERBER_DRAW_LAYER( i ) );
690  }
691 
692  return visible;
693 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
LSET is a set of PCB_LAYER_IDs.
#define GERBER_DRAWLAYERS_COUNT
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
static LSET AllLayersMask()
Definition: lset.cpp:787
#define GERBER_DRAW_LAYER(x)
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition: view.h:404

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 SIM_PLOT_FRAME, FOOTPRINT_WIZARD_FRAME, FOOTPRINT_VIEWER_FRAME, SYMBOL_VIEWER_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 704 of file eda_base_frame.cpp.

705 {
706  return &aCfg->m_Window;
707 }
WINDOW_SETTINGS m_Window
Definition: app_settings.h:181

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

1117 {
1118 #ifdef __WXGTK__
1119  // GTK includes the window decorations in the normal GetSize call,
1120  // so we have to use a GTK-specific sizing call that returns the
1121  // non-decorated window size.
1122  int width = 0;
1123  int height = 0;
1124  GTKDoGetSize( &width, &height );
1125 
1126  wxSize winSize( width, height );
1127 #else
1128  wxSize winSize = GetSize();
1129 #endif
1130 
1131  return winSize;
1132 }

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

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

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

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

◆ handleActivateEvent()

void EDA_DRAW_FRAME::handleActivateEvent ( wxActivateEvent &  aEvent)
protectedvirtualinherited

Handle a window activation event.

Reimplemented in PCB_BASE_EDIT_FRAME.

Definition at line 1077 of file eda_draw_frame.cpp.

1078 {
1079  // Force a refresh of the message panel to ensure that the text is the right color
1080  // when the window activates
1081  if( !IsIconized() )
1082  m_messagePanel->Refresh();
1083 }
EDA_MSG_PANEL * m_messagePanel

References EDA_DRAW_FRAME::m_messagePanel.

Referenced by PCB_BASE_EDIT_FRAME::handleActivateEvent(), and EDA_DRAW_FRAME::onActivate().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )
virtualinherited

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

Definition at line 1135 of file eda_base_frame.cpp.

1136 {
1137  // Update the icon theme when the system theme changes and update the toolbars
1138  if( GetBitmapStore()->ThemeChanged() )
1139  ThemeChanged();
1140 
1141  // This isn't handled by ThemeChanged()
1142  if( GetMenuBar() )
1143  {
1144  // For icons in menus, icon scaling & hotkeys
1145  ReCreateMenuBar();
1146  GetMenuBar()->Refresh();
1147  }
1148 }
virtual void ThemeChanged()
Process light/dark theme change.
virtual void ReCreateMenuBar()
Recreates the menu bar.
BITMAP_STORE * GetBitmapStore()
Definition: bitmap.cpp:92

References GetBitmapStore(), EDA_BASE_FRAME::ReCreateMenuBar(), 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 349 of file eda_base_frame.cpp.

351 {
352  bool checkRes = false;
353  bool enableRes = true;
354  bool showRes = true;
355  SELECTION& selection = aFrame->GetCurrentSelection();
356 
357  try
358  {
359  checkRes = aCond.checkCondition( selection );
360  enableRes = aCond.enableCondition( selection );
361  showRes = aCond.showCondition( selection );
362  }
363  catch( std::exception& )
364  {
365  // Something broke with the conditions, just skip the event.
366  aEvent.Skip();
367  return;
368  }
369 
370  aEvent.Enable( enableRes );
371  aEvent.Show( showRes );
372 
373  // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
374  // checked, since wxMenuItems don't want to be checked unless they actually are checkable
375 #if wxCHECK_VERSION( 3, 1, 5 )
376  if( aEvent.IsCheckable() )
377  aEvent.Check( checkRes );
378 #else
379  bool canCheck = true;
380 
381  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
382  // see if they can be and can't just universally apply a check in this event.
383  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
384  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
385 
386  if( canCheck )
387  aEvent.Check( checkRes );
388 #endif
389 }
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:102

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

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

void EDA_DRAW_FRAME::HardRedraw ( )
virtualinherited

Rebuild the GAL and redraws the screen.

Call when something went wrong.

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

Definition at line 772 of file eda_draw_frame.cpp.

773 {
774  // To be implemented by subclasses.
775 }

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

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 723 of file eda_base_frame.cpp.

724 {
725  return Kiface().GetHelpFileName();
726 }
const wxString & GetHelpFileName() const
Return just the basename portion of the current help file.
Definition: kiface_i.h:109
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImagesMaxCount()

unsigned GERBVIEW_FRAME::ImagesMaxCount ( ) const

The max number of file images.

Definition at line 964 of file gerbview_frame.cpp.

965 {
967 }
GBR_LAYOUT * m_gerberLayout
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Definition: gbr_layout.cpp:41

References GBR_LAYOUT::GetImagesList(), GERBER_FILE_IMAGE_LIST::ImagesMaxCount(), and m_gerberLayout.

Referenced by GERBVIEW_FRAME(), getNextAvailableLayer(), and GERBVIEW_INSPECTION_TOOL::ShowDCodes().

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

1027 {
1028  wxAcceleratorEntry entries[1];
1029  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
1030  wxAcceleratorTable accel( 1, entries );
1031  SetAcceleratorTable( accel );
1032 }

◆ InstallPreferences()

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

Allow Gerbview to install its preferences panels into the preferences dialog.

Reimplemented from EDA_BASE_FRAME.

Definition at line 1008 of file gerbview_frame.cpp.

1010 {
1011  wxTreebook* book = aParent->GetTreebook();
1012 
1013  book->AddPage( new wxPanel( book ), _( "GerbView" ) );
1014  book->AddSubPage( new PANEL_GERBVIEW_DISPLAY_OPTIONS( this, book ), _( "Display Options" ) );
1015  book->AddSubPage( new PANEL_GERBVIEW_SETTINGS( this, book ), _( "Editing Options" ) );
1016 
1017  aHotkeysPanel->AddHotKeys( GetToolManager() );
1018 }
void AddHotKeys(TOOL_MANAGER *aToolMgr)
wxTreebook * GetTreebook()
Definition: paged_dialog.h:52
#define _(s)
Definition: 3d_actions.cpp:33
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55

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

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const
inlineprotectedvirtualinherited

Return the auto save status of the application.

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 597 of file eda_base_frame.h.

597 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( )
virtualinherited

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

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

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

Definition at line 1019 of file eda_base_frame.cpp.

1020 {
1021  // This function should be overridden in child classes
1022  return false;
1023 }

Referenced by EDITOR_CONDITIONS::contentModifiedFunc().

◆ IsCurrentTool()

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

Definition at line 108 of file tools_holder.cpp.

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

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

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

◆ IsDismissed()

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

Definition at line 155 of file kiway_player.cpp.

156 {
157  return !m_modal_loop;
158 }
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:196

References KIWAY_PLAYER::m_modal_loop.

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

◆ IsElementVisible()

bool GERBVIEW_FRAME::IsElementVisible ( int  aLayerID) const

Test whether a given element category is visible.

Keep this as an inline function.

Parameters
aLayerIDis an item id from the enum GERBVIEW_LAYER_ID
Returns
bool - true if the element is visible.

Definition at line 664 of file gerbview_frame.cpp.

665 {
666  switch( aLayerID )
667  {
670  case LAYER_GERBVIEW_GRID: return IsGridVisible();
672  case LAYER_GERBVIEW_BACKGROUND: return true;
673 
674  default:
675  wxFAIL_MSG( wxString::Format( "GERBVIEW_FRAME::IsElementVisible(): bad arg %d", aLayerID ) );
676  }
677 
678  return true;
679 }
bool m_DisplayNegativeObjects
Option to draw negative objects in a specific color.
bool IsGridVisible() const
bool m_showBorderAndTitleBlock
GBR_DISPLAY_OPTIONS m_DisplayOptions
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
bool m_DisplayDCodes
Option to show dcode values on items drawn with a dcode tool.

References Format(), EDA_DRAW_FRAME::IsGridVisible(), LAYER_DCODES, LAYER_GERBVIEW_BACKGROUND, LAYER_GERBVIEW_DRAWINGSHEET, LAYER_GERBVIEW_GRID, LAYER_NEGATIVE_OBJECTS, GBR_DISPLAY_OPTIONS::m_DisplayDCodes, GBR_DISPLAY_OPTIONS::m_DisplayNegativeObjects, m_DisplayOptions, and EDA_DRAW_FRAME::m_showBorderAndTitleBlock.

Referenced by GERBVIEW_CONTROL::DisplayControl(), GetNegativeItemsColor(), GERBER_LAYER_WIDGET::ReFillRender(), SaveSettings(), setupUIConditions(), and PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataToWindow().

◆ IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( ) const
inherited

Definition at line 335 of file eda_draw_frame.cpp.

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

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

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

◆ 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 712 of file gerbview_frame.cpp.

713 {
714  return m_LayersManager->IsLayerVisible( aLayer );
715 }
GERBER_LAYER_WIDGET * m_LayersManager
bool IsLayerVisible(LAYER_NUM aLayer)
Function IsLayerVisible returns the visible state of the layer ROW associated with aLayer id.

References LAYER_WIDGET::IsLayerVisible(), and m_LayersManager.

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

◆ 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 170 of file kiway_player.h.

170 { return m_modal; }

References KIWAY_PLAYER::m_modal.

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

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 192 of file eda_base_frame.h.

192 { return m_ident == aType; }

References EDA_BASE_FRAME::m_ident.

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

◆ IsWritable()

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

Checks if aFileName can be written.

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

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

Definition at line 928 of file eda_base_frame.cpp.

929 {
930  wxString msg;
931  wxFileName fn = aFileName;
932 
933  // Check for absence of a file path with a file name. Unfortunately KiCad
934  // uses paths relative to the current project path without the ./ part which
935  // confuses wxFileName. Making the file name path absolute may be less than
936  // elegant but it solves the problem.
937  if( fn.GetPath().IsEmpty() && fn.HasName() )
938  fn.MakeAbsolute();
939 
940  wxCHECK_MSG( fn.IsOk(), false,
941  wxT( "File name object is invalid. Bad programmer!" ) );
942  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
943  wxT( "File name object path <" ) + fn.GetFullPath() +
944  wxT( "> is not set. Bad programmer!" ) );
945 
946  if( fn.IsDir() && !fn.IsDirWritable() )
947  {
948  msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
949  fn.GetPath() );
950  }
951  else if( !fn.FileExists() && !fn.IsDirWritable() )
952  {
953  msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
954  fn.GetFullName(), fn.GetPath() );
955  }
956  else if( fn.FileExists() && !fn.IsFileWritable() )
957  {
958  msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
959  fn.GetFullPath() );
960  }
961 
962  if( !msg.IsEmpty() )
963  {
964  wxMessageBox( msg );
965  return false;
966  }
967 
968  return true;
969 }
#define _(s)
Definition: 3d_actions.cpp:33

References _.

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

◆ 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 56 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurPart(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS aEvent)
protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 176 of file kiway_player.cpp.

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

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS aEvent)
virtualinherited

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

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

Definition at line 70 of file kiway_player.cpp.

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

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

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

An event handler called on a language menu selection.

Definition at line 183 of file kiway_player.cpp.

184 {
185  int id = event.GetId();
186 
187  // tell all the KIWAY_PLAYERs about the language change.
188  Kiway().SetLanguage( id );
189 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
virtual void SetLanguage(int aLanguage)
Change the language and then calls ShowChangedLanguage() on all #KIWAY_PLAYERs.
Definition: kiway.cpp:459

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

903 {
904  wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
905  aFilename.SetExt( ext );
906 
907  wxString dir = aGlobalPath;
908 
909 
910  if( isDirectory && doOpen )
911  {
912  if( !aIsGlobal )
913  {
914  dir = Prj().GetProjectPath();
915  }
916 
917  wxDirDialog dlg( this, prompt, dir,
918  wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
919 
920  if( dlg.ShowModal() == wxID_CANCEL )
921  return false;
922 
923  aFilename = dlg.GetPath();
924  aFilename.SetExt( ext );
925  }
926  else
927  {
928  // Ensure the file has a dummy name, otherwise GTK will display the regex from the filter
929  if( aFilename.GetName().empty() )
930  aFilename.SetName( "Library" );
931 
932  if( !aIsGlobal )
933  {
934  dir = Prj().IsNullProject() ? aFilename.GetFullPath() : Prj().GetProjectPath();
935  }
936 
937  wxFileDialog dlg( this, prompt, dir, aFilename.GetFullName(),
938  wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
939  : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
940 
941  if( dlg.ShowModal() == wxID_CANCEL )
942  return false;
943 
944  aFilename = dlg.GetPath();
945  aFilename.SetExt( ext );
946  }
947 
948  return true;
949 }
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:123
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual bool IsNullProject() const
Check if this project is a null project (i.e.
Definition: project.cpp:135
#define _(s)
Definition: 3d_actions.cpp:33

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

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

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )
protectedinherited

Returns the canvas type stored in the application settings.

Definition at line 665 of file eda_draw_frame.cpp.

666 {
667 #ifdef __WXMAC__
668  // Cairo renderer doesn't handle Retina displays so there's really only one game
669  // in town for Mac
671 #endif
672 
675 
676  if( cfg )
677  canvasType = static_cast<EDA_DRAW_PANEL_GAL::GAL_TYPE>( cfg->m_Graphics.canvas_type );
678 
679  if( canvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
680  || canvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
681  {
682  wxASSERT( false );
684  }
685 
686  // Legacy canvas no longer supported. Switch to Cairo, and on the first instantiation
687  // the user will be prompted to switch to OpenGL
688  if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
690 
691  return canvasType;
692 }
static constexpr GAL_TYPE GAL_FALLBACK
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:92
Sentinel, do not use as a parameter.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:99
GAL not used (the legacy wxDC engine is used)
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by SCH_BASE_FRAME::createCanvas(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), and EDA_DRAW_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 335 of file gerbview/files.cpp.

336 {
337  wxString filetypes;
338  wxArrayString filenamesList;
339  wxFileName filename = aFullFileName;
340  wxString currentPath;
341 
342  if( !filename.IsOk() )
343  {
344  filetypes = DrillFileWildcard();
345  filetypes << wxT( "|" );
346 
347  /* All filetypes */
348  filetypes += AllFilesWildcard();
349 
350  /* Use the current working directory if the file name path does not exist. */
351  if( filename.DirExists() )
352  currentPath = filename.GetPath();
353  else
354  currentPath = m_mruPath;
355 
356  wxFileDialog dlg( this, _( "Open NC (Excellon) Drill File(s)" ),
357  currentPath, filename.GetFullName(), filetypes,
358  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE | wxFD_CHANGE_DIR );
359 
360  if( dlg.ShowModal() == wxID_CANCEL )
361  return false;
362 
363  dlg.GetPaths( filenamesList );
364  currentPath = wxGetCwd();
365  m_mruPath = currentPath;
366  }
367  else
368  {
369  filenamesList.Add( aFullFileName );
370  currentPath = filename.GetPath();
371  m_mruPath = currentPath;
372  }
373 
374  // Read Excellon drill files: each file is loaded on a new GerbView layer
375  bool success = true;
376  int layer = GetActiveLayer();
377 
378  // Manage errors when loading files
379  wxString msg;
380  WX_STRING_REPORTER reporter( &msg );
381 
382  for( unsigned ii = 0; ii < filenamesList.GetCount(); ii++ )
383  {
384  filename = filenamesList[ii];
385 
386  if( !filename.IsAbsolute() )
387  filename.SetPath( currentPath );
388 
389  m_lastFileName = filename.GetFullPath();
390 
391  SetActiveLayer( layer, false );
392 
393  if( Read_EXCELLON_File( filename.GetFullPath() ) )
394  {
395  // Update the list of recent drill files.
396  UpdateFileHistory( filename.GetFullPath(), &m_drillFileHistory );
397 
398  layer = getNextAvailableLayer( layer );
399 
400  if( layer == NO_AVAILABLE_LAYERS && ii < filenamesList.GetCount()-1 )
401  {
402  success = false;
403  reporter.Report( MSG_NO_MORE_LAYER, RPT_SEVERITY_ERROR );
404 
405  // Report the name of not loaded files:
406  ii += 1;
407  while( ii < filenamesList.GetCount() )
408  {
409  filename = filenamesList[ii++];
410  wxString txt = wxString::Format( MSG_NOT_LOADED, filename.GetFullName() );
411  reporter.Report( txt, RPT_SEVERITY_ERROR );
412  }
413  break;
414  }
415 
416  SetActiveLayer( layer, false );
417  }
418  }
419 
420  if( !success )
421  {
422  HTML_MESSAGE_BOX mbox( this, _( "Errors" ) );
423  mbox.ListSet( msg );
424  mbox.ShowModal();
425  }
426 
427  Zoom_Automatique( false );
428 
429  // Synchronize layers tools with actual active layer:
433  syncLayerBox();
434 
435  return success;
436 }
wxString m_lastFileName
wxString m_mruPath
void syncLayerBox(bool aRebuildLayerBox=false)
Update the currently "selected" layer within m_SelLayerBox.
GERBER_LAYER_WIDGET * m_LayersManager
void SetActiveLayer(int aLayer, bool doLayerWidgetUpdate=true)
change the currently active layer to aLayer and update the GERBER_LAYER_WIDGET.
wxString AllFilesWildcard()
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
#define MSG_NOT_LOADED
virtual void Zoom_Automatique(bool aWarpPointer)
Redraw the screen with best zoom level and the best centering that shows all the page or the board.
#define NO_AVAILABLE_LAYERS
void UpdateLayerIcons()
Function UpdateLayerIcons Update all layer manager icons (layers only) Useful when loading a file or ...
HTML_MESSAGE_BOX.
FILE_HISTORY m_drillFileHistory
#define MSG_NO_MORE_LAYER
wxString DrillFileWildcard()
A wrapper for reporting to a wxString object.
Definition: reporter.h:159
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
int GetActiveLayer() const
Return the active layer.
#define _(s)
Definition: 3d_actions.cpp:33
int getNextAvailableLayer(int aLayer=0) const
Find the next empty layer starting at aLayer and returns it to the caller.
void ReFillLayerWidget()
Change out all the layers in m_Layers; called upon loading new gerber files.
bool Read_EXCELLON_File(const wxString &aFullFileName)

References _, AllFilesWildcard(), DrillFileWildcard(), Format(), GetActiveLayer(), getNextAvailableLayer(), HTML_MESSAGE_BOX::ListSet(), m_drillFileHistory, m_lastFileName, m_LayersManager, EDA_BASE_FRAME::m_mruPath, MSG_NO_MORE_LAYER, MSG_NOT_LOADED, NO_AVAILABLE_LAYERS, Read_EXCELLON_File(), ReFillLayerWidget(), WX_STRING_REPORTER::Report(), RPT_SEVERITY_ERROR, SetActiveLayer(), syncLayerBox(), EDA_BASE_FRAME::UpdateFileHistory(), LAYER_WIDGET::UpdateLayerIcons(), and EDA_DRAW_FRAME::Zoom_Automatique().

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

◆ LoadGerberFiles()

bool GERBVIEW_FRAME::LoadGerberFiles ( const wxString &  aFileName)

Load a photoplot (Gerber) 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 void string: user will be prompted for filename(s)
Returns
true if file was opened successfully.

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

117 {
118  static int lastGerberFileWildcard = 0;
119  wxString filetypes;
120  wxArrayString filenamesList;
121  wxFileName filename = aFullFileName;
122  wxString currentPath;
123 
124  if( !filename.IsOk() )
125  {
126  /* Standard gerber filetypes
127  * (See http://en.wikipedia.org/wiki/Gerber_File)
128  * The .gbr (.pho in legacy files) extension is the default used in Pcbnew; however
129  * there are a lot of other extensions used for gerber files. Because the first letter
130  * is usually g, we accept g* as extension.
131  * (Mainly internal copper layers do not have specific extension, and filenames are like
132  * *.g1, *.g2 *.gb1 ...)
133  * Now (2014) Ucamco (the company which manages the Gerber format) encourages use of .gbr
134  * only and the Gerber X2 file format.
135  */
136  filetypes = _( "Gerber files (.g* .lgr .pho)" );
137  filetypes << wxT("|");
138  filetypes += wxT("*.g*;*.G*;*.pho;*.PHO" );
139  filetypes << wxT("|");
140 
141  /* Special gerber filetypes */
142  filetypes += _( "Top layer (*.GTL)|*.GTL;*.gtl|" );
143  filetypes += _( "Bottom layer (*.GBL)|*.GBL;*.gbl|" );
144  filetypes += _( "Bottom solder resist (*.GBS)|*.GBS;*.gbs|" );
145  filetypes += _( "Top solder resist (*.GTS)|*.GTS;*.gts|" );
146  filetypes += _( "Bottom overlay (*.GBO)|*.GBO;*.gbo|" );
147  filetypes += _( "Top overlay (*.GTO)|*.GTO;*.gto|" );
148  filetypes += _( "Bottom paste (*.GBP)|*.GBP;*.gbp|" );
149  filetypes += _( "Top paste (*.GTP)|*.GTP;*.gtp|" );
150  filetypes += _( "Keep-out layer (*.GKO)|*.GKO;*.gko|" );
151  filetypes += _( "Mechanical layers (*.GMx)|*.GM1;*.gm1;*.GM2;*.gm2;*.GM3;*.gm3|" );
152  filetypes += _( "Top Pad Master (*.GPT)|*.GPT;*.gpt|" );
153  filetypes += _( "Bottom Pad Master (*.GPB)|*.GPB;*.gpb|" );
154 
155  // All filetypes
156  filetypes += AllFilesWildcard();
157 
158  // Use the current working directory if the file name path does not exist.
159  if( filename.DirExists() )
160  currentPath = filename.GetPath();
161  else
162  {
163  currentPath = m_mruPath;
164 
165  // On wxWidgets 3.1 (bug?) the path in wxFileDialog is ignored when
166  // finishing by the dir separator. Remove it if any:
167  if( currentPath.EndsWith( '\\' ) || currentPath.EndsWith( '/' ) )
168  currentPath.RemoveLast();
169  }
170 
171  wxFileDialog dlg( this, _( "Open Gerber File(s)" ), currentPath, filename.GetFullName(),
172  filetypes,
173  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE | wxFD_CHANGE_DIR );
174  dlg.SetFilterIndex( lastGerberFileWildcard );
175 
176  if( dlg.ShowModal() == wxID_CANCEL )
177  return false;
178 
179  lastGerberFileWildcard = dlg.GetFilterIndex();
180  dlg.GetPaths( filenamesList );
181  m_mruPath = currentPath = dlg.GetDirectory();
182  }
183  else
184  {
185  filenamesList.Add( aFullFileName );
186  m_mruPath = currentPath = filename.GetPath();
187  }
188 
189  Erase_Current_DrawLayer( false );
190 
191  // Set the busy cursor
192  wxBusyCursor wait;
193 
194  return LoadListOfGerberAndDrillFiles( currentPath, filenamesList );
195 }
wxString m_mruPath
void Erase_Current_DrawLayer(bool query)
wxString AllFilesWildcard()
bool LoadListOfGerberAndDrillFiles(const wxString &aPath, const wxArrayString &aFilenameList, const std::vector< int > *aFileType=nullptr)
Load a list of Gerber and NC drill files and updates the view based on them.
#define _(s)
Definition: 3d_actions.cpp:33

References _, AllFilesWildcard(), Erase_Current_DrawLayer(), LoadListOfGerberAndDrillFiles(), and EDA_BASE_FRAME::m_mruPath.

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 177 of file job_file_reader.cpp.

178 {
179  wxFileName filename = aFullFileName;
180  wxString currentPath;
181  bool success = true;
182 
183  if( !filename.IsOk() )
184  {
185  // Use the current working directory if the file name path does not exist.
186  if( filename.DirExists() )
187  currentPath = filename.GetPath();
188  else
189  currentPath = m_mruPath;
190 
191  wxFileDialog dlg( this, _( "Open Gerber Job File" ),
192  currentPath,
193  filename.GetFullName(),
195  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_CHANGE_DIR );
196 
197  if( dlg.ShowModal() == wxID_CANCEL )
198  return false;
199 
200  filename = dlg.GetPath();
201  currentPath = filename.GetPath();
202  m_mruPath = currentPath;
203  }
204  else
205  {
206  currentPath = filename.GetPath();
207  m_mruPath = currentPath;
208  }
209 
210  wxString msg;
211  WX_STRING_REPORTER reporter( &msg );
212 
213  if( filename.IsOk() )
214  {
215  GERBER_JOBFILE_READER gbjReader( filename.GetFullPath(), &reporter );
216 
217  if( gbjReader.ReadGerberJobFile() )
218  {
219  // Update the list of recent drill files.
220  UpdateFileHistory( filename.GetFullPath(), &m_jobFileHistory );
221 
222  Clear_DrawLayers( false );
223  ClearMsgPanel();
224 
225  wxArrayString& gbrfiles = gbjReader.GetGerberFiles();
226 
227  success = LoadListOfGerberAndDrillFiles( currentPath, gbrfiles );
228  }
229  }
230 
232 
233  if( !msg.IsEmpty() )
234  {
235  wxSafeYield(); // Allows slice of time to redraw the screen
236  // to refresh widgets, before displaying messages
237  HTML_MESSAGE_BOX mbox( this, _( "Messages" ) );
238  mbox.ListSet( msg );
239  mbox.ShowModal();
240  }
241 
242  return success;
243 }
void SortLayersByX2Attributes()
bool Clear_DrawLayers(bool query)
wxString m_mruPath
FILE_HISTORY m_jobFileHistory
this class read and parse a Gerber job file to extract useful info for GerbView
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
bool LoadListOfGerberAndDrillFiles(const wxString &aPath, const wxArrayString &aFilenameList, const std::vector< int > *aFileType=nullptr)
Load a list of Gerber and NC drill files and updates the view based on them.
HTML_MESSAGE_BOX.
virtual void ClearMsgPanel()
Clear all messages from the message panel.
A wrapper for reporting to a wxString object.
Definition: reporter.h:159
wxString GerberJobFileWildcard()
#define _(s)
Definition: 3d_actions.cpp:33

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

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

◆ LoadListOfGerberAndDrillFiles()

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

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) if nullptr, files are expected Gerber type.
Returns
true if every file loaded successfully

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

201 {
202  wxFileName filename;
203 
204  // Read gerber files: each file is loaded on a new GerbView layer
205  bool success = true;
206  int layer = GetActiveLayer();
208 
209  // Manage errors when loading files
210  wxString msg;
211  WX_STRING_REPORTER reporter( &msg );
212 
213  // Create progress dialog (only used if more than 1 file to load
214  std::unique_ptr<WX_PROGRESS_REPORTER> progress = nullptr;
215 
216  for( unsigned ii = 0; ii < aFilenameList.GetCount(); ii++ )
217  {
218  filename = aFilenameList[ii];
219 
220  if( !filename.IsAbsolute() )
221  filename.SetPath( aPath );
222 
223  // Check for non existing files, to avoid creating broken or useless data
224  // and report all in one error list:
225  if( !filename.FileExists() )
226  {
227  wxString warning;
228  warning << "<b>" << _( "File not found:" ) << "</b><br>"
229  << filename.GetFullPath() << "<br>";
230  reporter.Report( warning, RPT_SEVERITY_WARNING );
231  success = false;
232  continue;
233  }
234 
235  m_lastFileName = filename.GetFullPath();
236 
237  if( !progress && ( aFilenameList.GetCount() > 1 ) )
238  {
239  progress = std::make_unique<WX_PROGRESS_REPORTER>( this,
240  _( "Loading Gerber files..." ), 1, false );
241  progress->SetMaxProgress( aFilenameList.GetCount() - 1 );
242  progress->Report( wxString::Format( _("Loading %u/%zu %s" ), ii+1,
243  aFilenameList.GetCount(), m_lastFileName ) );
244  }
245  else if( progress )
246  {
247  progress->Report( wxString::Format( _("Loading %u/%zu %s" ), ii+1,
248  aFilenameList.GetCount(), m_lastFileName ) );
249  progress->KeepRefreshing();
250  }
251 
252  SetActiveLayer( layer, false );
253 
254  visibility[ layer ] = true;
255 
256  if( aFileType && (*aFileType)[ii] == 1 )
257  {
258  LoadExcellonFiles( filename.GetFullPath() );
259  layer = GetActiveLayer(); // Loading NC drill file changes the active layer
260  }
261  else
262  {
263  if( filename.GetExt() == GerberJobFileExtension.c_str() )
264  {
265  //We cannot read a gerber job file as a gerber plot file: skip it
266  wxString txt;
267  txt.Printf(
268  _( "<b>A gerber job file cannot be loaded as a plot file</b> <i>%s</i>" ),
269  filename.GetFullName() );
270  success = false;
271  reporter.Report( txt, RPT_SEVERITY_ERROR );
272  }
273  else if( Read_GERBER_File( filename.GetFullPath() ) )
274  {
276 
277  layer = getNextAvailableLayer( layer );
278 
279  if( layer == NO_AVAILABLE_LAYERS && ii < aFilenameList.GetCount()-1 )
280  {
281  success = false;
282  reporter.Report( MSG_NO_MORE_LAYER, RPT_SEVERITY_ERROR );
283 
284  // Report the name of not loaded files:
285  ii += 1;
286  while( ii < aFilenameList.GetCount() )
287  {
288  filename = aFilenameList[ii++];
289  wxString txt = wxString::Format( MSG_NOT_LOADED, filename.GetFullName() );
290  reporter.Report( txt, RPT_SEVERITY_ERROR );
291  }
292  break;
293  }
294 
295  SetActiveLayer( layer, false );
296  }
297  }
298 
299  if( progress )
300  progress->AdvanceProgress();
301  }
302 
303  if( !success )
304  {
305  wxSafeYield(); // Allows slice of time to redraw the screen
306  // to refresh widgets, before displaying messages
307  HTML_MESSAGE_BOX mbox( this, _( "Errors" ) );
308  mbox.ListSet( msg );
309  mbox.ShowModal();
310  }
311 
313 
314  Zoom_Automatique( false );
315 
316  // Synchronize layers tools with actual active layer:
318 
319  // TODO: it would be nice if we could set the active layer to one of the
320  // ones that was just loaded, but to maintain the previous user experience
321  // we need to set it to a blank layer in case they load another file.
322  // We can't start with the next available layer when loading files because
323  // some users expect the behavior of overwriting the active layer on load.
324  SetActiveLayer( getNextAvailableLayer( layer ), true );
325 
327  syncLayerBox( true );
328 
329  GetCanvas()->Refresh();
330 
331  return success;
332 }
wxString m_lastFileName
void syncLayerBox(bool aRebuildLayerBox=false)
Update the currently "selected" layer within m_SelLayerBox.
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
GERBER_LAYER_WIDGET * m_LayersManager
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
bool Read_GERBER_File(const wxString &GERBER_FullFileName)
Definition: readgerb.cpp:40
void SetActiveLayer(int aLayer, bool doLayerWidgetUpdate=true)
change the currently active layer to aLayer and update the GERBER_LAYER_WIDGET.
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
#define MSG_NOT_LOADED
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.
LSET is a set of PCB_LAYER_IDs.
#define NO_AVAILABLE_LAYERS
void UpdateLayerIcons()
Function UpdateLayerIcons Update all layer manager icons (layers only) Useful when loading a file or ...
const std::string GerberJobFileExtension
HTML_MESSAGE_BOX.
#define MSG_NO_MORE_LAYER
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
A wrapper for reporting to a wxString object.
Definition: reporter.h:159
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
int GetActiveLayer() const
Return the active layer.
#define _(s)
Definition: 3d_actions.cpp:33
bool LoadExcellonFiles(const wxString &aFileName)
Load a drill (EXCELLON) file or many files.
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
int getNextAvailableLayer(int aLayer=0) const
Find the next empty layer starting at aLayer and returns it to the caller.
void ReFillLayerWidget()
Change out all the layers in m_Layers; called upon loading new gerber files.

References _, Format(), GerberJobFileExtension, GetActiveLayer(), EDA_DRAW_FRAME::GetCanvas(), getNextAvailableLayer(), GetVisibleLayers(), HTML_MESSAGE_BOX::ListSet(), LoadExcellonFiles(), m_lastFileName, m_LayersManager, MSG_NO_MORE_LAYER, MSG_NOT_LOADED, NO_AVAILABLE_LAYERS, Read_GERBER_File(), ReFillLayerWidget(), EDA_DRAW_PANEL_GAL::Refresh(), WX_STRING_REPORTER::Report(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, SetActiveLayer(), SetVisibleLayers(), syncLayerBox(), EDA_BASE_FRAME::UpdateFileHistory(), LAYER_WIDGET::UpdateLayerIcons(), visibility, and EDA_DRAW_FRAME::Zoom_Automatique().

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

◆ LoadSettings()

void GERBVIEW_FRAME::LoadSettings ( APP_SETTINGS_BASE aCfg)
overridevirtual

Load common frame parameters from a configuration file.

Don't forget to call the base method or your frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 294 of file gerbview_frame.cpp.

295 {
297 
298  if( aCfg->m_Window.grid.sizes.empty() )
299  {
300  aCfg->m_Window.grid.sizes = { "100 mil",
301  "50 mil",
302  "25 mil",
303  "20 mil",
304  "10 mil",
305  "5 mil",
306  "2.5 mil",
307  "2 mil",
308  "1 mil",
309  "0.5 mil",
310  "0.2 mil",
311  "0.1 mil",
312  "5.0 mm",
313  "2.5 mm",
314  "1.0 mm",
315  "0.5 mm",
316  "0.25 mm",
317  "0.2 mm",
318  "0.1 mm",
319  "0.05 mm",
320  "0.025 mm",
321  "0.01 mm" };
322  }
323 
324  if( aCfg->m_Window.zoom_factors.empty() )
325  {
327  }
328 
329  GERBVIEW_SETTINGS* cfg = dynamic_cast<GERBVIEW_SETTINGS*>( aCfg );
330  wxCHECK( cfg, /*void*/ );
331 
333 
334  PAGE_INFO pageInfo( wxT( "GERBER" ) );
335  pageInfo.SetType( cfg->m_Appearance.page_type );
336  SetPageSettings( pageInfo );
337 
340 
344 }
std::vector< wxString > m_JobFileHistory
FILE_HISTORY m_jobFileHistory
void SetPageSettings(const PAGE_INFO &aPageSettings) override
void Load(const APP_SETTINGS_BASE &aSettings)
Loads history from a JSON settings object.
Definition: filehistory.cpp:45
std::vector< double > zoom_factors
Definition: app_settings.h:86
FILE_HISTORY m_zipFileHistory
std::vector< wxString > sizes
Definition: app_settings.h:52
std::vector< wxString > m_DrillFileHistory
GRID_SETTINGS grid
Definition: app_settings.h:89
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:53
#define ZOOM_LIST_GERBVIEW
Definition: zoom_defines.h:29
FILE_HISTORY m_drillFileHistory
WINDOW_SETTINGS m_Window
Definition: app_settings.h:181
std::vector< wxString > m_ZipFileHistory
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void SetElementVisibility(int aLayerID, bool aNewState)
Change the visibility of an element category.

References WINDOW_SETTINGS::grid, LAYER_DCODES, LAYER_GERBVIEW_DRAWINGSHEET, LAYER_NEGATIVE_OBJECTS, FILE_HISTORY::Load(), EDA_DRAW_FRAME::LoadSettings(), GERBVIEW_SETTINGS::m_Appearance, GERBVIEW_SETTINGS::m_DrillFileHistory, m_drillFileHistory, GERBVIEW_SETTINGS::m_JobFileHistory, m_jobFileHistory, APP_SETTINGS_BASE::m_Window, GERBVIEW_SETTINGS::m_ZipFileHistory, m_zipFileHistory, GERBVIEW_SETTINGS::APPEARANCE::page_type, SetElementVisibility(), SetPageSettings(), PAGE_INFO::SetType(), GERBVIEW_SETTINGS::APPEARANCE::show_border_and_titleblock, GERBVIEW_SETTINGS::APPEARANCE::show_dcodes, GERBVIEW_SETTINGS::APPEARANCE::show_negative_objects, GRID_SETTINGS::sizes, WINDOW_SETTINGS::zoom_factors, and ZOOM_LIST_GERBVIEW.

Referenced by GERBVIEW_FRAME().

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

605 {
606  LoadWindowState( aCfg->state );
607 
608  if( m_hasAutoSave )
609  m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
610 
611  m_perspective = aCfg->perspective;
612  m_mruPath = aCfg->mru_path;
613 
614  TOOLS_HOLDER::CommonSettingsChanged( false, false );
615 }
wxString mru_path
Definition: app_settings.h:84
wxString m_mruPath
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void LoadWindowState(const wxString &aFileName)
wxString m_perspective
wxString perspective
Definition: app_settings.h:85
WINDOW_STATE state
Definition: app_settings.h:83
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.

References TOOLS_HOLDER::CommonSettingsChanged(), EDA_BASE_FRAME::LoadWindowState(), EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_perspective, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), and WINDOW_SETTINGS::state.

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString &  aFileName)
inherited

Definition at line 487 of file eda_base_frame.cpp.

488 {
489  if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
490  return;
491 
492  const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
493 
494  if( state != nullptr )
495  {
496  LoadWindowState( state->window );
497  }
498 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void LoadWindowState(const wxString &aFileName)
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:151
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
struct WINDOW_STATE window
const PROJECT_FILE_STATE * GetFileState(const wxString &aFileName)

References PROJECT_LOCAL_SETTINGS::GetFileState(), PROJECT::GetLocalSettings(), Pgm(), KIWAY_HOLDER::Prj(), and PROJECT_FILE_STATE::window.

Referenced by KICAD_MANAGER_FRAME::LoadProject(), PCB_EDIT_FRAME::LoadProjectSettings(), EDA_BASE_FRAME::LoadWindowSettings(), and SCH_EDIT_FRAME::OpenProjectFiles().

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE aState)
virtualinherited

Load frame state info from a configuration file.

Definition at line 501 of file eda_base_frame.cpp.

502 {
503  bool wasDefault = false;
504 
505  m_framePos.x = aState.pos_x;
506  m_framePos.y = aState.pos_y;
507  m_frameSize.x = aState.size_x;
508  m_frameSize.y = aState.size_y;
509 
510  wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
512 
513  // Ensure minimum size is set if the stored config was zero-initialized
514  if( m_frameSize.x < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
515  {
517  wasDefault = true;
518 
519  wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_frameSize.x, m_frameSize.y );
520  }
521 
522  wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
523 
524  if( aState.display >= wxDisplay::GetCount() )
525  {
526  wxLogTrace( traceDisplayLocation, "Previous display not found" );
527 
528  // If it isn't attached, use the first display
529  // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
530  const unsigned int index = 0;
531  wxDisplay display( index );
532  wxRect clientSize = display.GetGeometry();
533 
534  m_framePos = wxDefaultPosition;
535 
536  // Ensure the window fits on the display, since the other one could have been larger
537  if( m_frameSize.x > clientSize.width )
538  m_frameSize.x = clientSize.width;
539 
540  if( m_frameSize.y > clientSize.height )
541  m_frameSize.y = clientSize.height;
542  }
543  else
544  {
545  wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
546  wxPoint upperLeft( m_framePos.x, m_framePos.y );
547 
548  wxDisplay display( aState.display );
549  wxRect clientSize = display.GetClientArea();
550 
551  // The percentage size (represented in decimal) of the region around the screen's border where
552  // an upper corner is not allowed
553 #define SCREEN_BORDER_REGION 0.10
554 
555  int yLim = clientSize.y + ( clientSize.height * ( 1.0 - SCREEN_BORDER_REGION ) );
556  int xLimLeft = clientSize.x + ( clientSize.width * SCREEN_BORDER_REGION );
557  int xLimRight = clientSize.x + ( clientSize.width * ( 1.0 - SCREEN_BORDER_REGION ) );
558 
559  if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
560  upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
561  upperRight.y > yLim ) // Upper corner too close to the bottom of the screen
562  {
563  m_framePos = wxDefaultPosition;
564  wxLogTrace( traceDisplayLocation, "Resetting to default position" );
565  }
566  }
567 
568  // Ensure Window title bar is visible
569 #if defined( __WXOSX__ )
570  // for macOSX, the window must be below system (macOSX) toolbar
571  int Ypos_min = 20;
572 #else
573  int Ypos_min = 0;
574 #endif
575  if( m_framePos.y < Ypos_min )
576  m_framePos.y = Ypos_min;
577 
578  wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
580 
581  SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
582 
583  // Center the window if we reset to default
584  if( m_framePos.x == -1 )
585  {
586  wxLogTrace( traceDisplayLocation, "Centering window" );
587  Center();
588  m_framePos = GetPosition();
589  }
590 
591  // Record the frame sizes in an un-maximized state
594 
595  // Maximize if we were maximized before
596  if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
597  {
598  wxLogTrace( traceDisplayLocation, "Maximizing window" );
599  Maximize();
600  }
601 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxPoint m_normalFramePos
#define SCREEN_BORDER_REGION
wxSize m_normalFrameSize
static const wxSize defaultSize(FRAME_T aFrameType)
static const wxSize minSize(FRAME_T aFrameType)
unsigned int display
Definition: app_settings.h:75

References PCAD2KICAD::Center, defaultSize(), WINDOW_STATE::display, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_ident, EDA_BASE_FRAME::m_maximizeByDefault, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, minSize(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, SCREEN_BORDER_REGION, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.

◆ 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 598 of file gerbview/files.cpp.

599 {
600 #define ZipFileExtension "zip"
601 
602  wxFileName filename = aFullFileName;
603  wxString currentPath;
604 
605  if( !filename.IsOk() )
606  {
607  // Use the current working directory if the file name path does not exist.
608  if( filename.DirExists() )
609  currentPath = filename.GetPath();
610  else
611  currentPath = m_mruPath;
612 
613  wxFileDialog dlg( this, _( "Open Zip File" ), currentPath, filename.GetFullName(),
614  ZipFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_CHANGE_DIR );
615 
616  if( dlg.ShowModal() == wxID_CANCEL )
617  return false;
618 
619  filename = dlg.GetPath();
620  currentPath = wxGetCwd();
621  m_mruPath = currentPath;
622  }
623  else
624  {
625  currentPath = filename.GetPath();
626  m_mruPath = currentPath;
627  }
628 
629  wxString msg;
630  WX_STRING_REPORTER reporter( &msg );
631 
632  if( filename.IsOk() )
633  unarchiveFiles( filename.GetFullPath(), &reporter );
634 
635  Zoom_Automatique( false );
636 
637  // Synchronize layers tools with actual active layer:
641  syncLayerBox();
642 
643  if( !msg.IsEmpty() )
644  {
645  wxSafeYield(); // Allows slice of time to redraw the screen
646  // to refresh widgets, before displaying messages
647  HTML_MESSAGE_BOX mbox( this, _( "Messages" ) );
648  mbox.ListSet( msg );
649  mbox.ShowModal();
650  }
651 
652  return true;
653 }
wxString m_mruPath
void syncLayerBox(bool aRebuildLayerBox=false)
Update the currently "selected" layer within m_SelLayerBox.
GERBER_LAYER_WIDGET * m_LayersManager
void SetActiveLayer(int aLayer, bool doLayerWidgetUpdate=true)
change the currently active layer to aLayer and update the GERBER_LAYER_WIDGET.
wxString ZipFileWildcard()
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.
bool unarchiveFiles(const wxString &aFullFileName, REPORTER *aReporter=nullptr)
Extract gerber and drill files from the zip archive, and load them.
void UpdateLayerIcons()
Function UpdateLayerIcons Update all layer manager icons (layers only) Useful when loading a file or ...
HTML_MESSAGE_BOX.
A wrapper for reporting to a wxString object.
Definition: reporter.h:159
int GetActiveLayer() const
Return the active layer.
#define _(s)
Definition: 3d_actions.cpp:33
void ReFillLayerWidget()
Change out all the layers in m_Layers; called upon loading new gerber files.

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 OnZipFileHistory(), 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
false if the file was already locked, true otherwise.

Definition at line 188 of file eda_draw_frame.cpp.

189 {
190  m_file_checker = ::LockFile( aFileName );
191 
192  return bool( m_file_checker );
193 }
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
bool LockFile(const wxString &aFileName)
Mark a schematic file as being in use.

References EDA_DRAW_FRAME::m_file_checker.

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

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce)
inlineinherited

Definition at line 564 of file eda_base_frame.h.

565  {
566  m_isNonUserClose = true;
567  return Close( aForce );
568  }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onActivate()

void EDA_DRAW_FRAME::onActivate ( wxActivateEvent &  aEvent)
protectedinherited

Definition at line 1086 of file eda_draw_frame.cpp.

1087 {
1088  handleActivateEvent( aEvent );
1089 
1090  aEvent.Skip();
1091 }
virtual void handleActivateEvent(wxActivateEvent &aEvent)
Handle a window activation event.

References EDA_DRAW_FRAME::handleActivateEvent().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 294 of file eda_base_frame.cpp.

295 {
296  if( !doAutoSave() )
297  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
298 }
virtual bool doAutoSave()
This should be overridden by the derived class to handle the auto save feature.
wxTimer * m_autoSaveTimer

References EDA_BASE_FRAME::doAutoSave(), EDA_BASE_FRAME::m_autoSaveInterval, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  event)
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 FOOTPRINT_VIEWER_FRAME.

Definition at line 307 of file eda_base_frame.cpp.

308 {
309  wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( event ) );
310  // Key events can be filtered here.
311  // Currently no filtering is made.
312  event.Skip();
313 }
wxString dump(const wxArrayString &aArray)
Debug helper for printing wxArrayString contents.
const wxChar *const kicadTraceKeyEvent
Flag to enable wxKeyEvent debug tracing.

References dump(), and kicadTraceKeyEvent.

◆ OnClearDrlFileHistory()

void GERBVIEW_FRAME::OnClearDrlFileHistory ( wxCommandEvent &  aEvent)
private

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

77 {
79 }
FILE_HISTORY m_drillFileHistory
void ClearFileHistory(FILE_HISTORY *aFileHistory=nullptr)
Removes all files from the file history.

References EDA_BASE_FRAME::ClearFileHistory(), and m_drillFileHistory.

◆ OnClearGbrFileHistory()

void GERBVIEW_FRAME::OnClearGbrFileHistory ( wxCommandEvent &  aEvent)
private

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

57 {
59 }
void ClearFileHistory(FILE_HISTORY *aFileHistory=nullptr)
Removes all files from the file history.

References EDA_BASE_FRAME::ClearFileHistory().

◆ OnClearJobFileHistory()

void GERBVIEW_FRAME::OnClearJobFileHistory ( wxCommandEvent &  aEvent)
private

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

111 {
113 }
FILE_HISTORY m_jobFileHistory
void ClearFileHistory(FILE_HISTORY *aFileHistory=nullptr)
Removes all files from the file history.

References EDA_BASE_FRAME::ClearFileHistory(), and m_jobFileHistory.

◆ OnClearZipFileHistory()

void GERBVIEW_FRAME::OnClearZipFileHistory ( wxCommandEvent &  aEvent)
private

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

96 {
98 }
FILE_HISTORY m_zipFileHistory
void ClearFileHistory(FILE_HISTORY *aFileHis