Common, abstract interface for edit frames. More...

#include <pcb_base_edit_frame.h>

Inheritance diagram for PCB_BASE_EDIT_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
	PCB_BASE_EDIT_FRAME (KIWAY aKiway, wxWindow aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)

virtual	~PCB_BASE_EDIT_FRAME ()

bool	TryBefore (wxEvent &aEvent) override

void	doCloseWindow () override

wxString	CreateNewLibrary (const wxString &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)
	If a library name is given, creates a new footprint library in the project folder with the given name. More...

wxString	CreateNewProjectLibrary (const wxString &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)

bool	AddLibrary (const wxString &aLibName=wxEmptyString, FP_LIB_TABLE *aTable=nullptr)
	Add an existing library to either the global or project library table. More...

virtual void	OnEditItemRequest (BOARD_ITEM *aItem)=0
	Install the corresponding dialog editor for the given item. More...

void	SaveCopyInUndoList (EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand) override
	Create a new entry in undo list of commands. More...

void	SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aCommandType) override
	Create a new entry in undo list of commands. More...

void	RestoreCopyFromRedoList (wxCommandEvent &aEvent)
	Redo the last edit: More...

void	RestoreCopyFromUndoList (wxCommandEvent &aEvent)
	Undo the last edit: More...

void	RollbackFromUndo ()
	Perform an undo of the last edit without logging a corresponding redo. More...

void	PutDataInPreviousState (PICKED_ITEMS_LIST *aList)
	Used in undo or redo command. More...

bool	UndoRedoBlocked () const
	Check if the undo and redo operations are currently blocked. More...

void	UndoRedoBlock (bool aBlock=true)
	Enable/disable undo and redo operations. More...

void	SetGridVisibility (bool aVisible) override
	Override this function in the PCB_BASE_EDIT_FRAME to refill the layer widget. More...

void	SetObjectVisible (GAL_LAYER_ID aLayer, bool aVisible=true)

int	GetRotationAngle () const
	Return the angle used for rotate operations. More...

void	SetRotationAngle (int aRotationAngle)
	Set the angle used for rotate operations. More...

void	ShowTextPropertiesDialog (BOARD_ITEM *aText)

void	ShowGraphicItemPropertiesDialog (BOARD_ITEM *aItem)

void	ActivateGalCanvas () override
	Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD. More...

virtual void	SetBoard (BOARD aBoard, PROGRESS_REPORTER aReporter=nullptr) override
	Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD. More...

COLOR_SETTINGS *	GetColorSettings () const override
	Helper to retrieve the current color settings. More...

void	ClearUndoORRedoList (UNDO_REDO_LIST whichList, int aItemCount=-1) override
	Free the undo or redo list from List element. More...

wxString	GetDesignRulesPath ()
	Return the absolute path to the design rules file for the currently-loaded board. More...

APPEARANCE_CONTROLS *	GetAppearancePanel ()

virtual void	OnLayerAlphaChanged ()
	Notify the frame that the layer Alpha is being changed. More...

EDA_3D_VIEWER_FRAME *	Get3DViewerFrame ()

virtual void	Update3DView (bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
	Update the 3D view, if the viewer is opened by this frame. More...

FOOTPRINT *	LoadFootprint (const LIB_ID &aFootprintId)
	Attempt to load aFootprintId from the footprint library table. More...

EDA_RECT	GetBoardBoundingBox (bool aBoardEdgesOnly=false) const
	Calculate the bounding box containing all board items (or board edge segments). More...

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

virtual 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 wxPoint &	GetAuxOrigin () const

const wxPoint	GetUserOrigin () const

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

const TITLE_BLOCK &	GetTitleBlock () const override

void	SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override

virtual BOARD_DESIGN_SETTINGS &	GetDesignSettings () const
	Returns the BOARD_DESIGN_SETTINGS for the open project. More...

PCBNEW_SETTINGS &	Settings ()

void	SetDrawBgColor (const COLOR4D &aColor) override

const PCB_DISPLAY_OPTIONS &	GetDisplayOptions () const
	Display options control the way tracks, vias, outlines and other things are shown (for instance solid or sketch mode). More...

void	SetDisplayOptions (const PCB_DISPLAY_OPTIONS &aOptions, bool aRefresh=true)
	Updates the current display options from the given options struct. More...

const ZONE_SETTINGS &	GetZoneSettings () const

void	SetZoneSettings (const ZONE_SETTINGS &aSettings)

virtual const PCB_PLOT_PARAMS &	GetPlotSettings () const
	Return the PCB_PLOT_PARAMS for the BOARD owned by this frame. More...

virtual void	SetPlotSettings (const PCB_PLOT_PARAMS &aSettings)

BOARD *	GetBoard () const

virtual BOARD_ITEM_CONTAINER *	GetModel () const =0

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

void	FocusOnItem (BOARD_ITEM *aItem, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)

void	FocusOnItems (std::vector< BOARD_ITEM * > aItems, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)

virtual void	ReCreateOptToolbar () override

virtual void	ShowChangedLanguage () override
	Redraw the menus and what not in current language. More...

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

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

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

EDA_3D_VIEWER_FRAME *	CreateAndShow3D_Frame ()
	Shows the 3D view frame. More...

GENERAL_COLLECTORS_GUIDE	GetCollectorsGuide ()

wxString	SelectLibrary (const wxString &aNicknameExisting)
	Put up a dialog and allows the user to pick a library, for unspecified use. More...

FOOTPRINT *	GetFootprintFromBoardByReference ()

virtual void	OnModify ()
	Must be called after a change in order to set the "modify" flag of the current screen and update the date in frame reference. More...

FOOTPRINT *	CreateNewFootprint (const wxString &aFootprintName, bool aQuiet=false)
	Creates a new footprint, at position 0,0. More...

void	PlaceFootprint (FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
	Places aFootprint at the current cursor position and updates footprint coordinates with the new position. More...

void	ShowPadPropertiesDialog (PAD *aPad)

FOOTPRINT *	SelectFootprintFromLibTree (LIB_ID aPreselect=LIB_ID())
	Open a dialog to select a footprint. More...

virtual void	AddFootprintToBoard (FOOTPRINT *aFootprint)
	Add the given footprint to the board. More...

wxString	SelectFootprintFromLibBrowser ()
	Launch the footprint viewer to select the name of a footprint to load. More...

void	Compile_Ratsnest (bool aDisplayStatus)
	Create the entire board ratsnest. More...

PCB_LAYER_ID	SelectOneLayer (PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
	Show the dialog box for a layer selection. More...

virtual void	SwitchLayer (PCB_LAYER_ID aLayer)
	Change the active layer in the frame. More...

virtual void	SetActiveLayer (PCB_LAYER_ID aLayer)

virtual PCB_LAYER_ID	GetActiveLayer () const

SEVERITY	GetSeverity (int aErrorCode) const override

virtual void	OnDisplayOptionsChanged ()

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

PCBNEW_SETTINGS *	GetPcbNewSettings () const

FOOTPRINT_EDITOR_SETTINGS *	GetFootprintEditorSettings () const

virtual MAGNETIC_SETTINGS *	GetMagneticItemsSettings ()

void	CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
	Notification event that some of the common (suite-wide) settings have changed. More...

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

PCB_DRAW_PANEL_GAL *	GetCanvas () const override
	Return a pointer to GAL-based canvas of given EDA draw frame. 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 COLOR4D	GetDrawBgColor () const

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

void	EraseMsgBox ()

virtual void	ReCreateHToolbar ()=0

virtual void	ReCreateVToolbar ()=0

virtual void	ReCreateAuxiliaryToolbar ()

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

bool	IsGridVisible () const

virtual COLOR4D	GetGridColor ()

virtual void	SetGridColor (const COLOR4D &aColor)

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

void	OnGridSettings (wxCommandEvent &event)

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

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

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

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

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

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

void	OnMove (wxMoveEvent &aEvent) override

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

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

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

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

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

void	DisplayToolMsg (const wxString &msg) override

void	DisplayConstraintsMsg (const wxString &msg)

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

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

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

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

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

void	SetMsgPanel (EDA_ITEM *aItem)

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

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

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

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 bool	OpenProjectFiles (const std::vector< wxString > &aFileList, int aCtl=0)
	Open a project or set of files given by aFileList. 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

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

virtual void	InstallPreferences (PAGED_DIALOG , PANEL_HOTKEYS_EDITOR )
	Allow a frame to load its preference panels (if any) into the preferences dialog. More...

void	LoadWindowState (const wxString &aFileName)

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

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

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

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

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

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

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

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

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

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

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

void	SetMruPath (const wxString &aPath)

wxString	GetMruPath () const

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

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

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

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

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

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

const wxString &	GetAboutTitle () const

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

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

virtual void	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 SELECTION &	GetCurrentSelection ()
	Get the current selection from the canvas area. 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...

Protected Member Functions
FP_LIB_TABLE *	selectLibTable (bool aOptional=false)
	Prompts a user to select global or project library tables. More...

wxString	createNewLibrary (const wxString &aLibName, const wxString &aProposedName, FP_LIB_TABLE *aTable)
	Create a new library in the given table (presumed to be either the global or project library table). More...

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

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

bool	canCloseWindow (wxCloseEvent &aCloseEvent) override

FOOTPRINT *	loadFootprint (const LIB_ID &aFootprintId)
	Attempts to load aFootprintId from the footprint library table. More...

virtual void	SetScreen (BASE_SCREEN *aScreen)

void	setupUnits (APP_SETTINGS_BASE *aCfg)

std::vector< wxWindow * >	findDialogs ()

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

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

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

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

void	onSystemColorChange (wxSysColourChangedEvent &aEvent)

virtual void	setupUIConditions ()
	Setup the UI conditions for the various actions and their controls in this frame. More...

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
int	m_rotationAngle

bool	m_undoRedoBlocked

PANEL_SELECTION_FILTER *	m_selectionFilterPanel

APPEARANCE_CONTROLS *	m_appearancePanel

BOARD *	m_pcb

PCB_DISPLAY_OPTIONS	m_displayOptions

PCB_ORIGIN_TRANSFORMS	m_originTransforms

PCBNEW_SETTINGS *	m_settings

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

Detailed Description

Common, abstract interface for edit frames.

Definition at line 39 of file pcb_base_edit_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

39 { DIALOG, FRAME, PANEL };

KIWAY_HOLDER::DIALOG

Definition: kiway_holder.h:39

KIWAY_HOLDER::PANEL

Definition: kiway_holder.h:39

KIWAY_HOLDER::FRAME

Definition: kiway_holder.h:39

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

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

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 109 of file eda_base_frame.h.

  {
  UNDO_LIST,
  REDO_LIST
  };

Constructor & Destructor Documentation

◆ PCB_BASE_EDIT_FRAME()

PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME	(	KIWAY *	aKiway,
		wxWindow *	aParent,
		FRAME_T	aFrameType,
		const wxString &	aTitle,
		const wxPoint &	aPos,
		const wxSize &	aSize,
		long	aStyle,
		const wxString &	aFrameName
	)

Definition at line 47 of file pcb_base_edit_frame.cpp.

  :
  PCB_BASE_FRAME( aKiway, aParent, aFrameType, aTitle, aPos, aSize, aStyle, aFrameName ),
  m_rotationAngle( 900 ), m_undoRedoBlocked( false ),
  m_selectionFilterPanel( nullptr ),
  m_appearancePanel( nullptr )
 {
  Bind( wxEVT_IDLE,
  [this]( wxIdleEvent& aEvent )
  {
  // Handle cursor adjustments. While we can get motion and key events through
  // wxWidgets, we can't get modifier-key-up events.
  if( m_toolManager )
  {
  PCB_SELECTION_TOOL* selTool = m_toolManager->GetTool<PCB_SELECTION_TOOL>();
 
  if( selTool )
  selTool->OnIdle( aEvent );
  }
  } );
 }

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

◆ ~PCB_BASE_EDIT_FRAME()

PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME ( )

virtual

Definition at line 72 of file pcb_base_edit_frame.cpp.

 {
  GetCanvas()->GetView()->Clear();
 }

References KIGFX::VIEW::Clear(), PCB_BASE_FRAME::GetCanvas(), and PCB_DRAW_PANEL_GAL::GetView().

Member Function Documentation

◆ ActivateGalCanvas()

void PCB_BASE_EDIT_FRAME::ActivateGalCanvas ( )

overridevirtual

Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.

Parameters

aBoard is the BOARD to put into the frame.

Reimplemented from PCB_BASE_FRAME.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 135 of file pcb_base_edit_frame.cpp.

 {
  PCB_BASE_FRAME::ActivateGalCanvas();
 
  GetCanvas()->SyncLayersVisibility( m_pcb );
 }

References PCB_BASE_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::m_pcb, and PCB_DRAW_PANEL_GAL::SyncLayersVisibility().

Referenced by FOOTPRINT_EDIT_FRAME::ActivateGalCanvas(), and PCB_EDIT_FRAME::ActivateGalCanvas().

◆ AddFootprintToBoard()

void PCB_BASE_FRAME::AddFootprintToBoard ( FOOTPRINT * aFootprint )

virtualinherited

Add the given footprint to the board.

Parameters

aDC	is the current Device Context, to draw the new footprint (can be NULL ).

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 177 of file pcb_base_frame.cpp.

 {
  if( aFootprint )
  {
  GetBoard()->Add( aFootprint, ADD_MODE::APPEND );
 
  aFootprint->SetFlags( IS_NEW );
  aFootprint->SetPosition( wxPoint( 0, 0 ) ); // cursor in GAL may not be initialized yet
 
  // Put it on FRONT layer (note that it might be stored flipped if the lib is an archive
  // built from a board)
  if( aFootprint->IsFlipped() )
  aFootprint->Flip( aFootprint->GetPosition(), m_settings->m_FlipLeftRight );
 
  // Place it in orientation 0 even if it is not saved with orientation 0 in lib (note that
  // it might be stored in another orientation if the lib is an archive built from a board)
  aFootprint->SetOrientation( 0 );
  }
 }

References BOARD::Add(), APPEND, FOOTPRINT::Flip(), PCB_BASE_FRAME::GetBoard(), FOOTPRINT::GetPosition(), IS_NEW, FOOTPRINT::IsFlipped(), PCBNEW_SETTINGS::m_FlipLeftRight, PCB_BASE_FRAME::m_settings, EDA_ITEM::SetFlags(), FOOTPRINT::SetOrientation(), and FOOTPRINT::SetPosition().

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard().

◆ AddLibrary()

bool PCB_BASE_EDIT_FRAME::AddLibrary	(	const wxString &	aLibName = `wxEmptyString`,
		FP_LIB_TABLE *	aTable = `nullptr`
	)

Add an existing library to either the global or project library table.

Parameters

aFileName the library to add; a file open dialog will be displayed if empty.

Returns: true if successfully added.

Definition at line 546 of file footprint_libraries_utils.cpp.

 {
  if( aTable == nullptr )
  aTable = selectLibTable();
 
  if( aTable == nullptr )
  return wxEmptyString;
 
  bool isGlobal = ( aTable == &GFootprintTable );
 
  wxFileName fn( aFilename );
 
  if( aFilename.IsEmpty() )
  {
  if( !LibraryFileBrowser( true, fn, KiCadFootprintLibPathWildcard(),
  KiCadFootprintLibPathExtension, true, isGlobal,
  PATHS::GetDefaultUserFootprintsPath() ) )
  {
  return false;
  }
  }
 
  wxString libPath = fn.GetFullPath();
  wxString libName = fn.GetName();
 
  if( libName.IsEmpty() )
  return false;
 
  wxString type = IO_MGR::ShowType( IO_MGR::GuessPluginTypeFromLibPath( libPath ) );
 
  // try to use path normalized to an environmental variable or project path
  wxString normalizedPath = NormalizePath( libPath, &Pgm().GetLocalEnvVariables(), &Prj() );
 
  try
  {
  FP_LIB_TABLE_ROW* row = new FP_LIB_TABLE_ROW( libName, normalizedPath, type, wxEmptyString );
  aTable->InsertRow( row );
 
  if( isGlobal )
  GFootprintTable.Save( FP_LIB_TABLE::GetGlobalTableFileName() );
  else
  Prj().PcbFootprintLibs()->Save( Prj().FootprintLibTblName() );
  }
  catch( const IO_ERROR& ioe )
  {
  DisplayError( this, ioe.What() );
  return false;
  }
 
  auto editor = (FOOTPRINT_EDIT_FRAME*) Kiway().Player( FRAME_FOOTPRINT_EDITOR, false );
 
  if( editor )
  {
  LIB_ID libID( libName, wxEmptyString );
  editor->SyncLibraryTree( true );
  editor->FocusOnLibID( libID );
  }
 
  auto viewer = (FOOTPRINT_VIEWER_FRAME*) Kiway().Player( FRAME_FOOTPRINT_VIEWER, false );
 
  if( viewer )
  viewer->ReCreateLibraryList();
 
  return true;
 }

References DisplayError(), editor, FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_VIEWER, PATHS::GetDefaultUserFootprintsPath(), FP_LIB_TABLE::GetGlobalTableFileName(), GFootprintTable, IO_MGR::GuessPluginTypeFromLibPath(), LIB_TABLE::InsertRow(), KiCadFootprintLibPathExtension, KiCadFootprintLibPathWildcard(), KIWAY_HOLDER::Kiway(), EDA_DRAW_FRAME::LibraryFileBrowser(), NormalizePath(), PROJECT::PcbFootprintLibs(), Pgm(), KIWAY::Player(), KIWAY_HOLDER::Prj(), LIB_TABLE::Save(), selectLibTable(), IO_MGR::ShowType(), and IO_ERROR::What().

Referenced by createNewLibrary().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar * aMenuBar )

inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 460 of file eda_base_frame.cpp.

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU & aMenu )

inherited

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

zoom and grid).

Definition at line 492 of file eda_draw_frame.cpp.

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

◆ canCloseWindow()

bool PCB_BASE_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

overrideprotectedvirtualinherited

Reimplemented from EDA_BASE_FRAME.

Reimplemented in PCB_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 86 of file pcb_base_frame.cpp.

 {
  // Close modeless dialogs. They're trouble when they get destroyed after the frame and/or
  // board.
  wxWindow* viewer3D = Get3DViewerFrame();
 
  if( viewer3D )
  viewer3D->Close( true );
 
  return true;
 }

References PCB_BASE_FRAME::Get3DViewerFrame().

Referenced by FOOTPRINT_EDIT_FRAME::canCloseWindow(), and PCB_EDIT_FRAME::canCloseWindow().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

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

virtualinherited

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

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

Parameters

aFileName A wxFileName object containing the file name to check.

Reimplemented in SCH_EDIT_FRAME.

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

◆ 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 976 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 GERBVIEW_FRAME::OnClearDrlFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), SCH_EDIT_FRAME::OnClearFileHistory(), GERBVIEW_FRAME::OnClearGbrFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), and GERBVIEW_FRAME::OnClearZipFileHistory().

◆ ClearMsgPanel()

void EDA_DRAW_FRAME::ClearMsgPanel ( )

virtualinherited

Clear all messages from the message panel.

Reimplemented in SYMBOL_EDIT_FRAME.

Definition at line 660 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(), GERBVIEW_FRAME::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 GERBVIEW_FRAME::UpdateTitleAndInfo().

◆ ClearUndoORRedoList()

void PCB_BASE_EDIT_FRAME::ClearUndoORRedoList	(	UNDO_REDO_LIST	whichList,
		int	aItemCount = `-1`
	)

overridevirtual

Free the undo or redo list from List element.

Wrappers are deleted. Data pointed by wrappers are deleted if not in use in schematic i.e. when they are copy of a schematic item or they are no more in use (DELETED). Items are removed from the beginning of the list so this function can be called to remove old commands.

Parameters

whichList	the UNDO_REDO_CONTAINER to clear.
aItemCount	the count of items to remove. < 0 for all items.

Reimplemented from EDA_BASE_FRAME.

Definition at line 551 of file undo_redo.cpp.

 {
  if( aItemCount == 0 )
  return;
 
  UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
  unsigned icnt = list.m_CommandsList.size();
 
  if( aItemCount > 0 )
  icnt = aItemCount;
 
  for( unsigned ii = 0; ii < icnt; ii++ )
  {
  if( list.m_CommandsList.size() == 0 )
  break;
 
  PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
  list.m_CommandsList.erase( list.m_CommandsList.begin() );
 
  curr_cmd->ClearListAndDeleteItems();
  delete curr_cmd; // Delete command
  }
 }

References PICKED_ITEMS_LIST::ClearListAndDeleteItems(), and UNDO_REDO_CONTAINER::m_CommandsList.

◆ 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 1154 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::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SCH_EDIT_FRAME::OnImportProject(), PL_EDITOR_FRAME::OnNewDrawingSheet(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and EDA_BASE_FRAME::~EDA_BASE_FRAME().

◆ CommonSettingsChanged()

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

overridevirtualinherited

Notification event that some of the common (suite-wide) settings have changed.

Update menus, toolbars, local variables, etc.

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in PCB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 863 of file pcb_base_frame.cpp.

 {
  EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
 
  GetCanvas()->GetView()->GetPainter()->GetSettings()->LoadColors( GetColorSettings() );
 
  GetCanvas()->GetView()->UpdateAllItemsConditionally( KIGFX::REPAINT,
  [&]( KIGFX::VIEW_ITEM* aItem ) -> bool
  {
  if( dynamic_cast<RATSNEST_VIEW_ITEM*>( aItem ) )
  {
  return true; // ratsnest display
  }
  else if( dynamic_cast<PCB_TRACK*>( aItem ) )
  {
  return true; // track, arc & via clearance display
  }
  else if( dynamic_cast<PAD*>( aItem ) )
  {
  return true; // pad clearance display
  }
 
  return false;
  } );
 
  GetCanvas()->GetView()->UpdateAllItems( KIGFX::COLOR );
 
  RecreateToolbars();
 
  // The 3D viewer isn't in the Kiway, so send its update manually
  EDA_3D_VIEWER_FRAME* viewer = Get3DViewerFrame();
 
  if( viewer )
  viewer->CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
 }

References KIGFX::COLOR, EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::Get3DViewerFrame(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetColorSettings(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::RENDER_SETTINGS::LoadColors(), EDA_DRAW_FRAME::RecreateToolbars(), KIGFX::REPAINT, KIGFX::VIEW::UpdateAllItems(), and KIGFX::VIEW::UpdateAllItemsConditionally().

Referenced by FOOTPRINT_VIEWER_FRAME::CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), and PCB_EDIT_FRAME::CommonSettingsChanged().

◆ Compile_Ratsnest()

void PCB_BASE_FRAME::Compile_Ratsnest ( bool aDisplayStatus )

inherited

Create the entire board ratsnest.

Function Compile_Ratsnest Create the entire board ratsnest.

This must be called after a board change (changes for pads, footprints or a read netlist ).

Parameters

aDC	is the current device context (can be NULL).
aDisplayStatus	if true, display the computation results.

Must be called after a board change (changes for pads, footprints or a read netlist ).

Parameters

aDC	= the current device context (can be NULL)
aDisplayStatus	: if true, display the computation results

Definition at line 40 of file ratsnest.cpp.

 {
  GetBoard()->GetConnectivity()->RecalculateRatsnest();
 
  if( aDisplayStatus )
  SetMsgPanel( m_pcb );
 }

References PCB_BASE_FRAME::GetBoard(), BOARD::GetConnectivity(), PCB_BASE_FRAME::m_pcb, and EDA_DRAW_FRAME::SetMsgPanel().

Referenced by DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCB_EDIT_FRAME::ExportToGenCAD(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), PCB_CONTROL::Paste(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const

virtualinherited

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

Reimplemented in SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 816 of file eda_base_frame.cpp.

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

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

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

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )

inlineoverridevirtualinherited

Get the configuration base name.

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

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

Reimplemented from TOOLS_HOLDER.

Definition at line 358 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateAndShow3D_Frame()

EDA_3D_VIEWER_FRAME * PCB_BASE_FRAME::CreateAndShow3D_Frame ( )

inherited

Shows the 3D view frame.

If it does not exist, it is created. If it exists, it is brought to the foreground.

Definition at line 603 of file pcb_base_frame.cpp.

 {
  EDA_3D_VIEWER_FRAME* draw3DFrame = Get3DViewerFrame();
 
  if( !draw3DFrame )
  draw3DFrame = new EDA_3D_VIEWER_FRAME( &Kiway(), this, _( "3D Viewer" ) );
 
  // Raising the window does not show the window on Windows if iconized. This should work
  // on any platform.
  if( draw3DFrame->IsIconized() )
  draw3DFrame->Iconize( false );
 
  draw3DFrame->Raise();
  draw3DFrame->Show( true );
 
  // Raising the window does not set the focus on Linux. This should work on any platform.
  if( wxWindow::FindFocus() != draw3DFrame )
  draw3DFrame->SetFocus();
 
  // Allocate a slice of time to display the 3D frame
  // a call to wxSafeYield() should be enough (and better), but on Linux we need
  // to call wxYield()
  // otherwise the activity messages are not displayed during the first board loading
  wxYield();
 
  // Note, the caller is responsible to load/update the board 3D view.
  // after frame creation the board is not automatically created.
 
  return draw3DFrame;
 }

References _, PCB_BASE_FRAME::Get3DViewerFrame(), and KIWAY_HOLDER::Kiway().

Referenced by PCB_VIEWER_TOOLS::Show3DViewer().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 841 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( wxT( "InfoBar" ) ).Top().Layer(1) );
 #endif
 }

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

◆ CreateNewFootprint()

FOOTPRINT * PCB_BASE_FRAME::CreateNewFootprint	(	const wxString &	aFootprintName,
		bool	aQuiet = `false`
	)

inherited

Creates a new footprint, at position 0,0.

The new footprint contains only 2 texts: a reference and a value: Reference = REF** Value = "VAL**" or Footprint name in lib

Note: They are dummy texts, which will be replaced by the actual texts when the footprint is placed on a board and a netlist is read.

Parameters

aFootprintName	is the name of the new footprint in library.
aQuiet	prevents user dialogs from being shown

Definition at line 1136 of file footprint_libraries_utils.cpp.

 {
  wxString footprintName = aFootprintName;
 
  // Static to store user preference for a session
  static int footprintType = 1;
  int footprintTranslated = FP_SMD;
 
  // Ask for the new footprint name
  if( footprintName.IsEmpty() && !aQuiet )
  {
  WX_TEXT_ENTRY_DIALOG dlg( this, _( "Enter footprint name:" ), _( "New Footprint" ),
  footprintName, _( "Footprint type:" ),
  { _( "Through hole" ), _( "SMD" ), _( "Other" ) },
  footprintType );
  dlg.SetTextValidator( FOOTPRINT_NAME_VALIDATOR( &footprintName ) );
 
  if( dlg.ShowModal() != wxID_OK )
  return nullptr; //Aborted by user
 
  footprintType = dlg.GetChoice();
 
  switch( footprintType )
  {
  case 0:
  footprintTranslated = FP_THROUGH_HOLE;
  break;
  case 1:
  footprintTranslated = FP_SMD;
  break;
  default:
  footprintTranslated = 0;
  }
  }
 
  footprintName.Trim( true );
  footprintName.Trim( false );
 
  if( footprintName.IsEmpty() )
  {
  if( !aQuiet )
  DisplayInfoMessage( this, _( "No footprint name defined." ) );
 
  return nullptr;
  }
 
  // Creates the new footprint and add it to the head of the linked list of footprints
  FOOTPRINT* footprint = new FOOTPRINT( GetBoard() );
 
  // Update its name in lib
  footprint->SetFPID( LIB_ID( wxEmptyString, footprintName ) );
 
  footprint->SetAttributes( footprintTranslated );
 
  PCB_LAYER_ID txt_layer;
  wxPoint default_pos;
  BOARD_DESIGN_SETTINGS& settings = GetDesignSettings();
 
  footprint->Reference().SetText( settings.m_DefaultFPTextItems[0].m_Text );
  footprint->Reference().SetVisible( settings.m_DefaultFPTextItems[0].m_Visible );
  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[0].m_Layer;
  footprint->Reference().SetLayer( txt_layer );
  default_pos.y -= settings.GetTextSize( txt_layer ).y / 2;
  footprint->Reference().SetPosition( default_pos );
  default_pos.y += settings.GetTextSize( txt_layer ).y;
 
  footprint->Value().SetText( settings.m_DefaultFPTextItems[1].m_Text );
  footprint->Value().SetVisible( settings.m_DefaultFPTextItems[1].m_Visible );
  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[1].m_Layer;
  footprint->Value().SetLayer( txt_layer );
  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
  footprint->Value().SetPosition( default_pos );
  default_pos.y += settings.GetTextSize( txt_layer ).y;
 
  for( size_t i = 2; i < settings.m_DefaultFPTextItems.size(); ++i )
  {
  FP_TEXT* textItem = new FP_TEXT( footprint );
  textItem->SetText( settings.m_DefaultFPTextItems[i].m_Text );
  textItem->SetVisible( settings.m_DefaultFPTextItems[i].m_Visible );
  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[i].m_Layer;
  textItem->SetLayer( txt_layer );
  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
  textItem->SetPosition( default_pos );
  default_pos.y += settings.GetTextSize( txt_layer ).y;
  footprint->GraphicalItems().push_back( textItem );
  }
 
  if( footprint->GetReference().IsEmpty() )
  footprint->SetReference( footprintName );
 
  if( footprint->GetValue().IsEmpty() )
  footprint->SetValue( footprintName );
 
  footprint->RunOnChildren(
  [&] ( BOARD_ITEM* aChild )
  {
  if( aChild->Type() == PCB_FP_TEXT_T )
  {
  FP_TEXT* textItem = static_cast<FP_TEXT*>( aChild );
  PCB_LAYER_ID layer = textItem->GetLayer();
 
  textItem->SetTextThickness( settings.GetTextThickness( layer ) );
  textItem->SetTextSize( settings.GetTextSize( layer ) );
  textItem->SetItalic( settings.GetTextItalic( layer ) );
  textItem->SetKeepUpright( settings.GetTextUpright( layer ) );
  }
  } );
 
  SetMsgPanel( footprint );
  return footprint;
 }

References _, DisplayInfoMessage(), FP_SMD, FP_THROUGH_HOLE, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetDesignSettings(), BOARD_ITEM::GetLayer(), FOOTPRINT::GetReference(), BOARD_DESIGN_SETTINGS::GetTextItalic(), BOARD_DESIGN_SETTINGS::GetTextSize(), BOARD_DESIGN_SETTINGS::GetTextThickness(), BOARD_DESIGN_SETTINGS::GetTextUpright(), FOOTPRINT::GetValue(), FOOTPRINT::GraphicalItems(), BOARD_DESIGN_SETTINGS::m_DefaultFPTextItems, PCB_FP_TEXT_T, FOOTPRINT::Reference(), FOOTPRINT::RunOnChildren(), FOOTPRINT::SetAttributes(), FOOTPRINT::SetFPID(), EDA_TEXT::SetItalic(), FP_TEXT::SetKeepUpright(), BOARD_ITEM::SetLayer(), EDA_DRAW_FRAME::SetMsgPanel(), FP_TEXT::SetPosition(), FOOTPRINT::SetReference(), EDA_TEXT::SetText(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), WX_TEXT_ENTRY_DIALOG::SetTextValidator(), FOOTPRINT::SetValue(), EDA_TEXT::SetVisible(), EDA_ITEM::Type(), and FOOTPRINT::Value().

Referenced by MICROWAVE_TOOL::createBaseFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), and FOOTPRINT_EDITOR_CONTROL::NewFootprint().

◆ CreateNewLibrary()

wxString PCB_BASE_EDIT_FRAME::CreateNewLibrary	(	const wxString &	aLibName = `wxEmptyString`,
		const wxString &	aProposedName = `wxEmptyString`
	)

If a library name is given, creates a new footprint library in the project folder with the given name.

If no library name is given it prompts user for a library path, then creates a new footprint library at that location. If library exists, user is warned about that, and is given a chance to abort the new creation, and in that case existing library is first deleted.

Parameters

aProposedName is the initial path and filename shown in the file chooser dialog.

Returns: The newly created library path if library was successfully created, else wxEmptyString because user aborted or error.

Definition at line 392 of file footprint_libraries_utils.cpp.

 {
  FP_LIB_TABLE* table = selectLibTable();
 
  return createNewLibrary( aLibName, aProposedName, table );
 }

References createNewLibrary(), and selectLibTable().

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary().

◆ createNewLibrary()

wxString PCB_BASE_EDIT_FRAME::createNewLibrary	(	const wxString &	aLibName,
		const wxString &	aProposedName,
		FP_LIB_TABLE *	aTable
	)

protected

Create a new library in the given table (presumed to be either the global or project library table).

Definition at line 401 of file footprint_libraries_utils.cpp.

 {
  // Kicad cannot write legacy format libraries, only .pretty new format because the legacy
  // format cannot handle current features.
  // The footprint library is actually a directory.
 
  if( aTable == nullptr )
  return wxEmptyString;
 
  wxString initialPath = aProposedName.IsEmpty() ? Prj().GetProjectPath() : aProposedName;
  wxFileName fn;
  bool doAdd = false;
  bool isGlobal = ( aTable == &GFootprintTable );
 
  if( aLibName.IsEmpty() )
  {
  fn = initialPath;
 
  if( !LibraryFileBrowser( false, fn, KiCadFootprintLibPathWildcard(),
  KiCadFootprintLibPathExtension, false, isGlobal,
  PATHS::GetDefaultUserFootprintsPath() ) )
  {
  return wxEmptyString;
  }
 
  doAdd = true;
  }
  else
  {
  fn = aLibName;
 
  if( !fn.IsAbsolute() )
  {
  fn.SetName( aLibName );
  fn.MakeAbsolute( initialPath );
  }
 
  // Enforce the .pretty extension:
  fn.SetExt( KiCadFootprintLibPathExtension );
  }
 
  // We can save fp libs only using IO_MGR::KICAD_SEXP format (.pretty libraries)
  IO_MGR::PCB_FILE_T piType = IO_MGR::KICAD_SEXP;
  wxString libPath = fn.GetFullPath();
 
  try
  {
  PLUGIN::RELEASER pi( IO_MGR::PluginFind( piType ) );
 
  bool writable = false;
  bool exists = false;
 
  try
  {
  writable = pi->IsFootprintLibWritable( libPath );
  exists = true; // no exception was thrown, lib must exist.
  }
  catch( const IO_ERROR& )
  {
  // best efforts....
  }
 
  if( exists )
  {
  if( !writable )
  {
  wxString msg = wxString::Format( _( "Library %s is read only." ), libPath );
  ShowInfoBarError( msg );
  return wxEmptyString;
  }
  else
  {
  wxString msg = wxString::Format( _( "Library %s already exists." ), libPath );
  KIDIALOG dlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
  dlg.SetOKLabel( _( "Overwrite" ) );
  dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
 
  if( dlg.ShowModal() == wxID_CANCEL )
  return wxEmptyString;
 
  pi->FootprintLibDelete( libPath );
  }
  }
 
  pi->FootprintLibCreate( libPath );
  }
  catch( const IO_ERROR& ioe )
  {
  DisplayError( this, ioe.What() );
  return wxEmptyString;
  }
 
  if( doAdd )
  AddLibrary( libPath, aTable );
 
  return libPath;
 }

References _, AddLibrary(), DisplayError(), KIDIALOG::DoNotShowCheckbox(), Format(), PATHS::GetDefaultUserFootprintsPath(), PROJECT::GetProjectPath(), GFootprintTable, IO_MGR::KICAD_SEXP, KiCadFootprintLibPathExtension, KiCadFootprintLibPathWildcard(), EDA_DRAW_FRAME::LibraryFileBrowser(), IO_MGR::PluginFind(), KIWAY_HOLDER::Prj(), EDA_BASE_FRAME::ShowInfoBarError(), KIDIALOG::ShowModal(), and IO_ERROR::What().

Referenced by CreateNewLibrary(), and CreateNewProjectLibrary().

◆ CreateNewProjectLibrary()

wxString PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary	(	const wxString &	aLibName = `wxEmptyString`,
		const wxString &	aProposedName = `wxEmptyString`
	)

Definition at line 385 of file footprint_libraries_utils.cpp.

 {
  return createNewLibrary( aLibName, aProposedName, Prj().PcbFootprintLibs() );
 }

References createNewLibrary(), and KIWAY_HOLDER::Prj().

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

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

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

◆ DisplayConstraintsMsg()

void EDA_DRAW_FRAME::DisplayConstraintsMsg ( const wxString & msg )

inherited

Definition at line 518 of file eda_draw_frame.cpp.

 {
  SetStatusText( msg, 7 );
 }

Referenced by DRAWING_TOOL::updateStatusBar().

◆ DisplayGridMsg()

void PCB_BASE_FRAME::DisplayGridMsg ( )

overridevirtualinherited

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 702 of file pcb_base_frame.cpp.

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

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

Referenced by PCB_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

void EDA_DRAW_FRAME::DisplayToolMsg ( const wxString & msg )

overridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 512 of file eda_draw_frame.cpp.

 {
  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 536 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 327 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 PCB_BASE_EDIT_FRAME::doCloseWindow ( )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 78 of file pcb_base_edit_frame.cpp.

 {
  SETTINGS_MANAGER* mgr = GetSettingsManager();
  wxFileName projectName( Prj().GetProjectFullName() );
 
  if( mgr->IsProjectOpen() && wxFileName::IsDirWritable( projectName.GetPath() )
  && projectName.Exists() )
  {
  GFootprintList.WriteCacheToFile( Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
  }
 
  // Close the project if we are standalone, so it gets cleaned up properly
  if( mgr->IsProjectOpen() && Kiface().IsSingle() )
  mgr->UnloadProject( &Prj(), false );
 }

References EDA_BASE_FRAME::GetSettingsManager(), GFootprintList, SETTINGS_MANAGER::IsProjectOpen(), KIFACE_BASE::IsSingle(), Kiface(), KIWAY_HOLDER::Prj(), SETTINGS_MANAGER::UnloadProject(), and FOOTPRINT_LIST_IMPL::WriteCacheToFile().

Referenced by PCB_EDIT_FRAME::doCloseWindow().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 657 of file eda_base_frame.cpp.

 {
  wxDisplay display( wxDisplay::GetFromWindow( this ) );
  wxRect clientSize = display.GetClientArea();
  wxPoint pos = GetPosition();
  wxSize size = GetWindowSize();
 
  wxLogTrace( traceDisplayLocation,
  wxT( "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d" ), clientSize.x, clientSize.y,
  clientSize.width, clientSize.height );
 
  if( pos.y < clientSize.y )
  {
  wxLogTrace( traceDisplayLocation,
  wxT( "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d" ), pos.y,
  clientSize.y );
  pos.y = clientSize.y;
  }
 
  if( pos.x < clientSize.x )
  {
  wxLogTrace( traceDisplayLocation,
  wxT( "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,
  wxT( "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,
  wxT( "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d" ),
  pos.y + size.y, clientSize.height, newHeight );
  size.y = newHeight;
  }
 
  wxLogTrace( traceDisplayLocation, wxT( "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().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )

inherited

Definition at line 305 of file eda_draw_frame.cpp.

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

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

inlinevirtualinherited

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

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 196 of file kiway_player.h.

196 {}

Referenced by KIWAY_PLAYER::OnSockRequest().

◆ findDialogs()

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

protectedinherited

Definition at line 842 of file eda_draw_frame.cpp.

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

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

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 853 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( wxT( "InfoBar" ) ).Hide();
  m_auimgr.Update();
 #endif
 }

References EDA_BASE_FRAME::m_auimgr.

◆ FocusOnItem()

void PCB_BASE_FRAME::FocusOnItem	(	BOARD_ITEM *	aItem,
		PCB_LAYER_ID	aLayer = `UNDEFINED_LAYER`
	)

inherited

Definition at line 204 of file pcb_base_frame.cpp.

 {
  std::vector<BOARD_ITEM*> items;
 
  if( aItem )
  items.push_back( aItem );
 
  FocusOnItems( items, aLayer );
 }

References PCB_BASE_FRAME::FocusOnItems().

Referenced by PCB_SELECTION_TOOL::Main(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_GROUP_PROPERTIES::OnMemberSelected(), DIALOG_GROUP_PROPERTIES::OnRemoveMember(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_DRC::~DIALOG_DRC(), and DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES().

◆ FocusOnItems()

void PCB_BASE_FRAME::FocusOnItems	(	std::vector< BOARD_ITEM * >	aItems,
		PCB_LAYER_ID	aLayer = `UNDEFINED_LAYER`
	)

inherited

Todo:: The Boost entropy exception does not exist prior to 1.67. Once the minimum Boost version is raise to 1.67 or greater, this version check can be removed.

Definition at line 215 of file pcb_base_frame.cpp.

 {
  static std::vector<KIID> lastBrightenedItemIDs;
 
  BOARD_ITEM* lastItem = nullptr;
 
  for( KIID lastBrightenedItemID : lastBrightenedItemIDs )
  {
  #if BOOST_VERSION >= 106700
  try
  {
  lastItem = GetBoard()->GetItem( lastBrightenedItemID );
  }
  catch( const boost::uuids::entropy_error& )
  {
  wxLogError( wxT( "A Boost UUID entropy exception was thrown in %s:%s." ),
  __FILE__, __FUNCTION__ );
  }
  #else
  lastItem = GetBoard()->GetItem( lastBrightenedItemID );
  #endif
 
  if( lastItem && lastItem != DELETED_BOARD_ITEM::GetInstance() )
  {
  lastItem->ClearBrightened();
 
  if( lastItem->Type() == PCB_FOOTPRINT_T )
  {
  static_cast<FOOTPRINT*>( lastItem )->RunOnChildren(
  [&]( BOARD_ITEM* child )
  {
  child->ClearBrightened();
  } );
  }
  else if( lastItem->Type() == PCB_GROUP_T )
  {
  static_cast<PCB_GROUP*>( lastItem )->RunOnChildren(
  [&]( BOARD_ITEM* child )
  {
  child->ClearBrightened();
  } );
  }
 
  GetCanvas()->GetView()->Update( lastItem );
  lastBrightenedItemID = niluuid;
  GetCanvas()->Refresh();
  }
  }
 
  lastBrightenedItemIDs.clear();
 
  if( aItems.empty() )
  return;
 
  wxPoint focusPt;
  KIGFX::VIEW* view = GetCanvas()->GetView();
  SHAPE_POLY_SET viewportPoly( view->GetViewport() );
 
  for( wxWindow* dialog : findDialogs() )
  {
  wxPoint dialogPos = GetCanvas()->ScreenToClient( dialog->GetScreenPosition() );
  SHAPE_POLY_SET dialogPoly( BOX2D( view->ToWorld( dialogPos, true ),
  view->ToWorld( dialog->GetSize(), false ) ) );
 
  try
  {
  viewportPoly.BooleanSubtract( dialogPoly, SHAPE_POLY_SET::PM_FAST );
  }
  catch( const ClipperLib::clipperException& exc )
  {
  // This may be overkill and could be an assertion but we are more likely to
  // find any clipper errors this way.
  wxLogError( wxT( "Clipper library exception '%s' occurred." ), exc.what() );
  }
  }
 
  SHAPE_POLY_SET itemPoly, clippedPoly;
 
  for( BOARD_ITEM* item : aItems )
  {
  if( item && item != DELETED_BOARD_ITEM::GetInstance() )
  {
  item->SetBrightened();
 
  if( item->Type() == PCB_FOOTPRINT_T )
  {
  static_cast<FOOTPRINT*>( item )->RunOnChildren(
  [&]( BOARD_ITEM* child )
  {
  child->SetBrightened();
  });
  }
  else if( item->Type() == PCB_GROUP_T )
  {
  static_cast<PCB_GROUP*>( item )->RunOnChildren(
  [&]( BOARD_ITEM* child )
  {
  child->SetBrightened();
  });
  }
 
  GetCanvas()->GetView()->Update( item );
  lastBrightenedItemIDs.push_back( item->m_Uuid );
 
  // Focus on the object's location. Prefer a visible part of the object to its anchor
  // in order to keep from scrolling around.
 
  focusPt = item->GetPosition();
 
  if( aLayer == UNDEFINED_LAYER )
  aLayer = item->GetLayerSet().Seq()[0];
 
  switch( item->Type() )
  {
  case PCB_FOOTPRINT_T:
  try
  {
  itemPoly = static_cast<FOOTPRINT*>( item )->GetBoundingHull();
  }
  catch( const ClipperLib::clipperException& exc )
  {
  // This may be overkill and could be an assertion but we are more likely to
  // find any clipper errors this way.
  wxLogError( wxT( "Clipper library exception '%s' occurred." ), exc.what() );
  }
 
  break;
 
  case PCB_PAD_T:
  case PCB_MARKER_T:
  case PCB_VIA_T:
  FocusOnLocation( item->GetFocusPosition() );
  GetCanvas()->Refresh();
  return;
 
  case PCB_SHAPE_T:
  case PCB_TEXT_T:
  case PCB_FP_TEXT_T:
  case PCB_FP_SHAPE_T:
  case PCB_FP_ZONE_T:
  case PCB_TRACE_T:
  case PCB_ARC_T:
  case PCB_DIMENSION_T:
  case PCB_DIM_ALIGNED_T:
  case PCB_DIM_LEADER_T:
  case PCB_DIM_CENTER_T:
  case PCB_DIM_ORTHOGONAL_T:
  item->TransformShapeWithClearanceToPolygon( itemPoly, aLayer, 0, Millimeter2iu( 0.1 ),
  ERROR_INSIDE );
  break;
 
  case PCB_ZONE_T:
  {
  ZONE* zone = static_cast<ZONE*>( item );
  #if 0
  // Using the filled area shapes to find a Focus point can give good results, but
  // unfortunately the calculations are highly time consuming, even for not very
  // large areas (can be easily a few minutes for large areas).
  // so we used only the zone outline that usually do not have too many vertices.
  zone->TransformShapeWithClearanceToPolygon( itemPoly, aLayer, 0, Millimeter2iu( 0.1 ),
  ERROR_INSIDE );
 
  if( itemPoly.IsEmpty() )
   itemPoly = *zone->Outline();
  #else
  // much faster calculation time when using only the zone outlines
  itemPoly = *zone->Outline();
  #endif
 
  break;
  }
 
  default:
  {
  BOX2I item_bbox = item->GetBoundingBox();
  itemPoly.NewOutline();
  itemPoly.Append( item_bbox.GetOrigin() );
  itemPoly.Append( item_bbox.GetOrigin() + VECTOR2I( item_bbox.GetWidth(), 0 ) );
  itemPoly.Append( item_bbox.GetOrigin() + VECTOR2I( 0, item_bbox.GetHeight() ) );
  itemPoly.Append( item_bbox.GetOrigin() + VECTOR2I( item_bbox.GetWidth(),
  item_bbox.GetHeight() ) );
  break;
  }
  }
 
  try
  {
  clippedPoly.BooleanIntersection( itemPoly, viewportPoly, SHAPE_POLY_SET::PM_FAST );
  }
  catch( const ClipperLib::clipperException& exc )
  {
  // This may be overkill and could be an assertion but we are more likely to
  // find any clipper errors this way.
  wxLogError( wxT( "Clipper library exception '%s' occurred." ), exc.what() );
  }
 
  if( !clippedPoly.IsEmpty() )
  itemPoly = clippedPoly;
  }
  }
 
  /*
  * Perform a step-wise deflate to find the visual-center-of-mass
  */
 
  BOX2I bbox = itemPoly.BBox();
  int step = std::min( bbox.GetWidth(), bbox.GetHeight() ) / 10;
 
  while( !itemPoly.IsEmpty() )
  {
  focusPt = (wxPoint) itemPoly.BBox().Centre();
 
  try
  {
  itemPoly.Deflate( step, 4, SHAPE_POLY_SET::CHAMFER_ACUTE_CORNERS );
  }
  catch( const ClipperLib::clipperException& exc )
  {
  // This may be overkill and could be an assertion but we are more likely to
  // find any clipper errors this way.
  wxLogError( wxT( "Clipper library exception '%s' occurred." ), exc.what() );
  }
  }
 
  FocusOnLocation( focusPt );
 
  GetCanvas()->Refresh();
 }

References SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::BBox(), SHAPE_POLY_SET::BooleanIntersection(), SHAPE_POLY_SET::BooleanSubtract(), BOX2< Vec >::Centre(), SHAPE_POLY_SET::CHAMFER_ACUTE_CORNERS, EDA_ITEM::ClearBrightened(), SHAPE_POLY_SET::Deflate(), ERROR_INSIDE, EDA_DRAW_FRAME::findDialogs(), EDA_DRAW_FRAME::FocusOnLocation(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOX2< Vec >::GetHeight(), DELETED_BOARD_ITEM::GetInstance(), BOARD::GetItem(), BOX2< Vec >::GetOrigin(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), SHAPE_POLY_SET::IsEmpty(), Millimeter2iu(), SHAPE_POLY_SET::NewOutline(), niluuid, ZONE::Outline(), PCB_ARC_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIMENSION_T, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, SHAPE_POLY_SET::PM_FAST, EDA_DRAW_PANEL_GAL::Refresh(), EDA_ITEM::SetBrightened(), KIGFX::VIEW::ToWorld(), ZONE::TransformShapeWithClearanceToPolygon(), EDA_ITEM::Type(), UNDEFINED_LAYER, and KIGFX::PCB_VIEW::Update().

Referenced by PCB_BASE_FRAME::FocusOnItem(), and DIALOG_DRC::OnDRCItemSelected().

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

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

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

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

◆ Get3DViewerFrame()

EDA_3D_VIEWER_FRAME * PCB_BASE_FRAME::Get3DViewerFrame ( )

inherited

Returns: a reference to the child 3D viewer frame, when exists, or NULL

Definition at line 99 of file pcb_base_frame.cpp.

 {
  wxWindow* frame = FindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( this ) );
  return dynamic_cast<EDA_3D_VIEWER_FRAME*>( frame );
 }

References QUALIFIED_VIEWER3D_FRAMENAME.

Referenced by PCB_BASE_FRAME::canCloseWindow(), PCB_BASE_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::Update3DView(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 514 of file eda_base_frame.h.

514 { return m_aboutTitle; }

EDA_BASE_FRAME::m_aboutTitle

wxString m_aboutTitle

Definition: eda_base_frame.h:704

References EDA_BASE_FRAME::m_aboutTitle.

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

◆ GetActiveLayer()

virtual PCB_LAYER_ID PCB_BASE_FRAME::GetActiveLayer ( ) const

inlinevirtualinherited

Definition at line 363 of file pcb_base_frame.h.

363 { return GetScreen()->m_Active_Layer; }

PCB_SCREEN::m_Active_Layer

PCB_LAYER_ID m_Active_Layer

Definition: pcb_screen.h:42

PCB_BASE_FRAME::GetScreen

PCB_SCREEN * GetScreen() const override

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

Definition: pcb_base_frame.h:229

References PCB_BASE_FRAME::GetScreen(), and PCB_SCREEN::m_Active_Layer.

Referenced by DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_BASE_FRAME::GetCollectorsGuide(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), PCB_CONTROL::LayerNext(), PCB_CONTROL::LayerPrev(), PCB_CONTROL::LayerToggle(), ROUTER_TOOL::MainLoop(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), APPEARANCE_CONTROLS::OnLayerAlphaChanged(), APPEARANCE_CONTROLS::OnLayerChanged(), APPEARANCE_CONTROLS::OnLayerContextMenu(), PCB_DRAW_PANEL_GAL::OnShow(), FOOTPRINT_EDIT_FRAME::OnUpdateLayerSelectBox(), PCB_EDIT_FRAME::OnUpdateLayerSelectBox(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), DRAWING_TOOL::PlaceText(), PCB_EDIT_FRAME::SaveProjectSettings(), PCB_BASE_FRAME::SetDisplayOptions(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), and ROUTER_TOOL::switchLayerOnViaPlacement().

◆ GetAppearancePanel()

APPEARANCE_CONTROLS* PCB_BASE_EDIT_FRAME::GetAppearancePanel ( )

inline

Definition at line 207 of file pcb_base_edit_frame.h.

207 { return m_appearancePanel; }

PCB_BASE_EDIT_FRAME::m_appearancePanel

APPEARANCE_CONTROLS * m_appearancePanel

Definition: pcb_base_edit_frame.h:238

References m_appearancePanel.

Referenced by BOARD_INSPECTION_TOOL::doHideNet(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawZone(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DRAWING_TOOL::PlaceText(), and ROUTER_TOOL::prepareInteractive().

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )

inlinestaticprotectedinherited

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

Definition at line 602 of file eda_base_frame.h.

  {
  return wxT( "_autosave-" );
  }

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), SCH_EDIT_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(), SCH_EDIT_FRAME::saveSchematicFile(), and SCH_EDIT_FRAME::updateAutoSaveFile().

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inlineinherited

Definition at line 204 of file eda_base_frame.h.

204 { return m_autoSaveInterval; }

EDA_BASE_FRAME::m_autoSaveInterval

int m_autoSaveInterval

Definition: eda_base_frame.h:720

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetAuxOrigin()

const wxPoint & PCB_BASE_FRAME::GetAuxOrigin ( ) const

inherited

Definition at line 483 of file pcb_base_frame.cpp.

 {
  return m_pcb->GetDesignSettings().GetAuxOrigin();
 }

References BOARD_DESIGN_SETTINGS::GetAuxOrigin(), BOARD::GetDesignSettings(), and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_BASE_FRAME::GetUserOrigin().

◆ GetBoard()

BOARD* PCB_BASE_FRAME::GetBoard ( ) const

inlineinherited

Definition at line 207 of file pcb_base_frame.h.

  {
  wxASSERT( m_pcb );
  return m_pcb;
  }

References PCB_BASE_FRAME::m_pcb.

◆ GetBoardBoundingBox()

EDA_RECT PCB_BASE_FRAME::GetBoardBoundingBox ( bool aBoardEdgesOnly = false ) const

inherited

Calculate the bounding box containing all board items (or board edge segments).

Parameters

aBoardEdgesOnly is true if we are interested in board edge segments only.

Returns: the board's bounding box.

Definition at line 560 of file pcb_base_frame.cpp.

 {
  EDA_RECT area = aBoardEdgesOnly ? m_pcb->GetBoardEdgesBoundingBox() : m_pcb->GetBoundingBox();
 
  if( area.GetWidth() == 0 && area.GetHeight() == 0 )
  {
  wxSize pageSize = GetPageSizeIU();
 
  if( m_showBorderAndTitleBlock )
  {
  area.SetOrigin( 0, 0 );
  area.SetEnd( pageSize.x, pageSize.y );
  }
  else
  {
  area.SetOrigin( -pageSize.x / 2, -pageSize.y / 2 );
  area.SetEnd( pageSize.x / 2, pageSize.y / 2 );
  }
  }
 
  return area;
 }

References BOARD::GetBoardEdgesBoundingBox(), BOARD::GetBoundingBox(), EDA_RECT::GetHeight(), PCB_BASE_FRAME::GetPageSizeIU(), EDA_RECT::GetWidth(), PCB_BASE_FRAME::m_pcb, EDA_DRAW_FRAME::m_showBorderAndTitleBlock, EDA_RECT::SetEnd(), and EDA_RECT::SetOrigin().

Referenced by FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), and PCB_BASE_FRAME::GetDocumentExtents().

◆ GetCanvas()

PCB_DRAW_PANEL_GAL * PCB_BASE_FRAME::GetCanvas ( ) const

overridevirtualinherited

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

Returns: Pointer to GAL-based canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 911 of file pcb_base_frame.cpp.

 {
  return static_cast<PCB_DRAW_PANEL_GAL*>( EDA_DRAW_FRAME::GetCanvas() );
 }

References EDA_DRAW_FRAME::GetCanvas().

◆ GetCollectorsGuide()

GENERAL_COLLECTORS_GUIDE PCB_BASE_FRAME::GetCollectorsGuide ( )

inherited

Returns: global configuration options.

Definition at line 677 of file pcb_base_frame.cpp.

 {
  GENERAL_COLLECTORS_GUIDE guide( m_pcb->GetVisibleLayers(), GetActiveLayer(),
  GetCanvas()->GetView() );
 
  // account for the globals
  guide.SetIgnoreMTextsMarkedNoShow( ! m_pcb->IsElementVisible( LAYER_MOD_TEXT_INVISIBLE ) );
  guide.SetIgnoreMTextsOnBack( ! m_pcb->IsElementVisible( LAYER_MOD_TEXT ) );
  guide.SetIgnoreMTextsOnFront( ! m_pcb->IsElementVisible( LAYER_MOD_TEXT ) );
  guide.SetIgnoreModulesOnBack( ! m_pcb->IsElementVisible( LAYER_MOD_BK ) );
  guide.SetIgnoreModulesOnFront( ! m_pcb->IsElementVisible( LAYER_MOD_FR ) );
  guide.SetIgnorePadsOnBack( ! m_pcb->IsElementVisible( LAYER_PAD_BK ) );
  guide.SetIgnorePadsOnFront( ! m_pcb->IsElementVisible( LAYER_PAD_FR ) );
  guide.SetIgnoreThroughHolePads( ! m_pcb->IsElementVisible( LAYER_PADS_TH ) );
  guide.SetIgnoreModulesVals( ! m_pcb->IsElementVisible( LAYER_MOD_VALUES ) );
  guide.SetIgnoreModulesRefs( ! m_pcb->IsElementVisible( LAYER_MOD_REFERENCES ) );
  guide.SetIgnoreThroughVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
  guide.SetIgnoreBlindBuriedVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
  guide.SetIgnoreMicroVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
  guide.SetIgnoreTracks( ! m_pcb->IsElementVisible( LAYER_TRACKS ) );
 
  return guide;
 }

References PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), BOARD::GetVisibleLayers(), BOARD::IsElementVisible(), LAYER_MOD_BK, LAYER_MOD_FR, LAYER_MOD_REFERENCES, LAYER_MOD_TEXT, LAYER_MOD_TEXT_INVISIBLE, LAYER_MOD_VALUES, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_TH, LAYER_TRACKS, LAYER_VIAS, PCB_BASE_FRAME::m_pcb, and GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsMarkedNoShow().

Referenced by PCB_CONTROL::DeleteItemCursor(), PAD_TOOL::EnumeratePads(), and BOARD_INSPECTION_TOOL::highlightNet().

◆ GetColorSettings()

COLOR_SETTINGS * PCB_BASE_EDIT_FRAME::GetColorSettings ( ) const

overridevirtual

Helper to retrieve the current color settings.

Returns: a pointer to the active COLOR_SETTINGS.

Reimplemented from PCB_BASE_FRAME.

Definition at line 229 of file pcb_base_edit_frame.cpp.

 {
  return Pgm().GetSettingsManager().GetColorSettings( GetPcbNewSettings()->m_ColorTheme );
 }

References PCB_BASE_FRAME::GetPcbNewSettings(), and Pgm().

Referenced by PCB_EDIT_FRAME::PrepareLayerIndicator(), and DIALOG_PRINT_PCBNEW::saveSettings().

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const

inlinevirtualinherited

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

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

Returns: the filename and full path to the open file

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 439 of file eda_base_frame.h.

439 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

virtual SELECTION& TOOLS_HOLDER::GetCurrentSelection ( )

inlinevirtualinherited

Get the current selection from the canvas area.

Returns: the current selection.

Reimplemented in PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_VIEWER_FRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, DISPLAY_FOOTPRINTS_FRAME, PL_EDITOR_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 101 of file tools_holder.h.

  {
  return m_dummySelection;
  }

References TOOLS_HOLDER::m_dummySelection.

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent(), and ACTION_MANAGER::RunHotKey().

◆ GetDesignRulesPath()

wxString PCB_BASE_EDIT_FRAME::GetDesignRulesPath ( )

Return the absolute path to the design rules file for the currently-loaded board.

Note: There is no guarantee that this file actually exists and can be opened! It only makes sense from PcbNew but is needed in PCB_BASE_EDIT_FRAME::SetBoard.

Definition at line 235 of file pcb_base_edit_frame.cpp.

 {
  if( !GetBoard() )
  return wxEmptyString;
 
  wxFileName fn = GetBoard()->GetFileName();
  fn.SetExt( DesignRulesFileExtension );
  return Prj().AbsolutePath( fn.GetFullName() );
 }

References PROJECT::AbsolutePath(), DesignRulesFileExtension, PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), and KIWAY_HOLDER::Prj().

Referenced by DRAWING_TOOL::DrawVia(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), DIALOG_DRC::OnRunDRCClick(), BOARD_INSPECTION_TOOL::reportClearance(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), PANEL_SETUP_RULES::TransferDataFromWindow(), and PANEL_SETUP_RULES::TransferDataToWindow().

◆ GetDesignSettings()

BOARD_DESIGN_SETTINGS & PCB_BASE_FRAME::GetDesignSettings ( ) const

virtualinherited

Returns the BOARD_DESIGN_SETTINGS for the open project.

Overloaded in FOOTPRINT_EDIT_FRAME.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 523 of file pcb_base_frame.cpp.

 {
  return m_pcb->GetDesignSettings();
 }

References BOARD::GetDesignSettings(), and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_CONTROL::AppendBoard(), PAD_TOOL::copyPadSettings(), MICROWAVE_TOOL::createBaseFootprint(), MICROWAVE_TOOL::createFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), DRAWING_TOOL::DrawSpecificationStackup(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), PCB_EDIT_FRAME::OnUpdateSelectAutoWidth(), PCB_EDIT_FRAME::OnUpdateSelectTrackWidth(), PCB_EDIT_FRAME::OnUpdateSelectViaSize(), PAD_TOOL::pastePadProperties(), DRAWING_TOOL::PlaceText(), PCB_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), PCB_EDIT_FRAME::UpdateTrackWidthSelectBox(), and PCB_EDIT_FRAME::UpdateViaSizeSelectBox().

◆ GetDisplayOptions()

const PCB_DISPLAY_OPTIONS& PCB_BASE_FRAME::GetDisplayOptions ( ) const

inlineinherited

Display options control the way tracks, vias, outlines and other things are shown (for instance solid or sketch mode).

Definition at line 180 of file pcb_base_frame.h.

180 { return m_displayOptions; }

PCB_BASE_FRAME::m_displayOptions

PCB_DISPLAY_OPTIONS m_displayOptions

Definition: pcb_base_frame.h:407

References PCB_BASE_FRAME::m_displayOptions.

◆ GetDocumentExtents()

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

inlineoverridevirtualinherited

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.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 115 of file pcb_base_frame.h.

  {
  /* "Zoom to Fit" calls this with "aIncludeAllVisible" as true. Since that feature
  * always ignored the page and border, this function returns a bbox without them
  * as well when passed true. This technically is not all things visible, but it
  * keeps behavior consistent.
  *
  * When passed false, this function returns a bbox of just the board edge. This
  * allows things like fabrication text or anything else outside the board edge to
  * be ignored, and just zooms up to the board itself.
  *
  * Calling "GetBoardBoundingBox(true)" when edge cuts are turned off will return
  * the entire page and border, so we call "GetBoardBoundingBox(false)" instead.
  */
  if( aIncludeAllVisible || !m_pcb->IsLayerVisible( Edge_Cuts ) )
  return GetBoardBoundingBox( false );
  else
  return GetBoardBoundingBox( true );
  }

References Edge_Cuts, PCB_BASE_FRAME::GetBoardBoundingBox(), BOARD::IsLayerVisible(), and PCB_BASE_FRAME::m_pcb.

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const

inlineinherited

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

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

Definition at line 129 of file tools_holder.h.

129 { return m_immediateActions; }

TOOLS_HOLDER::m_immediateActions

bool m_immediateActions

Definition: tools_holder.h:171

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

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

Definition at line 135 of file tools_holder.h.

135 { return m_dragAction; }

TOOLS_HOLDER::m_dragAction

MOUSE_DRAG_ACTION m_dragAction

Definition: tools_holder.h:175

References TOOLS_HOLDER::m_dragAction.

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

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const

inlinevirtualinherited

Reimplemented in SCH_BASE_FRAME.

Definition at line 173 of file eda_draw_frame.h.

173 { return m_drawBgColor; }

EDA_DRAW_FRAME::m_drawBgColor

COLOR4D m_drawBgColor

Definition: eda_draw_frame.h:494

References EDA_DRAW_FRAME::m_drawBgColor.

Referenced by GERBVIEW_FRAME::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 936 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 GERBVIEW_FRAME::OnDrlFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), SCH_EDIT_FRAME::OnLoadFile(), and GERBVIEW_FRAME::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(), GERBVIEW_FRAME::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.

106 { return m_findStringHistoryList; }

EDA_DRAW_FRAME::m_findStringHistoryList

wxArrayString m_findStringHistoryList

Definition: eda_draw_frame.h:512

References EDA_DRAW_FRAME::m_findStringHistoryList.

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

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )

inlineinherited

Definition at line 105 of file eda_draw_frame.h.

105 { return *m_findReplaceData; }

EDA_DRAW_FRAME::m_findReplaceData

wxFindReplaceData * m_findReplaceData

Definition: eda_draw_frame.h:511

References EDA_DRAW_FRAME::m_findReplaceData.

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

◆ GetFootprintEditorSettings()

FOOTPRINT_EDITOR_SETTINGS * PCB_BASE_FRAME::GetFootprintEditorSettings ( ) const

inherited

Definition at line 850 of file pcb_base_frame.cpp.

 {
  return Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
 }

References Pgm().

Referenced by FOOTPRINT_WIZARD_FRAME::GetColorSettings(), and FOOTPRINT_EDIT_FRAME::GetColorSettings().

◆ GetFootprintFromBoardByReference()

FOOTPRINT * PCB_BASE_FRAME::GetFootprintFromBoardByReference ( )

inherited

Returns: a reference to the footprint found by its reference on the current board. The reference is entered by the user from a dialog (by awxTextCtlr, or a list of available references)

Definition at line 459 of file load_select_footprint.cpp.

 {
  wxString footprintName;
  wxArrayString fplist;
 
  // Build list of available fp references, to display them in dialog
  for( FOOTPRINT* fp : GetBoard()->Footprints() )
  fplist.Add( fp->GetReference() + wxT( " ( " ) + fp->GetValue() + wxT( " )" ) );
 
  fplist.Sort();
 
  DIALOG_GET_FOOTPRINT_BY_NAME dlg( this, fplist );
 
  if( dlg.ShowModal() != wxID_OK ) //Aborted by user
  return nullptr;
 
  footprintName = dlg.GetValue();
  footprintName.Trim( true );
  footprintName.Trim( false );
 
  if( !footprintName.IsEmpty() )
  {
  for( FOOTPRINT* fp : GetBoard()->Footprints() )
  {
  if( fp->GetReference().CmpNoCase( footprintName ) == 0 )
  return fp;
  }
  }
 
  return nullptr;
 }

References FOOTPRINT::Add(), BOARD::Footprints(), GetBoard(), and DIALOG_GET_FOOTPRINT_BY_NAME::GetValue().

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 207 of file eda_base_frame.h.

207 { return m_ident; }

EDA_BASE_FRAME::m_ident

FRAME_T m_ident

Definition: eda_base_frame.h:694

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

427 { return m_galDisplayOptions; }

EDA_DRAW_FRAME::m_galDisplayOptions

KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions

Default display origin transforms object.

Definition: eda_draw_frame.h:528

References EDA_DRAW_FRAME::m_galDisplayOptions.

Referenced by SCH_BASE_FRAME::createCanvas(), EDITOR_CONDITIONS::cursorFunc(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_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().

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )

inlinevirtualinherited

Reimplemented in GERBVIEW_FRAME, FOOTPRINT_EDIT_FRAME, PCB_EDIT_FRAME, DISPLAY_FOOTPRINTS_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 227 of file eda_draw_frame.h.

227 { return m_gridColor; }

EDA_DRAW_FRAME::m_gridColor

COLOR4D m_gridColor

Definition: eda_draw_frame.h:493

References EDA_DRAW_FRAME::m_gridColor.

Referenced by PCB_CONTROL::Reset().

◆ GetGridOrigin()

const wxPoint & PCB_BASE_FRAME::GetGridOrigin ( ) const

overridevirtualinherited

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 471 of file pcb_base_frame.cpp.

 {
  return m_pcb->GetDesignSettings().GetGridOrigin();
 }

References BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetGridOrigin(), and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_BASE_FRAME::GetUserOrigin().

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

234 { return m_infoBar; }

EDA_BASE_FRAME::m_infoBar

WX_INFOBAR * m_infoBar

Definition: eda_base_frame.h:709

References EDA_BASE_FRAME::m_infoBar.

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

◆ GetItem()

EDA_ITEM * PCB_BASE_FRAME::GetItem ( const KIID & aId ) const

overridevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 198 of file pcb_base_frame.cpp.

 {
  return GetBoard()->GetItem( aId );
 }

References PCB_BASE_FRAME::GetBoard(), and BOARD::GetItem().

◆ GetMagneticItemsSettings()

MAGNETIC_SETTINGS * PCB_BASE_FRAME::GetMagneticItemsSettings ( )

virtualinherited

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 856 of file pcb_base_frame.cpp.

 {
  wxCHECK( m_settings, nullptr );
  return &m_settings->m_MagneticItems;
 }

References PCBNEW_SETTINGS::m_MagneticItems, and PCB_BASE_FRAME::m_settings.

Referenced by EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_PICKER_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), DRAWING_TOOL::SetAnchor(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), and PANEL_EDIT_OPTIONS::TransferDataToWindow().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 582 of file eda_base_frame.h.

582 { return m_undoRedoCountMax; }

EDA_BASE_FRAME::m_undoRedoCountMax

int m_undoRedoCountMax

Definition: eda_base_frame.h:723

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetModel()

virtual BOARD_ITEM_CONTAINER* PCB_BASE_FRAME::GetModel ( ) const

pure virtualinherited

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

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

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

Definition at line 141 of file tools_holder.h.

141 { return m_moveWarpsCursor; }

TOOLS_HOLDER::m_moveWarpsCursor

bool m_moveWarpsCursor

Definition: tools_holder.h:177

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 430 of file eda_base_frame.h.

430 { return m_mruPath; }

EDA_BASE_FRAME::m_mruPath

wxString m_mruPath

Definition: eda_base_frame.h:728

References EDA_BASE_FRAME::m_mruPath.

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

◆ GetNearestGridPosition()

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 795 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 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 809 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(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Rotate().

◆ GetOriginTransforms()

ORIGIN_TRANSFORMS & PCB_BASE_FRAME::GetOriginTransforms ( )

overridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 505 of file pcb_base_frame.cpp.

 {
  return m_originTransforms;
 }

References PCB_BASE_FRAME::m_originTransforms.

◆ GetPageSettings()

const PAGE_INFO & PCB_BASE_FRAME::GetPageSettings ( ) const

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 456 of file pcb_base_frame.cpp.

 {
  return m_pcb->GetPageSettings();
 }

References BOARD::GetPageSettings(), and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_CONTROL::Print().

◆ GetPageSizeIU()

const wxSize PCB_BASE_FRAME::GetPageSizeIU ( ) const

overridevirtualinherited

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 462 of file pcb_base_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 m_pcb->GetPageSettings().GetSizeIU();
 }

References BOARD::GetPageSettings(), and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_CONTROL::AppendBoard(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetBoardBoundingBox(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ GetPcbNewSettings()

PCBNEW_SETTINGS * PCB_BASE_FRAME::GetPcbNewSettings ( ) const

inherited

Definition at line 844 of file pcb_base_frame.cpp.

 {
  return Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
 }

References Pgm().

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), DIALOG_PLOT::applyPlotSettings(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_NETLIST_IMPORT::DIALOG_NETLIST_IMPORT(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GetColorSettings(), DIALOG_PLOT::init_Dialog(), DIALOG_GENDRILL::initDialog(), DIALOG_EXPORT_SVG::initDialog(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_DRC::initValues(), DIALOG_BOARD_REANNOTATE::InitValues(), DIALOG_COPPER_ZONE::loadPersistentNetSortConfigurations(), DIALOG_PRINT_PCBNEW::onColorModeClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), DIALOG_EXPORT_SVG::onPagePerLayerClicked(), PNS::TOOL_BASE::Reset(), DIALOG_PRINT_PCBNEW::saveSettings(), DIALOG_COPPER_ZONE::storePersistentNetSortConfigurations(), PCB_EDIT_FRAME::ToggleLayersManager(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataFromWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), PANEL_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), DIALOG_GENDRILL::UpdateConfig(), DIALOG_BOARD_REANNOTATE::~DIALOG_BOARD_REANNOTATE(), DIALOG_CLEANUP_TRACKS_AND_VIAS::~DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_DRC::~DIALOG_DRC(), DIALOG_EXPORT_3DFILE::~DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::~DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::~DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::~DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_IMPORT_GFX::~DIALOG_IMPORT_GFX(), DIALOG_NETLIST_IMPORT::~DIALOG_NETLIST_IMPORT(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetPlotSettings()

const PCB_PLOT_PARAMS & PCB_BASE_FRAME::GetPlotSettings ( ) const

virtualinherited

Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.

Overloaded in FOOTPRINT_EDIT_FRAME.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 548 of file pcb_base_frame.cpp.

 {
  return m_pcb->GetPlotOptions();
 }

References BOARD::GetPlotOptions(), and PCB_BASE_FRAME::m_pcb.

Referenced by DIALOG_PLOT::CreateDrillFile(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_PLOT::DIALOG_PLOT(), and FOOTPRINT_EDIT_FRAME::GetPlotSettings().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 580 of file eda_base_frame.h.

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

UNDO_REDO_CONTAINER::m_CommandsList

std::vector< PICKED_ITEMS_LIST * > m_CommandsList

Definition: undo_redo_container.h:308

EDA_BASE_FRAME::m_redoList

UNDO_REDO_CONTAINER m_redoList

Definition: eda_base_frame.h:726

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

◆ GetRotationAngle()

int PCB_BASE_EDIT_FRAME::GetRotationAngle ( ) const

inline

Return the angle used for rotate operations.

Definition at line 162 of file pcb_base_edit_frame.h.

162 { return m_rotationAngle; }

PCB_BASE_EDIT_FRAME::m_rotationAngle

int m_rotationAngle

Definition: pcb_base_edit_frame.h:234

References m_rotationAngle.

Referenced by TOOL_EVT_UTILS::GetEventRotationAngle(), and PANEL_EDIT_OPTIONS::TransferDataToWindow().

◆ GetScreen()

PCB_SCREEN* PCB_BASE_FRAME::GetScreen ( ) const

inlineoverridevirtualinherited

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 from EDA_DRAW_FRAME.

Definition at line 229 of file pcb_base_frame.h.

229 { return (PCB_SCREEN*) EDA_DRAW_FRAME::GetScreen(); }

PCB_SCREEN

Definition: pcb_screen.h:34

EDA_DRAW_FRAME::GetScreen

virtual BASE_SCREEN * GetScreen() const

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

Definition: eda_draw_frame.h:204

References EDA_DRAW_FRAME::GetScreen().

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_EDIT_FRAME::ClearModify(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), PCB_EDIT_FRAME::doAutoSave(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Files_io_from_id(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetActiveLayer(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), ROUTER_TOOL::handleLayerSwitch(), FOOTPRINT_EDIT_FRAME::IsContentModified(), PCB_CONTROL::LayerToggle(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_BASE_FRAME::OnModify(), DIALOG_POSITION_RELATIVE::OnUseUserOriginClick(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::PrepareLayerIndicator(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PCB_EDIT_FRAME::SavePcbFile(), DIALOG_FIND::search(), ROUTER_TOOL::SelectCopperLayerPair(), PCB_BASE_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPageSettings(), PCB_BASE_FRAME::UpdateStatusBar(), and DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

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

140 { return m_settingsManager; }

EDA_BASE_FRAME::m_settingsManager

SETTINGS_MANAGER * m_settingsManager

Definition: eda_base_frame.h:714

References EDA_BASE_FRAME::m_settingsManager.

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CreateNewProject(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), 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()

SEVERITY PCB_BASE_FRAME::GetSeverity ( int aErrorCode ) const

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 818 of file pcb_base_frame.cpp.

 {
  if( aErrorCode >= CLEANUP_FIRST )
  return RPT_SEVERITY_ACTION;
 
  BOARD_DESIGN_SETTINGS& bds = GetBoard()->GetDesignSettings();
 
  return bds.m_DRCSeverities[ aErrorCode ];
 }

References CLEANUP_FIRST, PCB_BASE_FRAME::GetBoard(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::m_DRCSeverities, and RPT_SEVERITY_ACTION.

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const

inlineinherited

For those frames that support polar coordinates.

Definition at line 120 of file eda_draw_frame.h.

120 { return m_polarCoords; }

EDA_DRAW_FRAME::m_polarCoords

bool m_polarCoords

Definition: eda_draw_frame.h:498

References EDA_DRAW_FRAME::m_polarCoords.

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

◆ GetTitleBlock()

const TITLE_BLOCK & PCB_BASE_FRAME::GetTitleBlock ( ) const

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 511 of file pcb_base_frame.cpp.

 {
  return m_pcb->GetTitleBlock();
 }

References BOARD::GetTitleBlock(), and PCB_BASE_FRAME::m_pcb.

◆ GetToolCanvas()

wxWindow* EDA_DRAW_FRAME::GetToolCanvas ( ) const

inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 422 of file eda_draw_frame.h.

422 { return GetCanvas(); }

EDA_DRAW_FRAME::GetCanvas

virtual EDA_DRAW_PANEL_GAL * GetCanvas() const

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

Definition: eda_draw_frame.h:419

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 54 of file tools_holder.h.

54 { return m_toolManager; }

TOOLS_HOLDER::m_toolManager

TOOL_MANAGER * m_toolManager

Definition: tools_holder.h:158

References TOOLS_HOLDER::m_toolManager.

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

46 { return m_type; }

KIWAY_HOLDER::m_type

HOLDER_TYPE m_type

Definition: kiway_holder.h:76

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 579 of file eda_base_frame.h.

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

EDA_BASE_FRAME::m_undoList

UNDO_REDO_CONTAINER m_undoList

Definition: eda_base_frame.h:725

UNDO_REDO_CONTAINER::m_CommandsList

std::vector< PICKED_ITEMS_LIST * > m_CommandsList

Definition: undo_redo_container.h:308

References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_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 1075 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().

◆ GetUserOrigin()

const wxPoint PCB_BASE_FRAME::GetUserOrigin ( ) const

inherited

Definition at line 489 of file pcb_base_frame.cpp.

 {
  auto& displ_opts = GetDisplayOptions();
  wxPoint origin( 0, 0 );
 
  switch( displ_opts.m_DisplayOrigin )
  {
  case PCB_DISPLAY_OPTIONS::PCB_ORIGIN_PAGE: break;
  case PCB_DISPLAY_OPTIONS::PCB_ORIGIN_AUX: origin = GetAuxOrigin(); break;
  case PCB_DISPLAY_OPTIONS::PCB_ORIGIN_GRID: origin = GetGridOrigin(); break;
  default: wxASSERT( false ); break;
  }
 
  return origin;
 }

References PCB_BASE_FRAME::GetAuxOrigin(), PCB_BASE_FRAME::GetDisplayOptions(), PCB_BASE_FRAME::GetGridOrigin(), PCB_DISPLAY_OPTIONS::PCB_ORIGIN_AUX, PCB_DISPLAY_OPTIONS::PCB_ORIGIN_GRID, and PCB_DISPLAY_OPTIONS::PCB_ORIGIN_PAGE.

Referenced by PCB_ORIGIN_TRANSFORMS::GetUserXOrigin(), and PCB_ORIGIN_TRANSFORMS::GetUserYOrigin().

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

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

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

References KICAD_MAIN_FRAME_T, and EDA_BASE_FRAME::m_ident.

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

◆ GetZoneSettings()

const ZONE_SETTINGS & PCB_BASE_FRAME::GetZoneSettings ( ) const

inherited

Definition at line 536 of file pcb_base_frame.cpp.

 {
  return m_pcb->GetDesignSettings().GetDefaultZoneSettings();
 }

References BOARD_DESIGN_SETTINGS::GetDefaultZoneSettings(), BOARD::GetDesignSettings(), and PCB_BASE_FRAME::m_pcb.

Referenced by ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), and PCB_EDIT_FRAME::Edit_Zone_Params().

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const

inherited

Return a human readable value for display in dialogs.

Definition at line 574 of file eda_draw_frame.cpp.

 {
  // 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 PCB_BASE_EDIT_FRAME::handleActivateEvent ( wxActivateEvent & aEvent )

overrideprotectedvirtual

Handle a window activation event.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 246 of file pcb_base_edit_frame.cpp.

 {
  EDA_DRAW_FRAME::handleActivateEvent( aEvent );
 
  // The text in the collapsible pane headers need to be updated
  if( m_appearancePanel )
  m_appearancePanel->RefreshCollapsiblePanes();
 }

References EDA_DRAW_FRAME::handleActivateEvent(), m_appearancePanel, and APPEARANCE_CONTROLS::RefreshCollapsiblePanes().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

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

Definition at line 1261 of file eda_base_frame.cpp.

 {
  // 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 376 of file eda_base_frame.cpp.

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

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

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

void EDA_DRAW_FRAME::HardRedraw ( )

virtualinherited

Rebuild the GAL and redraws the screen.

Call when something went wrong.

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

Definition at line 829 of file eda_draw_frame.cpp.

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

 {
  return Kiface().GetHelpFileName();
 }

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

Referenced by COMMON_CONTROL::ShowHelp().

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

virtual void EDA_BASE_FRAME::InstallPreferences	(	PAGED_DIALOG *	,
		PANEL_HOTKEYS_EDITOR *
	)

inlinevirtualinherited

Allow a frame to load its preference panels (if any) into the preferences dialog.

Parameters

aParent a paged dialog into which the preference panels should be installed.

Reimplemented in SCH_EDIT_FRAME, PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, PL_EDITOR_FRAME, KICAD_MANAGER_FRAME, and EDA_3D_VIEWER_FRAME.

Definition at line 298 of file eda_base_frame.h.

298 { }

Referenced by EDA_BASE_FRAME::OnPreferences().

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const

inlineprotectedvirtualinherited

Return the auto save status of the application.

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 617 of file eda_base_frame.h.

617 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( ) const

virtualinherited

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

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

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

Definition at line 1138 of file eda_base_frame.cpp.

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

Referenced by GERBVIEW_FRAME::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().

◆ IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( ) const

inherited

Definition at line 408 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(), GERBVIEW_FRAME::IsElementVisible(), PICKER_TOOL::Main(), GERBER_LAYER_WIDGET::OnRenderEnable(), and COMMON_TOOLS::ToggleGrid().

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const

inlineoverridevirtualinherited

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

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 173 of file kiway_player.h.

173 { return m_modal; }

KIWAY_PLAYER::m_modal

bool m_modal

Definition: kiway_player.h:210

References KIWAY_PLAYER::m_modal.

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

◆ IsScriptingConsoleVisible()

bool EDA_DRAW_FRAME::IsScriptingConsoleVisible ( )

inherited

Gets the current visibility of the scripting console window.

Definition at line 249 of file eda_draw_frame.cpp.

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

206 { return m_ident == aType; }

EDA_BASE_FRAME::m_ident

FRAME_T m_ident

Definition: eda_base_frame.h:694

References EDA_BASE_FRAME::m_ident.

◆ IsWritable()

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

inherited

Checks if aFileName can be written.

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

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

Parameters

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

Returns: False if aFileName cannot be written.

Definition at line 1045 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() )
  {
  if( aVerbose )
  wxMessageBox( msg );
 
  return false;
  }
 
  return true;
 }

References _.

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

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const

inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

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

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS & aEvent )

protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 181 of file kiway_player.cpp.

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

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

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

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

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )

protectedinherited

Returns the canvas type stored in the application settings.

Definition at line 723 of file eda_draw_frame.cpp.

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

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

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

◆ LoadFootprint()

FOOTPRINT * PCB_BASE_FRAME::LoadFootprint ( const LIB_ID & aFootprintId )

inherited

Attempt to load aFootprintId from the footprint library table.

Parameters

aFootprintId is the LIB_ID of component footprint to load.

Returns: the FOOTPRINT if found or NULL if aFootprintId not found in any of the libraries in table returned from Prj().PcbFootprintLibs().

Definition at line 312 of file load_select_footprint.cpp.

 {
  FOOTPRINT* footprint = nullptr;
 
  try
  {
  footprint = loadFootprint( aFootprintId );
  }
  catch( const IO_ERROR& )
  {
  }
 
  return footprint;
 }

Referenced by BOARD_NETLIST_UPDATER::addNewFootprint(), FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), FOOTPRINT_EDITOR_CONTROL::ExportFootprint(), DIALOG_EXCHANGE_FOOTPRINTS::processFootprint(), BOARD_NETLIST_UPDATER::replaceFootprint(), and FOOTPRINT_EDITOR_CONTROL::SaveAs().

◆ loadFootprint()

FOOTPRINT * PCB_BASE_FRAME::loadFootprint ( const LIB_ID & aFootprintId )

protectedinherited

Attempts to load aFootprintId from the footprint library table.

Parameters

aFootprintId is the LIB_ID of component footprint to load.

Returns: the FOOTPRINT if found or NULL if aFootprintId not found in any of the libraries in the table returned from Prj().PcbFootprintLibs().

Exceptions

IO_ERROR if an I/O error occurs or a PARSE_ERROR if a file parsing error occurs while reading footprint library files.

Definition at line 328 of file load_select_footprint.cpp.

 {
  FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs();
 
  wxCHECK_MSG( fptbl, nullptr, wxT( "Cannot look up LIB_ID in NULL FP_LIB_TABLE." ) );
 
  FOOTPRINT *footprint = nullptr;
 
  // When loading a footprint from a library in the footprint editor
  // the items UUIDs must be keep and not reinitialized
  bool keepUUID = IsType( FRAME_FOOTPRINT_EDITOR );
 
  try
  {
  footprint = fptbl->FootprintLoadWithOptionalNickname( aFootprintId, keepUUID );
  }
  catch( const IO_ERROR& )
  {
  }
 
  // If the footprint is found, clear all net info to be sure there are no broken links to
  // any netinfo list (should be not needed, but it can be edited from the footprint editor )
  if( footprint )
  footprint->ClearAllNets();
 
  return footprint;
 }

References FOOTPRINT::ClearAllNets(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), FRAME_FOOTPRINT_EDITOR, PROJECT::PcbFootprintLibs(), and Prj().

Referenced by FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_EDIT_FRAME::LoadFootprints(), and FOOTPRINT_EDIT_FRAME::restoreLastFootprint().

◆ LoadSettings()

void PCB_BASE_FRAME::LoadSettings ( APP_SETTINGS_BASE * aCfg )

overridevirtualinherited

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

Reimplemented in PCB_EDIT_FRAME, FOOTPRINT_WIZARD_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 779 of file pcb_base_frame.cpp.

 {
  EDA_DRAW_FRAME::LoadSettings( aCfg );
 
  if( aCfg->m_Window.grid.sizes.empty() )
  aCfg->m_Window.grid.sizes = aCfg->DefaultGridSizeList();
 
  // Currently values read from config file are not used because the user cannot

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ HOLDER_TYPE

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ PCB_BASE_EDIT_FRAME()

◆ ~PCB_BASE_EDIT_FRAME()

Member Function Documentation

◆ ActivateGalCanvas()

◆ AddFootprintToBoard()

◆ AddLibrary()

◆ AddStandardHelpMenu()

◆ AddStandardSubMenus()

◆ AppendMsgPanel()

◆ canCloseWindow()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ ClearFileHistory()

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

◆ Compile_Ratsnest()

◆ config()

◆ ConfigBaseName()

◆ CreateAndShow3D_Frame()

◆ CreateInfoBar()

◆ CreateNewFootprint()

◆ CreateNewLibrary()

◆ createNewLibrary()

◆ CreateNewProjectLibrary()

◆ CreateServer()

◆ CurrentToolName()

◆ Destroy()

◆ DismissModal()

◆ DisplayConstraintsMsg()

◆ DisplayGridMsg()

◆ DisplayToolMsg()

◆ DisplayUnitsMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ ensureWindowIsOnScreen()

◆ EraseMsgBox()

◆ ExecuteRemoteCommand()

◆ findDialogs()

◆ FinishAUIInitialization()

◆ FocusOnItem()

◆ FocusOnItems()

◆ FocusOnLocation()

◆ Get3DViewerFrame()

◆ GetAboutTitle()

◆ GetActiveLayer()

◆ GetAppearancePanel()

◆ GetAutoSaveFilePrefix()

◆ GetAutoSaveInterval()

◆ GetAuxOrigin()

◆ GetBoard()

◆ GetBoardBoundingBox()

◆ GetCanvas()

◆ GetCollectorsGuide()

◆ GetColorSettings()

◆ GetCurrentFileName()

◆ GetCurrentSelection()

◆ GetDesignRulesPath()

◆ GetDesignSettings()

◆ GetDisplayOptions()

◆ GetDocumentExtents()

◆ GetDoImmediateActions()

◆ GetDragAction()

◆ GetDrawBgColor()

◆ GetFileFromHistory()

◆ GetFileHistory()

◆ GetFindHistoryList()