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 }
 Function ClearUndoORRedoList (virtual). More...
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

const GBR_DISPLAY_OPTIONSGetDisplayOptions () const
 
void SetDisplayOptions (const GBR_DISPLAY_OPTIONS &aOptions)
 
void SetLayout (GBR_LAYOUT *aLayout)
 Function SetLayout sets 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 wxPointGetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
int SelectPCBLayer (int aDefaultLayer, int aCopperLayerCount, wxString aGerberName)
 Install the dialog box for layer selection. More...
 
COLOR4D GetGridColor () override
 
virtual void SetGridColor (COLOR4D aColor) override
 

More...
 
const BOX2I GetDocumentExtents (bool aIncludeAllVisible=true) const override
 Returns bbox of document with option to not include some items. More...
 
 GERBVIEW_FRAME (KIWAY *aKiway, wxWindow *aParent)
 
 ~GERBVIEW_FRAME ()
 
void doCloseWindow () override
 
bool OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl) override
 Function OpenProjectFiles is abstract, and opens a project or set of files given by aFileList. More...
 
bool LoadListOfGerberAndDrillFiles (const wxString &aPath, const wxArrayString &aFilenameList, const std::vector< int > *aFileType=nullptr)
 Loads 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
 Function ReCreateVToolbar creates or updates 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...
 
int GetDisplayMode ()
 Function GetDisplayMode. More...
 
void SetDisplayMode (int aMode)
 Function SetDisplayMode. More...
 
bool IsElementVisible (int aLayerID) const
 Function IsElementVisible tests whether a given element category is visible. More...
 
void SetElementVisibility (int aLayerID, bool aNewState)
 Function SetElementVisibility changes the visibility of an element category. More...
 
void SetGridVisibility (bool aVisible) override
 Function SetGridVisibility(), virtual from EDA_DRAW_FRAME It may be overloaded by derived classes. More...
 
LSET GetVisibleLayers () const
 Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSettings. More...
 
void SetVisibleLayers (LSET aLayerMask)
 Function SetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSettings. More...
 
bool IsLayerVisible (int aLayer) const
 Function IsLayerVisible tests whether a given layer is visible. More...
 
COLOR4D GetVisibleElementColor (int aLayerID)
 Function GetVisibleElementColor returns the color of a gerber visible element. More...
 
void SetVisibleElementColor (int aLayerID, COLOR4D aColor)
 
COLOR4D GetLayerColor (int aLayer) const
 
void SetLayerColor (int aLayer, COLOR4D aColor)
 
COLOR4D GetNegativeItemsColor ()
 Function GetNegativeItemsColor. More...
 
void ReFillLayerWidget ()
 Function ReFillLayerWidget changes out all the layers in m_Layers; called upon loading new gerber files. More...
 
void SetActiveLayer (int aLayer, bool doLayerWidgetUpdate=true)
 Function SetActiveLayer will change the currently active layer to aLayer and update the GERBER_LAYER_WIDGET. More...
 
int GetActiveLayer () const
 Function SetActiveLayer returns the active layer. More...
 
int getNextAvailableLayer (int aLayer=0) const
 Function getNextAvailableLayer finds the next empty layer starting at aLayer and returns it to the caller. More...
 
void syncLayerWidget ()
 Function syncLayerWidget updates the currently "selected" layer within the GERBER_LAYER_WIDGET. More...
 
void syncLayerBox (bool aRebuildLayerBox=false)
 Function syncLayerBox updates the currently "selected" layer within m_SelLayerBox The currently active layer, as defined by the return value of GetActiveLayer(). More...
 
void UpdateTitleAndInfo ()
 Function UpdateTitleAndInfo displays the short filename (if exists) of the selected layer on the caption of the main GerbView window and some other parameters Name of the layer (found in the gerber file: LN &ltname&gt command) in the status bar Name of the Image (found in the gerber file: IN &ltname&gt command) in the status bar and other data in toolbar. More...
 
void DisplayGridMsg () override
 Function DisplayGridMsg() More...
 
void LoadSettings (APP_SETTINGS_BASE *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (APP_SETTINGS_BASE *aCfg) override
 Saves common frame parameters to a configuration data file. More...
 
void ToggleLayerManager ()
 
void ShowChangedLanguage () override
 Redraw the menus and what not in current language. More...
 
void OnSelectHighlightChoice (wxCommandEvent &event)
 Handles the changing of the highlighted component/net/attribute. More...
 
void OnSelectActiveDCode (wxCommandEvent &event)
 Function OnSelectActiveDCode Selects the active DCode for the current active layer. More...
 
void OnSelectActiveLayer (wxCommandEvent &event)
 Function OnSelectActiveLayer Selects the active layer: More...
 
void OnSelectDisplayMode (wxCommandEvent &event)
 Function OnSelectDisplayMode called on a display mode selection Mode selection can be fast display, or exact mode with stacked images or with transparency. More...
 
void OnQuit (wxCommandEvent &event)
 Function OnQuit called on request of application quit. More...
 
void OnUpdateDrawMode (wxUpdateUIEvent &aEvent)
 
void OnUpdateSelectDCode (wxUpdateUIEvent &aEvent)
 
void OnUpdateLayerSelectBox (wxUpdateUIEvent &aEvent)
 
void OnGbrFileHistory (wxCommandEvent &event)
 Function OnGbrFileHistory deletes the current data and loads a Gerber file selected from history list on current layer. More...
 
void OnDrlFileHistory (wxCommandEvent &event)
 Function OnDrlFileHistory deletes the current data and load a drill file in Excellon format selected from history list on current layer. More...
 
void OnZipFileHistory (wxCommandEvent &event)
 Function OnZipFileHistory deletes the current data and load a zip archive file selected from the history list. More...
 
void OnJobFileHistory (wxCommandEvent &event)
 deletes the current data and load a gerber job file selected from the history list. More...
 
bool unarchiveFiles (const wxString &aFullFileName, REPORTER *aReporter=nullptr)
 Extracts gerber and drill files from the zip archive, and load them. More...
 
bool LoadGerberFiles (const wxString &aFileName)
 function LoadGerberFiles Load a photoplot (Gerber) file or many files. More...
 
bool Read_GERBER_File (const wxString &GERBER_FullFileName)
 
bool LoadExcellonFiles (const wxString &aFileName)
 function LoadExcellonFiles Load a drill (EXCELLON) file or many files. More...
 
bool Read_EXCELLON_File (const wxString &aFullFileName)
 
bool LoadZipArchiveFile (const wxString &aFileName)
 function LoadZipArchiveFileLoadZipArchiveFile Load a zipped archive file. More...
 
bool LoadGerberJobFile (const wxString &aFileName)
 Load a Gerber job file, and load gerber files found in job files. More...
 
bool Clear_DrawLayers (bool query)
 
void Erase_Current_DrawLayer (bool query)
 
void SortLayersByX2Attributes ()
 
void UpdateDisplayOptions (const GBR_DISPLAY_OPTIONS &aOptions)
 Updates the display options and refreshes the view as needed. More...
 
void SaveCopyInUndoList (GERBER_DRAW_ITEM *aItemToCopy, UNDO_REDO aTypeCommand=UNDO_REDO::UNSPECIFIED, const wxPoint &aTransformPoint=wxPoint(0, 0))
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0))
 Function SaveCopyInUndoList (overloaded). More...
 
void ActivateGalCanvas () override
 

More...
 
void InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
 Allows 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...
 
bool LockFile (const wxString &aFileName)
 Mark a schematic file as being in use. More...
 
void ReleaseFile ()
 Release the current file marked in use. More...
 
wxFindReplaceData & GetFindReplaceData ()
 
wxArrayString & GetFindHistoryList ()
 
bool GetShowPolarCoords () const
 For those frames that support polar coordinates. More...
 
void SetShowPolarCoords (bool aShow)
 
void ToggleUserUnits () override
 
void GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
 Get the pair or units in current use. More...
 
wxPoint GetNearestGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize location to aPosition. More...
 
virtual ORIGIN_TRANSFORMSGetOriginTransforms ()
 Return a reference to the default ORIGIN_TRANSFORMS object. More...
 
virtual COLOR4D GetDrawBgColor () const
 
virtual void SetDrawBgColor (COLOR4D aColor)
 
virtual COLOR_SETTINGSGetColorSettings ()
 Returns a pointer to the active color theme settings. More...
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
virtual wxString GetScreenDesc () const
 
virtual BASE_SCREENGetScreen () const
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command send via a socket to the application, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) It called by EDA_DRAW_FRAME::OnSockRequest(). More...
 
void EraseMsgBox ()
 
bool IsGridVisible () const
 
void OnSelectGrid (wxCommandEvent &event)
 Command event handler for selecting grid sizes. More...
 
void OnGridSettings (wxCommandEvent &event)
 
void UpdateGridSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
 
void OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
 Update the checked item in the grid combobox. More...
 
void UpdateZoomSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
 
void OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
 Update the checked item in the zoom combobox. More...
 
const wxString GetZoomLevelIndicator () const
 Return a human readable value for display in dialogs. More...
 
virtual void OnSelectZoom (wxCommandEvent &event)
 Set the zoom factor when selected by the zoom list box in the main tool bar. More...
 
virtual void OnSize (wxSizeEvent &event)
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
void OnMove (wxMoveEvent &aEvent) override
 
virtual void HardRedraw ()
 Rebuild the GAL and redraws the screen. More...
 
virtual void Zoom_Automatique (bool aWarpPointer)
 Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...
 
void FocusOnLocation (const wxPoint &aPos)
 Useful to focus on a particular location, in find functions 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. More...
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Function CreateBasicMenu. More...
 
void PrintWorkSheet (RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aScale, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
 Prints the page layout with the frame and the basic inscriptions. More...
 
void DisplayToolMsg (const wxString &msg) override
 
virtual void OnPageSettingsChange ()
 Called when modifying the page settings. More...
 
void DisplayUnitsMsg ()
 Display current unit pane in the status bar. More...
 
void CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
void AppendMsgPanel (const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=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)
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. More...
 
virtual EDA_ITEMGetItem (const KIID &aId)
 Fetch an item by KIID. More...
 
virtual void PrintPage (RENDER_SETTINGS *aSettings)
 Print the page pointed by current screen, set by the calling print function. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. 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)
 Handles command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=NULL, wxWindow *aResultantFocusWindow=NULL)
 Function ShowModal puts up 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)
 Function KiwayMailIn receives 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 In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing. More...
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). More...
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
EDA_UNITS GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS aUnits)
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
SETTINGS_MANAGERGetSettingsManager () const
 
virtual int GetSeverity (int aErrorCode) const
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
virtual void OnCharHook (wxKeyEvent &event)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
virtual void RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
 Register a UI update handler for the control with ID aID. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
 Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...
 
virtual void UnregisterUIUpdateHandler (int aID) override
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
virtual const SEARCH_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program. More...
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 
void PrintMsg (const wxString &text)
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg)
 
void ShowInfoBarWarning (const wxString &aWarningMsg)
 
void ShowInfoBarMsg (const wxString &aMsg)
 
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)
 Loads 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. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Saves window settings to the given settings object Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Returns a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 
virtual void SaveProjectSettings ()
 Save changes to the project settings to the project (.pro) file. More...
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
 Fetches the file name from the file history list. More...
 
void ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
 Removes all files from the file history. More...
 
void UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
 Update the list of recently opened files. More...
 
FILE_HISTORYGetFileHistory ()
 Get the frame's main file history. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
virtual wxString GetCurrentFileName () const
 Get the full filename + path of the currently opened file in the frame. More...
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void ProjectChanged ()
 Notification event that the project has changed. More...
 
const wxString & GetAboutTitle () const
 
virtual bool IsContentModified ()
 Get if the contents of the frame have been modified since the last save. More...
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
virtual void ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)
 
virtual void ClearUndoRedoList ()
 Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status. More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList) More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList) More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual int GetUndoCommandCount () const
 
virtual int GetRedoCommandCount () const
 
int GetMaxUndoItems () const
 
bool NonUserClose (bool aForce)
 
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
 Indicates that hotkeys should perform an immediate action even if another tool is currently active. More...
 
bool GetDragSelects () const
 Indicates that a drag should draw a selection rectangle, even when started over an item. More...
 
bool GetMoveWarpsCursor () const
 Indicates that a move operation should warp the mouse pointer to the origin of the move object. More...
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

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

Public Attributes

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

Protected Member Functions

void setupUIConditions () override
 Setup the UI conditions for the various actions and their controls in this frame. More...
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void setupUnits (APP_SETTINGS_BASE *aCfg)
 
void InitExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 Function language_change is 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)
 

Static Protected Member Functions

static wxString GetBackupSuffix ()
 
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
 prevents opening same file multiple times. More...
 
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
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
 The current canvas type. More...
 
bool m_modal
 
WX_EVENT_LOOPm_modal_loop
 
wxWindow * m_modal_resultant_parent
 
wxString m_modal_string
 
bool m_modal_ret_val
 
FRAME_T m_Ident
 
wxPoint m_FramePos
 
wxSize m_FrameSize
 
bool m_maximizeByDefault
 
wxPoint m_NormalFramePos
 
wxSize m_NormalFrameSize
 
wxString m_AboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 
bool m_isClosing
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
bool m_dragSelects
 
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

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
 
int m_displayMode
 
bool m_show_layer_manager_tools
 

Detailed Description

Definition at line 56 of file gerbview_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

◆ UNDO_REDO_LIST

Function ClearUndoORRedoList (virtual).

this function must remove the aItemCount 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

Parameters
aList= the UNDO_REDO_CONTAINER of commands
aItemCount= number of old commands to delete. -1 to remove all old commands this will empty the list of commands. Commands are deleted from the older to the last.
Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 586 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ GERBVIEW_FRAME()

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

Definition at line 64 of file gerbview_frame.cpp.

65  : EDA_DRAW_FRAME( aKiway, aParent, FRAME_GERBER, wxT( "GerbView" ), wxDefaultPosition,
67  m_activeLayer( 0 ),
69  ID_GERBVIEW_ZIP_FILE_LIST_CLEAR, _( "Clear Recent Zip Files" ) ),
71  ID_GERBVIEW_DRILL_FILE_LIST_CLEAR, _( "Clear Recent Drill Files" ) ),
73  ID_GERBVIEW_JOB_FILE_LIST_CLEAR, _( "Clear Recent Job Files" ) ),
74  m_TextInfo( nullptr )
75 {
76  m_maximizeByDefault = true;
77  m_gerberLayout = nullptr;
79  m_showBorderAndTitleBlock = false; // true for reference drawings.
80  m_SelLayerBox = nullptr;
81  m_DCodeSelector = nullptr;
82  m_SelComponentBox = nullptr;
83  m_SelNetnameBox = nullptr;
84  m_SelAperAttributesBox = nullptr;
85  m_cmpText = nullptr;
86  m_netText = nullptr;
87  m_apertText = nullptr;
88  m_dcodeText = nullptr;
89  m_displayMode = 0;
90  m_AboutTitle = "GerbView";
91 
92  SHAPE_POLY_SET dummy; // A ugly trick to force the linker to include
93  // some methods in code and avoid link errors
94 
95  int fileHistorySize = Pgm().GetCommonSettings()->m_System.file_history_size;
96  m_drillFileHistory.SetMaxFiles( fileHistorySize );
97  m_zipFileHistory.SetMaxFiles( fileHistorySize );
98  m_jobFileHistory.SetMaxFiles( fileHistorySize );
99 
100  auto* galCanvas = new GERBVIEW_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_FrameSize,
103 
104  SetCanvas( galCanvas );
105 
106  // GerbView requires draw priority for rendering negative objects
107  galCanvas->GetView()->UseDrawPriority( true );
108 
109  // Give an icon
110  wxIcon icon;
111  icon.CopyFromBitmap( KiBitmap( icon_gerbview_xpm ) );
112  SetIcon( icon );
113 
114  // Be sure a page info is set. this default value will be overwritten later.
115  PAGE_INFO pageInfo( wxT( "GERBER" ) );
116  SetLayout( new GBR_LAYOUT() );
117  SetPageSettings( pageInfo );
118 
119  SetVisibleLayers( LSET::AllLayersMask() ); // All draw layers visible.
120 
121  SetScreen( new BASE_SCREEN( GetPageSettings().GetSizeIU() ) );
122 
123  // Create the PCB_LAYER_WIDGET *after* SetLayout():
125 
126  // LoadSettings() *after* creating m_LayersManager, because LoadSettings()
127  // initialize parameters in m_LayersManager
128  LoadSettings( config() );
129 
130  setupTools();
132  ReCreateMenuBar();
136 
137  m_auimgr.SetManagedWindow( this );
138 
139  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) );
140  m_auimgr.AddPane( m_auxiliaryToolBar, EDA_PANE().HToolbar().Name( "AuxToolbar" ).Top().Layer(4) );
141  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6) );
142 
143  m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" ).Left().Layer(3) );
144  m_auimgr.AddPane( m_LayersManager, EDA_PANE().Palette().Name( "LayersManager" ).Right().Layer(3)
145  .Caption( _( "Layers Manager" ) ).PaneBorder( false )
146  .MinSize( 80, -1 ).BestSize( m_LayersManager->GetBestSize() ) );
147 
148  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
149 
150  m_auimgr.GetArtProvider()->SetColour( wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR,
151  wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT ) );
152  m_auimgr.GetArtProvider()->SetColour( wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR,
153  wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT ) );
154 
155  ReFillLayerWidget(); // this is near end because contents establish size
156  m_auimgr.Update();
157 
158  SetActiveLayer( 0, true );
160 
162 
163  // Nudge user to switch to OpenGL if they are on legacy or Cairo
164  if( m_firstRunDialogSetting < 1 )
165  {
166  if( canvasType != EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL )
167  {
168  wxString msg = _( "KiCad can use your graphics card to give you a smoother "
169  "and faster experience. This option is turned off by "
170  "default since it is not compatible with all computers.\n\n"
171  "Would you like to try enabling graphics acceleration?\n\n"
172  "If you'd like to choose later, select Accelerated Graphics "
173  "in the Preferences menu." );
174 
175  wxMessageDialog dlg( this, msg, _( "Enable Graphics Acceleration" ), wxYES_NO );
176 
177  dlg.SetYesNoLabels( _( "&Enable Acceleration" ), _( "&No Thanks" ) );
178 
179  if( dlg.ShowModal() == wxID_YES )
180  {
181  // Save Cairo as default in case OpenGL crashes
183 
184  // Switch to OpenGL, which will save the new setting if successful
186 
187  // Switch back to Cairo if OpenGL is not supported
188  if( GetCanvas()->GetBackend() == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
190  }
191  else
192  {
193  // If they were on legacy, switch to Cairo
195  }
196  }
197 
199  SaveSettings( config() );
200  }
201 
202  SwitchCanvas( canvasType );
203 
204  setupUnits( config() );
205 
206  // Enable the axes to match legacy draw style
207  auto& galOptions = GetGalDisplayOptions();
208  galOptions.m_axesEnabled = true;
209  galOptions.NotifyChanged();
210 
212  m_LayersManager->ReFillRender(); // Update colors in Render after the config is read
213 
215 
216  // Ensure the window is on top
217  Raise();
218 }
GBR_LAYOUT holds list of GERBER_DRAW_ITEM currently loaded.
Definition: gbr_layout.h:47
wxSize GetBestSize() const
Function GetBestSize returns the preferred minimum size, taking into consideration the dynamic conten...
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Saves common frame parameters to a configuration data file.
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)
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)
Function SetActiveLayer will change the currently active layer to aLayer and update the GERBER_LAYER_...
static TOOL_ACTION zoomFitScreen
Definition: actions.h:94
GBR_LAYER_BOX_SELECTOR * m_SelLayerBox
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
static TOOL_ACTION standardGraphics
Definition: actions.h:164
wxString m_AboutTitle
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting()
Returns the canvas type stored in the application settings.
wxAuiManager m_auimgr
ACTION_TOOLBAR * m_mainToolBar
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
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 ReCreateHToolbar() override
FILE_HISTORY m_zipFileHistory
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:83
void ReCreateAuxiliaryToolbar() override
SHAPE_POLY_SET.
EDA_MSG_PANEL * m_messagePanel
GAL not used (the legacy wxDC engine is used)
PAGE_INFO describes the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:54
bool m_showBorderAndTitleBlock
BASE_SCREEN handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:42
GBR_LAYOUT * m_gerberLayout
static LSET AllLayersMask()
Definition: lset.cpp:786
GERBER_LAYER_WIDGET is here to implement the abtract functions of LAYER_WIDGET so they may be tied in...
#define KICAD_DEFAULT_DRAWFRAME_STYLE
FILE_HISTORY m_drillFileHistory
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
#define GERBVIEW_FRAME_NAME
GERBVIEW_FRAME is the main window used in GerbView.
Specialization of the wxAuiPaneInfo class for KiCad panels.
const BITMAP_OPAQUE icon_gerbview_xpm[1]
wxTextCtrl * m_TextInfo
DCODE_SELECTION_BOX * m_DCodeSelector
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
const PAGE_INFO & GetPageSettings() const override
void SetMaxFiles(size_t aMaxFiles)
Update the number of files that will be contained inside the file history.
Definition: filehistory.cpp:85
wxStaticText * m_cmpText
wxChoice * m_SelAperAttributesBox
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Changes the current rendering backend.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
#define _(s)
Definition: 3d_actions.cpp:33
void setupUnits(APP_SETTINGS_BASE *aCfg)
#define DEFAULT_FILE_HISTORY_SIZE
IDs range for menuitems file history: The default range file history size is 9 (compatible with defau...
Definition: id.h:69
static TOOL_ACTION acceleratedGraphics
Definition: actions.h:163
wxStaticText * m_dcodeText
wxChoice * m_SelComponentBox
wxStaticText * m_netText
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:76
void SetVisibleLayers(LSET aLayerMask)
Function SetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
void ReFillRender()
Function ReFillRender Rebuild Render for instance after the config is read.
bool m_show_layer_manager_tools
void ReCreateMenuBar() override
Recreates the menu bar.
wxStaticText * m_apertText
bool saveCanvasTypeSetting(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Stores the canvas type in the application settings.
void SetLayout(GBR_LAYOUT *aLayout)
Function SetLayout sets the m_gerberLayout member in such as way as to ensure deleting any previous G...
void ReFillLayerWidget()
Function ReFillLayerWidget changes out all the layers in m_Layers; called upon loading new gerber fil...
long m_firstRunDialogSetting
void ReCreateOptToolbar() override
Create or update the left vertical toolbar (option toolbar)

References _, ACTIONS::acceleratedGraphics, LSET::AllLayersMask(), PCAD2KICAD::Center, EDA_BASE_FRAME::config(), dummy(), EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, LAYER_WIDGET::GetBestSize(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_FRAME::GetGalDisplayOptions(), GetPageSettings(), TOOLS_HOLDER::GetToolManager(), icon_gerbview_xpm, KiBitmap(), PCAD2KICAD::Left, EDA_DRAW_FRAME::LoadCanvasTypeSetting(), LoadSettings(), EDA_BASE_FRAME::m_AboutTitle, m_apertText, EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_auxiliaryToolBar, m_cmpText, m_DCodeSelector, m_dcodeText, m_displayMode, m_drillFileHistory, EDA_DRAW_FRAME::m_firstRunDialogSetting, 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(), PCAD2KICAD::Right, TOOL_MANAGER::RunAction(), EDA_DRAW_FRAME::saveCanvasTypeSetting(), SaveSettings(), SetActiveLayer(), EDA_DRAW_FRAME::SetCanvas(), SetLayout(), FILE_HISTORY::SetMaxFiles(), SetPageSettings(), EDA_DRAW_FRAME::SetScreen(), setupTools(), setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), SetVisibleLayers(), ACTIONS::standardGraphics, EDA_DRAW_FRAME::SwitchCanvas(), and ACTIONS::zoomFitScreen.

◆ ~GERBVIEW_FRAME()

GERBVIEW_FRAME::~GERBVIEW_FRAME ( )

Definition at line 221 of file gerbview_frame.cpp.

222 {
223  // Shutdown all running tools
224  if( m_toolManager )
226 
227  GetCanvas()->GetView()->Clear();
228 
230  delete m_gerberLayout;
231 }
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.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1089
GBR_LAYOUT * m_gerberLayout
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
GBR_LAYOUT * GetGerberLayout() const
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Definition: gbr_layout.cpp:41

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

Member Function Documentation

◆ ActivateGalCanvas()

void GERBVIEW_FRAME::ActivateGalCanvas ( )
overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1015 of file gerbview_frame.cpp.

1016 {
1018 
1019  EDA_DRAW_PANEL_GAL* galCanvas = GetCanvas();
1020 
1021  if( m_toolManager )
1022  {
1024  GetCanvas()->GetViewControls(), config(), this );
1026  }
1027 
1029 
1031 
1032  galCanvas->GetView()->RecacheAllItems();
1033  galCanvas->SetEventDispatcher( m_toolDispatcher );
1034  galCanvas->StartDrawing();
1035 
1038 
1040  ReCreateMenuBar();
1041 }
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()
Function RecacheAllItems() Rebuilds GAL display lists.
Definition: view.cpp:1377
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Function ResetTools() Resets all tools (i.e.
GBR_LAYOUT * m_gerberLayout
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual void ActivateGalCanvas()
Use to start up the GAL drawing canvas.
void StartDrawing()
Function StartDrawing() Begins drawing if it was stopped previously.
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:50
const PAGE_INFO & GetPageSettings() const override
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, APP_SETTINGS_BASE *aSettings, TOOLS_HOLDER *aFrame)
Sets the work environment (model, view, view controls and the parent window).
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools.
COLOR4D GetLayerColor(int aLayer) const
void ReFillRender()
Function ReFillRender Rebuild Render for instance after the config is read.
void ReCreateMenuBar() override
Recreates the menu bar.
Rendering engine changes.
Definition: tool_base.h:83
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 379 of file eda_base_frame.cpp.

380 {
381  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
382  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
383 
384  helpMenu->Add( ACTIONS::help );
385  helpMenu->Add( ACTIONS::gettingStarted );
386  helpMenu->Add( ACTIONS::listHotKeys );
387  helpMenu->Add( ACTIONS::getInvolved );
388  helpMenu->Add( ACTIONS::reportBug );
389 
390  helpMenu->AppendSeparator();
391  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
392 
393  aMenuBar->Append( helpMenu, _( "&Help" ) );
394 }
static TOOL_ACTION listHotKeys
Definition: actions.h:177
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:43
static TOOL_ACTION reportBug
Definition: actions.h:179
const BITMAP_OPAQUE about_xpm[1]
Definition: about.cpp:84
COMMON_CONTROL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:176
static TOOL_ACTION getInvolved
Definition: actions.h:178
static TOOL_ACTION gettingStarted
Definition: actions.h:175

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

Function CreateBasicMenu.

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

Definition at line 434 of file eda_draw_frame.cpp.

435 {
436  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
437  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
438 
439  aMenu.AddSeparator( 1000 );
441  aMenu.AddItem( ACTIONS::zoomIn, SELECTION_CONDITIONS::ShowAlways, 1000 );
442  aMenu.AddItem( ACTIONS::zoomOut, SELECTION_CONDITIONS::ShowAlways, 1000 );
444  if( IsType( FRAME_SCH ) || IsType( FRAME_PCB_EDITOR ) )
446 
447  aMenu.AddSeparator( 1000 );
448 
449  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
450  zoomMenu->SetTool( commonTools );
451  aToolMenu.AddSubMenu( zoomMenu );
452 
453  auto gridMenu = std::make_shared<GRID_MENU>( this );
454  gridMenu->SetTool( commonTools );
455  aToolMenu.AddSubMenu( gridMenu );
456 
457  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
458  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
459 }
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
static TOOL_ACTION zoomFitScreen
Definition: actions.h:94
static TOOL_ACTION zoomFitObjects
Definition: actions.h:95
COMMON_TOOLS.
Definition: common_tools.h:38
void AddSeparator(int aOrder=ANY_ORDER)
Adds a separator to the menu.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
bool IsType(FRAME_T aType) const
static TOOL_ACTION zoomCenter
Definition: actions.h:93
static TOOL_ACTION zoomIn
Definition: actions.h:89
static TOOL_ACTION zoomOut
Definition: actions.h:90

References CONDITIONAL_MENU::AddSeparator(), TOOL_MENU::AddSubMenu(), FRAME_PCB_EDITOR, FRAME_SCH, TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), EDA_BASE_FRAME::IsType(), TOOLS_HOLDER::m_toolManager, SELECTION_CONDITIONS::ShowAlways(), ACTIONS::zoomCenter, ACTIONS::zoomFitObjects, ACTIONS::zoomFitScreen, ACTIONS::zoomIn, and ACTIONS::zoomOut.

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

◆ AppendMsgPanel()

void EDA_DRAW_FRAME::AppendMsgPanel ( const wxString &  textUpper,
const wxString &  textLower,
COLOR4D  color,
int  pad = 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
textUpper- The message upper text.
textLower- The message lower text.
color- A color ID from the KiCad color list (see colors.h).
pad- Number of spaces to pad between messages (default = 4).

Definition at line 602 of file eda_draw_frame.cpp.

604 {
605  if( m_messagePanel )
606  m_messagePanel->AppendMessage( textUpper, textLower, color, pad );
607 }
int color
Definition: DXF_plotter.cpp:60
EDA_MSG_PANEL * m_messagePanel
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, COLOR4D aColor, int aPad=6)
Function AppendMessage appends a message to the message panel.
Definition: msgpanel.cpp:114

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

Referenced by PCB_BASE_FRAME::Compile_Ratsnest(), LIB_EDIT_FRAME::DisplayCmpDoc(), GERBER_FILE_IMAGE::DisplayImageInfo(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_PRINTOUT::OnPrintPage(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::SaveEEFile(), PCB_EDIT_FRAME::SavePcbFile(), and LIB_VIEW_FRAME::updatePreviewSymbol().

◆ applyDisplaySettingsToGAL()

void GERBVIEW_FRAME::applyDisplaySettingsToGAL ( )
private

Updates the GAL with display settings changes.

Definition at line 489 of file gerbview_frame.cpp.

490 {
491  auto painter = static_cast<KIGFX::GERBVIEW_PAINTER*>( GetCanvas()->GetView()->GetPainter() );
492  KIGFX::GERBVIEW_RENDER_SETTINGS* settings = painter->GetSettings();
495 
497 }
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:102
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:571
GBR_DISPLAY_OPTIONS m_DisplayOptions
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
GERBVIEW_RENDER_SETTINGS Stores GerbView specific render settings.
void LoadColors(const COLOR_SETTINGS *aSettings) override
virtual COLOR_SETTINGS * GetColorSettings()
Returns a pointer to the active color theme settings.
void LoadDisplayOptions(const GBR_DISPLAY_OPTIONS &aOptions)
Function LoadDisplayOptions Loads settings related to display options.

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

962 {
963  SetUserUnits( aUnits );
965 
966  wxCommandEvent e( UNITS_CHANGED );
967  ProcessEventLocally( e );
968 }
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void SetUserUnits(EDA_UNITS aUnits)

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

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

◆ CheckForAutoSaveFile()

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

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

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

Parameters
aFileNameA wxFileName object containing the file name to check.

Definition at line 859 of file eda_base_frame.cpp.

860 {
861  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
862 
863  wxFileName autoSaveFileName = aFileName;
864 
865  // Check for auto save file.
866  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
867 
868  wxLogTrace( traceAutoSave,
869  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
870 
871  if( !autoSaveFileName.FileExists() )
872  return;
873 
874  wxString msg = wxString::Format( _(
875  "Well this is potentially embarrassing!\n"
876  "It appears that the last time you were editing the file\n"
877  "\"%s\"\n"
878  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
879  aFileName.GetFullName()
880  );
881 
882  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
883 
884  // Make a backup of the current file, delete the file, and rename the auto save file to
885  // the file name.
886  if( response == wxYES )
887  {
888  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
889  {
890  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
891  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
892  }
893  }
894  else
895  {
896  wxLogTrace( traceAutoSave,
897  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
898 
899  // Remove the auto save file when using the previous file as is.
900  wxRemoveFile( autoSaveFileName.GetFullPath() );
901  }
902 }
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:102
static wxString GetAutoSaveFilePrefix()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33

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

Referenced by SCH_EDIT_FRAME::OpenProjectFiles(), and 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() == NULL )
43  return false;
44 
45  if( query && GetScreen()->IsModify() )
46  {
47  if( !IsOK( this, _( "Current data will be lost?" ) ) )
48  return false;
49  }
50 
51  if( GetCanvas() )
52  {
53  if( m_toolManager )
55 
56  GetCanvas()->GetView()->Clear();
57 
58  // Reinit the worksheet 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.
Model changes (required full reload)
Definition: tool_base.h:82
void syncLayerBox(bool aRebuildLayerBox=false)
Function syncLayerBox updates the currently "selected" layer within m_SelLayerBox The currently activ...
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)
Function SetActiveLayer will change the currently active layer to aLayer and update the GERBER_LAYER_...
void SetBoundingBox(const EDA_RECT &aBox)
Definition: gbr_layout.h:88
#define NULL
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1089
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Function ResetTools() Resets all tools (i.e.
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
GBR_LAYOUT * GetGerberLayout() const
const PAGE_INFO & GetPageSettings() const override
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
#define _(s)
Definition: 3d_actions.cpp:33
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
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:284
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
void ReFillLayerWidget()
Function ReFillLayerWidget changes out all the layers in m_Layers; called upon loading new gerber fil...

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

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

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

757 {
758  if( !aFileHistory )
759  aFileHistory = m_fileHistory;
760 
761  wxASSERT( aFileHistory );
762 
763  aFileHistory->ClearFileHistory();
764 
765  // Update the menubar to update the file history menu
766  if( GetMenuBar() )
767  {
768  ReCreateMenuBar();
769  GetMenuBar()->Refresh();
770  }
771 }
void ClearFileHistory()
Clear all entries from the file history.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

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

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

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

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

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

Called after the preferences dialog is run.

Reimplemented from TOOLS_HOLDER.

Definition at line 1178 of file gerbview_frame.cpp.

1179 {
1180  EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
1181 
1182  RecreateToolbars();
1183  Layout();
1184  SendSizeEvent();
1185 }
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 KICAD_MANAGER_FRAME.

Definition at line 652 of file eda_base_frame.cpp.

653 {
654  // KICAD_MANAGER_FRAME overrides this
655  return Kiface().KifaceSettings();
656 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:103
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

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

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited
Returns
a base name prefix used in Load/Save settings to build the full name of keys used in config. 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 config can be used.

Reimplemented from TOOLS_HOLDER.

Definition at line 402 of file eda_base_frame.h.

403  {
404  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
405  return baseCfgName;
406  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateServer()

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

Definition at line 48 of file eda_dde.cpp.

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

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

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

◆ CurrentToolName()

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

Definition at line 99 of file tools_holder.cpp.

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

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

Referenced by TOOL_MANAGER::processEvent().

◆ Destroy()

◆ DismissModal()

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

Definition at line 161 of file kiway_player.cpp.

162 {
163  m_modal_ret_val = aRetVal;
164  m_modal_string = aResult;
165 
166  if( m_modal_loop )
167  {
168  m_modal_loop->Exit();
169  m_modal_loop = 0; // this marks it as dismissed.
170  }
171 
172  Show( false );
173 }
bool m_modal_ret_val
Definition: kiway_player.h:207
wxString m_modal_string
Definition: kiway_player.h:206
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:204

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

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

◆ DisplayGridMsg()

void GERBVIEW_FRAME::DisplayGridMsg ( )
overridevirtual

Function DisplayGridMsg()

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 935 of file gerbview_frame.cpp.

936 {
937  wxString line;
938 
939  line.Printf( "grid X %s Y %s",
940  MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x ),
941  MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().y ) );
942 
943  SetStatusText( line, 4 );
944 }
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Definition: base_units.cpp:122
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_UNITS m_userUnits

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

Referenced by UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 471 of file eda_draw_frame.cpp.

472 {
473  SetStatusText( msg, 6 );
474 }

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane in the status bar.

Definition at line 488 of file eda_draw_frame.cpp.

489 {
490  wxString msg;
491 
492  switch( m_userUnits )
493  {
494  case EDA_UNITS::INCHES: msg = _( "inches" ); break;
495  case EDA_UNITS::MILS: msg = _( "mils" ); break;
496  case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
497  default: msg = _( "Units" ); break;
498  }
499 
500  SetStatusText( msg, 5 );
501 }
#define _(s)
Definition: 3d_actions.cpp:33
EDA_UNITS m_userUnits

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

Definition at line 270 of file eda_base_frame.cpp.

271 {
272  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
273 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void GERBVIEW_FRAME::doCloseWindow ( )
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 234 of file gerbview_frame.cpp.

235 {
236  // No more vetos
237  m_isClosing = true;
238  GetCanvas()->StopDrawing();
239  GetCanvas()->GetView()->Clear();
240 
241  if( m_toolManager )
243 
244  // Be sure any OpenGL event cannot be fired after frame deletion:
245  GetCanvas()->SetEvtHandlerEnabled( false );
246 
247  Destroy();
248 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void DeactivateTool()
Function DeactivateTool() Deactivates the currently active tool.
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1089
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
void StopDrawing()
Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDraw...

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

◆ Erase_Current_DrawLayer()

void GERBVIEW_FRAME::Erase_Current_DrawLayer ( bool  query)

Definition at line 73 of file clear_gbr_drawlayers.cpp.

74 {
75  int layer = GetActiveLayer();
76  wxString msg;
77 
78  msg.Printf( _( "Clear layer %d?" ), layer + 1 );
79 
80  if( query && !IsOK( this, msg ) )
81  return;
82 
83  if( m_toolManager )
85 
86  GetImagesList()->DeleteImage( layer );
87 
89  syncLayerBox();
90  GetCanvas()->Refresh();
91 }
Model changes (required full reload)
Definition: tool_base.h:82
void syncLayerBox(bool aRebuildLayerBox=false)
Function syncLayerBox updates the currently "selected" layer within m_SelLayerBox The currently activ...
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)
Function ResetTools() Resets all tools (i.e.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
int GetActiveLayer() const
Function SetActiveLayer returns the active layer.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
#define _(s)
Definition: 3d_actions.cpp:33
void DeleteImage(int aIdx)
delete the loaded data of image aIdx.
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:284
void ReFillLayerWidget()
Function ReFillLayerWidget changes out all the layers in m_Layers; called upon loading new gerber fil...

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

227 {
228  if( m_messagePanel )
230 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:220

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

Execute a remote command send via a socket to the application, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) It called by EDA_DRAW_FRAME::OnSockRequest().

this is a virtual function becuse the actual commands depends on the application. the basic function do nothing

Parameters
cmdline= received command from socket

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 252 of file eda_draw_frame.h.

252 {}

Referenced by EDA_DRAW_FRAME::OnSockRequest().

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

778 {
779  bool centerView = false;
780  BOX2D r = GetCanvas()->GetView()->GetViewport();
781 
782  // Center if we're off the current view, or within 10% of its edge
783  r.Inflate( - (int) r.GetWidth() / 10 );
784 
785  if( !r.Contains( aPos ) )
786  centerView = true;
787 
788  // Center if we're behind an obscuring dialog, or within 10% of its edge
789  wxWindow* dialog = findDialog( GetChildren() );
790 
791  if( dialog )
792  {
793  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
794  dialog->GetSize() );
795  dialogRect.Inflate( dialogRect.GetWidth() / 10 );
796 
797  if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
798  centerView = true;
799  }
800 
801  if( centerView )
802  {
803  // If a dialog partly obscures the window, then center on the uncovered area.
804  if( dialog )
805  {
806  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
807  dialog->GetSize() );
808  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
809  }
810  else
811  GetCanvas()->GetView()->SetCenter( aPos );
812  }
813 
815 }
BOX2D GetViewport() const
Function GetViewport() Returns the current viewport visible area rectangle.
Definition: view.cpp:519
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns 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)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:585
coord_type GetWidth() const
Definition: box2.h:197
bool Contains(const Vec &aPoint) const
Function Contains.
Definition: box2.h:151
wxWindow * findDialog(wxWindowList &aList)
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Moves the graphic crosshair cursor to the requested position expressed in world coordinates.
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:302

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

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

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

Definition at line 552 of file eda_base_frame.h.

552 { return m_AboutTitle; }
wxString m_AboutTitle

References EDA_BASE_FRAME::m_AboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), and COMMON_CONTROL::ReportBug().

◆ GetActiveLayer()

◆ GetAutoSaveFilePrefix()

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

Definition at line 185 of file eda_base_frame.h.

186  {
187  return wxT( "_autosave-" );
188  }

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 313 of file eda_base_frame.h.

313 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetBackupSuffix()

static wxString EDA_BASE_FRAME::GetBackupSuffix ( )
inlinestaticprotectedinherited
Returns
the suffix to be appended to the file extension on backup

Definition at line 177 of file eda_base_frame.h.

178  {
179  return wxT( "-bak" );
180  }

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

470 { return m_canvas; }
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.

References EDA_DRAW_FRAME::m_canvas.

Referenced by EDA_DRAW_FRAME::ActivateGalCanvas(), ActivateGalCanvas(), applyDisplaySettingsToGAL(), GERBVIEW_CONTROL::canvas(), EDITOR_CONDITIONS::canvasTypeFunc(), 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::GetToolCanvas(), GetVisibleLayers(), LoadListOfGerberAndDrillFiles(), ZOOM_TOOL::Main(), PICKER_TOOL::Main(), GERBVIEW_SELECTION_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(), OnSelectDisplayMode(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), Read_EXCELLON_File(), Read_GERBER_File(), GERBER_LAYER_WIDGET::ReFill(), EDA_DRAW_FRAME::RefreshCanvas(), 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(), ZOOM_MENU::update(), UpdateDisplayOptions(), UpdateStatusBar(), and ~GERBVIEW_FRAME().

◆ GetColorSettings()

COLOR_SETTINGS * EDA_DRAW_FRAME::GetColorSettings ( )
virtualinherited

Returns a pointer to the active color theme settings.

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

Definition at line 935 of file eda_draw_frame.cpp.

936 {
937  if( !m_colorSettings )
938  m_colorSettings = Pgm().GetSettingsManager().GetColorSettings();
939 
940  return m_colorSettings;
941 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
COLOR_SETTINGS * m_colorSettings

References EDA_DRAW_FRAME::m_colorSettings, and Pgm().

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

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

483 { 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 1188 of file gerbview_frame.cpp.

1189 {
1190  return m_toolManager->GetTool<GERBVIEW_SELECTION_TOOL>()->GetSelection();
1191 }
GERBVIEW_SELECTION_TOOL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48

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

Referenced by GERBVIEW_INSPECTION_TOOL::MeasureTool().

◆ GetDisplayMode()

int GERBVIEW_FRAME::GetDisplayMode ( )
inline

Function GetDisplayMode.

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

244 { return m_displayMode; }

References m_displayMode.

Referenced by OnUpdateDrawMode().

◆ GetDisplayOptions()

◆ GetDocumentExtents()

const BOX2I GERBVIEW_FRAME::GetDocumentExtents ( bool  aIncludeAllVisible = true) const
inlineoverridevirtual

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

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

Parameters
aIncludeAllVisible- True = Include everything visible in bbox calculations False = Ignore some visible items (program dependent)
Returns
BOX2I - Bounding box of document (ignoring some items as requested)

Reimplemented from EDA_DRAW_FRAME.

Definition at line 142 of file gerbview_frame.h.

143  {
144  wxASSERT( m_gerberLayout );
145  return m_gerberLayout->ViewBBox();
146  }
GBR_LAYOUT * m_gerberLayout
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers.
Definition: eda_item.cpp:206

References m_gerberLayout, and EDA_ITEM::ViewBBox().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

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

147 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:61

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragSelects()

bool TOOLS_HOLDER::GetDragSelects ( ) const
inlineinherited

Indicates that a drag should draw a selection rectangle, even when started over an item.

Definition at line 153 of file tools_holder.h.

153 { return m_dragSelects; }
bool m_dragSelects
Definition: tools_holder.h:65

References TOOLS_HOLDER::m_dragSelects.

Referenced by PL_SELECTION_TOOL::Main(), and EE_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 init 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 716 of file eda_base_frame.cpp.

718 {
719  if( !aFileHistory )
720  aFileHistory = m_fileHistory;
721 
722  wxASSERT( aFileHistory );
723 
724  int baseId = aFileHistory->GetBaseId();
725 
726  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
727 
728  unsigned i = cmdId - baseId;
729 
730  if( i < aFileHistory->GetCount() )
731  {
732  wxString fn = aFileHistory->GetHistoryFile( i );
733 
734  if( wxFileName::FileExists( fn ) )
735  return fn;
736  else
737  {
738  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
739  wxMessageBox( msg );
740 
741  aFileHistory->RemoveFileFromHistory( i );
742  }
743  }
744 
745  // Update the menubar to update the file history menu
746  if( GetMenuBar() )
747  {
748  ReCreateMenuBar();
749  GetMenuBar()->Refresh();
750  }
751 
752  return wxEmptyString;
753 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

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

◆ GetFileHistory()

FILE_HISTORY& EDA_BASE_FRAME::GetFileHistory ( )
inlineinherited

Get the frame's main file history.

Returns
the main file history

Definition at line 468 of file eda_base_frame.h.

469  {
470  return *m_fileHistory;
471  }
FILE_HISTORY * m_fileHistory

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

Definition at line 172 of file eda_draw_frame.h.

172 { return m_findStringHistoryList; }
wxArrayString m_findStringHistoryList

References EDA_DRAW_FRAME::m_findStringHistoryList.

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

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )
inlineinherited

Definition at line 171 of file eda_draw_frame.h.

171 { return *m_findReplaceData; }
wxFindReplaceData * m_findReplaceData

References EDA_DRAW_FRAME::m_findReplaceData.

Referenced by DIALOG_FIND::search().

◆ GetGalDisplayOptions()

◆ GetGbrImage()

◆ GetGerberLayout()

◆ GetGridColor()

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 918 of file gerbview_frame.cpp.

919 {
920  return Pgm().GetSettingsManager().GetColorSettings()->GetColor( LAYER_GRID );
921 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102

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

111 { 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)
inlinevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 441 of file eda_draw_frame.h.

441 { return nullptr; }

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

◆ GetLayerColor()

COLOR4D GERBVIEW_FRAME::GetLayerColor ( int  aLayer) const

Definition at line 833 of file gerbview_frame.cpp.

834 {
835  return Pgm().GetSettingsManager().GetColorSettings()->GetColor( aLayer );
836 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102

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

631 { return m_UndoRedoCountMax; }

References EDA_BASE_FRAME::m_UndoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const
inlineinherited

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

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

Definition at line 159 of file tools_holder.h.

159 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:66

References TOOLS_HOLDER::m_moveWarpsCursor.

Referenced by EDIT_TOOL::doMoveSelection(), LIB_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 nearst grid position.

Definition at line 733 of file eda_draw_frame.cpp.

734 {
735  const wxPoint& gridOrigin = GetGridOrigin();
736  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
737 
738  double xOffset = fmod( gridOrigin.x, gridSize.x );
739  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
740  double yOffset = fmod( gridOrigin.y, gridSize.y );
741  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
742 
743  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
744 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns 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
Returns the grid size.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

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

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

◆ GetNegativeItemsColor()

COLOR4D GERBVIEW_FRAME::GetNegativeItemsColor ( )

Function GetNegativeItemsColor.

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

Definition at line 824 of file gerbview_frame.cpp.

825 {
828  else
829  return GetDrawBgColor();
830 }
COLOR4D GetVisibleElementColor(int aLayerID)
Function GetVisibleElementColor returns the color of a gerber visible element.
bool IsElementVisible(int aLayerID) const
Function IsElementVisible tests 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

Function getNextAvailableLayer finds 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 500 of file gerbview_frame.cpp.

501 {
502  int layer = aLayer;
503 
504  for( unsigned i = 0; i < ImagesMaxCount(); ++i )
505  {
506  const GERBER_FILE_IMAGE* gerber = GetGbrImage( layer );
507 
508  if( gerber == NULL ) // this graphic layer is available: use it
509  return layer;
510 
511  ++layer; // try next graphic layer
512 
513  if( layer >= (int)ImagesMaxCount() )
514  layer = 0;
515  }
516 
517  return NO_AVAILABLE_LAYERS;
518 }
GERBER_FILE_IMAGE holds the Image data and parameters for one gerber file and layer parameters (TODO:...
unsigned ImagesMaxCount() const
The max number of file images.
#define NULL
#define NO_AVAILABLE_LAYERS
GERBER_FILE_IMAGE * GetGbrImage(int aIdx) const

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

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

◆ GetOriginTransforms()

virtual ORIGIN_TRANSFORMS& EDA_DRAW_FRAME::GetOriginTransforms ( )
inlinevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented in PCB_BASE_FRAME.

Definition at line 217 of file eda_draw_frame.h.

218  { return m_OriginTransforms; }
ORIGIN_TRANSFORMS m_OriginTransforms
Default display origin transforms object.

References EDA_DRAW_FRAME::m_OriginTransforms.

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

◆ GetPageSettings()

const PAGE_INFO & GERBVIEW_FRAME::GetPageSettings ( ) const
overridevirtual

◆ GetPageSizeIU()

const wxSize GERBVIEW_FRAME::GetPageSizeIU ( ) const
overridevirtual

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

Implements EDA_DRAW_FRAME.

Definition at line 895 of file gerbview_frame.cpp.

896 {
897  // this function is only needed because EDA_DRAW_FRAME is not compiled
898  // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
899  // into an application specific source file.
900  return GetPageSettings().GetSizeIU();
901 }
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 871 of file eda_draw_frame.cpp.

872 {
873  // Virtual function. Base class implementation returns an empty string.
874  return wxEmptyString;
875 }

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

◆ GetSettingsManager()

◆ GetSeverity()

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

Reimplemented in PCB_BASE_FRAME.

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

186 { 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 904 of file gerbview_frame.cpp.

905 {
906  wxASSERT( m_gerberLayout );
907  return m_gerberLayout->GetTitleBlock();
908 }
TITLE_BLOCK & GetTitleBlock()
Definition: gbr_layout.h:70
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 473 of file eda_draw_frame.h.

473 { 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 76 of file tools_holder.h.

76 { return m_toolManager; }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48

References TOOLS_HOLDER::m_toolManager.

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

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

967 {
969 
970  aPrimaryUnit = GetUserUnits();
971  aSecondaryUnits = EDA_UNITS::MILS;
972 
973  if( IsImperialUnit( aPrimaryUnit ) )
974  {
975  if( cmnTool )
976  aSecondaryUnits = cmnTool->GetLastMetricUnits();
977  else
978  aSecondaryUnits = EDA_UNITS::MILLIMETRES;
979  }
980  else
981  {
982  if( cmnTool )
983  aSecondaryUnits = cmnTool->GetLastImperialUnits();
984  else
985  aSecondaryUnits = EDA_UNITS::MILS;
986  }
987 }
EDA_UNITS GetLastMetricUnits()
Definition: common_tools.h:75
EDA_UNITS GetLastImperialUnits()
Definition: common_tools.h:76
COMMON_TOOLS.
Definition: common_tools.h:38
bool IsImperialUnit(EDA_UNITS aUnit)
Definition: common.cpp:185
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
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(), 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 237 of file eda_base_frame.h.

238  {
239  return m_userUnits;
240  }
EDA_UNITS m_userUnits

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(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_MODEDIT_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), MARKER_PCB::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), ZONE_CONTAINER::GetMsgPanelInfo(), WS_DRAW_ITEM_BASE::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), DIMENSION::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), RC_TREE_MODEL::GetValue(), PCB_INSPECTION_TOOL::InspectClearance(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_SELECT_NET_FROM_LIST::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::onUpdateThicknessValue(), PANEL_PREV_3D::PANEL_PREV_3D(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_FEATURE_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(), updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and PANEL_SETUP_TRACKS_AND_VIAS::validateData().

◆ GetVisibleElementColor()

COLOR4D GERBVIEW_FRAME::GetVisibleElementColor ( int  aLayerID)

Function GetVisibleElementColor returns the color of a gerber visible element.

Definition at line 754 of file gerbview_frame.cpp.

755 {
756  COLOR4D color = COLOR4D::UNSPECIFIED;
757  COLOR_SETTINGS* settings = Pgm().GetSettingsManager().GetColorSettings();
758 
759  switch( aLayerID )
760  {
762  case LAYER_DCODES:
765  color = settings->GetColor( aLayerID );
766  break;
767 
768  case LAYER_GERBVIEW_GRID:
769  color = GetGridColor();
770  break;
771 
772  default:
773  wxFAIL_MSG( wxString::Format( "GERBVIEW_FRAME::GetVisibleElementColor(): bad arg %d",
774  aLayerID ) );
775  }
776 
777  return color;
778 }
int color
Definition: DXF_plotter.cpp:60
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
COLOR4D GetGridColor() override
COLOR4D GetColor(int aLayer) const
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
Color settings are a bit different than most of the settings objects in that there can be more than o...
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100

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

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

◆ GetVisibleLayers()

LSET GERBVIEW_FRAME::GetVisibleLayers ( ) const

Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSettings.

Returns
LSET of the visible layers

Definition at line 718 of file gerbview_frame.cpp.

719 {
720  LSET visible = LSET::AllLayersMask();
721 
722  if( GetCanvas() )
723  {
724  for( int i = 0; i < GERBER_DRAWLAYERS_COUNT; i++ )
725  visible[i] = GetCanvas()->GetView()->IsLayerVisible( GERBER_DRAW_LAYER( i ) );
726  }
727 
728  return visible;
729 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
LSET is a set of PCB_LAYER_IDs.
#define GERBER_DRAWLAYERS_COUNT
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
static LSET AllLayersMask()
Definition: lset.cpp:786
#define GERBER_DRAW_LAYER(x)
bool IsLayerVisible(int aLayer) const
Function IsLayerVisible() Returns information about visibility of a particular layer.
Definition: view.h:402

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

Returns a pointer to the window settings for this frame.

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

Parameters
aCfgis this frame's config object

Reimplemented in SIM_PLOT_FRAME, FOOTPRINT_WIZARD_FRAME, FOOTPRINT_VIEWER_FRAME, LIB_VIEW_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 646 of file eda_base_frame.cpp.

647 {
648  return &aCfg->m_Window;
649 }
WINDOW_SETTINGS m_Window
Definition: app_settings.h:173

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

994 {
995 #ifdef __WXGTK__
996  // GTK includes the window decorations in the normal GetSize call,
997  // so we have to use a GTK-specific sizing call that returns the
998  // non-decorated window size.
999  int width = 0;
1000  int height = 0;
1001  GTKDoGetSize( &width, &height );
1002 
1003  wxSize winSize( width, height );
1004 #else
1005  wxSize winSize = GetSize();
1006 #endif
1007 
1008  return winSize;
1009 }

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

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const
inherited

Return a human readable value for display in dialogs.

Definition at line 524 of file eda_draw_frame.cpp.

525 {
526  // returns a human readable value which can be displayed as zoom
527  // level indicator in dialogs.
528  double zoom = m_canvas->GetGAL()->GetZoomFactor() / ZOOM_COEFF;
529  return wxString::Format( wxT( "Z %.2f" ), zoom );
530 }
#define ZOOM_COEFF
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns 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, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201

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

Referenced by EDA_DRAW_FRAME::UpdateStatusBar().

◆ HandleUpdateUIEvent()

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

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

320 {
321  bool checkRes = false;
322  bool enableRes = true;
323  bool showRes = true;
324  SELECTION& selection = aFrame->GetCurrentSelection();
325 
326  try
327  {
328  checkRes = aCond.checkCondition( selection );
329  enableRes = aCond.enableCondition( selection );
330  showRes = aCond.showCondition( selection );
331  }
332  catch( std::exception& )
333  {
334  // Something broke with the conditions, just skip the event.
335  aEvent.Skip();
336  return;
337  }
338 
339  aEvent.Enable( enableRes );
340  aEvent.Show( showRes );
341 
342  bool canCheck = true;
343 
344  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
345  // see if they can be and can't just universally apply a check in this event.
346  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
347  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
348 
349  if( canCheck )
350  aEvent.Check( checkRes );
351 }
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:123

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

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

void EDA_DRAW_FRAME::HardRedraw ( )
virtualinherited

Rebuild the GAL and redraws the screen.

Call when something went wrong.

Reimplemented in SCH_EDIT_FRAME, LIB_EDIT_FRAME, PL_EDITOR_FRAME, SCH_BASE_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 753 of file eda_draw_frame.cpp.

754 {
755  // To be implemented by subclasses.
756 }

Referenced by COMMON_TOOLS::ZoomRedraw().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 665 of file eda_base_frame.cpp.

666 {
667  return Kiface().GetHelpFileName();
668 }
const wxString & GetHelpFileName() const
Function GetHelpFileName returns just the basename portion of the current help file.
Definition: kiface_i.h:123
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImagesMaxCount()

unsigned GERBVIEW_FRAME::ImagesMaxCount ( ) const

The max number of file images.

Definition at line 1000 of file gerbview_frame.cpp.

1001 {
1003 }
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 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
aActionMap= current hotkey map (over which the imported hotkeys will be applied)
aDefaultShortname= a default short name (extension not needed) like eechema, kicad...

◆ InitExitKey()

void EDA_DRAW_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 462 of file eda_draw_frame.cpp.

463 {
464  wxAcceleratorEntry entries[1];
465  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
466  wxAcceleratorTable accel( 1, entries );
467  SetAcceleratorTable( accel );
468 }

Referenced by FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME().

◆ InstallPreferences()

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

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 1044 of file gerbview_frame.cpp.

1046 {
1047  wxTreebook* book = aParent->GetTreebook();
1048 
1049  book->AddPage( new wxPanel( book ), _( "Gerbview" ) );
1050  book->AddSubPage( new PANEL_GERBVIEW_DISPLAY_OPTIONS( this, book ), _( "Display Options" ) );
1051  book->AddSubPage( new PANEL_GERBVIEW_SETTINGS( this, book ), _( "Editing Options" ) );
1052 
1053  aHotkeysPanel->AddHotKeys( GetToolManager() );
1054 }
void AddHotKeys(TOOL_MANAGER *aToolMgr)
wxTreebook * GetTreebook()
Definition: paged_dialog.h:50
#define _(s)
Definition: 3d_actions.cpp:33
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:76

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

Definition at line 200 of file eda_base_frame.h.

200 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( )
virtualinherited

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

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

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

Definition at line 905 of file eda_base_frame.cpp.

906 {
907  // This function should be overridden in child classes
908  return false;
909 }

Referenced by EDITOR_CONDITIONS::contentModifiedFunc().

◆ IsCurrentTool()

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

Definition at line 108 of file tools_holder.cpp.

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

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

Referenced by PCB_INSPECTION_TOOL::HighlightNetTool(), SCH_EDIT_TOOL::Init(), PCB_EDITOR_CONTROL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), EDIT_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )
inherited

Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal().

IOW, it will return true if the dialog is not modal or if it is modal and has been dismissed.

Definition at line 155 of file kiway_player.cpp.

156 {
157  return !m_modal_loop;
158 }
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:204

References KIWAY_PLAYER::m_modal_loop.

Referenced by FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), and LIB_VIEW_FRAME::OnCloseWindow().

◆ IsElementVisible()

bool GERBVIEW_FRAME::IsElementVisible ( int  aLayerID) const

Function IsElementVisible tests 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 700 of file gerbview_frame.cpp.

701 {
702  switch( aLayerID )
703  {
706  case LAYER_GERBVIEW_GRID: return IsGridVisible();
708  case LAYER_GERBVIEW_BACKGROUND: return true;
709 
710  default:
711  wxFAIL_MSG( wxString::Format( "GERBVIEW_FRAME::IsElementVisible(): bad arg %d", aLayerID ) );
712  }
713 
714  return true;
715 }
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, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
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_GRID, LAYER_GERBVIEW_WORKSHEET, 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

◆ IsLayerVisible()

bool GERBVIEW_FRAME::IsLayerVisible ( int  aLayer) const

Function IsLayerVisible tests whether a given layer is visible.

Parameters
aLayer= The layer to be tested (still 0-31!)
Returns
bool - true if the layer is visible.

Definition at line 748 of file gerbview_frame.cpp.

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

References LAYER_WIDGET::IsLayerVisible(), and m_LayersManager.

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

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const
inlineoverridevirtualinherited

Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing.

Reimplemented from EDA_BASE_FRAME.

Definition at line 178 of file kiway_player.h.

178 { return m_modal; }

References KIWAY_PLAYER::m_modal.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), LIB_CONTROL::AddSymbolToSchematic(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LIB_VIEW_FRAME::OnCloseWindow(), and KIWAY_PLAYER::ShowModal().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 315 of file eda_base_frame.h.

315 { return m_Ident == aType; }

References EDA_BASE_FRAME::m_Ident.

Referenced by LIB_CONTROL::AddLibrary(), PCBNEW_CONTROL::AddLibrary(), EDA_DRAW_FRAME::AddStandardSubMenus(), LIB_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), EDA_3D_VIEWER::CreateMenuBar(), LIB_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), COMMON_TOOLS::doZoomFit(), LIB_CONTROL::DuplicateSymbol(), LIB_CONTROL::EditSymbol(), LIB_CONTROL::ExportSymbol(), MODULE::GetMsgPanelInfo(), CONVERT_TOOL::Init(), LIB_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), CONVERT_TOOL::LinesToPoly(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), LIB_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCBNEW_CONTROL::Paste(), LIB_CONTROL::PinLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), LIB_CONTROL::Revert(), EE_INSPECTION_TOOL::RunERC(), LIB_CONTROL::Save(), LIB_CONTROL::ShowComponentTree(), EE_INSPECTION_TOOL::ShowDatasheet(), and LIB_CONTROL::UnpinLibrary().

◆ IsWritable()

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

Checks if aFileName can be written.

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

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

Definition at line 815 of file eda_base_frame.cpp.

816 {
817  wxString msg;
818  wxFileName fn = aFileName;
819 
820  // Check for absence of a file path with a file name. Unfortunately KiCad
821  // uses paths relative to the current project path without the ./ part which
822  // confuses wxFileName. Making the file name path absolute may be less than
823  // elegant but it solves the problem.
824  if( fn.GetPath().IsEmpty() && fn.HasName() )
825  fn.MakeAbsolute();
826 
827  wxCHECK_MSG( fn.IsOk(), false,
828  wxT( "File name object is invalid. Bad programmer!" ) );
829  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
830  wxT( "File name object path <" ) + fn.GetFullPath() +
831  wxT( "> is not set. Bad programmer!" ) );
832 
833  if( fn.IsDir() && !fn.IsDirWritable() )
834  {
835  msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
836  fn.GetPath() );
837  }
838  else if( !fn.FileExists() && !fn.IsDirWritable() )
839  {
840  msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
841  fn.GetFullName(), fn.GetPath() );
842  }
843  else if( fn.FileExists() && !fn.IsFileWritable() )
844  {
845  msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
846  fn.GetFullPath() );
847  }
848 
849  if( !msg.IsEmpty() )
850  {
851  wxMessageBox( msg );
852  return false;
853  }
854 
855  return true;
856 }
#define _(s)
Definition: 3d_actions.cpp:33

References _.

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

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), 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(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), LIB_CONTROL::UpdateSymbolInSchematic(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS aEvent)
protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 176 of file kiway_player.cpp.

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

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS aEvent)
virtualinherited

Function KiwayMailIn receives KIWAY_EXPRESS messages from other players.

Merely override it in derived classes.

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

Definition at line 70 of file kiway_player.cpp.

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

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

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

Function language_change is an event handler called on a language menu selection.

Definition at line 183 of file kiway_player.cpp.

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

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 
)
protectedinherited
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 877 of file eda_draw_frame.cpp.

880 {
881  wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
882  aFilename.SetExt( ext );
883 
884  if( isDirectory && doOpen )
885  {
886  wxDirDialog dlg( this, prompt, Prj().GetProjectPath(),
887  wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
888 
889  if( dlg.ShowModal() == wxID_CANCEL )
890  return false;
891 
892  aFilename = dlg.GetPath();
893  aFilename.SetExt( ext );
894  }
895  else
896  {
897  // Ensure the file has a dummy name, otherwise GTK will display the regex from the filter
898  if( aFilename.GetName().empty() )
899  aFilename.SetName( "Library" );
900 
901  wxString dir = Prj().IsNullProject() ? aFilename.GetFullPath() : Prj().GetProjectPath();
902 
903  wxFileDialog dlg( this, prompt, dir, aFilename.GetFullName(),
904  wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
905  : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
906 
907  if( dlg.ShowModal() == wxID_CANCEL )
908  return false;
909 
910  aFilename = dlg.GetPath();
911  aFilename.SetExt( ext );
912  }
913 
914  return true;
915 }
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:121
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
VTBL_ENTRY bool IsNullProject() const
Checks if this project is a null project (i.e.
Definition: project.cpp:133
#define _(s)
Definition: 3d_actions.cpp:33

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

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

◆ LoadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::LoadCanvasTypeSetting ( )
inherited

Returns the canvas type stored in the application settings.

Definition at line 661 of file eda_draw_frame.cpp.

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

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

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

◆ LoadExcellonFiles()

bool GERBVIEW_FRAME::LoadExcellonFiles ( const wxString &  aFileName)

function LoadExcellonFiles Load a drill (EXCELLON) file or many files.

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

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

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

function LoadGerberFiles Load a photoplot (Gerber) file or many files.

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

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

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

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

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

◆ LoadGerberJobFile()

bool GERBVIEW_FRAME::LoadGerberJobFile ( const wxString &  aFileName)

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

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

Definition at line 175 of file job_file_reader.cpp.

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

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

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

◆ LoadListOfGerberAndDrillFiles()

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

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

Parameters
aPathis the base path for the filenames if they are relative
aFilenameListis a list of filenames to load
aFileTypeis a list of type of files to load (0 = Gerber, 1 = NC drill) if nullptr, files are expected Gerber type.
Returns
true if every file loaded successfully

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

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

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

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

◆ LoadSettings()

void GERBVIEW_FRAME::LoadSettings ( APP_SETTINGS_BASE aCfg)
overridevirtual

Load common frame parameters from a configuration file.

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 308 of file gerbview_frame.cpp.

309 {
311 
312  if( aCfg->m_Window.grid.sizes.empty() )
313  {
314  aCfg->m_Window.grid.sizes = { "100 mil",
315  "50 mil",
316  "25 mil",
317  "20 mil",
318  "10 mil",
319  "5 mil",
320  "2.5 mil",
321  "2 mil",
322  "1 mil",
323  "0.5 mil",
324  "0.2 mil",
325  "0.1 mil",
326  "5.0 mm",
327  "2.5 mm",
328  "1.0 mm",
329  "0.5 mm",
330  "0.25 mm",
331  "0.2 mm",
332  "0.1 mm",
333  "0.05 mm",
334  "0.025 mm",
335  "0.01 mm" };
336  }
337 
338  if( aCfg->m_Window.zoom_factors.empty() )
339  {
340  aCfg->m_Window.zoom_factors = { 0.022,
341  0.035,
342  0.05,
343  0.08,
344  0.13,
345  0.22,
346  0.35,
347  0.6,
348  1.0,
349  2.2,
350  3.5,
351  5.0,
352  8.0,
353  13.0,
354  22.0,
355  35.0,
356  50.0,
357  80.0,
358  130.0,
359  220.0 };
360  }
361 
362  for( double& factor : aCfg->m_Window.zoom_factors )
363  factor = std::min( factor, MAX_ZOOM_FACTOR );
364 
365  GERBVIEW_SETTINGS* cfg = dynamic_cast<GERBVIEW_SETTINGS*>( aCfg );
366  wxCHECK( cfg, /*void*/ );
367 
369 
370  PAGE_INFO pageInfo( wxT( "GERBER" ) );
371  pageInfo.SetType( cfg->m_Appearance.page_type );
372  SetPageSettings( pageInfo );
373 
376 
380 }
std::vector< wxString > m_JobFileHistory
FILE_HISTORY m_jobFileHistory
void SetPageSettings(const PAGE_INFO &aPageSettings) override
#define MAX_ZOOM_FACTOR
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
PAGE_INFO describes the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:54
FILE_HISTORY m_drillFileHistory
WINDOW_SETTINGS m_Window
Definition: app_settings.h:173
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)
Function SetElementVisibility changes the visibility of an element category.

References WINDOW_SETTINGS::grid, LAYER_DCODES, LAYER_GERBVIEW_WORKSHEET, 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, MAX_ZOOM_FACTOR, 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, and WINDOW_SETTINGS::zoom_factors.

Referenced by GERBVIEW_FRAME().

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS aCfg)
inherited

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

547 {
548  LoadWindowState( aCfg->state );
549 
550  if( m_hasAutoSave )
551  m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
552 
553  m_perspective = aCfg->perspective;
554  m_mruPath = aCfg->mru_path;
555 
556  TOOLS_HOLDER::CommonSettingsChanged( false, false );
557 }
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:102
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 428 of file eda_base_frame.cpp.

429 {
430  if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
431  return;
432 
433  const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
434 
435  if( state != nullptr )
436  {
437  LoadWindowState( state->window );
438  }
439 }
VTBL_ENTRY PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:147
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
void LoadWindowState(const wxString &aFileName)
PROJECT & Prj() const
Function Prj returns 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 442 of file eda_base_frame.cpp.

443 {
444  bool wasDefault = false;
445 
446  m_FramePos.x = aState.pos_x;
447  m_FramePos.y = aState.pos_y;
448  m_FrameSize.x = aState.size_x;
449  m_FrameSize.y = aState.size_y;
450 
451  wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
453 
454  // Ensure minimum size is set if the stored config was zero-initialized
456  {
459  wasDefault = true;
460 
461  wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_FrameSize.x, m_FrameSize.y );
462  }
463 
464  wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
465 
466  if( aState.display >= wxDisplay::GetCount() )
467  {
468  wxLogTrace( traceDisplayLocation, "Previous display not found" );
469 
470  // If it isn't attached, use the first display
471  // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
472  const unsigned int index = 0;
473  wxDisplay display( index );
474  wxRect clientSize = display.GetGeometry();
475 
476  m_FramePos = wxDefaultPosition;
477 
478  // Ensure the window fits on the display, since the other one could have been larger
479  if( m_FrameSize.x > clientSize.width )
480  m_FrameSize.x = clientSize.width;
481 
482  if( m_FrameSize.y > clientSize.height )
483  m_FrameSize.y = clientSize.height;
484  }
485  else
486  {
487  wxPoint upperRight( m_FramePos.x + m_FrameSize.x, m_FramePos.y );
488  wxPoint upperLeft( m_FramePos.x, m_FramePos.y );
489 
490  wxDisplay display( aState.display );
491  wxRect clientSize = display.GetClientArea();
492 
493  // The percentage size (represented in decimal) of the region around the screen's border where
494  // an upper corner is not allowed
495 #define SCREEN_BORDER_REGION 0.10
496 
497  int yLim = clientSize.y + ( clientSize.height * ( 1.0 - SCREEN_BORDER_REGION ) );
498  int xLimLeft = clientSize.x + ( clientSize.width * SCREEN_BORDER_REGION );
499  int xLimRight = clientSize.x + ( clientSize.width * ( 1.0 - SCREEN_BORDER_REGION ) );
500 
501  if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
502  upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
503  upperRight.y > yLim ) // Upper corner too close to the bottom of the screen
504  {
505  m_FramePos = wxDefaultPosition;
506  wxLogTrace( traceDisplayLocation, "Resetting to default position" );
507  }
508  }
509 
510  // Ensure Window title bar is visible
511 #if defined( __WXOSX__ )
512  // for macOSX, the window must be below system (macOSX) toolbar
513  int Ypos_min = 20;
514 #else
515  int Ypos_min = 0;
516 #endif
517  if( m_FramePos.y < Ypos_min )
518  m_FramePos.y = Ypos_min;
519 
520  wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
522 
523  SetSize( m_FramePos.x, m_FramePos.y, m_FrameSize.x, m_FrameSize.y );
524 
525  // Center the window if we reset to default
526  if( m_FramePos.x == -1 )
527  {
528  wxLogTrace( traceDisplayLocation, "Centering window" );
529  Center();
530  m_FramePos = GetPosition();
531  }
532 
533  // Record the frame sizes in an un-maximized state
536 
537  // Maximize if we were maximized before
538  if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
539  {
540  wxLogTrace( traceDisplayLocation, "Maximizing window" );
541  Maximize();
542  }
543 }
static const int s_defaultSize_x
static const int s_defaultSize_y
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxSize m_NormalFrameSize
#define SCREEN_BORDER_REGION
static const int s_minsize_x
static const int s_minsize_y
unsigned int display
Definition: app_settings.h:75
wxPoint m_NormalFramePos

References PCAD2KICAD::Center, WINDOW_STATE::display, EDA_BASE_FRAME::m_FramePos, EDA_BASE_FRAME::m_FrameSize, EDA_BASE_FRAME::m_maximizeByDefault, EDA_BASE_FRAME::m_NormalFramePos, EDA_BASE_FRAME::m_NormalFrameSize, WINDOW_STATE::maximized, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, s_defaultSize_x, s_defaultSize_y, s_minsize_x, s_minsize_y, SCREEN_BORDER_REGION, WINDOW_STATE::size_x, WINDOW_STATE::size_y, traceDisplayLocation, wxPoint::x, and wxPoint::y.

◆ LoadZipArchiveFile()

bool GERBVIEW_FRAME::LoadZipArchiveFile ( const wxString &  aFileName)

function LoadZipArchiveFileLoadZipArchiveFile Load a zipped archive file.

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

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

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

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

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

◆ LockFile()

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

Mark a schematic file as being in use.

Use ReleaseFile() to undo this.

Parameters
aFileName= full path to the file.
Returns
false if the file was already locked, true otherwise.

Definition at line 182 of file eda_draw_frame.cpp.

183 {
184  m_file_checker = ::LockFile( aFileName );
185 
186  return bool( m_file_checker );
187 }
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
prevents opening same file multiple times.
bool LockFile(const wxString &aFileName)
Mark a schematic file as being in use.

References EDA_DRAW_FRAME::m_file_checker.

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

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce)
inlineinherited

Definition at line 633 of file eda_base_frame.h.

634  {
635  m_isNonUserClose = true;
636  return Close( aForce );
637  }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 263 of file eda_base_frame.cpp.

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

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

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  event)
virtualinherited

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

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

Reimplemented in FOOTPRINT_VIEWER_FRAME.

Definition at line 276 of file eda_base_frame.cpp.

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

References dump(), and kicadTraceKeyEvent.

◆ OnClearDrlFileHistory()

void GERBVIEW_FRAME::OnClearDrlFileHistory ( wxCommandEvent &  aEvent)
private

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

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

References EDA_BASE_FRAME::ClearFileHistory(), and m_drillFileHistory.

◆ OnClearGbrFileHistory()

void GERBVIEW_FRAME::OnClearGbrFileHistory ( wxCommandEvent &  aEvent)
private

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

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

References EDA_BASE_FRAME::ClearFileHistory().

◆ OnClearJobFileHistory()

void GERBVIEW_FRAME::OnClearJobFileHistory ( wxCommandEvent &  aEvent)
private

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

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

References EDA_BASE_FRAME::ClearFileHistory(), and m_jobFileHistory.

◆ OnClearZipFileHistory()

void GERBVIEW_FRAME::OnClearZipFileHistory ( wxCommandEvent &  aEvent)
private

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

96 {
98 }
FILE_HISTORY m_zipFileHistory
void ClearFileHistory(FILE_HISTORY *aFileHistory=nullptr)
Removes all files from the file history.

References EDA_BASE_FRAME::ClearFileHistory(), and m_zipFileHistory.

◆ OnDrlFileHistory()

void GERBVIEW_FRAME::OnDrlFileHistory ( wxCommandEvent &  event)

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

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

63 {
64  wxString fn;
65 
66  fn = GetFileFromHistory( event.GetId(), _( "Drill files" ), &m_drillFileHistory );
67 
68  if( !fn.IsEmpty() )
69  {
70  Erase_Current_DrawLayer( false );
71  LoadExcellonFiles( fn );
72  }
73 }
void Erase_Current_DrawLayer(bool query)
wxString GetFileFromHistory(int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
Fetches the file name from the file history list.
FILE_HISTORY m_drillFileHistory
#define _(s)
Definition: 3d_actions.cpp:33
bool LoadExcellonFiles(const wxString &aFileName)
function LoadExcellonFiles Load a drill (EXCELLON) file or many files.

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

◆ OnGbrFileHistory()

void GERBVIEW_FRAME::OnGbrFileHistory ( wxCommandEvent &  event)

Function OnGbrFileHistory deletes the current data and loads a Gerber file selected from history list on current layer.

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

44 {
45  wxString fn;
46 
47  fn = GetFileFromHistory( event.GetId(), _( "Gerber files" ) );
48 
49  if( !fn.IsEmpty() )
50  {
51  Erase_Current_DrawLayer( false );
52  LoadGerberFiles( fn );
53  }
54 }
void Erase_Current_DrawLayer(bool query)
wxString GetFileFromHistory(int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
Fetches the file name from the file history list.
bool LoadGerberFiles(const wxString &aFileName)
function LoadGerberFiles Load a photoplot (Gerber) file or many files.
#define _(s)
Definition: 3d_actions.cpp:33

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

◆ OnGridSettings()

void EDA_DRAW_FRAME::OnGridSettings ( wxCommandEvent &  event)
inherited

Definition at line 314 of file eda_draw_frame.cpp.

315 {
316  DIALOG_GRID_SETTINGS dlg( this );
317 
318  if( dlg.ShowModal() == wxID_OK )
319  {
320  UpdateStatusBar();
321  GetCanvas()->Refresh();
322  }
323 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
void UpdateStatusBar() override
Update the status bar information.

References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::Refresh(), and EDA_DRAW_FRAME::UpdateStatusBar().

Referenced by EDA_DRAW_FRAME::OnSelectGrid().

◆ OnJobFileHistory()

void GERBVIEW_FRAME::OnJobFileHistory ( wxCommandEvent &  event)

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

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

102 {
103  wxString filename = GetFileFromHistory( event.GetId(), _( "Job files" ), &m_jobFileHistory );
104 
105  if( !filename.IsEmpty() )
106  LoadGerberJobFile( filename );
107 }
FILE_HISTORY m_jobFileHistory
bool LoadGerberJobFile(const wxString &aFileName)
Load a Gerber job file, and load gerber files found in job files.