GERBVIEW_FRAME Class Reference

#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, const std::vector< int > *aFileType=nullptr)
	Load a list of Gerber and NC drill files and updates the view based on them. More...
void	ReCreateHToolbar () override
void	ReCreateAuxiliaryToolbar () override
void	ReCreateVToolbar () override
	Create or update the right vertical toolbar. More...
void	ReCreateOptToolbar () override
	Create or update the left vertical toolbar (option toolbar) More...
void	ReCreateMenuBar () override
	Recreates the menu bar. More...
void	UpdateStatusBar () override
	Update the status bar information. More...
void	UpdateToolbarControlSizes () override
	Update the sizes of any controls in the toolbars of the frame. More...
int	GetDisplayMode ()
void	SetDisplayMode (int aMode)
bool	IsElementVisible (int aLayerID) const
	Test whether a given element category is visible. More...
void	SetElementVisibility (int aLayerID, bool aNewState)
	Change the visibility of an element category. More...
void	SetGridVisibility (bool aVisible) override
LSET	GetVisibleLayers () const
	A proxy function that calls the correspondent function in m_BoardSettings. More...
void	SetVisibleLayers (LSET aLayerMask)
	A proxy function that calls the correspondent function in m_BoardSettings. More...
bool	IsLayerVisible (int aLayer) const
	Test whether a given layer is visible. More...
COLOR4D	GetVisibleElementColor (int aLayerID)
	Return the color of a gerber visible element. More...
void	SetVisibleElementColor (int aLayerID, const COLOR4D &aColor)
COLOR4D	GetLayerColor (int aLayer) const
void	SetLayerColor (int aLayer, const COLOR4D &aColor)
COLOR4D	GetNegativeItemsColor ()
	This is usually the background color, but can be another color in order to see negative objects. More...
void	ReFillLayerWidget ()
	Change out all the layers in m_Layers; called upon loading new gerber files. More...
void	SetActiveLayer (int aLayer, bool doLayerWidgetUpdate=true)
	change the currently active layer to aLayer and update the GERBER_LAYER_WIDGET. More...
int	GetActiveLayer () const
	Return the active layer. More...
int	getNextAvailableLayer (int aLayer=0) const
	Find the next empty layer starting at aLayer and returns it to the caller. More...
void	syncLayerWidget ()
	Update the currently "selected" layer within the GERBER_LAYER_WIDGET. More...
void	syncLayerBox (bool aRebuildLayerBox=false)
	Update the currently "selected" layer within m_SelLayerBox. More...
void	UpdateTitleAndInfo ()
	Display the short filename (if exists) of the selected layer on the caption of the main GerbView window and some other parameters. More...
void	DisplayGridMsg () override
	Display the current grid pane on the status bar. More...
void	LoadSettings (APP_SETTINGS_BASE *aCfg) override
	Load common frame parameters from a configuration file. More...
void	SaveSettings (APP_SETTINGS_BASE *aCfg) override
	Save common frame parameters to a configuration data file. More...
void	ToggleLayerManager ()
void	ShowChangedLanguage () override
void	OnSelectHighlightChoice (wxCommandEvent &event)
	Handles the changing of the highlighted component/net/attribute. More...
void	OnSelectActiveDCode (wxCommandEvent &event)
	Select the active DCode for the current active layer. More...
void	OnSelectActiveLayer (wxCommandEvent &event)
	Select the active layer: More...
void	OnSelectDisplayMode (wxCommandEvent &event)
	Called on a display mode selection. More...
void	OnQuit (wxCommandEvent &event)
	Called on request of application quit. More...
void	OnUpdateDrawMode (wxUpdateUIEvent &aEvent)
void	OnUpdateSelectDCode (wxUpdateUIEvent &aEvent)
void	OnUpdateLayerSelectBox (wxUpdateUIEvent &aEvent)
void	OnGbrFileHistory (wxCommandEvent &event)
	Delete the current data and loads a Gerber file selected from history list on current layer. More...
void	OnDrlFileHistory (wxCommandEvent &event)
	Delete the current data and load a drill file in Excellon format selected from history list on current layer. More...
void	OnZipFileHistory (wxCommandEvent &event)
	Delete the current data and load a zip archive file selected from the history list. More...
void	OnJobFileHistory (wxCommandEvent &event)
	Delete the current data and load a gerber job file selected from the history list. More...
bool	unarchiveFiles (const wxString &aFullFileName, REPORTER *aReporter=nullptr)
	Extract gerber and drill files from the zip archive, and load them. More...
bool	LoadGerberFiles (const wxString &aFileName)
	Load a given Gerber file or selected file(s), if the filename is empty. More...
bool	Read_GERBER_File (const wxString &GERBER_FullFileName)
bool	LoadExcellonFiles (const wxString &aFileName)
	Load a drill (EXCELLON) file or many files. More...
bool	Read_EXCELLON_File (const wxString &aFullFileName)
bool	LoadZipArchiveFile (const wxString &aFileName)
	Load a zipped archive file. More...
bool	LoadGerberJobFile (const wxString &aFileName)
	Load a Gerber job file, and load gerber files found in job files. More...
bool	Clear_DrawLayers (bool query)
void	Erase_Current_DrawLayer (bool query)
void	SortLayersByX2Attributes ()
void	UpdateDiffLayers ()
	Update each layers' differential option. More...
void	UpdateDisplayOptions (const GBR_DISPLAY_OPTIONS &aOptions)
	Update the display options and refreshes the view as needed. More...
void	SaveCopyInUndoList (GERBER_DRAW_ITEM *aItemToCopy, UNDO_REDO aTypeCommand=UNDO_REDO::UNSPECIFIED)
void	SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand)
	Create a new entry in undo list of commands and add a list of pickers to handle a list of items. More...
void	ActivateGalCanvas () override
	Use to start up the GAL drawing canvas. More...
void	InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
	Allow Gerbview to install its preferences panels into the preferences dialog. More...
void	CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
	Called after the preferences dialog is run. More...
SELECTION &	GetCurrentSelection () override
	Get the current selection from the canvas area. More...
const GBR_DISPLAY_OPTIONS &	GetDisplayOptions () const
void	SetDisplayOptions (const GBR_DISPLAY_OPTIONS &aOptions)
void	SetLayout (GBR_LAYOUT *aLayout)
	Set the m_gerberLayout member in such as way as to ensure deleting any previous GBR_LAYOUT. More...
GBR_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 wxPoint &	GetGridOrigin () const override
	Return the absolute coordinates of the origin of the snap grid. More...
void	SetGridOrigin (const wxPoint &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...
wxFindReplaceData &	GetFindReplaceData ()
wxArrayString &	GetFindHistoryList ()
bool	GetShowPolarCoords () const
	For those frames that support polar coordinates. More...
void	SetShowPolarCoords (bool aShow)
void	ToggleUserUnits () override
void	GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
	Get the pair or units in current use. More...
wxPoint	GetNearestGridPosition (const wxPoint &aPosition) const
	Return the nearest aGridSize location to aPosition. More...
wxPoint	GetNearestHalfGridPosition (const wxPoint &aPosition) const
	Return the nearest aGridSize / 2 location to aPosition. More...
virtual ORIGIN_TRANSFORMS &	GetOriginTransforms ()
	Return a reference to the default ORIGIN_TRANSFORMS object. More...
virtual COLOR4D	GetDrawBgColor () const
virtual void	SetDrawBgColor (const COLOR4D &aColor)
virtual COLOR_SETTINGS *	GetColorSettings () const
	Returns a pointer to the active color theme settings. More...
bool	ShowPageLimits () const
void	SetShowPageLimits (bool aShow)
bool	LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
virtual wxString	GetScreenDesc () const
virtual BASE_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 combobox. More...
void	UpdateZoomSelectBox ()
	Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
void	OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
	Update the checked item in the zoom combobox. More...
const wxString	GetZoomLevelIndicator () const
	Return a human readable value for display in dialogs. More...
virtual void	OnSelectZoom (wxCommandEvent &event)
	Set the zoom factor when selected by the zoom list box in the main tool bar. More...
virtual void	OnSize (wxSizeEvent &event) override
	Recalculate the size of toolbars and display panel when the frame size changes. More...
void	OnMove (wxMoveEvent &aEvent) override
virtual void	HardRedraw ()
	Rebuild the GAL and redraws the screen. More...
virtual void	Zoom_Automatique (bool aWarpPointer)
	Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...
void	FocusOnLocation (const wxPoint &aPos)
	Useful to focus on a particular location, in find functions. More...
void	AddStandardSubMenus (TOOL_MENU &aMenu)
	Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g. More...
void	PrintDrawingSheet (const RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
	Prints the drawing-sheet (frame and title block). More...
void	DisplayToolMsg (const wxString &msg) override
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...
EDA_UNITS	GetUserUnits () const
	Return the user units currently in use. More...
void	SetUserUnits (EDA_UNITS aUnits)
void	ChangeUserUnits (EDA_UNITS aUnits)
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)
void	SetAutoSaveInterval (int aInterval)
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)
	Checks if aFileName can be written. More...
void	CheckForAutoSaveFile (const wxFileName &aFileName)
	Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
virtual void	ThemeChanged ()
	Process light/dark theme change. More...
virtual void	ProjectChanged ()
	Notification event that the project has changed. More...
const wxString &	GetAboutTitle () const
virtual bool	IsContentModified () 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 std::string &actionName)
	NB: the definition of "tool" is different at the user level. More...
virtual void	PopTool (const std::string &actionName)
bool	ToolStackIsEmpty ()
std::string	CurrentToolName () const
bool	IsCurrentTool (const TOOL_ACTION &aAction) const
bool	GetDoImmediateActions () const
	Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...
MOUSE_DRAG_ACTION	GetDragAction () const
	Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...
bool	GetMoveWarpsCursor () const
	Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...
HOLDER_TYPE	GetType () const
KIWAY &	Kiway () const
	Return a reference to the KIWAY that this object has an opportunity to participate in. 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...

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

Protected Member Functions
void	setupUIConditions () override
	Setup the UI conditions for the various actions and their controls in this frame. More...
virtual void	SetScreen (BASE_SCREEN *aScreen)
void	setupUnits (APP_SETTINGS_BASE *aCfg)
void	resolveCanvasType ()
	Determines the Canvas type to load (with prompt if required) and initializes m_canvasType. More...
EDA_DRAW_PANEL_GAL::GAL_TYPE	loadCanvasTypeSetting ()
	Returns the canvas type stored in the application settings. More...
bool	saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
	Stores the canvas type in the application settings. More...
virtual void	handleActivateEvent (wxActivateEvent &aEvent)
	Handle a window activation event. More...
void	onActivate (wxActivateEvent &aEvent)
void	kiway_express (KIWAY_EXPRESS &aEvent)
	event handler, routes to derivative specific virtual KiwayMailIn() More...
void	language_change (wxCommandEvent &event)
	An event handler called on a language menu selection. More...
void	onAutoSaveTimer (wxTimerEvent &aEvent)
	Handle the auto save timer event. More...
virtual bool	isAutoSaveRequired () const
	Return the auto save status of the application. More...
virtual bool	doAutoSave ()
	This should be overridden by the derived class to handle the auto save feature. More...
virtual bool	canCloseWindow (wxCloseEvent &aCloseEvent)
void	onSystemColorChange (wxSysColourChangedEvent &aEvent)
void	initExitKey ()
	Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
void	ensureWindowIsOnScreen ()

Static Protected Member Functions
static wxString	GetAutoSaveFilePrefix ()

Protected Attributes
GERBER_LAYER_WIDGET *	m_LayersManager
FILE_HISTORY	m_zipFileHistory
FILE_HISTORY	m_drillFileHistory
FILE_HISTORY	m_jobFileHistory
wxString	m_lastFileName
wxSocketServer *	m_socketServer
std::vector< wxSocketBase * >	m_sockets
	interprocess communication More...
std::unique_ptr< wxSingleInstanceChecker >	m_file_checker
bool	m_showPageLimits
COLOR4D	m_gridColor
COLOR4D	m_drawBgColor
int	m_undoRedoCountMax
bool	m_polarCoords
bool	m_showBorderAndTitleBlock
long	m_firstRunDialogSetting
wxChoice *	m_gridSelectBox
wxChoice *	m_zoomSelectBox
ACTION_TOOLBAR *	m_mainToolBar
ACTION_TOOLBAR *	m_auxiliaryToolBar
ACTION_TOOLBAR *	m_drawToolBar
ACTION_TOOLBAR *	m_optionsToolBar
wxFindReplaceData *	m_findReplaceData
wxArrayString	m_findStringHistoryList
wxArrayString	m_replaceStringHistoryList
EDA_MSG_PANEL *	m_messagePanel
int	m_msgFrameHeight
COLOR_SETTINGS *	m_colorSettings
	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
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_hasAutoSave
bool	m_autoSaveState
int	m_autoSaveInterval
wxTimer *	m_autoSaveTimer
UNDO_REDO_CONTAINER	m_undoList
UNDO_REDO_CONTAINER	m_redoList
wxString	m_mruPath
EDA_UNITS	m_userUnits
	Map containing the UI update handlers registered with wx for each action. More...
std::map< int, UIUpdateHandler >	m_uiUpdateMap
	Set by the close window event handler after frames are asked if they can close. More...
bool	m_isClosing
	Set by NonUserClose() to indicate that the user did not request the current close. More...
bool	m_isNonUserClose
TOOL_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	setupTools ()
void	applyDisplaySettingsToGAL ()
	Updates the GAL with display settings changes. More...

Private Attributes
int	m_displayMode
bool	m_show_layer_manager_tools
GBR_LAYOUT *	m_gerberLayout
int	m_activeLayer
wxPoint	m_grid_origin
PAGE_INFO	m_paper
GBR_DISPLAY_OPTIONS	m_DisplayOptions
wxStaticText *	m_cmpText
wxStaticText *	m_netText
wxStaticText *	m_apertText
wxStaticText *	m_dcodeText

Detailed Description

Definition at line 54 of file gerbview_frame.h.

Member Enumeration Documentation

HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

{ DIALOG, FRAME, PANEL };

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

        : EDA_DRAW_FRAME( aKiway, aParent, FRAME_GERBER, wxT( "GerbView" ), wxDefaultPosition,
                          wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE, GERBVIEW_FRAME_NAME ),
          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() ) );

    // 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

    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(), PCAD2KICAD::Center, EDA_BASE_FRAME::config(), dummy(), EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, LAYER_WIDGET::GetBestSize(), EDA_DRAW_FRAME::GetCanvas(), GERBER_FILE_IMAGE_LIST::GetDisplayName(), EDA_DRAW_FRAME::GetGalDisplayOptions(), GetImagesList(), GetPageSettings(), TOOLS_HOLDER::GetToolManager(), icon_gerbview, icon_gerbview_16, icon_gerbview_32, ImagesMaxCount(), KiBitmap(), PCAD2KICAD::Left, LoadSettings(), EDA_BASE_FRAME::m_aboutTitle, m_apertText, EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_auxiliaryToolBar, EDA_DRAW_FRAME::m_canvasType, m_cmpText, m_DCodeSelector, m_dcodeText, m_displayMode, m_drillFileHistory, EDA_BASE_FRAME::m_frameSize, m_gerberLayout, m_jobFileHistory, m_LayersManager, EDA_DRAW_FRAME::m_mainToolBar, EDA_BASE_FRAME::m_maximizeByDefault, EDA_DRAW_FRAME::m_messagePanel, m_netText, EDA_DRAW_FRAME::m_optionsToolBar, m_SelAperAttributesBox, m_SelComponentBox, m_SelLayerBox, m_SelNetnameBox, m_show_layer_manager_tools, EDA_DRAW_FRAME::m_showBorderAndTitleBlock, m_zipFileHistory, Pgm(), ReCreateAuxiliaryToolbar(), ReCreateHToolbar(), ReCreateMenuBar(), ReCreateOptToolbar(), GERBER_LAYER_WIDGET::ReFill(), ReFillLayerWidget(), GERBER_LAYER_WIDGET::ReFillRender(), EDA_DRAW_FRAME::resolveCanvasType(), PCAD2KICAD::Right, TOOL_MANAGER::RunAction(), SetActiveLayer(), EDA_DRAW_FRAME::SetCanvas(), SetLayout(), FILE_HISTORY::SetMaxFiles(), SetPageSettings(), EDA_DRAW_FRAME::SetScreen(), LAYER_WIDGET::SetSmallestLayerString(), setupTools(), setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), SetVisibleLayers(), EDA_DRAW_FRAME::SwitchCanvas(), UpdateToolbarControlSizes(), and ACTIONS::zoomFitScreen.

~GERBVIEW_FRAME()

GERBVIEW_FRAME::~GERBVIEW_FRAME

(

)

Definition at line 205 of file gerbview_frame.cpp.

{
    // 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 1023 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 440 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(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU &  aMenu )

inherited

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

zoom and grid).

Definition at line 489 of file eda_draw_frame.cpp.

{
    COMMON_TOOLS*     commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
    CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();

    aMenu.AddSeparator( 1000 );

    auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
    zoomMenu->SetTool( commonTools );
    aToolMenu.AddSubMenu( zoomMenu );

    auto gridMenu = std::make_shared<GRID_MENU>( this );
    gridMenu->SetTool( commonTools );
    aToolMenu.AddSubMenu( gridMenu );

    aMenu.AddMenu( zoomMenu.get(),   SELECTION_CONDITIONS::ShowAlways, 1000 );
    aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
}

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

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

AppendMsgPanel()

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

inherited

Append a message to the message panel.

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

Parameters

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

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

private

Updates the GAL with display settings changes.

Definition at line 457 of file gerbview_frame.cpp.

{
    auto painter = static_cast<KIGFX::GERBVIEW_PAINTER*>( GetCanvas()->GetView()->GetPainter() );
    KIGFX::GERBVIEW_RENDER_SETTINGS* settings = painter->GetSettings();
    settings->LoadDisplayOptions( m_DisplayOptions );
    settings->LoadColors( Pgm().GetSettingsManager().GetColorSettings() );

    GetCanvas()->GetView()->MarkTargetDirty( KIGFX::TARGET_NONCACHED );
}

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

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

canCloseWindow()

virtual bool EDA_BASE_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent )

inlineprotectedvirtualinherited

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

Definition at line 625 of file eda_base_frame.h.

{ return true; }

Referenced by EDA_BASE_FRAME::windowClosing().

ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits )

inherited

Definition at line 1181 of file eda_base_frame.cpp.

{
    SetUserUnits( aUnits );
    unitsChangeRefresh();

    wxCommandEvent e( UNITS_CHANGED );
    ProcessEventLocally( e );
}

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

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

CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName &  aFileName )

inherited

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

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

Parameters

aFileName

A wxFileName object containing the file name to check.

Definition at line 1069 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(), and SCH_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( EDA_RECT() );

    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 956 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(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), SCH_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 651 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 544 of file eda_base_frame.h.

    { }

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 1132 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(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), PL_EDITOR_FRAME::OnNewDrawingSheet(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and 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 1193 of file gerbview_frame.cpp.

{
    EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );

    RecreateToolbars();
    Layout();
    SendSizeEvent();
}

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

config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const

virtualinherited

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

Reimplemented in SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 796 of file eda_base_frame.cpp.

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

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

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

ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )

inlineoverridevirtualinherited

Get the configuration base name.

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

Returns

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

Reimplemented from TOOLS_HOLDER.

Definition at line 358 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 821 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 );

    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 100 of file tools_holder.cpp.

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

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

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

Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

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

Definition at line 154 of file kiway_player.cpp.

{
    return EDA_BASE_FRAME::Destroy();
}

Referenced by DISPLAY_FOOTPRINTS_FRAME::doCloseWindow(), doCloseWindow(), SYMBOL_VIEWER_FRAME::doCloseWindow(), PL_EDITOR_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_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 166 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().

DisplayGridMsg()

void GERBVIEW_FRAME::DisplayGridMsg ( )

overridevirtual

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 943 of file gerbview_frame.cpp.

{
    wxString line;

    line.Printf( "grid X %s  Y %s",
                 MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x ),
                 MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().y ) );

    SetStatusText( line, 4 );
}

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

Referenced by UpdateStatusBar().

DisplayToolMsg()

void EDA_DRAW_FRAME::DisplayToolMsg ( const wxString &  msg )

overridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 509 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 527 of file eda_draw_frame.cpp.

{
    wxString msg;

    switch( m_userUnits )
    {
    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 _, INCHES, EDA_BASE_FRAME::m_userUnits, MILLIMETRES, and MILS.

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

doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )

protectedvirtualinherited

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

Returns

true if the auto save was successful otherwise false.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

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

ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 637 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 );

    GetImagesList()->DeleteImage( layer );

    ReFillLayerWidget();
    syncLayerBox();
    GetCanvas()->Refresh();
}

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

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

EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )

inherited

Definition at line 284 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.

{}

Referenced by KIWAY_PLAYER::OnSockRequest().

FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 833 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 wxPoint &  aPos )

inherited

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

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

Parameters

aPos	is the point to go to.

Definition at line 846 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;

    // Center if we're behind an obscuring dialog, or within 10% of its edge
    wxWindow* dialog = findDialog( GetChildren() );

    if( dialog )
    {
        wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
                           dialog->GetSize() );
        dialogRect.Inflate( dialogRect.GetWidth() / 10 );

        if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
            centerView = true;
    }

    if( centerView )
    {
        // If a dialog partly obscures the window, then center on the uncovered area.
        if( dialog )
        {
            BOX2D dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
                              dialog->GetSize() );
            GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
        }
        else
            GetCanvas()->GetView()->SetCenter( aPos );
    }

    GetCanvas()->GetViewControls()->SetCrossHairCursorPosition( aPos );
}

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

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

GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 513 of file eda_base_frame.h.

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

{ return m_activeLayer; }

References m_activeLayer.

Referenced by Erase_Current_DrawLayer(), GERBVIEW_CONTROL::HighlightControl(), GERBVIEW_CONTROL::LayerNext(), GERBVIEW_CONTROL::LayerPrev(), LoadExcellonFiles(), LoadListOfGerberAndDrillFiles(), LoadZipArchiveFile(), 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 601 of file eda_base_frame.h.

    {
        return wxT( "_autosave-" );
    }

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

GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inlineinherited

Definition at line 204 of file eda_base_frame.h.

{ return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

GetCanvas()

virtual EDA_DRAW_PANEL_GAL* EDA_DRAW_FRAME::GetCanvas ( ) const

inlinevirtualinherited

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

Returns

Pointer to GAL-based canvas.

Reimplemented in PCB_BASE_FRAME, PL_EDITOR_FRAME, and SCH_BASE_FRAME.

Definition at line 422 of file eda_draw_frame.h.

{ return m_canvas; }

References EDA_DRAW_FRAME::m_canvas.

Referenced by ActivateGalCanvas(), EDA_DRAW_FRAME::ActivateGalCanvas(), applyDisplaySettingsToGAL(), GERBVIEW_CONTROL::canvas(), COMMON_TOOLS::CenterContents(), Clear_DrawLayers(), EDA_DRAW_FRAME::CommonSettingsChanged(), DIALOG_PRINT_GERBVIEW::createPrintout(), DisplayGridMsg(), EDA_DRAW_FRAME::DisplayGridMsg(), doCloseWindow(), COMMON_TOOLS::doZoomFit(), Erase_Current_DrawLayer(), EDA_DRAW_FRAME::FocusOnLocation(), GERBVIEW_FRAME(), SCH_BASE_FRAME::GetCanvas(), PL_EDITOR_FRAME::GetCanvas(), PCB_BASE_FRAME::GetCanvas(), EDA_DRAW_FRAME::GetNearestGridPosition(), EDA_DRAW_FRAME::GetNearestHalfGridPosition(), EDA_DRAW_FRAME::GetToolCanvas(), GetVisibleLayers(), LoadListOfGerberAndDrillFiles(), ZOOM_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), STATUS_POPUP::onCharHook(), EDA_DRAW_FRAME::OnGridSettings(), GERBER_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerSelect(), GERBER_LAYER_WIDGET::OnLayerVisible(), EDA_DRAW_FRAME::OnMove(), GERBER_LAYER_WIDGET::onPopupSelection(), GERBER_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderEnable(), OnSelectActiveDCode(), OnSelectActiveLayer(), OnSelectDisplayMode(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), Read_EXCELLON_File(), Read_GERBER_File(), GERBER_LAYER_WIDGET::ReFill(), EDA_DRAW_FRAME::RefreshCanvas(), EDA_DRAW_FRAME::resolveCanvasType(), SaveCanvasImageToFile(), ZOOM_TOOL::selectRegion(), SetActiveLayer(), SetElementVisibility(), SetGridColor(), EDA_DRAW_FRAME::SetGridVisibility(), SetPageSettings(), setupTools(), SetVisibleLayers(), SortLayersByX2Attributes(), EDA_DRAW_FRAME::SwitchCanvas(), PANEL_GAL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), GAL_OPTIONS_PANEL::TransferDataFromWindow(), GAL_OPTIONS_PANEL::TransferDataToWindow(), unarchiveFiles(), ZOOM_MENU::update(), UpdateDiffLayers(), UpdateDisplayOptions(), UpdateStatusBar(), and ~GERBVIEW_FRAME().

GetColorSettings()

COLOR_SETTINGS * EDA_DRAW_FRAME::GetColorSettings ( ) const

virtualinherited

Returns a pointer to the active color theme settings.

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

Definition at line 1020 of file eda_draw_frame.cpp.

{
    if( !m_colorSettings )
    {
        COLOR_SETTINGS* colorSettings = Pgm().GetSettingsManager().GetColorSettings();

        const_cast<EDA_DRAW_FRAME*>( this )->m_colorSettings = colorSettings;
    }

    return m_colorSettings;
}

References EDA_DRAW_FRAME::m_colorSettings, and Pgm().

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

GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const

inlinevirtualinherited

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

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

Returns

the filename and full path to the open file

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 439 of file eda_base_frame.h.

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

{ return m_displayMode; }

References m_displayMode.

Referenced by OnUpdateDrawMode().

GetDisplayOptions()

const GBR_DISPLAY_OPTIONS& GERBVIEW_FRAME::GetDisplayOptions ( ) const

inline

Definition at line 397 of file gerbview_frame.h.

{ return m_DisplayOptions; }

References m_DisplayOptions.

Referenced by GERBVIEW_CONTROL::DisplayControl(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), GERBVIEW_SELECTION_TOOL::selectable(), PANEL_GERBVIEW_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_GERBVIEW_SETTINGS::TransferDataToWindow(), and PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataToWindow().

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

{ return m_immediateActions; }

References TOOLS_HOLDER::m_immediateActions.

GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

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

Definition at line 135 of file tools_holder.h.

{ return m_dragAction; }

References TOOLS_HOLDER::m_dragAction.

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

GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const

inlinevirtualinherited

Reimplemented in SCH_BASE_FRAME.

Definition at line 173 of file eda_draw_frame.h.

{ return m_drawBgColor; }

References EDA_DRAW_FRAME::m_drawBgColor.

Referenced by GetNegativeItemsColor(), PLEDITOR_PRINTOUT::PrintPage(), 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 916 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 423 of file eda_base_frame.h.

    {
        return *m_fileHistory;
    }

References EDA_BASE_FRAME::m_fileHistory.

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

GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )

inlineinherited

Definition at line 106 of file eda_draw_frame.h.

{ return m_findStringHistoryList; }

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

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )

inlineinherited

Definition at line 105 of file eda_draw_frame.h.

{ return *m_findReplaceData; }

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

{ return m_ident; }

References EDA_BASE_FRAME::m_ident.

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

{ return m_galDisplayOptions; }

References EDA_DRAW_FRAME::m_galDisplayOptions.

Referenced by SCH_BASE_FRAME::createCanvas(), EDITOR_CONDITIONS::cursorFunc(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME(), SYMBOL_VIEWER_FRAME::LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), DIALOG_PAD_PROPERTIES::prepareCanvas(), FOOTPRINT_EDIT_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), SYMBOL_EDIT_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 1002 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(), LoadListOfGerberAndDrillFiles(), 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 929 of file gerbview_frame.cpp.

{
    return Pgm().GetSettingsManager().GetColorSettings()->GetColor( LAYER_GRID );
}

References LAYER_GRID, and Pgm().

Referenced by GetVisibleElementColor().

GetGridOrigin()

const wxPoint& GERBVIEW_FRAME::GetGridOrigin ( ) const

inlineoverridevirtual

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

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

Implements EDA_DRAW_FRAME.

Definition at line 434 of file gerbview_frame.h.

{ return m_grid_origin; }

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(), LoadGerberFiles(), Read_GERBER_File(), GERBVIEW_CONTROL::ReloadAllLayers(), 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 234 of file eda_base_frame.h.

{ return m_infoBar; }

References EDA_BASE_FRAME::m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), APPEARANCE_CONTROLS::onReadOnlySwatch(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SYMBOL_EDIT_FRAME::SetCurSymbol(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), EDA_BASE_FRAME::ShowInfoBarWarning(), SCH_DRAWING_TOOLS::SingleClickPlace(), and PCB_CONTROL::unfilledZoneCheck().

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

{ return nullptr; }

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

GetLayerColor()

COLOR4D GERBVIEW_FRAME::GetLayerColor

(

int

aLayer

)

const

Definition at line 841 of file gerbview_frame.cpp.

{
    return Pgm().GetSettingsManager().GetColorSettings()->GetColor( aLayer );
}

References Pgm().

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

GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 581 of file eda_base_frame.h.

{ return m_undoRedoCountMax; }

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

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

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

Definition at line 141 of file tools_holder.h.

{ return m_moveWarpsCursor; }

References TOOLS_HOLDER::m_moveWarpsCursor.

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

GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 430 of file eda_base_frame.h.

{ 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(), KICAD_MANAGER_CONTROL::NewProject(), KICAD_MANAGER_CONTROL::OpenProject(), SCH_EDIT_FRAME::SaveProject(), and KICAD_MANAGER_CONTROL::SaveProjectAs().

GetNearestGridPosition()

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

inherited

Return the nearest aGridSize location to aPosition.

Parameters

aPosition

The position to check.

Returns

The nearest grid position.

Definition at line 787 of file eda_draw_frame.cpp.

{
    const wxPoint& 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 wxPoint( 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 SYMBOL_EDITOR_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), and SCH_DRAWING_TOOLS::sizeSheet().

GetNearestHalfGridPosition()

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

inherited

Return the nearest aGridSize / 2 location to aPosition.

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

Parameters

aPosition

The position to check.

Returns

The nearest half-grid position.

Definition at line 801 of file eda_draw_frame.cpp.

{
    const wxPoint& 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 wxPoint( 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 SYMBOL_EDITOR_EDIT_TOOL::Mirror(), and SCH_EDIT_TOOL::Mirror().

GetNegativeItemsColor()

COLOR4D GERBVIEW_FRAME::GetNegativeItemsColor

(

)

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

Returns

the color of negative items.

Definition at line 832 of file gerbview_frame.cpp.

{
    if( IsElementVisible( LAYER_NEGATIVE_OBJECTS ) )
        return GetVisibleElementColor( LAYER_NEGATIVE_OBJECTS );
    else
        return GetDrawBgColor();
}

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

getNextAvailableLayer()

int GERBVIEW_FRAME::getNextAvailableLayer

(

int

aLayer = 0

)

const

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

If no empty layers are found, NO_AVAILABLE_LAYERS is return.

Parameters

aLayer

The first layer to search.

Returns

The first empty layer found or NO_AVAILABLE_LAYERS.

Definition at line 468 of file gerbview_frame.cpp.

{
    int layer = aLayer;

    for( unsigned i = 0; i < ImagesMaxCount(); ++i )
    {
        const GERBER_FILE_IMAGE* gerber = GetGbrImage( layer );

        if( gerber == nullptr )    // this graphic layer is available: use it
            return layer;

        ++layer;                // try next graphic layer

        if( layer >= (int)ImagesMaxCount() )
            layer = 0;
    }

    return NO_AVAILABLE_LAYERS;
}

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

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

GetOriginTransforms()

virtual ORIGIN_TRANSFORMS& EDA_DRAW_FRAME::GetOriginTransforms ( )

inlinevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented in PCB_BASE_FRAME.

Definition at line 164 of file eda_draw_frame.h.

    { return m_originTransforms; }

References EDA_DRAW_FRAME::m_originTransforms.

Referenced by PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), and PCB_DIM_LEADER::GetMsgPanelInfo().

GetPageSettings()

const PAGE_INFO & GERBVIEW_FRAME::GetPageSettings ( ) const

overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 900 of file gerbview_frame.cpp.

{
    return m_paper;
}

References m_paper.

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

GetPageSizeIU()

const wxSize GERBVIEW_FRAME::GetPageSizeIU ( ) const

overridevirtual

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

Implements EDA_DRAW_FRAME.

Definition at line 906 of file gerbview_frame.cpp.

{
    // 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();
}

References GetPageSettings().

GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 579 of file eda_base_frame.h.

{ return m_redoList.m_CommandsList.size(); }

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(), and EDITOR_CONDITIONS::redoFunc().

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

Definition at line 204 of file eda_draw_frame.h.

{ return m_currentScreen; }

References EDA_DRAW_FRAME::m_currentScreen.

Referenced by Clear_DrawLayers(), EDA_DRAW_PANEL_GAL::DoRePaint(), PL_EDITOR_FRAME::Files_io(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_BASE_FRAME::GetScreen(), PCB_BASE_FRAME::GetScreen(), PL_EDITOR_FRAME::IsContentModified(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), PL_EDITOR_FRAME::OnModify(), PL_EDITOR_FRAME::OnNewDrawingSheet(), PLEDITOR_PRINTOUT::PrintPage(), PL_EDITOR_FRAME::PrintPage(), COMMON_TOOLS::ResetLocalCoords(), PL_EDITOR_FRAME::SaveCopyInUndoList(), PL_EDITOR_FRAME::SaveDrawingSheetFile(), PL_EDITOR_FRAME::SetPageSettings(), SetPageSettings(), UpdateStatusBar(), and PL_EDITOR_FRAME::UpdateStatusBar().

GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 943 of file eda_draw_frame.cpp.

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

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

GetSettingsManager()

SETTINGS_MANAGER* EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

Definition at line 140 of file eda_base_frame.h.

{ return m_settingsManager; }

References EDA_BASE_FRAME::m_settingsManager.

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

GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int  aErrorCode ) const

inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME.

Definition at line 142 of file eda_base_frame.h.

{ return RPT_SEVERITY_UNDEFINED; }

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.

{ return m_polarCoords; }

References EDA_DRAW_FRAME::m_polarCoords.

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

GetTitleBlock()

const TITLE_BLOCK & GERBVIEW_FRAME::GetTitleBlock ( ) const

overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 915 of file gerbview_frame.cpp.

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

{ 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.

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

GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

{ return m_type; }

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

{ return m_undoList.m_CommandsList.size(); }

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(), 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 1055 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(), EDA_BASE_FRAME::GetUserUnits(), EDA_UNIT_UTILS::IsImperialUnit(), TOOLS_HOLDER::m_toolManager, MILLIMETRES, and MILS.

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

GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const

inlineinherited

Return the user units currently in use.

Definition at line 126 of file eda_base_frame.h.

    {
        return m_userUnits;
    }

References EDA_BASE_FRAME::m_userUnits.

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

GetVisibleElementColor()

COLOR4D GERBVIEW_FRAME::GetVisibleElementColor

(

int

aLayerID

)

Return the color of a gerber visible element.

Definition at line 761 of file gerbview_frame.cpp.

{
    COLOR4D color = COLOR4D::UNSPECIFIED;
    COLOR_SETTINGS* settings = Pgm().GetSettingsManager().GetColorSettings();

    switch( aLayerID )
    {
    case LAYER_NEGATIVE_OBJECTS:
    case LAYER_DCODES:
    case LAYER_GERBVIEW_DRAWINGSHEET:
    case LAYER_GERBVIEW_BACKGROUND:
        color = settings->GetColor( aLayerID );
        break;

    case LAYER_GERBVIEW_GRID:
        color = GetGridColor();
        break;

    default:
        wxFAIL_MSG( wxString::Format( "GERBVIEW_FRAME::GetVisibleElementColor(): bad arg %d",
                                      aLayerID ) );
    }

    return color;
}

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

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

GetVisibleLayers()

LSET GERBVIEW_FRAME::GetVisibleLayers

(

)

const

A proxy function that calls the correspondent function in m_BoardSettings.

Returns

LSET of the visible layers

Definition at line 725 of file gerbview_frame.cpp.

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

Definition at line 790 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 1215 of file eda_base_frame.cpp.

{
#ifdef __WXGTK__
    // 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.
    int width  = 0;
    int height = 0;
    GTKDoGetSize( &width, &height );

    wxSize winSize( width, height );
#else
    wxSize winSize = GetSize();
#endif

    return winSize;
}

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 565 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 PL_EDITOR_FRAME::UpdateStatusBar(), and EDA_DRAW_FRAME::UpdateStatusBar().

handleActivateEvent()

void EDA_DRAW_FRAME::handleActivateEvent ( wxActivateEvent &  aEvent )

protectedvirtualinherited

Handle a window activation event.

Reimplemented in PCB_BASE_EDIT_FRAME.

Definition at line 1128 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 PCB_BASE_EDIT_FRAME::handleActivateEvent(), and EDA_DRAW_FRAME::onActivate().

HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

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

Definition at line 1234 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 372 of file eda_base_frame.cpp.

{
    bool       checkRes  = false;
    bool       enableRes = true;
    bool       showRes   = true;
    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;
    }

    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, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), and ACTION_CONDITIONS::showCondition.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

HardRedraw()

void EDA_DRAW_FRAME::HardRedraw ( )

virtualinherited

Rebuild the GAL and redraws the screen.

Call when something went wrong.

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

Definition at line 821 of file eda_draw_frame.cpp.

{
    // To be implemented by subclasses.
}

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

help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 809 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 1008 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 1123 of file eda_base_frame.cpp.

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

InstallPreferences()

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

overridevirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 1052 of file gerbview_frame.cpp.

{
    wxTreebook* book = aParent->GetTreebook();

    book->AddPage( new wxPanel( book ), _( "GerbView" ) );
    book->AddSubPage( new PANEL_GERBVIEW_DISPLAY_OPTIONS( this, book ),
                      _( "Display Options" ) );
    book->AddSubPage( new PANEL_GERBVIEW_SETTINGS( this, book ), _( "Editing Options" ) );
    book->AddSubPage( new PANEL_GERBVIEW_EXCELLON_SETTINGS( this, book ),
                      _( "Excellon Options" ) );

    aHotkeysPanel->AddHotKeys( GetToolManager() );
}

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

isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const

inlineprotectedvirtualinherited

Return the auto save status of the application.

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 616 of file eda_base_frame.h.

{ return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( ) const

virtualinherited

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

Returns

true if the contents of the frame have not been saved

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

Definition at line 1116 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 109 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(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().

IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )

inherited

Returns

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

Definition at line 160 of file kiway_player.cpp.

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

{
    switch( aLayerID )
    {
    case LAYER_DCODES:                return m_DisplayOptions.m_DisplayDCodes;
    case LAYER_NEGATIVE_OBJECTS:      return m_DisplayOptions.m_DisplayNegativeObjects;
    case LAYER_GERBVIEW_GRID:         return IsGridVisible();
    case LAYER_GERBVIEW_DRAWINGSHEET: return m_showBorderAndTitleBlock;
    case LAYER_GERBVIEW_BACKGROUND:   return true;

    default:
        wxFAIL_MSG( wxString::Format( "GERBVIEW_FRAME::IsElementVisible(): bad arg %d",
                                      aLayerID ) );
    }

    return true;
}

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

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

IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( ) const

inherited

Definition at line 384 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 755 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.

{ return m_modal; }

References KIWAY_PLAYER::m_modal.

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

IsScriptingConsoleVisible()

bool EDA_DRAW_FRAME::IsScriptingConsoleVisible ( )

inherited

Gets the current visibility of the scripting console window.

Definition at line 241 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 206 of file eda_base_frame.h.

{ return m_ident == aType; }

References EDA_BASE_FRAME::m_ident.

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

IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName &  aFileName )

inherited

Checks if aFileName can be written.

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

Note

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

Parameters

aFileName

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

Returns

False if aFileName cannot be written.

Definition at line 1025 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.GetFullName(), fn.GetPath() );
    }
    else if( fn.FileExists() && !fn.IsFileWritable() )
    {
        msg.Printf( _( "Insufficient permissions to save file '%s'." ),
                    fn.GetFullPath() );
    }

    if( !msg.IsEmpty() )
    {
        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.

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

kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS &  aEvent )

protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 181 of file kiway_player.cpp.

{
    // 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 SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, SCH_EDIT_FRAME, PCB_EDIT_FRAME, and CVPCB_MAINFRAME.

Definition at line 71 of file kiway_player.cpp.

{
    // override this in derived classes.
}

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

language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event )

protectedinherited

An event handler called on a language menu selection.

Definition at line 188 of file kiway_player.cpp.

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

{
    wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
    aFilename.SetExt( ext );

    wxString dir = aGlobalPath;


    if( isDirectory && doOpen )
    {
        if( !aIsGlobal )
        {
            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 )
        {
            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 );
    }

    return true;
}

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

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

loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )

protectedinherited

Returns the canvas type stored in the application settings.

Definition at line 714 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 Cairo, and on the first instantiation
    // the user will be prompted to switch to OpenGL
    if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
        canvasType = EDA_DRAW_PANEL_GAL::GAL_FALLBACK;

    return canvasType;
}

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

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

LoadExcellonFiles()

bool GERBVIEW_FRAME::LoadExcellonFiles

(

const wxString &

aFileName

)

Load a drill (EXCELLON) file or many files.

Parameters

aFileName

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

Returns

true if file was opened successfully.

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

{
    wxString   filetypes;
    wxArrayString filenamesList;
    wxFileName filename = aFullFileName;
    wxString currentPath;

    if( !filename.IsOk() )
    {
        filetypes = DrillFileWildcard();
        filetypes << wxT( "|" );

        /* All filetypes */
        filetypes += AllFilesWildcard();

        /* 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 NC (Excellon) Drill File(s)" ),
                          currentPath, filename.GetFullName(), filetypes,
                          wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE | wxFD_CHANGE_DIR );

        if( dlg.ShowModal() == wxID_CANCEL )
            return false;

        dlg.GetPaths( filenamesList );
        currentPath = wxGetCwd();
        m_mruPath = currentPath;
    }
    else
    {
        filenamesList.Add( aFullFileName );
        currentPath = filename.GetPath();
        m_mruPath = currentPath;
    }

    // Read Excellon drill files: each file is loaded on a new GerbView layer
    bool success = true;
    int layer = GetActiveLayer();

    // Manage errors when loading files
    wxString msg;
    WX_STRING_REPORTER reporter( &msg );

    for( unsigned ii = 0; ii < filenamesList.GetCount(); ii++ )
    {
        filename = filenamesList[ii];

        if( !filename.IsAbsolute() )
            filename.SetPath( currentPath );

        m_lastFileName = filename.GetFullPath();

        SetActiveLayer( layer, false );

        if( Read_EXCELLON_File( filename.GetFullPath() ) )
        {
            // Update the list of recent drill files.
            UpdateFileHistory( filename.GetFullPath(), &m_drillFileHistory );

            layer = getNextAvailableLayer( layer );

            if( layer == NO_AVAILABLE_LAYERS && ii < filenamesList.GetCount()-1 )
            {
                success = false;
                reporter.Report( MSG_NO_MORE_LAYER, RPT_SEVERITY_ERROR );

                // Report the name of not loaded files:
                ii += 1;
                while( ii < filenamesList.GetCount() )
                {
                    filename = filenamesList[ii++];
                    wxString txt = wxString::Format( MSG_NOT_LOADED, filename.GetFullName() );
                    reporter.Report( txt, RPT_SEVERITY_ERROR );
                }
                break;
            }

            SetActiveLayer( layer, false );
        }
    }

    if( !success )
    {
        HTML_MESSAGE_BOX mbox( this, _( "Errors" ) );
        mbox.ListSet( msg );
        mbox.ShowModal();
    }

    Zoom_Automatique( false );

    // Synchronize layers tools with actual active layer:
    ReFillLayerWidget();
    SetActiveLayer( GetActiveLayer() );
    m_LayersManager->UpdateLayerIcons();
    syncLayerBox();

    return success;
}

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

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

LoadGerberFiles()

bool GERBVIEW_FRAME::LoadGerberFiles

(

const wxString &

aFileName

)

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

Parameters

aFileName

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

Returns

true if file was opened successfully.

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

{
    static int lastGerberFileWildcard = 0;
    wxString   filetypes;
    wxArrayString filenamesList;
    wxFileName filename = aFullFileName;
    wxString currentPath;

    if( !filename.IsOk() )
    {
        /* 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();

        // 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, _( "Open Gerber File(s)" ), currentPath, filename.GetFullName(),
                          filetypes,
                          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( aFullFileName );
        m_mruPath = currentPath = filename.GetPath();
    }

    Erase_Current_DrawLayer( false );

    // Set the busy cursor
    wxBusyCursor wait;

    bool isFirstFile = GetImagesList()->GetLoadedImageCount() == 0;

    bool success = LoadListOfGerberAndDrillFiles( currentPath, filenamesList );

    // Auto zoom is only applied if there is only one file loaded
    if( isFirstFile )
    {
        Zoom_Automatique( false );
    }

    return success;
}

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

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

LoadGerberJobFile()

bool GERBVIEW_FRAME::LoadGerberJobFile

(

const wxString &

aFileName

)

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

Parameters

aFileName

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

Returns

true if file(s) was opened successfully.

Definition at line 179 of file job_file_reader.cpp.

{
    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();

            success = LoadListOfGerberAndDrillFiles( currentPath, gbrfiles );

            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(), HTML_MESSAGE_BOX::ListSet(), LoadListOfGerberAndDrillFiles(), m_jobFileHistory, EDA_BASE_FRAME::m_mruPath, SortLayersByX2Attributes(), EDA_BASE_FRAME::UpdateFileHistory(), and EDA_DRAW_FRAME::Zoom_Automatique().

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

LoadListOfGerberAndDrillFiles()

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

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

Parameters

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) if nullptr, files are expected Gerber type.

Returns

true if every file loaded successfully

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

{
    wxFileName filename;

    // Read gerber files: each file is loaded on a new GerbView layer
    bool success = true;
    int layer = GetActiveLayer();
    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 << "<b>" << _( "File not found:" ) << "</b><br>"
                    << filename.GetFullPath() << "<br>";
            reporter.Report( warning, RPT_SEVERITY_WARNING );
            success = false;
            continue;
        }

        m_lastFileName = filename.GetFullPath();

        if( !progress && ( aFilenameList.GetCount() > 1 ) )
        {
            progress = std::make_unique<WX_PROGRESS_REPORTER>( this,
                                                               _( "Loading Gerber 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();
        }

        SetActiveLayer( layer, false );

        visibility[ layer ] = true;

        try
        {
            if( aFileType && ( *aFileType )[ii] == 1 )
            {
                LoadExcellonFiles( filename.GetFullPath() );
                layer = GetActiveLayer(); // Loading NC drill file changes the active layer
            }
            else
            {
                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 );
                }
                else if( Read_GERBER_File( filename.GetFullPath() ) )
                {
                    UpdateFileHistory( m_lastFileName );

                    GetCanvas()->GetView()->SetLayerHasNegatives(
                            GERBER_DRAW_LAYER( layer ), GetGbrImage( layer )->HasNegativeItems() );

                    layer = getNextAvailableLayer( layer );

                    if( layer == NO_AVAILABLE_LAYERS && ii < aFilenameList.GetCount() - 1 )
                    {
                        success = false;
                        reporter.Report( MSG_NO_MORE_LAYER, RPT_SEVERITY_ERROR );

                        // Report the name of not loaded files:
                        ii += 1;
                        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 );
                }
            }
        }
        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 );

    // Synchronize layers tools with actual active layer:
    ReFillLayerWidget();

    // TODO: it would be nice if we could set the active layer to one of the
    // ones that was just loaded, but to maintain the previous user experience
    // we need to set it to a blank layer in case they load another file.
    // We can't start with the next available layer when loading files because
    // some users expect the behavior of overwriting the active layer on load.
    SetActiveLayer( getNextAvailableLayer( layer ), true );

    m_LayersManager->UpdateLayerIcons();
    syncLayerBox( true );

    GetCanvas()->Refresh();

    return success;
}

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

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

LoadSettings()

void GERBVIEW_FRAME::LoadSettings ( APP_SETTINGS_BASE *  aCfg )

overridevirtual

Load common frame parameters from a configuration file.

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 295 of file gerbview_frame.cpp.

{
    EDA_DRAW_FRAME::LoadSettings( aCfg );

    if( aCfg->m_Window.grid.sizes.empty() )
    {
        aCfg->m_Window.grid.sizes = { "100 mil",
                                      "50 mil",
                                      "25 mil",
                                      "20 mil",
                                      "10 mil",
                                      "5 mil",
                                      "2.5 mil",
                                      "2 mil",
                                      "1 mil",
                                      "0.5 mil",
                                      "0.2 mil",
                                      "0.1 mil",
                                      "5.0 mm",
                                      "2.5 mm",
                                      "1.0 mm",
                                      "0.5 mm",
                                      "0.25 mm",
                                      "0.2 mm",
                                      "0.1 mm",
                                      "0.05 mm",
                                      "0.025 mm",
                                      "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 );

    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 );
}

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

Referenced by GERBVIEW_FRAME().

LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS *  aCfg )

inherited

Load window settings from the given settings object.

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

Definition at line 689 of file eda_base_frame.cpp.

{
    LoadWindowState( aCfg->state );

    if( m_hasAutoSave )
        m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;

    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_autoSaveInterval, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_perspective, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), and WINDOW_SETTINGS::state.

Referenced by EDA_BASE_FRAME::LoadSettings().

LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString &  aFileName )

inherited

Definition at line 529 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(), Pgm(), KIWAY_HOLDER::Prj(), and PROJECT_FILE_STATE::window.

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

LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE &  aState )

virtualinherited

Load frame state info from a configuration file.

Definition at line 543 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.

LoadZipArchiveFile()

bool GERBVIEW_FRAME::LoadZipArchiveFile

(

const wxString &

aFileName

)

Load a zipped archive file.

Parameters

aFileName

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

Returns

true if file was opened successfully.

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

{
#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 = dl