#include <gerbview_frame.h>

Inheritance diagram for GERBVIEW_FRAME:

Public Types
enum	UNDO_REDO_LIST { UNDO_LIST , REDO_LIST }
	Specifies whether we are interacting with the undo or redo stacks. More...

enum	HOLDER_TYPE { DIALOG , FRAME , PANEL }

Public Member Functions
	GERBVIEW_FRAME (KIWAY aKiway, wxWindow aParent)

	~GERBVIEW_FRAME ()

void	doCloseWindow () override

bool	OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl) override
	Open a project or set of files given by aFileList. More...

bool	LoadListOfGerberAndDrillFiles (const wxString &aPath, const wxArrayString &aFilenameList, std::vector< int > *aFileType)
	Load a list of Gerber and NC drill files and updates the view based on them. More...

void	ReCreateHToolbar () override

void	ReCreateAuxiliaryToolbar () override

void	ReCreateVToolbar () override
	Create or update the right vertical toolbar. More...

void	ReCreateOptToolbar () override
	Create or update the left vertical toolbar (option toolbar) More...

void	ReCreateMenuBar () override
	Recreates the menu bar. More...

void	UpdateStatusBar () override
	Update the status bar information. More...

void	UpdateToolbarControlSizes () override
	Update the sizes of any controls in the toolbars of the frame. More...

GERBVIEW_SETTINGS *	gvconfig () const

void	ApplyDisplaySettingsToGAL ()
	Updates the GAL with display settings changes. More...

int	GetDisplayMode ()

void	SetDisplayMode (int aMode)

bool	IsElementVisible (int aLayerID) const
	Test whether a given element category is visible. More...

void	SetElementVisibility (int aLayerID, bool aNewState)
	Change the visibility of an element category. More...

void	SetGridVisibility (bool aVisible) override

LSET	GetVisibleLayers () const
	A proxy function that calls the correspondent function in m_BoardSettings. More...

void	SetVisibleLayers (LSET aLayerMask)
	A proxy function that calls the correspondent function in m_BoardSettings. More...

bool	IsLayerVisible (int aLayer) const
	Test whether a given layer is visible. More...

COLOR4D	GetVisibleElementColor (int aLayerID)
	Return the color of a gerber visible element. More...

void	SetVisibleElementColor (int aLayerID, const COLOR4D &aColor)

COLOR4D	GetLayerColor (int aLayer) const

void	SetLayerColor (int aLayer, const COLOR4D &aColor)

void	ReFillLayerWidget ()
	Change out all the layers in m_Layers; called upon loading new gerber files. More...

void	SetActiveLayer (int aLayer, bool doLayerWidgetUpdate=true)
	change the currently active layer to aLayer and update the GERBER_LAYER_WIDGET. More...

int	GetActiveLayer () const
	Return the active layer. More...

int	getNextAvailableLayer () const
	Find the next empty layer. More...

void	syncLayerWidget ()
	Update the currently "selected" layer within the GERBER_LAYER_WIDGET. More...

void	syncLayerBox (bool aRebuildLayerBox=false)
	Update the currently "selected" layer within m_SelLayerBox. More...

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

void	DisplayGridMsg () override
	Display the current grid pane on the status bar. More...

void	LoadSettings (APP_SETTINGS_BASE *aCfg) override
	Load common frame parameters from a configuration file. More...

void	SaveSettings (APP_SETTINGS_BASE *aCfg) override
	Save common frame parameters to a configuration data file. More...

COLOR_SETTINGS *	GetColorSettings (bool aForceRefresh=false) const override
	Returns a pointer to the active color theme settings. More...

void	ToggleLayerManager ()

void	ShowChangedLanguage () override

void	OnSelectHighlightChoice (wxCommandEvent &event)
	Handles the changing of the highlighted component/net/attribute. More...

void	OnSelectActiveDCode (wxCommandEvent &event)
	Select the active DCode for the current active layer. More...

void	OnSelectActiveLayer (wxCommandEvent &event)
	Select the active layer: More...

void	OnSelectDisplayMode (wxCommandEvent &event)
	Called on a display mode selection. More...

void	OnQuit (wxCommandEvent &event)
	Called on request of application quit. More...

void	OnUpdateDrawMode (wxUpdateUIEvent &aEvent)

void	OnUpdateSelectDCode (wxUpdateUIEvent &aEvent)

void	OnUpdateLayerSelectBox (wxUpdateUIEvent &aEvent)

void	OnGbrFileHistory (wxCommandEvent &event)
	Delete the current data and loads a Gerber file selected from history list on current layer. More...

void	OnDrlFileHistory (wxCommandEvent &event)
	Delete the current data and load a drill file in Excellon format selected from history list on current layer. More...

void	OnZipFileHistory (wxCommandEvent &event)
	Delete the current data and load a zip archive file selected from the history list. More...

void	OnJobFileHistory (wxCommandEvent &event)
	Delete the current data and load a gerber job file selected from the history list. More...

bool	unarchiveFiles (const wxString &aFullFileName, REPORTER *aReporter=nullptr)
	Extract gerber and drill files from the zip archive, and load them. More...

bool	LoadAutodetectedFiles (const wxString &aFileName)
	Load a given file or selected file(s), if the filename is empty. More...

bool	LoadGerberFiles (const wxString &aFileName)
	Load a given Gerber file or selected file(s), if the filename is empty. More...

bool	Read_GERBER_File (const wxString &GERBER_FullFileName)

bool	LoadExcellonFiles (const wxString &aFileName)
	Load a drill (EXCELLON) file or many files. More...

bool	Read_EXCELLON_File (const wxString &aFullFileName)

bool	LoadZipArchiveFile (const wxString &aFileName)
	Load a zipped archive file. More...

bool	LoadGerberJobFile (const wxString &aFileName)
	Load a Gerber job file, and load gerber files found in job files. More...

bool	Clear_DrawLayers (bool query)

void	Erase_Current_DrawLayer (bool query)

void	SortLayersByFileExtension ()

void	SortLayersByX2Attributes ()

void	RemapLayers (std::unordered_map< int, int > remapping)
	Takes a layer remapping and reorders the layers. More...

void	UpdateDiffLayers ()
	Update each layers' differential option. More...

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

void	SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand)
	Create a new entry in undo list of commands and add a list of pickers to handle a list of items. More...

void	ActivateGalCanvas () override
	Use to start up the GAL drawing canvas. More...

void	CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
	Called after the preferences dialog is run. More...

SELECTION &	GetCurrentSelection () override
	Get the current selection from the canvas area. More...

void	SetLayout (GBR_LAYOUT *aLayout)
	Set the m_gerberLayout member in such as way as to ensure deleting any previous GBR_LAYOUT. More...

GBR_LAYOUT *	GetGerberLayout () const

GERBER_FILE_IMAGE_LIST *	GetImagesList () const
	Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data. More...

GERBER_FILE_IMAGE *	GetGbrImage (int aIdx) const

unsigned	ImagesMaxCount () const
	The max number of file images. More...

void	SetPageSettings (const PAGE_INFO &aPageSettings) override

const PAGE_INFO &	GetPageSettings () const override

const wxSize	GetPageSizeIU () const override
	Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view. More...

const VECTOR2I &	GetGridOrigin () const override
	Return the absolute coordinates of the origin of the snap grid. More...

void	SetGridOrigin (const VECTOR2I &aPoint) override

const TITLE_BLOCK &	GetTitleBlock () const override

void	SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override

int	SelectPCBLayer (int aDefaultLayer, int aCopperLayerCount, const wxString &aGerberName)
	Show the dialog box for layer selection. More...

COLOR4D	GetGridColor () override

virtual void	SetGridColor (const COLOR4D &aColor) override

const BOX2I	GetDocumentExtents (bool aIncludeAllVisible=true) const override
	Returns bbox of document with option to not include some items. More...

bool	LockFile (const wxString &aFileName)
	Mark a schematic file as being in use. More...

void	ReleaseFile ()
	Release the current file marked in use. More...

void	ScriptingConsoleEnableDisable ()
	Toggles the scripting console visibility. More...

bool	IsScriptingConsoleVisible ()
	Gets the current visibility of the scripting console window. More...

EDA_SEARCH_DATA &	GetFindReplaceData ()

wxArrayString &	GetFindHistoryList ()

bool	GetShowPolarCoords () const
	For those frames that support polar coordinates. More...

void	SetShowPolarCoords (bool aShow)

void	ToggleUserUnits () override

void	GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
	Get the pair or units in current use. More...

VECTOR2I	GetNearestGridPosition (const VECTOR2I &aPosition) const
	Return the nearest aGridSize location to aPosition. More...

VECTOR2I	GetNearestHalfGridPosition (const VECTOR2I &aPosition) const
	Return the nearest aGridSize / 2 location to aPosition. More...

virtual COLOR4D	GetDrawBgColor () const

virtual void	SetDrawBgColor (const COLOR4D &aColor)

bool	LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)

virtual wxString	GetScreenDesc () const

virtual BASE_SCREEN *	GetScreen () const
	Return a pointer to a BASE_SCREEN or one of its derivatives. More...

void	EraseMsgBox ()

bool	IsGridVisible () const

void	OnSelectGrid (wxCommandEvent &event)
	Command event handler for selecting grid sizes. More...

void	OnGridSettings (wxCommandEvent &event)

void	UpdateGridSelectBox ()
	Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.). More...

void	OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
	Update the checked item in the grid wxchoice. More...

void	OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
	Update the checked item in the zoom wxchoice. More...

void	UpdateZoomSelectBox ()
	Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...

const wxString	GetZoomLevelIndicator () const
	Return a human readable value for display in dialogs. More...

virtual void	OnSelectZoom (wxCommandEvent &event)
	Set the zoom factor when selected by the zoom list box in the main tool bar. More...

virtual void	OnSize (wxSizeEvent &event) override
	Recalculate the size of toolbars and display panel when the frame size changes. More...

void	OnMove (wxMoveEvent &aEvent) override

virtual void	HardRedraw ()
	Rebuild the GAL and redraws the screen. More...

virtual void	Zoom_Automatique (bool aWarpPointer)
	Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...

void	FocusOnLocation (const VECTOR2I &aPos)
	Useful to focus on a particular location, in find functions. More...

void	AddStandardSubMenus (TOOL_MENU &aMenu)
	Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g. More...

void	PrintDrawingSheet (const RENDER_SETTINGS aSettings, BASE_SCREEN aScreen, const std::map< wxString, wxString > *aProperties, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
	Prints the drawing-sheet (frame and title block). More...

void	DisplayToolMsg (const wxString &msg) override

void	DisplayConstraintsMsg (const wxString &msg)

virtual void	OnPageSettingsChange ()
	Called when modifying the page settings. More...

void	DisplayUnitsMsg ()
	Display current unit pane in the status bar. More...

void	AppendMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
	Append a message to the message panel. More...

virtual void	ClearMsgPanel ()
	Clear all messages from the message panel. More...

void	SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
	Clear the message panel and populates it with the contents of aList. More...

void	SetMsgPanel (EDA_ITEM *aItem)

void	SetMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
	Helper function that erases the msg panel and then appends a single message. More...

virtual void	UpdateMsgPanel ()
	Redraw the message panel. More...

virtual EDA_ITEM *	GetItem (const KIID &aId) const
	Fetch an item by KIID. More...

virtual void	PrintPage (const RENDER_SETTINGS *aSettings)
	Print the page pointed by current screen, set by the calling print function. More...

virtual void	SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
	Changes the current rendering backend. More...

virtual EDA_DRAW_PANEL_GAL *	GetCanvas () 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_OPTIONS &	GetGalDisplayOptions ()
	Return a reference to the gal rendering options used by GAL for rendering. More...

void	RefreshCanvas () override

void	RecreateToolbars ()
	Rebuild all toolbars, and update the checked state of check tools. More...

virtual void	ParseArgs (wxCmdLineParser &aParser)
	Handle command-line arguments in a frame-specific way. More...

virtual bool	ShowModal (wxString aResult=nullptr, wxWindow aResultantFocusWindow=nullptr)
	Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...

virtual void	KiwayMailIn (KIWAY_EXPRESS &aEvent)
	Receive KIWAY_EXPRESS messages from other players. More...

bool	Destroy () override
	Our version of Destroy() which is virtual from wxWidgets. More...

bool	IsModal () const override
	Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame. More...

void	SetModal (bool aIsModal)

bool	IsDismissed ()

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

void	CreateServer (int service, bool local=true)

void	OnSockRequest (wxSocketEvent &evt)

void	OnSockRequestServer (wxSocketEvent &evt)

virtual void	ExecuteRemoteCommand (const char *cmdline)
	Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242). More...

void	ChangeUserUnits (EDA_UNITS aUnits)

virtual ORIGIN_TRANSFORMS &	GetOriginTransforms ()
	Return a reference to the default ORIGIN_TRANSFORMS object. More...

SETTINGS_MANAGER *	GetSettingsManager () const

virtual SEVERITY	GetSeverity (int aErrorCode) const

bool	ProcessEvent (wxEvent &aEvent) override
	Override the default process event handler to implement the auto save feature. More...

virtual void	OnCharHook (wxKeyEvent &aKeyEvent)
	Capture the key event before it is sent to the GUI. More...

void	OnMenuEvent (wxMenuEvent &event)
	The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...

virtual void	RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
	Register a UI update handler for the control with ID `aID`. More...

virtual void	RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
	Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...

virtual void	UnregisterUIUpdateHandler (int aID) override
	Unregister a UI handler for a given ID that was registered using `RegisterUIUpdateHandler`. More...

virtual void	UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
	Unregister a UI handler for an action that was registered using `RegisterUIUpdateHandler`. More...

void	OnMaximize (wxMaximizeEvent &aEvent)

int	GetAutoSaveInterval () const

bool	IsType (FRAME_T aType) const

FRAME_T	GetFrameType () const

virtual const SEARCH_STACK &	sys_search ()
	Return a SEARCH_STACK pertaining to entire program. More...

virtual wxString	help_name ()

void	OnKicadAbout (wxCommandEvent &event)

void	OnPreferences (wxCommandEvent &event)
	Displays the preferences and settings of all opened editors paged dialog. More...

void	PrintMsg (const wxString &text)

void	CreateInfoBar ()

void	FinishAUIInitialization ()

WX_INFOBAR *	GetInfoBar ()

void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...

void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...

void	ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...

void	ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...

virtual APP_SETTINGS_BASE *	config () const
	Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...

void	LoadWindowState (const wxString &aFileName)

virtual void	LoadWindowState (const WINDOW_STATE &aState)
	Load frame state info from a configuration file. More...

void	LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
	Load window settings from the given settings object. More...

void	SaveWindowSettings (WINDOW_SETTINGS *aCfg)
	Save window settings to the given settings object. More...

virtual WINDOW_SETTINGS *	GetWindowSettings (APP_SETTINGS_BASE *aCfg)
	Return a pointer to the window settings for this frame. More...

wxString	ConfigBaseName () override
	Get the configuration base name. More...

virtual void	SaveProjectSettings ()
	Save changes to the project settings to the project (.pro) file. More...

void	ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
	Prompt the user for a hotkey file to read, and read it. More...

wxString	GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
	Fetches the file name from the file history list. More...

void	ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
	Removes all files from the file history. More...

void	UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
	Update the list of recently opened files. More...

FILE_HISTORY &	GetFileHistory ()
	Get the frame's main file history. More...

void	SetMruPath (const wxString &aPath)

wxString	GetMruPath () const

virtual wxString	GetCurrentFileName () const
	Get the full filename + path of the currently opened file in the frame. More...

void	AddStandardHelpMenu (wxMenuBar *aMenuBar)
	Adds the standard KiCad help menu to the menubar. More...

bool	IsWritable (const wxFileName &aFileName, bool aVerbose=true)
	Checks if aFileName can be written. More...

virtual void	CheckForAutoSaveFile (const wxFileName &aFileName)
	Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...

virtual void	ThemeChanged ()
	Process light/dark theme change. More...

virtual void	ProjectChanged ()
	Notification event that the project has changed. More...

const wxString &	GetAboutTitle () const

virtual bool	IsContentModified () const
	Get if the contents of the frame have been modified since the last save. More...

wxSize	GetWindowSize ()
	Get the undecorated window size that can be used for restoring the window size. More...

virtual void	ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)
	Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. More...

virtual void	ClearUndoRedoList ()
	Clear the undo and redo list using ClearUndoORRedoList() More...

virtual void	PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
	Add a command to undo in the undo list. More...

virtual void	PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
	Add a command to redo in the redo list. More...

virtual PICKED_ITEMS_LIST *	PopCommandFromUndoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...

virtual PICKED_ITEMS_LIST *	PopCommandFromRedoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...

virtual int	GetUndoCommandCount () const

virtual int	GetRedoCommandCount () const

int	GetMaxUndoItems () const

bool	NonUserClose (bool aForce)

virtual void	HandleSystemColorChange ()
	Update the UI in response to a change in the system colors. More...

TOOL_MANAGER *	GetToolManager () const
	Return the MVC controller. More...

virtual void	PushTool (const TOOL_EVENT &aEvent)
	NB: the definition of "tool" is different at the user level. More...

virtual void	PopTool (const TOOL_EVENT &aEvent)
	Pops a tool from the stack. More...

bool	ToolStackIsEmpty ()

std::string	CurrentToolName () const

bool	IsCurrentTool (const TOOL_ACTION &aAction) const

bool	GetDoImmediateActions () const
	Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...

MOUSE_DRAG_ACTION	GetDragAction () const
	Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...

bool	GetMoveWarpsCursor () const
	Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...

HOLDER_TYPE	GetType () const

KIWAY &	Kiway () const
	Return a reference to the KIWAY that this object has an opportunity to participate in. More...

bool	HasKiway () const
	Safety check before asking for the Kiway reference. More...

PROJECT &	Prj () const
	Return a reference to the PROJECT associated with this KIWAY. More...

void	SetKiway (wxWindow aDest, KIWAY aKiway)
	It is only used for debugging, since "this" is not a wxWindow*. More...

EDA_UNITS	GetUserUnits () const

void	SetUserUnits (EDA_UNITS aUnits)

const EDA_IU_SCALE &	GetIuScale () const

wxString	StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Converts aValue in internal units into a united string. More...

wxString	StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false)

wxString	MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	A lower-precision version of StringFromValue(). More...

wxString	MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true)

long long int	ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Converts aTextValue in aUnits to internal units used by the frame. More...

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

Public Attributes
wxChoice *	m_SelComponentBox

wxChoice *	m_SelNetnameBox

wxChoice *	m_SelAperAttributesBox

GBR_LAYER_BOX_SELECTOR *	m_SelLayerBox

DCODE_SELECTION_BOX *	m_DCodeSelector

wxTextCtrl *	m_TextInfo

GERBER_LAYER_WIDGET *	m_LayersManager

Protected Member Functions
void	setupUIConditions () override
	Setup the UI conditions for the various actions and their controls in this frame. More...

virtual void	SetScreen (BASE_SCREEN *aScreen)

void	setupUnits (APP_SETTINGS_BASE *aCfg)

std::vector< wxWindow * >	findDialogs ()

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

EDA_DRAW_PANEL_GAL::GAL_TYPE	loadCanvasTypeSetting ()
	Returns the canvas type stored in the application settings. More...

bool	saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
	Stores the canvas type in the application settings. More...

virtual void	handleActivateEvent (wxActivateEvent &aEvent)
	Handle a window activation event. More...

void	onActivate (wxActivateEvent &aEvent)

void	kiway_express (KIWAY_EXPRESS &aEvent)
	event handler, routes to derivative specific virtual KiwayMailIn() More...

void	language_change (wxCommandEvent &event)
	An event handler called on a language menu selection. More...

void	onAutoSaveTimer (wxTimerEvent &aEvent)
	Handle the auto save timer event. More...

virtual void	handleIconizeEvent (wxIconizeEvent &aEvent)
	Handle a window iconize event. More...

void	onIconize (wxIconizeEvent &aEvent)

virtual bool	isAutoSaveRequired () const
	Return the auto save status of the application. More...

virtual bool	doAutoSave ()
	This should be overridden by the derived class to handle the auto save feature. More...

virtual bool	canCloseWindow (wxCloseEvent &aCloseEvent)

void	onSystemColorChange (wxSysColourChangedEvent &aEvent)

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

void	ensureWindowIsOnScreen ()

virtual void	OnDropFiles (wxDropFilesEvent &aEvent)
	Handles event fired when a file is dropped to the window. More...

Static Protected Member Functions
static wxString	GetAutoSaveFilePrefix ()

Protected Attributes
FILE_HISTORY	m_zipFileHistory

FILE_HISTORY	m_drillFileHistory

FILE_HISTORY	m_jobFileHistory

wxString	m_lastFileName

wxSocketServer *	m_socketServer

std::vector< wxSocketBase * >	m_sockets
	interprocess communication More...

std::unique_ptr< wxSingleInstanceChecker >	m_file_checker

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_TOOLBAR *	m_mainToolBar

ACTION_TOOLBAR *	m_auxiliaryToolBar

ACTION_TOOLBAR *	m_drawToolBar

ACTION_TOOLBAR *	m_optionsToolBar

std::unique_ptr< EDA_SEARCH_DATA >	m_findReplaceData

wxArrayString	m_findStringHistoryList

wxArrayString	m_replaceStringHistoryList

EDA_MSG_PANEL *	m_messagePanel

int	m_msgFrameHeight

COLOR_SETTINGS *	m_colorSettings

SEARCH_PANE *	m_searchPane
	The current canvas type. More...

EDA_DRAW_PANEL_GAL::GAL_TYPE	m_canvasType

bool	m_modal

WX_EVENT_LOOP *	m_modal_loop
	< Points to nested event_loop. NULL means not modal and dismissed. More...

wxWindow *	m_modal_resultant_parent

wxString	m_modal_string

bool	m_modal_ret_val

std::vector< wxFileName >	m_AcceptedFiles

FRAME_T	m_ident

wxPoint	m_framePos

wxSize	m_frameSize

bool	m_maximizeByDefault

int	m_displayIndex

wxPoint	m_normalFramePos

wxSize	m_normalFrameSize

wxString	m_aboutTitle

wxAuiManager	m_auimgr

wxString	m_perspective

WX_INFOBAR *	m_infoBar

wxString	m_configName

SETTINGS_MANAGER *	m_settingsManager

FILE_HISTORY *	m_fileHistory

bool	m_supportsAutoSave

bool	m_autoSaveState

wxTimer *	m_autoSaveTimer

UNDO_REDO_CONTAINER	m_undoList

UNDO_REDO_CONTAINER	m_redoList

wxString	m_mruPath

ORIGIN_TRANSFORMS	m_originTransforms

std::map< int, UIUpdateHandler >	m_uiUpdateMap
	< Map containing the UI update handlers registered with wx for each action. More...

bool	m_isClosing
	Set by NonUserClose() to indicate that the user did not request the current close. More...

bool	m_isNonUserClose

std::map< const wxString, TOOL_ACTION * >	m_acceptedExts
	Associates files extensions with action to execute. More...

TOOL_MANAGER *	m_toolManager

ACTIONS *	m_actions

TOOL_DISPATCHER *	m_toolDispatcher

SELECTION	m_dummySelection

std::vector< std::string >	m_toolStack

bool	m_immediateActions

MOUSE_DRAG_ACTION	m_dragAction

bool	m_moveWarpsCursor

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

Private Member Functions
void	updateComponentListSelectBox ()

void	updateNetnameListSelectBox ()

void	updateAperAttributesSelectBox ()

void	updateDCodeSelectBox ()

void	unitsChangeRefresh () override
	Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...

void	OnClearJobFileHistory (wxCommandEvent &aEvent)

void	OnClearZipFileHistory (wxCommandEvent &aEvent)

void	OnClearDrlFileHistory (wxCommandEvent &aEvent)

void	OnClearGbrFileHistory (wxCommandEvent &aEvent)

void	DoWithAcceptedFiles () override
	Execute action on accepted dropped file. More...

bool	LoadFileOrShowDialog (const wxString &aFileName, const wxString &dialogFiletypes, const wxString &dialogTitle, const int filetype)
	Loads the file provided or shows a dialog to get the file(s) from the user. More...

void	setupTools ()

void	windowClosing (wxCloseEvent &event)
	(with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings(). More...

void	commonInit (FRAME_T aFrameType)
	Collect common initialization functions used in all CTORs. More...

wxWindow *	findQuasiModalDialog ()

Private Attributes
int	m_displayMode

bool	m_show_layer_manager_tools

GBR_LAYOUT *	m_gerberLayout

int	m_activeLayer

VECTOR2I	m_grid_origin

PAGE_INFO	m_paper

wxStaticText *	m_cmpText

wxStaticText *	m_netText

wxStaticText *	m_apertText

wxStaticText *	m_dcodeText

BASE_SCREEN *	m_currentScreen
	current used SCREEN More...

EDA_DRAW_PANEL_GAL *	m_canvas
	This the frame's interface to setting GAL display options. More...

KIGFX::GAL_DISPLAY_OPTIONS	m_galDisplayOptions

KIWAY *	m_kiway

HOLDER_TYPE	m_type

const EDA_IU_SCALE &	m_iuScale

EDA_UNITS	m_userUnits

Detailed Description

Definition at line 54 of file gerbview_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

39{ DIALOG, FRAME, PANEL };

KIWAY_HOLDER::PANEL

@ PANEL

Definition: kiway_holder.h:39

KIWAY_HOLDER::DIALOG

@ DIALOG

Definition: kiway_holder.h:39

KIWAY_HOLDER::FRAME

@ FRAME

Definition: kiway_holder.h:39

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

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

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 111 of file eda_base_frame.h.

 {
 UNDO_LIST,
 REDO_LIST
 };

Constructor & Destructor Documentation

◆ GERBVIEW_FRAME()

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

Definition at line 59 of file gerbview_frame.cpp.

 : EDA_DRAW_FRAME( aKiway, aParent, FRAME_GERBER, wxT( "GerbView" ), wxDefaultPosition,
 wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE, GERBVIEW_FRAME_NAME,
 gerbIUScale ),
 m_TextInfo( nullptr ),
 m_zipFileHistory( DEFAULT_FILE_HISTORY_SIZE, ID_GERBVIEW_ZIP_FILE1,
 ID_GERBVIEW_ZIP_FILE_LIST_CLEAR, _( "Clear Recent Zip Files" ) ),
 m_drillFileHistory( DEFAULT_FILE_HISTORY_SIZE, ID_GERBVIEW_DRILL_FILE1,
 ID_GERBVIEW_DRILL_FILE_LIST_CLEAR, _( "Clear Recent Drill Files" ) ),
 m_jobFileHistory( DEFAULT_FILE_HISTORY_SIZE, ID_GERBVIEW_JOB_FILE1,
 ID_GERBVIEW_JOB_FILE_LIST_CLEAR, _( "Clear Recent Job Files" ) ),
 m_activeLayer( 0 )
{
 m_maximizeByDefault = true;
 m_gerberLayout = nullptr;
 m_show_layer_manager_tools = true;
 m_showBorderAndTitleBlock = false; // true for reference drawings.
 m_SelLayerBox = nullptr;
 m_DCodeSelector = nullptr;
 m_SelComponentBox = nullptr;
 m_SelNetnameBox = nullptr;
 m_SelAperAttributesBox = nullptr;
 m_cmpText = nullptr;
 m_netText = nullptr;
 m_apertText = nullptr;
 m_dcodeText = nullptr;
 m_displayMode = 0;
 m_aboutTitle = _( "KiCad Gerber Viewer" );
 
 SHAPE_POLY_SET dummy; // A ugly trick to force the linker to include
 // some methods in code and avoid link errors
 
 int fileHistorySize = Pgm().GetCommonSettings()->m_System.file_history_size;
 m_drillFileHistory.SetMaxFiles( fileHistorySize );
 m_zipFileHistory.SetMaxFiles( fileHistorySize );
 m_jobFileHistory.SetMaxFiles( fileHistorySize );
 
 auto* galCanvas = new GERBVIEW_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
 GetGalDisplayOptions(),
 EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE );
 
 SetCanvas( galCanvas );
 
 // GerbView requires draw priority for rendering negative objects
 galCanvas->GetView()->UseDrawPriority( true );
 
 // Give an icon
 wxIcon icon;
 wxIconBundle icon_bundle;
 
 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview ) );
 icon_bundle.AddIcon( icon );
 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview_32 ) );
 icon_bundle.AddIcon( icon );
 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_gerbview_16 ) );
 icon_bundle.AddIcon( icon );
 
 SetIcons( icon_bundle );
 
 // Be sure a page info is set. this default value will be overwritten later.
 PAGE_INFO pageInfo( wxT( "GERBER" ) );
 SetLayout( new GBR_LAYOUT() );
 SetPageSettings( pageInfo );
 
 SetVisibleLayers( LSET::AllLayersMask() ); // All draw layers visible.
 
 SetScreen( new BASE_SCREEN( GetPageSettings().GetSizeIU( gerbIUScale.IU_PER_MILS ) ) );
 
 // Create the PCB_LAYER_WIDGET *after* SetLayout():
 m_LayersManager = new GERBER_LAYER_WIDGET( this, GetCanvas() );
 
 // Update the minimum string length in the layer panel with the length of the last default layer
 wxString lyrName = GetImagesList()->GetDisplayName( GetImagesList()->ImagesMaxCount(),
 false, true );
 m_LayersManager->SetSmallestLayerString( lyrName );
 
 // LoadSettings() *after* creating m_LayersManager, because LoadSettings()
 // initialize parameters in m_LayersManager
 LoadSettings( config() );
 
 setupTools();
 setupUIConditions();
 ReCreateMenuBar();
 ReCreateHToolbar();
 ReCreateOptToolbar();
 ReCreateAuxiliaryToolbar();
 
 m_auimgr.SetManagedWindow( this );
 
 m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer( 6 ) );
 m_auimgr.AddPane( m_auxiliaryToolBar, EDA_PANE().HToolbar().Name( "AuxToolbar" ).Top()
 .Layer(4) );
 m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom()
 .Layer( 6 ) );
 m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" ).Left()
 .Layer( 3 ) );
 m_auimgr.AddPane( m_LayersManager, EDA_PANE().Palette().Name( "LayersManager" ).Right()
 .Layer( 3 ).Caption( _( "Layers Manager" ) ).PaneBorder( false )
 .MinSize( 80, -1 ).BestSize( m_LayersManager->GetBestSize() ) );
 
 m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
 
 ReFillLayerWidget(); // this is near end because contents establish size
 m_auimgr.Update();
 
 SetActiveLayer( 0, true );
 GetToolManager()->RunAction( ACTIONS::zoomFitScreen, false );
 
 resolveCanvasType();
 
 SwitchCanvas( m_canvasType );
 
 setupUnits( config() );
 
 // Enable the axes to match legacy draw style
 auto& galOptions = GetGalDisplayOptions();
 galOptions.m_axesEnabled = true;
 galOptions.NotifyChanged();
 
 m_LayersManager->ReFill();
 m_LayersManager->ReFillRender(); // Update colors in Render after the config is read
 
 // Drag and drop
 m_acceptedExts.emplace( ArchiveFileExtension, &GERBVIEW_ACTIONS::loadZipFile );
 for( const auto& ext : GerberFileExtensions )
 m_acceptedExts.emplace( ext, &GERBVIEW_ACTIONS::loadGerbFiles );
 m_acceptedExts.emplace( DrillFileExtension, &GERBVIEW_ACTIONS::loadGerbFiles );
 DragAcceptFiles( true );
 
 GetToolManager()->RunAction( ACTIONS::zoomFitScreen, true );
 
 // Ensure the window is on top
 Raise();
 
 // Register a call to update the toolbar sizes. It can't be done immediately because
 // it seems to require some sizes calculated that aren't yet (at least on GTK).
 CallAfter( [&]()
 {
 // Ensure the controls on the toolbars all are correctly sized
 UpdateToolbarControlSizes();
 } );
}

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

◆ ~GERBVIEW_FRAME()

GERBVIEW_FRAME::~GERBVIEW_FRAME ( )

Definition at line 203 of file gerbview_frame.cpp.

{
 // Ensure m_canvasType is up to date, to save it in config
 m_canvasType = GetCanvas()->GetBackend();
 
 // Shutdown all running tools
 if( m_toolManager )
 m_toolManager->ShutdownAllTools();
 
 GetCanvas()->GetView()->Clear();
 
 GetGerberLayout()->GetImagesList()->DeleteAllImages();
 delete m_gerberLayout;
}

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

Member Function Documentation

◆ ActivateGalCanvas()

void GERBVIEW_FRAME::ActivateGalCanvas ( )

overridevirtual

Use to start up the GAL drawing canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 970 of file gerbview_frame.cpp.

{
 EDA_DRAW_FRAME::ActivateGalCanvas();
 
 EDA_DRAW_PANEL_GAL* galCanvas = GetCanvas();
 
 if( m_toolManager )
 {
 m_toolManager->SetEnvironment( m_gerberLayout, GetCanvas()->GetView(),
 GetCanvas()->GetViewControls(), config(), this );
 m_toolManager->ResetTools( TOOL_BASE::GAL_SWITCH );
 }
 
 galCanvas->GetGAL()->SetGridColor( GetLayerColor( LAYER_GERBVIEW_GRID ) );
 
 SetPageSettings( GetPageSettings() );
 
 galCanvas->GetView()->RecacheAllItems();
 galCanvas->SetEventDispatcher( m_toolDispatcher );
 galCanvas->StartDrawing();
 
 m_LayersManager->ReFill();
 m_LayersManager->ReFillRender();
 
 ReCreateOptToolbar();
 ReCreateMenuBar();
}

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

{
 COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
 ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
 
 helpMenu->Add( ACTIONS::help );
 helpMenu->Add( ACTIONS::gettingStarted );
 helpMenu->Add( ACTIONS::listHotKeys );
 helpMenu->Add( ACTIONS::getInvolved );
 helpMenu->Add( ACTIONS::donate );
 helpMenu->Add( ACTIONS::reportBug );
 
 helpMenu->AppendSeparator();
 helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
 
 // Trailing space keeps OSX from hijacking our menu (and disabling everything in it).
 aMenuBar->Append( helpMenu, _( "&Help" ) + wxS( " " ) );
}

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU & aMenu )

inherited

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

zoom and grid).

Definition at line 546 of file eda_draw_frame.cpp.

{
 COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
 CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
 
 aMenu.AddSeparator( 1000 );
 
 std::shared_ptr<ZOOM_MENU> zoomMenu = std::make_shared<ZOOM_MENU>( this );
 zoomMenu->SetTool( commonTools );
 aToolMenu.RegisterSubMenu( zoomMenu );
 
 std::shared_ptr<GRID_MENU> gridMenu = std::make_shared<GRID_MENU>( this );
 gridMenu->SetTool( commonTools );
 aToolMenu.RegisterSubMenu( gridMenu );
 
 aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
 aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
}

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

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

◆ AppendMsgPanel()

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

inherited

Append a message to the message panel.

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

Parameters

aTextUpper	The message upper text.
aTextLower	The message lower text.
aPadding	Number of spaces to pad between messages.

Definition at line 708 of file eda_draw_frame.cpp.

{
 if( m_messagePanel )
 m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
}

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

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

◆ ApplyDisplaySettingsToGAL()

void GERBVIEW_FRAME::ApplyDisplaySettingsToGAL ( )

Updates the GAL with display settings changes.

Definition at line 479 of file gerbview_frame.cpp.

{
 auto painter = static_cast<KIGFX::GERBVIEW_PAINTER*>( GetCanvas()->GetView()->GetPainter() );
 KIGFX::GERBVIEW_RENDER_SETTINGS* settings = painter->GetSettings();
 settings->SetHighContrast( gvconfig()->m_Display.m_HighContrastMode );
 settings->LoadColors( GetColorSettings() );
 
 GetCanvas()->GetView()->MarkTargetDirty( KIGFX::TARGET_NONCACHED );
}

References EDA_DRAW_FRAME::GetCanvas(), GetColorSettings(), KIGFX::VIEW::GetPainter(), EDA_DRAW_PANEL_GAL::GetView(), gvconfig(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), GERBVIEW_SETTINGS::m_Display, GBR_DISPLAY_OPTIONS::m_HighContrastMode, KIGFX::VIEW::MarkTargetDirty(), KIGFX::RENDER_SETTINGS::SetHighContrast(), and KIGFX::TARGET_NONCACHED.

Referenced by GERBVIEW_CONTROL::DisplayControl(), SetElementVisibility(), and SetLayerColor().

◆ canCloseWindow()

virtual bool EDA_BASE_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

inlineprotectedvirtualinherited

Reimplemented in CVPCB_MAINFRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PCB_BASE_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, PCB_EDIT_FRAME, SIM_PLOT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 618 of file eda_base_frame.h.

618{ return true; }

Referenced by EDA_BASE_FRAME::windowClosing().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1303 of file eda_base_frame.cpp.

{
 SetUserUnits( aUnits );
 unitsChangeRefresh();
 
 wxCommandEvent e( UNITS_CHANGED );
 ProcessEventLocally( e );
}

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

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

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName & aFileName )

virtualinherited

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

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

Parameters

aFileName A wxFileName object containing the file name to check.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1191 of file eda_base_frame.cpp.

{
 wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
 
 wxFileName autoSaveFileName = aFileName;
 
 // Check for auto save file.
 autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
 
 wxLogTrace( traceAutoSave,
 wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
 
 if( !autoSaveFileName.FileExists() )
 return;
 
 wxString msg = wxString::Format( _(
 "Well this is potentially embarrassing!\n"
 "It appears that the last time you were editing the file\n"
 "%s\n"
 "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
 aFileName.GetFullName()
 );
 
 int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
 this );
 
 // Make a backup of the current file, delete the file, and rename the auto save file to
 // the file name.
 if( response == wxYES )
 {
 if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
 {
 wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
 Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
 }
 }
 else
 {
 wxLogTrace( traceAutoSave,
 wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
 
 // Remove the auto save file when using the previous file as is.
 wxRemoveFile( autoSaveFileName.GetFullPath() );
 }
}

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ Clear_DrawLayers()

bool GERBVIEW_FRAME::Clear_DrawLayers ( bool query )

Definition at line 40 of file clear_gbr_drawlayers.cpp.

{
 if( GetGerberLayout() == nullptr )
 return false;
 
 if( query && GetScreen()->IsContentModified() )
 {
 if( !IsOK( this, _( "Current data will be lost?" ) ) )
 return false;
 }
 
 if( GetCanvas() )
 {
 if( m_toolManager )
 m_toolManager->ResetTools( TOOL_BASE::MODEL_RELOAD );
 
 GetCanvas()->GetView()->Clear();
 
 // Reinit the drawing-sheet view, cleared by GetView()->Clear():
 SetPageSettings( GetPageSettings() );
 }
 
 GetImagesList()->DeleteAllImages();
 
 GetGerberLayout()->SetBoundingBox( BOX2I() );
 
 SetActiveLayer( 0 );
 ReFillLayerWidget();
 syncLayerBox();
 return true;
}

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

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

◆ ClearFileHistory()

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

inherited

Removes all files from the file history.

Parameters

aFileHistory The FILE_HISTORY in use. If null, the main application file history is used

Definition at line 948 of file eda_base_frame.cpp.

{
 if( !aFileHistory )
 aFileHistory = m_fileHistory;
 
 wxASSERT( aFileHistory );
 
 aFileHistory->ClearFileHistory();
 
 // Update the menubar to update the file history menu
 if( GetMenuBar() )
 {
 ReCreateMenuBar();
 GetMenuBar()->Refresh();
 }
}

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

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

◆ ClearMsgPanel()

void EDA_DRAW_FRAME::ClearMsgPanel ( )

virtualinherited

Clear all messages from the message panel.

Reimplemented in SYMBOL_EDIT_FRAME.

Definition at line 716 of file eda_draw_frame.cpp.

{
 if( m_messagePanel )
 m_messagePanel->EraseMsgBox();
}

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

Referenced by GERBVIEW_CONTROL::ClearAllLayers(), GERBVIEW_CONTROL::ClearLayer(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GENDRILL::GenDrillAndMapFiles(), LoadGerberJobFile(), DIALOG_BOM::OnRunGenerator(), GERBVIEW_CONTROL::ReloadAllLayers(), NETLIST_DIALOG::TransferDataFromWindow(), EE_INSPECTION_TOOL::UpdateMessagePanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo(), and UpdateTitleAndInfo().

◆ ClearUndoORRedoList()

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

inlinevirtualinherited

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

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

Parameters

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

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 528 of file eda_base_frame.h.

529 { }

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

◆ ClearUndoRedoList()

void EDA_BASE_FRAME::ClearUndoRedoList ( )

virtualinherited

Clear the undo and redo list using ClearUndoORRedoList()

Picked items are deleted by ClearUndoORRedoList() according to their status.

Definition at line 1254 of file eda_base_frame.cpp.

{
 ClearUndoORRedoList( UNDO_LIST );
 ClearUndoORRedoList( REDO_LIST );
}

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::REDO_LIST, and EDA_BASE_FRAME::UNDO_LIST.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_EDIT_FRAME::emptyScreen(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), PCB_EDIT_FRAME::ImportSpecctraSession(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SCH_EDIT_FRAME::OnImportProject(), PL_EDITOR_FRAME::OnNewDrawingSheet(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and EDA_BASE_FRAME::~EDA_BASE_FRAME().

◆ commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T aFrameType )

privateinherited

Collect common initialization functions used in all CTORs.

Definition at line 117 of file eda_base_frame.cpp.

{
 m_ident = aFrameType;
 m_maximizeByDefault = false;
 m_infoBar = nullptr;
 m_settingsManager = nullptr;
 m_fileHistory = nullptr;
 m_supportsAutoSave = false;
 m_autoSaveState = false;
 m_undoRedoCountMax = DEFAULT_MAX_UNDO_ITEMS;
 m_isClosing = false;
 m_isNonUserClose = false;
 m_autoSaveTimer = new wxTimer( this, ID_AUTO_SAVE_TIMER );
 m_mruPath = PATHS::GetDefaultUserProjectsPath();
 m_frameSize = defaultSize( aFrameType );
 m_displayIndex = -1;
 
 m_auimgr.SetArtProvider( new WX_AUI_DOCK_ART() );
 
 m_settingsManager = &Pgm().GetSettingsManager();
 
 // Set a reasonable minimal size for the frame
 SetSizeHints( minSize( aFrameType ).x, minSize( aFrameType ).y, -1, -1, -1, -1 );
 
 // Store dimensions of the user area of the main window.
 GetClientSize( &m_frameSize.x, &m_frameSize.y );
 
 Connect( ID_AUTO_SAVE_TIMER, wxEVT_TIMER,
 wxTimerEventHandler( EDA_BASE_FRAME::onAutoSaveTimer ) );
 
 // hook wxEVT_CLOSE_WINDOW so we can call SaveSettings(). This function seems
 // to be called before any other hook for wxCloseEvent, which is necessary.
 Connect( wxEVT_CLOSE_WINDOW, wxCloseEventHandler( EDA_BASE_FRAME::windowClosing ) );
 
 initExitKey();
}

References DEFAULT_MAX_UNDO_ITEMS, defaultSize(), PATHS::GetDefaultUserProjectsPath(), ID_AUTO_SAVE_TIMER, minSize(), EDA_BASE_FRAME::onAutoSaveTimer(), Pgm(), and EDA_BASE_FRAME::windowClosing().

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ CommonSettingsChanged()

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

overridevirtual

Called after the preferences dialog is run.

Reimplemented from TOOLS_HOLDER.

Definition at line 1115 of file gerbview_frame.cpp.

{
 EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
 
 SetPageSettings( PAGE_INFO( gvconfig()->m_Appearance.page_type ) );
 
 if( gvconfig()->m_Display.m_DiffMode )
 UpdateDiffLayers();
 
 SetElementVisibility( LAYER_DCODES, gvconfig()->m_Appearance.show_dcodes );
 
 GetCanvas()->GetView()->MarkTargetDirty( KIGFX::TARGET_NONCACHED );
 GetCanvas()->GetView()->UpdateAllItems( KIGFX::REPAINT );
 GetCanvas()->ForceRefresh();
 
 RecreateToolbars();
 ReFillLayerWidget(); // Update the layers list
 m_LayersManager->ReFillRender(); // Update colors in Render after the config is read
 
 Layout();
 SendSizeEvent();
}

References EDA_DRAW_FRAME::CommonSettingsChanged(), EDA_DRAW_PANEL_GAL::ForceRefresh(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), gvconfig(), LAYER_DCODES, m_LayersManager, KIGFX::VIEW::MarkTargetDirty(), EDA_DRAW_FRAME::RecreateToolbars(), ReFillLayerWidget(), GERBER_LAYER_WIDGET::ReFillRender(), KIGFX::REPAINT, SetElementVisibility(), SetPageSettings(), KIGFX::TARGET_NONCACHED, KIGFX::VIEW::UpdateAllItems(), and UpdateDiffLayers().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const

virtualinherited

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

Reimplemented in SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 788 of file eda_base_frame.cpp.

{
 // KICAD_MANAGER_FRAME overrides this
 return Kiface().KifaceSettings();
}

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

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

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )

inlineoverridevirtualinherited

Get the configuration base name.

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

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

Reimplemented from TOOLS_HOLDER.

Definition at line 341 of file eda_base_frame.h.

 {
 wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
 return baseCfgName;
 }

References EDA_BASE_FRAME::m_configName.

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 813 of file eda_base_frame.cpp.

{
#if defined( __WXOSX_MAC__ )
 m_infoBar = new WX_INFOBAR( GetToolCanvas() );
#else
 m_infoBar = new WX_INFOBAR( this, &m_auimgr );
 
 m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
#endif
}

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

◆ CreateServer()

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

inherited

Definition at line 43 of file eda_dde.cpp.

{
 wxIPV4address addr;
 
 // Set the port number
 addr.Service( service );
 
 // Listen on localhost only if requested
 if( local )
 addr.Hostname( HOSTNAME );
 
 if( m_socketServer )
 {
 // this helps prevent any events that could come in during deletion
 m_socketServer->Notify( false );
 delete m_socketServer;
 }
 
 m_socketServer = new wxSocketServer( addr );
 
 m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
 m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
 m_socketServer->Notify( true );
}

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

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

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 110 of file tools_holder.cpp.

{
 if( m_toolStack.empty() )
 return ACTIONS::selectionTool.GetName();
 else
 return m_toolStack.back();
}

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

Referenced by TOOLS_HOLDER::ShowChangedLanguage().

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

Our version of Destroy() which is virtual from wxWidgets.

Definition at line 170 of file kiway_player.cpp.

{
 return EDA_BASE_FRAME::Destroy();
}

Referenced by DISPLAY_FOOTPRINTS_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::doCloseWindow(), SYMBOL_VIEWER_FRAME::doCloseWindow(), doCloseWindow(), PL_EDITOR_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), PCB_BASE_FRAME::SelectFootprintFromLibBrowser(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ DismissModal()

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

inherited

Definition at line 182 of file kiway_player.cpp.

{
 m_modal_ret_val = aRetVal;
 m_modal_string = aResult;
 
 if( m_modal_loop )
 {
 m_modal_loop->Exit();
 m_modal_loop = nullptr; // this marks it as dismissed.
 }
 
 Show( false );
}

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

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

◆ DisplayConstraintsMsg()

void EDA_DRAW_FRAME::DisplayConstraintsMsg ( const wxString & msg )

inherited

Definition at line 572 of file eda_draw_frame.cpp.

{
 SetStatusText( msg, 7 );
}

Referenced by EDIT_TOOL::doMoveSelection(), and DRAWING_TOOL::UpdateStatusBar().

◆ DisplayGridMsg()

void GERBVIEW_FRAME::DisplayGridMsg ( )

overridevirtual

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 889 of file gerbview_frame.cpp.

{
 VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
 wxString line;
 
 line.Printf( wxT( "grid X %s Y %s" ),
 MessageTextFromValue( gridSize.x, false ),
 MessageTextFromValue( gridSize.y, false ) );
 
 SetStatusText( line, 4 );
 SetStatusText( line, 4 );
}

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

Referenced by UpdateStatusBar().

◆ DisplayToolMsg()

void EDA_DRAW_FRAME::DisplayToolMsg ( const wxString & msg )

overridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 566 of file eda_draw_frame.cpp.

{
 SetStatusText( msg, 6 );
}

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )

inherited

Display current unit pane in the status bar.

Definition at line 588 of file eda_draw_frame.cpp.

{
 wxString msg;
 
 switch( GetUserUnits() )
 {
 case EDA_UNITS::INCHES: msg = _( "inches" ); break;
 case EDA_UNITS::MILS: msg = _( "mils" ); break;
 case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
 default: msg = _( "Units" ); break;
 }
 
 SetStatusText( msg, 5 );
}

References _, UNITS_PROVIDER::GetUserUnits(), INCHES, MILLIMETRES, and MILS.

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )

protectedvirtualinherited

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

Returns: true if the auto save was successful otherwise false.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 310 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void GERBVIEW_FRAME::doCloseWindow ( )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 219 of file gerbview_frame.cpp.

{
 // No more vetos
 m_isClosing = true;
 GetCanvas()->StopDrawing();
 GetCanvas()->GetView()->Clear();
 
 if( m_toolManager )
 m_toolManager->DeactivateTool();
 
 // Be sure any OpenGL event cannot be fired after frame deletion:
 GetCanvas()->SetEvtHandlerEnabled( false );
 
 Destroy();
}

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

◆ DoWithAcceptedFiles()

void GERBVIEW_FRAME::DoWithAcceptedFiles ( )

overrideprivatevirtual

Execute action on accepted dropped file.

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

Reimplemented from EDA_BASE_FRAME.

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

{
 wxString gerbFn; // param to be sent with action event.
 
 for( const wxFileName& file : m_AcceptedFiles )
 {
 if( IsExtensionAccepted( file.GetExt(), { ArchiveFileExtension } ) )
 {
 wxString fn = file.GetFullPath();
 // Open zip archive in editor
 m_toolManager->RunAction( *m_acceptedExts.at( ArchiveFileExtension ), true, &fn );
 }
 else
 {
 // Store FileName in variable to open later
 gerbFn += '"' + file.GetFullPath() + '"';
 }
 }
 
 // Open files in editor
 if( !gerbFn.IsEmpty() )
 m_toolManager->RunAction( *m_acceptedExts.at( DrillFileExtension ), true, &gerbFn );
}

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

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 640 of file eda_base_frame.cpp.

{
 wxDisplay display( wxDisplay::GetFromWindow( this ) );
 wxRect clientSize = display.GetClientArea();
 wxPoint pos = GetPosition();
 wxSize size = GetWindowSize();
 
 wxLogTrace( traceDisplayLocation,
 "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d", clientSize.x, clientSize.y,
 clientSize.width, clientSize.height );
 
 if( pos.y < clientSize.y )
 {
 wxLogTrace( traceDisplayLocation,
 "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d", pos.y,
 clientSize.y );
 pos.y = clientSize.y;
 }
 
 if( pos.x < clientSize.x )
 {
 wxLogTrace( traceDisplayLocation,
 "ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d", pos.x,
 clientSize.x );
 pos.x = clientSize.x;
 }
 
 if( pos.x + size.x - clientSize.x > clientSize.width )
 {
 int newWidth = clientSize.width - ( pos.x - clientSize.x );
 wxLogTrace( traceDisplayLocation,
 "ensureWindowIsOnScreen: effective width %d above available %d, setting to %d",
 pos.x + size.x, clientSize.width, newWidth );
 size.x = newWidth;
 }
 
 if( pos.y + size.y - clientSize.y > clientSize.height )
 {
 int newHeight = clientSize.height - ( pos.y - clientSize.y );
 wxLogTrace( traceDisplayLocation,
 "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d",
 pos.y + size.y, clientSize.height, newHeight );
 size.y = newHeight;
 }
 
 wxLogTrace( traceDisplayLocation, "Updating window position (%d, %d) with size (%d, %d)",
 pos.x, pos.y, size.x, size.y );
 
 SetSize( pos.x, pos.y, size.x, size.y );
}

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ Erase_Current_DrawLayer()

void GERBVIEW_FRAME::Erase_Current_DrawLayer ( bool query )

Definition at line 73 of file clear_gbr_drawlayers.cpp.

{
 int layer = GetActiveLayer();
 wxString msg;
 
 msg.Printf( _( "Clear layer %d?" ), layer + 1 );
 
 if( query && !IsOK( this, msg ) )
 return;
 
 if( m_toolManager )
 m_toolManager->ResetTools( TOOL_BASE::MODEL_RELOAD );
 
 RemapLayers( GetImagesList()->RemoveImage( layer ) );
 
 ReFillLayerWidget();
 syncLayerBox();
 GetCanvas()->Refresh();
}

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

Referenced by GERBVIEW_CONTROL::ClearLayer(), GERBER_LAYER_WIDGET::onPopupSelection(), Read_EXCELLON_File(), and Read_GERBER_File().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )

inherited

Definition at line 328 of file eda_draw_frame.cpp.

{
 if( m_messagePanel )
 m_messagePanel->EraseMsgBox();
}

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

inlinevirtualinherited

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

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 196 of file kiway_player.h.

196{}

Referenced by KIWAY_PLAYER::OnSockRequest().

◆ findDialogs()

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

protectedinherited

Definition at line 898 of file eda_draw_frame.cpp.

{
 std::vector<wxWindow*> dialogs;
 
 for( wxWindow* window : GetChildren() )
 {
 if( dynamic_cast<DIALOG_SHIM*>( window ) )
 dialogs.push_back( window );
 }
 
 return dialogs;
}

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

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

privateinherited

Definition at line 168 of file eda_base_frame.cpp.

{
 for( wxWindow* iter : GetChildren() )
 {
 DIALOG_SHIM* dlg = dynamic_cast<DIALOG_SHIM*>( iter );
 
 if( dlg && dlg->IsQuasiModal() )
 return dlg;
 }
 
 // FIXME: CvPcb is currently implemented on top of KIWAY_PLAYER rather than DIALOG_SHIM,
 // so we have to look for it separately.
 if( m_ident == FRAME_SCH )
 {
 wxWindow* cvpcb = wxWindow::FindWindowByName( "CvpcbFrame" );
 
 if( cvpcb )
 return cvpcb;
 }
 
 return nullptr;
}

References FRAME_SCH, DIALOG_SHIM::IsQuasiModal(), and EDA_BASE_FRAME::m_ident.

Referenced by EDA_BASE_FRAME::ProcessEvent(), and EDA_BASE_FRAME::windowClosing().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 825 of file eda_base_frame.cpp.

{
#if defined( __WXOSX_MAC__ )
 m_auimgr.Update();
#else
 // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
 // hiding it.
 m_auimgr.Update();
 
 // We don't want the infobar displayed right away
 m_auimgr.GetPane( "InfoBar" ).Hide();
 m_auimgr.Update();
#endif
}

References EDA_BASE_FRAME::m_auimgr.

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const VECTOR2I & 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

aPos	is the point to go to.

Definition at line 912 of file eda_draw_frame.cpp.

{
 bool centerView = false;
 BOX2D r = GetCanvas()->GetView()->GetViewport();
 
 // Center if we're off the current view, or within 10% of its edge
 r.Inflate( - (int) r.GetWidth() / 10 );
 
 if( !r.Contains( aPos ) )
 centerView = true;
 
 std::vector<BOX2D> dialogScreenRects;
 
 for( wxWindow* dialog : findDialogs() )
 {
 dialogScreenRects.emplace_back( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
 dialog->GetSize() );
 }
 
 // Center if we're behind an obscuring dialog, or within 10% of its edge
 for( BOX2D rect : dialogScreenRects )
 {
 rect.Inflate( rect.GetWidth() / 10 );
 
 if( rect.Contains( GetCanvas()->GetView()->ToScreen( aPos ) ) )
 centerView = true;
 }
 
 if( centerView )
 {
 try
 {
 GetCanvas()->GetView()->SetCenter( aPos, dialogScreenRects );
 }
 catch( const ClipperLib::clipperException& exc )
 {
 wxLogError( wxT( "Clipper library error '%s' occurred centering object." ),
 exc.what() );
 }
 }
 
 GetCanvas()->GetViewControls()->SetCrossHairCursorPosition( aPos );
}

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

Referenced by PCB_SELECTION_TOOL::doSyncSelection(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindNext(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), DIALOG_DRC::OnDRCItemSelected(), and EE_SELECTION_TOOL::SyncSelection().

◆ GetAboutTitle()

const wxString & EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 497 of file eda_base_frame.h.

497{ return m_aboutTitle; }

References EDA_BASE_FRAME::m_aboutTitle.

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

◆ GetActiveLayer()

int GERBVIEW_FRAME::GetActiveLayer ( ) const

inline

Return the active layer.

Definition at line 180 of file gerbview_frame.h.

180{ return m_activeLayer; }

References m_activeLayer.

Referenced by Erase_Current_DrawLayer(), GERBVIEW_CONTROL::HighlightControl(), GERBVIEW_CONTROL::LayerNext(), GERBVIEW_CONTROL::LayerPrev(), LoadListOfGerberAndDrillFiles(), LoadZipArchiveFile(), GERBVIEW_CONTROL::MoveLayerDown(), GERBVIEW_CONTROL::MoveLayerUp(), GERBER_LAYER_WIDGET::OnLayerSelect(), GERBER_LAYER_WIDGET::onPopupSelection(), OnSelectActiveDCode(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), OnUpdateLayerSelectBox(), OnUpdateSelectDCode(), Read_EXCELLON_File(), Read_GERBER_File(), GERBVIEW_SELECTION_TOOL::selectable(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), GERBVIEW_INSPECTION_TOOL::ShowSource(), syncLayerBox(), syncLayerWidget(), unarchiveFiles(), updateDCodeSelectBox(), UpdateDiffLayers(), and UpdateTitleAndInfo().

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )

inlinestaticprotectedinherited

Returns: the string to prepend to a file name for automatic save.

Definition at line 585 of file eda_base_frame.h.

 {
 return wxT( "_autosave-" );
 }

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inherited

Definition at line 297 of file eda_base_frame.cpp.

{
 return Pgm().GetCommonSettings()->m_System.autosave_interval;
}

References Pgm().

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::onAutoSaveTimer(), and EDA_BASE_FRAME::ProcessEvent().

◆ GetCanvas()

virtual EDA_DRAW_PANEL_GAL * EDA_DRAW_FRAME::GetCanvas ( ) const

inlinevirtualinherited

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

Returns: Pointer to GAL-based canvas.

Reimplemented in SCH_BASE_FRAME, PCB_BASE_FRAME, and PL_EDITOR_FRAME.

Definition at line 415 of file eda_draw_frame.h.

415{ return m_canvas; }

EDA_DRAW_FRAME::m_canvas

EDA_DRAW_PANEL_GAL * m_canvas

This the frame's interface to setting GAL display options.

Definition: eda_draw_frame.h:526

References EDA_DRAW_FRAME::m_canvas.

◆ GetColorSettings()

COLOR_SETTINGS * GERBVIEW_FRAME::GetColorSettings ( bool aForceRefresh = false ) const

overridevirtual

Returns a pointer to the active color theme settings.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 383 of file gerbview_frame.cpp.

{
 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 GERBVIEW_SETTINGS* cfg = mgr.GetAppSettings<GERBVIEW_SETTINGS>();
 wxString currentTheme = cfg->m_ColorTheme;
 return mgr.GetColorSettings( currentTheme );
}

References SETTINGS_MANAGER::GetAppSettings(), SETTINGS_MANAGER::GetColorSettings(), APP_SETTINGS_BASE::m_ColorTheme, and Pgm().

Referenced by ApplyDisplaySettingsToGAL(), GetGridColor(), GetLayerColor(), GetVisibleElementColor(), GERBER_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), GERBVIEW_CONTROL::Print(), SetGridColor(), SetLayerColor(), and SetVisibleElementColor().

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const

inlinevirtualinherited

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

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

Returns: the filename and full path to the open file

Reimplemented in SCH_EDIT_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, and PCB_EDIT_FRAME.

Definition at line 422 of file eda_base_frame.h.

422{ 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 1139 of file gerbview_frame.cpp.

{
 return m_toolManager->GetTool<GERBVIEW_SELECTION_TOOL>()->GetSelection();
}

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

Referenced by GERBVIEW_INSPECTION_TOOL::MeasureTool().

◆ GetDisplayMode()

int GERBVIEW_FRAME::GetDisplayMode ( )

inline

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

Definition at line 104 of file gerbview_frame.h.

104{ return m_displayMode; }

References m_displayMode.

Referenced by OnUpdateDrawMode().

◆ GetDocumentExtents()

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

inlineoverridevirtual

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

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

Parameters

aIncludeAllVisible True to include everything visible in bbox calculations, false to ignore some visible items (program dependent).

Returns: Bounding box of the document (ignoring some items as requested).

Reimplemented from EDA_DRAW_FRAME.

Definition at line 467 of file gerbview_frame.h.

 {
 wxASSERT( m_gerberLayout );
 return m_gerberLayout->ViewBBox();
 }

References m_gerberLayout, and EDA_ITEM::ViewBBox().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const

inlineinherited

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

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

Definition at line 141 of file tools_holder.h.

141{ return m_immediateActions; }

TOOLS_HOLDER::m_immediateActions

bool m_immediateActions

Definition: tools_holder.h:183

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

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

Definition at line 147 of file tools_holder.h.

147{ return m_dragAction; }

TOOLS_HOLDER::m_dragAction

MOUSE_DRAG_ACTION m_dragAction

Definition: tools_holder.h:187

References TOOLS_HOLDER::m_dragAction.

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

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const

inlinevirtualinherited

Reimplemented in SCH_BASE_FRAME.

Definition at line 166 of file eda_draw_frame.h.

166{ return m_drawBgColor; }

EDA_DRAW_FRAME::m_drawBgColor

COLOR4D m_drawBgColor

Definition: eda_draw_frame.h:494

References EDA_DRAW_FRAME::m_drawBgColor.

Referenced by PLEDITOR_PRINTOUT::PrintPage(), PROPERTIES_FRAME::PROPERTIES_FRAME(), PL_EDITOR_FRAME::SaveSettings(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ GetFileFromHistory()

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

inherited

Fetches the file name from the file history list.

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

Parameters

cmdId	The command ID associated with the aFileHistory object.
type	Please document me!
aFileHistory	The FILE_HISTORY in use. If null, the main application file history is used

Returns: a wxString containing the selected filename

Definition at line 908 of file eda_base_frame.cpp.

{
 if( !aFileHistory )
 aFileHistory = m_fileHistory;
 
 wxASSERT( aFileHistory );
 
 int baseId = aFileHistory->GetBaseId();
 
 wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
 
 unsigned i = cmdId - baseId;
 
 if( i < aFileHistory->GetCount() )
 {
 wxString fn = aFileHistory->GetHistoryFile( i );
 
 if( wxFileName::FileExists( fn ) )
 {
 return fn;
 }
 else
 {
 DisplayErrorMessage( this, wxString::Format( _( "File '%s' was not found." ), fn ) );
 aFileHistory->RemoveFileFromHistory( i );
 }
 }
 
 // Update the menubar to update the file history menu
 if( GetMenuBar() )
 {
 ReCreateMenuBar();
 GetMenuBar()->Refresh();
 }
 
 return wxEmptyString;
}

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

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

◆ GetFileHistory()

FILE_HISTORY & EDA_BASE_FRAME::GetFileHistory ( )

inlineinherited

Get the frame's main file history.

Returns: the main file history

Definition at line 406 of file eda_base_frame.h.

 {
 return *m_fileHistory;
 }

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString & EDA_DRAW_FRAME::GetFindHistoryList ( )

inlineinherited

Definition at line 106 of file eda_draw_frame.h.

106{ return m_findStringHistoryList; }

EDA_DRAW_FRAME::m_findStringHistoryList

wxArrayString m_findStringHistoryList

Definition: eda_draw_frame.h:512

References EDA_DRAW_FRAME::m_findStringHistoryList.

Referenced by DIALOG_FIND::DIALOG_FIND(), DIALOG_FIND::search(), DIALOG_SCH_FIND::SetFindEntries(), and DIALOG_SCH_FIND::SetReplaceEntries().

◆ GetFindReplaceData()

EDA_SEARCH_DATA & EDA_DRAW_FRAME::GetFindReplaceData ( )

inlineinherited

Definition at line 105 of file eda_draw_frame.h.

105{ return *m_findReplaceData; }

EDA_DRAW_FRAME::m_findReplaceData

std::unique_ptr< EDA_SEARCH_DATA > m_findReplaceData

Definition: eda_draw_frame.h:511

References EDA_DRAW_FRAME::m_findReplaceData.

Referenced by SCH_EDITOR_CONTROL::FindNext(), SCH_EDITOR_CONTROL::HasMatch(), SCH_EDITOR_CONTROL::ReplaceAll(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), DIALOG_FIND::search(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 198 of file eda_base_frame.h.

198{ return m_ident; }

References EDA_BASE_FRAME::m_ident.

Referenced by PCB_BASE_FRAME::GetViewerSettingsBase(), and EDA_BASE_FRAME::OnPreferences().

◆ GetGalDisplayOptions()

KIGFX::GAL_DISPLAY_OPTIONS & EDA_DRAW_FRAME::GetGalDisplayOptions ( )

inlineinherited

Return a reference to the gal rendering options used by GAL for rendering.

Definition at line 423 of file eda_draw_frame.h.

423{ return m_galDisplayOptions; }

EDA_DRAW_FRAME::m_galDisplayOptions

KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions

Definition: eda_draw_frame.h:529

References EDA_DRAW_FRAME::m_galDisplayOptions.

Referenced by SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::createCanvas(), EDITOR_CONDITIONS::cursorFunc(), GERBVIEW_FRAME(), SYMBOL_VIEWER_FRAME::LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), DIALOG_PAD_PROPERTIES::prepareCanvas(), SYMBOL_EDIT_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), COMMON_TOOLS::ToggleCursor(), and COMMON_TOOLS::ToggleCursorStyle().

◆ GetGbrImage()

GERBER_FILE_IMAGE * GERBVIEW_FRAME::GetGbrImage ( int aIdx ) const

Definition at line 949 of file gerbview_frame.cpp.

{
 return m_gerberLayout->GetImagesList()->GetGbrImage( aIdx );
}

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

Referenced by getNextAvailableLayer(), GERBVIEW_CONTROL::HighlightControl(), OnSelectActiveDCode(), OnUpdateSelectDCode(), Read_GERBER_File(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), GERBVIEW_INSPECTION_TOOL::ShowSource(), syncLayerBox(), unarchiveFiles(), updateDCodeSelectBox(), and UpdateTitleAndInfo().

◆ GetGerberLayout()

GBR_LAYOUT * GERBVIEW_FRAME::GetGerberLayout ( ) const

inline

Definition at line 411 of file gerbview_frame.h.

 {
 wxASSERT( m_gerberLayout );
 return m_gerberLayout;
 }

References m_gerberLayout.

Referenced by Clear_DrawLayers(), DIALOG_PRINT_GERBVIEW::createPrintout(), GBR_TO_PCB_EXPORTER::ExportPcb(), GERBVIEW_CONTROL::ExportToPcbnew(), LAYERS_MAP_DIALOG::findNumAltiumGerbersLoaded(), LAYERS_MAP_DIALOG::findNumKiCadGerbersLoaded(), LAYERS_MAP_DIALOG::findNumX2GerbersLoaded(), LAYERS_MAP_DIALOG::initDialog(), LAYERS_MAP_DIALOG::OnSelectLayer(), Read_EXCELLON_File(), DIALOG_PRINT_GERBVIEW::TransferDataToWindow(), and ~GERBVIEW_FRAME().

◆ GetGridColor()

COLOR4D GERBVIEW_FRAME::GetGridColor ( )

overridevirtual

Returns: the color of the grid

Reimplemented from EDA_DRAW_FRAME.

Definition at line 875 of file gerbview_frame.cpp.

{
 return GetColorSettings()->GetColor( LAYER_GERBVIEW_GRID );
}

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

Referenced by GetVisibleElementColor().

◆ GetGridOrigin()

const VECTOR2I & GERBVIEW_FRAME::GetGridOrigin ( ) const

inlineoverridevirtual

Return the absolute coordinates of the origin of the snap grid.

This is treated as a relative offset and snapping will occur at multiples of the grid size relative to this point.

Implements EDA_DRAW_FRAME.

Definition at line 434 of file gerbview_frame.h.

434{ return m_grid_origin; }

GERBVIEW_FRAME::m_grid_origin

VECTOR2I m_grid_origin

Definition: gerbview_frame.h:547

References m_grid_origin.

◆ GetImagesList()

GERBER_FILE_IMAGE_LIST * GERBVIEW_FRAME::GetImagesList ( ) const

inline

Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data.

Definition at line 420 of file gerbview_frame.h.

 {
 return m_gerberLayout->GetImagesList();
 }

References GBR_LAYOUT::GetImagesList(), and m_gerberLayout.

Referenced by Clear_DrawLayers(), Erase_Current_DrawLayer(), GERBVIEW_FRAME(), LoadFileOrShowDialog(), Read_GERBER_File(), GERBVIEW_CONTROL::ReloadAllLayers(), SortLayersByFileExtension(), SortLayersByX2Attributes(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), updateAperAttributesSelectBox(), updateComponentListSelectBox(), and updateNetnameListSelectBox().

◆ GetInfoBar()

WX_INFOBAR * EDA_BASE_FRAME::GetInfoBar ( )

inlineinherited

Returns: the WX_INFOBAR that can be displayed on the top of the canvas.

Definition at line 225 of file eda_base_frame.h.

225{ return m_infoBar; }

References EDA_BASE_FRAME::m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), PCB_EDIT_FRAME::CommonSettingsChanged(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SCH_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), APPEARANCE_CONTROLS::onReadOnlySwatch(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), PAD_TOOL::Reset(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SYMBOL_EDIT_FRAME::SetCurSymbol(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), EDA_BASE_FRAME::ShowInfoBarWarning(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), PCB_CONTROL::unfilledZoneCheck(), and ZONE_FILLER_TOOL::ZoneFillDirty().

◆ GetItem()

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

inlinevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 391 of file eda_draw_frame.h.

391{ return nullptr; }

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

◆ GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 40 of file units_provider.h.

40{ return m_iuScale; }

UNITS_PROVIDER::m_iuScale

const EDA_IU_SCALE & m_iuScale

Definition: units_provider.h:104

References UNITS_PROVIDER::m_iuScale.

Referenced by GRID_MENU::BuildChoiceList(), UNITS_PROVIDER::MessageTextFromValue(), COMMON_TOOLS::Reset(), UNITS_PROVIDER::StringFromValue(), and UNITS_PROVIDER::ValueFromString().

◆ GetLayerColor()

COLOR4D GERBVIEW_FRAME::GetLayerColor ( int aLayer ) const

Definition at line 785 of file gerbview_frame.cpp.

{
 return GetColorSettings()->GetColor( aLayer );
}

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

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

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 565 of file eda_base_frame.h.

565{ return m_undoRedoCountMax; }

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

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

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

Definition at line 153 of file tools_holder.h.

153{ return m_moveWarpsCursor; }

TOOLS_HOLDER::m_moveWarpsCursor

bool m_moveWarpsCursor

Definition: tools_holder.h:189

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 413 of file eda_base_frame.h.

413{ return m_mruPath; }

References EDA_BASE_FRAME::m_mruPath.

Referenced by AskLoadBoardFileName(), PANEL_HOTKEYS_EDITOR::dumpHotkeys(), GERBVIEW_CONTROL::ExportToPcbnew(), PCB_EDIT_FRAME::Files_io_from_id(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), EDA_DRAW_FRAME::LibraryFileBrowser(), KICAD_MANAGER_CONTROL::NewProject(), KICAD_MANAGER_CONTROL::OpenProject(), SCH_EDIT_FRAME::SaveProject(), and KICAD_MANAGER_CONTROL::SaveProjectAs().

◆ GetNearestGridPosition()

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

inherited

Return the nearest aGridSize location to aPosition.

Parameters

aPosition The position to check.

Returns: The nearest grid position.

Definition at line 851 of file eda_draw_frame.cpp.

{
 const VECTOR2I& gridOrigin = GetGridOrigin();
 VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
 
 double xOffset = fmod( gridOrigin.x, gridSize.x );
 int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
 double yOffset = fmod( gridOrigin.y, gridSize.y );
 int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
 
 return VECTOR2I( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
}

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

Referenced by SCH_EDIT_TOOL::ChangeTextType(), and SCH_DRAWING_TOOLS::sizeSheet().

◆ GetNearestHalfGridPosition()

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

inherited

Return the nearest aGridSize / 2 location to aPosition.

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

Parameters

aPosition The position to check.

Returns: The nearest half-grid position.

Definition at line 865 of file eda_draw_frame.cpp.

{
 const VECTOR2I& gridOrigin = GetGridOrigin();
 VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize() / 2.0;
 
 double xOffset = fmod( gridOrigin.x, gridSize.x );
 int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
 double yOffset = fmod( gridOrigin.y, gridSize.y );
 int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
 
 return VECTOR2I( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
}

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

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

◆ getNextAvailableLayer()

int GERBVIEW_FRAME::getNextAvailableLayer ( ) const

Find the next empty layer.

If no empty layers are found, NO_AVAILABLE_LAYERS is return.

Returns: The first empty layer found or NO_AVAILABLE_LAYERS.

Definition at line 490 of file gerbview_frame.cpp.

{
 for( unsigned i = 0; i < ImagesMaxCount(); ++i )
 {
 const GERBER_FILE_IMAGE* gerber = GetGbrImage( i );
 
 if( gerber == nullptr ) // this graphic layer is available: use it
 return i;
 }
 
 return NO_AVAILABLE_LAYERS;
}

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

Referenced by LoadListOfGerberAndDrillFiles(), and unarchiveFiles().

◆ GetOriginTransforms()

virtual ORIGIN_TRANSFORMS & EDA_BASE_FRAME::GetOriginTransforms ( )

inlinevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented in PCB_BASE_FRAME.

Definition at line 130 of file eda_base_frame.h.

130{ return m_originTransforms; }

EDA_BASE_FRAME::m_originTransforms

ORIGIN_TRANSFORMS m_originTransforms

Definition: eda_base_frame.h:736

References EDA_BASE_FRAME::m_originTransforms.

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

◆ GetPageSettings()

const PAGE_INFO & GERBVIEW_FRAME::GetPageSettings ( ) const

overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 846 of file gerbview_frame.cpp.

{
 return m_paper;
}

References m_paper.

Referenced by ActivateGalCanvas(), Clear_DrawLayers(), GERBVIEW_FRAME(), GetPageSizeIU(), GERBVIEW_CONTROL::Print(), SaveSettings(), SetElementVisibility(), SetPageSettings(), and SetVisibleElementColor().

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

{
 // this function is only needed because EDA_DRAW_FRAME is not compiled
 // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
 // into an application specific source file.
 return GetPageSettings().GetSizeIU( gerbIUScale.IU_PER_MILS );
}

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

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 563 of file eda_base_frame.h.

563{ return m_redoList.m_CommandsList.size(); }

EDA_BASE_FRAME::m_redoList

UNDO_REDO_CONTAINER m_redoList

Definition: eda_base_frame.h:732

UNDO_REDO_CONTAINER::m_CommandsList

std::vector< PICKED_ITEMS_LIST * > m_CommandsList

Definition: undo_redo_container.h:308

References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_redoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), EDA_BASE_FRAME::PushCommandToRedoList(), SCH_EDITOR_CONTROL::Redo(), EDITOR_CONDITIONS::redoFunc(), and PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList().

◆ GetScreen()

virtual BASE_SCREEN * EDA_DRAW_FRAME::GetScreen ( ) const

inlinevirtualinherited

Return a pointer to a BASE_SCREEN or one of its derivatives.

It is overloaded by derived classes to return SCH_SCREEN or PCB_SCREEN.

Reimplemented in SCH_BASE_FRAME, SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 194 of file eda_draw_frame.h.

194{ return m_currentScreen; }

EDA_DRAW_FRAME::m_currentScreen

BASE_SCREEN * m_currentScreen

current used SCREEN

Definition: eda_draw_frame.h:525

References EDA_DRAW_FRAME::m_currentScreen.

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1016 of file eda_draw_frame.cpp.

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

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

◆ GetSettingsManager()

SETTINGS_MANAGER * EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

Definition at line 133 of file eda_base_frame.h.

133{ return m_settingsManager; }

References EDA_BASE_FRAME::m_settingsManager.

Referenced by KICAD_MANAGER_FRAME::canCloseWindow(), EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::CreateNewProject(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_BASE_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_PLOT_SCHEMATIC::getColorSettings(), GetSettingsManager(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), SCH_EDIT_FRAME::OnImportProject(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int aErrorCode ) const

inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 135 of file eda_base_frame.h.

135{ return RPT_SEVERITY_UNDEFINED; }

RPT_SEVERITY_UNDEFINED

@ RPT_SEVERITY_UNDEFINED

Definition: report_severity.h:27

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const

inlineinherited

For those frames that support polar coordinates.

Definition at line 120 of file eda_draw_frame.h.

120{ return m_polarCoords; }

EDA_DRAW_FRAME::m_polarCoords

bool m_polarCoords

Definition: eda_draw_frame.h:498

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

{
 wxASSERT( m_gerberLayout );
 return m_gerberLayout->GetTitleBlock();
}

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

418{ return GetCanvas(); }

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolManager()

TOOL_MANAGER * TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 54 of file tools_holder.h.

54{ return m_toolManager; }

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), SCH_NAVIGATE_TOOL::Back(), BOARD_COMMIT::BOARD_COMMIT(), SCH_NAVIGATE_TOOL::changeSheet(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SCH_FIELD::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_NAVIGATE_TOOL::Forward(), GERBVIEW_FRAME(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineBreakTrack(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnDeleteOneClick(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), GERBER_LAYER_WIDGET::onPopupSelection(), SIM_PLOT_FRAME::onProbe(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_PANEL::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), PCB_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), PANEL_KICAD_LAUNCHER::PANEL_KICAD_LAUNCHER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), Refresh(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), DIALOG_FIND::search(), FOOTPRINT_SEARCH_HANDLER::SelectItems(), ZONE_SEARCH_HANDLER::SelectItems(), TEXT_SEARCH_HANDLER::SelectItems(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), PCB_PROPERTIES_PANEL::UpdateData(), DIALOG_DRC::updateDisplayedCounts(), CVPCB_MAINFRAME::updateFootprintViewerOnIdle(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), PCB_PROPERTIES_PANEL::valueChanged(), DIALOG_NETLIST_IMPORT::~DIALOG_NETLIST_IMPORT(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

46{ return m_type; }

KIWAY_HOLDER::m_type

HOLDER_TYPE m_type

Definition: kiway_holder.h:85

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 562 of file eda_base_frame.h.

562{ return m_undoList.m_CommandsList.size(); }

EDA_BASE_FRAME::m_undoList

UNDO_REDO_CONTAINER m_undoList

Definition: eda_base_frame.h:731

References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_undoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EDA_BASE_FRAME::PushCommandToUndoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDITOR_CONTROL::Undo(), and EDITOR_CONDITIONS::undoFunc().

◆ GetUnitPair()

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

{
 COMMON_TOOLS* cmnTool = m_toolManager->GetTool<COMMON_TOOLS>();
 
 aPrimaryUnit = GetUserUnits();
 aSecondaryUnits = EDA_UNITS::MILS;
 
 if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
 {
 if( cmnTool )
 aSecondaryUnits = cmnTool->GetLastMetricUnits();
 else
 aSecondaryUnits = EDA_UNITS::MILLIMETRES;
 }
 else
 {
 if( cmnTool )
 aSecondaryUnits = cmnTool->GetLastImperialUnits();
 else
 aSecondaryUnits = EDA_UNITS::MILS;
 }
}

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

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

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 37 of file units_provider.h.

37{ return m_userUnits; }

UNITS_PROVIDER::m_userUnits

EDA_UNITS m_userUnits

Definition: units_provider.h:105

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortDiffPairsClick(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortTrackWidthsClick(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortViaSizesClick(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), PANEL_FP_EDITOR_DEFAULTS::PANEL_FP_EDITOR_DEFAULTS(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), SCH_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), UNITS_PROVIDER::StringFromValue(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), PROPERTIES_PANEL::update(), updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and UNITS_PROVIDER::ValueFromString().

◆ GetVisibleElementColor()

COLOR4D GERBVIEW_FRAME::GetVisibleElementColor ( int aLayerID )

Return the color of a gerber visible element.

Definition at line 723 of file gerbview_frame.cpp.

{
 COLOR4D color = COLOR4D::UNSPECIFIED;
 COLOR_SETTINGS* settings = GetColorSettings();
 
 switch( aLayerID )
 {
 case LAYER_NEGATIVE_OBJECTS:
 case LAYER_DCODES:
 case LAYER_GERBVIEW_DRAWINGSHEET:
 case LAYER_GERBVIEW_PAGE_LIMITS:
 case LAYER_GERBVIEW_BACKGROUND:
 color = settings->GetColor( aLayerID );
 break;
 
 case LAYER_GERBVIEW_GRID:
 color = GetGridColor();
 break;
 
 default:
 wxFAIL_MSG( wxString::Format( wxT( "GERBVIEW_FRAME::GetVisibleElementColor(): bad arg %d" ),
 aLayerID ) );
 }
 
 return color;
}

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

Referenced by GERBER_LAYER_WIDGET::ReFillRender().

◆ GetVisibleLayers()

LSET GERBVIEW_FRAME::GetVisibleLayers ( ) const

A proxy function that calls the correspondent function in m_BoardSettings.

Returns: LSET of the visible layers

Definition at line 687 of file gerbview_frame.cpp.

{
 LSET visible = LSET::AllLayersMask();
 
 if( GetCanvas() )
 {
 for( int i = 0; i < GERBER_DRAWLAYERS_COUNT; i++ )
 visible[i] = GetCanvas()->GetView()->IsLayerVisible( GERBER_DRAW_LAYER( i ) );
 }
 
 return visible;
}

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

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

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE * aCfg )

virtualinherited

Return a pointer to the window settings for this frame.

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

Parameters

aCfg	is this frame's config object

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

Definition at line 782 of file eda_base_frame.cpp.

{
 return &aCfg->m_Window;
}

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

{
#ifdef __WXGTK__
 wxSize winSize = GetSize();
 
 // GTK includes the window decorations in the normal GetSize call,
 // so we have to use a GTK-specific sizing call that returns the
 // non-decorated window size.
 if( m_ident == KICAD_MAIN_FRAME_T )
 {
 int width = 0;
 int height = 0;
 GTKDoGetSize( &width, &height );
 
 winSize.Set( width, height );
 }
#else
 wxSize winSize = GetSize();
#endif
 
 return winSize;
}

References KICAD_MAIN_FRAME_T, and EDA_BASE_FRAME::m_ident.

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

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const

inherited

Return a human readable value for display in dialogs.

Definition at line 626 of file eda_draw_frame.cpp.

{
 // returns a human readable value which can be displayed as zoom
 // level indicator in dialogs.
 double zoom = m_canvas->GetGAL()->GetZoomFactor();
 return wxString::Format( wxT( "Z %.2f" ), zoom );
}

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

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

◆ gvconfig()

GERBVIEW_SETTINGS * GERBVIEW_FRAME::gvconfig ( ) const

Definition at line 303 of file gerbview_frame.cpp.

{
 return dynamic_cast<GERBVIEW_SETTINGS*>( config() );
}

References EDA_BASE_FRAME::config().

Referenced by ApplyDisplaySettingsToGAL(), CommonSettingsChanged(), GERBVIEW_CONTROL::DisplayControl(), IsElementVisible(), GERBVIEW_SELECTION_TOOL::selectable(), SetActiveLayer(), SetElementVisibility(), setupUIConditions(), SetVisibleLayers(), and UpdateDiffLayers().

◆ handleActivateEvent()

void EDA_DRAW_FRAME::handleActivateEvent ( wxActivateEvent & aEvent )

protectedvirtualinherited

Handle a window activation event.

Reimplemented in SCH_BASE_FRAME, PCB_BASE_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 1197 of file eda_draw_frame.cpp.

{
 // Force a refresh of the message panel to ensure that the text is the right color
 // when the window activates
 if( !IsIconized() )
 m_messagePanel->Refresh();
}

References EDA_DRAW_FRAME::m_messagePanel.

Referenced by SCH_BASE_FRAME::handleActivateEvent(), PCB_BASE_FRAME::handleActivateEvent(), and EDA_DRAW_FRAME::onActivate().

◆ handleIconizeEvent()

virtual void EDA_BASE_FRAME::handleIconizeEvent ( wxIconizeEvent & aEvent )

inlineprotectedvirtualinherited

Handle a window iconize event.

Parameters

aEvent is the data for the event.

Reimplemented in EDA_3D_VIEWER_FRAME, SCH_BASE_FRAME, and PCB_BASE_FRAME.

Definition at line 601 of file eda_base_frame.h.

601{}

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

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

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

Definition at line 1361 of file eda_base_frame.cpp.

{
 // Update the icon theme when the system theme changes and update the toolbars
 GetBitmapStore()->ThemeChanged();
 ThemeChanged();
 
 // This isn't handled by ThemeChanged()
 if( GetMenuBar() )
 {
 // For icons in menus, icon scaling & hotkeys
 ReCreateMenuBar();
 GetMenuBar()->Refresh();
 }
}

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

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

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

staticinherited

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

enabled, checked, etc.).

Parameters

aEvent	is the wxUpdateUIEvent to be processed.
aFrame	is the frame to get the selection from
aCond	are the #UI SELECTION_CONDITIONS used

Definition at line 359 of file eda_base_frame.cpp.

{
 bool checkRes = false;
 bool enableRes = true;
 bool showRes = true;
 bool isCut = aEvent.GetId() == ACTIONS::cut.GetUIId();
 bool isCopy = aEvent.GetId() == ACTIONS::copy.GetUIId();
 bool isPaste = aEvent.GetId() == ACTIONS::paste.GetUIId();
 SELECTION& selection = aFrame->GetCurrentSelection();
 
 try
 {
 checkRes = aCond.checkCondition( selection );
 enableRes = aCond.enableCondition( selection );
 showRes = aCond.showCondition( selection );
 }
 catch( std::exception& )
 {
 // Something broke with the conditions, just skip the event.
 aEvent.Skip();
 return;
 }
 
 if( isCut || isCopy || isPaste )
 {
 wxWindow* focus = wxWindow::FindFocus();
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( focus );
 
 if( textEntry && isCut && textEntry->CanCut() )
 enableRes = true;
 else if( textEntry && isCopy && textEntry->CanCopy() )
 enableRes = true;
 else if( textEntry && isPaste && textEntry->CanPaste() )
 enableRes = true;
 }
 
 aEvent.Enable( enableRes );
 aEvent.Show( showRes );
 
 // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
 // checked, since wxMenuItems don't want to be checked unless they actually are checkable
#if wxCHECK_VERSION( 3, 1, 5 )
 if( aEvent.IsCheckable() )
 aEvent.Check( checkRes );
#else
 bool canCheck = true;
 
 // wxMenuItems don't want to be checked unless they actually are checkable, so we have to
 // check to see if they can be and can't just universally apply a check in this event.
 if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
 canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
 
 if( canCheck )
 aEvent.Check( checkRes );
#endif
}

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

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

void EDA_DRAW_FRAME::HardRedraw ( )

virtualinherited

Rebuild the GAL and redraws the screen.

Call when something went wrong.

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

Definition at line 885 of file eda_draw_frame.cpp.

{
 // To be implemented by subclasses.
}

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

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const

inlineinherited

Safety check before asking for the Kiway reference.

Returns: true if kiway is non-null

Definition at line 63 of file kiway_holder.h.

 {
 return m_kiway != nullptr;
 }

References KIWAY_HOLDER::m_kiway.

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 801 of file eda_base_frame.cpp.

{
 return Kiface().GetHelpFileName();
}

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImagesMaxCount()

unsigned GERBVIEW_FRAME::ImagesMaxCount ( ) const

The max number of file images.

Definition at line 955 of file gerbview_frame.cpp.

{
 return m_gerberLayout->GetImagesList()->ImagesMaxCount();
}

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

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

◆ ImportHotkeyConfigFromFile()

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

inherited

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

Parameters

aActionMap	current hotkey map (over which the imported hotkeys will be applied).
aDefaultShortname	a default short name (extension not needed) like Eeschema, KiCad...

◆ initExitKey()

void EDA_BASE_FRAME::initExitKey ( )

protectedinherited

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

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

Definition at line 1245 of file eda_base_frame.cpp.

{
 wxAcceleratorEntry entries[1];
 entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
 wxAcceleratorTable accel( 1, entries );
 SetAcceleratorTable( accel );
}

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const

inlineprotectedvirtualinherited

Return the auto save status of the application.

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 609 of file eda_base_frame.h.

609{ return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( ) const

virtualinherited

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

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

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

Definition at line 1238 of file eda_base_frame.cpp.

{
 // This function should be overridden in child classes
 return false;
}

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

◆ IsCurrentTool()

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

inherited

Definition at line 119 of file tools_holder.cpp.

{
 if( m_toolStack.empty() )
 return &aAction == &ACTIONS::selectionTool;
 else
 return m_toolStack.back() == aAction.GetName();
}

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

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

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )

inherited

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

Definition at line 176 of file kiway_player.cpp.

{
 return !m_modal_loop;
}

References KIWAY_PLAYER::m_modal_loop.

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

◆ IsElementVisible()

bool GERBVIEW_FRAME::IsElementVisible ( int aLayerID ) const

Test whether a given element category is visible.

Keep this as an inline function.

Parameters

aLayerID is an item id from the enum GERBVIEW_LAYER_ID

Returns: bool - true if the element is visible.

Definition at line 667 of file gerbview_frame.cpp.

{
 switch( aLayerID )
 {
 case LAYER_DCODES: return gvconfig()->m_Appearance.show_dcodes;
 case LAYER_NEGATIVE_OBJECTS: return gvconfig()->m_Appearance.show_negative_objects;
 case LAYER_GERBVIEW_GRID: return IsGridVisible();
 case LAYER_GERBVIEW_DRAWINGSHEET: return gvconfig()->m_Appearance.show_border_and_titleblock;
 case LAYER_GERBVIEW_PAGE_LIMITS: return gvconfig()->m_Display.m_DisplayPageLimits;
 case LAYER_GERBVIEW_BACKGROUND: return true;
 
 default:
 wxFAIL_MSG( wxString::Format( wxT( "GERBVIEW_FRAME::IsElementVisible(): bad arg %d" ),
 aLayerID ) );
 }
 
 return true;
}

References Format(), gvconfig(), EDA_DRAW_FRAME::IsGridVisible(), LAYER_DCODES, LAYER_GERBVIEW_BACKGROUND, LAYER_GERBVIEW_DRAWINGSHEET, LAYER_GERBVIEW_GRID, LAYER_GERBVIEW_PAGE_LIMITS, LAYER_NEGATIVE_OBJECTS, GERBVIEW_SETTINGS::m_Appearance, GERBVIEW_SETTINGS::m_Display, GBR_DISPLAY_OPTIONS::m_DisplayPageLimits, GERBVIEW_SETTINGS::APPEARANCE::show_border_and_titleblock, GERBVIEW_SETTINGS::APPEARANCE::show_dcodes, and GERBVIEW_SETTINGS::APPEARANCE::show_negative_objects.

Referenced by GERBER_LAYER_WIDGET::ReFillRender().

◆ IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( ) const

inherited

Definition at line 462 of file eda_draw_frame.cpp.

{
 return config()->m_Window.grid.show;
}

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

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

◆ IsLayerVisible()

bool GERBVIEW_FRAME::IsLayerVisible ( int aLayer ) const

Test whether a given layer is visible.

Parameters

aLayer The layer to be tested (still 0-31!)

Returns: true if the layer is visible.

Definition at line 717 of file gerbview_frame.cpp.

{
 return m_LayersManager->IsLayerVisible( aLayer );
}

References LAYER_WIDGET::IsLayerVisible(), and m_LayersManager.

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

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const

inlineoverridevirtualinherited

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

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 173 of file kiway_player.h.

173{ return m_modal; }

KIWAY_PLAYER::m_modal

bool m_modal

Definition: kiway_player.h:210

References KIWAY_PLAYER::m_modal.

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

◆ IsScriptingConsoleVisible()

bool EDA_DRAW_FRAME::IsScriptingConsoleVisible ( )

inherited

Gets the current visibility of the scripting console window.

Definition at line 250 of file eda_draw_frame.cpp.

{
 KIWAY_PLAYER* frame = Kiway().Player( FRAME_PYTHON, false );
 return frame && frame->IsVisible();
}

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

Referenced by EDITOR_CONDITIONS::consoleVisibleFunc().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inlineinherited

Definition at line 197 of file eda_base_frame.h.

197{ return m_ident == aType; }

References EDA_BASE_FRAME::m_ident.

◆ IsWritable()

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

inherited

Checks if aFileName can be written.

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

‍
Note
The file name path must be set or an assertion will be raised on debug builds and return false on release builds.

Parameters

aFileName The full path and/or file name of the file to test.

aVerbose If true will show an error dialog if the file is not writable

Returns
False if aFileName cannot be written.

Definition at line 1148 of file eda_base_frame.cpp.

{
 wxString msg;
 wxFileName fn = aFileName;
 
 // Check for absence of a file path with a file name. Unfortunately KiCad
 // uses paths relative to the current project path without the ./ part which
 // confuses wxFileName. Making the file name path absolute may be less than
 // elegant but it solves the problem.
 if( fn.GetPath().IsEmpty() && fn.HasName() )
 fn.MakeAbsolute();
 
 wxCHECK_MSG( fn.IsOk(), false,
 wxT( "File name object is invalid. Bad programmer!" ) );
 wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
 wxT( "File name object path <" ) + fn.GetFullPath() +
 wxT( "> is not set. Bad programmer!" ) );
 
 if( fn.IsDir() && !fn.IsDirWritable() )
 {
 msg.Printf( _( "Insufficient permissions to folder '%s'." ), fn.GetPath() );
 }
 else if( !fn.FileExists() && !fn.IsDirWritable() )
 {
 msg.Printf( _( "Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
 }
 else if( fn.FileExists() && !fn.IsFileWritable() )
 {
 msg.Printf( _( "Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
 }
 
 if( !msg.IsEmpty() )
 {
 if( aVerbose )
 wxMessageBox( msg );
 
 return false;
 }
 
 return true;
}

References _.

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

◆ Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const

inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 of file kiway_holder.h.

 {
 wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
 return *m_kiway;
 }

References KIWAY_HOLDER::m_kiway.

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS & aEvent )

protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 197 of file kiway_player.cpp.

{
 // logging support
 KiwayMailIn( aEvent ); // call the virtual, override in derived.
}

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS & aEvent )

virtualinherited

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

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

Definition at line 87 of file kiway_player.cpp.

{
 // override this in derived classes.
}

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

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent & event )

protectedinherited

An event handler called on a language menu selection.

Definition at line 204 of file kiway_player.cpp.

{
 int id = event.GetId();
 
 // tell all the KIWAY_PLAYERs about the language change.
 Kiway().SetLanguage( id );
}

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

◆ LibraryFileBrowser()

bool EDA_DRAW_FRAME::LibraryFileBrowser	(	bool	doOpen,
		wxFileName &	aFilename,
		const wxString &	wildcard,
		const wxString &	ext,
		bool	isDirectory = `false`,
		bool	aIsGlobal = `false`,
		const wxString &	aGlobalPath = `wxEmptyString`
	)

inherited

Parameters

doOpen	if true runs an Open Library browser, otherwise New Library
aFilename	for New may contain a default name; in both cases return the chosen filename.
wildcard	a wildcard to filter the displayed files
ext	the library file extension
isDirectory	indicates the library files are directories

Returns: true for OK; false for Cancel.

Definition at line 1023 of file eda_draw_frame.cpp.

{
 wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
 aFilename.SetExt( ext );
 
 wxString dir;
 
 if( GetMruPath().IsEmpty() )
 dir = aGlobalPath;
 else
 dir = GetMruPath();
 
 
 if( isDirectory && doOpen )
 {
 if( !aIsGlobal && GetMruPath().IsEmpty() )
 {
 dir = Prj().GetProjectPath();
 }
 
 wxDirDialog dlg( this, prompt, dir, wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
 
 if( dlg.ShowModal() == wxID_CANCEL )
 return false;
 
 aFilename = dlg.GetPath();
 aFilename.SetExt( ext );
 }
 else
 {
 // Ensure the file has a dummy name, otherwise GTK will display the regex from the filter
 if( aFilename.GetName().empty() )
 aFilename.SetName( "Library" );
 
 if( !aIsGlobal && GetMruPath().IsEmpty() )
 {
 dir = Prj().IsNullProject() ? aFilename.GetFullPath() : Prj().GetProjectPath();
 }
 
 wxFileDialog dlg( this, prompt, dir, aFilename.GetFullName(),
 wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
 : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
 
 if( dlg.ShowModal() == wxID_CANCEL )
 return false;
 
 aFilename = dlg.GetPath();
 aFilename.SetExt( ext );
 }
 
 SetMruPath( aFilename.GetPath() );
 
 return true;
}

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), PCB_BASE_EDIT_FRAME::createNewLibrary(), and SCH_EDITOR_CONTROL::ExportSymbolsToLibrary().

◆ LoadAutodetectedFiles()

bool GERBVIEW_FRAME::LoadAutodetectedFiles ( const wxString & aFileName )

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

Parameters

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

Returns: true if file was opened successfully.

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

{
 // 2 = autodetect files
 return LoadFileOrShowDialog( aFileName, AllFilesWildcard(), _( "Open Autodetected File(s)" ),
 2 );
}

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

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

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )

protectedinherited

Returns the canvas type stored in the application settings.

Definition at line 779 of file eda_draw_frame.cpp.

{
#ifdef __WXMAC__
 // Cairo renderer doesn't handle Retina displays so there's really only one game
 // in town for Mac
 return EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL;
#endif
 
 EDA_DRAW_PANEL_GAL::GAL_TYPE canvasType = EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE;
 APP_SETTINGS_BASE* cfg = Kiface().KifaceSettings();
 
 if( cfg )
 canvasType = static_cast<EDA_DRAW_PANEL_GAL::GAL_TYPE>( cfg->m_Graphics.canvas_type );
 
 if( canvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
 || canvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
 {
 wxASSERT( false );
 canvasType = EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE;
 }
 
 // Legacy canvas no longer supported. Switch to OpenGL, falls back to Cairo on failure
 if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
 canvasType = EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL;
 
 return canvasType;
}

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

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

◆ LoadExcellonFiles()

bool GERBVIEW_FRAME::LoadExcellonFiles ( const wxString & aFileName )

Load a drill (EXCELLON) file or many files.

Parameters

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

Returns: true if file was opened successfully.

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

{
 wxString filetypes = DrillFileWildcard();
 filetypes << wxT( "|" );
 filetypes += AllFilesWildcard();
 
 // 1 = drill files
 return LoadFileOrShowDialog( aFileName, filetypes, _( "Open NC (Excellon) Drill File(s)" ), 1 );
}

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

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

◆ LoadFileOrShowDialog()

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

private

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

Parameters

aFileName	Name of the file to open. Shows a dialog if not specified.
dialogFiletypes	File extensions to pass to the dialog if necessary
dialogTitle	Dialog title to use if necessary
filetype	Type of file for parsing, 0 = gerber, 1 = drill, 2 = autodetect

Returns: true if success opening all files, false otherwise

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

{
 static int lastGerberFileWildcard = 0;
 wxArrayString filenamesList;
 wxFileName filename = aFileName;
 wxString currentPath;
 
 if( !filename.IsOk() )
 {
 // Use the current working directory if the file name path does not exist.
 if( filename.DirExists() )
 currentPath = filename.GetPath();
 else
 {
 currentPath = m_mruPath;
 
 // On wxWidgets 3.1 (bug?) the path in wxFileDialog is ignored when
 // finishing by the dir separator. Remove it if any:
 if( currentPath.EndsWith( '\\' ) || currentPath.EndsWith( '/' ) )
 currentPath.RemoveLast();
 }
 
 wxFileDialog dlg( this, dialogTitle, currentPath, filename.GetFullName(), dialogFiletypes,
 wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE | wxFD_CHANGE_DIR );
 dlg.SetFilterIndex( lastGerberFileWildcard );
 
 if( dlg.ShowModal() == wxID_CANCEL )
 return false;
 
 lastGerberFileWildcard = dlg.GetFilterIndex();
 dlg.GetPaths( filenamesList );
 m_mruPath = currentPath = dlg.GetDirectory();
 }
 else
 {
 filenamesList.Add( aFileName );
 currentPath = filename.GetPath();
 m_mruPath = currentPath;
 }
 
 // Set the busy cursor
 wxBusyCursor wait;
 
 bool isFirstFile = GetImagesList()->GetLoadedImageCount() == 0;
 
 std::vector<int> fileTypesVec( filenamesList.Count(), filetype );
 bool success = LoadListOfGerberAndDrillFiles( currentPath, filenamesList, &fileTypesVec );
 
 // Auto zoom / sort is only applied when no other files have been loaded
 if( isFirstFile )
 {
 SortLayersByFileExtension();
 Zoom_Automatique( false );
 }
 
 return success;
}

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

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

◆ LoadGerberFiles()

bool GERBVIEW_FRAME::LoadGerberFiles ( const wxString & aFileName )

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

Parameters

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

Returns: true if file was opened successfully.

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

{
 wxString filetypes;
 wxFileName filename = aFileName;
 
 /* Standard gerber filetypes
 * (See http://en.wikipedia.org/wiki/Gerber_File)
 * The .gbr (.pho in legacy files) extension is the default used in Pcbnew; however
 * there are a lot of other extensions used for gerber files. Because the first letter
 * is usually g, we accept g* as extension.
 * (Mainly internal copper layers do not have specific extension, and filenames are like
 * *.g1, *.g2 *.gb1 ...)
 * Now (2014) Ucamco (the company which manages the Gerber format) encourages use of .gbr
 * only and the Gerber X2 file format.
 */
 filetypes = _( "Gerber files (.g* .lgr .pho)" );
 filetypes << wxT( "|" );
 filetypes += wxT( "*.g*;*.G*;*.pho;*.PHO" );
 filetypes << wxT( "|" );
 
 /* Special gerber filetypes */
 filetypes += _( "Top layer" ) + AddFileExtListToFilter( { "GTL" } ) + wxT( "|" );
 filetypes += _( "Bottom layer" ) + AddFileExtListToFilter( { "GBL" } ) + wxT( "|" );
 filetypes += _( "Bottom solder resist" ) + AddFileExtListToFilter( { "GBS" } ) + wxT( "|" );
 filetypes += _( "Top solder resist" ) + AddFileExtListToFilter( { "GTS" } ) + wxT( "|" );
 filetypes += _( "Bottom overlay" ) + AddFileExtListToFilter( { "GBO" } ) + wxT( "|" );
 filetypes += _( "Top overlay" ) + AddFileExtListToFilter( { "GTO" } ) + wxT( "|" );
 filetypes += _( "Bottom paste" ) + AddFileExtListToFilter( { "GBP" } ) + wxT( "|" );
 filetypes += _( "Top paste" ) + AddFileExtListToFilter( { "GTP" } ) + wxT( "|" );
 filetypes += _( "Keep-out layer" ) + AddFileExtListToFilter( { "GKO" } ) + wxT( "|" );
 filetypes += _( "Mechanical layers" )
 + AddFileExtListToFilter(
 { "GM1", "GM2", "GM3", "GM4", "GM5", "GM6", "GM7", "GM8", "GM9" } )
 + wxT( "|" );
 filetypes += _( "Top Pad Master" ) + AddFileExtListToFilter( { "GPT" } ) + wxT( "|" );
 filetypes += _( "Bottom Pad Master" ) + AddFileExtListToFilter( { "GPB" } ) + wxT( "|" );
 
 // All filetypes
 filetypes += AllFilesWildcard();
 
 // 0 = gerber files
 return LoadFileOrShowDialog( aFileName, filetypes, _( "Open Gerber File(s)" ), 0 );
}

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

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

◆ LoadGerberJobFile()

bool GERBVIEW_FRAME::LoadGerberJobFile ( const wxString & aFileName )

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

Parameters

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

Returns: true if file(s) was opened successfully.

Definition at line 178 of file job_file_reader.cpp.

{
 wxFileName filename = aFullFileName;
 wxString currentPath;
 bool success = true;
 
 if( !filename.IsOk() )
 {
 // Use the current working directory if the file name path does not exist.
 if( filename.DirExists() )
 currentPath = filename.GetPath();
 else
 currentPath = m_mruPath;
 
 wxFileDialog dlg( this, _( "Open Gerber Job File" ),
 currentPath,
 filename.GetFullName(),
 GerberJobFileWildcard(),
 wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_CHANGE_DIR );
 
 if( dlg.ShowModal() == wxID_CANCEL )
 return false;
 
 filename = dlg.GetPath();
 currentPath = filename.GetPath();
 m_mruPath = currentPath;
 }
 else
 {
 currentPath = filename.GetPath();
 m_mruPath = currentPath;
 }
 
 wxString msg;
 WX_STRING_REPORTER reporter( &msg );
 
 if( filename.IsOk() )
 {
 GERBER_JOBFILE_READER gbjReader( filename.GetFullPath(), &reporter );
 
 if( gbjReader.ReadGerberJobFile() )
 {
 // Update the list of recent drill files.
 UpdateFileHistory( filename.GetFullPath(), &m_jobFileHistory );
 
 Clear_DrawLayers( false );
 ClearMsgPanel();
 
 wxArrayString& gbrfiles = gbjReader.GetGerberFiles();
 
 // 0 = Gerber file type
 std::vector<int> fileTypesVec( gbrfiles.Count(), 0 );
 success = LoadListOfGerberAndDrillFiles( currentPath, gbrfiles, &fileTypesVec );
 
 Zoom_Automatique( false );
 }
 }
 
 SortLayersByX2Attributes();
 
 if( !msg.IsEmpty() )
 {
 wxSafeYield(); // Allows slice of time to redraw the screen
 // to refresh widgets, before displaying messages
 HTML_MESSAGE_BOX mbox( this, _( "Messages" ) );
 mbox.ListSet( msg );
 mbox.ShowModal();
 }
 
 return success;
}

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

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

◆ LoadListOfGerberAndDrillFiles()

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

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

Parameters

aPath	is the base path for the filenames if they are relative
aFilenameList	is a list of filenames to load
aFileType	is a list of type of files to load (0 = Gerber, 1 = NC drill, 2 Autodetect) Successfully autodetected files will have their type changed

Returns: true if every file loaded successfully

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

{
 wxCHECK_MSG( aFilenameList.Count() == aFileType->size(), false,
 "Mismatch in file names and file types count" );
 
 wxFileName filename;
 
 // Read gerber files: each file is loaded on a new GerbView layer
 bool success = true;
 int layer = GetActiveLayer();
 int firstLoadedLayer = NO_AVAILABLE_LAYERS;
 LSET visibility = GetVisibleLayers();
 
 // Manage errors when loading files
 wxString msg;
 WX_STRING_REPORTER reporter( &msg );
 
 // Create progress dialog (only used if more than 1 file to load
 std::unique_ptr<WX_PROGRESS_REPORTER> progress = nullptr;
 
 for( unsigned ii = 0; ii < aFilenameList.GetCount(); ii++ )
 {
 filename = aFilenameList[ii];
 
 if( !filename.IsAbsolute() )
 filename.SetPath( aPath );
 
 // Check for non existing files, to avoid creating broken or useless data
 // and report all in one error list:
 if( !filename.FileExists() )
 {
 wxString warning;
 warning << wxT( "<b>" ) << _( "File not found:" ) << wxT( "</b><br>" )
 << filename.GetFullPath() << wxT( "<br>" );
 reporter.Report( warning, RPT_SEVERITY_WARNING );
 success = false;
 continue;
 }
 
 if( filename.GetExt() == GerberJobFileExtension.c_str() )
 {
 //We cannot read a gerber job file as a gerber plot file: skip it
 wxString txt;
 txt.Printf( _( "<b>A gerber job file cannot be loaded as a plot file</b> "
 "<i>%s</i>" ),
 filename.GetFullName() );
 success = false;
 reporter.Report( txt, RPT_SEVERITY_ERROR );
 continue;
 }
 
 
 m_lastFileName = filename.GetFullPath();
 
 if( !progress && ( aFilenameList.GetCount() > 1 ) )
 {
 progress = std::make_unique<WX_PROGRESS_REPORTER>( this, _( "Loading files..." ), 1,
 false );
 progress->SetMaxProgress( aFilenameList.GetCount() - 1 );
 progress->Report( wxString::Format( _("Loading %u/%zu %s..." ),
 ii+1,
 aFilenameList.GetCount(),
 m_lastFileName ) );
 }
 else if( progress )
 {
 progress->Report( wxString::Format( _("Loading %u/%zu %s..." ),
 ii+1,
 aFilenameList.GetCount(),
 m_lastFileName ) );
 progress->KeepRefreshing();
 }
 
 
 // Make sure we have a layer available to load into
 layer = getNextAvailableLayer();
 
 if( layer == NO_AVAILABLE_LAYERS )
 {
 success = false;
 reporter.Report( MSG_NO_MORE_LAYER, RPT_SEVERITY_ERROR );
 
 // Report the name of not loaded files:
 while( ii < aFilenameList.GetCount() )
 {
 filename = aFilenameList[ii++];
 wxString txt = wxString::Format( MSG_NOT_LOADED, filename.GetFullName() );
 reporter.Report( txt, RPT_SEVERITY_ERROR );
 }
 break;
 }
 
 SetActiveLayer( layer, false );
 visibility[ layer ] = true;
 
 try
 {
 // 2 = Autodetect
 if( ( *aFileType )[ii] == 2 )
 {
 if( EXCELLON_IMAGE::TestFileIsExcellon( filename.GetFullPath() ) )
 ( *aFileType )[ii] = 1;
 else if( GERBER_FILE_IMAGE::TestFileIsRS274( filename.GetFullPath() ) )
 ( *aFileType )[ii] = 0;
 }
 
 switch( ( *aFileType )[ii] )
 {
 case 0:
 
 if( Read_GERBER_File( filename.GetFullPath() ) )
 {
 UpdateFileHistory( filename.GetFullPath() );
 
 if( firstLoadedLayer == NO_AVAILABLE_LAYERS )
 {
 firstLoadedLayer = layer;
 }
 }
 
 break;
 
 case 1:
 
 if( Read_EXCELLON_File( filename.GetFullPath() ) )
 {
 UpdateFileHistory( filename.GetFullPath(), &m_drillFileHistory );
 
 // Select the first added layer by default when done loading
 if( firstLoadedLayer == NO_AVAILABLE_LAYERS )
 {
 firstLoadedLayer = layer;
 }
 }
 
 break;
 default:
 wxString txt = wxString::Format( MSG_NOT_LOADED, filename.GetFullName() );
 reporter.Report( txt, RPT_SEVERITY_ERROR );
 }
 }
 catch( const std::bad_alloc& )
 {
 wxString txt = wxString::Format( MSG_OOM, filename.GetFullName() );
 reporter.Report( txt, RPT_SEVERITY_ERROR );
 success = false;
 continue;
 }
 
 if( progress )
 progress->AdvanceProgress();
 }
 
 if( !success )
 {
 wxSafeYield(); // Allows slice of time to redraw the screen
 // to refresh widgets, before displaying messages
 HTML_MESSAGE_BOX mbox( this, _( "Errors" ) );
 mbox.ListSet( msg );
 mbox.ShowModal();
 }
 
 SetVisibleLayers( visibility );
 
 if( firstLoadedLayer != NO_AVAILABLE_LAYERS )
 SetActiveLayer( firstLoadedLayer, true );
 
 // Synchronize layers tools with actual active layer:
 ReFillLayerWidget();
 
 m_LayersManager->UpdateLayerIcons();
 syncLayerBox( true );
 
 GetCanvas()->Refresh();
 
 return success;
}

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

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

◆ LoadSettings()

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

{
 EDA_DRAW_FRAME::LoadSettings( aCfg );
 
 if( aCfg->m_Window.grid.sizes.empty() )
 {
 aCfg->m_Window.grid.sizes = { wxT( "100 mil" ),
 wxT( "50 mil" ),
 wxT( "25 mil" ),
 wxT( "20 mil" ),
 wxT( "10 mil" ),
 wxT( "5 mil" ),
 wxT( "2.5 mil" ),
 wxT( "2 mil" ),
 wxT( "1 mil" ),
 wxT( "0.5 mil" ),
 wxT( "0.2 mil" ),
 wxT( "0.1 mil" ),
 wxT( "5.0 mm" ),
 wxT( "2.5 mm" ),
 wxT( "1.0 mm" ),
 wxT( "0.5 mm" ),
 wxT( "0.25 mm" ),
 wxT( "0.2 mm" ),
 wxT( "0.1 mm" ),
 wxT( "0.05 mm" ),
 wxT( "0.025 mm" ),
 wxT( "0.01 mm" ) };
 }
 
 if( aCfg->m_Window.zoom_factors.empty() )
 {
 aCfg->m_Window.zoom_factors = { ZOOM_LIST_GERBVIEW };
 }
 
 GERBVIEW_SETTINGS* cfg = dynamic_cast<GERBVIEW_SETTINGS*>( aCfg );
 wxCHECK( cfg, /*void*/ );
 
 SetElementVisibility( LAYER_GERBVIEW_DRAWINGSHEET,
 cfg->m_Appearance.show_border_and_titleblock );
 SetElementVisibility( LAYER_GERBVIEW_PAGE_LIMITS,
 cfg->m_Display.m_DisplayPageLimits );
 
 PAGE_INFO pageInfo( wxT( "GERBER" ) );
 pageInfo.SetType( cfg->m_Appearance.page_type );
 SetPageSettings( pageInfo );
 
 SetElementVisibility( LAYER_DCODES, cfg->m_Appearance.show_dcodes );
 SetElementVisibility( LAYER_NEGATIVE_OBJECTS, cfg->m_Appearance.show_negative_objects );
 
 m_drillFileHistory.Load( cfg->m_DrillFileHistory );
 m_zipFileHistory.Load( cfg->m_ZipFileHistory );
 m_jobFileHistory.Load( cfg->m_JobFileHistory );
}

Referenced by GERBVIEW_FRAME().

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS * aCfg )

inherited

Load window settings from the given settings object.

Normally called by LoadSettings() unless the window in question is a child window that* stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.

Definition at line 692 of file eda_base_frame.cpp.

{
 LoadWindowState( aCfg->state );
 
 m_perspective = aCfg->perspective;
 m_mruPath = aCfg->mru_path;
 
 TOOLS_HOLDER::CommonSettingsChanged( false, false );
}

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

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE & aState )

virtualinherited

Load frame state info from a configuration file.

Definition at line 546 of file eda_base_frame.cpp.

{
 bool wasDefault = false;
 
 m_framePos.x = aState.pos_x;
 m_framePos.y = aState.pos_y;
 m_frameSize.x = aState.size_x;
 m_frameSize.y = aState.size_y;
 
 wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
 m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
 // Ensure minimum size is set if the stored config was zero-initialized
 if( m_frameSize.x < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
 {
 m_frameSize = defaultSize( m_ident );
 wasDefault = true;
 
 wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)",
 m_frameSize.x, m_frameSize.y );
 }
 
 wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
 
 if( aState.display >= wxDisplay::GetCount() )
 {
 wxLogTrace( traceDisplayLocation, "Previous display not found" );
 
 // If it isn't attached, use the first display
 // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
 const unsigned int index = 0;
 wxDisplay display( index );
 wxRect clientSize = display.GetGeometry();
 
 m_framePos = wxDefaultPosition;
 
 // Ensure the window fits on the display, since the other one could have been larger
 if( m_frameSize.x > clientSize.width )
 m_frameSize.x = clientSize.width;
 
 if( m_frameSize.y > clientSize.height )
 m_frameSize.y = clientSize.height;
 }
 else
 {
 wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
 wxPoint upperLeft( m_framePos.x, m_framePos.y );
 
 wxDisplay display( aState.display );
 wxRect clientSize = display.GetClientArea();
 
 int yLimTop = clientSize.y;
 int yLimBottom = clientSize.y + clientSize.height;
 int xLimLeft = clientSize.x;
 int xLimRight = clientSize.x + clientSize.width;
 
 if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
 upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
 upperLeft.y < yLimTop || // Upper corner too close to the bottom of the screen
 upperLeft.y > yLimBottom )
 {
 m_framePos = wxDefaultPosition;
 wxLogTrace( traceDisplayLocation, "Resetting to default position" );
 }
 }
 
 wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
 m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
 SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
 // Center the window if we reset to default
 if( m_framePos.x == -1 )
 {
 wxLogTrace( traceDisplayLocation, "Centering window" );
 Center();
 m_framePos = GetPosition();
 }
 
 // Record the frame sizes in an un-maximized state
 m_normalFrameSize = m_frameSize;
 m_normalFramePos = m_framePos;
 
 // Maximize if we were maximized before
 if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
 {
 wxLogTrace( traceDisplayLocation, "Maximizing window" );
 Maximize();
 }
 
 m_displayIndex = wxDisplay::GetFromWindow( this );
}

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

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString & aFileName )

inherited

Definition at line 532 of file eda_base_frame.cpp.

{
 if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
 return;
 
 const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
 
 if( state != nullptr )
 {
 LoadWindowState( state->window );
 }
}

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

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

◆ LoadZipArchiveFile()

bool GERBVIEW_FRAME::LoadZipArchiveFile ( const wxString & aFileName )

Load a zipped archive file.

Parameters

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

Returns: true if file was opened successfully.

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

{
#define ZipFileExtension "zip"
 
 wxFileName filename = aFullFileName;
 wxString currentPath;
 
 if( !filename.IsOk() )
 {
 // Use the current working directory if the file name path does not exist.
 if( filename.DirExists() )
 currentPath = filename.GetPath();
 else
 currentPath = m_mruPath;
 
 wxFileDialog dlg( this, _( "Open Zip File" ), currentPath, filename.GetFullName(),
 ZipFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_CHANGE_DIR );
 
 if( dlg.ShowModal() == wxID_CANCEL )
 return false;
 
 filename = dlg.GetPath();
 currentPath = wxGetCwd();
 m_mruPath = currentPath;
 }
 else
 {
 currentPath = filename.GetPath();
 m_mruPath = currentPath;
 }
 
 wxString msg;
 WX_STRING_REPORTER reporter( &msg );
 
 if( filename.IsOk() )
 unarchiveFiles( filename.GetFullPath(), &reporter );
 
 Zoom_Automatique( false );
 
 // Synchronize layers tools with actual active layer:
 ReFillLayerWidget();
 SetActiveLayer( GetActiveLayer() );
 m_LayersManager->UpdateLayerIcons();
 syncLayerBox();
 
 if( !msg.IsEmpty() )
 {
 wxSafeYield(); // Allows slice of time to redraw the screen
 // to refresh widgets, before displaying messages
 HTML_MESSAGE_BOX mbox( this, _( "Messages" ) );
 mbox.ListSet( msg );
 mbox.ShowModal();
 }
 
 return true;
}

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

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

◆ LockFile()

bool EDA_DRAW_FRAME::LockFile ( const wxString & aFileName )

inherited

Mark a schematic file as being in use.

Use ReleaseFile() to undo this.

Parameters

aFileName full path to the file.

Returns: false if the file was already locked, true otherwise.

Definition at line 209 of file eda_draw_frame.cpp.

{
 m_file_checker = ::LockFile( aFileName );
 
 return m_file_checker && !m_file_checker->IsAnotherRunning();
}

References EDA_DRAW_FRAME::LockFile(), and EDA_DRAW_FRAME::m_file_checker.

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

◆ MessageTextFromValue() [1/2]

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

inlineinherited

Definition at line 82 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::MessageTextFromValue( unityScale, EDA_UNITS::DEGREES,
 aValue.AsDegrees(), aAddUnitLabel,
 EDA_DATA_TYPE::DISTANCE );
 }

References EDA_ANGLE::AsDegrees(), DEGREES, DISTANCE, EDA_UNIT_UTILS::UI::MessageTextFromValue(), and unityScale.

◆ MessageTextFromValue() [2/2]

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

inlineinherited

A lower-precision version of StringFromValue().

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

Definition at line 75 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::MessageTextFromValue( GetIuScale(), GetUserUnits(), aValue,
 aAddUnitLabel, aType );
 }

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

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), CheckLibSymbol(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), DIALOG_BOARD_REANNOTATE::CoordTowxString(), EDA_DRAW_FRAME::DisplayGridMsg(), DisplayGridMsg(), PCB_BASE_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DRAWING_TOOL::DrawBoardCharacteristics(), DRC_ENGINE::EvalRules(), DIALOG_NET_INSPECTOR::formatLength(), LIB_FIELD::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_BITMAP::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), STROKE_PARAMS::GetMsgPanelInfo(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), TEXT_SEARCH_HANDLER::GetResultCell(), LIB_SHAPE::GetSelectMenuText(), SCH_LINE::GetSelectMenuText(), SCH_SHAPE::GetSelectMenuText(), DS_DRAW_ITEM_LINE::GetSelectMenuText(), DS_DRAW_ITEM_RECT::GetSelectMenuText(), PCB_TRACK::GetSelectMenuText(), DIALOG_BOARD_REANNOTATE::MakeSampleText(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_SHAPE::ShapeGetMsgPanelInfo(), showCoord(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), VIA_SIZE_MENU::update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), PCB_CONTROL::UpdateMessagePanel(), PL_EDITOR_FRAME::UpdateMsgPanelInfo(), SCH_BASE_FRAME::UpdateStatusBar(), UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), and DIALOG_BOARD_STATISTICS::updateWidets().

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce )

inlineinherited

Definition at line 567 of file eda_base_frame.h.

 {
 m_isNonUserClose = true;
 return Close( aForce );
 }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onActivate()

void EDA_DRAW_FRAME::onActivate ( wxActivateEvent & aEvent )

protectedinherited

Definition at line 1206 of file eda_draw_frame.cpp.

{
 handleActivateEvent( aEvent );
 
 aEvent.Skip();
}

References EDA_DRAW_FRAME::handleActivateEvent().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protectedinherited

Handle the auto save timer event.

Definition at line 303 of file eda_base_frame.cpp.

{
 if( !doAutoSave() )
 m_autoSaveTimer->Start( GetAutoSaveInterval() * 1000, wxTIMER_ONE_SHOT );
}

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

Referenced by EDA_BASE_FRAME::commonInit().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent & aKeyEvent )

virtualinherited

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

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

Reimplemented in SYMBOL_VIEWER_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 316 of file eda_base_frame.cpp.

{
 wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( aKeyEvent ) );
 
 // Key events can be filtered here.
 // Currently no filtering is made.
 aKeyEvent.Skip();
}

References dump(), and kicadTraceKeyEvent.

◆ OnClearDrlFileHistory()

void GERBVIEW_FRAME::OnClearDrlFileHistory ( wxCommandEvent & aEvent )

private

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

{
 ClearFileHistory( &m_drillFileHistory );
}

References EDA_BASE_FRAME::ClearFileHistory(), and m_drillFileHistory.

◆ OnClearGbrFileHistory()

void GERBVIEW_FRAME::OnClearGbrFileHistory ( wxCommandEvent & aEvent )

private

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

{
 ClearFileHistory();
}

References EDA_BASE_FRAME::ClearFileHistory().

◆ OnClearJobFileHistory()

void GERBVIEW_FRAME::OnClearJobFileHistory ( wxCommandEvent & aEvent )

private

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

{
 ClearFileHistory( &m_jobFileHistory );
}

References EDA_BASE_FRAME::ClearFileHistory(), and m_jobFileHistory.

◆ OnClearZipFileHistory()

void GERBVIEW_FRAME::OnClearZipFileHistory ( wxCommandEvent & aEvent )

private

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

{
 ClearFileHistory( &m_zipFileHistory );
}

References EDA_BASE_FRAME::ClearFileHistory(), and m_zipFileHistory.

◆ OnDrlFileHistory()

void GERBVIEW_FRAME::OnDrlFileHistory ( wxCommandEvent & event )

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

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

{
 wxString fn;
 
 fn = GetFileFromHistory( event.GetId(), _( "Drill files" ), &m_drillFileHistory );
 
 if( !fn.IsEmpty() )
 {
 LoadExcellonFiles( fn );
 }
}

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

◆ OnDropFiles()

void EDA_BASE_FRAME::OnDropFiles ( wxDropFilesEvent & aEvent )

protectedvirtualinherited

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

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

Definition at line 1118 of file eda_base_frame.cpp.

{
 wxString* files = aEvent.GetFiles();
 for( int nb = 0; nb < aEvent.GetNumberOfFiles(); nb++ )
 {
 const wxFileName fn = wxFileName( files[nb] );
 for( const auto& [ext, tool] : m_acceptedExts )
 {
 if( IsExtensionAccepted( fn.GetExt(), { ext.ToStdString() } ) )
 {
 m_AcceptedFiles.emplace( m_AcceptedFiles.end(), fn );
 break;
 }
 }
 }
 DoWithAcceptedFiles();
 m_AcceptedFiles.clear();
}

References EDA_BASE_FRAME::DoWithAcceptedFiles(), IsExtensionAccepted(), EDA_BASE_FRAME::m_acceptedExts, and EDA_BASE_FRAME::m_AcceptedFiles.

◆ OnGbrFileHistory()

void GERBVIEW_FRAME::OnGbrFileHistory ( wxCommandEvent & event )

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

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

{
 wxString fn;
 
 fn = GetFileFromHistory( event.GetId(), _( "Gerber files" ) );
 
 if( !fn.IsEmpty() )
 {
 LoadGerberFiles( fn );
 }
}

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

◆ OnGridSettings()

void EDA_DRAW_FRAME::OnGridSettings ( wxCommandEvent & event )

inherited

Definition at line 450 of file eda_draw_frame.cpp.

{
 DIALOG_GRID_SETTINGS dlg( this );
 
 if( dlg.ShowModal() == wxID_OK )
 {
 UpdateStatusBar();
 GetCanvas()->Refresh();
 }
}

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

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent & aEvent )

protectedinherited

Definition at line 1387 of file eda_base_frame.cpp.

{
 // Call the handler
 handleIconizeEvent( aEvent );
 
 // Skip the event.
 aEvent.Skip();
}

References EDA_BASE_FRAME::handleIconizeEvent().

◆ OnJobFileHistory()

void GERBVIEW_FRAME::OnJobFileHistory ( wxCommandEvent & event )

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

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

{
 wxString filename = GetFileFromHistory( event.GetId(), _( "Job files" ), &m_jobFileHistory );
 
 if( !filename.IsEmpty() )
 LoadGerberJobFile( filename );
}

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

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

Definition at line 966 of file eda_base_frame.cpp.

{
 void ShowAboutDialog( EDA_BASE_FRAME * aParent ); // See AboutDialog_main.cpp
 ShowAboutDialog( this );
}

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

inherited

Definition at line 1313 of file eda_base_frame.cpp.

{
 // When we maximize the window, we want to save the old information
 // so that we can add it to the settings on next window load.
 // Contrary to the documentation, this event seems to be generated
 // when the window is also being unmaximized on OSX, so we only
 // capture the size information when we maximize the window when on OSX.
#ifdef __WXOSX__
 if( !IsMaximized() )
#endif
 {
 m_normalFrameSize = GetWindowSize();
 m_normalFramePos = GetPosition();
 wxLogTrace( traceDisplayLocation,
 "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
 m_normalFramePos.x, m_normalFramePos.y,
 m_normalFrameSize.x, m_normalFrameSize.y );
 }
 
 // Skip event to actually maximize the window
 aEvent.Skip();
}

References EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, and traceDisplayLocation.

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent & event )

inherited

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

Definition at line 326 of file eda_base_frame.cpp.

{
 if( !m_toolDispatcher )
 aEvent.Skip();
 else

aFileName	The full path and/or file name of the file to test.
aVerbose	If true will show an error dialog if the file is not writable

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ HOLDER_TYPE

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ GERBVIEW_FRAME()

◆ ~GERBVIEW_FRAME()

Member Function Documentation

◆ ActivateGalCanvas()

◆ AddStandardHelpMenu()

◆ AddStandardSubMenus()

◆ AppendMsgPanel()

◆ ApplyDisplaySettingsToGAL()

◆ canCloseWindow()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ Clear_DrawLayers()

◆ ClearFileHistory()

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ commonInit()

◆ CommonSettingsChanged()

◆ config()

◆ ConfigBaseName()

◆ CreateInfoBar()

◆ CreateServer()

◆ CurrentToolName()

◆ Destroy()

◆ DismissModal()

◆ DisplayConstraintsMsg()

◆ DisplayGridMsg()

◆ DisplayToolMsg()

◆ DisplayUnitsMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ DoWithAcceptedFiles()

◆ ensureWindowIsOnScreen()

◆ Erase_Current_DrawLayer()

◆ EraseMsgBox()

◆ ExecuteRemoteCommand()

◆ findDialogs()

◆ findQuasiModalDialog()

◆ FinishAUIInitialization()

◆ FocusOnLocation()

◆ GetAboutTitle()

◆ GetActiveLayer()

◆ GetAutoSaveFilePrefix()

◆ GetAutoSaveInterval()

◆ GetCanvas()

◆ GetColorSettings()

◆ GetCurrentFileName()

◆ GetCurrentSelection()

◆ GetDisplayMode()

◆ GetDocumentExtents()

◆ GetDoImmediateActions()

◆ GetDragAction()

◆ GetDrawBgColor()

◆ GetFileFromHistory()

◆ GetFileHistory()

◆ GetFindHistoryList()

◆ GetFindReplaceData()

◆ GetFrameType()

◆ GetGalDisplayOptions()

◆ GetGbrImage()

◆ GetGerberLayout()

◆ GetGridColor()

◆ GetGridOrigin()

◆ GetImagesList()

◆ GetInfoBar()