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 }
 Specifies whether we are interacting with the undo or redo stacks. More...
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 GERBVIEW_FRAME (KIWAY *aKiway, wxWindow *aParent)
 
 ~GERBVIEW_FRAME ()
 
void doCloseWindow () override
 
bool OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl) override
 Open a project or set of files given by aFileList. More...
 
bool LoadListOfGerberAndDrillFiles (const wxString &aPath, const wxArrayString &aFilenameList, 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, const COLOR4D &aColor)
 
COLOR4D GetLayerColor (int aLayer) const
 
void SetLayerColor (int aLayer, const 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
 
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 given Gerber file or selected file(s), if the filename is empty. More...
 
bool Read_GERBER_File (const wxString &GERBER_FullFileName)
 
bool LoadExcellonFiles (const wxString &aFileName)
 Load a drill (EXCELLON) file or many files. More...
 
bool Read_EXCELLON_File (const wxString &aFullFileName)
 
bool LoadZipArchiveFile (const wxString &aFileName)
 Load a zipped archive file. More...
 
bool LoadGerberJobFile (const wxString &aFileName)
 Load a Gerber job file, and load gerber files found in job files. More...
 
bool Clear_DrawLayers (bool query)
 
void Erase_Current_DrawLayer (bool query)
 
void SortLayersByX2Attributes ()
 
void UpdateDiffLayers ()
 Update each layers' differential option. More...
 
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, const wxString &aGerberName)
 Show the dialog box for layer selection. More...
 
COLOR4D GetGridColor () override
 
virtual void SetGridColor (const COLOR4D &aColor) override
 
const BOX2I GetDocumentExtents (bool aIncludeAllVisible=true) const override
 Returns bbox of document with option to not include some items. More...
 
bool LockFile (const wxString &aFileName)
 Mark a schematic file as being in use. More...
 
void ReleaseFile ()
 Release the current file marked in use. More...
 
void ScriptingConsoleEnableDisable ()
 Toggles the scripting console visibility. More...
 
bool IsScriptingConsoleVisible ()
 Gets the current visibility of the scripting console window. More...
 
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 (const 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...
 
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...
 
const wxString GetZoomLevelIndicator () const
 Return a human readable value for display in dialogs. More...
 
virtual void OnSelectZoom (wxCommandEvent &event)
 Set the zoom factor when selected by the zoom list box in the main tool bar. More...
 
virtual void OnSize (wxSizeEvent &event) override
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
void OnMove (wxMoveEvent &aEvent) override
 
virtual void HardRedraw ()
 Rebuild the GAL and redraws the screen. More...
 
virtual void Zoom_Automatique (bool aWarpPointer)
 Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...
 
void FocusOnLocation (const 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
 
void DisplayConstraintsMsg (const wxString &msg)
 
virtual void OnPageSettingsChange ()
 Called when modifying the page settings. More...
 
void DisplayUnitsMsg ()
 Display current unit pane in the status bar. More...
 
void AppendMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
 Append a message to the message panel. More...
 
virtual void ClearMsgPanel ()
 Clear all messages from the message panel. More...
 
void SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
 Clear the message panel and populates it with the contents of aList. More...
 
void SetMsgPanel (EDA_ITEM *aItem)
 
void SetMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
 Helper function that erases the msg panel and then appends a single message. More...
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. More...
 
virtual 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)
 
void CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242). More...
 
EDA_UNITS GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS aUnits)
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
SETTINGS_MANAGERGetSettingsManager () const
 
virtual SEVERITY GetSeverity (int aErrorCode) const
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
virtual void OnCharHook (wxKeyEvent &aKeyEvent)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
virtual void RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
 Register a UI update handler for the control with ID aID. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
 Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...
 
virtual void UnregisterUIUpdateHandler (int aID) override
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
FRAME_T GetFrameType () const
 
virtual const SEARCH_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program. More...
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 Displays the preferences and settings of all opened editors paged dialog. More...
 
void PrintMsg (const wxString &text)
 
void CreateInfoBar ()
 
void FinishAUIInitialization ()
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...
 
void ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...
 
virtual APP_SETTINGS_BASEconfig () const
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
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, bool aVerbose=true)
 Checks if aFileName can be written. More...
 
virtual void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void ThemeChanged ()
 Process light/dark theme change. More...
 
virtual void ProjectChanged ()
 Notification event that the project has changed. More...
 
const wxString & GetAboutTitle () const
 
virtual bool IsContentModified () const
 Get if the contents of the frame have been modified since the last save. More...
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
virtual void ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)
 Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. More...
 
virtual void ClearUndoRedoList ()
 Clear the undo and redo list using ClearUndoORRedoList() More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Add a command to undo in the undo list. More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Add a command to redo in the redo list. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual int GetUndoCommandCount () const
 
virtual int GetRedoCommandCount () const
 
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)
 
std::vector< wxWindow * > findDialogs ()
 
void resolveCanvasType ()
 Determines the Canvas type to load (with prompt if required) and initializes m_canvasType. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
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...
 
void ensureWindowIsOnScreen ()
 

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
 
int m_displayIndex
 
wxPoint m_normalFramePos
 
wxSize m_normalFrameSize
 
wxString m_aboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 Map containing the UI update handlers registered with wx for each action. More...
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 Set by the close window event handler after frames are asked if they can close. More...
 
bool m_isClosing
 Set by NonUserClose() to indicate that the user did not request the current close. More...
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
MOUSE_DRAG_ACTION m_dragAction
 
bool m_moveWarpsCursor
 

Static Protected Attributes

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

Private Member Functions

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

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 39 of file kiway_holder.h.

◆ UNDO_REDO_LIST

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

Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 109 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ GERBVIEW_FRAME()

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

Definition at line 69 of file gerbview_frame.cpp.

70  : EDA_DRAW_FRAME( aKiway, aParent, FRAME_GERBER, wxT( "GerbView" ), wxDefaultPosition,
72  m_TextInfo( nullptr ),
74  ID_GERBVIEW_ZIP_FILE_LIST_CLEAR, _( "Clear Recent Zip Files" ) ),
76  ID_GERBVIEW_DRILL_FILE_LIST_CLEAR, _( "Clear Recent Drill Files" ) ),
78  ID_GERBVIEW_JOB_FILE_LIST_CLEAR, _( "Clear Recent Job Files" ) ),
79  m_activeLayer( 0 )
80 {
81  m_maximizeByDefault = true;
82  m_gerberLayout = nullptr;
84  m_showBorderAndTitleBlock = false; // true for reference drawings.
85  m_SelLayerBox = nullptr;
86  m_DCodeSelector = nullptr;
87  m_SelComponentBox = nullptr;
88  m_SelNetnameBox = nullptr;
89  m_SelAperAttributesBox = nullptr;
90  m_cmpText = nullptr;
91  m_netText = nullptr;
92  m_apertText = nullptr;
93  m_dcodeText = nullptr;
94  m_displayMode = 0;
95  m_aboutTitle = _( "KiCad Gerber Viewer" );
96 
97  SHAPE_POLY_SET dummy; // A ugly trick to force the linker to include
98  // some methods in code and avoid link errors
99 
100  int fileHistorySize = Pgm().GetCommonSettings()->m_System.file_history_size;
101  m_drillFileHistory.SetMaxFiles( fileHistorySize );
102  m_zipFileHistory.SetMaxFiles( fileHistorySize );
103  m_jobFileHistory.SetMaxFiles( fileHistorySize );
104 
105  auto* galCanvas = new GERBVIEW_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
108 
109  SetCanvas( galCanvas );
110 
111  // GerbView requires draw priority for rendering negative objects
112  galCanvas->GetView()->UseDrawPriority( true );
113 
114  // Give an icon
115  wxIcon icon;
116  wxIconBundle icon_bundle;
117 
118  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview ) );
119  icon_bundle.AddIcon( icon );
120  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview_32 ) );
121  icon_bundle.AddIcon( icon );
122  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview_16 ) );
123  icon_bundle.AddIcon( icon );
124 
125  SetIcons( icon_bundle );
126 
127  // Be sure a page info is set. this default value will be overwritten later.
128  PAGE_INFO pageInfo( wxT( "GERBER" ) );
129  SetLayout( new GBR_LAYOUT() );
130  SetPageSettings( pageInfo );
131 
132  SetVisibleLayers( LSET::AllLayersMask() ); // All draw layers visible.
133 
134  SetScreen( new BASE_SCREEN( GetPageSettings().GetSizeIU() ) );
135 
136  // Create the PCB_LAYER_WIDGET *after* SetLayout():
138 
139  // Update the minimum string length in the layer panel with the length of the last default layer
140  wxString lyrName = GetImagesList()->GetDisplayName( GetImagesList()->ImagesMaxCount(),
141  false, true );
143 
144  // LoadSettings() *after* creating m_LayersManager, because LoadSettings()
145  // initialize parameters in m_LayersManager
146  LoadSettings( config() );
147 
148  setupTools();
150  ReCreateMenuBar();
154 
155  m_auimgr.SetManagedWindow( this );
156 
157  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer( 6 ) );
158  m_auimgr.AddPane( m_auxiliaryToolBar, EDA_PANE().HToolbar().Name( "AuxToolbar" ).Top()
159  .Layer(4) );
160  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom()
161  .Layer( 6 ) );
162  m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" ).Left()
163  .Layer( 3 ) );
164  m_auimgr.AddPane( m_LayersManager, EDA_PANE().Palette().Name( "LayersManager" ).Right()
165  .Layer( 3 ).Caption( _( "Layers Manager" ) ).PaneBorder( false )
166  .MinSize( 80, -1 ).BestSize( m_LayersManager->GetBestSize() ) );
167 
168  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
169 
170  ReFillLayerWidget(); // this is near end because contents establish size
171  m_auimgr.Update();
172 
173  SetActiveLayer( 0, true );
175 
177 
179 
180  setupUnits( config() );
181 
182  // Enable the axes to match legacy draw style
183  auto& galOptions = GetGalDisplayOptions();
184  galOptions.m_axesEnabled = true;
185  galOptions.NotifyChanged();
186 
188  m_LayersManager->ReFillRender(); // Update colors in Render after the config is read
189 
191 
192  // Ensure the window is on top
193  Raise();
194 
195  // Register a call to update the toolbar sizes. It can't be done immediately because
196  // it seems to require some sizes calculated that aren't yet (at least on GTK).
197  CallAfter( [&]()
198  {
199  // Ensure the controls on the toolbars all are correctly sized
201  } );
202 }
A list of GERBER_DRAW_ITEM objects currently loaded.
Definition: gbr_layout.h:45
wxSize GetBestSize() const
Return the preferred minimum size, taking into consideration the dynamic content.
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:96
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:143
void resolveCanvasType()
Determines the Canvas type to load (with prompt if required) and initializes m_canvasType.
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:141
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
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
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
#define _(s)
static LSET AllLayersMask()
Definition: lset.cpp:796
Abstract functions of LAYER_WIDGET so they may be tied into the GERBVIEW_FRAME's data and we can add ...
#define KICAD_DEFAULT_DRAWFRAME_STYLE
FILE_HISTORY m_drillFileHistory
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
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 ReFill()
Rebuild Render for instance after the config is read.
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.
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:54
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
void 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
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 205 of file gerbview_frame.cpp.

206 {
207  // Ensure m_canvasType is up to date, to save it in config
209 
210  // Shutdown all running tools
211  if( m_toolManager )
213 
214  GetCanvas()->GetView()->Clear();
215 
217  delete m_gerberLayout;
218 }
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.
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
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:1100
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:158
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Definition: gbr_layout.cpp:41
GAL_TYPE GetBackend() const
Return the type of backend currently used by GAL canvas.

References KIGFX::VIEW::Clear(), GERBER_FILE_IMAGE_LIST::DeleteAllImages(), EDA_DRAW_PANEL_GAL::GetBackend(), EDA_DRAW_FRAME::GetCanvas(), GetGerberLayout(), GBR_LAYOUT::GetImagesList(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_FRAME::m_canvasType, 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 1025 of file gerbview_frame.cpp.

1026 {
1028 
1029  EDA_DRAW_PANEL_GAL* galCanvas = GetCanvas();
1030 
1031  if( m_toolManager )
1032  {
1034  GetCanvas()->GetViewControls(), config(), this );
1036  }
1037 
1039 
1041 
1042  galCanvas->GetView()->RecacheAllItems();
1043  galCanvas->SetEventDispatcher( m_toolDispatcher );
1044  galCanvas->StartDrawing();
1045 
1048 
1050  ReCreateMenuBar();
1051 }
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:1385
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:160
const PAGE_INFO & GetPageSettings() const override
void ReFill()
Rebuild Render for instance after the config is read.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
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()
Rebuild Render for instance after the config is read.
void ReCreateMenuBar() override
Recreates the menu bar.
Rendering engine changes.
Definition: tool_base.h:81
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 460 of file eda_base_frame.cpp.

461 {
462  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
463  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
464 
465  helpMenu->Add( ACTIONS::help );
466  helpMenu->Add( ACTIONS::gettingStarted );
467  helpMenu->Add( ACTIONS::listHotKeys );
468  helpMenu->Add( ACTIONS::getInvolved );
469  helpMenu->Add( ACTIONS::donate );
470  helpMenu->Add( ACTIONS::reportBug );
471 
472  helpMenu->AppendSeparator();
473  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
474 
475  // Trailing space keeps OSX from hijacking our menu (and disabling everything in it).
476  aMenuBar->Append( helpMenu, _( "&Help" ) + wxS( " " ) );
477 }
static TOOL_ACTION listHotKeys
Definition: actions.h:179
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
static TOOL_ACTION reportBug
Cursor control event types.
Definition: actions.h:182
static TOOL_ACTION donate
Definition: actions.h:180
#define _(s)
Handle actions that are shared between different applications.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
static TOOL_ACTION help
Definition: actions.h:178
static TOOL_ACTION getInvolved
Definition: actions.h:181
static TOOL_ACTION gettingStarted
Definition: actions.h:177

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

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

zoom and grid).

Definition at line 492 of file eda_draw_frame.cpp.

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

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

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

◆ AppendMsgPanel()

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

Append a message to the message panel.

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

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

Definition at line 652 of file eda_draw_frame.cpp.

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

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

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

◆ applyDisplaySettingsToGAL()

void GERBVIEW_FRAME::applyDisplaySettingsToGAL ( )
private

Updates the GAL with display settings changes.

Definition at line 457 of file gerbview_frame.cpp.

458 {
459  auto painter = static_cast<KIGFX::GERBVIEW_PAINTER*>( GetCanvas()->GetView()->GetPainter() );
460  KIGFX::GERBVIEW_RENDER_SETTINGS* settings = painter->GetSettings();
463 
465 }
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:609
GBR_DISPLAY_OPTIONS m_DisplayOptions
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
Store GerbView specific render settings.
void LoadColors(const COLOR_SETTINGS *aSettings) override
void LoadDisplayOptions(const GBR_DISPLAY_OPTIONS &aOptions)
Load 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 1203 of file eda_base_frame.cpp.

1204 {
1205  SetUserUnits( aUnits );
1207 
1208  wxCommandEvent e( UNITS_CHANGED );
1209  ProcessEventLocally( e );
1210 }
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)
virtualinherited

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

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

Parameters
aFileNameA wxFileName object containing the file name to check.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1091 of file eda_base_frame.cpp.

1092 {
1093  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
1094 
1095  wxFileName autoSaveFileName = aFileName;
1096 
1097  // Check for auto save file.
1098  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
1099 
1100  wxLogTrace( traceAutoSave,
1101  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
1102 
1103  if( !autoSaveFileName.FileExists() )
1104  return;
1105 
1106  wxString msg = wxString::Format( _(
1107  "Well this is potentially embarrassing!\n"
1108  "It appears that the last time you were editing the file\n"
1109  "%s\n"
1110  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
1111  aFileName.GetFullName()
1112  );
1113 
1114  int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
1115  this );
1116 
1117  // Make a backup of the current file, delete the file, and rename the auto save file to
1118  // the file name.
1119  if( response == wxYES )
1120  {
1121  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1122  {
1123  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1124  Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1125  }
1126  }
1127  else
1128  {
1129  wxLogTrace( traceAutoSave,
1130  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1131 
1132  // Remove the auto save file when using the previous file as is.
1133  wxRemoveFile( autoSaveFileName.GetFullPath() );
1134  }
1135 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static wxString GetAutoSaveFilePrefix()

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ Clear_DrawLayers()

bool GERBVIEW_FRAME::Clear_DrawLayers ( bool  query)

Definition at line 40 of file clear_gbr_drawlayers.cpp.

41 {
42  if( GetGerberLayout() == nullptr )
43  return false;
44 
45  if( query && GetScreen()->IsContentModified() )
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:80
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:78
void Clear()
Remove all items from the view.
Definition: view.cpp:1100
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Reset all tools (i.e.
#define _(s)
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
GBR_LAYOUT * GetGerberLayout() const
virtual bool IsContentModified() const
Get if the contents of the frame have been modified since the last save.
const PAGE_INFO & GetPageSettings() const override
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
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:323
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(), EDA_BASE_FRAME::IsContentModified(), IsOK(), TOOLS_HOLDER::m_toolManager, TOOL_BASE::MODEL_RELOAD, 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 976 of file eda_base_frame.cpp.

977 {
978  if( !aFileHistory )
979  aFileHistory = m_fileHistory;
980 
981  wxASSERT( aFileHistory );
982 
983  aFileHistory->ClearFileHistory();
984 
985  // Update the menubar to update the file history menu
986  if( GetMenuBar() )
987  {
988  ReCreateMenuBar();
989  GetMenuBar()->Refresh();
990  }
991 }
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

Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.

Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN. Commands are deleted from the older to the last.

Parameters
aList= the UNDO_REDO_CONTAINER of commands.
aItemCountnumber of old commands to delete. -1 to remove all old commands this will empty the list of commands.

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 545 of file eda_base_frame.h.

546  { }

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

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

1196 {
1197  EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
1198 
1199  RecreateToolbars();
1200  Layout();
1201  SendSizeEvent();
1202 }
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 816 of file eda_base_frame.cpp.

817 {
818  // KICAD_MANAGER_FRAME overrides this
819  return Kiface().KifaceSettings();
820 }
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:92

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

Referenced by 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(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), Read_EXCELLON_File(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), and BM2CMP_FRAME::~BM2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited

Get the configuration base name.

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

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

Reimplemented from TOOLS_HOLDER.

Definition at line 358 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

Definition at line 841 of file eda_base_frame.cpp.

842 {
843 #if defined( __WXOSX_MAC__ )
845 #else
846  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
847 
848  m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( wxT( "InfoBar" ) ).Top().Layer(1) );
849 #endif
850 }
wxAuiManager m_auimgr
virtual wxWindow * GetToolCanvas() const =0
Canvas access.
Specialization of the wxAuiPaneInfo class for KiCad panels.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:73
WX_INFOBAR * m_infoBar

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

◆ CreateServer()

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

Definition at line 43 of file eda_dde.cpp.

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

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

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

◆ CurrentToolName()

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

Definition at line 100 of file tools_holder.cpp.

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

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

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

◆ Destroy()

◆ DismissModal()

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

Definition at line 166 of file kiway_player.cpp.

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

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

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

◆ DisplayConstraintsMsg()

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

Definition at line 518 of file eda_draw_frame.cpp.

519 {
520  SetStatusText( msg, 7 );
521 }

Referenced by DRAWING_TOOL::updateStatusBar().

◆ DisplayGridMsg()

void GERBVIEW_FRAME::DisplayGridMsg ( )
overridevirtual

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 943 of file gerbview_frame.cpp.

944 {
945  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
946  wxString line;
947 
948  line.Printf( wxT( "grid X %s Y %s" ),
949  MessageTextFromValue( m_userUnits, gridSize.x, false ),
950  MessageTextFromValue( m_userUnits, gridSize.y, false ) );
951 
952  SetStatusText( line, 4 );
953  SetStatusText( line, 4 );
954 }
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:104
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.
const VECTOR2D & GetGridSize() const
Return the grid size.
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

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

Referenced by UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 512 of file eda_draw_frame.cpp.

513 {
514  SetStatusText( msg, 6 );
515 }

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

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

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

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

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

328 {
329  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
330 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void GERBVIEW_FRAME::doCloseWindow ( )
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 221 of file gerbview_frame.cpp.

222 {
223  // No more vetos
224  m_isClosing = true;
225  GetCanvas()->StopDrawing();
226  GetCanvas()->GetView()->Clear();
227 
228  if( m_toolManager )
230 
231  // Be sure any OpenGL event cannot be fired after frame deletion:
232  GetCanvas()->SetEvtHandlerEnabled( false );
233 
234  Destroy();
235 }
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:1100
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.

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

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )
protectedinherited

Definition at line 657 of file eda_base_frame.cpp.

658 {
659  wxDisplay display( wxDisplay::GetFromWindow( this ) );
660  wxRect clientSize = display.GetClientArea();
661  wxPoint pos = GetPosition();
662  wxSize size = GetWindowSize();
663 
664  wxLogTrace( traceDisplayLocation,
665  wxT( "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d" ), clientSize.x, clientSize.y,
666  clientSize.width, clientSize.height );
667 
668  if( pos.y < clientSize.y )
669  {
670  wxLogTrace( traceDisplayLocation,
671  wxT( "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d" ), pos.y,
672  clientSize.y );
673  pos.y = clientSize.y;
674  }
675 
676  if( pos.x < clientSize.x )
677  {
678  wxLogTrace( traceDisplayLocation,
679  wxT( "ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d" ), pos.x,
680  clientSize.x );
681  pos.x = clientSize.x;
682  }
683 
684  if( pos.x + size.x - clientSize.x > clientSize.width )
685  {
686  int newWidth = clientSize.width - ( pos.x - clientSize.x );
687  wxLogTrace( traceDisplayLocation,
688  wxT( "ensureWindowIsOnScreen: effective width %d above available %d, setting to %d" ),
689  pos.x + size.x, clientSize.width, newWidth );
690  size.x = newWidth;
691  }
692 
693  if( pos.y + size.y - clientSize.y > clientSize.height )
694  {
695  int newHeight = clientSize.height - ( pos.y - clientSize.y );
696  wxLogTrace( traceDisplayLocation,
697  wxT( "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d" ),
698  pos.y + size.y, clientSize.height, newHeight );
699  size.y = newHeight;
700  }
701 
702  wxLogTrace( traceDisplayLocation, wxT( "Updating window position (%d, %d) with size (%d, %d)" ),
703  pos.x, pos.y, size.x, size.y );
704 
705  SetSize( pos.x, pos.y, size.x, size.y );
706 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ 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:80
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.
#define _(s)
int GetActiveLayer() const
Return the active layer.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
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:323
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 305 of file eda_draw_frame.cpp.

306 {
307  if( m_messagePanel )
309 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:198

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

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

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 196 of file kiway_player.h.

196 {}

Referenced by KIWAY_PLAYER::OnSockRequest().

◆ findDialogs()

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

Definition at line 842 of file eda_draw_frame.cpp.

843 {
844  std::vector<wxWindow*> dialogs;
845 
846  for( wxWindow* window : GetChildren() )
847  {
848  if( dynamic_cast<DIALOG_SHIM*>( window ) )
849  dialogs.push_back( window );
850  }
851 
852  return dialogs;
853 }

Referenced by PCB_BASE_FRAME::FocusOnItems(), and EDA_DRAW_FRAME::FocusOnLocation().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 853 of file eda_base_frame.cpp.

854 {
855 #if defined( __WXOSX_MAC__ )
856  m_auimgr.Update();
857 #else
858  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
859  // hiding it.
860  m_auimgr.Update();
861 
862  // We don't want the infobar displayed right away
863  m_auimgr.GetPane( wxT( "InfoBar" ) ).Hide();
864  m_auimgr.Update();
865 #endif
866 }
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 856 of file eda_draw_frame.cpp.

857 {
858  bool centerView = false;
859  BOX2D r = GetCanvas()->GetView()->GetViewport();
860 
861  // Center if we're off the current view, or within 10% of its edge
862  r.Inflate( - (int) r.GetWidth() / 10 );
863 
864  if( !r.Contains( aPos ) )
865  centerView = true;
866 
867  std::vector<BOX2D> dialogScreenRects;
868 
869  for( wxWindow* dialog : findDialogs() )
870  {
871  dialogScreenRects.emplace_back( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
872  dialog->GetSize() );
873  }
874 
875  // Center if we're behind an obscuring dialog, or within 10% of its edge
876  for( BOX2D rect : dialogScreenRects )
877  {
878  rect.Inflate( rect.GetWidth() / 10 );
879 
880  if( rect.Contains( GetCanvas()->GetView()->ToScreen( aPos ) ) )
881  centerView = true;
882  }
883 
884  if( centerView )
885  {
886  try
887  {
888  GetCanvas()->GetView()->SetCenter( aPos, dialogScreenRects );
889  }
890  catch( const ClipperLib::clipperException& exc )
891  {
892  wxLogError( wxT( "Clipper library error '%s' occurred centering object." ),
893  exc.what() );
894  }
895  }
896 
898 }
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition: view.cpp:512
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:578
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.
E_SERIE r
Definition: eserie.cpp:41
std::vector< wxWindow * > findDialogs()

References EDA_DRAW_FRAME::findDialogs(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), KIGFX::VIEW::GetViewport(), r, KIGFX::VIEW::SetCenter(), and KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition().

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

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetActiveLayer()

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )
inlinestaticprotectedinherited

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 204 of file eda_base_frame.h.

204 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

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

419 { 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(), 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(), unarchiveFiles(), ZOOM_MENU::update(), UpdateDiffLayers(), 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_VIEWER_FRAME, DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 1040 of file eda_draw_frame.cpp.

1041 {
1042  if( !m_colorSettings )
1043  {
1044  COLOR_SETTINGS* colorSettings = Pgm().GetSettingsManager().GetColorSettings();
1045 
1046  const_cast<EDA_DRAW_FRAME*>( this )->m_colorSettings = colorSettings;
1047  }
1048 
1049  return m_colorSettings;
1050 }
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::UpdateDrawingSheetExample().

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const
inlinevirtualinherited

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

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

Returns
the filename and full path to the open file

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 439 of file eda_base_frame.h.

439 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

SELECTION & GERBVIEW_FRAME::GetCurrentSelection ( )
overridevirtual

Get the current selection from the canvas area.

Returns
the current selection.

Reimplemented from TOOLS_HOLDER.

Definition at line 1205 of file gerbview_frame.cpp.

1206 {
1207  return m_toolManager->GetTool<GERBVIEW_SELECTION_TOOL>()->GetSelection();
1208 }
Selection tool for GerbView, based on the one in Pcbnew.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158

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

100 { 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 drawing sheet border, and "false" by "Zoom To Objects" to ignore drawing sheet border. In Pcbnew, false makes it ignore any items outside the PCB edge such as fabrication notes.

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 467 of file gerbview_frame.h.

468  {
469  wxASSERT( m_gerberLayout );
470  return m_gerberLayout->ViewBBox();
471  }
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:257

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

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

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const
inlineinherited

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

Definition at line 135 of file tools_holder.h.

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

References TOOLS_HOLDER::m_dragAction.

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

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

◆ GetFileFromHistory()

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

Fetches the file name from the file history list.

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

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

Definition at line 936 of file eda_base_frame.cpp.

938 {
939  if( !aFileHistory )
940  aFileHistory = m_fileHistory;
941 
942  wxASSERT( aFileHistory );
943 
944  int baseId = aFileHistory->GetBaseId();
945 
946  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
947 
948  unsigned i = cmdId - baseId;
949 
950  if( i < aFileHistory->GetCount() )
951  {
952  wxString fn = aFileHistory->GetHistoryFile( i );
953 
954  if( wxFileName::FileExists( fn ) )
955  {
956  return fn;
957  }
958  else
959  {
960  DisplayErrorMessage( this, wxString::Format( _( "File '%s' was not found." ), fn ) );
961  aFileHistory->RemoveFileFromHistory( i );
962  }
963  }
964 
965  // Update the menubar to update the file history menu
966  if( GetMenuBar() )
967  {
968  ReCreateMenuBar();
969  GetMenuBar()->Refresh();
970  }
971 
972  return wxEmptyString;
973 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:292
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

Referenced by 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 423 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )
inlineinherited

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const
inlineinherited

Definition at line 207 of file eda_base_frame.h.

207 { return m_ident; }

References EDA_BASE_FRAME::m_ident.

◆ GetGalDisplayOptions()

◆ GetGbrImage()

◆ GetGerberLayout()

◆ GetGridColor()

COLOR4D GERBVIEW_FRAME::GetGridColor ( )
overridevirtual

Returns
the color of the grid

Reimplemented from EDA_DRAW_FRAME.

Definition at line 929 of file gerbview_frame.cpp.

930 {
931  return Pgm().GetSettingsManager().GetColorSettings()->GetColor( LAYER_GRID );
932 }
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 434 of file gerbview_frame.h.

434 { 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 395 of file eda_draw_frame.h.

395 { 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 841 of file gerbview_frame.cpp.

842 {
843  return Pgm().GetSettingsManager().GetColorSettings()->GetColor( aLayer );
844 }
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 582 of file eda_base_frame.h.

582 { 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 141 of file tools_holder.h.

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

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

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

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

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

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

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

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

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

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

833 {
836  else
837  return GetDrawBgColor();
838 }
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 468 of file gerbview_frame.cpp.

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

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

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

165  { return m_originTransforms; }
ORIGIN_TRANSFORMS m_originTransforms

References EDA_DRAW_FRAME::m_originTransforms.

Referenced by PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), and EDA_SHAPE::ShapeGetMsgPanelInfo().

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

907 {
908  // this function is only needed because EDA_DRAW_FRAME is not compiled
909  // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
910  // into an application specific source file.
911  return GetPageSettings().GetSizeIU();
912 }
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 957 of file eda_draw_frame.cpp.

958 {
959  // Virtual function. Base class implementation returns an empty string.
960  return wxEmptyString;
961 }

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

◆ GetSettingsManager()

SETTINGS_MANAGER* EDA_BASE_FRAME::GetSettingsManager ( ) const
inlineinherited

Definition at line 140 of file eda_base_frame.h.

140 { return m_settingsManager; }
SETTINGS_MANAGER * m_settingsManager

References EDA_BASE_FRAME::m_settingsManager.

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

◆ GetSeverity()

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

Reimplemented in PCB_BASE_FRAME, and SCH_EDIT_FRAME.

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

120 { return m_polarCoords; }

References EDA_DRAW_FRAME::m_polarCoords.

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

◆ GetTitleBlock()

const TITLE_BLOCK & GERBVIEW_FRAME::GetTitleBlock ( ) const
overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 915 of file gerbview_frame.cpp.

916 {
917  wxASSERT( m_gerberLayout );
918  return m_gerberLayout->GetTitleBlock();
919 }
TITLE_BLOCK & GetTitleBlock()
Definition: gbr_layout.h:63
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 422 of file eda_draw_frame.h.

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

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 54 of file tools_holder.h.

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

References TOOLS_HOLDER::m_toolManager.

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 46 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const
inlinevirtualinherited

◆ GetUnitPair()

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

Get the pair or units in current use.

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

Definition at line 1075 of file eda_draw_frame.cpp.

1076 {
1078 
1079  aPrimaryUnit = GetUserUnits();
1080  aSecondaryUnits = EDA_UNITS::MILS;
1081 
1082  if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
1083  {
1084  if( cmnTool )
1085  aSecondaryUnits = cmnTool->GetLastMetricUnits();
1086  else
1087  aSecondaryUnits = EDA_UNITS::MILLIMETRES;
1088  }
1089  else
1090  {
1091  if( cmnTool )
1092  aSecondaryUnits = cmnTool->GetLastImperialUnits();
1093  else
1094  aSecondaryUnits = EDA_UNITS::MILS;
1095  }
1096 }
EDA_UNITS GetLastMetricUnits()
Definition: common_tools.h:74
bool IsImperialUnit(EDA_UNITS aUnit)
Definition: eda_units.cpp:26
EDA_UNITS GetLastImperialUnits()
Definition: common_tools.h:75
Handles action that are shared between different applications.
Definition: common_tools.h:37
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

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

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

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 126 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), EE_INSPECTION_TOOL::CheckSymbol(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_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(), SCH_PIN::GetMsgPanelInfo(), PL_EDITOR_LAYOUT::GetMsgPanelInfo(), PCB_MARKER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), FP_TEXT_GRID_TABLE::GetValue(), PIN_TABLE_DATA_MODEL::GetValue(), RC_TREE_MODEL::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), FP_TEXT_GRID_TABLE::SetValue(), PIN_TABLE_DATA_MODEL::SetValue(), EDA_SHAPE::ShapeGetMsgPanelInfo(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), PIN_TABLE_DATA_MODEL::SortRows(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), 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(), ROUTER_TOOL::UpdateMessagePanel(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), UpdateStatusBar(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_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 761 of file gerbview_frame.cpp.

762 {
763  COLOR4D color = COLOR4D::UNSPECIFIED;
764  COLOR_SETTINGS* settings = Pgm().GetSettingsManager().GetColorSettings();
765 
766  switch( aLayerID )
767  {
769  case LAYER_DCODES:
772  color = settings->GetColor( aLayerID );
773  break;
774 
775  case LAYER_GERBVIEW_GRID:
776  color = GetGridColor();
777  break;
778 
779  default:
780  wxFAIL_MSG( wxString::Format( wxT( "GERBVIEW_FRAME::GetVisibleElementColor(): bad arg %d" ),
781  aLayerID ) );
782  }
783 
784  return color;
785 }
int color
Definition: DXF_plotter.cpp:57
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:103

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

726 {
727  LSET visible = LSET::AllLayersMask();
728 
729  if( GetCanvas() )
730  {
731  for( int i = 0; i < GERBER_DRAWLAYERS_COUNT; i++ )
732  visible[i] = GetCanvas()->GetView()->IsLayerVisible( GERBER_DRAW_LAYER( i ) );
733  }
734 
735  return visible;
736 }
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.
Definition: layer_ids.h:516
#define GERBER_DRAWLAYERS_COUNT
Definition: layer_ids.h:390
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
static LSET AllLayersMask()
Definition: lset.cpp:796
#define GERBER_DRAW_LAYER(x)
Definition: layer_ids.h:410
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition: view.h:405

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

Definition at line 810 of file eda_base_frame.cpp.

811 {
812  return &aCfg->m_Window;
813 }
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 1237 of file eda_base_frame.cpp.

1238 {
1239 #ifdef __WXGTK__
1240  wxSize winSize = GetSize();
1241 
1242  // GTK includes the window decorations in the normal GetSize call,
1243  // so we have to use a GTK-specific sizing call that returns the
1244  // non-decorated window size.
1245  if( m_ident == KICAD_MAIN_FRAME_T )
1246  {
1247  int width = 0;
1248  int height = 0;
1249  GTKDoGetSize( &width, &height );
1250 
1251  winSize.Set( width, height );
1252  }
1253 #else
1254  wxSize winSize = GetSize();
1255 #endif
1256 
1257  return winSize;
1258 }

References KICAD_MAIN_FRAME_T, and EDA_BASE_FRAME::m_ident.

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

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const
inherited

Return a human readable value for display in dialogs.

Definition at line 574 of file eda_draw_frame.cpp.

575 {
576  // returns a human readable value which can be displayed as zoom
577  // level indicator in dialogs.
578  double zoom = m_canvas->GetGAL()->GetZoomFactor();
579  return wxString::Format( wxT( "Z %.2f" ), zoom );
580 }
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 1127 of file eda_draw_frame.cpp.

1128 {
1129  // Force a refresh of the message panel to ensure that the text is the right color
1130  // when the window activates
1131  if( !IsIconized() )
1132  m_messagePanel->Refresh();
1133 }
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 1261 of file eda_base_frame.cpp.

1262 {
1263  // Update the icon theme when the system theme changes and update the toolbars
1265  ThemeChanged();
1266 
1267  // This isn't handled by ThemeChanged()
1268  if( GetMenuBar() )
1269  {
1270  // For icons in menus, icon scaling & hotkeys
1271  ReCreateMenuBar();
1272  GetMenuBar()->Refresh();
1273  }
1274 }
void ThemeChanged()
Notifies the store that the icon theme has been changed by the user, so caches must be invalidated.
virtual void ThemeChanged()
Process light/dark theme change.
virtual void ReCreateMenuBar()
Recreates the menu bar.
BITMAP_STORE * GetBitmapStore()
Definition: bitmap.cpp:93

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

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

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

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

enabled, checked, etc.).

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

Definition at line 376 of file eda_base_frame.cpp.

378 {
379  bool checkRes = false;
380  bool enableRes = true;
381  bool showRes = true;
382  bool isCut = aEvent.GetId() == ACTIONS::cut.GetUIId();
383  bool isCopy = aEvent.GetId() == ACTIONS::copy.GetUIId();
384  bool isPaste = aEvent.GetId() == ACTIONS::paste.GetUIId();
385  SELECTION& selection = aFrame->GetCurrentSelection();
386 
387  try
388  {
389  checkRes = aCond.checkCondition( selection );
390  enableRes = aCond.enableCondition( selection );
391  showRes = aCond.showCondition( selection );
392  }
393  catch( std::exception& )
394  {
395  // Something broke with the conditions, just skip the event.
396  aEvent.Skip();
397  return;
398  }
399 
400  if( isCut || isCopy || isPaste )
401  {
402  wxWindow* focus = wxWindow::FindFocus();
403  wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( focus );
404 
405  if( textEntry && isCut && textEntry->CanCut() )
406  enableRes = true;
407  else if( textEntry && isCopy && textEntry->CanCopy() )
408  enableRes = true;
409  else if( textEntry && isPaste && textEntry->CanPaste() )
410  enableRes = true;
411  }
412 
413  aEvent.Enable( enableRes );
414  aEvent.Show( showRes );
415 
416  // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
417  // checked, since wxMenuItems don't want to be checked unless they actually are checkable
418 #if wxCHECK_VERSION( 3, 1, 5 )
419  if( aEvent.IsCheckable() )
420  aEvent.Check( checkRes );
421 #else
422  bool canCheck = true;
423 
424  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to
425  // check to see if they can be and can't just universally apply a check in this event.
426  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
427  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
428 
429  if( canCheck )
430  aEvent.Check( checkRes );
431 #endif
432 }
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
int GetUIId() const
Definition: tool_action.h:130
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
static TOOL_ACTION copy
Definition: actions.h:67
static TOOL_ACTION cut
Definition: actions.h:66
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:101
static TOOL_ACTION paste
Definition: actions.h:68

References ACTION_CONDITIONS::checkCondition, ACTIONS::copy, ACTIONS::cut, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), TOOL_ACTION::GetUIId(), ACTIONS::paste, and ACTION_CONDITIONS::showCondition.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

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

830 {
831  // To be implemented by subclasses.
832 }

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

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

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImagesMaxCount()

unsigned GERBVIEW_FRAME::ImagesMaxCount ( ) const

The max number of file images.

Definition at line 1010 of file gerbview_frame.cpp.

1011 {
1013 }
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 1145 of file eda_base_frame.cpp.

1146 {
1147  wxAcceleratorEntry entries[1];
1148  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
1149  wxAcceleratorTable accel( 1, entries );
1150  SetAcceleratorTable( accel );
1151 }

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

1056 {
1057  wxTreebook* book = aParent->GetTreebook();
1058 
1059  book->AddPage( new wxPanel( book ), _( "GerbView" ) );
1060  book->AddSubPage( new PANEL_GERBVIEW_DISPLAY_OPTIONS( this, book ),
1061  _( "Display Options" ) );
1062  book->AddSubPage( new PANEL_GERBVIEW_SETTINGS( this, book ), _( "Editing Options" ) );
1063  book->AddSubPage( new PANEL_GERBVIEW_EXCELLON_SETTINGS( this, book ),
1064  _( "Excellon Options" ) );
1065 
1066  aHotkeysPanel->AddHotKeys( GetToolManager() );
1067 }
void AddHotKeys(TOOL_MANAGER *aToolMgr)
wxTreebook * GetTreebook()
Definition: paged_dialog.h:37
#define _(s)
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54

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

617 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( ) const
virtualinherited

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

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

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

Definition at line 1138 of file eda_base_frame.cpp.

1139 {
1140  // This function should be overridden in child classes
1141  return false;
1142 }

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

◆ IsCurrentTool()

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

Definition at line 109 of file tools_holder.cpp.

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

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

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

◆ IsDismissed()

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

Definition at line 160 of file kiway_player.cpp.

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

References KIWAY_PLAYER::m_modal_loop.

Referenced by SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), and 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 706 of file gerbview_frame.cpp.

707 {
708  switch( aLayerID )
709  {
712  case LAYER_GERBVIEW_GRID: return IsGridVisible();
714  case LAYER_GERBVIEW_BACKGROUND: return true;
715 
716  default:
717  wxFAIL_MSG( wxString::Format( wxT( "GERBVIEW_FRAME::IsElementVisible(): bad arg %d" ),
718  aLayerID ) );
719  }
720 
721  return true;
722 }
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 408 of file eda_draw_frame.cpp.

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

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

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), EDITOR_CONDITIONS::gridFunc(), 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 755 of file gerbview_frame.cpp.

756 {
757  return m_LayersManager->IsLayerVisible( aLayer );
758 }
GERBER_LAYER_WIDGET * m_LayersManager
bool IsLayerVisible(LAYER_NUM aLayer)
Return 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 173 of file kiway_player.h.

173 { return m_modal; }

References KIWAY_PLAYER::m_modal.

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

◆ IsScriptingConsoleVisible()

bool EDA_DRAW_FRAME::IsScriptingConsoleVisible ( )
inherited

Gets the current visibility of the scripting console window.

Definition at line 249 of file eda_draw_frame.cpp.

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

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

Referenced by EDITOR_CONDITIONS::consoleVisibleFunc().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 206 of file eda_base_frame.h.

206 { return m_ident == aType; }

References EDA_BASE_FRAME::m_ident.

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

◆ IsWritable()

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

Checks if aFileName can be written.

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

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

Definition at line 1045 of file eda_base_frame.cpp.

1046 {
1047  wxString msg;
1048  wxFileName fn = aFileName;
1049 
1050  // Check for absence of a file path with a file name. Unfortunately KiCad
1051  // uses paths relative to the current project path without the ./ part which
1052  // confuses wxFileName. Making the file name path absolute may be less than
1053  // elegant but it solves the problem.
1054  if( fn.GetPath().IsEmpty() && fn.HasName() )
1055  fn.MakeAbsolute();
1056 
1057  wxCHECK_MSG( fn.IsOk(), false,
1058  wxT( "File name object is invalid. Bad programmer!" ) );
1059  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
1060  wxT( "File name object path <" ) + fn.GetFullPath() +
1061  wxT( "> is not set. Bad programmer!" ) );
1062 
1063  if( fn.IsDir() && !fn.IsDirWritable() )
1064  {
1065  msg.Printf( _( "Insufficient permissions to folder '%s'." ),
1066  fn.GetPath() );
1067  }
1068  else if( !fn.FileExists() && !fn.IsDirWritable() )
1069  {
1070  msg.Printf( _( "Insufficient permissions to save file '%s'." ),
1071  fn.GetFullName(), fn.GetPath() );
1072  }
1073  else if( fn.FileExists() && !fn.IsFileWritable() )
1074  {
1075  msg.Printf( _( "Insufficient permissions to save file '%s'." ),
1076  fn.GetFullPath() );
1077  }
1078 
1079  if( !msg.IsEmpty() )
1080  {
1081  if( aVerbose )
1082  wxMessageBox( msg );
1083 
1084  return false;
1085  }
1086 
1087  return true;
1088 }
#define _(s)

References _.

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

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

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

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS aEvent)
protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 181 of file kiway_player.cpp.

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

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS aEvent)
virtualinherited

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

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

Definition at line 71 of file kiway_player.cpp.

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

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

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

An event handler called on a language menu selection.

Definition at line 188 of file kiway_player.cpp.

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

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

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

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), 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 723 of file eda_draw_frame.cpp.

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

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

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

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

366 {
367  wxString filetypes;
368  wxArrayString filenamesList;
369  wxFileName filename = aFullFileName;
370  wxString currentPath;
371 
372  if( !filename.IsOk() )
373  {
374  filetypes = DrillFileWildcard();
375  filetypes << wxT( "|" );
376 
377  /* All filetypes */
378  filetypes += AllFilesWildcard();
379 
380  /* Use the current working directory if the file name path does not exist. */
381  if( filename.DirExists() )
382  currentPath = filename.GetPath();
383  else
384  currentPath = m_mruPath;
385 
386  wxFileDialog dlg( this, _( "Open NC (Excellon) Drill File(s)" ),
387  currentPath, filename.GetFullName(), filetypes,
388  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE | wxFD_CHANGE_DIR );
389 
390  if( dlg.ShowModal() == wxID_CANCEL )
391  return false;
392 
393  dlg.GetPaths( filenamesList );
394  currentPath = wxGetCwd();
395  m_mruPath = currentPath;
396  }
397  else
398  {
399  filenamesList.Add( aFullFileName );
400  currentPath = filename.GetPath();
401  m_mruPath = currentPath;
402  }
403 
404  // Read Excellon drill files: each file is loaded on a new GerbView layer
405  bool success = true;
406  int layer = GetActiveLayer();
407 
408  // Manage errors when loading files
409  wxString msg;
410  WX_STRING_REPORTER reporter( &msg );
411 
412  for( unsigned ii = 0; ii < filenamesList.GetCount(); ii++ )
413  {
414  filename = filenamesList[ii];
415 
416  if( !filename.IsAbsolute() )
417  filename.SetPath( currentPath );
418 
419  m_lastFileName = filename.GetFullPath();
420 
421  SetActiveLayer( layer, false );
422 
423  if( Read_EXCELLON_File( filename.GetFullPath() ) )
424  {
425  // Update the list of recent drill files.
426  UpdateFileHistory( filename.GetFullPath(), &m_drillFileHistory );
427 
428  layer = getNextAvailableLayer( layer );
429 
430  if( layer == NO_AVAILABLE_LAYERS && ii < filenamesList.GetCount()-1 )
431  {
432  success = false;
433  reporter.Report( MSG_NO_MORE_LAYER, RPT_SEVERITY_ERROR );
434 
435  // Report the name of not loaded files:
436  ii += 1;
437  while( ii < filenamesList.GetCount() )
438  {
439  filename = filenamesList[ii++];
440  wxString txt = wxString::Format( MSG_NOT_LOADED, filename.GetFullName() );
441  reporter.Report( txt, RPT_SEVERITY_ERROR );
442  }
443  break;
444  }
445 
446  SetActiveLayer( layer, false );
447  }
448  }
449 
450  if( !success )
451  {
452  HTML_MESSAGE_BOX mbox( this, _( "Errors" ) );
453  mbox.ListSet( msg );
454  mbox.ShowModal();
455  }
456 
457  Zoom_Automatique( false );
458 
459  // Synchronize layers tools with actual active layer:
463  syncLayerBox();
464 
465  return success;
466 }
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()
Update all layer manager icons (layers only).
#define _(s)
FILE_HISTORY m_drillFileHistory
#define MSG_NO_MORE_LAYER
wxString DrillFileWildcard()
A wrapper for reporting to a wxString object.
Definition: reporter.h:163
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.
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 given Gerber file or selected file(s), if the filename is empty.

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

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

120 {
121  static int lastGerberFileWildcard = 0;
122  wxString filetypes;
123  wxArrayString filenamesList;
124  wxFileName filename = aFullFileName;
125  wxString currentPath;
126 
127  if( !filename.IsOk() )
128  {
129  /* Standard gerber filetypes
130  * (See http://en.wikipedia.org/wiki/Gerber_File)
131  * The .gbr (.pho in legacy files) extension is the default used in Pcbnew; however
132  * there are a lot of other extensions used for gerber files. Because the first letter
133  * is usually g, we accept g* as extension.
134  * (Mainly internal copper layers do not have specific extension, and filenames are like
135  * *.g1, *.g2 *.gb1 ...)
136  * Now (2014) Ucamco (the company which manages the Gerber format) encourages use of .gbr
137  * only and the Gerber X2 file format.
138  */
139  filetypes = _( "Gerber files (.g* .lgr .pho)" );
140  filetypes << wxT("|");
141  filetypes += wxT("*.g*;*.G*;*.pho;*.PHO" );
142  filetypes << wxT("|");
143 
144  /* Special gerber filetypes */
145  filetypes += _( "Top layer" ) + AddFileExtListToFilter( { "GTL" } ) + wxT( "|" );
146  filetypes += _( "Bottom layer" ) + AddFileExtListToFilter( { "GBL" } ) + wxT( "|" );
147  filetypes += _( "Bottom solder resist" ) + AddFileExtListToFilter( { "GBS" } ) + wxT( "|" );
148  filetypes += _( "Top solder resist" ) + AddFileExtListToFilter( { "GTS" } ) + wxT( "|" );
149  filetypes += _( "Bottom overlay" ) + AddFileExtListToFilter( { "GBO" } ) + wxT( "|" );
150  filetypes += _( "Top overlay" ) + AddFileExtListToFilter( { "GTO" } ) + wxT( "|" );
151  filetypes += _( "Bottom paste" ) + AddFileExtListToFilter( { "GBP" } ) + wxT( "|" );
152  filetypes += _( "Top paste" ) + AddFileExtListToFilter( { "GTP" } ) + wxT( "|" );
153  filetypes += _( "Keep-out layer" ) + AddFileExtListToFilter( { "GKO" } ) + wxT( "|" );
154  filetypes += _( "Mechanical layers" ) + AddFileExtListToFilter( { "GM1", "GM2", "GM3", "GM4", "GM5", "GM6", "GM7", "GM8", "GM9" } ) + wxT( "|" );
155  filetypes += _( "Top Pad Master" ) + AddFileExtListToFilter( { "GPT" } ) + wxT( "|" );
156  filetypes += _( "Bottom Pad Master" ) + AddFileExtListToFilter( { "GPB" } ) + wxT( "|" );
157 
158  // All filetypes
159  filetypes += AllFilesWildcard();
160 
161  // Use the current working directory if the file name path does not exist.
162  if( filename.DirExists() )
163  currentPath = filename.GetPath();
164  else
165  {
166  currentPath = m_mruPath;
167 
168  // On wxWidgets 3.1 (bug?) the path in wxFileDialog is ignored when
169  // finishing by the dir separator. Remove it if any:
170  if( currentPath.EndsWith( '\\' ) || currentPath.EndsWith( '/' ) )
171  currentPath.RemoveLast();
172  }
173 
174  wxFileDialog dlg( this, _( "Open Gerber File(s)" ), currentPath, filename.GetFullName(),
175  filetypes,
176  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE | wxFD_CHANGE_DIR );
177  dlg.SetFilterIndex( lastGerberFileWildcard );
178 
179  if( dlg.ShowModal() == wxID_CANCEL )
180  return false;
181 
182  lastGerberFileWildcard = dlg.GetFilterIndex();
183  dlg.GetPaths( filenamesList );
184  m_mruPath = currentPath = dlg.GetDirectory();
185  }
186  else
187  {
188  filenamesList.Add( aFullFileName );
189  m_mruPath = currentPath = filename.GetPath();
190  }
191 
192  Erase_Current_DrawLayer( false );
193 
194  // Set the busy cursor
195  wxBusyCursor wait;
196 
197  bool isFirstFile = GetImagesList()->GetLoadedImageCount() == 0;
198 
199  bool success = LoadListOfGerberAndDrillFiles( currentPath, filenamesList );
200 
201  // Auto zoom is only applied if there is only one file loaded
202  if( isFirstFile )
203  {
204  Zoom_Automatique( false );
205  }
206 
207  return success;
208 }
wxString m_mruPath
void Erase_Current_DrawLayer(bool query)
wxString AllFilesWildcard()
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 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)
unsigned GetLoadedImageCount()
Get number of loaded images.
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data.
wxString AddFileExtListToFilter(const std::vector< std::string > &aExts)
Build the wildcard extension file dialog wildcard filter to add to the base message dialog.

References _, AddFileExtListToFilter(), AllFilesWildcard(), Erase_Current_DrawLayer(), GetImagesList(), GERBER_FILE_IMAGE_LIST::GetLoadedImageCount(), LoadListOfGerberAndDrillFiles(), EDA_BASE_FRAME::m_mruPath, and EDA_DRAW_FRAME::Zoom_Automatique().

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

180 {
181  wxFileName filename = aFullFileName;
182  wxString currentPath;
183  bool success = true;
184 
185  if( !filename.IsOk() )
186  {
187  // Use the current working directory if the file name path does not exist.
188  if( filename.DirExists() )
189  currentPath = filename.GetPath();
190  else
191  currentPath = m_mruPath;
192 
193  wxFileDialog dlg( this, _( "Open Gerber Job File" ),
194  currentPath,
195  filename.GetFullName(),
197  wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_CHANGE_DIR );
198 
199  if( dlg.ShowModal() == wxID_CANCEL )
200  return false;
201 
202  filename = dlg.GetPath();
203  currentPath = filename.GetPath();
204  m_mruPath = currentPath;
205  }
206  else
207  {
208  currentPath = filename.GetPath();
209  m_mruPath = currentPath;
210  }
211 
212  wxString msg;
213  WX_STRING_REPORTER reporter( &msg );
214 
215  if( filename.IsOk() )
216  {
217  GERBER_JOBFILE_READER gbjReader( filename.GetFullPath(), &reporter );
218 
219  if( gbjReader.ReadGerberJobFile() )
220  {
221  // Update the list of recent drill files.
222  UpdateFileHistory( filename.GetFullPath(), &m_jobFileHistory );
223 
224  Clear_DrawLayers( false );
225  ClearMsgPanel();
226 
227  wxArrayString& gbrfiles = gbjReader.GetGerberFiles();
228 
229  success = LoadListOfGerberAndDrillFiles( currentPath, gbrfiles );
230 
231  Zoom_Automatique( false );
232  }
233  }
234 
236 
237  if( !msg.IsEmpty() )
238  {
239  wxSafeYield(); // Allows slice of time to redraw the screen
240  // to refresh widgets, before displaying messages
241  HTML_MESSAGE_BOX mbox( this, _( "Messages" ) );
242  mbox.ListSet( msg );
243  mbox.ShowModal();
244  }
245 
246  return success;
247 }
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.
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 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)
virtual void ClearMsgPanel()
Clear all messages from the message panel.
A wrapper for reporting to a wxString object.
Definition: reporter.h:163
wxString GerberJobFileWildcard()

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

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

◆ LoadListOfGerberAndDrillFiles()

bool GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles ( const wxString &  aPath,
const wxArrayString &  aFilenameList,
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 211 of file gerbview/files.cpp.

214 {
215  wxFileName filename;
216 
217  // Read gerber files: each file is loaded on a new GerbView layer
218  bool success = true;
219  int layer = GetActiveLayer();
221 
222  // Manage errors when loading files
223  wxString msg;
224  WX_STRING_REPORTER reporter( &msg );
225 
226  // Create progress dialog (only used if more than 1 file to load
227  std::unique_ptr<WX_PROGRESS_REPORTER> progress = nullptr;
228 
229  for( unsigned ii = 0; ii < aFilenameList.GetCount(); ii++ )
230  {
231  filename = aFilenameList[ii];
232 
233  if( !filename.IsAbsolute() )
234  filename.SetPath( aPath );
235 
236  // Check for non existing files, to avoid creating broken or useless data
237  // and report all in one error list:
238  if( !filename.FileExists() )
239  {
240  wxString warning;
241  warning << wxT( "<b>" ) << _( "File not found:" ) << wxT( "</b><br>" )
242  << filename.GetFullPath() << wxT( "<br>" );
243  reporter.Report( warning, RPT_SEVERITY_WARNING );
244  success = false;
245  continue;
246  }
247 
248  m_lastFileName = filename.GetFullPath();
249 
250  if( !progress && ( aFilenameList.GetCount() > 1 ) )
251  {
252  progress = std::make_unique<WX_PROGRESS_REPORTER>( this,
253  _( "Loading Gerber files..." ), 1,
254  false );
255  progress->SetMaxProgress( aFilenameList.GetCount() - 1 );
256  progress->Report( wxString::Format( _("Loading %u/%zu %s..." ),
257  ii+1,
258  aFilenameList.GetCount(),
259  m_lastFileName ) );
260  }
261  else if( progress )
262  {
263  progress->Report( wxString::Format( _("Loading %u/%zu %s..." ),
264  ii+1,
265  aFilenameList.GetCount(),
266  m_lastFileName ) );
267  progress->KeepRefreshing();
268  }
269 
270  SetActiveLayer( layer, false );
271 
272  visibility[ layer ] = true;
273 
274  try
275  {
276  if( aFileType && ( *aFileType )[ii] == 1 )
277  {
278  LoadExcellonFiles( filename.GetFullPath() );
279  layer = GetActiveLayer(); // Loading NC drill file changes the active layer
280  }
281  else
282  {
283  if( filename.GetExt() == GerberJobFileExtension.c_str() )
284  {
285  //We cannot read a gerber job file as a gerber plot file: skip it
286  wxString txt;
287  txt.Printf( _( "<b>A gerber job file cannot be loaded as a plot file</b> "
288  "<i>%s</i>" ),
289  filename.GetFullName() );
290  success = false;
291  reporter.Report( txt, RPT_SEVERITY_ERROR );
292  }
293  else if( Read_GERBER_File( filename.GetFullPath() ) )
294  {
296 
298  GERBER_DRAW_LAYER( layer ), GetGbrImage( layer )->HasNegativeItems() );
299 
300  layer = getNextAvailableLayer( layer );
301 
302  if( layer == NO_AVAILABLE_LAYERS && ii < aFilenameList.GetCount() - 1 )
303  {
304  success = false;
305  reporter.Report( MSG_NO_MORE_LAYER, RPT_SEVERITY_ERROR );
306 
307  // Report the name of not loaded files:
308  ii += 1;
309  while( ii < aFilenameList.GetCount() )
310  {
311  filename = aFilenameList[ii++];
312  wxString txt =
313  wxString::Format( MSG_NOT_LOADED, filename.GetFullName() );
314  reporter.Report( txt, RPT_SEVERITY_ERROR );
315  }
316  break;
317  }
318 
319  SetActiveLayer( layer, false );
320  }
321  }
322  }
323  catch( const std::bad_alloc& )
324  {
325  wxString txt = wxString::Format( MSG_OOM, filename.GetFullName() );
326  reporter.Report( txt, RPT_SEVERITY_ERROR );
327  success = false;
328  continue;
329  }
330 
331  if( progress )
332  progress->AdvanceProgress();
333  }
334 
335  if( !success )
336  {
337  wxSafeYield(); // Allows slice of time to redraw the screen
338  // to refresh widgets, before displaying messages
339  HTML_MESSAGE_BOX mbox( this, _( "Errors" ) );
340  mbox.ListSet( msg );
341  mbox.ShowModal();
342  }
343 
345 
346  // Synchronize layers tools with actual active layer:
348 
349  // TODO: it would be nice if we could set the active layer to one of the
350  // ones that was just loaded, but to maintain the previous user experience
351  // we need to set it to a blank layer in case they load another file.
352  // We can't start with the next available layer when loading files because
353  // some users expect the behavior of overwriting the active layer on load.
354  SetActiveLayer( getNextAvailableLayer( layer ), true );
355 
357  syncLayerBox( true );
358 
359  GetCanvas()->Refresh();
360 
361  return success;
362 }
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
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:516
#define NO_AVAILABLE_LAYERS
#define MSG_OOM
GERBER_FILE_IMAGE * GetGbrImage(int aIdx) const
void UpdateLayerIcons()
Update all layer manager icons (layers only).
const std::string GerberJobFileExtension
#define _(s)
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
#define MSG_NO_MORE_LAYER
#define GERBER_DRAW_LAYER(x)
Definition: layer_ids.h:410
A wrapper for reporting to a wxString object.
Definition: reporter.h:163
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.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
bool LoadExcellonFiles(const wxString &aFileName)
Load a drill (EXCELLON) file or many files.
void SetLayerHasNegatives(int aLayer, bool aNegatives=true)
Set the status of negatives presense in a particular layer.
Definition: view.h:437
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(), GERBER_DRAW_LAYER, GerberJobFileExtension, GetActiveLayer(), EDA_DRAW_FRAME::GetCanvas(), GetGbrImage(), getNextAvailableLayer(), EDA_DRAW_PANEL_GAL::GetView(), GetVisibleLayers(), HTML_MESSAGE_BOX::ListSet(), LoadExcellonFiles(), m_lastFileName, m_LayersManager, MSG_NO_MORE_LAYER, MSG_NOT_LOADED, MSG_OOM, NO_AVAILABLE_LAYERS, Read_GERBER_File(), ReFillLayerWidget(), EDA_DRAW_PANEL_GAL::Refresh(), WX_STRING_REPORTER::Report(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, SetActiveLayer(), KIGFX::VIEW::SetLayerHasNegatives(), SetVisibleLayers(), syncLayerBox(), EDA_BASE_FRAME::UpdateFileHistory(), LAYER_WIDGET::UpdateLayerIcons(), and visibility.

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

296 {
298 
299  if( aCfg->m_Window.grid.sizes.empty() )
300  {
301  aCfg->m_Window.grid.sizes = { wxT( "100 mil" ),
302  wxT( "50 mil" ),
303  wxT( "25 mil" ),
304  wxT( "20 mil" ),
305  wxT( "10 mil" ),
306  wxT( "5 mil" ),
307  wxT( "2.5 mil" ),
308  wxT( "2 mil" ),
309  wxT( "1 mil" ),
310  wxT( "0.5 mil" ),
311  wxT( "0.2 mil" ),
312  wxT( "0.1 mil" ),
313  wxT( "5.0 mm" ),
314  wxT( "2.5 mm" ),
315  wxT( "1.0 mm" ),
316  wxT( "0.5 mm" ),
317  wxT( "0.25 mm" ),
318  wxT( "0.2 mm" ),
319  wxT( "0.1 mm" ),
320  wxT( "0.05 mm" ),
321  wxT( "0.025 mm" ),
322  wxT( "0.01 mm" ) };
323  }
324 
325  if( aCfg->m_Window.zoom_factors.empty() )
326  {
328  }
329 
330  GERBVIEW_SETTINGS* cfg = dynamic_cast<GERBVIEW_SETTINGS*>( aCfg );
331  wxCHECK( cfg, /*void*/ );
332 
335 
336  PAGE_INFO pageInfo( wxT( "GERBER" ) );
337  pageInfo.SetType( cfg->m_Appearance.page_type );
338  SetPageSettings( pageInfo );
339 
342 
346 }
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 709 of file eda_base_frame.cpp.

710 {
711  LoadWindowState( aCfg->state );
712 
713  if( m_hasAutoSave )
714  m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
715 
716  m_perspective = aCfg->perspective;
717  m_mruPath = aCfg->mru_path;
718 
719  TOOLS_HOLDER::CommonSettingsChanged( false, false );
720 }
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 549 of file eda_base_frame.cpp.

550 {
551  if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
552  return;
553 
554  const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
555 
556  if( state != nullptr )
557  {
558  LoadWindowState( state->window );
559  }
560 }
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 563 of file eda_base_frame.cpp.

564 {
565  bool wasDefault = false;
566 
567  m_framePos.x = aState.pos_x;
568  m_framePos.y = aState.pos_y;
569  m_frameSize.x = aState.size_x;
570  m_frameSize.y = aState.size_y;
571 
572  wxLogTrace( traceDisplayLocation, wxT( "Config position (%d, %d) with size (%d, %d)" ),
574 
575  // Ensure minimum size is set if the stored config was zero-initialized
576  if( m_frameSize.x < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
577  {
579  wasDefault = true;
580 
581  wxLogTrace( traceDisplayLocation, wxT( "Using minimum size (%d, %d)" ),
582  m_frameSize.x, m_frameSize.y );
583  }
584 
585  wxLogTrace( traceDisplayLocation, wxT( "Number of displays: %d" ), wxDisplay::GetCount() );
586 
587  if( aState.display >= wxDisplay::GetCount() )
588  {
589  wxLogTrace( traceDisplayLocation, wxT( "Previous display not found" ) );
590 
591  // If it isn't attached, use the first display
592  // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
593  const unsigned int index = 0;
594  wxDisplay display( index );
595  wxRect clientSize = display.GetGeometry();
596 
597  m_framePos = wxDefaultPosition;
598 
599  // Ensure the window fits on the display, since the other one could have been larger
600  if( m_frameSize.x > clientSize.width )
601  m_frameSize.x = clientSize.width;
602 
603  if( m_frameSize.y > clientSize.height )
604  m_frameSize.y = clientSize.height;
605  }
606  else
607  {
608  wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
609  wxPoint upperLeft( m_framePos.x, m_framePos.y );
610 
611  wxDisplay display( aState.display );
612  wxRect clientSize = display.GetClientArea();
613 
614  int yLimTop = clientSize.y;
615  int yLimBottom = clientSize.y + clientSize.height;
616  int xLimLeft = clientSize.x;
617  int xLimRight = clientSize.x + clientSize.width;
618 
619  if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
620  upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
621  upperLeft.y < yLimTop || // Upper corner too close to the bottom of the screen
622  upperLeft.y > yLimBottom )
623  {
624  m_framePos = wxDefaultPosition;
625  wxLogTrace( traceDisplayLocation, wxT( "Resetting to default position" ) );
626  }
627  }
628 
629  wxLogTrace( traceDisplayLocation, wxT( "Final window position (%d, %d) with size (%d, %d)" ),
631 
632  SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
633 
634  // Center the window if we reset to default
635  if( m_framePos.x == -1 )
636  {
637  wxLogTrace( traceDisplayLocation, wxT( "Centering window" ) );
638  Center();
639  m_framePos = GetPosition();
640  }
641 
642  // Record the frame sizes in an un-maximized state
645 
646  // Maximize if we were maximized before
647  if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
648  {
649  wxLogTrace( traceDisplayLocation, wxT( "Maximizing window" ) );
650  Maximize();
651  }
652 
653  m_displayIndex = wxDisplay::GetFromWindow( this );
654 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxPoint m_normalFramePos
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_displayIndex, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_ident, EDA_BASE_FRAME::m_maximizeByDefault, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, minSize(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.

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

633 {
634 #define ZipFileExtension "zip"
635 
636  wxFileName filename = aFullFileName;
637  wxString currentPath;
638 
639  if( !filename.IsOk() )
640  {
641  // Use the current working directory if the file name path does not exist.
642  if( filename.DirExists() )
643  currentPath = filename.GetPath();
644  else
645  currentPath = m_mruPath;
646 
647  wxFileDialog dlg( this, _( "Open Zip File" ), currentPath, filename.GetFullName(),
648  ZipFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_CHANGE_DIR );
649 
650  if( dlg.ShowModal() == wxID_CANCEL )
651  return false;
652 
653  filename = dlg.GetPath();
654  currentPath = wxGetCwd();
655  m_mruPath = currentPath;
656  }
657  else
658  {
659  currentPath = filename.GetPath();
660  m_mruPath = currentPath;
661  }
662 
663  wxString msg;
664  WX_STRING_REPORTER reporter( &msg );
665 
666  if( filename.IsOk() )
667  unarchiveFiles( filename.GetFullPath(), &reporter );
668 
669  Zoom_Automatique( false );
670 
671  // Synchronize layers tools with actual active layer:
675  syncLayerBox();
676 
677  if( !msg.IsEmpty() )
678  {
679  wxSafeYield(); // Allows slice of time to redraw the screen
680  // to refresh widgets, before displaying messages
681  HTML_MESSAGE_BOX mbox( this, _( "Messages" ) );
682  mbox.ListSet( msg );
683  mbox.ShowModal();
684  }
685 
686  return true;
687 }
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=nullp