#include <footprint_edit_frame.h>

Inheritance diagram for FOOTPRINT_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
	~FOOTPRINT_EDIT_FRAME ()

BOARD_ITEM_CONTAINER *	GetModel () const override

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

bool	IsContentModified () const override
	Get if any footprints or libraries have been modified but not saved. More...

bool	IsCurrentFPFromBoard () const

bool	CanCloseFPFromBoard (bool doClose)

FOOTPRINT_EDITOR_SETTINGS *	GetSettings ()

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

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

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

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

void	SetPlotSettings (const PCB_PLOT_PARAMS &aSettings) override

MAGNETIC_SETTINGS *	GetMagneticItemsSettings () override

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

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

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

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

bool	canCloseWindow (wxCloseEvent &Event) override

void	doCloseWindow () override

void	CloseFootprintEditor (wxCommandEvent &Event)

void	OnExitKiCad (wxCommandEvent &aEvent)

void	SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) override
	Switch the currently used canvas (Cairo / OpenGL). More...

void	UpdateUserInterface ()
	Update the layer manager and other widgets from the board setup (layer and items visibility, colors ...). More...

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

void	HardRedraw () override
	Refresh the library tree and redraw the window. More...

void	ReCreateHToolbar () override
	Create the main horizontal toolbar for the footprint editor. More...

void	ReCreateVToolbar () override

void	ReCreateOptToolbar () override

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

void	ReCreateLayerBox (bool aForceResizeToolbar=true)
	Re create the layer Box by clearing the old list, and building a new one from the new layers names and layer colors. More...

void	OnUpdateLayerSelectBox (wxUpdateUIEvent &aEvent)

void	SelectLayer (wxCommandEvent &event)

void	setupTools ()

void	OnSaveFootprintAsPng (wxCommandEvent &event)

bool	IsSearchTreeShown () const

void	ToggleSearchTree ()

void	ToggleLayersManager ()

bool	SaveLibraryAs (const wxString &aLibraryPath)
	Save a library to a new name and/or library type. More...

void	OnUpdateLoadFootprintFromBoard (wxUpdateUIEvent &aEvent)

void	OnUpdateSaveFootprintToBoard (wxUpdateUIEvent &aEvent)
	Install the corresponding dialog editor for the given item. More...

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

void	OnLoadFootprintFromBoard (wxCommandEvent &event)
	Called from the main toolbar to load a footprint from board mainly to edit it. More...

void	OnSaveFootprintToBoard (wxCommandEvent &event)

void	LoadFootprintFromLibrary (LIB_ID aFPID)

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > &	GetLibTreeAdapter ()
	Return the adapter object that provides the stored data. More...

bool	SaveFootprint (FOOTPRINT *aFootprint)
	Save in an existing library a given footprint. More...

bool	DuplicateFootprint (FOOTPRINT *aFootprint)

bool	SaveFootprintAs (FOOTPRINT *aFootprint)

bool	SaveFootprintToBoard (bool aAddNew)

bool	SaveFootprintInLibrary (FOOTPRINT *aFootprint, const wxString &aLibraryName)

bool	RevertFootprint ()

void	OnModify () override
	Must be called after a footprint change in order to set the "modify" flag of the current screen and prepare, if needed the refresh of the 3D frame showing the footprint. More...

bool	Clear_Pcb (bool aQuery)
	Delete all and reinitialize the current board. More...

LIB_ID	GetTreeFPID () const
	Return the LIB_ID of the part or library selected in the footprint tree. More...

LIB_TREE_NODE *	GetCurrentTreeNode () const

LIB_ID	GetLoadedFPID () const
	Return the LIB_ID of the part being edited. More...

LIB_ID	GetTargetFPID () const
	Return the LIB_ID of the part selected in the footprint tree, or the loaded part if there is no selection in the tree. More...

void	ClearModify ()

void	ExportFootprint (FOOTPRINT *aFootprint)
	Create a file containing only one footprint. More...

FOOTPRINT *	ImportFootprint (const wxString &aName=wxT(""))
	Read a file containing only one footprint. More...

bool	LoadFootprintFromBoard (FOOTPRINT *aFootprint)
	Load a footprint from the main board into the Footprint Editor. More...

FOOTPRINT *	SelectFootprintFromBoard (BOARD *aPcb)
	Display the list of footprints currently existing on the BOARD. More...

bool	DeleteFootprintFromLibrary (const LIB_ID &aFPID, bool aConfirm)
	Delete the given footprint from its library. More...

COLOR4D	GetGridColor () override

void	SetActiveLayer (PCB_LAYER_ID aLayer) override

void	OnDisplayOptionsChanged () override

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

bool	OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl=0) override
	Load a KiCad board (.kicad_pcb) from aFileName. More...

void	AddFootprintToBoard (FOOTPRINT *aFootprint) override
	Override from PCB_BASE_EDIT_FRAME which adds a footprint to the editor's dummy board, NOT to the user's PCB. More...

void	ReloadFootprint (FOOTPRINT *aFootprint) override
	Override from PCB_BASE_FRAME which reloads the footprint from the library without setting the footprint watcher. More...

void	ShowChangedLanguage () override
	Update visible items after a language change. More...

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

void	SyncLibraryTree (bool aProgress)
	Synchronize the footprint library tree to the current state of the footprint library table. More...

void	RegenerateLibraryTree ()
	Filter, sort, and redisplay the library tree. More...

void	RefreshLibraryTree ()
	Redisplay the library tree. More...

void	UpdateLibraryTree (const wxDataViewItem &treeItem, FOOTPRINT *aFootprint)
	Update a single node in the library tree. More...

void	UpdateView ()

void	UpdateTitle ()

void	FocusOnLibID (const LIB_ID &aLibID)

void	KiwayMailIn (KIWAY_EXPRESS &mail) override
	Receive KIWAY_EXPRESS messages from other players. More...

bool	TryBefore (wxEvent &aEvent) 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...

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	AppendCopyToUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aCommandType) override
	As SaveCopyInUndoList, but appends the changes to the last undo item on the stack. 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)

void	ShowBitmapPropertiesDialog (BOARD_ITEM *aBitmap)
	Set the angle used for rotate operations. More...

void	ShowTextPropertiesDialog (PCB_TEXT *aText)

int	ShowTextBoxPropertiesDialog (PCB_TEXTBOX *aTextBox)

void	ShowGraphicItemPropertiesDialog (PCB_SHAPE *aShape)

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

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

void	ClearListAndDeleteItems (PICKED_ITEMS_LIST *aList)

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

APPEARANCE_CONTROLS *	GetAppearancePanel ()

PROPERTIES_PANEL *	GetPropertiesPanel ()

void	UpdateProperties ()

void	ToggleProperties ()

void	GetContextualTextVars (BOARD_ITEM aSourceItem, const wxString &aCrossRef, wxArrayString aTokens)

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

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

virtual void	SetPageSettings (const PAGE_INFO &aPageSettings) override

const PAGE_INFO &	GetPageSettings () const override

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

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

void	SetGridOrigin (const VECTOR2I &aPoint) override

const VECTOR2I &	GetAuxOrigin () const

const VECTOR2I	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

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)

BOARD *	GetBoard () const

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)

void	HideSolderMask ()

void	ShowSolderMask ()

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

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

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 PCB_LAYER_ID	GetActiveLayer () const

SEVERITY	GetSeverity (int aErrorCode) const override

PCBNEW_SETTINGS *	GetPcbNewSettings () const

FOOTPRINT_EDITOR_SETTINGS *	GetFootprintEditorSettings () const

virtual PCB_VIEWERS_SETTINGS_BASE *	GetViewerSettingsBase () const

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

void	AddBoardChangeListener (wxEvtHandler *aListener)
	Add aListener to post #EDA_EVT_BOARD_CHANGED command events to. More...

void	RemoveBoardChangeListener (wxEvtHandler *aListener)
	Remove aListener to from the board changed listener list. More...

void	OnFPChange (wxFileSystemWatcherEvent &aEvent)
	Handler for FP change events. More...

void	OnFpChangeDebounceTimer (wxTimerEvent &aEvent)
	Handler for the filesystem watcher debounce timer. More...

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

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

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

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

EDA_SEARCH_DATA &	GetFindReplaceData ()

wxArrayString &	GetFindHistoryList ()

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

void	SetShowPolarCoords (bool aShow)

void	ToggleUserUnits () override

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

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

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

virtual COLOR4D	GetDrawBgColor () const

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

virtual wxString	GetScreenDesc () const

virtual wxString	GetFullScreenDesc () const

void	EraseMsgBox ()

virtual void	ReCreateAuxiliaryToolbar ()

bool	IsGridVisible () const

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

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

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

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

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

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

void	OnMove (wxMoveEvent &aEvent) override

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

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

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

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

void	DisplayToolMsg (const wxString &msg) override

void	DisplayConstraintsMsg (const wxString &msg)

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

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

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

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

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

void	SetMsgPanel (EDA_ITEM *aItem)

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

virtual void	PrintPage (const RENDER_SETTINGS *aSettings)
	Print the page pointed by current screen, set by the calling print function. 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	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...

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

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

void	SetModal (bool aIsModal)

bool	IsDismissed ()

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

void	CreateServer (int service, bool local=true)

void	OnSockRequest (wxSocketEvent &evt)

void	OnSockRequestServer (wxSocketEvent &evt)

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

void	ChangeUserUnits (EDA_UNITS aUnits)

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)

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	ShowPreferences (wxString aStartPage, wxString aStartParentPage)
	Displays the preferences and settings of all opened editors paged dialog, starting with a particular page. 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...

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	SaveProjectLocalSettings ()
	Save changes to the project local settings. 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	ReCreateMenuBar ()
	Recreates the menu bar. 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

const wxString &	GetUntranslatedAboutTitle () const

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 void	PushTool (const TOOL_EVENT &aEvent)
	NB: the definition of "tool" is different at the user level. More...

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

bool	ToolStackIsEmpty ()

std::string	CurrentToolName () const

bool	IsCurrentTool (const TOOL_ACTION &aAction) const

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

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

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

HOLDER_TYPE	GetType () const

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

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

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

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

EDA_UNITS	GetUserUnits () const

void	SetUserUnits (EDA_UNITS aUnits)

const EDA_IU_SCALE &	GetIuScale () const

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

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

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

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

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

EDA_ANGLE	AngleValueFromString (const wxString &aTextValue)

Static Public Member Functions
static const wxChar *	GetFootprintEditorFrameName ()

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
	FOOTPRINT_EDIT_FRAME (KIWAY aKiway, wxWindow aParent)
	protected so only friend PCB::IFACE::CreateWindow() can act as sole factory. More...

EDA_LIST_DIALOG *	buildSaveAsDialog (const wxString &aFootprintName, const wxString &aLibraryPreselect)

void	initLibraryTree ()
	Make sure the footprint info list is loaded (with a progress dialog) and then initialize the footprint library tree. More...

void	restoreLastFootprint ()

void	retainLastFootprint ()

void	doReCreateMenuBar () override
	(Re)Create the menubar for the Footprint Editor frame More...

void	editFootprintProperties (FOOTPRINT *aFootprint)
	Run the Footprint Properties dialog and handle changes made in it. More...

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

void	centerItemIdleHandler (wxIdleEvent &aEvent)

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	saveCopyInUndoList (PICKED_ITEMS_LIST *commandToUndo, const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aCommandType)

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

virtual void	onDarkModeToggle ()

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

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

void	rebuildConnectivity ()

void	setFPWatcher (FOOTPRINT *aFootprint)
	Creates (or removes) a watcher on the specified footprint. 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...

void	onIconize (wxIconizeEvent &aEvent)

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

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

void	onSystemColorChange (wxSysColourChangedEvent &aEvent)

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

void	ensureWindowIsOnScreen ()

virtual void	saveProjectSettings ()
	Saves any design-related project settings associated with this frame. More...

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

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

Static Protected Member Functions
static wxString	GetAutoSaveFilePrefix ()

Protected Attributes
PCB_LAYER_BOX_SELECTOR *	m_selLayerBox

FOOTPRINT_EDITOR_SETTINGS *	m_editorSettings

bool	m_undoRedoBlocked

PANEL_SELECTION_FILTER *	m_selectionFilterPanel

APPEARANCE_CONTROLS *	m_appearancePanel

PROPERTIES_PANEL *	m_propertiesPanel

wxAuiNotebook *	m_tabbedPanel

bool	m_darkMode
	Panel with Layers and Object Inspector tabs. More...

bool	m_show_properties

BOARD *	m_pcb

PCB_DISPLAY_OPTIONS	m_displayOptions

PCB_ORIGIN_TRANSFORMS	m_originTransforms

wxSocketServer *	m_socketServer
	Prevents opening same file multiple times. More...

std::unique_ptr< LOCKFILE >	m_file_checker

COLOR4D	m_gridColor

COLOR4D	m_drawBgColor

int	m_undoRedoCountMax

bool	m_polarCoords

bool	m_showBorderAndTitleBlock

wxChoice *	m_gridSelectBox

wxChoice *	m_zoomSelectBox

ACTION_TOOLBAR *	m_mainToolBar

ACTION_TOOLBAR *	m_auxiliaryToolBar

ACTION_TOOLBAR *	m_drawToolBar

ACTION_TOOLBAR *	m_optionsToolBar

std::unique_ptr< EDA_SEARCH_DATA >	m_findReplaceData

wxArrayString	m_findStringHistoryList

wxArrayString	m_replaceStringHistoryList

EDA_MSG_PANEL *	m_messagePanel

int	m_msgFrameHeight

COLOR_SETTINGS *	m_colorSettings

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

EDA_DRAW_PANEL_GAL::GAL_TYPE	m_canvasType

bool	m_modal

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

wxWindow *	m_modal_resultant_parent

wxString	m_modal_string

bool	m_modal_ret_val

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

std::vector< wxFileName >	m_AcceptedFiles

FRAME_T	m_ident

wxPoint	m_framePos

wxSize	m_frameSize

bool	m_maximizeByDefault

int	m_displayIndex

wxPoint	m_normalFramePos

wxSize	m_normalFrameSize

wxString	m_aboutTitle

wxAuiManager	m_auimgr

wxString	m_perspective

WX_INFOBAR *	m_infoBar

wxString	m_configName

SETTINGS_MANAGER *	m_settingsManager

FILE_HISTORY *	m_fileHistory

bool	m_supportsAutoSave

bool	m_autoSavePending

bool	m_autoSaveRequired

wxTimer *	m_autoSaveTimer

UNDO_REDO_CONTAINER	m_undoList

UNDO_REDO_CONTAINER	m_redoList

wxString	m_mruPath

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

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

bool	m_isNonUserClose

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

TOOL_MANAGER *	m_toolManager

ACTIONS *	m_actions

TOOL_DISPATCHER *	m_toolDispatcher

SELECTION	m_dummySelection

std::vector< std::string >	m_toolStack

bool	m_immediateActions

MOUSE_DRAG_ACTION	m_dragAction

bool	m_moveWarpsCursor

Static Protected Attributes
static bool	m_openGLFailureOccured = false
	Has any failure occured when switching to OpenGL in any EDA_DRAW_FRAME? More...

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

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

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

wxWindow *	findQuasiModalDialog ()

Private Attributes
FOOTPRINT_TREE_PANE *	m_treePane

LIB_ID	m_centerItemOnIdle

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER >	m_adapter

bool	m_show_layer_manager_tools

std::unique_ptr< FOOTPRINT >	m_originalFootprintCopy

wxString	m_footprintNameWhenLoaded

std::map< KIID, KIID >	m_boardFootprintUuids

NL_PCBNEW_PLUGIN *	m_spaceMouse

std::unique_ptr< wxFileSystemWatcher >	m_watcher

wxFileName	m_watcherFileName

wxDateTime	m_watcherLastModified

wxTimer	m_watcherDebounceTimer

std::vector< wxEvtHandler * >	m_boardChangeListeners

BASE_SCREEN *	m_currentScreen
	current used SCREEN More...

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

KIGFX::GAL_DISPLAY_OPTIONS	m_galDisplayOptions

KIWAY *	m_kiway

HOLDER_TYPE	m_type

const EDA_IU_SCALE &	m_iuScale

EDA_UNITS	m_userUnits

Friends
struct	PCB::IFACE

Detailed Description

Definition at line 39 of file footprint_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.

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

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

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 111 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ ~FOOTPRINT_EDIT_FRAME()

FOOTPRINT_EDIT_FRAME::~FOOTPRINT_EDIT_FRAME ( )

Definition at line 332 of file footprint_edit_frame.cpp.

References PCB_BASE_EDIT_FRAME::m_appearancePanel, PCB_BASE_EDIT_FRAME::m_selectionFilterPanel, TOOLS_HOLDER::m_toolManager, m_treePane, retainLastFootprint(), PCB_BASE_FRAME::setFPWatcher(), and TOOL_MANAGER::ShutdownAllTools().

◆ FOOTPRINT_EDIT_FRAME()

FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME	(	KIWAY *	aKiway,
		wxWindow *	aParent
	)

protected

protected so only friend PCB::IFACE::CreateWindow() can act as sole factory.

Definition at line 109 of file footprint_edit_frame.cpp.

References _, _HKI, PAGE_INFO::A4, FOOTPRINT_EDITOR_SETTINGS::AUI_PANELS::appearance_panel_tab, ACTIONS::ddAddLibrary, PCB_ACTIONS::ddImportFootprint, TOOL_DISPATCHER::DispatchWxEvent(), F_SilkS, FPHOLDER, GetBoard(), BOARD::GetDesignSettings(), icon_modedit, icon_modedit_16, icon_modedit_32, In1_Cu, EDA_IU_SCALE::IU_PER_MILS, KiBitmap(), KiCadFootprintFileExtension, KiCadFootprintLibPathExtension, FOOTPRINT_EDITOR_SETTINGS::m_ActiveLayerPreset, FOOTPRINT_EDITOR_SETTINGS::m_AuiPanels, FOOTPRINT_EDITOR_SETTINGS::m_LayerPresets, FOOTPRINT_EDITOR_SETTINGS::m_LibWidth, BOARD_DESIGN_SETTINGS::m_NetSettings, BOARD_DESIGN_SETTINGS::m_SolderMaskExpansion, pcbIUScale, FOOTPRINT_EDITOR_SETTINGS::AUI_PANELS::right_panel_width, SetAuiPaneSize(), BOARD::SetBoardUse(), BOARD::SetCopperLayerCount(), BOARD::SetEnabledLayers(), BOARD::SetLayerName(), KIPLATFORM::APP::SetShutdownBlockReason(), BOARD::SetVisibleAlls(), BOARD::SetVisibleLayers(), and ACTIONS::zoomFitScreen.

Member Function Documentation

◆ ActivateGalCanvas()

void FOOTPRINT_EDIT_FRAME::ActivateGalCanvas ( )

overridevirtual

Use to start up the GAL drawing canvas.

Reimplemented from PCB_BASE_FRAME.

Definition at line 1305 of file footprint_edit_frame.cpp.

References PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::SetAxesEnabled(), UpdateUserInterface(), and UpdateView().

◆ AddBoardChangeListener()

void PCB_BASE_FRAME::AddBoardChangeListener ( wxEvtHandler * aListener )

inherited

Add aListener to post #EDA_EVT_BOARD_CHANGED command events to.

Warning: The caller is reponsible for removing any listeners that are no long valid.

Note: This only gets called when the board editor is in stand alone mode. Changing projects in the project manager closes the board editor when a new project is loaded.

Definition at line 244 of file pcb_base_frame.cpp.

References PCB_BASE_FRAME::m_boardChangeListeners.

Referenced by PCB_EDIT_FRAME::GetNetInspectorDialog().

◆ AddFootprintToBoard()

void FOOTPRINT_EDIT_FRAME::AddFootprintToBoard ( FOOTPRINT * aFootprint )

overridevirtual

Override from PCB_BASE_EDIT_FRAME which adds a footprint to the editor's dummy board, NOT to the user's PCB.

Reimplemented from PCB_BASE_FRAME.

Definition at line 572 of file footprint_edit_frame.cpp.

References IsCurrentFPFromBoard(), ReloadFootprint(), and PCB_BASE_FRAME::setFPWatcher().

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), ImportFootprint(), LoadFootprintFromBoard(), LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), restoreLastFootprint(), and RevertFootprint().

◆ AddLibrary()

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

inherited

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.

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

Referenced by PCB_CONTROL::AddLibrary(), and PCB_BASE_EDIT_FRAME::createNewLibrary().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar * aMenuBar )

inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 483 of file eda_base_frame.cpp.

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

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

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

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

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

◆ AngleValueFromString()

EDA_ANGLE UNITS_PROVIDER::AngleValueFromString ( const wxString & aTextValue )

inlineinherited

Definition at line 120 of file units_provider.h.

References DEGREES_T, EDA_UNIT_UTILS::UI::DoubleValueFromString(), and UNITS_PROVIDER::GetIuScale().

Referenced by FP_TEXT_GRID_TABLE::SetValue().

◆ AppendCopyToUndoList()

void PCB_BASE_EDIT_FRAME::AppendCopyToUndoList	(	const PICKED_ITEMS_LIST &	aItemsList,
		UNDO_REDO	aCommandType
	)

overridevirtualinherited

As SaveCopyInUndoList, but appends the changes to the last undo item on the stack.

Implements PCB_BASE_FRAME.

Definition at line 301 of file undo_redo.cpp.

References EDA_BASE_FRAME::PopCommandFromUndoList(), and PCB_BASE_EDIT_FRAME::saveCopyInUndoList().

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

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

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

◆ buildSaveAsDialog()

EDA_LIST_DIALOG * FOOTPRINT_EDIT_FRAME::buildSaveAsDialog	(	const wxString &	aFootprintName,
		const wxString &	aLibraryPreselect
	)

protected

◆ CanCloseFPFromBoard()

bool FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard ( bool doClose )

Definition at line 745 of file footprint_edit_frame.cpp.

References _, Clear_Pcb(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), EDA_BASE_FRAME::GetInfoBar(), FOOTPRINT::GetReference(), HandleUnsavedChanges(), IsContentModified(), SaveFootprint(), WX_INFOBAR::ShowMessageFor(), and UpdateTitle().

◆ canCloseWindow()

bool FOOTPRINT_EDIT_FRAME::canCloseWindow ( wxCloseEvent & Event )

overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 773 of file footprint_edit_frame.cpp.

References _, EDA_BASE_FRAME::canCloseWindow(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), FOOTPRINT::GetFPID(), LIB_ID::GetLibItemName(), FOOTPRINT::GetReference(), HandleUnsavedChanges(), IsContentModified(), IsCurrentFPFromBoard(), m_adapter, SaveFootprint(), and KIPLATFORM::APP::SupportsShutdownBlockReason().

◆ centerItemIdleHandler()

void FOOTPRINT_EDIT_FRAME::centerItemIdleHandler ( wxIdleEvent & aEvent )

protected

Definition at line 116 of file footprint_editor_utils.cpp.

References centerItemIdleHandler(), LIB_TREE::CenterLibId(), FOOTPRINT_TREE_PANE::GetLibTree(), m_centerItemOnIdle, and m_treePane.

Referenced by centerItemIdleHandler(), and LoadFootprintFromLibrary().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1403 of file eda_base_frame.cpp.

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

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

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName & aFileName )

virtualinherited

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

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

Parameters

aFileName A wxFileName object containing the file name to check.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1279 of file eda_base_frame.cpp.

References _, KIPLATFORM::IO::DuplicatePermissions(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), Pgm(), and traceAutoSave.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ Clear_Pcb()

bool FOOTPRINT_EDIT_FRAME::Clear_Pcb ( bool aQuery )

Delete all and reinitialize the current board.

Parameters

aQuery = true to prompt user for confirmation, false to initialize silently

Definition at line 97 of file initpcb.cpp.

References _, EDA_BASE_FRAME::ClearUndoRedoList(), PCB_BASE_FRAME::GetBoard(), BOARD::GetDesignSettings(), GetDesignSettings(), PCB_BASE_FRAME::GetPageSizeIU(), PCB_BASE_FRAME::GetScreen(), HandleUnsavedChanges(), BASE_SCREEN::InitDataPoints(), IsContentModified(), IsCurrentFPFromBoard(), m_boardFootprintUuids, SaveFootprint(), PCB_BASE_EDIT_FRAME::SetBoard(), BOARD::SetBoardUse(), BASE_SCREEN::SetContentModified(), BOARD::SetFileName(), and BOARD::SynchronizeNetsAndNetClasses().

Referenced by CanCloseFPFromBoard(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), doCloseWindow(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), LoadFootprintFromBoard(), LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), OpenProjectFiles(), and RevertFootprint().

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

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

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

◆ ClearListAndDeleteItems()

void PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems ( PICKED_ITEMS_LIST * aList )

inherited

Definition at line 618 of file undo_redo.cpp.

References PICKED_ITEMS_LIST::ClearListAndDeleteItems().

Referenced by PCB_BASE_EDIT_FRAME::ClearUndoORRedoList(), PCB_EDIT_FRAME::Edit_Zone_Params(), BOARD_EDITOR_CONTROL::PlaceFootprint(), and PCB_BASE_EDIT_FRAME::RollbackFromUndo().

◆ ClearModify()

void FOOTPRINT_EDIT_FRAME::ClearModify ( )

Definition at line 489 of file footprint_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), FOOTPRINT::GetFPID(), LIB_ID::GetLibItemName(), PCB_BASE_FRAME::GetScreen(), m_footprintNameWhenLoaded, and BASE_SCREEN::SetContentModified().

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDITOR_CONTROL::Save(), and FOOTPRINT_EDITOR_CONTROL::SaveAs().

◆ ClearMsgPanel()

void EDA_DRAW_FRAME::ClearMsgPanel ( )

virtualinherited

Clear all messages from the message panel.

Reimplemented in SYMBOL_EDIT_FRAME.

Definition at line 749 of file eda_draw_frame.cpp.

References EDA_MSG_PANEL::EraseMsgBox(), EDA_BASE_FRAME::m_isClosing, 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(), DIALOG_EXPORT_NETLIST::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`
	)

overridevirtualinherited

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 594 of file undo_redo.cpp.

References PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), UNDO_REDO_CONTAINER::m_CommandsList, EDA_BASE_FRAME::m_redoList, EDA_BASE_FRAME::m_undoList, and EDA_BASE_FRAME::UNDO_LIST.

Referenced by PCB_BASE_EDIT_FRAME::saveCopyInUndoList().

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

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

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

◆ CloseFootprintEditor()

void FOOTPRINT_EDIT_FRAME::CloseFootprintEditor ( wxCommandEvent & Event )

Definition at line 839 of file footprint_edit_frame.cpp.

◆ commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T aFrameType )

privateinherited

Collect common initialization functions used in all CTORs.

Definition at line 119 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ CommonSettingsChanged()

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

overridevirtual

Called after the preferences dialog is run.

Reimplemented from PCB_BASE_FRAME.

Definition at line 1319 of file footprint_edit_frame.cpp.

References EDA_BASE_FRAME::CommonSettingsChanged(), EDA_DRAW_PANEL_GAL::ForceRefresh(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetDesignSettings(), EDA_DRAW_FRAME::GetGalDisplayOptions(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::MarkTargetDirty(), Pgm(), KIGFX::GAL_DISPLAY_OPTIONS::ReadWindowSettings(), SyncLibraryTree(), KIGFX::TARGET_NONCACHED, KIGFX::VIEW::UpdateAllLayersColor(), and UpdateUserInterface().

◆ 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

aDisplayStatus if true, display the computation results.

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

Parameters

aDisplayStatus : if true, display the computation results

Definition at line 35 of file ratsnest.cpp.

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

Referenced by DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_EDIT_FRAME::OnNetlistChanged(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), PCB_BASE_FRAME::PlaceFootprint(), and PCB_BASE_EDIT_FRAME::PutDataInPreviousState().

◆ config()

APP_SETTINGS_BASE * FOOTPRINT_EDIT_FRAME::config ( ) const

overridevirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 618 of file footprint_edit_frame.cpp.

References m_editorSettings, and Pgm().

Referenced by setupTools().

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

References EDA_BASE_FRAME::m_configName.

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

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

Referenced by PCB_VIEWER_TOOLS::Show3DViewer().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 856 of file eda_base_frame.cpp.

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

Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ 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 1246 of file footprint_libraries_utils.cpp.

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_TEXT_T, FOOTPRINT::Reference(), FOOTPRINT::RunOnChildren(), FOOTPRINT::SetAttributes(), FOOTPRINT::SetFPID(), EDA_TEXT::SetItalic(), EDA_TEXT::SetKeepUpright(), BOARD_ITEM::SetLayer(), EDA_DRAW_FRAME::SetMsgPanel(), PCB_TEXT::SetPosition(), FOOTPRINT::SetReference(), EDA_TEXT::SetText(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), WX_TEXT_ENTRY_DIALOG::SetTextValidator(), FOOTPRINT::SetValue(), EDA_TEXT::SetVisible(), PCB_TEXT::TEXT_is_DIVERS, EDA_ITEM::Type(), FOOTPRINT::Value(), and VECTOR2< T >::y.

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

◆ createNewLibrary()

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

protectedinherited

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

Definition at line 404 of file footprint_libraries_utils.cpp.

References _, PCB_BASE_EDIT_FRAME::AddLibrary(), DisplayError(), KIDIALOG::DoNotShowCheckbox(), EnsureFileExtension(), PLUGIN::FootprintLibCreate(), PLUGIN::FootprintLibDelete(), PATHS::GetDefaultUserFootprintsPath(), PROJECT::GetProjectPath(), GFootprintTable, PLUGIN::IsFootprintLibWritable(), IO_MGR::KICAD_SEXP, KiCadFootprintLibPathExtension, KiCadFootprintLibPathWildcard(), EDA_DRAW_FRAME::LibraryFileBrowser(), IO_MGR::PluginFind(), Prj(), EDA_BASE_FRAME::ShowInfoBarError(), KIDIALOG::ShowModal(), and IO_ERROR::What().

Referenced by PCB_BASE_EDIT_FRAME::CreateNewLibrary(), and PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary().

◆ CreateNewLibrary()

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

inherited

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 395 of file footprint_libraries_utils.cpp.

References PCB_BASE_EDIT_FRAME::createNewLibrary(), and PCB_BASE_EDIT_FRAME::selectLibTable().

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary(), SaveFootprintAs(), and SaveLibraryAs().

◆ CreateNewProjectLibrary()

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

inherited

Definition at line 388 of file footprint_libraries_utils.cpp.

References PCB_BASE_EDIT_FRAME::createNewLibrary(), and 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.

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

Referenced by HandleJob().

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 110 of file tools_holder.cpp.

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

Referenced by TOOLS_HOLDER::ShowChangedLanguage().

◆ DeleteFootprintFromLibrary()

bool FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary	(	const LIB_ID &	aFPID,
		bool	aConfirm
	)

Delete the given footprint from its library.

Definition at line 619 of file footprint_libraries_utils.cpp.

References _, DisplayError(), DisplayInfoMessage(), FP_LIB_TABLE::FindRow(), FP_LIB_TABLE::FootprintDelete(), LIB_TABLE_ROW::GetFullURI(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), IO_MGR::GuessPluginTypeFromLibPath(), INFO_LEGACY_LIB_WARN_DELETE(), IsOK(), LIB_ID::IsValid(), IO_MGR::LEGACY, PROJECT::PcbFootprintLibs(), Prj(), EDA_BASE_FRAME::ShowInfoBarError(), and IO_ERROR::What().

Referenced by SaveFootprint().

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

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

Definition at line 171 of file kiway_player.cpp.

◆ DismissModal()

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

inherited

Definition at line 183 of file kiway_player.cpp.

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

Referenced by EDIT_TOOL::doMoveSelection(), and 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 808 of file pcb_base_frame.cpp.

References PCB_BASE_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetGridSize(), UNITS_PROVIDER::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 600 of file eda_draw_frame.cpp.

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

References _, and UNITS_PROVIDER::GetUserUnits().

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void FOOTPRINT_EDIT_FRAME::doCloseWindow ( )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 810 of file footprint_edit_frame.cpp.

References Clear_Pcb(), PCB_BASE_FRAME::GetCanvas(), GetSettingsManager(), GFootprintList, SETTINGS_MANAGER::IsProjectOpen(), EDA_BASE_FRAME::m_auimgr, Prj(), EDA_DRAW_PANEL_GAL::SetEventDispatcher(), EDA_DRAW_PANEL_GAL::StopDrawing(), and FOOTPRINT_LIST_IMPL::WriteCacheToFile().

◆ doReCreateMenuBar()

void FOOTPRINT_EDIT_FRAME::doReCreateMenuBar ( )

overrideprotectedvirtual

(Re)Create the menubar for the Footprint Editor frame

Reimplemented from PCB_BASE_FRAME.

Definition at line 39 of file menubar_footprint_editor.cpp.

References _, ACTION_MENU::Add(), ACTION_MENU::AddClose(), ACTIONS::addLibrary, AddMenuLanguageList(), EDA_BASE_FRAME::AddStandardHelpMenu(), ACTION_MENU::CHECK, PCB_ACTIONS::checkFootprint, PCB_ACTIONS::cleanupGraphics, ACTIONS::configurePaths, ACTIONS::copy, PCB_ACTIONS::createFootprint, ACTIONS::cut, PCB_ACTIONS::defaultPadProperties, ACTIONS::doDelete, PCB_ACTIONS::drawAlignedDimension, PCB_ACTIONS::drawArc, PCB_ACTIONS::drawCenterDimension, PCB_ACTIONS::drawCircle, PCB_ACTIONS::drawLeader, PCB_ACTIONS::drawLine, PCB_ACTIONS::drawOrthogonalDimension, PCB_ACTIONS::drawPolygon, PCB_ACTIONS::drawRadialDimension, PCB_ACTIONS::drawRectangle, PCB_ACTIONS::drawRuleArea, PCB_ACTIONS::drawTextBox, ACTIONS::duplicate, PCB_ACTIONS::editTextAndGraphics, PCB_ACTIONS::exportFootprint, PCB_ACTIONS::flipBoard, PCB_ACTIONS::footprintProperties, TOOL_MANAGER::GetTool(), PCB_ACTIONS::graphicsOutlines, ACTIONS::gridProperties, ACTIONS::gridResetOrigin, ACTIONS::gridSetOrigin, ACTIONS::highContrastMode, ID_ADD_FOOTPRINT_TO_BOARD, ID_FPEDIT_SAVE_PNG, ID_LOAD_FOOTPRINT_FROM_BOARD, PCB_ACTIONS::importFootprint, ACTIONS::inchesUnits, PCB_ACTIONS::layerAlphaDec, PCB_ACTIONS::layerAlphaInc, TOOLS_HOLDER::m_toolManager, ACTIONS::measureTool, ACTIONS::millimetersUnits, ACTIONS::milsUnits, PCB_ACTIONS::newFootprint, ACTIONS::newLibrary, ACTION_MENU::NORMAL, PCB_ACTIONS::padDisplayMode, ACTIONS::paste, PCB_ACTIONS::placeImage, PCB_ACTIONS::placeImportedGraphics, PCB_ACTIONS::placePad, PCB_ACTIONS::placeText, ACTIONS::print, ACTIONS::redo, PCB_ACTIONS::repairFootprint, ACTIONS::revert, ACTIONS::save, ACTIONS::saveAs, ACTIONS::selectAll, PCB_ACTIONS::setAnchor, ACTION_MENU::SetIcon(), ACTION_MENU::SetTitle(), ACTIONS::show3DViewer, ACTIONS::showFootprintBrowser, ACTIONS::showFootprintLibTable, PCB_ACTIONS::showFootprintTree, PCB_ACTIONS::showLayersManager, PCB_ACTIONS::textOutlines, ACTIONS::toggleCursorStyle, ACTIONS::toggleGrid, ACTIONS::togglePolarCoords, ACTIONS::undo, ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, ACTIONS::zoomRedraw, and ACTIONS::zoomTool.

◆ DoWithAcceptedFiles()

void EDA_BASE_FRAME::DoWithAcceptedFiles ( )

protectedvirtualinherited

Execute action on accepted dropped file.

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

Reimplemented in GERBVIEW_FRAME, KICAD_MANAGER_FRAME, and PL_EDITOR_FRAME.

Definition at line 1226 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::OnDropFiles().

◆ DuplicateFootprint()

bool FOOTPRINT_EDIT_FRAME::DuplicateFootprint ( FOOTPRINT * aFootprint )

Definition at line 870 of file footprint_libraries_utils.cpp.

References DisplayInfoMessage(), FP_LIB_TABLE::FindRow(), FP_LIB_TABLE::FootprintExists(), FOOTPRINT::GetFPID(), LIB_TABLE_ROW::GetFullURI(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), FOOTPRINT::GetValue(), IO_MGR::GuessPluginTypeFromLibPath(), INFO_LEGACY_LIB_WARN_EDIT(), IO_MGR::LEGACY, PROJECT::PcbFootprintLibs(), Prj(), SaveFootprintInLibrary(), FOOTPRINT::SetFPID(), and FOOTPRINT::SetValue().

Referenced by FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint().

◆ editFootprintProperties()

void FOOTPRINT_EDIT_FRAME::editFootprintProperties ( FOOTPRINT * aFootprint )

protected

Run the Footprint Properties dialog and handle changes made in it.

Definition at line 173 of file footprint_editor_utils.cpp.

References FOOTPRINT::GetFPID(), m_adapter, UpdateLibraryTree(), UpdateMsgPanel(), and UpdateTitle().

Referenced by OnEditItemRequest().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 680 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )

inherited

Definition at line 349 of file eda_draw_frame.cpp.

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 182 of file kiway_player.h.

Referenced by DIALOG_BOOK_REPORTER::OnErrorLinkClicked(), and KIWAY_PLAYER::OnSockRequest().

◆ ExportFootprint()

void FOOTPRINT_EDIT_FRAME::ExportFootprint ( FOOTPRINT * aFootprint )

Create a file containing only one footprint.

Definition at line 321 of file footprint_libraries_utils.cpp.

References _, CTL_FOR_LIBRARY, DisplayError(), DisplayErrorMessage(), DisplayInfoMessage(), EnsureFileExtension(), PCB_PLUGIN::Format(), FOOTPRINT::GetFPID(), LIB_ID::GetLibItemName(), GetSettings(), PCB_PLUGIN::GetStringOutput(), KiCadFootprintFileExtension, KiCadFootprintLibFileWildcard(), FOOTPRINT_EDITOR_SETTINGS::m_LastImportExportPath, EDA_BASE_FRAME::m_mruPath, and IO_ERROR::What().

Referenced by FOOTPRINT_EDITOR_CONTROL::ExportFootprint().

◆ findDialogs()

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

protectedinherited

Definition at line 916 of file eda_draw_frame.cpp.

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

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

privateinherited

Definition at line 189 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::findQuasiModalDialog(), FRAME_SCH, and EDA_BASE_FRAME::m_ident.

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

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 868 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::m_auimgr.

Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ FocusOnItem()

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

inherited

Definition at line 293 of file pcb_base_frame.cpp.

References PCB_BASE_FRAME::FocusOnItems().

Referenced by PCB_SELECTION_TOOL::Main(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_GROUP_PROPERTIES::OnMemberSelected(), DIALOG_GROUP_PROPERTIES::OnRemoveMember(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_DRC::~DIALOG_DRC(), DIALOG_FOOTPRINT_CHECKER::~DIALOG_FOOTPRINT_CHECKER(), 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 304 of file pcb_base_frame.cpp.

References SHAPE_POLY_SET::ALLOW_ACUTE_CORNERS, SHAPE_POLY_SET::Append(), ARC_LOW_DEF, SHAPE_POLY_SET::BBox(), SHAPE_POLY_SET::BooleanIntersection(), SHAPE_POLY_SET::BooleanSubtract(), BOX2< Vec >::Centre(), 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(), EDA_IU_SCALE::mmToIU(), 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_DIM_RADIAL_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, pcbIUScale, SHAPE_POLY_SET::PM_FAST, EDA_DRAW_PANEL_GAL::Refresh(), EDA_ITEM::SetBrightened(), ToVECTOR2D(), KIGFX::VIEW::ToWorld(), ZONE::TransformShapeToPolygon(), EDA_ITEM::Type(), UNDEFINED_LAYER, and KIGFX::PCB_VIEW::Update().

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

◆ FocusOnLibID()

void FOOTPRINT_EDIT_FRAME::FocusOnLibID ( const LIB_ID & aLibID )

Definition at line 1081 of file footprint_edit_frame.cpp.

References FOOTPRINT_TREE_PANE::GetLibTree(), m_treePane, and LIB_TREE::SelectLibId().

Referenced by FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), and FOOTPRINT_EDITOR_CONTROL::SaveAs().

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const VECTOR2I & aPos )

inherited

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

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

Parameters

aPos	is the point to go to.

Definition at line 930 of file eda_draw_frame.cpp.

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

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

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

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

References EDA_BASE_FRAME::m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), PGM_SINGLE_TOP::OnPgmInit(), and PGM_KICAD::OnPgmInit().

◆ GetActiveLayer()

virtual PCB_LAYER_ID PCB_BASE_FRAME::GetActiveLayer ( ) const

inlinevirtualinherited

Definition at line 363 of file pcb_base_frame.h.

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

Referenced by DIALOG_GLOBAL_EDIT_TEARDROPS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), CONVERT_TOOL::CreatePolys(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_SELECTION_TOOL::GetActiveLayer(), 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::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), APPEARANCE_CONTROLS::OnLayerChanged(), APPEARANCE_CONTROLS::OnLayerContextMenu(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), PCB_DRAW_PANEL_GAL::OnShow(), OnUpdateLayerSelectBox(), PCB_EDIT_FRAME::OnUpdateLayerSelectBox(), LENGTH_TUNER_TOOL::performTuning(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceStackup(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), ROUTER_TOOL::RouteSelected(), PCB_EDIT_FRAME::saveProjectSettings(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetDisplayOptions(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), ROUTER_TOOL::switchLayerOnViaPlacement(), PCB_CONTROL::UpdateMessagePanel(), and PCB_EDIT_FRAME::UpdateUserInterface().

◆ GetAppearancePanel()

APPEARANCE_CONTROLS * PCB_BASE_EDIT_FRAME::GetAppearancePanel ( )

inlineinherited

Definition at line 221 of file pcb_base_edit_frame.h.

References PCB_BASE_EDIT_FRAME::m_appearancePanel.

Referenced by PCB_EDIT_FRAME::CommonSettingsChanged(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), ROUTER_TOOL::performRouting(), 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 604 of file eda_base_frame.h.

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inherited

Definition at line 317 of file eda_base_frame.cpp.

References Pgm().

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

◆ GetAuxOrigin()

const VECTOR2I & PCB_BASE_FRAME::GetAuxOrigin ( ) const

inherited

Definition at line 593 of file pcb_base_frame.cpp.

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 203 of file pcb_base_frame.h.

References PCB_BASE_FRAME::m_pcb.

◆ GetBoardBoundingBox()

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

References BOARD::GetBoardEdgesBoundingBox(), BOARD::GetBoundingBox(), BOX2< Vec >::GetHeight(), PCB_BASE_FRAME::GetPageSizeIU(), BOX2< Vec >::GetWidth(), PCB_BASE_FRAME::m_pcb, EDA_DRAW_FRAME::m_showBorderAndTitleBlock, BOX2< Vec >::SetEnd(), BOX2< Vec >::SetOrigin(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_BASE_FRAME::GetDocumentExtents(), and 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 1050 of file pcb_base_frame.cpp.

References EDA_DRAW_FRAME::GetCanvas().

◆ GetCollectorsGuide()

GENERAL_COLLECTORS_GUIDE PCB_BASE_FRAME::GetCollectorsGuide ( )

inherited

Returns: global configuration options.

Definition at line 783 of file pcb_base_frame.cpp.

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

◆ GetColorSettings()

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

overridevirtual

Helper to retrieve the current color settings.

Reimplemented from PCB_BASE_FRAME.

Definition at line 693 of file footprint_edit_frame.cpp.

References PCB_BASE_FRAME::GetFootprintEditorSettings(), APP_SETTINGS_BASE::m_ColorTheme, and Pgm().

Referenced by GetGridColor().

◆ GetContextualTextVars()

void PCB_BASE_EDIT_FRAME::GetContextualTextVars	(	BOARD_ITEM *	aSourceItem,
		const wxString &	aCrossRef,
		wxArrayString *	aTokens
	)

inherited

Definition at line 327 of file pcb_base_edit_frame.cpp.

References BOARD::Footprints(), BOARD_ITEM::GetBoard(), BOARD::GetContextualTextVars(), BOARD_ITEM::GetParentFootprint(), BOARD::GetProject(), and PROJECT::GetTextVars().

Referenced by DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES().

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const

inlinevirtualinherited

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

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

Returns: the filename and full path to the open file

Reimplemented in SCH_EDIT_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, and PCB_EDIT_FRAME.

Definition at line 433 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

SELECTION & FOOTPRINT_EDIT_FRAME::GetCurrentSelection ( )

overridevirtual

Get the current selection from the canvas area.

Returns: the current selection.

Reimplemented from TOOLS_HOLDER.

Definition at line 372 of file footprint_edit_frame.cpp.

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

◆ GetCurrentTreeNode()

LIB_TREE_NODE * FOOTPRINT_EDIT_FRAME::GetCurrentTreeNode ( ) const

Definition at line 458 of file footprint_edit_frame.cpp.

References LIB_TREE::GetCurrentTreeNode(), FOOTPRINT_TREE_PANE::GetLibTree(), and m_treePane.

Referenced by FOOTPRINT_EDITOR_CONTROL::Init(), FOOTPRINT_EDITOR_CONTROL::PinLibrary(), and FOOTPRINT_EDITOR_CONTROL::UnpinLibrary().

◆ GetDesignRulesPath()

wxString PCB_BASE_EDIT_FRAME::GetDesignRulesPath ( )

inherited

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 266 of file pcb_base_edit_frame.cpp.

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

Referenced by PCB_EDIT_FRAME::CommonSettingsChanged(), DRAWING_TOOL::DrawVia(), BOARD_INSPECTION_TOOL::makeDRCEngine(), PCB_EDIT_FRAME::onBoardLoaded(), DIALOG_DRC::OnRunDRCClick(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), PANEL_SETUP_RULES::TransferDataFromWindow(), and PANEL_SETUP_RULES::TransferDataToWindow().

◆ GetDesignSettings()

BOARD_DESIGN_SETTINGS & FOOTPRINT_EDIT_FRAME::GetDesignSettings ( ) const

overridevirtual

Returns the BOARD_DESIGN_SETTINGS for the open project.

Reimplemented from PCB_BASE_FRAME.

Definition at line 589 of file footprint_edit_frame.cpp.

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

Referenced by Clear_Pcb(), LoadSettings(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), and SaveSettings().

◆ 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 171 of file pcb_base_frame.h.

References PCB_BASE_FRAME::m_displayOptions.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), PCB_BASE_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), PAD_TOOL::EditPad(), PCB_CONTROL::HighContrastMode(), PCB_CONTROL::HighContrastModeCycle(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_CONTROL::NetColorModeCycle(), APPEARANCE_CONTROLS::onNetColorMode(), APPEARANCE_CONTROLS::onObjectOpacitySlider(), PCB_DRAW_PANEL_GAL::OnShow(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), PNS::TOOL_BASE::pickSingleItem(), PCB_EDIT_FRAME::Process_Special_Functions(), PAD_TOOL::Reset(), PCB_EDIT_FRAME::saveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), SelectLayer(), PCB_SELECTION_TOOL::selectPoint(), PCB_EDIT_FRAME::SetActiveLayer(), setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), APPEARANCE_CONTROLS::syncObjectSettings(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), PCB_CONTROL::ZoneDisplayMode(), and PCB_EDITOR_CONDITIONS::zoneDisplayModeFunc().

◆ GetDocumentExtents()

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

overridevirtual

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

Definition at line 709 of file footprint_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetBoardBoundingBox(), FOOTPRINT::GetBoundingBox(), BOARD::GetFirstFootprint(), FOOTPRINT::GraphicalItems(), BOX2< Vec >::Inflate(), EDA_IU_SCALE::mmToIU(), FOOTPRINT::Pads(), PCB_TEXT_T, pcbIUScale, and FOOTPRINT::Zones().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const

inlineinherited

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

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

Definition at line 141 of file tools_holder.h.

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

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

Definition at line 147 of file tools_holder.h.

References TOOLS_HOLDER::m_dragAction.

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

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const

inlinevirtualinherited

Reimplemented in SCH_BASE_FRAME.

Definition at line 167 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_drawBgColor.

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

◆ GetFileFromHistory()

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

inherited

Fetches the file name from the file history list.

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

Parameters

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

Returns: a wxString containing the selected filename

Definition at line 951 of file eda_base_frame.cpp.

References _, DisplayErrorMessage(), 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 417 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString & EDA_DRAW_FRAME::GetFindHistoryList ( )

inlineinherited

Definition at line 107 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_findStringHistoryList.

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

◆ GetFindReplaceData()

EDA_SEARCH_DATA & EDA_DRAW_FRAME::GetFindReplaceData ( )

inlineinherited

Definition at line 106 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_findReplaceData.

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

◆ GetFootprintEditorFrameName()

const wxChar * FOOTPRINT_EDIT_FRAME::GetFootprintEditorFrameName ( )

static

Returns: the frame name used when creating the frame used to get a reference to this frame, if exists; the primary data model.

Definition at line 583 of file footprint_edit_frame.cpp.

References FOOTPRINT_EDIT_FRAME_NAME.

◆ GetFootprintEditorSettings()

FOOTPRINT_EDITOR_SETTINGS * PCB_BASE_FRAME::GetFootprintEditorSettings ( ) const

inherited

Definition at line 952 of file pcb_base_frame.cpp.

References Pgm().

Referenced by PCB_POINT_EDITOR::changeArcEditMode(), GetColorSettings(), FOOTPRINT_WIZARD_FRAME::GetColorSettings(), and PCB_POINT_EDITOR::OnSelectionChange().

◆ 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 463 of file load_select_footprint.cpp.

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

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 201 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_ident.

Referenced by DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), PCB_BASE_FRAME::GetViewerSettingsBase(), and EDA_BASE_FRAME::ShowPreferences().

◆ GetFullScreenDesc()

wxString EDA_DRAW_FRAME::GetFullScreenDesc ( ) const

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1043 of file eda_draw_frame.cpp.

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

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

References EDA_DRAW_FRAME::m_galDisplayOptions.

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

◆ GetGridColor()

COLOR4D FOOTPRINT_EDIT_FRAME::GetGridColor ( )

overridevirtual

Returns: the color of the grid

Reimplemented from EDA_DRAW_FRAME.

Definition at line 277 of file footprint_editor_utils.cpp.

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

◆ GetGridOrigin()

const VECTOR2I & 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 581 of file pcb_base_frame.cpp.

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.

References EDA_BASE_FRAME::m_infoBar.

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

◆ GetItem()

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

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

Referenced by PAD_TOOL::EditPad().

◆ GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 45 of file units_provider.h.

References UNITS_PROVIDER::m_iuScale.

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

◆ GetLibTreeAdapter()

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > & FOOTPRINT_EDIT_FRAME::GetLibTreeAdapter ( )

inline

Return the adapter object that provides the stored data.

Definition at line 173 of file footprint_edit_frame.h.

References m_adapter.

Referenced by FOOTPRINT_TREE_PANE::FOOTPRINT_TREE_PANE(), and FOOTPRINT_EDITOR_CONTROL::RenameFootprint().

◆ GetLoadedFPID()

LIB_ID FOOTPRINT_EDIT_FRAME::GetLoadedFPID ( ) const

Return the LIB_ID of the part being edited.

Definition at line 478 of file footprint_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), FOOTPRINT::GetFPID(), LIB_ID::GetLibNickname(), and m_footprintNameWhenLoaded.

Referenced by FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), GetTargetFPID(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), OnSaveFootprintAsPng(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), retainLastFootprint(), RevertFootprint(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), and UpdateTitle().

◆ GetMagneticItemsSettings()

MAGNETIC_SETTINGS * FOOTPRINT_EDIT_FRAME::GetMagneticItemsSettings ( )

overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 700 of file footprint_edit_frame.cpp.

References GetSettings(), and FOOTPRINT_EDITOR_SETTINGS::m_MagneticItems.

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 578 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetModel()

BOARD_ITEM_CONTAINER * FOOTPRINT_EDIT_FRAME::GetModel ( ) const

overridevirtual

Returns: the primary data model.

Implements PCB_BASE_FRAME.

Definition at line 446 of file footprint_edit_frame.cpp.

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

Referenced by UpdateMsgPanel().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

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

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

Definition at line 153 of file tools_holder.h.

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 424 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_mruPath.

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

◆ GetNearestGridPosition()

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

inherited

Return the nearest aGridSize location to aPosition.

Parameters

aPosition The position to check.

Returns: The nearest grid position.

Definition at line 869 of file eda_draw_frame.cpp.

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

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

◆ GetNearestHalfGridPosition()

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

inherited

Return the nearest aGridSize / 2 location to aPosition.

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

Parameters

aPosition The position to check.

Returns: The nearest half-grid position.

Definition at line 883 of file eda_draw_frame.cpp.

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

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

◆ GetOriginTransforms()

ORIGIN_TRANSFORMS & PCB_BASE_FRAME::GetOriginTransforms ( )

overridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from EDA_BASE_FRAME.

Definition at line 614 of file pcb_base_frame.cpp.

References PCB_BASE_FRAME::m_originTransforms.

◆ GetPageSettings()

const PAGE_INFO & PCB_BASE_FRAME::GetPageSettings ( ) const

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 566 of file pcb_base_frame.cpp.

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

Referenced by PCB_CONTROL::Print().

◆ GetPageSizeIU()

const VECTOR2I 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 572 of file pcb_base_frame.cpp.

References BOARD::GetPageSettings(), PAGE_INFO::GetSizeIU(), EDA_IU_SCALE::IU_PER_MILS, PCB_BASE_FRAME::m_pcb, and pcbIUScale.

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

◆ GetPcbNewSettings()

PCBNEW_SETTINGS * PCB_BASE_FRAME::GetPcbNewSettings ( ) const

inherited

Definition at line 946 of file pcb_base_frame.cpp.

References Pgm().

◆ GetPlotSettings()

const PCB_PLOT_PARAMS & FOOTPRINT_EDIT_FRAME::GetPlotSettings ( ) const

overridevirtual

Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.

Reimplemented from PCB_BASE_FRAME.

Definition at line 595 of file footprint_edit_frame.cpp.

References PCB_BASE_FRAME::GetPlotSettings().

◆ GetPropertiesPanel()

PROPERTIES_PANEL * PCB_BASE_EDIT_FRAME::GetPropertiesPanel ( )

inlineinherited

Definition at line 223 of file pcb_base_edit_frame.h.

References PCB_BASE_EDIT_FRAME::m_propertiesPanel.

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 576 of file eda_base_frame.h.

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

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

◆ GetRotationAngle()

EDA_ANGLE FOOTPRINT_EDIT_FRAME::GetRotationAngle ( ) const

overridevirtual

Return the angle used for rotate operations.

Reimplemented from PCB_BASE_EDIT_FRAME.

Definition at line 684 of file footprint_edit_frame.cpp.

References ANGLE_90, GetSettings(), and FOOTPRINT_EDITOR_SETTINGS::m_RotationAngle.

◆ 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 227 of file pcb_base_frame.h.

References EDA_DRAW_FRAME::GetScreen().

Referenced by Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), ClearModify(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), PCB_EDIT_FRAME::doAutoSave(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExportSpecctraFile(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_BASE_FRAME::GetActiveLayer(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), ROUTER_TOOL::handleLayerSwitch(), IsContentModified(), PCB_EDIT_FRAME::IsContentModified(), PCB_CONTROL::LayerToggle(), LoadFootprintFromBoard(), LoadFootprintFromLibrary(), EDIT_TOOL::MoveExact(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), PCB_BASE_FRAME::OnModify(), OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::PrepareLayerIndicator(), RevertFootprint(), PCB_EDIT_FRAME::SavePcbFile(), DIALOG_FIND::search(), ROUTER_TOOL::SelectCopperLayerPair(), PCB_BASE_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPageSettings(), PCB_EDIT_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 1036 of file eda_draw_frame.cpp.

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

◆ GetSettings()

FOOTPRINT_EDITOR_SETTINGS * FOOTPRINT_EDIT_FRAME::GetSettings ( )

Definition at line 609 of file footprint_edit_frame.cpp.

References m_editorSettings, and Pgm().

Referenced by DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), ExportFootprint(), GetMagneticItemsSettings(), GetRotationAngle(), ImportFootprint(), LoadSettings(), SaveSettings(), setupUIConditions(), ToggleLayersManager(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR().

◆ GetSettingsManager()

SETTINGS_MANAGER * EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

◆ GetSeverity()

SEVERITY PCB_BASE_FRAME::GetSeverity ( int aErrorCode ) const

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 923 of file pcb_base_frame.cpp.

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

References EDA_DRAW_FRAME::m_polarCoords.

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

◆ GetTargetFPID()

LIB_ID FOOTPRINT_EDIT_FRAME::GetTargetFPID ( ) const

Return the LIB_ID of the part selected in the footprint tree, or the loaded part if there is no selection in the tree.

Definition at line 464 of file footprint_edit_frame.cpp.

References empty(), GetLoadedFPID(), GetTreeFPID(), and IsSearchTreeShown().

Referenced by FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), RegenerateLibraryTree(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), setupUIConditions(), and SyncLibraryTree().

◆ GetTitleBlock()

const TITLE_BLOCK & PCB_BASE_FRAME::GetTitleBlock ( ) const

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 620 of file pcb_base_frame.cpp.

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

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.

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), PCB_SEARCH_HANDLER::ActivateItem(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), PCB_PROPERTIES_PANEL::AfterCommit(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), SCH_NAVIGATE_TOOL::Back(), BOARD_COMMIT::BOARD_COMMIT(), SCH_NAVIGATE_TOOL::changeSheet(), 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(), SIMULATOR_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SCH_FIELD::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_NAVIGATE_TOOL::Forward(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), PCB_PROPERTIES_PANEL::getPropertyFromEvent(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineBreakTrack(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::LoadProjectSettings(), LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnDeleteOneClick(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemSelected(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), GERBER_LAYER_WIDGET::onPopupSelection(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_PANE::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), PCB_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected(), PANEL_KICAD_LAUNCHER::PANEL_KICAD_LAUNCHER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), PCB_BASE_FRAME::rebuildConnectivity(), SIMULATOR_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::RollbackFromUndo(), SaveFootprintToBoard(), PCB_EDIT_FRAME::saveProjectSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), SaveSettings(), SCHEMATIC_COMMIT::SCHEMATIC_COMMIT(), DIALOG_FIND::search(), SCH_SEARCH_HANDLER::SelectItems(), FOOTPRINT_SEARCH_HANDLER::SelectItems(), ZONE_SEARCH_HANDLER::SelectItems(), TEXT_SEARCH_HANDLER::SelectItems(), CVPCB_MAINFRAME::setupEventHandlers(), setupTools(), TOOLS_HOLDER::ShowChangedLanguage(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), SIMULATOR_CONTROL::Tune(), PCB_PROPERTIES_PANEL::UpdateData(), DIALOG_DRC::updateDisplayedCounts(), CVPCB_MAINFRAME::updateFootprintViewerOnIdle(), NET_GRID_TABLE::updateNetVisibility(), PCB_PROPERTIES_PANEL::valueChanged(), PCB_PROPERTIES_PANEL::valueChanging(), DIALOG_IMPORT_NETLIST::~DIALOG_IMPORT_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetTreeFPID()

LIB_ID FOOTPRINT_EDIT_FRAME::GetTreeFPID ( ) const

Return the LIB_ID of the part or library selected in the footprint tree.

Definition at line 452 of file footprint_edit_frame.cpp.

References FOOTPRINT_TREE_PANE::GetLibTree(), LIB_TREE::GetSelectedLibId(), and m_treePane.

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), FOOTPRINT_EDITOR_CONTROL::EditFootprint(), FOOTPRINT_EDITOR_CONTROL::ExportFootprint(), GetTargetFPID(), FOOTPRINT_EDITOR_CONTROL::Init(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), and FOOTPRINT_EDITOR_CONTROL::RenameFootprint().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

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

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

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

◆ GetUnitPair()

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

inherited

Get the pair or units in current use.

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

Definition at line 1172 of file eda_draw_frame.cpp.

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

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

◆ GetUntranslatedAboutTitle()

const wxString & EDA_BASE_FRAME::GetUntranslatedAboutTitle ( ) const

inlineinherited

Definition at line 510 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_aboutTitle.

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

◆ GetUserOrigin()

const VECTOR2I PCB_BASE_FRAME::GetUserOrigin ( ) const

inherited

Definition at line 599 of file pcb_base_frame.cpp.

References PCB_BASE_FRAME::GetAuxOrigin(), PCB_BASE_FRAME::GetGridOrigin(), and PCB_BASE_FRAME::GetPcbNewSettings().

Referenced by PCB_ORIGIN_TRANSFORMS::getUserXOrigin(), and PCB_ORIGIN_TRANSFORMS::getUserYOrigin().

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 42 of file units_provider.h.

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_BOOK_REPORTER::AddHTMLPage(), PG_UNIT_EDITOR::CreateControls(), PCB::IFACE::CreateKiWindow(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PROPERTIES_PANEL::extractValueAndWritability(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), WX_GRID::GetUnitValue(), GetUserUnits(), UNIT_BINDER::init(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), PANEL_PREVIEW_3D_MODEL::onUnitsChanged(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PG_UNIT_EDITOR::PG_UNIT_EDITOR(), PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL(), POSITION_RELATIVE_TOOL::PositionRelative(), PROPERTIES_PANEL::rebuildProperties(), DRC_TOOL::RunTests(), EDA_DRAW_FRAME::SaveSettings(), PCB_BASE_FRAME::SetBoard(), WX_GRID::SetUnitsProvider(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), UNITS_PROVIDER::StringFromValue(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), PCB_BASE_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), PG_UNIT_EDITOR::UpdateFrame(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), DRC_TOOL::userUnits(), and UNITS_PROVIDER::ValueFromString().

◆ GetViewerSettingsBase()

PCB_VIEWERS_SETTINGS_BASE * PCB_BASE_FRAME::GetViewerSettingsBase ( ) const

virtualinherited

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE * aCfg )

virtualinherited

Return a pointer to the window settings for this frame.

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

Parameters

aCfg	is this frame's config object

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

Definition at line 825 of file eda_base_frame.cpp.

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

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

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

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

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

◆ handleActivateEvent()

void PCB_BASE_EDIT_FRAME::handleActivateEvent ( wxActivateEvent & aEvent )

overrideprotectedvirtualinherited

Handle a window activation event.

Reimplemented from PCB_BASE_FRAME.

Definition at line 277 of file pcb_base_edit_frame.cpp.

References PCB_BASE_FRAME::handleActivateEvent(), PCB_BASE_EDIT_FRAME::m_appearancePanel, and APPEARANCE_CONTROLS::RefreshCollapsiblePanes().

◆ handleIconizeEvent()

void PCB_BASE_FRAME::handleIconizeEvent ( wxIconizeEvent & aEvent )

overrideprotectedvirtualinherited

Handle a window iconize event.

Parameters

aEvent is the data for the event.

Reimplemented from EDA_BASE_FRAME.

Definition at line 128 of file pcb_base_frame.cpp.

References ADVANCED_CFG::GetCfg(), EDA_BASE_FRAME::handleIconizeEvent(), PCB_BASE_FRAME::m_spaceMouse, ADVANCED_CFG::m_Use3DConnexionDriver, and NL_PCBNEW_PLUGIN::SetFocus().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

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

Definition at line 1463 of file eda_base_frame.cpp.

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

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 FOOTPRINT_EDIT_FRAME::HardRedraw ( )

overridevirtual

Refresh the library tree and redraw the window.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 392 of file footprint_edit_frame.cpp.

References EDA_DRAW_PANEL_GAL::ForceRefresh(), PCB_BASE_FRAME::GetCanvas(), and SyncLibraryTree().

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const

inlineinherited

Safety check before asking for the Kiway reference.

Returns: true if kiway is non-null

Definition at line 63 of file kiway_holder.h.

References KIWAY_HOLDER::m_kiway.

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 844 of file eda_base_frame.cpp.

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ HideSolderMask()

void PCB_BASE_FRAME::HideSolderMask ( )

inherited

Definition at line 534 of file pcb_base_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::HasItem(), and KIGFX::PCB_VIEW::Remove().

Referenced by EDIT_TOOL::doMoveSelection(), BOARD_COMMIT::Push(), and PCB_BASE_EDIT_FRAME::PutDataInPreviousState().

◆ ImportFootprint()

FOOTPRINT * FOOTPRINT_EDIT_FRAME::ImportFootprint ( const wxString & aName = wxT( "" ) )

Read a file containing only one footprint.

The import function can also read gpcb footprint file, in Newlib format. (One footprint per file, Newlib files have no special ext.)

Definition at line 237 of file footprint_libraries_utils.cpp.

References _, AddFootprintToBoard(), BOARD::BuildListOfNets(), detect_file_type(), DisplayError(), IO_MGR::FILE_TYPE_NONE, fileType(), PCB_BASE_FRAME::GetBoard(), getFootprintFilenameFromUser(), GetSettings(), FOOTPRINT_EDITOR_SETTINGS::m_LastImportExportPath, EDA_BASE_FRAME::m_mruPath, PCB_BASE_FRAME::PlaceFootprint(), FOOTPRINT::SetFPID(), EDA_DRAW_FRAME::SetMsgPanel(), FOOTPRINT::SetPosition(), try_load_footprint(), UpdateView(), and IO_ERROR::What().

Referenced by FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), and OpenProjectFiles().

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

◆ initLibraryTree()

void FOOTPRINT_EDIT_FRAME::initLibraryTree ( )

protected

Make sure the footprint info list is loaded (with a progress dialog) and then initialize the footprint library tree.

Definition at line 998 of file footprint_edit_frame.cpp.

References _, FP_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_SYNCHRONIZING_ADAPTER::Create(), FOOTPRINT_LIST::DisplayErrors(), FOOTPRINT_LIST::GetCount(), FOOTPRINT_LIST::GetErrorCount(), GFootprintList, m_adapter, PROJECT::PcbFootprintLibs(), Prj(), FOOTPRINT_LIST_IMPL::ReadCacheFromFile(), and FOOTPRINT_LIST_IMPL::ReadFootprintFiles().

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

Definition at line 630 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_autoSaveRequired.

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool FOOTPRINT_EDIT_FRAME::IsContentModified ( ) const

overridevirtual

Get if any footprints or libraries have been modified but not saved.

Returns: true if the any changes have not been saved

Reimplemented from EDA_BASE_FRAME.

Definition at line 365 of file footprint_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), PCB_BASE_FRAME::GetScreen(), and BASE_SCREEN::IsContentModified().

Referenced by CanCloseFPFromBoard(), canCloseWindow(), Clear_Pcb(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), RevertFootprint(), and UpdateTitle().

◆ IsCurrentFPFromBoard()

bool FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard ( ) const

Definition at line 498 of file footprint_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), FOOTPRINT::GetLink(), EDA_BASE_FRAME::m_isClosing, and niluuid.

Referenced by AddFootprintToBoard(), canCloseWindow(), Clear_Pcb(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), LoadFootprintFromBoard(), LoadFootprintFromLibrary(), ReloadFootprint(), and UpdateTitle().

◆ IsCurrentTool()

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

inherited

Definition at line 119 of file tools_holder.cpp.

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

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

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )

inherited

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

Definition at line 177 of file kiway_player.cpp.

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

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 159 of file kiway_player.h.

References KIWAY_PLAYER::m_modal.

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

◆ IsScriptingConsoleVisible()

bool EDA_DRAW_FRAME::IsScriptingConsoleVisible ( )

inherited

Gets the current visibility of the scripting console window.

Definition at line 264 of file eda_draw_frame.cpp.

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

Referenced by EDITOR_CONDITIONS::consoleVisibleFunc().

◆ IsSearchTreeShown()

bool FOOTPRINT_EDIT_FRAME::IsSearchTreeShown ( ) const

Definition at line 440 of file footprint_edit_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, and m_treePane.

Referenced by GetTargetFPID(), LoadFootprintFromBoard(), setupUIConditions(), and ToggleSearchTree().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inlineinherited

Definition at line 200 of file eda_base_frame.h.

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

References _, and DisplayErrorMessage().

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.

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), IMPORT_PROJ_HELPER::AssociateFileWithProj(), CVPCB_MAINFRAME::BuildLibrariesListBox(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), BOARD_INSPECTION_TOOL::constructDiffPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), PGM_SINGLE_TOP::MacOpenFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), KIWAY_HOLDER::Prj(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), SIMULATOR_CONTROL::Tune(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS & aEvent )

protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 198 of file kiway_player.cpp.

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void FOOTPRINT_EDIT_FRAME::KiwayMailIn ( KIWAY_EXPRESS & aEvent )

overridevirtual

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

Reimplemented from KIWAY_PLAYER.

Definition at line 315 of file footprint_editor_utils.cpp.

References _, KIWAY_EXPRESS::Command(), DisplayErrorMessage(), LIB_TABLE::FindRowByURI(), FOOTPRINT_TREE_PANE::GetLibTree(), LIB_TABLE_ROW::GetNickName(), KIWAY_EXPRESS::GetPayload(), LIB_TABLE::HasLibrary(), m_treePane, MAIL_FP_EDIT, MAIL_RELOAD_LIB, PROJECT::PcbFootprintLibs(), Prj(), RefreshLibraryTree(), LIB_TREE::SelectLibId(), and SyncLibraryTree().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent & event )

protectedinherited

An event handler called on a language menu selection.

Definition at line 205 of file kiway_player.cpp.

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

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

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

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )

protectedinherited

Returns the canvas type stored in the application settings.

Definition at line 810 of file eda_draw_frame.cpp.

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

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

◆ 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 316 of file load_select_footprint.cpp.

References PCB_BASE_FRAME::loadFootprint().

Referenced by BOARD_NETLIST_UPDATER::addNewFootprint(), FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), LoadFootprintFromLibrary(), DIALOG_EXCHANGE_FOOTPRINTS::processFootprint(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), 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 332 of file load_select_footprint.cpp.

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

Referenced by PCB_BASE_FRAME::LoadFootprint(), PCB_EDIT_FRAME::LoadFootprints(), restoreLastFootprint(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ LoadFootprintFromBoard()

bool FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard ( FOOTPRINT * aFootprint )

Load a footprint from the main board into the Footprint Editor.

Parameters

aFootprint = the footprint to load. If NULL, the user will be asked for a footprint reference.

Returns: true if a footprint is loaded.

Definition at line 79 of file load_select_footprint.cpp.

References AddFootprintToBoard(), ANGLE_0, Clear_Pcb(), FOOTPRINT::ClearAllNets(), EDA_ITEM::ClearFlags(), EDA_BASE_FRAME::ClearUndoRedoList(), FOOTPRINT::Clone(), F_Cu, FOOTPRINT::Flip(), FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetFirstFootprint(), FOOTPRINT::GetFPID(), FOOTPRINT::GetLayer(), FOOTPRINT_TREE_PANE::GetLibTree(), PCB_BASE_FRAME::GetPcbNewSettings(), FOOTPRINT::GetPosition(), PCB_BASE_FRAME::GetScreen(), EDA_DRAW_PANEL_GAL::GetViewControls(), IsCurrentFPFromBoard(), IsSearchTreeShown(), Kiway, m_adapter, m_boardFootprintUuids, PCBNEW_SETTINGS::m_FlipLeftRight, m_treePane, EDA_ITEM::m_Uuid, PAD_PROPERTIES_DLG_NAME, PCB_PAD_T, PCB_BASE_FRAME::PlaceFootprint(), KIWAY::Player(), ReCreateHToolbar(), EDA_BASE_FRAME::ReCreateMenuBar(), EDA_DRAW_PANEL_GAL::Refresh(), LIB_TREE::RefreshLibTree(), FOOTPRINT::RunOnChildren(), SelectFootprintFromBoard(), BASE_SCREEN::SetContentModified(), KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition(), FOOTPRINT::SetLink(), BOARD_ITEM::SetLocked(), FOOTPRINT::SetOrientation(), EDA_ITEM::SetParent(), BOARD_ITEM::SetParentGroup(), FOOTPRINT::SetPosition(), ToggleSearchTree(), EDA_ITEM::Type(), PCB_BASE_FRAME::Update3DView(), UpdateView(), and EDA_DRAW_FRAME::Zoom_Automatique().

Referenced by OnLoadFootprintFromBoard().

◆ LoadFootprintFromLibrary()

void FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary ( LIB_ID aFPID )

Definition at line 56 of file footprint_editor_utils.cpp.

References AddFootprintToBoard(), centerItemIdleHandler(), Clear_Pcb(), EDA_ITEM::ClearFlags(), LIB_TREE::ExpandLibId(), PCB_BASE_FRAME::GetCanvas(), FOOTPRINT_TREE_PANE::GetLibTree(), PCB_BASE_FRAME::GetScreen(), EDA_TEXT::GetText(), EDA_DRAW_PANEL_GAL::GetViewControls(), IsCurrentFPFromBoard(), PCB_BASE_FRAME::LoadFootprint(), m_centerItemOnIdle, m_treePane, ReCreateHToolbar(), EDA_BASE_FRAME::ReCreateMenuBar(), FOOTPRINT::Reference(), EDA_DRAW_PANEL_GAL::Refresh(), LIB_TREE::RefreshLibTree(), BASE_SCREEN::SetContentModified(), KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition(), EDA_TEXT::SetText(), PCB_TEXT::SetType(), PCB_TEXT::TEXT_is_REFERENCE, PCB_TEXT::TEXT_is_VALUE, PCB_BASE_FRAME::Update3DView(), UpdateView(), FOOTPRINT::Value(), and EDA_DRAW_FRAME::Zoom_Automatique().

Referenced by FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), FOOTPRINT_EDITOR_CONTROL::EditFootprint(), FOOTPRINT_TREE_PANE::onComponentSelected(), and FOOTPRINT_EDITOR_CONTROL::PasteFootprint().

◆ LoadSettings()

void FOOTPRINT_EDIT_FRAME::LoadSettings ( APP_SETTINGS_BASE * aCfg )

overridevirtual

Load common frame parameters from a configuration file.

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

Reimplemented from PCB_BASE_FRAME.

Definition at line 625 of file footprint_edit_frame.cpp.

References GetDesignSettings(), FOOTPRINT_TREE_PANE::GetLibTree(), GetSettings(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), PCB_BASE_FRAME::LoadSettings(), FOOTPRINT_EDITOR_SETTINGS::m_AuiPanels, FOOTPRINT_EDITOR_SETTINGS::m_DesignSettings, FOOTPRINT_EDITOR_SETTINGS::m_Display, PCB_BASE_FRAME::m_displayOptions, FOOTPRINT_EDITOR_SETTINGS::m_LibrarySortMode, FOOTPRINT_EDITOR_SETTINGS::m_SelectionFilter, PCB_BASE_EDIT_FRAME::m_selectionFilterPanel, m_show_layer_manager_tools, PCB_BASE_EDIT_FRAME::m_show_properties, m_treePane, PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), LIB_TREE::SetSortMode(), FOOTPRINT_EDITOR_SETTINGS::AUI_PANELS::show_layer_manager, and FOOTPRINT_EDITOR_SETTINGS::AUI_PANELS::show_properties.

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS * aCfg )

inherited

Load window settings from the given settings object.

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

Definition at line 733 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE & aState )

virtualinherited

Load frame state info from a configuration file.

Definition at line 586 of file eda_base_frame.cpp.

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

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString & aFileName )

inherited

Definition at line 572 of file eda_base_frame.cpp.

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

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

◆ LockFile()

bool EDA_DRAW_FRAME::LockFile ( const wxString & aFileName )

inherited

Mark a schematic file as being in use.

Use ReleaseFile() to undo this.

Parameters

aFileName full path to the file.

Returns: true if the file is locked or read-only, false otherwise.

Definition at line 217 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_file_checker.

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

◆ MessageTextFromValue() [1/2]

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

inlineinherited

Definition at line 96 of file units_provider.h.

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

◆ MessageTextFromValue() [2/2]

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

inlineinherited

A lower-precision version of StringFromValue().

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

Definition at line 89 of file units_provider.h.

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

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce )

inlineinherited

Definition at line 586 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onActivate()

void EDA_DRAW_FRAME::onActivate ( wxActivateEvent & aEvent )

protectedinherited

Definition at line 1217 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::handleActivateEvent().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protectedinherited

Handle the auto save timer event.

Definition at line 323 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::commonInit().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent & aKeyEvent )

virtualinherited

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

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

Reimplemented in SYMBOL_VIEWER_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 343 of file eda_base_frame.cpp.

References dump(), and kicadTraceKeyEvent.

◆ onDarkModeToggle()

void PCB_BASE_EDIT_FRAME::onDarkModeToggle ( )

protectedvirtualinherited

Definition at line 287 of file pcb_base_edit_frame.cpp.

References PCB_BASE_EDIT_FRAME::m_appearancePanel, and APPEARANCE_CONTROLS::OnDarkModeToggle().

Referenced by PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME().

◆ OnDisplayOptionsChanged()

void FOOTPRINT_EDIT_FRAME::OnDisplayOptionsChanged ( )

overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 1087 of file footprint_edit_frame.cpp.

References PCB_BASE_EDIT_FRAME::m_appearancePanel, and APPEARANCE_CONTROLS::UpdateDisplayOptions().

◆ OnDropFiles()

void EDA_BASE_FRAME::OnDropFiles ( wxDropFilesEvent & aEvent )

protectedvirtualinherited

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

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

Definition at line 1204 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::DoWithAcceptedFiles(), GerberFileExtension, IsGerberFileExtension(), EDA_BASE_FRAME::m_acceptedExts, and EDA_BASE_FRAME::m_AcceptedFiles.

◆ OnEditItemRequest()

void FOOTPRINT_EDIT_FRAME::OnEditItemRequest ( BOARD_ITEM * aItem )

overridevirtual

Install the corresponding dialog editor for the given item.

Parameters

aDC	the current device context.
aItem	a pointer to the BOARD_ITEM to edit.

Implements PCB_BASE_EDIT_FRAME.

Definition at line 189 of file footprint_editor_utils.cpp.

References _, editFootprintProperties(), ZONE_SETTINGS::ExportSetting(), PCB_BASE_FRAME::GetCanvas(), EDA_ITEM::GetClass(), ZONE::GetIsRuleArea(), TOOL_MANAGER::GetTool(), PCB_ACTIONS::groupProperties, InvokeCopperZonesEditor(), InvokeNonCopperZonesEditor(), InvokeRuleAreaEditor(), ZONE::IsOnCopperLayer(), TOOLS_HOLDER::m_toolManager, COMMIT::Modify(), PCB_BITMAP_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_ZONE_T, BOARD_COMMIT::Push(), EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), PCB_BASE_EDIT_FRAME::ShowBitmapPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), DIALOG_SHIM::ShowQuasiModal(), PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog(), and EDA_ITEM::Type().

◆ OnExitKiCad()

void FOOTPRINT_EDIT_FRAME::OnExitKiCad ( wxCommandEvent & aEvent )

Definition at line 833 of file footprint_edit_frame.cpp.

References Kiway, and KIWAY::OnKiCadExit().

◆ OnFPChange()

void PCB_BASE_FRAME::OnFPChange ( wxFileSystemWatcherEvent & aEvent )

inherited

Handler for FP change events.

Responds to the filesystem watcher set in setFPWatcher.

Definition at line 1201 of file pcb_base_frame.cpp.

References PCB_BASE_FRAME::m_watcherDebounceTimer, and PCB_BASE_FRAME::m_watcherFileName.

Referenced by PCB_BASE_FRAME::setFPWatcher().

◆ OnFpChangeDebounceTimer()

void PCB_BASE_FRAME::OnFpChangeDebounceTimer ( wxTimerEvent & aEvent )

inherited

Handler for the filesystem watcher debounce timer.

Definition at line 1215 of file pcb_base_frame.cpp.

References _, DisplayError(), FP_LIB_TABLE::FootprintLoad(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), FOOTPRINT::GetFPID(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), PCB_BASE_FRAME::GetScreen(), EDA_BASE_FRAME::IsContentModified(), IsOK(), PCB_BASE_FRAME::m_watcherFileName, PCB_BASE_FRAME::m_watcherLastModified, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), PCB_BASE_FRAME::ReloadFootprint(), and IO_ERROR::What().

Referenced by PCB_BASE_FRAME::PCB_BASE_FRAME().

◆ OnGridSettings()

void EDA_DRAW_FRAME::OnGridSettings ( wxCommandEvent & event )

inherited

Definition at line 478 of file eda_draw_frame.cpp.

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

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent & aEvent )

protectedinherited

Definition at line 1489 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::handleIconizeEvent().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

Definition at line 1009 of file eda_base_frame.cpp.

References ShowAboutDialog().

◆ OnLoadFootprintFromBoard()

void FOOTPRINT_EDIT_FRAME::OnLoadFootprintFromBoard ( wxCommandEvent & event )

Called from the main toolbar to load a footprint from board mainly to edit it.

Definition at line 50 of file footprint_editor_utils.cpp.

References LoadFootprintFromBoard().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

inherited

Definition at line 1415 of file eda_base_frame.cpp.

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

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent & event )

inherited

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

Definition at line 353 of file eda_base_frame.cpp.

References TOOL_DISPATCHER::DispatchWxEvent(), and TOOLS_HOLDER::m_toolDispatcher.

◆ OnModify()

void FOOTPRINT_EDIT_FRAME::OnModify ( )

overridevirtual

Must be called after a footprint change in order to set the "modify" flag of the current screen and prepare, if needed the refresh of the 3D frame showing the footprint.

Do not forget to call the basic OnModify function to update auxiliary info.

Reimplemented from PCB_BASE_FRAME.

Definition at line 915 of file footprint_edit_frame.cpp.

References FOOTPRINT_TREE_PANE::GetLibTree(), m_treePane, PCB_BASE_FRAME::OnModify(), LIB_TREE::RefreshLibTree(), PCB_BASE_FRAME::Update3DView(), and UpdateTitle().

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), and FOOTPRINT_EDITOR_CONTROL::RepairFootprint().

◆ OnMove()

void EDA_DRAW_FRAME::OnMove ( wxMoveEvent & aEvent )

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 563 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_FRAME::m_canvas, EDA_DRAW_FRAME::m_galDisplayOptions, KIGFX::GAL_DISPLAY_OPTIONS::m_scaleFactor, KIGFX::VIEW::MarkDirty(), KIGFX::GAL::ResizeScreen(), and KIGFX::GAL_DISPLAY_OPTIONS::UpdateScaleFactor().

◆ OnPageSettingsChange()

virtual void EDA_DRAW_FRAME::OnPageSettingsChange ( )

inlinevirtualinherited

Called when modifying the page settings.

In derived classes it can be used to modify parameters like draw area size, and any other local parameter related to the page settings.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 326 of file eda_draw_frame.h.

Referenced by DIALOG_PAGES_SETTINGS::TransferDataFromWindow().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

inherited

Displays the preferences and settings of all opened editors paged dialog.

Definition at line 1016 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::ShowPreferences().

Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch(), and COMMON_CONTROL::OpenPreferences().

◆ OnSaveFootprintAsPng()

void FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng ( wxCommandEvent & event )

Definition at line 1342 of file footprint_edit_frame.cpp.

References _, DisplayErrorMessage(), empty(), GetLoadedFPID(), PngFileWildcard(), Prj(), and SaveCanvasImageToFile().

◆ OnSaveFootprintToBoard()

void FOOTPRINT_EDIT_FRAME::OnSaveFootprintToBoard ( wxCommandEvent & event )

Definition at line 133 of file footprint_editor_utils.cpp.

References SaveFootprintToBoard().

◆ OnSelectGrid()

void EDA_DRAW_FRAME::OnSelectGrid ( wxCommandEvent & event )

inherited

Command event handler for selecting grid sizes.

All commands that set the grid size should eventually end up here. This is where the application setting is saved. If you override this method, make sure you call down to the base class.

Parameters

event Command event from the grid size combobox on the toolbar.

Definition at line 439 of file eda_draw_frame.cpp.

References dummy, ACTIONS::gridPreset, ACTIONS::gridProperties, EDA_DRAW_FRAME::m_canvas, EDA_DRAW_FRAME::m_gridSelectBox, TOOLS_HOLDER::m_toolManager, EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), EDA_DRAW_PANEL_GAL::SetFocus(), and EDA_DRAW_FRAME::UpdateStatusBar().

◆ OnSelectZoom()

void EDA_DRAW_FRAME::OnSelectZoom ( wxCommandEvent & event )

virtualinherited

Set the zoom factor when selected by the zoom list box in the main tool bar.

Note: List position 0 is fit to page. List position >= 1 = zoom (1 to zoom max). Last list position is custom zoom not in zoom list.

Definition at line 545 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_canvas, TOOLS_HOLDER::m_toolManager, EDA_DRAW_FRAME::m_zoomSelectBox, EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), EDA_DRAW_PANEL_GAL::SetFocus(), EDA_DRAW_FRAME::UpdateStatusBar(), and ACTIONS::zoomPreset.

◆ OnSize()

void EDA_DRAW_FRAME::OnSize ( wxSizeEvent & event )

overridevirtualinherited

Recalculate the size of toolbars and display panel when the frame size changes.

Reimplemented from EDA_BASE_FRAME.

Reimplemented in SYMBOL_VIEWER_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 639 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_frameSize, and EDA_BASE_FRAME::OnSize().

Referenced by SCH_EDIT_FRAME::onSize(), and PCB_EDIT_FRAME::onSize().

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent & evt )

inherited

Definition at line 69 of file eda_dde.cpp.

References client_ipc_buffer, KIWAY_PLAYER::ExecuteRemoteCommand(), and IPC_BUF_SIZE.

◆ OnSockRequestServer()

void KIWAY_PLAYER::OnSockRequestServer ( wxSocketEvent & evt )

inherited

Definition at line 99 of file eda_dde.cpp.

References ID_EDA_SOCKET_EVENT, and KIWAY_PLAYER::m_sockets.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent & aEvent )

protectedinherited

Definition at line 1479 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ OnUpdateLayerSelectBox()

void FOOTPRINT_EDIT_FRAME::OnUpdateLayerSelectBox ( wxUpdateUIEvent & aEvent )

Definition at line 288 of file toolbars_footprint_editor.cpp.

References PCB_BASE_FRAME::GetActiveLayer(), m_selLayerBox, and LAYER_BOX_SELECTOR::SetLayerSelection().

◆ OnUpdateLoadFootprintFromBoard()

void FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard ( wxUpdateUIEvent & aEvent )

Definition at line 845 of file footprint_edit_frame.cpp.

References FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), Kiway, and KIWAY::Player().

◆ OnUpdateSaveFootprintToBoard()

void FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard ( wxUpdateUIEvent & aEvent )

Install the corresponding dialog editor for the given item.

Parameters

aDC	the current device context.
aItem	a pointer to the BOARD_ITEM to edit.

Definition at line 853 of file footprint_edit_frame.cpp.

References BOARD::Footprints(), FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), FOOTPRINT::GetLink(), Kiway, niluuid, and KIWAY::Player().

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent & aEvent )

inherited

Update the checked item in the grid wxchoice.

Definition at line 382 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::config(), WINDOW_SETTINGS::grid, GRID_SETTINGS::last_size_idx, EDA_DRAW_FRAME::m_gridSelectBox, and APP_SETTINGS_BASE::m_Window.

Referenced by COMMON_TOOLS::OnGridChanged(), and EDA_DRAW_FRAME::OnSelectGrid().

◆ OnUpdateSelectZoom()

void EDA_DRAW_FRAME::OnUpdateSelectZoom ( wxUpdateUIEvent & aEvent )

inherited

Update the checked item in the zoom wxchoice.

Definition at line 400 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::config(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetZoomFactor(), APP_SETTINGS_BASE::m_Window, EDA_DRAW_FRAME::m_zoomSelectBox, zoom, and WINDOW_SETTINGS::zoom_factors.

◆ OpenProjectFiles()

bool FOOTPRINT_EDIT_FRAME::OpenProjectFiles	(	const std::vector< wxString > &	aFileSet,
		int	aCtl = `0`
	)

overridevirtual

Load a KiCad board (.kicad_pcb) from aFileName.

Parameters

aFileSet	is the BOARD file to load, a vector of one element.
aCtl	is the KICTL_ bits, one to indicate that an append of the board file aFileName to the currently loaded file is desired.

See also: KIWAY_PLAYER for bit defines.

Returns: false if file load fails, otherwise true.

Reimplemented from KIWAY_PLAYER.

Definition at line 296 of file footprint_editor_utils.cpp.

References Clear_Pcb(), EDA_ITEM::ClearFlags(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetFirstFootprint(), PCB_BASE_FRAME::GetScreen(), EDA_DRAW_PANEL_GAL::GetViewControls(), ImportFootprint(), EDA_DRAW_PANEL_GAL::Refresh(), BASE_SCREEN::SetContentModified(), KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition(), and EDA_DRAW_FRAME::Zoom_Automatique().

◆ PlaceFootprint()

void PCB_BASE_FRAME::PlaceFootprint	(	FOOTPRINT *	aFootprint,
		bool	aRecreateRatsnest = `true`
	)

inherited

Places aFootprint at the current cursor position and updates footprint coordinates with the new position.

Parameters

aRecreateRatsnest A bool true redraws the footprint ratsnest.

Definition at line 496 of file load_select_footprint.cpp.

References EDA_ITEM::ClearFlags(), PICKED_ITEMS_LIST::ClearItemsList(), PCB_BASE_FRAME::Compile_Ratsnest(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetConnectivity(), PICKED_ITEMS_LIST::GetCount(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), PCB_BASE_FRAME::m_pcb, PCB_BASE_FRAME::OnModify(), PICKED_ITEMS_LIST::PushItem(), s_FootprintInitialCopy, s_PickedList, PCB_BASE_FRAME::SaveCopyInUndoList(), ITEM_PICKER::SetLink(), EDA_DRAW_FRAME::SetMsgPanel(), and FOOTPRINT::SetPosition().

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_EDIT_FRAME::ExchangeFootprint(), ImportFootprint(), LoadFootprintFromBoard(), and SaveFootprintToBoard().

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )

virtualinherited

Return the last command to undo and remove it from list, nothing is deleted.

Definition at line 1391 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::m_redoList, and UNDO_REDO_CONTAINER::PopCommand().

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

◆ PopCommandFromUndoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromUndoList ( )

virtualinherited

Return the last command to undo and remove it from list, nothing is deleted.

Definition at line 1385 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::m_undoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by PCB_BASE_EDIT_FRAME::AppendCopyToUndoList(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), PCB_BASE_EDIT_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), PCB_EDIT_FRAME::RunActionPlugin(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const TOOL_EVENT & aEvent )

virtualinherited

Pops a tool from the stack.

Parameters

aEvent The event that started the tool that was pushed to the stack.

Definition at line 65 of file tools_holder.cpp.

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_EVENT::getCommandStr(), TOOLS_HOLDER::GetToolManager(), TOOLS_HOLDER::m_toolManager, TOOLS_HOLDER::m_toolStack, TOOL_ACTION::MakeEvent(), TOOL_MANAGER::PostEvent(), ACTIONS::selectionTool, TOOL_EVENT::SetHasPosition(), and TOOL_EVENT::SetReactivate().

Referenced by EDIT_TOOL::copyToClipboard(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintDrawingSheet()

void EDA_DRAW_FRAME::PrintDrawingSheet	(	const RENDER_SETTINGS *	aSettings,
		BASE_SCREEN *	aScreen,
		const std::map< wxString, wxString > *	aProperties,
		double	aMils2Iu,
		const wxString &	aFilename,
		const wxString &	aSheetLayer = `wxEmptyString`
	)

inherited

Prints the drawing-sheet (frame and title block).

Parameters

aScreen	screen to draw.
aProperties	Optional properties for text variable resolution.
aMils2Iu	The mils to Iu conversion factor.
aFilename	The filename to display in basic inscriptions.
aSheetLayer	The layer displayed from PcbNew.

Definition at line 1006 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::GetFullScreenDesc(), BASE_SCREEN::GetPageCount(), BASE_SCREEN::GetPageNumber(), EDA_DRAW_FRAME::GetPageSettings(), KIGFX::RENDER_SETTINGS::GetPrintDC(), EDA_DRAW_FRAME::GetScreenDesc(), EDA_DRAW_FRAME::GetTitleBlock(), BASE_SCREEN::GetVirtualPageNumber(), EDA_DRAW_FRAME::m_showBorderAndTitleBlock, EDA_DRAW_FRAME::PrintDrawingSheet(), and KIWAY_HOLDER::Prj().

Referenced by EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), PL_EDITOR_FRAME::PrintPage(), PLEDITOR_PRINTOUT::PrintPage(), and SCH_PRINTOUT::PrintPage().

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString & text )

inherited

Definition at line 850 of file eda_base_frame.cpp.

References text.

Referenced by KICAD_MANAGER_FRAME::OnUnarchiveFiles().

◆ PrintPage()

void EDA_DRAW_FRAME::PrintPage ( const RENDER_SETTINGS * aSettings )

virtualinherited

Print the page pointed by current screen, set by the calling print function.

Parameters

aDC	wxDC given by the calling print function

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, and PL_EDITOR_FRAME.

Definition at line 433 of file eda_draw_frame.cpp.

References DisplayErrorMessage().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

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

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent & aEvent )

overrideinherited

Override the default process event handler to implement the auto save feature.

Warning: If you override this function in a derived class, make sure you call down to this or the auto save feature will be disabled.

Definition at line 274 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::GetAutoSaveInterval(), EDA_BASE_FRAME::isAutoSaveRequired(), EDA_BASE_FRAME::m_autoSavePending, EDA_BASE_FRAME::m_autoSaveTimer, EDA_BASE_FRAME::m_isClosing, EDA_BASE_FRAME::m_supportsAutoSave, Pgm(), and traceAutoSave.

Referenced by COMMON_TOOLS::GridProperties(), SYMBOL_VIEWER_FRAME::onSelectNextSymbol(), SYMBOL_VIEWER_FRAME::onSelectPreviousSymbol(), and KIWAY::ProcessEvent().

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )

inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in KICAD_MANAGER_FRAME, and PCB_EDIT_FRAME.

Definition at line 506 of file eda_base_frame.h.

Referenced by KIWAY::ProjectChanged().

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST * aItem )

virtualinherited

Add a command to redo in the redo list.

Delete the very old commands when the max count of redo commands is reached.

Definition at line 1370 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetRedoCommandCount(), EDA_BASE_FRAME::m_redoList, EDA_BASE_FRAME::m_undoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and EDA_BASE_FRAME::REDO_LIST.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST * aItem )

virtualinherited

Add a command to undo in the undo list.

Delete the very old commands when the max count of undo commands is reached.

Definition at line 1355 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetUndoCommandCount(), EDA_BASE_FRAME::m_undoList, EDA_BASE_FRAME::m_undoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and EDA_BASE_FRAME::UNDO_LIST.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SCH_EDITOR_CONTROL::Redo(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_EDIT_FRAME::RunActionPlugin(), PL_EDITOR_FRAME::SaveCopyInUndoList(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::StartNewUndo().

◆ PushTool()

void TOOLS_HOLDER::PushTool ( const TOOL_EVENT & aEvent )

virtualinherited

NB: the definition of "tool" is different at the user level.

The implementation uses a single TOOL_BASE derived class to implement several user "tools", such as rectangle and circle, or wire and bus. So each user-level tool is actually a TOOL_ACTION.

Pushes a tool to the stack.

Parameters

aEvent The event that is starting the tool to be pushed to the stack.

Definition at line 44 of file tools_holder.cpp.

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_EVENT::getCommandStr(), TOOL_ACTION::GetLabel(), TOOLS_HOLDER::m_toolManager, and TOOLS_HOLDER::m_toolStack.

Referenced by EDIT_TOOL::copyToClipboard(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PutDataInPreviousState()

void PCB_BASE_EDIT_FRAME::PutDataInPreviousState ( PICKED_ITEMS_LIST * aList )

inherited

Used in undo or redo command.

Put data pointed by List in the previous state, i.e. the state memorized by aList.

Parameters

aList a PICKED_ITEMS_LIST pointer to the list of items to undo/redo.

Definition at line 373 of file undo_redo.cpp.

References _, BOARD_ITEM_CONTAINER::Add(), B_Mask, PCB_BASE_FRAME::Compile_Ratsnest(), BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), F_Mask, FRAME_PCB_EDITOR, BOARD_ITEM::GetBoard(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetConnectivity(), PICKED_ITEMS_LIST::GetCount(), PCB_BASE_FRAME::GetModel(), PICKED_ITEMS_LIST::GetPickedItem(), PICKED_ITEMS_LIST::GetPickedItemLink(), PICKED_ITEMS_LIST::GetPickedItemStatus(), EDA_ITEM::GetPosition(), TOOL_MANAGER::GetTool(), PCB_DRAW_PANEL_GAL::GetView(), group, PCB_BASE_FRAME::HideSolderMask(), image, BOARD::IncrementTimeStamp(), EDA_BASE_FRAME::IsType(), KI_FALLTHROUGH, TOOLS_HOLDER::m_toolManager, BOARD::OnItemChanged(), PCB_ARC_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_NETINFO_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, PCB_SELECTION_TOOL::RebuildSelection(), BOARD_ITEM_CONTAINER::Remove(), PICKED_ITEMS_LIST::RemovePicker(), DS_PROXY_UNDO_ITEM::Restore(), BOARD::SanitizeNetcodes(), BOARD_ITEM::SetParentGroup(), PICKED_ITEMS_LIST::SetPickedItemStatus(), BOARD_ITEM::SwapItemData(), TestForExistingItem(), and EDA_ITEM::Type().

Referenced by BOARD_EDITOR_CONTROL::PlaceFootprint(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), and PCB_BASE_EDIT_FRAME::RollbackFromUndo().

◆ rebuildConnectivity()

void PCB_BASE_FRAME::rebuildConnectivity ( )

protectedinherited

Definition at line 1042 of file pcb_base_frame.cpp.

References BOARD::BuildConnectivity(), EVENTS::ConnectivityChangedEvent, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), TOOLS_HOLDER::GetToolManager(), TOOL_MANAGER::PostEvent(), and PCB_DRAW_PANEL_GAL::RedrawRatsnest().

Referenced by PCB_EDIT_FRAME::Edit_Zone_Params(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ ReCreateAuxiliaryToolbar()

virtual void EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar ( )

inlinevirtualinherited

Reimplemented in GERBVIEW_FRAME, and PCB_EDIT_FRAME.

Definition at line 203 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::RecreateToolbars(), and PCB_BASE_EDIT_FRAME::unitsChangeRefresh().

◆ ReCreateHToolbar()

void FOOTPRINT_EDIT_FRAME::ReCreateHToolbar ( )

overridevirtual

Create the main horizontal toolbar for the footprint editor.

Implements EDA_DRAW_FRAME.

Definition at line 36 of file toolbars_footprint_editor.cpp.

References _, ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddScaledSeparator(), ACTION_TOOLBAR::CANCEL, PCB_ACTIONS::checkFootprint, ACTION_TOOLBAR::ClearToolbar(), PCB_ACTIONS::createFootprint, PCB_ACTIONS::defaultPadProperties, PCB_ACTIONS::footprintProperties, LSET::ForbiddenFootprintLayers(), PCB_ACTIONS::group, ID_ADD_FOOTPRINT_TO_BOARD, ID_H_TOOLBAR, ID_LOAD_FOOTPRINT_FROM_BOARD, ID_ON_GRID_SELECT, ID_ON_ZOOM_SELECT, ID_TOOLBARH_PCB_SELECT_LAYER, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, ACTION_TOOLBAR::KiRealize(), KiScaledBitmap(), EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_gridSelectBox, EDA_DRAW_FRAME::m_mainToolBar, m_selLayerBox, EDA_DRAW_FRAME::m_zoomSelectBox, PCB_ACTIONS::mirrorH, PCB_ACTIONS::mirrorV, PCB_ACTIONS::newFootprint, ACTIONS::print, ReCreateLayerBox(), ACTIONS::redo, PCB_LAYER_BOX_SELECTOR::Resync(), PCB_ACTIONS::rotateCcw, PCB_ACTIONS::rotateCw, ACTIONS::save, ACTION_TOOLBAR::SetAuiManager(), PCB_LAYER_BOX_SELECTOR::SetBoardFrame(), PCB_LAYER_BOX_SELECTOR::SetNotAllowedLayerSet(), ACTION_TOOLBAR::TOGGLE, ACTIONS::undo, PCB_ACTIONS::ungroup, ACTION_TOOLBAR::UpdateControlWidth(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, ACTIONS::zoomRedraw, and ACTIONS::zoomTool.

Referenced by FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), LoadFootprintFromBoard(), LoadFootprintFromLibrary(), and SaveFootprintAs().

◆ ReCreateLayerBox()

void FOOTPRINT_EDIT_FRAME::ReCreateLayerBox ( bool aForceResizeToolbar = true )

Re create the layer Box by clearing the old list, and building a new one from the new layers names and layer colors.

Parameters

aForceResizeToolbar true to resize the parent toolbar or false if not needed (mainly in parent toolbar creation or when the layers names are not modified).

Definition at line 275 of file toolbars_footprint_editor.cpp.

References _, EDA_DRAW_FRAME::m_mainToolBar, m_selLayerBox, PCB_LAYER_BOX_SELECTOR::Resync(), and UpdateToolbarControlSizes().

Referenced by ReCreateHToolbar().

◆ ReCreateMenuBar()

void EDA_BASE_FRAME::ReCreateMenuBar ( )

inherited

Recreates the menu bar.

Needed when the language or icons are changed

As of wxWidgets 3.2, recreating the menubar from within an event handler of that menubar will result in memory corruption on macOS. In order to minimize the chance of programmer error causing regressions here, we always wrap calls to ReCreateMenuBar in a CallAfter to ensure that they do not occur within the same event handling call stack.

Definition at line 467 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::doReCreateMenuBar().

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), EDA_BASE_FRAME::ClearFileHistory(), EDA_BASE_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_BASE_FRAME::GetFileFromHistory(), EDA_BASE_FRAME::HandleSystemColorChange(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), LoadFootprintFromBoard(), LoadFootprintFromLibrary(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCRIPTING_TOOL::reloadPlugins(), EDA_BASE_FRAME::ShowChangedLanguage(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), and EDA_BASE_FRAME::UpdateFileHistory().

◆ ReCreateOptToolbar()

void FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar ( )

overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 216 of file toolbars_footprint_editor.cpp.

References ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddScaledSeparator(), ACTION_TOOLBAR::AddToolContextMenu(), ACTION_TOOLBAR::ClearToolbar(), ADVANCED_CFG::GetCfg(), TOOL_MANAGER::GetTool(), PCB_ACTIONS::graphicsOutlines, ACTIONS::gridProperties, ACTIONS::highContrastMode, ID_OPT_TOOLBAR, ACTIONS::inchesUnits, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, ACTION_TOOLBAR::KiRealize(), EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_optionsToolBar, TOOLS_HOLDER::m_toolManager, ACTIONS::millimetersUnits, ACTIONS::milsUnits, PCB_ACTIONS::padDisplayMode, ACTION_TOOLBAR::SetAuiManager(), PCB_ACTIONS::showFootprintTree, PCB_ACTIONS::showLayersManager, PCB_ACTIONS::showProperties, PCB_ACTIONS::textOutlines, ACTION_TOOLBAR::TOGGLE, ACTIONS::toggleBoundingBoxes, ACTIONS::toggleCursorStyle, ACTIONS::toggleGrid, PCB_ACTIONS::toggleHV45Mode, and ACTIONS::togglePolarCoords.

◆ RecreateToolbars()

void EDA_DRAW_FRAME::RecreateToolbars ( )

inherited

Rebuild all toolbars, and update the checked state of check tools.

Definition at line 1109 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_auxiliaryToolBar, EDA_DRAW_FRAME::m_drawToolBar, EDA_DRAW_FRAME::m_mainToolBar, EDA_DRAW_FRAME::m_optionsToolBar, EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar(), EDA_DRAW_FRAME::ReCreateHToolbar(), EDA_DRAW_FRAME::ReCreateOptToolbar(), and EDA_DRAW_FRAME::ReCreateVToolbar().

Referenced by SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), and PCB_BASE_FRAME::ShowChangedLanguage().

◆ ReCreateVToolbar()

void FOOTPRINT_EDIT_FRAME::ReCreateVToolbar ( )

overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 147 of file toolbars_footprint_editor.cpp.

References ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddGroup(), ACTION_TOOLBAR::AddScaledSeparator(), ACTION_TOOLBAR::AddToolContextMenu(), ACTION_MENU::CHECK, ACTION_TOOLBAR::ClearToolbar(), ACTIONS::deleteTool, PCB_ACTIONS::drawAlignedDimension, PCB_ACTIONS::drawArc, PCB_ACTIONS::drawCenterDimension, PCB_ACTIONS::drawCircle, PCB_ACTIONS::drawLeader, PCB_ACTIONS::drawLine, PCB_ACTIONS::drawOrthogonalDimension, PCB_ACTIONS::drawPolygon, PCB_ACTIONS::drawRadialDimension, PCB_ACTIONS::drawRectangle, PCB_ACTIONS::drawRuleArea, PCB_ACTIONS::drawTextBox, dummy, TOOL_MANAGER::GetTool(), ACTIONS::gridSetOrigin, ID_V_TOOLBAR, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, ACTION_TOOLBAR::KiRealize(), EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_drawToolBar, TOOLS_HOLDER::m_toolManager, ACTIONS::measureTool, PCB_ACTIONS::placeImage, PCB_ACTIONS::placePad, PCB_ACTIONS::placeText, PCB_ACTIONS::pointEditorArcKeepCenter, PCB_ACTIONS::pointEditorArcKeepEndpoint, ACTIONS::selectionTool, PCB_ACTIONS::setAnchor, ACTION_TOOLBAR::SetAuiManager(), and ACTION_TOOLBAR::TOGGLE.

◆ RefreshCanvas()

void EDA_DRAW_FRAME::RefreshCanvas ( )

inlineoverridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 426 of file eda_draw_frame.h.

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

Referenced by SCH_EDIT_FRAME::OnImportProject().

◆ RefreshLibraryTree()

void FOOTPRINT_EDIT_FRAME::RefreshLibraryTree ( )

Redisplay the library tree.

Used after changing modified states, descriptions, etc.

Definition at line 1075 of file footprint_edit_frame.cpp.

References FOOTPRINT_TREE_PANE::GetLibTree(), m_treePane, and LIB_TREE::RefreshLibTree().

Referenced by FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), KiwayMailIn(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), FOOTPRINT_EDITOR_CONTROL::Save(), and FOOTPRINT_EDITOR_CONTROL::SaveAs().

◆ RegenerateLibraryTree()

void FOOTPRINT_EDIT_FRAME::RegenerateLibraryTree ( )

Filter, sort, and redisplay the library tree.

Does NOT synchronize it with libraries in disk.

Definition at line 1064 of file footprint_edit_frame.cpp.

References LIB_TREE::CenterLibId(), FOOTPRINT_TREE_PANE::GetLibTree(), GetTargetFPID(), LIB_ID::IsValid(), m_treePane, and LIB_TREE::Regenerate().

Referenced by FOOTPRINT_EDITOR_CONTROL::PinLibrary(), and FOOTPRINT_EDITOR_CONTROL::UnpinLibrary().

◆ RegisterUIUpdateHandler() [1/2]

virtual void TOOLS_HOLDER::RegisterUIUpdateHandler	(	const TOOL_ACTION &	aAction,
		const ACTION_CONDITIONS &	aConditions
	)

inlinevirtualinherited

Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls.

Parameters

aAction	is the action to register.
aConditions	are the UI conditions to use for the control states.

Definition at line 63 of file tools_holder.h.

References TOOL_ACTION::GetUIId(), and TOOLS_HOLDER::RegisterUIUpdateHandler().

Referenced by ACTION_TOOLBAR::doSelectAction(), TOOLS_HOLDER::RegisterUIUpdateHandler(), and ACTION_MANAGER::SetConditions().

◆ RegisterUIUpdateHandler() [2/2]

void EDA_BASE_FRAME::RegisterUIUpdateHandler	(	int	aID,
		const ACTION_CONDITIONS &	aConditions
	)

overridevirtualinherited

Register a UI update handler for the control with ID aID.

Parameters

aID	is the control ID to register the handler for
aConditions	are the UI conditions to use for the control states

Reimplemented from TOOLS_HOLDER.

Definition at line 362 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::HandleUpdateUIEvent(), and EDA_BASE_FRAME::m_uiUpdateMap.

Referenced by SCH_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), EDA_BASE_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::setupUIConditions(), and KICAD_MANAGER_FRAME::setupUIConditions().

◆ ReleaseFile()

void EDA_DRAW_FRAME::ReleaseFile ( )

inherited

Release the current file marked in use.

See m_file_checker.

Definition at line 210 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_file_checker.

Referenced by PCB_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Files_io_from_id(), SCH_EDITOR_CONTROL::Revert(), and EDA_DRAW_FRAME::~EDA_DRAW_FRAME().

◆ ReloadFootprint()

void FOOTPRINT_EDIT_FRAME::ReloadFootprint ( FOOTPRINT * aFootprint )

overridevirtual

Override from PCB_BASE_FRAME which reloads the footprint from the library without setting the footprint watcher.

Reimplemented from PCB_BASE_FRAME.

Definition at line 541 of file footprint_edit_frame.cpp.

References _, WX_INFOBAR::AddCloseButton(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT::Clone(), WX_INFOBAR::Dismiss(), FOOTPRINT::FixUuids(), FOOTPRINT::GetFPID(), EDA_BASE_FRAME::GetInfoBar(), LIB_ID::GetLibItemName(), FOOTPRINT::GetReference(), IsCurrentFPFromBoard(), m_footprintNameWhenLoaded, m_originalFootprintCopy, WX_INFOBAR::RemoveAllButtons(), WX_INFOBAR::ShowMessage(), and UpdateMsgPanel().

Referenced by AddFootprintToBoard().

◆ RemoveBoardChangeListener()

void PCB_BASE_FRAME::RemoveBoardChangeListener ( wxEvtHandler * aListener )

inherited

Remove aListener to from the board changed listener list.

Definition at line 254 of file pcb_base_frame.cpp.

References PCB_BASE_FRAME::m_boardChangeListeners.

Referenced by PCB_EDIT_FRAME::doCloseWindow(), and PCB_EDIT_FRAME::onCloseNetInspectorDialog().

◆ resolveCanvasType()

void EDA_DRAW_FRAME::resolveCanvasType ( )

protectedinherited

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

Definition at line 1196 of file eda_draw_frame.cpp.

References EDA_DRAW_PANEL_GAL::GAL_FALLBACK, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, EDA_DRAW_FRAME::loadCanvasTypeSetting(), EDA_DRAW_FRAME::m_canvasType, and EDA_DRAW_FRAME::m_openGLFailureOccured.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), and GERBVIEW_FRAME::GERBVIEW_FRAME().

◆ RestoreCopyFromRedoList()

void PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList ( wxCommandEvent & aEvent )

inherited

Redo the last edit:

Save the current board in Undo list
Get an old version of the board from Redo list

Definition at line 343 of file undo_redo.cpp.

References AS_GLOBAL, PCB_BASE_FRAME::GetCanvas(), EDA_BASE_FRAME::GetRedoCommandCount(), TOOLS_HOLDER::m_toolManager, PCB_BASE_FRAME::OnModify(), EDA_BASE_FRAME::PopCommandFromRedoList(), TOOL_MANAGER::PostEvent(), TOOL_MANAGER::ProcessEvent(), EDA_BASE_FRAME::PushCommandToUndoList(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), EDA_DRAW_PANEL_GAL::Refresh(), PICKED_ITEMS_LIST::ReversePickersListOrder(), EVENTS::SelectedItemsModified, TA_UNDO_REDO_POST, TA_UNDO_REDO_PRE, TC_MESSAGE, and PCB_BASE_EDIT_FRAME::UndoRedoBlocked().

Referenced by PCB_CONTROL::Redo().

◆ RestoreCopyFromUndoList()

void PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList ( wxCommandEvent & aEvent )

inherited

Undo the last edit:

Save the current board in Redo list
Get an old version of the board from Undo list

Definition at line 313 of file undo_redo.cpp.

References AS_GLOBAL, PCB_BASE_FRAME::GetCanvas(), EDA_BASE_FRAME::GetUndoCommandCount(), TOOLS_HOLDER::m_toolManager, PCB_BASE_FRAME::OnModify(), EDA_BASE_FRAME::PopCommandFromUndoList(), TOOL_MANAGER::PostEvent(), TOOL_MANAGER::ProcessEvent(), EDA_BASE_FRAME::PushCommandToRedoList(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), EDA_DRAW_PANEL_GAL::Refresh(), PICKED_ITEMS_LIST::ReversePickersListOrder(), EVENTS::SelectedItemsModified, TA_UNDO_REDO_POST, TA_UNDO_REDO_PRE, TC_MESSAGE, and PCB_BASE_EDIT_FRAME::UndoRedoBlocked().

Referenced by PCB_CONTROL::Undo().

◆ restoreLastFootprint()

void FOOTPRINT_EDIT_FRAME::restoreLastFootprint ( )

protected

Definition at line 522 of file footprint_edit_frame.cpp.

References AddFootprintToBoard(), PROJECT::GetRString(), PCB_BASE_FRAME::loadFootprint(), PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME, PROJECT::PCB_FOOTPRINT_EDITOR_LIB_NICKNAME, Prj(), and LIB_ID::SetLibNickname().

◆ retainLastFootprint()

void FOOTPRINT_EDIT_FRAME::retainLastFootprint ( )

protected

Definition at line 510 of file footprint_edit_frame.cpp.

References GetLoadedFPID(), PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME, PROJECT::PCB_FOOTPRINT_EDITOR_LIB_NICKNAME, Prj(), and PROJECT::SetRString().

Referenced by ~FOOTPRINT_EDIT_FRAME().

◆ RevertFootprint()

bool FOOTPRINT_EDIT_FRAME::RevertFootprint ( )

Definition at line 1216 of file footprint_libraries_utils.cpp.

References _, AddFootprintToBoard(), Clear_Pcb(), EDA_BASE_FRAME::ClearUndoRedoList(), ConfirmRevertDialog(), PCB_BASE_FRAME::GetCanvas(), GetLoadedFPID(), PCB_BASE_FRAME::GetScreen(), IsContentModified(), m_originalFootprintCopy, EDA_DRAW_PANEL_GAL::Refresh(), BASE_SCREEN::SetContentModified(), PCB_BASE_FRAME::Update3DView(), UpdateView(), and EDA_DRAW_FRAME::Zoom_Automatique().

◆ RollbackFromUndo()

void PCB_BASE_EDIT_FRAME::RollbackFromUndo ( )

inherited

Perform an undo of the last edit without logging a corresponding redo.

Used to cancel an in-progress operation.

Definition at line 628 of file undo_redo.cpp.

References PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), PCB_BASE_FRAME::GetCanvas(), EDA_BASE_FRAME::PopCommandFromUndoList(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), EDA_DRAW_PANEL_GAL::Refresh(), and undo.

Referenced by BOARD_EDITOR_CONTROL::PageSettings().

◆ saveCanvasTypeSetting()

bool EDA_DRAW_FRAME::saveCanvasTypeSetting ( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType )

protectedinherited

Stores the canvas type in the application settings.

Definition at line 839 of file eda_draw_frame.cpp.

References alg::contains(), FRAME_FOOTPRINT_EDITOR, FRAME_GERBER, FRAME_PCB_EDITOR, FRAME_PL_EDITOR, FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, Kiface(), and EDA_BASE_FRAME::m_ident.

Referenced by EDA_DRAW_FRAME::~EDA_DRAW_FRAME().

◆ SaveCopyInUndoList() [1/2]

void PCB_BASE_EDIT_FRAME::SaveCopyInUndoList	(	const PICKED_ITEMS_LIST &	aItemsList,
		UNDO_REDO	aCommandType
	)

overridevirtualinherited

Create a new entry in undo list of commands.

Add a list of pickers to handle a list of items.

Parameters

aItemsList	the list of items modified by the command to undo.
aCommandType	command type (see enum UNDO_REDO).

Implements PCB_BASE_FRAME.

Definition at line 292 of file undo_redo.cpp.

References PCB_BASE_EDIT_FRAME::saveCopyInUndoList().

◆ SaveCopyInUndoList() [2/2]

void PCB_BASE_EDIT_FRAME::SaveCopyInUndoList	(	EDA_ITEM *	aItemToCopy,
		UNDO_REDO	aTypeCommand
	)

overridevirtualinherited

Create a new entry in undo list of commands.

Add a picker to handle aItemToCopy.

Parameters

aItemToCopy	the board item modified by the command to undo.
aTypeCommand	command type (see enum UNDO_REDO).

Implements PCB_BASE_FRAME.

Definition at line 282 of file undo_redo.cpp.

References PICKED_ITEMS_LIST::PushItem(), and PCB_BASE_EDIT_FRAME::saveCopyInUndoList().

Referenced by BOARD_EDITOR_CONTROL::DrillOrigin(), GROUP_TOOL::Group(), BOARD_EDITOR_CONTROL::PageSettings(), PCB_EDIT_FRAME::RunActionPlugin(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), and GROUP_TOOL::Ungroup().

◆ saveCopyInUndoList()

void PCB_BASE_EDIT_FRAME::saveCopyInUndoList	(	PICKED_ITEMS_LIST *	commandToUndo,
		const PICKED_ITEMS_LIST &	aItemsList,
		UNDO_REDO	aCommandType
	)

protectedinherited

Definition at line 155 of file undo_redo.cpp.

Referenced by PCB_BASE_EDIT_FRAME::AppendCopyToUndoList(), and PCB_BASE_EDIT_FRAME::SaveCopyInUndoList().

◆ SaveFootprint()

bool FOOTPRINT_EDIT_FRAME::SaveFootprint ( FOOTPRINT * aFootprint )

Save in an existing library a given footprint.

Parameters

aFootprint = the given footprint

Returns: : true if OK, false if abort

Definition at line 789 of file footprint_libraries_utils.cpp.

References DeleteFootprintFromLibrary(), DisplayInfoMessage(), FP_LIB_TABLE::FindRow(), FOOTPRINT::GetFPID(), LIB_TABLE_ROW::GetFullURI(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), FOOTPRINT::GetLink(), TOOL_MANAGER::GetTool(), IO_MGR::GuessPluginTypeFromLibPath(), INFO_LEGACY_LIB_WARN_EDIT(), PAD_TOOL::InPadEditMode(), IO_MGR::LEGACY, m_footprintNameWhenLoaded, TOOLS_HOLDER::m_toolManager, niluuid, PROJECT::PcbFootprintLibs(), Prj(), PCB_ACTIONS::recombinePad, TOOL_MANAGER::RunAction(), SaveFootprintAs(), SaveFootprintInLibrary(), SaveFootprintToBoard(), SyncLibraryTree(), and IO_ERROR::What().

Referenced by CanCloseFPFromBoard(), canCloseWindow(), Clear_Pcb(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), and FOOTPRINT_EDITOR_CONTROL::Save().

◆ SaveFootprintAs()

bool FOOTPRINT_EDIT_FRAME::SaveFootprintAs ( FOOTPRINT * aFootprint )

◆ SaveFootprintInLibrary()

bool FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary	(	FOOTPRINT *	aFootprint,
		const wxString &	aLibraryName
	)

Definition at line 903 of file footprint_libraries_utils.cpp.

References DisplayError(), FP_LIB_TABLE::FootprintSave(), FOOTPRINT::GetFPID(), LIB_ID::GetLibItemName(), PROJECT::PcbFootprintLibs(), Prj(), FOOTPRINT::SetFPID(), and IO_ERROR::What().

Referenced by DuplicateFootprint(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SaveFootprint(), and SaveFootprintAs().

◆ SaveFootprintToBoard()

bool FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard ( bool aAddNew )

Definition at line 925 of file footprint_libraries_utils.cpp.

References _, COMMIT::Add(), EDA_ITEM::ClearFlags(), FOOTPRINT::Clone(), DisplayError(), PCB_EDIT_FRAME::ExchangeFootprint(), BOARD::Footprints(), FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), BOARD::GetFirstFootprint(), FOOTPRINT::GetLink(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), EDA_DRAW_PANEL_GAL::GetViewControls(), Kiway, m_boardFootprintUuids, TOOLS_HOLDER::m_toolManager, EDA_ITEM::m_Uuid, niluuid, PCB_BASE_FRAME::PlaceFootprint(), PCB_ACTIONS::placeFootprint, BOARD_EDITOR_CONTROL::PlacingFootprint(), KIWAY::Player(), BOARD_COMMIT::Push(), TOOL_MANAGER::RunAction(), FOOTPRINT::RunOnChildren(), PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition(), FOOTPRINT::SetLink(), EDA_ITEM::SetParent(), FOOTPRINT::SetPosition(), and EDA_BASE_FRAME::ShowInfoBarError().

Referenced by OnSaveFootprintToBoard(), and SaveFootprint().

◆ SaveLibraryAs()

bool FOOTPRINT_EDIT_FRAME::SaveLibraryAs ( const wxString & aLibraryPath )

Save a library to a new name and/or library type.

See also: PLUGIN::FootprintSave and PLUGIN::FootprintLibCreate

Note: Saving as a new library type requires the plug-in to support saving libraries

Definition at line 408 of file load_select_footprint.cpp.

References _, PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DisplayError(), DisplayInfoMessage(), dummy, PLUGIN::FootprintEnumerate(), PLUGIN::FootprintSave(), PLUGIN::GetEnumeratedFootprint(), IO_MGR::GuessPluginTypeFromLibPath(), IO_MGR::PluginFind(), and IO_ERROR::What().

Referenced by FOOTPRINT_EDITOR_CONTROL::SaveAs().

◆ SaveProjectLocalSettings()

virtual void EDA_BASE_FRAME::SaveProjectLocalSettings ( )

inlinevirtualinherited

Save changes to the project local settings.

These settings are used to save/restore the view state for a specific project, and should never contain design data. This method is normally called automatically at various points in the workflow so that the user's most recent display settings are automatically persisted.

The method is virtual so you can override it to call the suitable save method. The base method does nothing.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 366 of file eda_base_frame.h.

◆ saveProjectSettings()

virtual void EDA_BASE_FRAME::saveProjectSettings ( )

inlineprotectedvirtualinherited

Saves any design-related project settings associated with this frame.

This method should only be called as the result of direct user action, for example from an explicit "Save Project" command or as a consequence of saving a design document.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 673 of file eda_base_frame.h.

◆ SaveSettings()

void FOOTPRINT_EDIT_FRAME::SaveSettings ( APP_SETTINGS_BASE * aCfg )

overridevirtual

Save common frame parameters to a configuration data file.

Don't forget to call the base class's SaveSettings() from your derived SaveSettings() otherwise the frames won't remember their positions and sizes.

Reimplemented from PCB_BASE_FRAME.

Definition at line 649 of file footprint_edit_frame.cpp.

◆ SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings ( WINDOW_SETTINGS * aCfg )

inherited

Save window settings to the given settings object.

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

Definition at line 744 of file eda_base_frame.cpp.

References WINDOW_STATE::display, EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_auimgr, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, WINDOW_SETTINGS::state, and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ ScriptingConsoleEnableDisable()

void EDA_DRAW_FRAME::ScriptingConsoleEnableDisable ( )

inherited

Toggles the scripting console visibility.

Definition at line 231 of file eda_draw_frame.cpp.

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

Referenced by SCH_EDITOR_CONTROL::TogglePythonConsole(), and BOARD_EDITOR_CONTROL::TogglePythonConsole().

◆ SelectFootprintFromBoard()

FOOTPRINT * FOOTPRINT_EDIT_FRAME::SelectFootprintFromBoard ( BOARD * aPcb )

Display the list of footprints currently existing on the BOARD.

Returns: the selected footprint or nullptr

Definition at line 361 of file load_select_footprint.cpp.

References _, FOOTPRINT::Add(), BOARD::Footprints(), and EDA_LIST_DIALOG::GetTextSelection().

Referenced by LoadFootprintFromBoard().

◆ SelectFootprintFromLibBrowser()

wxString PCB_BASE_FRAME::SelectFootprintFromLibBrowser ( )

inherited

Launch the footprint viewer to select the name of a footprint to load.

Returns: the selected footprint name or an empty string if no selection was made.

Definition at line 183 of file load_select_footprint.cpp.

References KIWAY_PLAYER::Destroy(), FRAME_FOOTPRINT_VIEWER, FRAME_FOOTPRINT_VIEWER_MODAL, ignore_unused(), Kiway, KIWAY::Player(), and FOOTPRINT_VIEWER_FRAME::ShowModal().

Referenced by PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ SelectFootprintFromLibTree()

FOOTPRINT * PCB_BASE_FRAME::SelectFootprintFromLibTree ( LIB_ID aPreselect = LIB_ID() )

inherited

Open a dialog to select a footprint.

Parameters

aPreslect if valid, the LIB_ID to select (otherwise the global history is used).

Definition at line 214 of file load_select_footprint.cpp.

References _, AddFootprintToHistory(), FP_TREE_MODEL_ADAPTER::AddLibraries(), cancel, FP_TREE_MODEL_ADAPTER::Create(), FOOTPRINT_LIST::DisplayErrors(), LIB_TREE_MODEL_ADAPTER::DoAddLibrary(), LIB_ID::Format(), FOOTPRINT_LIST::GetErrorCount(), FOOTPRINT_LIST::GetFootprintInfo(), LIB_TREE_MODEL_ADAPTER::GetItemCount(), DIALOG_CHOOSE_FOOTPRINT::GetSelectedLibId(), GFootprintList, DIALOG_CHOOSE_FOOTPRINT::IsExternalBrowserSelected(), LIB_ID::IsValid(), PCB_BASE_FRAME::loadFootprint(), LIB_ID::Parse(), PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), FOOTPRINT_LIST_IMPL::ReadFootprintFiles(), s_FootprintHistoryList, LIB_TREE_MODEL_ADAPTER::SaveSettings(), PCB_BASE_FRAME::SelectFootprintFromLibBrowser(), LIB_TREE_MODEL_ADAPTER::SetPreselectNode(), and DIALOG_SHIM::ShowQuasiModal().

Referenced by BOARD_EDITOR_CONTROL::PlaceFootprint().

◆ SelectLayer()

void FOOTPRINT_EDIT_FRAME::SelectLayer ( wxCommandEvent & event )

Definition at line 124 of file footprint_editor_utils.cpp.

References PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetDisplayOptions(), LAYER_BOX_SELECTOR::GetLayerSelection(), m_selLayerBox, EDA_DRAW_PANEL_GAL::Refresh(), SetActiveLayer(), and ToLAYER_ID().

◆ SelectLibrary()

wxString PCB_BASE_FRAME::SelectLibrary ( const wxString & aNicknameExisting )

inherited

Put up a dialog and allows the user to pick a library, for unspecified use.

Parameters

aNicknameExisting is the current choice to highlight.

Returns: the library or wxEmptyString on abort.

Definition at line 1354 of file footprint_libraries_utils.cpp.

References _, alg::contains(), LIB_TABLE::GetDescription(), LIB_TABLE::GetLogicalLibs(), LIB_TREE_MODEL_ADAPTER::GetPinningSymbol(), PROJECT::GetProjectFile(), EDA_LIST_DIALOG::GetTextSelection(), Kiway, COMMON_SETTINGS::m_Session, PROJECT::PcbFootprintLibs(), Pgm(), COMMON_SETTINGS::SESSION::pinned_fp_libs, KIWAY::Prj(), KIWAY_HOLDER::Prj(), and project.

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary().

◆ selectLibTable()

FP_LIB_TABLE * PCB_BASE_EDIT_FRAME::selectLibTable ( bool aOptional = false )

protectedinherited

Prompts a user to select global or project library tables.

Returns: Pointer to library table selected or nullptr if none selected/canceled

Definition at line 502 of file footprint_libraries_utils.cpp.

References _, GFootprintTable, PROJECT::PcbFootprintLibs(), and Prj().

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

◆ SelectOneLayer()

PCB_LAYER_ID PCB_BASE_FRAME::SelectOneLayer	(	PCB_LAYER_ID	aDefaultLayer,
		LSET	aNotAllowedLayersMask = `LSET()`,
		wxPoint	aDlgPosition = `wxDefaultPosition`
	)

inherited

Show the dialog box for a layer selection.

Parameters

aDefaultLayer	is the default layer to select. Use UNDEFINED_LAYER if no selection is desired.
aNotAllowedLayersMask	is a layer mask for not allowed layers. Use 0 to show all layers in use.
aDlgPosition	is the position of dialog (default is centered).

Returns: the selected layer id.

Definition at line 274 of file sel_layer.cpp.

References PCB_BASE_FRAME::GetBoard(), PCB_ONE_LAYER_SELECTOR::GetLayerSelection(), DIALOG_SHIM::SetPosition(), ToLAYER_ID(), and UNDEFINED_LAYER.

Referenced by ROUTER_TOOL::handleLayerSwitch(), and DRAWING_TOOL::InteractivePlaceWithPreview().

◆ SetActiveLayer()

void FOOTPRINT_EDIT_FRAME::SetActiveLayer ( PCB_LAYER_ID aLayer )

overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 283 of file footprint_editor_utils.cpp.

References PCB_BASE_FRAME::GetCanvas(), PCB_ACTIONS::layerChanged, PCB_BASE_EDIT_FRAME::m_appearancePanel, TOOLS_HOLDER::m_toolManager, APPEARANCE_CONTROLS::OnLayerChanged(), EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), PCB_BASE_FRAME::SetActiveLayer(), EDA_DRAW_PANEL_GAL::SetFocus(), and PCB_DRAW_PANEL_GAL::SetHighContrastLayer().

Referenced by DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), and SelectLayer().

◆ SetBoard()

void PCB_BASE_EDIT_FRAME::SetBoard	(	BOARD *	aBoard,
		PROGRESS_REPORTER *	aReporter = `nullptr`
	)

overridevirtualinherited

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

Reimplemented from PCB_BASE_FRAME.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 190 of file pcb_base_edit_frame.cpp.

References KIGFX::VIEW::Clear(), EDA_BASE_FRAME::config(), PCB_DRAW_PANEL_GAL::DisplayBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetDesignSettings(), EDA_DRAW_PANEL_GAL::GetGAL(), BOARD_DESIGN_SETTINGS::GetGridOrigin(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::InitPreview(), BOARD_DESIGN_SETTINGS::m_DRCEngine, PCB_BASE_FRAME::m_pcb, TOOLS_HOLDER::m_toolManager, TOOL_BASE::MODEL_RELOAD, new_board, TOOL_MANAGER::ResetTools(), PCB_BASE_FRAME::SetBoard(), TOOL_MANAGER::SetEnvironment(), KIGFX::GAL::SetGridOrigin(), and PCB_DRAW_PANEL_GAL::UpdateColors().

Referenced by Clear_Pcb(), and PCB_EDIT_FRAME::SetBoard().

◆ SetCanvas()

void EDA_DRAW_FRAME::SetCanvas ( EDA_DRAW_PANEL_GAL * aPanel )

inlineinherited

Definition at line 417 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_canvas.

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

◆ SetDisplayOptions()

void PCB_BASE_FRAME::SetDisplayOptions	(	const PCB_DISPLAY_OPTIONS &	aOptions,
		bool	aRefresh = `true`
	)

inherited

Updates the current display options from the given options struct.

Parameters

aOptions	is the options struct to apply
aRefresh	will refresh the view after updating

Definition at line 1099 of file pcb_base_frame.cpp.

References KIGFX::ALL, PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), PCB_DRAW_PANEL_GAL::GetView(), PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, PCB_BASE_FRAME::m_displayOptions, PCB_BASE_FRAME::OnDisplayOptionsChanged(), pad, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), KIGFX::VIEW::UpdateAllItemsConditionally(), KIGFX::PCB_VIEW::UpdateDisplayOptions(), and via.

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), PCB_CONTROL::HighContrastMode(), PCB_CONTROL::HighContrastModeCycle(), PCB_EDIT_FRAME::LoadProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::LoadSettings(), PCB_CONTROL::NetColorModeCycle(), APPEARANCE_CONTROLS::onNetColorMode(), APPEARANCE_CONTROLS::onObjectOpacitySlider(), and PCB_CONTROL::ZoneDisplayMode().

◆ SetDrawBgColor()

void PCB_BASE_FRAME::SetDrawBgColor ( const COLOR4D & aColor )

overridevirtualinherited

Reimplemented from EDA_DRAW_FRAME.

Definition at line 638 of file pcb_base_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, and EDA_DRAW_FRAME::m_drawBgColor.

Referenced by APPEARANCE_CONTROLS::OnColorSwatchChanged().

◆ setFPWatcher()

void PCB_BASE_FRAME::setFPWatcher ( FOOTPRINT * aFootprint )

protectedinherited

Creates (or removes) a watcher on the specified footprint.

Parameters

aFootprint If nullptr, the watcher is removed. Otherwise, set a change watcher

Definition at line 1145 of file pcb_base_frame.cpp.

References DisplayInfoMessage(), FP_LIB_TABLE::FindRow(), FOOTPRINT::GetFPID(), LIB_TABLE_ROW::GetFullURI(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), KiCadFootprintFileExtension, PCB_BASE_FRAME::m_watcher, PCB_BASE_FRAME::m_watcherFileName, PCB_BASE_FRAME::m_watcherLastModified, PCB_BASE_FRAME::OnFPChange(), PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), and IO_ERROR::What().

Referenced by AddFootprintToBoard(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), ~FOOTPRINT_EDIT_FRAME(), and FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME().

◆ SetGridColor()

virtual void EDA_DRAW_FRAME::SetGridColor ( const COLOR4D & aColor )

inlinevirtualinherited

Reimplemented in GERBVIEW_FRAME, and PCB_EDIT_FRAME.

Definition at line 219 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_gridColor.

◆ SetGridOrigin()

void PCB_BASE_FRAME::SetGridOrigin ( const VECTOR2I & aPoint )

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 587 of file pcb_base_frame.cpp.

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

◆ SetGridVisibility()

void PCB_BASE_EDIT_FRAME::SetGridVisibility ( bool aVisible )

overridevirtualinherited

Override this function in the PCB_BASE_EDIT_FRAME to refill the layer widget.

Parameters

aVisible true if the grid must be shown.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 243 of file pcb_base_edit_frame.cpp.

References LAYER_GRID, PCB_BASE_EDIT_FRAME::m_appearancePanel, EDA_DRAW_FRAME::SetGridVisibility(), and APPEARANCE_CONTROLS::SetObjectVisible().

◆ SetKiway()

void KIWAY_HOLDER::SetKiway	(	wxWindow *	aDest,
		KIWAY *	aKiway
	)

inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters

aDest	is the recipient of aKiway pointer.
aKiway	is often from a parent window or from KIFACE::CreateKiWindow().

Definition at line 43 of file kiway_holder.cpp.

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by PCB::IFACE::CreateKiWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), and PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME().

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool aIsModal )

inlineinherited

Definition at line 160 of file kiway_player.h.

References KIWAY_PLAYER::m_modal.

Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString & aPath )

inlineinherited

Definition at line 422 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_mruPath.

Referenced by AskLoadBoardFileName(), GERBVIEW_CONTROL::ExportToPcbnew(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), EDA_DRAW_FRAME::LibraryFileBrowser(), and KICAD_MANAGER_FRAME::LoadProject().

◆ SetMsgPanel() [1/3]

void EDA_DRAW_FRAME::SetMsgPanel ( const std::vector< MSG_PANEL_ITEM > & aList )

inherited

Clear the message panel and populates it with the contents of aList.

Parameters

aList is the list of MSG_PANEL_ITEM objects to fill the message panel.

Definition at line 756 of file eda_draw_frame.cpp.

References EDA_MSG_PANEL::AppendMessage(), EDA_MSG_PANEL::EraseMsgBox(), EDA_BASE_FRAME::m_isClosing, and EDA_DRAW_FRAME::m_messagePanel.

Referenced by BOARD_INSPECTION_TOOL::ClearHighlight(), PCB_BASE_FRAME::Compile_Ratsnest(), PCB_BASE_FRAME::CreateNewFootprint(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::importFile(), ImportFootprint(), DRAWING_TOOL::InteractivePlaceWithPreview(), SCH_EDIT_FRAME::LoadSheetFromFile(), PCB_EDIT_FRAME::onBoardLoaded(), PCB_EDIT_FRAME::OnNetlistChanged(), SCH_PRINTOUT::OnPrintPage(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), PAD_TOOL::pushPadSettings(), SaveFootprintAs(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveSchematicFile(), EDA_DRAW_FRAME::SetMsgPanel(), SCH_DRAWING_TOOLS::SingleClickPlace(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), ROUTER_TOOL::UpdateMessagePanel(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), UpdateMsgPanel(), FOOTPRINT_VIEWER_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), PL_EDITOR_FRAME::UpdateMsgPanelInfo(), and EE_POINT_EDITOR::updateParentItem().

◆ SetMsgPanel() [2/3]

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

inherited

Helper function that erases the msg panel and then appends a single message.

Parameters

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

Definition at line 768 of file eda_draw_frame.cpp.

References EDA_MSG_PANEL::AppendMessage(), EDA_MSG_PANEL::EraseMsgBox(), EDA_BASE_FRAME::m_isClosing, and EDA_DRAW_FRAME::m_messagePanel.

◆ SetMsgPanel() [3/3]

void EDA_DRAW_FRAME::SetMsgPanel ( EDA_ITEM * aItem )

inherited

Definition at line 779 of file eda_draw_frame.cpp.

References EDA_ITEM::GetMsgPanelInfo(), and EDA_DRAW_FRAME::SetMsgPanel().

◆ SetObjectVisible()

void PCB_BASE_EDIT_FRAME::SetObjectVisible	(	GAL_LAYER_ID	aLayer,
		bool	aVisible = `true`
	)

inherited

Definition at line 253 of file pcb_base_edit_frame.cpp.

References PCB_BASE_EDIT_FRAME::m_appearancePanel, and APPEARANCE_CONTROLS::SetObjectVisible().

Referenced by DRAWING_TOOL::DrawZone().

◆ SetPageSettings()

void PCB_BASE_FRAME::SetPageSettings ( const PAGE_INFO & aPageSettings )

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 557 of file pcb_base_frame.cpp.

References PCB_BASE_FRAME::GetScreen(), PAGE_INFO::GetSizeIU(), BASE_SCREEN::InitDataPoints(), EDA_IU_SCALE::IU_PER_MILS, PCB_BASE_FRAME::m_pcb, pcbIUScale, and BOARD::SetPageSettings().

Referenced by PCB_EDIT_FRAME::SetPageSettings().

◆ SetPlotSettings()

void FOOTPRINT_EDIT_FRAME::SetPlotSettings ( const PCB_PLOT_PARAMS & aSettings )

overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 603 of file footprint_edit_frame.cpp.

◆ SetScreen()

virtual void EDA_DRAW_FRAME::SetScreen ( BASE_SCREEN * aScreen )

inlineprotectedvirtualinherited

Reimplemented in SCH_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 458 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_currentScreen.

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SCH_EDIT_FRAME::SetScreen(), SYMBOL_EDIT_FRAME::SetScreen(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), and DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME().

◆ SetShowPolarCoords()

void EDA_DRAW_FRAME::SetShowPolarCoords ( bool aShow )

inlineinherited

Definition at line 122 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_polarCoords.

Referenced by COMMON_TOOLS::TogglePolarCoords().

◆ SetTitleBlock()

void PCB_BASE_FRAME::SetTitleBlock ( const TITLE_BLOCK & aTitleBlock )

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 626 of file pcb_base_frame.cpp.

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

◆ setupTools()

void FOOTPRINT_EDIT_FRAME::setupTools ( )

◆ setupUIConditions()

void FOOTPRINT_EDIT_FRAME::setupUIConditions ( )

overrideprotectedvirtual

Setup the UI conditions for the various actions and their controls in this frame.

Reimplemented from EDA_BASE_FRAME.

Definition at line 1147 of file footprint_edit_frame.cpp.

◆ setupUnits()

void EDA_DRAW_FRAME::setupUnits ( APP_SETTINGS_BASE * aCfg )

protectedinherited

Definition at line 1150 of file

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ HOLDER_TYPE

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ ~FOOTPRINT_EDIT_FRAME()

◆ FOOTPRINT_EDIT_FRAME()

Member Function Documentation

◆ ActivateGalCanvas()

◆ AddBoardChangeListener()

◆ AddFootprintToBoard()

◆ AddLibrary()

◆ AddStandardHelpMenu()

◆ AddStandardSubMenus()

◆ AngleValueFromString()

◆ AppendCopyToUndoList()

◆ AppendMsgPanel()

◆ buildSaveAsDialog()

◆ CanCloseFPFromBoard()

◆ canCloseWindow()

◆ centerItemIdleHandler()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ Clear_Pcb()

◆ ClearFileHistory()

◆ ClearListAndDeleteItems()

◆ ClearModify()

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ CloseFootprintEditor()

◆ commonInit()

◆ CommonSettingsChanged()

◆ Compile_Ratsnest()

◆ config()

◆ ConfigBaseName()

◆ CreateAndShow3D_Frame()

◆ CreateInfoBar()

◆ CreateNewFootprint()

◆ createNewLibrary()

◆ CreateNewLibrary()

◆ CreateNewProjectLibrary()

◆ CreateServer()

◆ CurrentToolName()

◆ DeleteFootprintFromLibrary()

◆ Destroy()

◆ DismissModal()

◆ DisplayConstraintsMsg()

◆ DisplayGridMsg()

◆ DisplayToolMsg()

◆ DisplayUnitsMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ doReCreateMenuBar()

◆ DoWithAcceptedFiles()

◆ DuplicateFootprint()

◆ editFootprintProperties()

◆ ensureWindowIsOnScreen()

◆ EraseMsgBox()

◆ ExecuteRemoteCommand()

◆ ExportFootprint()

◆ findDialogs()

◆ findQuasiModalDialog()

◆ FinishAUIInitialization()

◆ FocusOnItem()

◆ FocusOnItems()

◆ FocusOnLibID()

◆ FocusOnLocation()

◆ Get3DViewerFrame()

◆ GetAboutTitle()