The main frame for Pcbnew. More...

#include <pcb_edit_frame.h>

Inheritance diagram for PCB_EDIT_FRAME:

Classes
struct	LAYER_TOOLBAR_ICON_VALUES
	Store the previous layer toolbar icon state information. More...

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

enum	HOLDER_TYPE { DIALOG , FRAME , PANEL }

Public Member Functions
virtual	~PCB_EDIT_FRAME ()

void	LoadFootprints (NETLIST &aNetlist, REPORTER &aReporter)
	Load the footprints for each #SCH_COMPONENT in aNetlist from the list of libraries.

void	OnQuit (wxCommandEvent &event)

bool	IsContentModified () const override
	Get if the current board has been modified but not saved.

void	PythonSyncEnvironmentVariables ()
	Synchronize the environment variables from KiCad's environment into the Python interpreter.

void	PythonSyncProjectName ()
	Synchronize the project name from KiCad's environment into the Python interpreter.

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

void	HardRedraw () override
	Rebuild the GAL and redraws the screen.

void	RebuildAndRefresh ()
	Rebuilds board connectivity, refreshes canvas.

void	ExecuteRemoteCommand (const char *cmdline) override
	Execute a remote command send by Eeschema via a socket, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242).

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

std::vector< BOARD_ITEM * >	FindItemsFromSyncSelection (std::string syncStr)
	Used to find items by selection synchronization spec string.

void	ShowFindDialog ()
	Show the Find dialog.

void	FindNext (bool reverse=false)
	Find the next item using our existing search parameters.

bool	LayerManagerShown ()

bool	PropertiesShown ()

bool	NetInspectorShown ()

void	OnUpdateSelectViaSize (wxUpdateUIEvent &aEvent)

void	OnUpdateSelectTrackWidth (wxUpdateUIEvent &aEvent)

void	UpdateTrackWidthSelectBox (wxChoice *aTrackWidthSelectBox, bool aShowNetclass, bool aShowEdit)

void	UpdateViaSizeSelectBox (wxChoice *aViaSizeSelectBox, bool aShowNetclass, bool aShowEdit)

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

COLOR4D	GetGridColor () override

void	SetGridColor (const COLOR4D &aColor) override

void	SaveProjectLocalSettings () override
	Save changes to the project local settings.

bool	LoadProjectSettings ()
	Load the current project's file configuration settings which are pertinent to this PCB_EDIT_FRAME instance.

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

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

void	LoadDrawingSheet ()
	Load the drawing sheet file.

wxString	GetLastPath (LAST_PATH_TYPE aType)
	Get the last path for a particular type.

void	SetLastPath (LAST_PATH_TYPE aType, const wxString &aLastPath)
	Set the path of the last file successfully read.

void	ResolveDRCExclusions (bool aCreateMarkers)
	If aCreateMarkers then create DRC exclusion markers from the serialized data.

void	Process_Special_Functions (wxCommandEvent &event)

void	Tracks_and_Vias_Size_Event (wxCommandEvent &event)

void	ReCreateLayerBox (bool aForceResizeToolbar=true)
	Recreate the layer box by clearing the old list and building a new one from the new layer names and colors.

void	OnModify () override
	Must be called after a board change to set the modified flag.

void	SetActiveLayer (PCB_LAYER_ID aLayer) override
	Change the currently active layer to aLayer and also update the APPEARANCE_CONTROLS.

void	SetActiveLayer (PCB_LAYER_ID aLayer, bool aForceRedraw)

void	OnDisplayOptionsChanged () override

bool	IsElementVisible (GAL_LAYER_ID aElement) const
	Test whether a given element category is visible.

void	SetElementVisibility (GAL_LAYER_ID aElement, bool aNewState)
	Change the visibility of an element category.

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

void	ShowBoardSetupDialog (const wxString &aInitialPage=wxEmptyString, wxWindow *aParent=nullptr)

void	PrepareLayerIndicator (bool aForceRebuild=false)

void	ToggleLayersManager ()

void	ToggleNetInspector ()

void	ToggleSearch ()

bool	IsSearchPaneShown ()

void	FocusSearch ()

void	ToggleLibraryTree () override

int	DoGenFootprintsPositionFile (const wxString &aFullFileName, bool aUnitsMM, bool aOnlySMD, bool aNoTHItems, bool aExcludeDNP, bool aExcludeBOM, bool aTopSide, bool aBottomSide, bool aFormatCSV, bool aUseAuxOrigin, bool aNegateBottomX)
	Create an ASCII footprint position file.

void	OnFileHistory (wxCommandEvent &event)

void	OnClearFileHistory (wxCommandEvent &aEvent)

bool	SaveBoard (bool aSaveAs=false, bool aSaveCopy=false)

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

bool	SavePcbFile (const wxString &aFileName, bool addToHistory=true, bool aChangeProject=true)
	Write the board data structures to a aFileName.

bool	SavePcbCopy (const wxString &aFileName, bool aCreateProject=false, bool aHeadless=false)
	Write the board data structures to aFileName.

bool	Clear_Pcb (bool doAskAboutUnsavedChanges, bool aFinal=false)
	Delete all and reinitialize the current board.

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.

void	SetBoard (BOARD aBoard, bool aBuildConnectivity, PROGRESS_REPORTER aReporter=nullptr)

BOARD_ITEM_CONTAINER *	GetModel () const override

std::unique_ptr< GRID_HELPER >	MakeGridHelper () override

void	SetPageSettings (const PAGE_INFO &aPageSettings) override

bool	SaveBoardAsDesignBlock (const wxString &aLibraryName)

bool	SaveSelectionAsDesignBlock (const wxString &aLibraryName)

bool	SaveBoardToDesignBlock (const LIB_ID &aLibId)

bool	SaveSelectionToDesignBlock (const LIB_ID &aLibId)

PCB_DESIGN_BLOCK_PANE *	GetDesignBlockPane () const

void	ExportFootprintsToLibrary (bool aStoreInNewLib, const wxString &aLibName=wxEmptyString, wxString *aLibPath=nullptr)
	Save footprints in a library:

bool	ExportVRML_File (const wxString &aFullFileName, double aMMtoWRMLunit, bool aIncludeUnspecified, bool aIncludeDNP, bool aExport3DFiles, bool aUseRelativePaths, const wxString &a3D_Subdir, double aXRef, double aYRef)
	Create the file(s) exporting current BOARD to a VRML file.

void	OnExportHyperlynx ()
	Export the current BOARD to a Hyperlynx HYP file.

bool	Export_IDF3 (BOARD *aPcb, const wxString &aFullFileName, bool aUseThou, double aXRef, double aYRef, bool aIncludeUnspecified, bool aIncludeDNP)
	Create an IDF3 compliant BOARD (.emn) and LIBRARY (.emp) file.

void	OnExportSTEP ()
	Export the current BOARD to a STEP assembly.

bool	ExportSpecctraFile (const wxString &aFullFilename)
	Export the current BOARD to a specctra dsn file.

bool	ImportSpecctraSession (const wxString &aFullFilename)
	Import a specctra *.ses file and use it to relocate MODULEs and to replace all vias and tracks in an existing and loaded BOARD.

void	ShowFootprintPropertiesDialog (FOOTPRINT *aFootprint)

int	ShowExchangeFootprintsDialog (FOOTPRINT *aFootprint, bool aUpdateMode, bool aSelectedMode)

void	ExchangeFootprint (FOOTPRINT aExisting, FOOTPRINT aNew, BOARD_COMMIT &aCommit, bool deleteExtraTexts=true, bool resetTextLayers=true, bool resetTextEffects=true, bool resetTextPositions=true, bool resetTextContent=true, bool resetFabricationAttrs=true, bool resetClearanceOverrides=true, bool reset3DModels=true, bool *aUpdated=nullptr)
	Replace aExisting footprint by aNew footprint using the Existing footprint settings (position, orientation, pad netnames ...).

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

void	SwitchLayer (PCB_LAYER_ID layer) override
	Change the active layer in the editor.

void	SetTrackSegmentWidth (PCB_TRACK aItem, PICKED_ITEMS_LIST aItemsListPicker, bool aUseDesignRules)
	Modify one track segment width or one via diameter (using DRC control).

void	Edit_Zone_Params (ZONE *zone_container)
	Edit params (layer, clearance, ...) for a zone outline.

void	ShowTargetOptionsDialog (PCB_TARGET *aTarget)

void	InstallNetlistFrame ()

bool	FetchNetlistFromSchematic (NETLIST &aNetlist, const wxString &aAnnotateMessage)

int	TestStandalone ()
	Test if standalone mode.

bool	ReadNetlistFromFile (const wxString &aFilename, NETLIST &aNetlist, REPORTER &aReporter)
	Read a netlist from a file into a NETLIST object.

void	OnNetlistChanged (BOARD_NETLIST_UPDATER &aUpdater, bool *aRunDragCommand)
	Called after netlist is updated.

void	SendSelectItemsToSch (const std::deque< EDA_ITEM * > &aItems, EDA_ITEM *aFocusItem, bool aForce)
	Send a message to the schematic editor to try to find schematic counterparts of specified PCB items and select them.

void	SendCrossProbeItem (BOARD_ITEM *aSyncItem)
	Send a message to the schematic editor so that it may move its cursor to an item with the same reference as the aSyncItem and highlight it.

void	SendCrossProbeNetName (const wxString &aNetName)
	Send a net name to Eeschema for highlighting.

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

void	OnBoardLoaded ()
	Update the state of the GUI after a new board is loaded or created.

void	UpdateTitle ()
	Set the main window title bar text.

void	CommonSettingsChanged (int aFlags) override
	Called after the preferences dialog is run.

void	ThemeChanged () override
	Called when light/dark theme is changed.

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

bool	CanAcceptApiCommands () override
	Check if this frame is ready to accept API commands.

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

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

TOOL_ACTION *	GetExportNetlistAction ()

DIALOG_BOOK_REPORTER *	GetInspectDrcErrorDialog ()

DIALOG_BOOK_REPORTER *	GetInspectConstraintsDialog ()

DIALOG_BOOK_REPORTER *	GetInspectClearanceDialog ()

DIALOG_BOOK_REPORTER *	GetFootprintDiffDialog ()

bool	DoAutoSave ()
	Perform auto save when the board has been modified and not saved within the auto save interval.

void	StartCrossProbeFlash (const std::vector< BOARD_ITEM * > &aItems)

void	OnCrossProbeFlashTimer (wxTimerEvent &aEvent)

bool	TryBefore (wxEvent &aEvent) override

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

wxString	CreateNewProjectLibrary (const wxString &aDialogTitle, const wxString &aLibName)

wxString	SelectLibrary (const wxString &aDialogTitle, const wxString &aListLabel, const std::vector< std::pair< wxString, bool * > > &aExtraCheckboxes={})
	Put up a dialog and allows the user to pick a library, for unspecified use.

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

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

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

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.

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

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

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

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

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

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

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

void	SetObjectVisible (GAL_LAYER_ID aLayer, bool aVisible=true)

void	ShowBarcodePropertiesDialog (PCB_BARCODE *aText)

void	ShowReferenceImagePropertiesDialog (BOARD_ITEM *aBitmap)

void	ShowTextPropertiesDialog (PCB_TEXT *aText)

int	ShowTextBoxPropertiesDialog (PCB_TEXTBOX *aTextBox)

void	ShowGraphicItemPropertiesDialog (PCB_SHAPE *aShape)

void	OpenVertexEditor (BOARD_ITEM *aItem)

void	CloseVertexEditor ()

void	UpdateVertexEditorSelection (BOARD_ITEM *aItem)

void	OnVertexEditorPaneClosed (PCB_VERTEX_EDITOR_PANE *aPane)

wxAuiManager &	GetAuiManager ()

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

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

void	ClearListAndDeleteItems (PICKED_ITEMS_LIST *aList)

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

APPEARANCE_CONTROLS *	GetAppearancePanel ()

LAYER_PAIR_SETTINGS *	GetLayerPairSettings ()
	Acess to the layer pair settings controller of the board, if available.

void	ToggleProperties () override

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

void	HighlightSelectionFilter (const PCB_SELECTION_FILTER_OPTIONS &aOptions)

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.

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

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

const BOX2I	GetDocumentExtents (bool aIncludeAllVisible=true) const override
	Return bounding box of document with option to not include some items.

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.

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

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.

wxString	MessageTextFromCoord (int aValue, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType) const

const TITLE_BLOCK &	GetTitleBlock () const override

void	SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override

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

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

void	SetDisplayOptions (const PCB_DISPLAY_OPTIONS &aOptions, bool aRefresh=true)
	Update the current display options.

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

virtual void	SetPlotSettings (const PCB_PLOT_PARAMS &aSettings)

virtual void	ReloadFootprint (FOOTPRINT *aFootprint)
	Reload the footprint from the library.

BOARD *	GetBoard () const

EDA_ITEM *	ResolveItem (const KIID &aId, bool aAllowNullptrReturn=false) const override
	Fetch an item by KIID.

void	FocusOnItem (EDA_ITEM *aItem, bool aAllowScroll=true) override
	Focus on a particular canvas item.

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

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

void	HideSolderMask ()

void	ShowSolderMask ()

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

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

EDA_3D_VIEWER_FRAME *	CreateAndShow3D_Frame ()
	Show the 3D view frame.

GENERAL_COLLECTORS_GUIDE	GetCollectorsGuide ()

FOOTPRINT *	CreateNewFootprint (wxString aFootprintName, const wxString &aLibName)
	Create a new footprint at position 0,0.

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

void	ShowPadPropertiesDialog (PAD *aPad)

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

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

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

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

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

virtual MAGNETIC_SETTINGS *	GetMagneticItemsSettings ()

PCB_DRAW_PANEL_GAL *	GetCanvas () const override
	Return a pointer to GAL-based canvas of given EDA draw frame.

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

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

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

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

void	GetLibraryItemsForListDialog (wxArrayString &aHeaders, std::vector< wxArrayString > &aItemsToDisplay)

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

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

void	ScriptingConsoleEnableDisable ()
	Toggle the scripting console visibility.

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

EDA_SEARCH_DATA &	GetFindReplaceData ()

wxArrayString &	GetFindHistoryList ()

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

void	SetShowPolarCoords (bool aShow)

void	ToggleUserUnits () override

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

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

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

virtual COLOR4D	GetDrawBgColor () const

bool	LibraryFileBrowser (const wxString &aTitle, bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory, FILEDLG_HOOK_NEW_LIBRARY *aFileDlgHook=nullptr)

virtual wxString	GetScreenDesc () const

virtual wxString	GetFullScreenDesc () const

void	EraseMsgBox ()

virtual void	ReCreateHToolbar ()

virtual void	ReCreateVToolbar ()

virtual void	ReCreateLeftToolbar ()

virtual void	ReCreateAuxiliaryToolbar ()

bool	IsGridVisible () const

bool	IsGridOverridden () const

virtual void	SetGridOverrides (bool aOverride)

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

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

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

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

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

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

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

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

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.

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

virtual void	ClearFocus ()

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

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

void	DisplayToolMsg (const wxString &msg) override

void	DisplayConstraintsMsg (const wxString &msg)

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

wxStatusBar *	OnCreateStatusBar (int number, long style, wxWindowID id, const wxString &name) override
	Create the status line (like a wxStatusBar).

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

virtual void	DisplayGridMsg ()
	Display current grid size in the status bar.

bool	GetOverrideLocks () const

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

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

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

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.

virtual void	UpdateMsgPanel ()
	Redraw the message panel.

virtual LIB_TREE *	GetLibTree () const

virtual LIB_ID	GetTargetLibId () const

virtual bool	IsLibraryTreeShown () const

virtual void	FocusLibraryTreeInput ()

PROPERTIES_PANEL *	GetPropertiesPanel ()

void	UpdateProperties ()

void	SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)

wxWindow *	GetToolCanvas () const override
	Canvas access.

GAL_DISPLAY_OPTIONS_IMPL &	GetGalDisplayOptions ()
	Return a reference to the gal rendering options used by GAL for rendering.

void	RefreshCanvas () override

HOTKEY_CYCLE_POPUP *	GetHotkeyPopup ()

virtual void	CreateHotkeyPopup ()

bool	SaveCanvasImageToFile (const wxString &aFileName, BITMAP_TYPE aBitmapType)
	Save the current view as an image file.

virtual void	OnApiPluginInvoke (wxCommandEvent &aEvent)
	Handler for activating an API plugin (via toolbar or menu).

virtual void	AddApiPluginTools (ACTION_TOOLBAR *aToolbar)
	Append actions from API plugins to the given toolbar.

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

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

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.

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)

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.

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

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.

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

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.

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

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

void	SelectLeftToolbarAction (const TOOL_ACTION &aAction)
	Select the given action in the left toolbar group which contains it, if any.

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.

virtual wxString	help_name ()

void	OnKicadAbout (wxCommandEvent &event)

void	OnPreferences (wxCommandEvent &event)

void	ShowPreferences (wxString aStartPage, wxString aStartParentPage)
	Display the preferences and settings of all opened editors paged dialog, starting with a particular page.

void	PrintMsg (const wxString &text)

void	CreateInfoBar ()

void	RestoreAuiLayout ()

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.

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.

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.

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.

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

void	LoadWindowState (const wxString &aFileName)

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

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

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

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

wxString	ConfigBaseName () override
	Get the configuration base name.

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

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

virtual void	ClearFileHistory ()
	Remove all files from the file history.

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

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

void	SetMruPath (const wxString &aPath)

wxString	GetMruPath () const

virtual void	RecreateToolbars ()

void	OnToolbarSizeChanged ()
	Update toolbars if desired toolbar icon changed.

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

void	RegisterCustomToolbarControlFactory (const ACTION_TOOLBAR_CONTROL &aControlDesc, const ACTION_TOOLBAR_CONTROL_FACTORY &aControlFactory)
	Register a creation factory for toolbar controls that are present in this frame.

ACTION_TOOLBAR_CONTROL_FACTORY *	GetCustomToolbarControlFactory (const std::string &aName)

void	ReCreateMenuBar ()
	Recreate the menu bar.

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

wxString	GetRunMenuCommandDescription (const TOOL_ACTION &aAction)

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

const wxString &	GetAboutTitle () const

const wxString &	GetUntranslatedAboutTitle () const

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

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

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

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

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

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

virtual int	GetUndoCommandCount () const

virtual int	GetRedoCommandCount () const

virtual wxString	GetUndoActionDescription () const

virtual wxString	GetRedoActionDescription () const

int	GetMaxUndoItems () const

bool	IsClosing () const

bool	NonUserClose (bool aForce)

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

TOOL_MANAGER *	GetToolManager () const
	Return the MVC controller.

TOOL_DISPATCHER *	GetToolDispatcher () const

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

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

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.

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

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

HOLDER_TYPE	GetType () const

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

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

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

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

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) const
	Converts aValue in internal units into a united string.

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

wxString	StringFromOptionalValue (std::optional< int > aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	Converts an optional aValue in internal units into a united string.

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

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

wxString	MessageTextFromMinOptMax (const MINOPTMAX< int > &aValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const

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

std::optional< int >	OptionalValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	Converts aTextValue in aUnits to internal units used by the frame.

EDA_ANGLE	AngleValueFromString (const wxString &aTextValue) const

EDA_UNITS	GetUnitsFromType (EDA_DATA_TYPE aType) const
	Gets the units to use in the conversion based on the underlying user units.

Static Public Member Functions
static const wxString	SearchPaneName ()

static bool	GetActionPluginButtonVisible (const wxString &aPluginPath, bool aPluginDefault)
	Return true if button visibility action plugin setting was set to true or it is unset and plugin defaults to true.

static std::vector< std::variant< ACTION_PLUGIN , const PLUGIN_ACTION > >	GetOrderedActionPlugins ()
	Return ordered list of plugins in sequence in which they should appear on toolbar or in settings.

static wxString	VertexEditorPaneName ()

static const wxString	PropertiesPaneName ()

static const wxString	NetInspectorPanelName ()

static const wxString	DesignBlocksPaneName ()

static const wxString	AppearancePanelName ()

static bool	IsPluginActionButtonVisible (const PLUGIN_ACTION &aAction, APP_SETTINGS_BASE *aCfg)

static std::vector< const PLUGIN_ACTION * >	GetOrderedPluginActions (PLUGIN_ACTION_SCOPE aScope, APP_SETTINGS_BASE *aCfg)
	Return ordered list of plugin actions for display in the toolbar.

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.

static EDA_DATA_TYPE	GetTypeFromUnits (const EDA_UNITS aUnits)
	Gets the inferred type from the given units.

Public Attributes
wxChoice *	m_SelTrackWidthBox

wxChoice *	m_SelViaSizeBox

bool	m_show_layer_manager_tools

bool	m_show_search

bool	m_show_net_inspector

bool	m_ZoneFillsDirty

bool	m_probingSchToPcb

wxTimer	m_crossProbeFlashTimer
	Timer to toggle selection visibility for flash.

int	m_crossProbeFlashPhase = 0
	Phase counter.

std::vector< KIID >	m_crossProbeFlashItems
	Items to flash (by UUID)

bool	m_crossProbeFlashing = false
	Currently flashing guard.

Static Public Attributes
static const wxString	NullUiString = ""
	The string that is used in the UI to represent a null value.

Protected Member Functions
void	doReCreateMenuBar () override

void	configureToolbars () override

void	setupTools ()

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

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

void	buildActionPluginMenus (ACTION_MENU *aActionMenu)
	Fill action menu with all registered action plugins.

void	addActionPluginTools (ACTION_TOOLBAR *aToolbar)
	Append action plugin buttons to given toolbar.

void	RunActionPlugin (ACTION_PLUGIN *aActionPlugin)
	Execute action plugin's Run() method and updates undo buffer.

void	OnActionPluginMenu (wxCommandEvent &aEvent)
	Launched by the menu when an action is called.

void	OnActionPluginButton (wxCommandEvent &aEvent)
	Launched by the button when an action is called.

PLUGIN_ACTION_SCOPE	PluginActionScope () const override

bool	doAutoSave () override
	Perform auto save when the board has been modified and not saved within the auto save interval.

bool	importFile (const wxString &aFileName, int aFileType, const std::map< std::string, UTF8 > *aProperties=nullptr)
	Load the given filename but sets the path to the current project path.

bool	saveBoardAsFile (BOARD *aBoard, const wxString &aFileName, bool aHeadless=false)
	Save a board object to a file.

bool	saveSelectionToDesignBlock (const wxString &aNickname, PCB_SELECTION &aSelection, DESIGN_BLOCK &aBlock)

bool	canCloseWindow (wxCloseEvent &aCloseEvent) override

void	doCloseWindow () override

	PCB_EDIT_FRAME (KIWAY aKiway, wxWindow aParent)

void	onSize (wxSizeEvent &aEvent)

int	inferLegacyEdgeClearance (BOARD *aBoard, bool aShowUserMsg=true)

void	redrawNetnames ()

void	saveProjectSettings () override
	Save any design-related project settings associated with this frame.

void	onCloseModelessBookReporterDialogs (wxCommandEvent &aEvent)

wxString	createNewLibrary (const wxString &aDialogTitle, const wxString &aLibName, const wxString &aInitialPath, FP_LIB_TABLE *aTable)
	Create a new library in the given table.

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

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.

virtual void	onDarkModeToggle ()

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

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

void	rebuildConnectivity ()

void	setFPWatcher (FOOTPRINT *aFootprint)
	Create or removes a watcher on the specified footprint.

virtual void	SetScreen (BASE_SCREEN *aScreen)

void	setupUnits (APP_SETTINGS_BASE *aCfg)

void	updateStatusBarWidths ()

std::vector< wxWindow * >	findDialogs ()

virtual void	resolveCanvasType ()
	Determine the canvas type to load (with prompt if required) and initializes m_canvasType.

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

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

void	onActivate (wxActivateEvent &aEvent)

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

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

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

void	onIconize (wxIconizeEvent &aEvent)

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

void	onSystemColorChange (wxSysColourChangedEvent &aEvent)

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

void	ensureWindowIsOnScreen ()

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

void	AddMenuLanguageList (ACTION_MENU aMasterMenu, TOOL_INTERACTIVE aControlTool)
	Create a menu list for language choice, and add it as submenu to MasterMenu.

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

Protected Attributes
LAYER_TOOLBAR_ICON_VALUES	m_prevIconVal

bool	m_undoRedoBlocked

PANEL_SELECTION_FILTER *	m_selectionFilterPanel

APPEARANCE_CONTROLS *	m_appearancePanel

std::unique_ptr< LAYER_PAIR_SETTINGS >	m_layerPairSettings

PCB_VERTEX_EDITOR_PANE *	m_vertexEditorPane

PCB_LAYER_BOX_SELECTOR *	m_SelLayerBox

wxAuiNotebook *	m_tabbedPanel

bool	m_darkMode
	Panel with Layers and Object Inspector tabs.

BOARD *	m_pcb

PCB_DISPLAY_OPTIONS	m_displayOptions

PCB_ORIGIN_TRANSFORMS	m_originTransforms

wxSocketServer *	m_socketServer
	Prevents opening same file multiple times.

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

wxCheckBox *	m_overrideLocksCb

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

PROPERTIES_PANEL *	m_propertiesPanel

NET_INSPECTOR_PANEL *	m_netInspectorPanel

HOTKEY_CYCLE_POPUP *	m_hotkeyPopup

EDA_DRAW_PANEL_GAL::GAL_TYPE	m_canvasType
	The current canvas type.

bool	m_modal

wxGUIEventLoop *	m_modal_loop
	Points to nested event_loop. NULL means not modal and dismissed.

wxWindow *	m_modal_resultant_parent

wxString	m_modal_string

bool	m_modal_ret_val

std::vector< wxSocketBase * >	m_sockets

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

nlohmann::json	m_auiLayoutState

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

bool	m_autoSavePermissionError

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.

bool	m_isClosing
	Set by the close window event handler after frames are asked if they can close.

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

std::map< const wxString, TOOL_ACTION * >	m_acceptedExts
	Associate file extensions with action to execute.

TOOLBAR_SETTINGS *	m_toolbarSettings

ACTION_TOOLBAR *	m_tbTopMain

ACTION_TOOLBAR *	m_tbTopAux

ACTION_TOOLBAR *	m_tbRight

ACTION_TOOLBAR *	m_tbLeft

std::map< std::string, ACTION_TOOLBAR_CONTROL_FACTORY >	m_toolbarControlFactories

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 occurred when switching to OpenGL in any EDA_DRAW_FRAME?

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

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

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

wxWindow *	findQuasiModalDialog ()

Private Attributes
TOOL_ACTION *	m_exportNetlistAction
	The export board netlist tool action object.

DIALOG_FIND *	m_findDialog

DIALOG_BOOK_REPORTER *	m_inspectDrcErrorDlg

DIALOG_BOOK_REPORTER *	m_inspectClearanceDlg

DIALOG_BOOK_REPORTER *	m_inspectConstraintsDlg

DIALOG_BOOK_REPORTER *	m_footprintDiffDlg

DIALOG_BOARD_SETUP *	m_boardSetupDlg

std::vector< LIB_ID >	m_designBlockHistoryList

PCB_DESIGN_BLOCK_PANE *	m_designBlocksPane

const std::map< std::string, UTF8 > *	m_importProperties

BOX2D	m_lastNetnamesViewport
	Keep track of viewport so that track net labels can be adjusted when it changes.

wxTimer *	m_eventCounterTimer

std::unique_ptr< NL_PCBNEW_PLUGIN >	m_spaceMouse

std::unique_ptr< wxFileSystemWatcher >	m_watcher

wxFileName	m_watcherFileName

wxDateTime	m_watcherLastModified

wxTimer	m_watcherDebounceTimer

bool	m_inFpChangeTimerEvent

BASE_SCREEN *	m_currentScreen
	current used SCREEN

EDA_DRAW_PANEL_GAL *	m_canvas

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

int	m_lastToolbarIconSize

KIWAY *	m_kiway

HOLDER_TYPE	m_type

const EDA_IU_SCALE &	m_iuScale

EDA_UNITS	m_userUnits

Friends
struct	PCB::IFACE

class	APPEARANCE_CONTROLS

Detailed Description

The main frame for Pcbnew.

See also class PCB_BASE_FRAME(): Basic class for Pcbnew and GerbView.

Definition at line 80 of file pcb_edit_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 41 of file kiway_holder.h.

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

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

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 118 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ ~PCB_EDIT_FRAME()

PCB_EDIT_FRAME::~PCB_EDIT_FRAME ( )

virtual

Definition at line 686 of file pcb_edit_frame.cpp.

References DIALOG_DRC_WINDOW_NAME, PCB_BASE_FRAME::GetBoard(), ADVANCED_CFG::GetCfg(), m_eventCounterTimer, m_exportNetlistAction, TOOLS_HOLDER::m_toolManager, BOARD::RemoveAllListeners(), and ScriptingOnDestructPcbEditFrame().

◆ PCB_EDIT_FRAME()

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

protected

Member Function Documentation

◆ ActivateGalCanvas()

void PCB_EDIT_FRAME::ActivateGalCanvas ( )

overridevirtual

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

Reimplemented from PCB_BASE_EDIT_FRAME.

Definition at line 1457 of file pcb_edit_frame.cpp.

References PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::Refresh(), and PCB_DRAW_PANEL_GAL::UpdateColors().

◆ addActionPluginTools()

void PCB_EDIT_FRAME::addActionPluginTools ( ACTION_TOOLBAR * aToolbar )

protected

Append action plugin buttons to given toolbar.

Definition at line 504 of file pcbnew_action_plugins.cpp.

References ACTION_TOOLBAR::AddScaledSeparator(), GetActionPluginButtonVisible(), ACTION_PLUGIN::GetName(), GetOrderedActionPlugins(), ACTION_PLUGIN::GetPluginPath(), ACTION_PLUGIN::GetShowToolbarButton(), ACTION_PLUGIN::iconBitmap, KiScaledBitmap(), OnActionPluginButton(), puzzle_piece, and ACTION_PLUGINS::SetActionButton().

Referenced by configureToolbars().

◆ AddApiPluginTools()

void EDA_DRAW_FRAME::AddApiPluginTools ( ACTION_TOOLBAR * aToolbar )

virtualinherited

Append actions from API plugins to the given toolbar.

Parameters

aToolbar is the toolbar to add the plugins to

Definition at line 1457 of file eda_draw_frame.cpp.

References API_PLUGIN_MANAGER::ButtonBindings(), EDA_BASE_FRAME::config(), GetOrderedPluginActions(), KIPLATFORM::UI::IsDarkTheme(), IsPluginActionButtonVisible(), OnApiPluginInvoke(), Pgm(), and PluginActionScope().

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

◆ AddBoardChangeListener()

void PCB_BASE_FRAME::AddBoardChangeListener ( wxEvtHandler * aListener )

inherited

Add aListener to post #EDA_EVT_BOARD_CHANGED command events to.

Warning: The caller is responsible 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.

◆ AddFootprintToBoard()

void PCB_BASE_FRAME::AddFootprintToBoard ( FOOTPRINT * aFootprint )

virtualinherited

Add the given footprint to the board.

Parameters

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

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 193 of file pcb_base_frame.cpp.

References BOARD::Add(), ANGLE_0, APPEND, FOOTPRINT::Flip(), GetBoard(), GetCanvas(), GetPcbNewSettings(), FOOTPRINT::GetPosition(), IS_NEW, FOOTPRINT::IsFlipped(), TOOLS_HOLDER::m_toolManager, PCB_ACTIONS::rehatchShapes, EDA_ITEM::SetFlags(), FOOTPRINT::SetOrientation(), FOOTPRINT::SetPosition(), and BOARD::UpdateUserUnits().

Referenced by FOOTPRINT_EDIT_FRAME::ReloadFootprint().

◆ AddLibrary()

bool PCB_BASE_EDIT_FRAME::AddLibrary	(	const wxString &	aDialogTitle,
		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 481 of file footprint_libraries_utils.cpp.

References DisplayError(), editor, PCB_IO_MGR::FILE_TYPE_NONE, FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_VIEWER, FP_LIB_TABLE::GetGlobalTableFileName(), FILEDLG_HOOK_NEW_LIBRARY::GetUseGlobalTable(), GFootprintTable, PCB_IO_MGR::GuessPluginTypeFromLibPath(), LIB_TABLE::InsertRow(), PCB_IO_MGR::KICAD_SEXP, FILEEXT::KiCadFootprintLibPathExtension, FILEEXT::KiCadFootprintLibPathWildcard(), Kiway, EDA_DRAW_FRAME::LibraryFileBrowser(), NormalizePath(), PROJECT_PCB::PcbFootprintLibs(), Pgm(), KIWAY::Player(), Prj(), LIB_TABLE::Save(), PCB_IO_MGR::ShowType(), and IO_ERROR::What().

Referenced by createNewLibrary().

◆ AddMenuLanguageList()

void EDA_BASE_FRAME::AddMenuLanguageList	(	ACTION_MENU *	aMasterMenu,
		TOOL_INTERACTIVE *	aControlTool )

protectedinherited

Create a menu list for language choice, and add it as submenu to MasterMenu.

Parameters

aMasterMenu	is the main menu.
aControlTool	is the tool to associate with the menu.

Definition at line 1854 of file eda_base_frame.cpp.

References _, ACTION_MENU::Add(), language, LanguagesList, ACTION_MENU::SetIcon(), and ACTION_MENU::SetTitle().

Referenced by BITMAP2CMP_FRAME::doReCreateMenuBar(), CVPCB_MAINFRAME::doReCreateMenuBar(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_CALCULATOR_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SIMULATOR_FRAME::doReCreateMenuBar(), and SYMBOL_EDIT_FRAME::doReCreateMenuBar().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar * aMenuBar )

inherited

Add the standard KiCad help menu to the menubar.

Definition at line 711 of file eda_base_frame.cpp.

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

Referenced by CVPCB_MAINFRAME::doReCreateMenuBar(), EDA_3D_VIEWER_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), and SYMBOL_VIEWER_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 643 of file eda_draw_frame.cpp.

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

Referenced by PCB_VIEWER_TOOLS::Init().

◆ AngleValueFromString()

EDA_ANGLE UNITS_PROVIDER::AngleValueFromString ( const wxString & aTextValue ) const

inlineinherited

Definition at line 188 of file units_provider.h.

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

◆ AppearancePanelName()

static const wxString EDA_DRAW_FRAME::AppearancePanelName ( )

inlinestaticinherited

Definition at line 441 of file eda_draw_frame.h.

Referenced by PCB_EDIT_FRAME::SaveSettings(), and PCB_EDIT_FRAME::ToggleLayersManager().

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

Reimplemented from PCB_BASE_FRAME.

Definition at line 183 of file undo_redo.cpp.

References PICKED_ITEMS_LIST::GetDescription(), EDA_BASE_FRAME::PopCommandFromUndoList(), saveCopyInUndoList(), and PICKED_ITEMS_LIST::SetDescription().

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

References EDA_BASE_FRAME::m_isClosing, and m_messagePanel.

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

◆ buildActionPluginMenus()

void PCB_EDIT_FRAME::buildActionPluginMenus ( ACTION_MENU * aActionMenu )

protected

Fill action menu with all registered action plugins.

Definition at line 481 of file pcbnew_action_plugins.cpp.

References KIUI::AddMenuItem(), ACTION_PLUGINS::GetAction(), ACTION_PLUGINS::GetActionsCount(), ACTION_PLUGIN::GetDescription(), ACTION_PLUGIN::GetName(), ACTION_PLUGIN::iconBitmap, KiBitmap(), OnActionPluginMenu(), puzzle_piece, and ACTION_PLUGINS::SetActionMenu().

Referenced by doReCreateMenuBar().

◆ CanAcceptApiCommands()

bool PCB_EDIT_FRAME::CanAcceptApiCommands ( )

overridevirtual

Check if this frame is ready to accept API commands.

A frame might not accept commands if a long-running process is underway, a dialog is open, the user is interacting with a tool, etc.

Reimplemented from EDA_BASE_FRAME.

Definition at line 3021 of file pcb_edit_frame.cpp.

References EDA_BASE_FRAME::CanAcceptApiCommands(), TOOLS_HOLDER::GetToolManager(), ZONE_FILLER_TOOL::IsBusy(), TOOLS_HOLDER::m_toolManager, and ROUTER_TOOL::RoutingInProgress().

◆ canCloseWindow()

bool PCB_EDIT_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

overrideprotectedvirtual

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1742 of file eda_base_frame.cpp.

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

◆ Clear_Pcb()

bool PCB_EDIT_FRAME::Clear_Pcb	(	bool	doAskAboutUnsavedChanges,
		bool	aFinal = false )

Delete all and reinitialize the current board.

Parameters

doAskAboutUnsavedChanges	true to prompt user if existing board contains unsaved changes, false to re-initialize silently.
aFinal	if true, we are clearing the board to exit, so don't run more events. Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.

Definition at line 42 of file initpcb.cpp.

References _, BOARD, KIGFX::VIEW::Clear(), EDA_BASE_FRAME::ClearUndoRedoList(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetPageSizeIU(), PCB_BASE_FRAME::GetScreen(), PCB_DRAW_PANEL_GAL::GetView(), BASE_SCREEN::InitDataPoints(), IsOK(), PCB_BASE_EDIT_FRAME::m_appearancePanel, EDA_BASE_FRAME::m_isClosing, TOOLS_HOLDER::m_toolManager, EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar(), ReCreateLayerBox(), EDA_DRAW_FRAME::ReleaseFile(), BOARD::ResetNetHighLight(), SetBoard(), BASE_SCREEN::SetContentModified(), BOARD::SetCopperLayerCount(), BOARD::SetEnabledLayers(), BOARD::SetFileName(), BOARD::SetUserDefinedLayerCount(), BOARD::SetVisibleLayers(), TOOL_BASE::SHUTDOWN, UpdateTitle(), and EDA_DRAW_FRAME::Zoom_Automatique().

Referenced by doCloseWindow(), and OpenProjectFiles().

◆ ClearFileHistory()

void EDA_BASE_FRAME::ClearFileHistory ( )

virtualinherited

Remove all files from the file history.

Reimplemented in GERBVIEW_FRAME.

Definition at line 1303 of file eda_base_frame.cpp.

References m_fileHistory, and ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::ClearFileHistory(), KIWAY::ClearFileHistory(), BITMAP2CMP_FRAME::OnClearFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), and SCH_EDIT_FRAME::OnClearFileHistory().

◆ ClearFocus()

virtual void EDA_DRAW_FRAME::ClearFocus ( )

inlinevirtualinherited

Definition at line 318 of file eda_draw_frame.h.

References FocusOnItem().

Referenced by SCH_EDIT_FRAME::HardRedraw(), and SCH_EDIT_FRAME::SetCurrentSheet().

◆ ClearListAndDeleteItems()

void PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems ( PICKED_ITEMS_LIST * aList )

inherited

Definition at line 693 of file undo_redo.cpp.

References PICKED_ITEMS_LIST::ClearListAndDeleteItems(), EDA_ITEM::HasFlag(), and UR_TRANSIENT.

Referenced by ClearUndoORRedoList(), and RollbackFromUndo().

◆ ClearMsgPanel()

void EDA_DRAW_FRAME::ClearMsgPanel ( )

virtualinherited

Clear all messages from the message panel.

Reimplemented in SYMBOL_EDIT_FRAME.

Definition at line 881 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing, and m_messagePanel.

Referenced by GERBER_FILE_IMAGE::DisplayImageInfo(), GERBVIEW_FRAME::LoadGerberJobFile(), 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 666 of file undo_redo.cpp.

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

Referenced by 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 1669 of file eda_base_frame.cpp.

References ClearUndoORRedoList(), REDO_LIST, and UNDO_LIST.

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

◆ CloseVertexEditor()

void PCB_BASE_EDIT_FRAME::CloseVertexEditor ( )

inherited

Definition at line 454 of file pcb_base_edit_frame.cpp.

References m_vertexEditorPane.

Referenced by ~PCB_BASE_EDIT_FRAME().

◆ commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T aFrameType )

privateinherited

Collect common initialization functions used in all CTORs.

Definition at line 138 of file eda_base_frame.cpp.

References commonInit(), DEFAULT_MAX_UNDO_ITEMS, defaultSize(), EDA_BASE_FRAME(), PATHS::GetDefaultUserProjectsPath(), PGM_BASE::GetSettingsManager(), ID_AUTO_SAVE_TIMER, initExitKey(), m_auimgr, m_autoSavePending, m_autoSavePermissionError, m_autoSaveRequired, m_autoSaveTimer, m_displayIndex, m_fileHistory, m_frameSize, m_ident, m_infoBar, m_isClosing, m_isNonUserClose, m_maximizeByDefault, m_mruPath, m_settingsManager, m_supportsAutoSave, m_undoRedoCountMax, minSize, minSizeLookup(), onAutoSaveTimer(), Pgm(), and windowClosing().

Referenced by commonInit(), and EDA_BASE_FRAME().

◆ CommonSettingsChanged()

void PCB_EDIT_FRAME::CommonSettingsChanged ( int aFlags )

overridevirtual

Called after the preferences dialog is run.

Reimplemented from PCB_BASE_FRAME.

Definition at line 2894 of file pcb_edit_frame.cpp.

References _, EDA_BASE_FRAME::CommonSettingsChanged(), WX_INFOBAR::DRC_RULES_ERROR, ENVVARS_CHANGED, EDA_DRAW_PANEL_GAL::ForceRefresh(), PCB_BASE_EDIT_FRAME::GetAppearancePanel(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DRC_TOOL::GetDRCEngine(), EDA_DRAW_FRAME::GetGalDisplayOptions(), EDA_BASE_FRAME::GetInfoBar(), PCB_BASE_FRAME::GetPcbNewSettings(), PCB_DRAW_PANEL_GAL::GetView(), DRC_ENGINE::InitEngine(), LAYER_RATSNEST, TOOLS_HOLDER::m_toolManager, KIGFX::VIEW::MarkTargetDirty(), APPEARANCE_CONTROLS::OnColorThemeChanged(), PythonSyncEnvironmentVariables(), GAL_DISPLAY_OPTIONS_IMPL::ReadWindowSettings(), SetElementVisibility(), ShowBoardSetupDialog(), and KIGFX::TARGET_NONCACHED.

◆ 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 GetBoard(), BOARD::GetConnectivity(), m_pcb, BOARD::OnRatsnestChanged(), CONNECTIVITY_DATA::RecalculateRatsnest(), EDA_DRAW_FRAME::SetMsgPanel(), and BOARD::UpdateRatsnestExclusions().

Referenced by PCB_EDIT_FRAME::OnNetlistChanged(), PlaceFootprint(), and PCB_BASE_EDIT_FRAME::PutDataInPreviousState().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const

virtualinherited

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

Reimplemented in FOOTPRINT_EDIT_FRAME, KICAD_MANAGER_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 1119 of file eda_base_frame.cpp.

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), EDA_DRAW_FRAME::AddApiPluginTools(), PCB_CONTROL::AppendBoard(), PCB_CONTROL::AppendDesignBlock(), AskLoadBoardFileName(), EDA_DRAW_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), SIMULATOR_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), PCB_VIEWER_TOOLS::FootprintAutoZoom(), PCB_EDITOR_CONDITIONS::footprintViewerAutoZoom(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GERBVIEW_FRAME::gvconfig(), EDA_DRAW_FRAME::IsGridOverridden(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), PCB_CALCULATOR_FRAME::loadPages(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), GERBVIEW_FRAME::Read_EXCELLON_File(), RecreateToolbars(), SaveSettings(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetDisplayOptions(), EDA_DRAW_FRAME::SetGridOverrides(), EDA_DRAW_FRAME::SetGridVisibility(), SCH_EDIT_FRAME::SetSchematic(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIMULATOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), BITMAP2CMP_FRAME::ShowChangedLanguage(), PCB_CALCULATOR_FRAME::ShowChangedLanguage(), EDA_DRAW_FRAME::UpdateGridSelectBox(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), windowClosing(), and BITMAP2CMP_FRAME::~BITMAP2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )

inlineoverridevirtualinherited

Get the configuration base name.

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

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

Reimplemented from TOOLS_HOLDER.

Definition at line 367 of file eda_base_frame.h.

References m_configName.

◆ configureToolbars()

void PCB_EDIT_FRAME::configureToolbars ( )

overrideprotectedvirtual

◆ CreateAndShow3D_Frame()

EDA_3D_VIEWER_FRAME * PCB_BASE_FRAME::CreateAndShow3D_Frame ( )

inherited

Show the 3D view frame.

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

Definition at line 639 of file pcb_base_frame.cpp.

References _, Get3DViewerFrame(), and Kiway.

Referenced by PCB_VIEWER_TOOLS::Show3DViewer(), and FOOTPRINT_CHOOSER_FRAME::Show3DViewerFrame().

◆ CreateHotkeyPopup()

void EDA_DRAW_FRAME::CreateHotkeyPopup ( )

virtualinherited

Definition at line 1277 of file eda_draw_frame.cpp.

References m_hotkeyPopup.

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 1144 of file eda_base_frame.cpp.

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

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ CreateNewFootprint()

FOOTPRINT * PCB_BASE_FRAME::CreateNewFootprint	(	wxString	aFootprintName,
		const wxString &	aLibName )

inherited

Create 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.
aLibName	optional, if specified is the library for the new footprint

Definition at line 1176 of file footprint_libraries_utils.cpp.

References _, FOOTPRINT, FP_LIB_TABLE::FootprintEnumerate(), FP_LIB_TABLE::FootprintExists(), FP_LIB_TABLE::FootprintLoad(), FP_SMD, FOOTPRINT::GetAttributes(), GetBoard(), 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_FIELD_T, PCB_TEXT_T, PROJECT_PCB::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), RECURSE, 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(), FOOTPRINT::SetValue(), EDA_TEXT::SetVisible(), EDA_ITEM::Type(), FOOTPRINT::Value(), and VECTOR2< T >::y.

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

◆ CreateNewLibrary()

wxString PCB_BASE_EDIT_FRAME::CreateNewLibrary	(	const wxString &	aDialogTitle,
		const wxString &	aInitialPath = 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

aDialogTitle	title for the file browser
aInitialPath	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 305 of file footprint_libraries_utils.cpp.

References createNewLibrary().

Referenced by FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveLibraryAs(), and SelectLibrary().

◆ createNewLibrary()

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

protectedinherited

Create a new library in the given table.

(The user will be consulted if the table is null.)

Definition at line 311 of file footprint_libraries_utils.cpp.

References _, AddLibrary(), DisplayError(), KIDIALOG::DoNotShowCheckbox(), EnsureFileExtension(), PROJECT::GetProjectPath(), FILEDLG_HOOK_NEW_LIBRARY::GetUseGlobalTable(), GFootprintTable, PCB_IO_MGR::KICAD_SEXP, FILEEXT::KiCadFootprintLibPathExtension, FILEEXT::KiCadFootprintLibPathWildcard(), EDA_DRAW_FRAME::LibraryFileBrowser(), PROJECT_PCB::PcbFootprintLibs(), PCB_IO_MGR::PluginFind(), Prj(), EDA_BASE_FRAME::ShowInfoBarError(), KIDIALOG::ShowModal(), and IO_ERROR::What().

Referenced by CreateNewLibrary(), and CreateNewProjectLibrary().

◆ CreateNewProjectLibrary()

wxString PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary	(	const wxString &	aDialogTitle,
		const wxString &	aLibName )

inherited

Definition at line 299 of file footprint_libraries_utils.cpp.

References createNewLibrary(), PROJECT_PCB::PcbFootprintLibs(), 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 m_socketServer.

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

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 120 of file tools_holder.cpp.

References m_toolStack, and ACTIONS::selectionTool.

Referenced by ShowChangedLanguage().

◆ DesignBlocksPaneName()

static const wxString EDA_DRAW_FRAME::DesignBlocksPaneName ( )

inlinestaticinherited

Definition at line 439 of file eda_draw_frame.h.

Referenced by defaultDesignBlocksPaneInfo(), PCB_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), PCB_EDIT_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::ToggleLibraryTree(), and SCH_EDIT_FRAME::ToggleLibraryTree().

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

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

Definition at line 150 of file kiway_player.cpp.

References EDA_BASE_FRAME::GetFrameType(), KIWAY_HOLDER::Kiway(), and KIWAY::PlayerDidClose().

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), GERBVIEW_FRAME::doCloseWindow(), PL_EDITOR_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), SIMULATOR_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::doCloseWindow(), SYMBOL_VIEWER_FRAME::doCloseWindow(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ DismissModal()

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

inherited

Definition at line 164 of file kiway_player.cpp.

References m_modal_loop, m_modal_ret_val, and m_modal_string.

Referenced by FOOTPRINT_CHOOSER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SYMBOL_CHOOSER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), FOOTPRINT_CHOOSER_FRAME::OnOK(), SYMBOL_CHOOSER_FRAME::OnOK(), and SYMBOL_CHOOSER_FRAME::SYMBOL_CHOOSER_FRAME().

◆ DisplayConstraintsMsg()

void EDA_DRAW_FRAME::DisplayConstraintsMsg ( const wxString & msg )

inherited

Definition at line 672 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing.

Referenced by EDIT_TOOL::doMoveSelection().

◆ DisplayGridMsg()

void EDA_DRAW_FRAME::DisplayGridMsg ( )

virtualinherited

Display current grid size in the status bar.

Reimplemented in GERBVIEW_FRAME, and PL_EDITOR_FRAME.

Definition at line 681 of file eda_draw_frame.cpp.

References _, GRID_SETTINGS::grids, EDA_BASE_FRAME::m_isClosing, and TOOLS_HOLDER::m_toolManager.

Referenced by PCB_BASE_FRAME::UpdateStatusBar(), and SCH_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

void EDA_DRAW_FRAME::DisplayToolMsg ( const wxString & msg )

overridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 663 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing.

Referenced by EDIT_TOOL::Duplicate().

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )

inherited

Display current unit pane in the status bar.

Definition at line 697 of file eda_draw_frame.cpp.

References _, UNITS_PROVIDER::GetUserUnits(), INCH, EDA_BASE_FRAME::m_isClosing, MILS, and MM.

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

◆ DoAutoSave()

bool PCB_EDIT_FRAME::DoAutoSave ( )

Perform auto save when the board has been modified and not saved within the auto save interval.

Returns: true if the auto save was successful.

Definition at line 3296 of file pcb_edit_frame.cpp.

References EDA_BASE_FRAME::doAutoSave().

Referenced by doAutoSave().

◆ doAutoSave()

bool PCB_EDIT_FRAME::doAutoSave ( )

inlineoverrideprotectedvirtual

Perform auto save when the board has been modified and not saved within the auto save interval.

Returns: true if the auto save was successful.

Reimplemented from EDA_BASE_FRAME.

Definition at line 771 of file pcb_edit_frame.h.

References DoAutoSave().

◆ doCloseWindow()

void PCB_EDIT_FRAME::doCloseWindow ( )

overrideprotectedvirtual

◆ DoGenFootprintsPositionFile()

int PCB_EDIT_FRAME::DoGenFootprintsPositionFile	(	const wxString &	aFullFileName,
		bool	aUnitsMM,
		bool	aOnlySMD,
		bool	aNoTHItems,
		bool	aExcludeDNP,
		bool	aExcludeBOM,
		bool	aTopSide,
		bool	aBottomSide,
		bool	aFormatCSV,
		bool	aUseAuxOrigin,
		bool	aNegateBottomX )

Create an ASCII footprint position file.

Parameters

aFullFileName	the full file name of the file to create.
aUnitsMM	false to use inches, true to use mm in coordinates.
aOnlySMD	true to force only footprints flagged smd to be in the list
aNoTHItems	true to include only footprints with no TH pads no matter the footprint flag
aExcludeDNP	true to exclude footprints flagged DNP
aExcludeBOM	true to exclude footprints flagged exclude from BOM
aTopSide	true to list footprints on front (top) side.
aBottomSide	true to list footprints on back (bottom) side, if aTopSide and aTopSide are true, list footprints on both sides.
aFormatCSV	true to use a comma separated file (CSV) format; default = false
aUseAuxOrigin	true to use auxiliary axis as an origin for the position data
aNegateBottomX	true to negate X coordinates for bottom side of the placement file

Returns: the number of footprints found on aSide side or -1 if the file could not be created.

Definition at line 490 of file dialog_gen_footprint_position.cpp.

References PLACE_FILE_EXPORTER::GenPositionData(), PCB_BASE_FRAME::GetBoard(), and PLACE_FILE_EXPORTER::GetFootprintCount().

◆ doReCreateMenuBar()

void PCB_EDIT_FRAME::doReCreateMenuBar ( )

overrideprotectedvirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 42 of file menubar_pcb_editor.cpp.

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

References m_acceptedExts, m_AcceptedFiles, and TOOLS_HOLDER::m_toolManager.

Referenced by OnDropFiles().

◆ Edit_Zone_Params()

void PCB_EDIT_FRAME::Edit_Zone_Params ( ZONE * zone_container )

Edit params (layer, clearance, ...) for a zone outline.

Definition at line 41 of file edit_zone_helpers.cpp.

References _, dummy, ZONE_SETTINGS::ExportSetting(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), ZONE::GetFirstLayer(), ZONE::GetIsRuleArea(), PCB_DRAW_PANEL_GAL::GetView(), InvokeCopperZonesEditor(), InvokeNonCopperZonesEditor(), InvokeRuleAreaEditor(), IsCopperLayer(), ZONE_SETTINGS::m_LayerProperties, ZONE_SETTINGS::m_Netcode, PCB_BASE_FRAME::m_pcb, COMMIT::Modify(), NETINFO_LIST::ORPHANED, BOARD_COMMIT::Push(), PCB_BASE_FRAME::rebuildConnectivity(), BOARD_CONNECTED_ITEM::SetNetCode(), SKIP_CONNECTIVITY, and KIGFX::PCB_VIEW::Update().

Referenced by OnEditItemRequest().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 952 of file eda_base_frame.cpp.

References GetWindowSize(), and traceDisplayLocation.

Referenced by OnSize().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )

inherited

Definition at line 396 of file eda_draw_frame.cpp.

References m_messagePanel.

◆ ExchangeFootprint()

void PCB_EDIT_FRAME::ExchangeFootprint	(	FOOTPRINT *	aExisting,
		FOOTPRINT *	aNew,
		BOARD_COMMIT &	aCommit,
		bool	deleteExtraTexts = true,
		bool	resetTextLayers = true,
		bool	resetTextEffects = true,
		bool	resetTextPositions = true,
		bool	resetTextContent = true,
		bool	resetFabricationAttrs = true,
		bool	resetClearanceOverrides = true,
		bool	reset3DModels = true,
		bool *	aUpdated = nullptr )

Replace aExisting footprint by aNew footprint using the Existing footprint settings (position, orientation, pad netnames ...).

The aExisting footprint is deleted or put in undo list.

Parameters

aExisting	footprint to replace.
aNew	footprint to put.
aCommit	commit that should store the changes.

Definition at line 2434 of file pcb_edit_frame.cpp.

References COMMIT::Add(), FOOTPRINT::Add(), EDA_GROUP::AddItem(), FOOTPRINT::AllowSolderMaskBridges(), EDA_GROUP::AsEdaItem(), EDA_ITEM::ClearFlags(), PCB_TEXT::Clone(), FOOTPRINT::Flip(), FOOTPRINT::FootprintNeedsUpdate(), FOOTPRINT::GetAttributes(), PCB_BASE_FRAME::GetBoard(), FOOTPRINT::GetComponentClass(), FOOTPRINT::GetFields(), FOOTPRINT::GetFilters(), FOOTPRINT::GetFPID(), FOOTPRINT::GetLayer(), LIB_ID::GetLibItemName(), FOOTPRINT::GetLocalClearance(), BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible(), FOOTPRINT::GetLocalSolderMaskMargin(), FOOTPRINT::GetLocalSolderPasteMargin(), FOOTPRINT::GetLocalSolderPasteMarginRatio(), FOOTPRINT::GetLocalZoneConnection(), BOARD_CONNECTED_ITEM::GetNetCode(), FOOTPRINT::GetOrientation(), EDA_ITEM::GetParentGroup(), FOOTPRINT::GetPath(), PCB_BASE_FRAME::GetPcbNewSettings(), PAD::GetPinFunction(), PAD::GetPinType(), FOOTPRINT::GetPosition(), FOOTPRINT::GetSheetfile(), FOOTPRINT::GetSheetname(), FOOTPRINT::GetValue(), FOOTPRINT::GraphicalItems(), group, FOOTPRINT::Groups(), BOARD_ITEM::INSTANCE_TO_INSTANCE, FOOTPRINT::IsLocked(), PAD::IsOnCopperLayer(), EDA_ITEM::m_Uuid, matchItemsBySimilarity(), FOOTPRINT::Models(), COMMIT::Modify(), NO_RECURSE, pad, FOOTPRINT::Pads(), PCB_BASE_FRAME::PlaceFootprint(), FOOTPRINT::Points(), processTextItem(), FOOTPRINT::Reference(), COMMIT::Remove(), EDA_GROUP::RemoveItem(), FOOTPRINT::SetAllowSolderMaskBridges(), FOOTPRINT::SetAttributes(), FOOTPRINT::SetFilters(), FOOTPRINT::SetLocalClearance(), BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible(), FOOTPRINT::SetLocalSolderMaskMargin(), FOOTPRINT::SetLocalSolderPasteMargin(), FOOTPRINT::SetLocalSolderPasteMarginRatio(), FOOTPRINT::SetLocalZoneConnection(), FOOTPRINT::SetLocked(), BOARD_CONNECTED_ITEM::SetNetCode(), FOOTPRINT::SetOrientation(), EDA_ITEM::SetParent(), FOOTPRINT::SetPath(), PAD::SetPinFunction(), PAD::SetPinType(), FOOTPRINT::SetPosition(), FOOTPRINT::SetSheetfile(), FOOTPRINT::SetSheetname(), FOOTPRINT::SetStaticComponentClass(), NETINFO_LIST::UNCONNECTED, FOOTPRINT::Value(), UTF8::wx_str(), and FOOTPRINT::Zones().

Referenced by FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ ExecuteRemoteCommand()

void PCB_EDIT_FRAME::ExecuteRemoteCommand ( const char * cmdline )

overridevirtual

Execute a remote command send by Eeschema via a socket, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242).

This is a virtual function called by EDA_DRAW_FRAME::OnSockRequest().

Parameters

cmdline is the received command from socket.

Reimplemented from KIWAY_PLAYER.

Definition at line 73 of file pcbnew/cross-probing.cpp.

References _, CROSS_PROBING_SETTINGS::auto_highlight, CROSS_PROBING_SETTINGS::center_on_items, BOX2< Vec >::Centre(), BOARD::FindNet(), EDA_DRAW_FRAME::FocusOnLocation(), BOARD::Footprints(), From_UTF8(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOX2< Vec >::GetHeight(), BOARD::GetHighLightNetCodes(), NETINFO_ITEM::GetMsgPanelInfo(), NETINFO_ITEM::GetNetCode(), KIGFX::VIEW::GetPainter(), PCB_BASE_FRAME::GetPcbNewSettings(), KIGFX::PAINTER::GetSettings(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), BOX2< Vec >::GetWidth(), BOARD::HighLightON(), KIGFX::RENDER_SETTINGS::IsHighlightEnabled(), BOARD::IsHighLightNetON(), APP_SETTINGS_BASE::m_CrossProbing, TOOLS_HOLDER::m_toolManager, BOX2< Vec >::Merge(), EDA_DRAW_PANEL_GAL::Refresh(), BOARD::ResetNetHighLight(), TOOL_MANAGER::RunAction(), PCB_ACTIONS::runDRC, KIGFX::RENDER_SETTINGS::SetHighlight(), BOARD::SetHighLightNet(), EDA_DRAW_FRAME::SetMsgPanel(), ShowBoardSetupDialog(), ACTIONS::showFootprintLibTable, text, BOARD::Tracks(), KIGFX::VIEW::UpdateAllLayersColor(), BOARD::Zones(), and CROSS_PROBING_SETTINGS::zoom_to_fit.

Referenced by KiwayMailIn().

◆ Export_IDF3()

bool PCB_EDIT_FRAME::Export_IDF3	(	BOARD *	aPcb,
		const wxString &	aFullFileName,
		bool	aUseThou,
		double	aXRef,
		double	aYRef,
		bool	aIncludeUnspecified,
		bool	aIncludeDNP )

Create an IDF3 compliant BOARD (*.emn) and LIBRARY (*.emp) file.

Generate IDFv3 compliant board (*.emn) and library (*.emp) files representing the user's PCB design.

Parameters

aPcb	a pointer to the board to be exported to IDF.
aFullFileName	the full filename of the export file.
aUseThou	set to true if the desired IDF unit is thou (mil).
aXRef	the board Reference Point in mm, X value.
aYRef	the board Reference Point in mm, Y value.
aIncludeUnspecified	true to include unspecified-type footprint models
aIncludeDNP	true to include DNP footprint models

Returns: true if OK.

Definition at line 612 of file export_idf.cpp.

References _, BOARD::Footprints(), From_UTF8(), PROJECT_PCB::Get3DCacheManager(), BOARD_DESIGN_SETTINGS::GetBoardThickness(), GetBuildVersion(), BOARD::GetDesignSettings(), BOARD::GetFileName(), S3D_CACHE::GetResolver(), idf_export_footprint(), idf_export_outline(), pcbIUScale, Prj(), resolver, scale, TO_UTF8, and IO_ERROR::What().

◆ ExportFootprintsToLibrary()

void PCB_EDIT_FRAME::ExportFootprintsToLibrary	(	bool	aStoreInNewLib,
		const wxString &	aLibName = wxEmptyString,
		wxString *	aLibPath = nullptr )

Save footprints in a library:

Parameters

aStoreInNewLib	true to save footprints in a existing library. Existing footprints will be kept or updated. This library should be in fp lib table, and is type is .pretty. False to save footprints in a new library. If it is an existing lib, previous footprints will be removed.
aLibName	optional library name to create, stops dialog call. Must be called with aStoreInNewLib as true.

Definition at line 630 of file footprint_libraries_utils.cpp.

References _, DisplayError(), DisplayInfoMessage(), FP_LIB_TABLE::FootprintSave(), PCB_BASE_FRAME::GetBoard(), EDA_ITEM::GetParentGroup(), FOOTPRINT::GetPosition(), IGNORE_PARENT_GROUP, PROJECT::PCB_LIB_NICKNAME, PROJECT_PCB::PcbFootprintLibs(), Prj(), PCB_BASE_EDIT_FRAME::SelectLibrary(), LIB_ID::SetLibNickname(), FOOTPRINT::SetReference(), PROJECT::SetRString(), IO_ERROR::What(), and FOOTPRINT::Zones().

Referenced by Process_Special_Functions().

◆ ExportSpecctraFile()

bool PCB_EDIT_FRAME::ExportSpecctraFile ( const wxString & aFullFilename )

Export the current BOARD to a specctra dsn file.

See http://www.autotraxeda.com/docs/SPECCTRA/SPECCTRA.pdf for the specification.

Returns: true if OK

Definition at line 76 of file specctra_export.cpp.

References _, DisplayErrorMessage(), DSN::ExportBoardToSpecctraFile(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetScreen(), BASE_SCREEN::IsContentModified(), BASE_SCREEN::SetContentModified(), and IO_ERROR::What().

◆ ExportVRML_File()

bool PCB_EDIT_FRAME::ExportVRML_File	(	const wxString &	aFullFileName,
		double	aMMtoWRMLunit,
		bool	aIncludeUnspecified,
		bool	aIncludeDNP,
		bool	aExport3DFiles,
		bool	aUseRelativePaths,
		const wxString &	a3D_Subdir,
		double	aXRef,
		double	aYRef )

Create the file(s) exporting current BOARD to a VRML file.

Note: When copying 3D shapes files, the new filename is build from the full path name, changing the separators by underscore. This is needed because files with the same shortname can exist in different directories; ExportVRML_File generates coordinates in board units (BIU) inside the file.

Todo: Use mm inside the file. A general scale transform is applied to the whole file (1.0 to have the actual WRML unit im mm, 0.001 to have the actual WRML unit in meters.

Note: For 3D models built by a 3D modeler, the unit is 0,1 inches. A specific scale is applied to 3D models to convert them to internal units.

Parameters

aFullFileName	the full filename of the file to create
aMMtoWRMLunit	the VRML scaling factor: 1.0 to export in mm. 0.001 for meters
aExport3DFiles	true to copy 3D shapes in the subir a3D_Subdir
aUseRelativePaths	set to true to use relative paths instead of absolute paths in the board VRML file URLs.
a3D_Subdir	sub directory where 3D shapes files are copied. This is only used when aExport3DFiles == true.
aXRef	X value of PCB (0,0) reference point.
aYRef	Y value of PCB (0,0) reference point.

Returns: true if Ok.

Definition at line 1341 of file exporter_vrml.cpp.

References EXPORTER_VRML::ExportVRML_File(), PCB_BASE_FRAME::GetBoard(), and Prj().

◆ FetchNetlistFromSchematic()

bool PCB_EDIT_FRAME::FetchNetlistFromSchematic	(	NETLIST &	aNetlist,
		const wxString &	aAnnotateMessage )

Parameters

aNetlist	a NETLIST owned by the caller. This function fills it in.
aAnnotateMessage	a message to be shown if annotation must be performed. If empty, annotation will be skipped.

Returns: true if a netlist was fetched.

Definition at line 2144 of file pcb_edit_frame.cpp.

References _, DisplayErrorMessage(), KIWAY::ExpressMail(), FRAME_SCH, Kiway, KICAD_NETLIST_READER::LoadNetlist(), MAIL_SCH_GET_NETLIST, IO_ERROR::Problem(), TestStandalone(), IO_ERROR::What(), and IO_ERROR::Where().

Referenced by KiwayMailIn().

◆ findDialogs()

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

protectedinherited

Definition at line 1064 of file eda_draw_frame.cpp.

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

◆ FindItemsFromSyncSelection()

std::vector< BOARD_ITEM * > PCB_EDIT_FRAME::FindItemsFromSyncSelection ( std::string syncStr )

Used to find items by selection synchronization spec string.

Definition at line 437 of file pcbnew/cross-probing.cpp.

References CTX_IPC, EscapeString(), PCB_BASE_FRAME::GetBoard(), pad, and UnescapeString().

Referenced by KiwayMailIn().

◆ FindNext()

void PCB_EDIT_FRAME::FindNext ( bool reverse = false )

Find the next item using our existing search parameters.

Definition at line 2088 of file pcb_edit_frame.cpp.

References m_findDialog, and ShowFindDialog().

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

privateinherited

Definition at line 273 of file eda_base_frame.cpp.

References findQuasiModalDialog(), FRAME_SCH, and m_ident.

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

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 1156 of file eda_base_frame.cpp.

References m_auimgr.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ FocusLibraryTreeInput()

virtual void EDA_DRAW_FRAME::FocusLibraryTreeInput ( )

inlinevirtualinherited

Reimplemented in FOOTPRINT_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 427 of file eda_draw_frame.h.

◆ FocusOnItem() [1/2]

void PCB_BASE_FRAME::FocusOnItem	(	BOARD_ITEM *	aItem,
		PCB_LAYER_ID	aLayer = UNDEFINED_LAYER,
		bool	aAllowScroll = true )

inherited

Definition at line 232 of file pcb_base_frame.cpp.

References FocusOnItems().

◆ FocusOnItem() [2/2]

void PCB_BASE_FRAME::FocusOnItem	(	EDA_ITEM *	aItem,
		bool	aAllowScroll = true )

overridevirtualinherited

Focus on a particular canvas item.

Parameters

aItem is the item to focus on. nullptr clears the focus.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 223 of file pcb_base_frame.cpp.

References FocusOnItem(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), and UNDEFINED_LAYER.

Referenced by FocusOnItem().

◆ FocusOnItems()

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

inherited

Definition at line 243 of file pcb_base_frame.cpp.

References 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(), SHAPE_POLY_SET::ClearArcs(), SHAPE_POLY_SET::Deflate(), ERROR_INSIDE, EDA_DRAW_FRAME::findDialogs(), EDA_DRAW_FRAME::FocusOnLocation(), GetBoard(), GetCanvas(), BOX2< Vec >::GetHeight(), DELETED_BOARD_ITEM::GetInstance(), BOX2< Vec >::GetOrigin(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), SHAPE_POLY_SET::IsEmpty(), EDA_ITEM::m_Uuid, SHAPE_POLY_SET::NewOutline(), ZONE::Outline(), PCB_ARC_T, PCB_BARCODE_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FIELD_T, PCB_FOOTPRINT_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, RECURSE, EDA_DRAW_PANEL_GAL::Refresh(), ResolveItem(), EDA_ITEM::SetBrightened(), ToVECTOR2D(), KIGFX::VIEW::ToWorld(), ZONE::TransformShapeToPolygon(), UNDEFINED_LAYER, and KIGFX::PCB_VIEW::Update().

Referenced by FocusOnItem().

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation	(	const VECTOR2I &	aPos,
		bool	aAllowScroll = true )

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

References BOX2< Vec >::Contains(), findDialogs(), 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_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), SCH_EDIT_FRAME::onNetNavigatorSelection(), and SCH_SELECTION_TOOL::SyncSelection().

◆ FocusSearch()

void PCB_EDIT_FRAME::FocusSearch ( )

Definition at line 1583 of file pcb_edit_frame.cpp.

References EDA_DRAW_FRAME::m_searchPane.

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

References QUALIFIED_VIEWER3D_FRAMENAME.

Referenced by canCloseWindow(), CommonSettingsChanged(), CreateAndShow3D_Frame(), FOOTPRINT_CHOOSER_FRAME::on3DviewReq(), PCB_BASE_EDIT_FRAME::onDarkModeToggle(), FOOTPRINT_CHOOSER_FRAME::onExternalViewer3DEnable(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_CHOOSER_FRAME::Show3DViewerFrame(), ShowChangedLanguage(), Update3DView(), FOOTPRINT_CHOOSER_FRAME::updateViews(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ GetAboutTitle()

const wxString & EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 540 of file eda_base_frame.h.

References m_aboutTitle.

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

◆ GetActionPluginButtonVisible()

bool PCB_EDIT_FRAME::GetActionPluginButtonVisible	(	const wxString &	aPluginPath,
		bool	aPluginDefault )

static

Return true if button visibility action plugin setting was set to true or it is unset and plugin defaults to true.

Definition at line 586 of file pcbnew_action_plugins.cpp.

References GetAppSettings(), and path.

Referenced by addActionPluginTools(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow().

◆ GetActiveLayer()

virtual PCB_LAYER_ID PCB_BASE_FRAME::GetActiveLayer ( ) const

inlinevirtualinherited

Definition at line 351 of file pcb_base_frame.h.

References GetScreen(), and PCB_SCREEN::m_Active_Layer.

Referenced by PCB_BASE_EDIT_FRAME::configureToolbars(), EDIT_TOOL::doMoveSelection(), GetCollectorsGuide(), PCB_EDIT_FRAME::OnBoardLoaded(), PCB_DRAW_PANEL_GAL::OnShow(), ROUTER_TOOL::prepareInteractive(), PCB_EDIT_FRAME::saveProjectSettings(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), SetDisplayOptions(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), and PCB_EDIT_FRAME::UpdateUserInterface().

◆ GetAppearancePanel()

APPEARANCE_CONTROLS * PCB_BASE_EDIT_FRAME::GetAppearancePanel ( )

inlineinherited

Definition at line 243 of file pcb_base_edit_frame.h.

References m_appearancePanel.

Referenced by PCB_CONTROL::AppendBoard(), PCB_EDIT_FRAME::CommonSettingsChanged(), API_HANDLER_PCB::handleSetVisibleLayers(), ROUTER_TOOL::performRouting(), and ROUTER_TOOL::prepareInteractive().

◆ GetAuiManager()

wxAuiManager & PCB_BASE_EDIT_FRAME::GetAuiManager ( )

inlineinherited

Definition at line 204 of file pcb_base_edit_frame.h.

References EDA_BASE_FRAME::m_auimgr.

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inherited

Definition at line 406 of file eda_base_frame.cpp.

References PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::SYSTEM::local_history_debounce, COMMON_SETTINGS::m_System, and Pgm().

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

◆ GetAuxOrigin()

const VECTOR2I & PCB_BASE_FRAME::GetAuxOrigin ( ) const

inherited

Definition at line 485 of file pcb_base_frame.cpp.

References m_pcb.

Referenced by GetUserOrigin().

◆ GetBoard()

BOARD * PCB_BASE_FRAME::GetBoard ( ) const

inlineinherited

Definition at line 211 of file pcb_base_frame.h.

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

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

Referenced by FOOTPRINT_EDIT_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 971 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 699 of file pcb_base_frame.cpp.

◆ GetColorSettings()

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

overridevirtualinherited

Helper to retrieve the current color settings.

Reimplemented from PCB_BASE_FRAME.

Definition at line 280 of file pcb_base_edit_frame.cpp.

References DEFAULT_THEME, PCB_BASE_FRAME::GetPcbNewSettings(), and APP_SETTINGS_BASE::m_ColorTheme.

Referenced by PCB_EDIT_FRAME::GetGridColor(), PCB_EDIT_FRAME::PrepareLayerIndicator(), and PCB_EDIT_FRAME::SetGridColor().

◆ GetContextualTextVars()

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

inherited

Definition at line 344 of file pcb_base_edit_frame.cpp.

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

◆ GetCurrentFileName()

wxString PCB_EDIT_FRAME::GetCurrentFileName ( ) const

overridevirtual

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

Definition at line 3042 of file pcb_edit_frame.cpp.

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

Referenced by LoadProjectSettings().

◆ GetCurrentSelection()

SELECTION & PCB_EDIT_FRAME::GetCurrentSelection ( )

overridevirtual

Get the current selection from the canvas area.

Returns: the current selection.

Reimplemented from TOOLS_HOLDER.

Definition at line 829 of file pcb_edit_frame.cpp.

References TOOLS_HOLDER::m_toolManager.

Referenced by RebuildAndRefresh().

◆ GetCustomToolbarControlFactory()

ACTION_TOOLBAR_CONTROL_FACTORY * EDA_BASE_FRAME::GetCustomToolbarControlFactory ( const std::string & aName )

inherited

Definition at line 572 of file eda_base_frame.cpp.

References m_toolbarControlFactories.

Referenced by ACTION_TOOLBAR::ApplyConfiguration().

◆ GetDesignBlockPane()

PCB_DESIGN_BLOCK_PANE * PCB_EDIT_FRAME::GetDesignBlockPane ( ) const

inline

Definition at line 423 of file pcb_edit_frame.h.

References m_designBlocksPane.

Referenced by PCB_CONTROL::AppendDesignBlock(), PCB_CONTROL::PlaceLinkedDesignBlock(), and PCB_CONTROL::SaveToLinkedDesignBlock().

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

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

Referenced by PCB_EDIT_FRAME::CommonSettingsChanged(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::OnBoardLoaded(), PCB_EDIT_FRAME::OnNetlistChanged(), PCB_EDIT_FRAME::SavePcbCopy(), and PCB_EDIT_FRAME::SavePcbFile().

◆ GetDesignSettings()

BOARD_DESIGN_SETTINGS & PCB_BASE_FRAME::GetDesignSettings ( ) const

virtualinherited

Return the BOARD_DESIGN_SETTINGS for the open project.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 524 of file pcb_base_frame.cpp.

References m_pcb.

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

References m_displayOptions.

Referenced by ActivateGalCanvas(), CommonSettingsChanged(), PCB_BASE_EDIT_FRAME::configureToolbars(), API_HANDLER_PCB::handleGetBoardEditorAppearanceSettings(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_DRAW_PANEL_GAL::OnShow(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), PCB_EDIT_FRAME::saveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), PCB_SELECTION_TOOL::Selectable(), PCB_EDIT_FRAME::SetActiveLayer(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), and PCB_EDITOR_CONDITIONS::zoneDisplayModeFunc().

◆ GetDocumentExtents()

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

overridevirtualinherited

Return bounding box of document with option to not include some items.

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

Parameters

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

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 597 of file pcb_base_frame.cpp.

References Edge_Cuts, GetBoardBoundingBox(), and m_pcb.

Referenced by NL_PCBNEW_PLUGIN_IMPL::GetModelExtents().

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

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

References m_dragAction.

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const

inlinevirtualinherited

Reimplemented in SCH_BASE_FRAME.

Definition at line 181 of file eda_draw_frame.h.

References m_drawBgColor.

Referenced by PROPERTIES_FRAME::PROPERTIES_FRAME(), and PL_EDITOR_FRAME::SaveSettings().

◆ GetExportNetlistAction()

TOOL_ACTION * PCB_EDIT_FRAME::GetExportNetlistAction ( )

inline

Definition at line 675 of file pcb_edit_frame.h.

References m_exportNetlistAction.

◆ GetFileFromHistory()

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

inherited

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

References _, DisplayErrorMessage(), m_fileHistory, and ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), BITMAP2CMP_FRAME::OnFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), PL_EDITOR_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 432 of file eda_base_frame.h.

References m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString & EDA_DRAW_FRAME::GetFindHistoryList ( )

inlineinherited

Definition at line 119 of file eda_draw_frame.h.

References m_findStringHistoryList.

◆ GetFindReplaceData()

EDA_SEARCH_DATA & EDA_DRAW_FRAME::GetFindReplaceData ( )

inlineinherited

Definition at line 118 of file eda_draw_frame.h.

References m_findReplaceData.

◆ GetFootprintDiffDialog()

DIALOG_BOOK_REPORTER * PCB_EDIT_FRAME::GetFootprintDiffDialog ( )

Definition at line 3117 of file pcb_edit_frame.cpp.

References _, FOOTPRINT_DIFF_DIALOG_NAME, and m_footprintDiffDlg.

◆ GetFootprintEditorSettings()

FOOTPRINT_EDITOR_SETTINGS * PCB_BASE_FRAME::GetFootprintEditorSettings ( ) const

inherited

Definition at line 851 of file pcb_base_frame.cpp.

References SETTINGS_MANAGER::GetAppSettings(), PGM_BASE::GetSettingsManager(), and Pgm().

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

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 218 of file eda_base_frame.h.

References m_ident.

Referenced by KIWAY_PLAYER::Destroy(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), EDA_3D_CONTROLLER::ExportImage(), PCB_BASE_FRAME::GetViewerSettingsBase(), SCH_BASE_FRAME::GetViewerSettingsBase(), EDA_3D_CONTROLLER::ReloadBoard(), ShowPreferences(), COMMON_CONTROL::ShowProjectManager(), EDA_3D_CONTROLLER::ToggleLayersManager(), EDA_3D_CONTROLLER::ToggleRaytracing(), and EDA_3D_CONTROLLER::ToggleVisibility().

◆ GetFullScreenDesc()

wxString EDA_DRAW_FRAME::GetFullScreenDesc ( ) const

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1190 of file eda_draw_frame.cpp.

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

◆ GetGalDisplayOptions()

GAL_DISPLAY_OPTIONS_IMPL & EDA_DRAW_FRAME::GetGalDisplayOptions ( )

inlineinherited

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

Definition at line 474 of file eda_draw_frame.h.

References m_galDisplayOptions.

Referenced by FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::createCanvas(), EDITOR_CONDITIONS::cursorFunc(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), SYMBOL_VIEWER_FRAME::LoadSettings(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), FOOTPRINT_EDIT_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ GetGridColor()

COLOR4D PCB_EDIT_FRAME::GetGridColor ( )

overridevirtual

Returns: the color of the grid

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1671 of file pcb_edit_frame.cpp.

References COLOR_SETTINGS::GetColor(), PCB_BASE_EDIT_FRAME::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 473 of file pcb_base_frame.cpp.

References m_pcb.

Referenced by GetUserOrigin().

◆ GetHotkeyPopup()

HOTKEY_CYCLE_POPUP * EDA_DRAW_FRAME::GetHotkeyPopup ( )

inlineinherited

Definition at line 500 of file eda_draw_frame.h.

References m_hotkeyPopup.

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

References m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), PCB_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDIT_FRAME::ReloadFootprint(), SYMBOL_EDIT_FRAME::SetCurSymbol(), ShowInfoBarError(), ShowInfoBarError(), ShowInfoBarMsg(), and ShowInfoBarWarning().

◆ GetInspectClearanceDialog()

DIALOG_BOOK_REPORTER * PCB_EDIT_FRAME::GetInspectClearanceDialog ( )

Definition at line 3093 of file pcb_edit_frame.cpp.

References _, INSPECT_CLEARANCE_DIALOG_NAME, and m_inspectClearanceDlg.

◆ GetInspectConstraintsDialog()

DIALOG_BOOK_REPORTER * PCB_EDIT_FRAME::GetInspectConstraintsDialog ( )

Definition at line 3105 of file pcb_edit_frame.cpp.

References _, INSPECT_CONSTRAINTS_DIALOG_NAME, and m_inspectConstraintsDlg.

◆ GetInspectDrcErrorDialog()

DIALOG_BOOK_REPORTER * PCB_EDIT_FRAME::GetInspectDrcErrorDialog ( )

Definition at line 3081 of file pcb_edit_frame.cpp.

References _, INSPECT_DRC_ERROR_DIALOG_NAME, and m_inspectDrcErrorDlg.

◆ GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 55 of file units_provider.h.

References m_iuScale.

Referenced by AngleValueFromString(), GRID_MENU::BuildChoiceList(), RC_ITEM::GetJsonViolation(), DRC_ENGINE::loadImplicitRules(), MessageTextFromMinOptMax(), MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), OptionalValueFromString(), StringFromOptionalValue(), StringFromValue(), GRID::UserUnitsMessageText(), and ValueFromString().

◆ GetLastPath()

wxString PCB_EDIT_FRAME::GetLastPath ( LAST_PATH_TYPE aType )

Get the last path for a particular type.

Returns: the absolute path and file name of the last file successfully read.

Definition at line 1901 of file pcb_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), PROJECT::GetProjectFile(), Prj(), and project.

Referenced by InstallNetlistFrame().

◆ GetLayerPairSettings()

LAYER_PAIR_SETTINGS * PCB_BASE_EDIT_FRAME::GetLayerPairSettings ( )

inlineinherited

Acess to the layer pair settings controller of the board, if available.

Definition at line 248 of file pcb_base_edit_frame.h.

References m_layerPairSettings.

◆ GetLibraryItemsForListDialog()

void PCB_BASE_FRAME::GetLibraryItemsForListDialog	(	wxArrayString &	aHeaders,
		std::vector< wxArrayString > &	aItemsToDisplay )

inherited

◆ GetLibTree()

virtual LIB_TREE * EDA_DRAW_FRAME::GetLibTree ( ) const

inlinevirtualinherited

Reimplemented in FOOTPRINT_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 422 of file eda_draw_frame.h.

◆ GetMagneticItemsSettings()

MAGNETIC_SETTINGS * PCB_BASE_FRAME::GetMagneticItemsSettings ( )

virtualinherited

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 880 of file pcb_base_frame.cpp.

References GetPcbNewSettings().

Referenced by EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::MakeGridHelper(), PCB_POINT_EDITOR::OnSelectionChange(), and PAD_TOOL::PlacePad().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 613 of file eda_base_frame.h.

References m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetModel()

BOARD_ITEM_CONTAINER * PCB_EDIT_FRAME::GetModel ( ) const

overridevirtual

Returns: the primary data model.

Implements PCB_BASE_FRAME.

Definition at line 739 of file pcb_edit_frame.cpp.

References PCB_BASE_FRAME::m_pcb.

Referenced by PANEL_COMPONENT_CLASS_ASSIGNMENT::OnHighlightItemsClick(), and PANEL_ASSIGN_COMPONENT_CLASSES::Validate().

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

References m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 439 of file eda_base_frame.h.

References m_mruPath.

Referenced by AskLoadBoardFileName(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), EDA_DRAW_FRAME::LibraryFileBrowser(), PCB_EDIT_FRAME::SaveBoard(), and SCH_EDIT_FRAME::SaveProject().

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

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

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

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

◆ GetOrderedActionPlugins()

std::vector< LEGACY_OR_API_PLUGIN > PCB_EDIT_FRAME::GetOrderedActionPlugins ( )

static

Return ordered list of plugins in sequence in which they should appear on toolbar or in settings.

Handles both legacy (SWIG) and API plugins, so returns a heterogenous list.

Definition at line 546 of file pcbnew_action_plugins.cpp.

References ACTION_PLUGINS::GetAction(), ACTION_PLUGINS::GetActionsCount(), GetAppSettings(), EDA_DRAW_FRAME::GetOrderedPluginActions(), PCBNEW_SETTINGS::m_VisibleActionPlugins, path, and PCB.

Referenced by addActionPluginTools(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow().

◆ GetOrderedPluginActions()

std::vector< const PLUGIN_ACTION * > EDA_DRAW_FRAME::GetOrderedPluginActions	(	PLUGIN_ACTION_SCOPE	aScope,
		APP_SETTINGS_BASE *	aCfg )

staticinherited

Return ordered list of plugin actions for display in the toolbar.

Must be static at the moment because this needs to be called from the preferences dialog, which can exist without the frame in question actually being created.

Parameters

aCfg	is the settings to read the plugin ordering from.

Definition at line 1419 of file eda_draw_frame.cpp.

References APP_SETTINGS_BASE::PLUGINS::actions, API_PLUGIN_MANAGER::GetActionsForScope(), APP_SETTINGS_BASE::m_Plugins, and Pgm().

Referenced by AddApiPluginTools(), and PCB_EDIT_FRAME::GetOrderedActionPlugins().

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

References m_originTransforms.

◆ GetOverrideLocks()

bool EDA_DRAW_FRAME::GetOverrideLocks ( ) const

inherited

Definition at line 522 of file eda_draw_frame.cpp.

References m_overrideLocksCb.

◆ GetPageSettings()

const PAGE_INFO & PCB_BASE_FRAME::GetPageSettings ( ) const

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 458 of file pcb_base_frame.cpp.

References m_pcb.

Referenced by FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME().

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

References m_pcb, and pcbIUScale.

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

◆ GetPcbNewSettings()

PCBNEW_SETTINGS * PCB_BASE_FRAME::GetPcbNewSettings ( ) const

inherited

Definition at line 845 of file pcb_base_frame.cpp.

References SETTINGS_MANAGER::GetAppSettings(), PGM_BASE::GetSettingsManager(), and Pgm().

◆ GetPlotSettings()

const PCB_PLOT_PARAMS & PCB_BASE_FRAME::GetPlotSettings ( ) const

virtualinherited

Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 537 of file pcb_base_frame.cpp.

References m_pcb.

Referenced by FOOTPRINT_EDIT_FRAME::GetPlotSettings().

◆ GetPropertiesPanel()

PROPERTIES_PANEL * EDA_DRAW_FRAME::GetPropertiesPanel ( )

inlineinherited

Definition at line 429 of file eda_draw_frame.h.

References m_propertiesPanel.

◆ GetRedoActionDescription()

wxString EDA_BASE_FRAME::GetRedoActionDescription ( ) const

virtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 1727 of file eda_base_frame.cpp.

References GetRedoCommandCount(), and m_redoList.

Referenced by HandleUpdateUIEvent().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 608 of file eda_base_frame.h.

References m_redoList.

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

◆ GetRotationAngle()

EDA_ANGLE PCB_EDIT_FRAME::GetRotationAngle ( ) const

overridevirtual

Return the angle used for rotate operations.

Reimplemented from PCB_BASE_EDIT_FRAME.

Definition at line 1663 of file pcb_edit_frame.cpp.

References ANGLE_90, config, and PCBNEW_SETTINGS::m_RotationAngle.

◆ GetRunMenuCommandDescription()

wxString EDA_BASE_FRAME::GetRunMenuCommandDescription ( const TOOL_ACTION & aAction )

inherited

Definition at line 731 of file eda_base_frame.cpp.

References _, TOOL_ACTION::GetFriendlyName(), and TOOL_ACTION::GetMenuLabel().

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

References EDA_DRAW_FRAME::GetScreen().

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_EDIT_FRAME::ClearModify(), PCB_EDIT_FRAME::ExportSpecctraFile(), GetActiveLayer(), DIALOG_POSITION_RELATIVE::getAnchorPos(), API_HANDLER_PCB::handleRevertDocument(), FOOTPRINT_EDIT_FRAME::IsContentModified(), PCB_EDIT_FRAME::IsContentModified(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), OnFpChangeDebounceTimer(), OnModify(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::PrepareLayerIndicator(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PCB_EDIT_FRAME::SavePcbFile(), SetActiveLayer(), SetPageSettings(), PCB_EDIT_FRAME::SetPageSettings(), UpdateStatusBar(), and DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1183 of file eda_draw_frame.cpp.

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

◆ GetSettingsManager()

SETTINGS_MANAGER * EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

Definition at line 143 of file eda_base_frame.h.

References m_settingsManager.

Referenced by SYMBOL_EDIT_FRAME::AddLibraryFile(), KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CreateNewProject(), PCB_BASE_EDIT_FRAME::doCloseWindow(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::saveProjectSettings(), KICAD_MANAGER_FRAME::SaveSettings(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetSeverity()

SEVERITY PCB_BASE_FRAME::GetSeverity ( int aErrorCode ) const

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 822 of file pcb_base_frame.cpp.

References CLEANUP_FIRST, 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 133 of file eda_draw_frame.h.

References m_polarCoords.

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

◆ GetTargetLibId()

virtual LIB_ID EDA_DRAW_FRAME::GetTargetLibId ( ) const

inlinevirtualinherited

Reimplemented in SYMBOL_EDIT_FRAME.

Definition at line 423 of file eda_draw_frame.h.

◆ GetTitleBlock()

const TITLE_BLOCK & PCB_BASE_FRAME::GetTitleBlock ( ) const

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 512 of file pcb_base_frame.cpp.

References m_pcb.

◆ GetToolCanvas()

wxWindow * EDA_DRAW_FRAME::GetToolCanvas ( ) const

inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 469 of file eda_draw_frame.h.

References GetCanvas().

◆ GetToolDispatcher()

TOOL_DISPATCHER * TOOLS_HOLDER::GetToolDispatcher ( ) const

inlineinherited

Definition at line 57 of file tools_holder.h.

References m_toolDispatcher.

◆ GetToolManager()

TOOL_MANAGER * TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

References m_toolManager.

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 48 of file kiway_holder.h.

References m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), EDA_3D_CONTROLLER::Main(), and PANEL_PREVIEW_3D_MODEL::onModify().

◆ GetTypeFromUnits()

static EDA_DATA_TYPE UNITS_PROVIDER::GetTypeFromUnits ( const EDA_UNITS aUnits )

inlinestaticinherited

Gets the inferred type from the given units.

Note: will always return the most simple type (e.g. a DISTANCE rather than AREA or VOLUME for a measurement unit).

Definition at line 221 of file units_provider.h.

References CM, DEGREES, DISTANCE, FS, INCH, LENGTH_DELAY, MILS, MM, PERCENT, PS, PS_PER_CM, PS_PER_INCH, PS_PER_MM, TIME, UM, UNITLESS, and UNSCALED.

Referenced by DRC_RULES_PARSER::parseConstraint(), and WX_GRID::SetAutoEvalColUnits().

◆ GetUndoActionDescription()

wxString EDA_BASE_FRAME::GetUndoActionDescription ( ) const

virtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 1718 of file eda_base_frame.cpp.

References GetUndoCommandCount(), and m_undoList.

Referenced by HandleUpdateUIEvent().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 607 of file eda_base_frame.h.

References m_undoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), GetUndoActionDescription(), PushCommandToUndoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), PCB_EDIT_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), and EDITOR_CONDITIONS::undoFunc().

◆ GetUnitPair()

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

overridevirtualinherited

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.

Reimplemented from UNITS_PROVIDER.

Definition at line 1317 of file eda_draw_frame.cpp.

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

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

◆ GetUnitsFromType()

EDA_UNITS UNITS_PROVIDER::GetUnitsFromType ( EDA_DATA_TYPE aType ) const

inlineinherited

Gets the units to use in the conversion based on the underlying user units.

Definition at line 199 of file units_provider.h.

References GetUserUnits(), EDA_UNIT_UTILS::IsMetricUnit(), LENGTH_DELAY, PS, PS_PER_CM, PS_PER_INCH, and TIME.

Referenced by PANEL_SETUP_TUNING_PROFILE_INFO::initPanel(), MessageTextFromMinOptMax(), MessageTextFromValue(), OptionalValueFromString(), StringFromOptionalValue(), StringFromValue(), and ValueFromString().

◆ GetUntranslatedAboutTitle()

const wxString & EDA_BASE_FRAME::GetUntranslatedAboutTitle ( ) const

inlineinherited

Definition at line 542 of file eda_base_frame.h.

References m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetUserOrigin()

const VECTOR2I PCB_BASE_FRAME::GetUserOrigin ( ) const

inherited

Definition at line 491 of file pcb_base_frame.cpp.

References GetAuxOrigin(), GetGridOrigin(), GetPcbNewSettings(), PCB_ORIGIN_AUX, PCB_ORIGIN_GRID, and PCB_ORIGIN_PAGE.

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 45 of file units_provider.h.

References m_userUnits.

Referenced by PCB::IFACE::CreateKiWindow(), DIALOG_SHIM::DIALOG_SHIM(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), WX_GRID::getColumnUnits(), RC_ITEM::GetJsonViolation(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUnitPair(), GetUnitsFromType(), IfaceOrAddress(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), PANEL_PREVIEW_3D_MODEL::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), POSITION_RELATIVE_TOOL::PositionRelative(), SaveFileAs(), EDA_DRAW_FRAME::SaveSettings(), PCB_BASE_FRAME::SetBoard(), WX_GRID::SetUnitsProvider(), EDA_DRAW_FRAME::ToggleUserUnits(), PCB_BASE_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), PL_EDITOR_FRAME::UpdateStatusBar(), and GRID::UserUnitsMessageText().

◆ GetViewerSettingsBase()

PCB_VIEWERS_SETTINGS_BASE * PCB_BASE_FRAME::GetViewerSettingsBase ( ) const

virtualinherited

Reimplemented in DISPLAY_FOOTPRINTS_FRAME.

Definition at line 857 of file pcb_base_frame.cpp.

References FRAME_CVPCB, FRAME_CVPCB_DISPLAY, FRAME_FOOTPRINT_CHOOSER, FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_PREVIEW, FRAME_FOOTPRINT_VIEWER, FRAME_FOOTPRINT_WIZARD, FRAME_PCB_DISPLAY3D, FRAME_PCB_EDITOR, SETTINGS_MANAGER::GetAppSettings(), EDA_BASE_FRAME::GetFrameType(), PGM_BASE::GetSettingsManager(), and Pgm().

Referenced by FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), PCB_VIEWER_TOOLS::GraphicOutlines(), PCB_EDITOR_CONDITIONS::graphicsFillDisplayFunc(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_VIEWER_TOOLS::NextLineMode(), PCB_VIEWER_TOOLS::PadDisplayMode(), PCB_EDITOR_CONDITIONS::padFillDisplayFunc(), PCB_EDITOR_CONDITIONS::padNumberDisplayFunc(), PCB_VIEWER_TOOLS::ShowPadNumbers(), PCB_EDITOR_CONDITIONS::textFillDisplayFunc(), and PCB_VIEWER_TOOLS::TextOutlines().

◆ 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, FOOTPRINT_CHOOSER_FRAME, FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, SIMULATOR_FRAME, SYMBOL_CHOOSER_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 1113 of file eda_base_frame.cpp.

References APP_SETTINGS_BASE::m_Window.

Referenced by LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), 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 1778 of file eda_base_frame.cpp.

References KICAD_MAIN_FRAME_T, and m_ident.

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

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const

inherited

Return a human readable value for display in dialogs.

Definition at line 797 of file eda_draw_frame.cpp.

References m_canvas, and zoom.

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

◆ handleActivateEvent()

void PCB_BASE_EDIT_FRAME::handleActivateEvent ( wxActivateEvent & aEvent )

overrideprotectedvirtualinherited

Handle a window activation event.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 298 of file pcb_base_edit_frame.cpp.

References PCB_BASE_FRAME::handleActivateEvent(), and m_appearancePanel.

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

References EDA_BASE_FRAME::handleIconizeEvent(), and m_spaceMouse.

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

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

Definition at line 1802 of file eda_base_frame.cpp.

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

Referenced by 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 480 of file eda_base_frame.cpp.

References _, ACTION_CONDITIONS::checkCondition, ACTIONS::copy, ACTIONS::cut, EDA_BASE_FRAME(), ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), GetRedoActionDescription(), GetUndoActionDescription(), ACTIONS::paste, ACTIONS::redo, ACTION_CONDITIONS::showCondition, and ACTIONS::undo.

Referenced by RegisterUIUpdateHandler().

◆ HardRedraw()

void PCB_EDIT_FRAME::HardRedraw ( )

overridevirtual

Rebuild the GAL and redraws the screen.

Call when something went wrong.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1950 of file pcb_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetConnectivity(), BOARD::GetMsgPanelInfo(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), EDA_DRAW_FRAME::SetMsgPanel(), and PCB_BASE_FRAME::Update3DView().

◆ 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 65 of file kiway_holder.h.

References m_kiway.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 1132 of file eda_base_frame.cpp.

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

◆ HideSolderMask()

void PCB_BASE_FRAME::HideSolderMask ( )

inherited

Definition at line 426 of file pcb_base_frame.cpp.

References GetBoard(), 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().

◆ HighlightSelectionFilter()

void PCB_BASE_EDIT_FRAME::HighlightSelectionFilter ( const PCB_SELECTION_FILTER_OPTIONS & aOptions )

inherited

Definition at line 418 of file pcb_base_edit_frame.cpp.

◆ importFile()

bool PCB_EDIT_FRAME::importFile	(	const wxString &	aFileName,
		int	aFileType,
		const std::map< std::string, UTF8 > *	aProperties = nullptr )

protected

Load the given filename but sets the path to the current project path.

Parameters

full	file path of file to be imported.
aFileType	PCB_FILE_T value for file type

Definition at line 1139 of file pcbnew/files.cpp.

References PCB_IO_MGR::ALTIUM_CIRCUIT_MAKER, PCB_IO_MGR::ALTIUM_CIRCUIT_STUDIO, PCB_IO_MGR::ALTIUM_DESIGNER, PCB_IO_MGR::CADSTAR_PCB_ARCHIVE, PCB_IO_MGR::EAGLE, PCB_IO_MGR::EASYEDA, PCB_IO_MGR::EASYEDAPRO, KICTL_IMPORT_LIB, KICTL_NONKICAD_ONLY, m_importProperties, OpenProjectFiles(), and PCB_IO_MGR::SOLIDWORKS_PCB.

Referenced by KiwayMailIn().

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

◆ ImportSpecctraSession()

bool PCB_EDIT_FRAME::ImportSpecctraSession ( const wxString & aFullFilename )

Import a specctra *.ses file and use it to relocate MODULEs and to replace all vias and tracks in an existing and loaded BOARD.

See http://www.autotraxeda.com/docs/SPECCTRA/SPECCTRA.pdf for the specification.

Definition at line 55 of file specctra_import.cpp.

References _, KIGFX::PCB_VIEW::Add(), EDA_BASE_FRAME::ClearUndoRedoList(), DisplayErrorMessage(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), DSN::ImportSpecctraSession(), OnModify(), Refresh(), KIGFX::PCB_VIEW::Remove(), and IO_ERROR::What().

◆ inferLegacyEdgeClearance()

int PCB_EDIT_FRAME::inferLegacyEdgeClearance	(	BOARD *	aBoard,
		bool	aShowUserMsg = true )

protected

Definition at line 419 of file pcbnew/files.cpp.

References _, GENERAL_COLLECTOR::AllBoardItems, PCB_LAYER_COLLECTOR::Collect(), DisplayInfoMessage(), Edge_Cuts, COLLECTOR::GetCount(), PCB_SHAPE_T, and PCB_LAYER_COLLECTOR::SetLayerId().

Referenced by OpenProjectFiles().

◆ initExitKey()

void EDA_BASE_FRAME::initExitKey ( )

protectedinherited

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

Referenced by commonInit().

◆ InstallNetlistFrame()

void PCB_EDIT_FRAME::InstallNetlistFrame ( )

Definition at line 45 of file dialog_import_netlist.cpp.

References GetLastPath(), LAST_PATH_NETLIST, SetLastPath(), and DIALOG_SHIM::ShowModal().

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

References m_autoSaveRequired.

Referenced by ProcessEvent().

◆ IsClosing()

bool EDA_BASE_FRAME::IsClosing ( ) const

inlineinherited

Definition at line 621 of file eda_base_frame.h.

References m_isClosing.

◆ IsContentModified()

bool PCB_EDIT_FRAME::IsContentModified ( ) const

overridevirtual

Get if the current board has been modified but not saved.

Returns: true if the any changes have not been saved

Reimplemented from EDA_BASE_FRAME.

Definition at line 823 of file pcb_edit_frame.cpp.

References PCB_BASE_FRAME::GetScreen(), and BASE_SCREEN::IsContentModified().

Referenced by canCloseWindow(), OpenProjectFiles(), and UpdateTitle().

◆ IsCurrentTool()

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

inherited

Definition at line 129 of file tools_holder.cpp.

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

Referenced by 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 158 of file kiway_player.cpp.

References m_modal_loop.

Referenced by FOOTPRINT_CHOOSER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), and SYMBOL_CHOOSER_FRAME::doCloseWindow().

◆ IsElementVisible()

bool PCB_EDIT_FRAME::IsElementVisible ( GAL_LAYER_ID aElement ) const

Test whether a given element category is visible.

Keep this as an inline function.

Parameters

aElement is from the enum by the same name

Returns: bool - true if the element is visible.

See also: enum GAL_LAYER_ID

Definition at line 1868 of file pcb_edit_frame.cpp.

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

◆ IsGridOverridden()

bool EDA_DRAW_FRAME::IsGridOverridden ( ) const

inherited

Definition at line 561 of file eda_draw_frame.cpp.

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

Referenced by EDITOR_CONDITIONS::gridOverridesFunc().

◆ IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( ) const

inherited

Definition at line 531 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 EDITOR_CONDITIONS::gridFunc(), and GERBVIEW_FRAME::IsElementVisible().

◆ IsLibraryTreeShown()

virtual bool EDA_DRAW_FRAME::IsLibraryTreeShown ( ) const

inlinevirtualinherited

Reimplemented in FOOTPRINT_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 425 of file eda_draw_frame.h.

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

References m_modal.

Referenced by FOOTPRINT_WIZARD_FRAME::doCloseWindow(), and ShowModal().

◆ IsPluginActionButtonVisible()

bool EDA_DRAW_FRAME::IsPluginActionButtonVisible	(	const PLUGIN_ACTION &	aAction,
		APP_SETTINGS_BASE *	aCfg )

staticinherited

Definition at line 1404 of file eda_draw_frame.cpp.

References APP_SETTINGS_BASE::PLUGINS::actions, PLUGIN_ACTION::identifier, APP_SETTINGS_BASE::m_Plugins, and PLUGIN_ACTION::show_button.

Referenced by AddApiPluginTools().

◆ IsScriptingConsoleVisible()

bool EDA_DRAW_FRAME::IsScriptingConsoleVisible ( )

inherited

Get the current visibility of the scripting console window.

Definition at line 301 of file eda_draw_frame.cpp.

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

Referenced by EDITOR_CONDITIONS::consoleVisibleFunc().

◆ IsSearchPaneShown()

bool PCB_EDIT_FRAME::IsSearchPaneShown ( )

inline

Definition at line 314 of file pcb_edit_frame.h.

References EDA_BASE_FRAME::m_auimgr, and SearchPaneName().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inlineinherited

Definition at line 217 of file eda_base_frame.h.

References m_ident.

Referenced by BOARD_COMMIT::BOARD_COMMIT(), PCB_POINT_EDITOR::changeArcEditMode(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), COMMON_TOOLS::doZoomFit(), SCH_BASE_FRAME::GetColorSettings(), FOOTPRINT::GetMsgPanelInfo(), PCB_BASE_FRAME::loadFootprint(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), EE_GRID_HELPER::queryVisible(), SCH_COMMIT::SCH_COMMIT(), and SCH_COMMIT::SCH_COMMIT().

◆ IsWritable()

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

inherited

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

References _, and DisplayErrorMessage().

Referenced by PCB_EDIT_FRAME::saveBoardAsFile(), 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 55 of file kiway_holder.h.

References m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), IMPORT_PROJ_HELPER::addLocalLibraries(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesList(), KICAD_MANAGER_FRAME::CloseProject(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), KIWAY_PLAYER::Destroy(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), KICAD_MANAGER_FRAME::LoadProject(), PGM_SINGLE_TOP::MacOpenFile(), PCB_CALCULATOR_FRAME::OnExit(), SIMULATOR_FRAME::onExit(), EDA_3D_CANVAS::OnLeftDown(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::PCB_DESIGN_BLOCK_PREVIEW_WIDGET(), Prj(), KICAD_MANAGER_FRAME::RestoreCommitFromHistory(), SCH_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), BOARD_EDITOR_CONTROL::ShowEeschema(), CVPCB_CONTROL::ShowFootprintViewer(), showFrame(), EDA_BASE_FRAME::ShowPreferences(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), KICAD_MANAGER_FRAME::UnarchiveFiles(), 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 179 of file kiway_player.cpp.

References KiwayMailIn().

◆ KiwayMailIn()

void PCB_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 523 of file pcbnew/cross-probing.cpp.

References COMPONENT::AddNet(), KIWAY_EXPRESS::Command(), COMPONENT, CTL_OMIT_FILTERS, dummy, ExecuteRemoteCommand(), FetchNetlistFromSchematic(), FindItemsFromSyncSelection(), FP_BOARD_ONLY, FP_DNP, FP_EXCLUDE_FROM_BOM, PCB_BASE_FRAME::GetBoard(), KIWAY_EXPRESS::GetPayload(), PCB_BASE_FRAME::GetPcbNewSettings(), STRING_FORMATTER::GetString(), TOOLS_HOLDER::GetToolManager(), importFile(), KI_FALLTHROUGH, m_designBlocksPane, m_probingSchToPcb, TOOLS_HOLDER::m_toolManager, MAIL_CROSS_PROBE, MAIL_IMPORT_FILE, MAIL_PCB_GET_NETLIST, MAIL_PCB_UPDATE, MAIL_PCB_UPDATE_LINKS, MAIL_RELOAD_LIB, MAIL_RELOAD_PLUGINS, MAIL_SELECTION, MAIL_SELECTION_FORCE, netlist, OnNetlistChanged(), pad, ACTIONS::pluginsReload, TOOL_MANAGER::RunAction(), BOARD_NETLIST_UPDATER::SetDeleteUnusedFootprints(), COMPONENT::SetFields(), BOARD_NETLIST_UPDATER::SetLookupByTimestamp(), COMPONENT::SetProperties(), BOARD_NETLIST_UPDATER::SetReplaceFootprints(), BOARD_NETLIST_UPDATER::SetTransferGroups(), StartCrossProbeFlash(), PCB_ACTIONS::syncSelection, PCB_ACTIONS::syncSelectionWithNets, traceCrossProbeFlash, PCB_BASE_FRAME::Update3DView(), BOARD_NETLIST_UPDATER::UpdateNetlist(), and ACTIONS::updatePcbFromSchematic.

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent & event )

protectedinherited

An event handler called on a language menu selection.

Definition at line 186 of file kiway_player.cpp.

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

◆ LayerManagerShown()

bool PCB_EDIT_FRAME::LayerManagerShown ( )

Definition at line 3048 of file pcb_edit_frame.cpp.

References EDA_BASE_FRAME::m_auimgr.

Referenced by setupUIConditions().

◆ LibraryFileBrowser()

bool EDA_DRAW_FRAME::LibraryFileBrowser	(	const wxString &	aTitle,
		bool	doOpen,
		wxFileName &	aFilename,
		const wxString &	wildcard,
		const wxString &	ext,
		bool	isDirectory,
		FILEDLG_HOOK_NEW_LIBRARY *	aFileDlgHook = nullptr )

inherited

Parameters

aTitle	dialog title
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
aFileDlgHook	optional; adds customized controls to dialog

Returns: true for OK; false for Cancel.

Definition at line 1197 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::GetMruPath(), and EDA_BASE_FRAME::SetMruPath().

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

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )

protectedinherited

Return the canvas type stored in the application settings.

Parameters

aCfg	is the APP_SETTINGS_BASE config storing the canvas type. If nullptr (default) the KifaceSettings() will be used

Definition at line 942 of file eda_draw_frame.cpp.

References COMMON_SETTINGS::GRAPHICS::canvas_type, EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO, EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::m_Graphics, and Pgm().

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

◆ LoadDrawingSheet()

void PCB_EDIT_FRAME::LoadDrawingSheet ( )

Load the drawing sheet file.

Definition at line 44 of file pcbnew_config.cpp.

References PCB_BASE_FRAME::GetBoard(), BOARD::GetEmbeddedFiles(), PROJECT::GetProjectFile(), DS_DATA_MODEL::GetTheInstance(), LoadDrawingSheet(), Pgm(), Prj(), project, resolver, and EDA_BASE_FRAME::ShowInfoBarError().

Referenced by LoadDrawingSheet(), and OpenProjectFiles().

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

References loadFootprint().

Referenced by FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary().

◆ loadFootprint()

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

protectedinherited

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

References FOOTPRINT::ApplyDefaultSettings(), FOOTPRINT::ClearAllNets(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), FRAME_FOOTPRINT_EDITOR, EDA_BASE_FRAME::IsType(), m_pcb, BOARD_DESIGN_SETTINGS::m_StyleFPBarcodes, BOARD_DESIGN_SETTINGS::m_StyleFPDimensions, BOARD_DESIGN_SETTINGS::m_StyleFPFields, BOARD_DESIGN_SETTINGS::m_StyleFPShapes, BOARD_DESIGN_SETTINGS::m_StyleFPText, PROJECT_PCB::PcbFootprintLibs(), and KIWAY_HOLDER::Prj().

Referenced by LoadFootprint(), PCB_EDIT_FRAME::LoadFootprints(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), and SelectFootprintFromLibrary().

◆ LoadFootprints()

void PCB_EDIT_FRAME::LoadFootprints	(	NETLIST &	aNetlist,
		REPORTER &	aReporter )

Load the footprints for each #SCH_COMPONENT in aNetlist from the list of libraries.

Parameters

aNetlist	is the netlist of components to load the footprints into.
aReporter	is the REPORTER object to report to.

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 164 of file netlist.cpp.

References _, FOOTPRINT, LIB_ID::Format(), NETLIST::GetComponent(), NETLIST::GetCount(), COMPONENT::GetFPID(), FOOTPRINT::GetFPID(), COMPONENT::GetKIIDs(), LIB_ID::GetLibItemName(), COMPONENT::GetPath(), COMPONENT::GetReference(), NETLIST::GetReplaceFootprints(), NETLIST::IsEmpty(), NETLIST::IsFindByTimeStamp(), PCB_BASE_FRAME::loadFootprint(), PCB_BASE_FRAME::m_pcb, EDA_ITEM::m_Uuid, path, PROJECT_PCB::PcbFootprintLibs(), Prj(), REPORTER::Report(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, COMPONENT::SetFootprint(), UTF8::size(), NETLIST::SortByFPID(), and UTF8::wx_str().

Referenced by ReadNetlistFromFile().

◆ LoadProjectSettings()

bool PCB_EDIT_FRAME::LoadProjectSettings ( )

Load the current project's file configuration settings which are pertinent to this PCB_EDIT_FRAME instance.

Returns: always returns true.

Definition at line 65 of file pcbnew_config.cpp.

Referenced by OpenProjectFiles().

◆ LoadSettings()

void PCB_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 1589 of file pcb_edit_frame.cpp.

References PCB_BASE_FRAME::LoadSettings(), PCBNEW_SETTINGS::m_AuiPanels, m_show_layer_manager_tools, m_show_net_inspector, m_show_search, PCBNEW_SETTINGS::AUI_PANELS::show_layer_manager, PCBNEW_SETTINGS::AUI_PANELS::show_net_inspector, and PCBNEW_SETTINGS::AUI_PANELS::show_search.

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

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

Referenced by 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 856 of file eda_base_frame.cpp.

References defaultSize(), WINDOW_STATE::display, m_displayIndex, m_framePos, m_frameSize, m_ident, m_maximizeByDefault, m_normalFramePos, m_normalFrameSize, WINDOW_STATE::maximized, minSize, minSizeLookup(), 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 842 of file eda_base_frame.cpp.

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

Referenced by KICAD_MANAGER_FRAME::LoadProject(), PCB_EDIT_FRAME::LoadProjectSettings(), LoadWindowSettings(), 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 245 of file eda_draw_frame.cpp.

References m_file_checker, and Pgm().

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

◆ MakeGridHelper()

std::unique_ptr< GRID_HELPER > PCB_EDIT_FRAME::MakeGridHelper ( )

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 745 of file pcb_edit_frame.cpp.

References PCB_BASE_FRAME::GetMagneticItemsSettings(), and TOOLS_HOLDER::m_toolManager.

◆ MessageTextFromCoord()

wxString PCB_BASE_FRAME::MessageTextFromCoord	(	int	aValue,
		ORIGIN_TRANSFORMS::COORD_TYPES_T	aCoordType ) const

inlineinherited

Definition at line 150 of file pcb_base_frame.h.

References m_originTransforms, and UNITS_PROVIDER::MessageTextFromValue().

◆ MessageTextFromMinOptMax()

wxString UNITS_PROVIDER::MessageTextFromMinOptMax	(	const MINOPTMAX< int > &	aValue,
		EDA_DATA_TYPE	aType = EDA_DATA_TYPE::DISTANCE ) const

inlineinherited

Definition at line 141 of file units_provider.h.

References DISTANCE, GetIuScale(), GetUnitsFromType(), and EDA_UNIT_UTILS::UI::MessageTextFromMinOptMax().

Referenced by PCB_TRACK::GetMsgPanelInfo(), and PCB_TUNING_PATTERN::GetMsgPanelInfo().

◆ MessageTextFromValue() [1/2]

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

inlineinherited

Definition at line 134 of file units_provider.h.

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

◆ MessageTextFromValue() [2/2]

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

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 127 of file units_provider.h.

References DISTANCE, GetIuScale(), GetUnitsFromType(), and EDA_UNIT_UTILS::UI::MessageTextFromValue().

◆ NetInspectorPanelName()

static const wxString EDA_DRAW_FRAME::NetInspectorPanelName ( )

inlinestaticinherited

Definition at line 437 of file eda_draw_frame.h.

Referenced by PCB_EDIT_FRAME::NetInspectorShown(), PCB_EDIT_FRAME::SaveSettings(), and PCB_EDIT_FRAME::ToggleNetInspector().

◆ NetInspectorShown()

bool PCB_EDIT_FRAME::NetInspectorShown ( )

Definition at line 3060 of file pcb_edit_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, and EDA_DRAW_FRAME::NetInspectorPanelName().

Referenced by setupUIConditions().

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce )

inlineinherited

Definition at line 623 of file eda_base_frame.h.

References m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ OnActionPluginButton()

void PCB_EDIT_FRAME::OnActionPluginButton ( wxCommandEvent & aEvent )

protected

Launched by the button when an action is called.

Parameters

aEvent sent by wx

Definition at line 271 of file pcbnew_action_plugins.cpp.

References ACTION_PLUGINS::GetActionByButton(), and RunActionPlugin().

Referenced by addActionPluginTools().

◆ OnActionPluginMenu()

void PCB_EDIT_FRAME::OnActionPluginMenu ( wxCommandEvent & aEvent )

protected

Launched by the menu when an action is called.

Parameters

aEvent sent by wx

Definition at line 262 of file pcbnew_action_plugins.cpp.

References ACTION_PLUGINS::GetActionByMenu(), and RunActionPlugin().

Referenced by buildActionPluginMenus().

◆ onActivate()

void EDA_DRAW_FRAME::onActivate ( wxActivateEvent & aEvent )

protectedinherited

Definition at line 1362 of file eda_draw_frame.cpp.

References handleActivateEvent().

◆ OnApiPluginInvoke()

void EDA_DRAW_FRAME::OnApiPluginInvoke ( wxCommandEvent & aEvent )

virtualinherited

Handler for activating an API plugin (via toolbar or menu).

Definition at line 1488 of file eda_draw_frame.cpp.

References API_PLUGIN_MANAGER::ButtonBindings(), API_PLUGIN_MANAGER::InvokeAction(), and Pgm().

Referenced by AddApiPluginTools().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protectedinherited

Handle the auto save timer event.

Definition at line 412 of file eda_base_frame.cpp.

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

Referenced by commonInit(), and ~EDA_BASE_FRAME().

◆ OnBoardLoaded()

void PCB_EDIT_FRAME::OnBoardLoaded ( )

Update the state of the GUI after a new board is loaded or created.

Definition at line 1775 of file pcb_edit_frame.cpp.

References _, KIGFX::ALL, LSET::AllLayersMask(), B_Cu, ENUM_MAP< T >::Choices(), F_Cu, PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), PCB_BASE_FRAME::GetDesignSettings(), DRC_TOOL::GetDRCEngine(), PROJECT::GetLocalSettings(), PCB_BASE_FRAME::GetPcbNewSettings(), PROJECT::GetProjectFile(), PCB_DRAW_PANEL_GAL::GetView(), LOCAL_HISTORY::Init(), DRC_ENGINE::InitEngine(), ENUM_MAP< T >::Instance(), LAYER_RATSNEST, PROJECT_LOCAL_SETTINGS::m_ActiveLayer, PROJECT_LOCAL_SETTINGS::m_ActiveLayerPreset, PCB_BASE_EDIT_FRAME::m_appearancePanel, EDA_BASE_FRAME::m_infoBar, PROJECT_FILE::m_LayerPairInfos, PCB_BASE_EDIT_FRAME::m_layerPairSettings, EDA_DRAW_FRAME::m_netInspectorPanel, PCB_BASE_FRAME::m_pcb, TOOLS_HOLDER::m_toolManager, ENUM_MAP< T >::Map(), LSET::Name(), WX_INFOBAR::OUTDATED_SAVE, Prj(), ReCreateLayerBox(), Refresh(), SetActiveLayer(), SetElementVisibility(), EDA_DRAW_FRAME::SetMsgPanel(), KIPLATFORM::APP::SetShutdownBlockReason(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), ENUM_MAP< T >::Undefined(), UNDEFINED_LAYER, PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), KIGFX::VIEW::UpdateAllItems(), UpdateTitle(), and EDA_DRAW_FRAME::Zoom_Automatique().

Referenced by OpenProjectFiles().

◆ 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 FOOTPRINT_VIEWER_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 437 of file eda_base_frame.cpp.

References dump(), and kicadTraceKeyEvent.

◆ OnClearFileHistory()

void PCB_EDIT_FRAME::OnClearFileHistory ( wxCommandEvent & aEvent )

Definition at line 265 of file pcbnew/files.cpp.

References EDA_BASE_FRAME::ClearFileHistory().

◆ onCloseModelessBookReporterDialogs()

void PCB_EDIT_FRAME::onCloseModelessBookReporterDialogs ( wxCommandEvent & aEvent )

protected

Definition at line 3132 of file pcb_edit_frame.cpp.

References FOOTPRINT_DIFF_DIALOG_NAME, INSPECT_CLEARANCE_DIALOG_NAME, INSPECT_CONSTRAINTS_DIALOG_NAME, INSPECT_DRC_ERROR_DIALOG_NAME, m_footprintDiffDlg, m_inspectClearanceDlg, m_inspectConstraintsDlg, m_inspectDrcErrorDlg, PCB_BASE_FRAME::m_pcb, TOOLS_HOLDER::m_toolManager, and ACTIONS::selectItem.

Referenced by doCloseWindow(), and EVT_UPDATE_UI_RANGE().

◆ OnCreateStatusBar()

wxStatusBar * EDA_DRAW_FRAME::OnCreateStatusBar	(	int	number,
		long	style,
		wxWindowID	id,
		const wxString &	name )

overrideinherited

Create the status line (like a wxStatusBar).

This is actually a KISTATUSBAR status bar. the specified number of fields is the extra number of fields, not the full field count.

Returns: a KISTATUSBAR (derived from wxStatusBar)

Definition at line 775 of file eda_draw_frame.cpp.

References name, and KISTATUSBAR::NONE_STYLE.

◆ OnCrossProbeFlashTimer()

void PCB_EDIT_FRAME::OnCrossProbeFlashTimer ( wxTimerEvent & aEvent )

Definition at line 626 of file pcb_edit_frame.cpp.

References SELECTION_TOOL::AddItemToSel(), PCB_SELECTION_TOOL::ClearSelection(), EDA_DRAW_PANEL_GAL::ForceRefresh(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), m_crossProbeFlashing, m_crossProbeFlashItems, m_crossProbeFlashPhase, m_crossProbeFlashTimer, m_probingSchToPcb, PCB_BASE_FRAME::ResolveItem(), and traceCrossProbeFlash.

Referenced by EVT_UPDATE_UI_RANGE().

◆ onDarkModeToggle()

void PCB_BASE_EDIT_FRAME::onDarkModeToggle ( )

protectedvirtualinherited

Definition at line 308 of file pcb_base_edit_frame.cpp.

References PCB_BASE_FRAME::Get3DViewerFrame(), m_appearancePanel, and EDA_3D_VIEWER_FRAME::OnDarkModeToggle().

Referenced by PCB_BASE_EDIT_FRAME().

◆ OnDisplayOptionsChanged()

void PCB_EDIT_FRAME::OnDisplayOptionsChanged ( )

overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 1862 of file pcb_edit_frame.cpp.

References PCB_BASE_EDIT_FRAME::m_appearancePanel.

◆ OnDropFiles()

void EDA_BASE_FRAME::OnDropFiles ( wxDropFilesEvent & aEvent )

protectedvirtualinherited

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

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

◆ OnEditItemRequest()

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

Reimplemented from PCB_BASE_EDIT_FRAME.

Definition at line 99 of file edit.cpp.

References Edit_Zone_Params(), ACTIONS::groupProperties, TOOLS_HOLDER::m_toolManager, PCB_BARCODE_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_POINT_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_ZONE_T, PCB_BASE_EDIT_FRAME::ShowBarcodePropertiesDialog(), ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), DIALOG_SHIM::ShowQuasiModal(), PCB_BASE_EDIT_FRAME::ShowReferenceImagePropertiesDialog(), ShowTargetOptionsDialog(), PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog(), and EDA_ITEM::Type().

◆ OnExportHyperlynx()

void PCB_EDIT_FRAME::OnExportHyperlynx ( )

Export the current BOARD to a Hyperlynx HYP file.

◆ OnExportSTEP()

void PCB_EDIT_FRAME::OnExportSTEP ( )

Export the current BOARD to a STEP assembly.

◆ OnFileHistory()

void PCB_EDIT_FRAME::OnFileHistory ( wxCommandEvent & event )

Definition at line 248 of file pcbnew/files.cpp.

References _, AskLoadBoardFileName(), EDA_BASE_FRAME::GetFileFromHistory(), KICTL_KICAD_ONLY, and OpenProjectFiles().

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

References m_watcherDebounceTimer, m_watcherFileName, and traceLibWatch.

Referenced by setFPWatcher().

◆ OnFpChangeDebounceTimer()

void PCB_BASE_FRAME::OnFpChangeDebounceTimer ( wxTimerEvent & aEvent )

inherited

Handler for the filesystem watcher debounce timer.

Definition at line 1157 of file pcb_base_frame.cpp.

References _, FOOTPRINT::ClearAllNets(), PCB_DRAW_PANEL_GAL::DisplayBoard(), DisplayError(), FP_LIB_TABLE::FootprintLoad(), FRAME_FOOTPRINT_EDITOR, GetBoard(), GetCanvas(), TOOLS_HOLDER::GetCurrentSelection(), BOARD::GetFirstFootprint(), FOOTPRINT::GetFPID(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), GetScreen(), EDA_BASE_FRAME::IsContentModified(), IsOK(), EDA_BASE_FRAME::IsType(), m_inFpChangeTimerEvent, TOOLS_HOLDER::m_toolManager, m_watcherDebounceTimer, m_watcherFileName, m_watcherLastModified, TOOL_BASE::MODEL_RELOAD, PROJECT_PCB::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), ReloadFootprint(), ResolveItem(), ACTIONS::selectItems, traceLibWatch, PCB_DRAW_PANEL_GAL::UpdateColors(), and IO_ERROR::What().

Referenced by PCB_BASE_FRAME().

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent & aEvent )

protectedinherited

Definition at line 1828 of file eda_base_frame.cpp.

References handleIconizeEvent().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

Definition at line 1318 of file eda_base_frame.cpp.

References EDA_BASE_FRAME(), and ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

inherited

Definition at line 1754 of file eda_base_frame.cpp.

References GetWindowSize(), m_normalFramePos, 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 447 of file eda_base_frame.cpp.

References TOOLS_HOLDER::m_toolDispatcher.

◆ OnModify()

void PCB_EDIT_FRAME::OnModify ( )

overridevirtual

Must be called after a board change to set the modified flag.

Reload the 3D view if required and calls the base PCB_BASE_FRAME::OnModify function to update auxiliary information.

Reimplemented from PCB_BASE_FRAME.

Definition at line 1933 of file pcb_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetPcbNewSettings(), EDA_BASE_FRAME::m_isClosing, m_ZoneFillsDirty, LOCAL_HISTORY::NoteFileChange(), PCB_BASE_FRAME::OnModify(), PCB_BASE_FRAME::Update3DView(), and UpdateTitle().

Referenced by MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createPolygonShape(), API_HANDLER_PCB::handleSetBoardEnabledLayers(), ImportSpecctraSession(), OpenProjectFiles(), RunActionPlugin(), SetLastPath(), ShowBoardSetupDialog(), and GLOBAL_EDIT_TOOL::ZonesManager().

◆ OnMove()

void EDA_DRAW_FRAME::OnMove ( wxMoveEvent & aEvent )

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 626 of file eda_draw_frame.cpp.

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

Referenced by EDA_DRAW_FRAME().

◆ OnNetlistChanged()

void PCB_EDIT_FRAME::OnNetlistChanged	(	BOARD_NETLIST_UPDATER &	aUpdater,
		bool *	aRunDragCommand )

Called after netlist is updated.

Parameters

aUpdater	is the updater object that was run.
aRunDragCommand	is set to true if the drag command was invoked by this call.

Definition at line 87 of file netlist.cpp.

References PCB_BASE_FRAME::Compile_Ratsnest(), KIGFX::GEOMETRY, BOARD_NETLIST_UPDATER::GetAddedFootprints(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetComponentClassManager(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DRC_TOOL::GetDRCEngine(), PCB_BASE_FRAME::GetPcbNewSettings(), TOOLS_HOLDER::GetToolManager(), PCB_DRAW_PANEL_GAL::GetView(), DRC_ENGINE::InitEngine(), COMPONENT_CLASS_MANAGER::InvalidateComponentClasses(), PCBNEW_SETTINGS::m_Display, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_NetNames, TOOLS_HOLDER::m_toolManager, COMPONENT_CLASS_MANAGER::RebuildRequiredCaches(), EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, TOOL_MANAGER::RunAction(), ACTIONS::selectionClear, ACTIONS::selectItems, EDA_DRAW_FRAME::SetMsgPanel(), SpreadFootprints(), BOARD::SynchronizeNetsAndNetClasses(), text, and KIGFX::VIEW::UpdateAllItemsConditionally().

Referenced by KiwayMailIn().

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

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

inherited

Definition at line 1325 of file eda_base_frame.cpp.

References ShowPreferences().

◆ OnQuit()

void PCB_EDIT_FRAME::OnQuit ( wxCommandEvent & event )

Definition at line 1246 of file pcb_edit_frame.cpp.

References Kiface(), Kiway, and KIWAY::OnKiCadExit().

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

References dummy, ACTIONS::gridPreset, ACTIONS::gridProperties, m_canvas, m_gridSelectBox, TOOLS_HOLDER::m_toolManager, OnUpdateSelectGrid(), and 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 608 of file eda_draw_frame.cpp.

References m_canvas, TOOLS_HOLDER::m_toolManager, m_zoomSelectBox, 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 FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 716 of file eda_draw_frame.cpp.

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

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

◆ onSize()

void PCB_EDIT_FRAME::onSize ( wxSizeEvent & aEvent )

protected

Definition at line 3066 of file pcb_edit_frame.cpp.

References TOOLS_HOLDER::GetToolManager(), EDA_DRAW_FRAME::OnSize(), onSize(), TOOL_MANAGER::RunAction(), and ACTIONS::zoomFitScreen.

Referenced by EVT_UPDATE_UI_RANGE(), and onSize().

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent & evt )

inherited

Definition at line 69 of file eda_dde.cpp.

References client_ipc_buffer, 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 m_sockets.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent & aEvent )

protectedinherited

Definition at line 1818 of file eda_base_frame.cpp.

References HandleSystemColorChange().

◆ OnToolbarSizeChanged()

void EDA_BASE_FRAME::OnToolbarSizeChanged ( )

inherited

Update toolbars if desired toolbar icon changed.

Definition at line 676 of file eda_base_frame.cpp.

References m_auimgr, m_tbLeft, m_tbRight, m_tbTopAux, and m_tbTopMain.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged().

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent & aEvent )

inherited

Update the checked item in the grid wxchoice.

Definition at line 429 of file eda_draw_frame.cpp.

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

Referenced by OnSelectGrid().

◆ OnUpdateSelectTrackWidth()

void PCB_EDIT_FRAME::OnUpdateSelectTrackWidth ( wxUpdateUIEvent & aEvent )

Definition at line 688 of file toolbars_pcb_editor.cpp.

References PCB_BASE_FRAME::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetTrackWidthIndex(), ID_AUX_TOOLBAR_PCB_TRACK_WIDTH, m_SelTrackWidthBox, and BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize().

◆ OnUpdateSelectViaSize()

void PCB_EDIT_FRAME::OnUpdateSelectViaSize ( wxUpdateUIEvent & aEvent )

Definition at line 707 of file toolbars_pcb_editor.cpp.

References PCB_BASE_FRAME::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetViaSizeIndex(), ID_AUX_TOOLBAR_PCB_VIA_SIZE, m_SelViaSizeBox, and BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize().

◆ OnUpdateSelectZoom()

void EDA_DRAW_FRAME::OnUpdateSelectZoom ( wxUpdateUIEvent & aEvent )

inherited

Update the checked item in the zoom wxchoice.

Definition at line 447 of file eda_draw_frame.cpp.

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

◆ OnVertexEditorPaneClosed()

void PCB_BASE_EDIT_FRAME::OnVertexEditorPaneClosed ( PCB_VERTEX_EDITOR_PANE * aPane )

inherited

Definition at line 466 of file pcb_base_edit_frame.cpp.

References m_vertexEditorPane.

◆ OpenProjectFiles()

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

overridevirtual

Load a KiCad board (.kicad_pcb) from aFileName.

Parameters

aFileSet	hold the BOARD file to load, a vector of one element.
aCtl	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. bool LoadOnePcbFile( const wxString& aFileName, bool aAppend = false, bool aForceFileDialog = false );

Reimplemented from KIWAY_PLAYER.

Definition at line 462 of file pcbnew/files.cpp.

References _, AskOverrideLock(), BOARD::BuildConnectivity(), BOARD::BuildListOfNets(), Clear_Pcb(), BOARD::ClearProject(), config, PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), WX_INFOBAR::Dismiss(), DisplayError(), DisplayErrorMessage(), KIDIALOG::DoNotShowCheckbox(), UTF8::empty(), PCB_IO_MGR::FILE_TYPE_NONE, PCB_IO_MGR::FindPluginTypeFromBoardPath(), WX_HTML_REPORT_BOX::Flush(), PROJECT::FootprintLibTblName(), GAL_LAYER_ID_BITMASK_END, GAL_LAYER_INDEX, WX_INFOBAR::GENERIC, PCB_BASE_FRAME::Get3DViewerFrame(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetComponentClassManager(), BOARD::GetDesignSettings(), BOARD::GetFileFormatVersionAtLoad(), BOARD::GetFileName(), BOARD::GetGenerator(), EDA_BASE_FRAME::GetInfoBar(), NULL_REPORTER::GetInstance(), BOARD::GetLengthCalculation(), LIB_ID::GetLibItemName(), PROJECT::GetLocalSettings(), PCB_BASE_FRAME::GetPageSizeIU(), PROJECT::GetProjectFullName(), GetRunningMicroSecs(), PCB_BASE_FRAME::GetScreen(), GetSettingsManager(), GFootprintList, HandleUnsavedChanges(), WX_HTML_REPORT_BOX::HasMessage(), inferLegacyEdgeClearance(), LOCAL_HISTORY::Init(), LIB_TABLE::InsertRow(), IsContentModified(), EDA_ITEM::IsModified(), IsOK(), PCB_IO_MGR::KICAD_SEXP, FILEEXT::KiCadPcbFileExtension, KICTL_CREATE, KICTL_IMPORT_LIB, KICTL_NONKICAD_ONLY, Kiface(), PCB_IO_MGR::LEGACY, LoadDrawingSheet(), SETTINGS_MANAGER::LoadProject(), LoadProjectSettings(), BOARD_DESIGN_SETTINGS::m_CopperEdgeClearance, EDA_DRAW_FRAME::m_file_checker, m_importProperties, EDA_BASE_FRAME::m_infoBar, BOARD::m_LegacyCopperEdgeClearanceLoaded, BOARD::m_LegacyDesignSettingsLoaded, BOARD::m_LegacyVisibleItems, BOARD::m_LegacyVisibleLayers, DIALOG_HTML_REPORTER::m_Reporter, TOOLS_HOLDER::m_toolManager, PROJECT_LOCAL_SETTINGS::m_VisibleItems, PROJECT_LOCAL_SETTINGS::m_VisibleLayers, EDA_3D_VIEWER_FRAME::NewDisplay(), OnBoardLoaded(), OnModify(), WX_INFOBAR::OUTDATED_SAVE, PROJECT_PCB::PcbFootprintLibs(), Pgm(), PCB_IO_MGR::PluginFind(), PR_CAN_ABORT, Prj(), SETTINGS_MANAGER::Prj(), IO_ERROR::Problem(), PROJECT_VAR_NAME, FILEEXT::ProjectFileExtension, COMPONENT_CLASS_MANAGER::RebuildRequiredCaches(), KIPLATFORM::APP::RegisterApplicationRestart(), PCB_ACTIONS::rehatchShapes, PCB_ACTIONS::repairBoard, Rescue, ResolveDRCExclusions(), result, DIALOG_IMPORT_CHOOSE_PROJECT::RunModal(), DIALOG_MAP_LAYERS::RunModal(), LIB_TABLE::Save(), SavePcbFile(), SaveProjectLocalSettings(), SetBoard(), BASE_SCREEN::SetContentModified(), BOARD::SetFileName(), EDA_DRAW_PANEL_GAL::SetFocus(), LIB_ID::SetLibNickname(), EDA_ITEM::SetModified(), BOARD::SetProject(), PROJECT::SetReadOnly(), SEXPR_BOARD_FILE_VERSION, DIALOG_SHIM::ShowModal(), KIDIALOG::ShowModal(), StrPrintf(), BOARD::SynchronizeComponentClasses(), LENGTH_DELAY_CALCULATION::SynchronizeTuningProfileProperties(), THROW_IO_ERROR, UNIX_STRING_DIR_SEP, SETTINGS_MANAGER::UnloadProject(), EDA_BASE_FRAME::UpdateFileHistory(), IO_ERROR::What(), and WIN_STRING_DIR_SEP.

Referenced by API_HANDLER_PCB::handleRevertDocument(), importFile(), and OnFileHistory().

◆ OpenVertexEditor()

void PCB_BASE_EDIT_FRAME::OpenVertexEditor ( BOARD_ITEM * aItem )

inherited

Definition at line 429 of file pcb_base_edit_frame.cpp.

References _, EDA_BASE_FRAME::m_auimgr, m_vertexEditorPane, and VertexEditorPaneName().

Referenced by EDIT_TOOL::EditVertices().

◆ OptionalValueFromString()

std::optional< int > UNITS_PROVIDER::OptionalValueFromString	(	const wxString &	aTextValue,
		EDA_DATA_TYPE	aType = EDA_DATA_TYPE::DISTANCE ) const

inlineinherited

Converts aTextValue in aUnits to internal units used by the frame.

Allows the return of an empty optional if the string represents a null value (currently empty string)

Warning: This utilizes the current locale and will break if decimal formats differ

Parameters

aType	is the type of this value, and controls the way the string is converted to a value
aTextValue	A reference to a wxString object containing the string to convert.

Returns: internal units value

Definition at line 175 of file units_provider.h.

References DISTANCE, EDA_UNIT_UTILS::UI::DoubleValueFromString(), GetIuScale(), GetUnitsFromType(), KiROUND(), and NullUiString.

Referenced by WX_GRID::GetOptionalUnitValue(), and WX_GRID::onCellEditorHidden().

◆ PlaceFootprint()

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

inherited

Place 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 400 of file load_select_footprint.cpp.

References CHANGED, EDA_ITEM::ClearFlags(), Compile_Ratsnest(), GetCanvas(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), m_pcb, NEWITEM, OnModify(), s_FootprintInitialCopy, s_PickedList, SaveCopyInUndoList(), ITEM_PICKER::SetLink(), EDA_DRAW_FRAME::SetMsgPanel(), FOOTPRINT::SetPosition(), and UNSPECIFIED.

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

◆ PluginActionScope()

PLUGIN_ACTION_SCOPE PCB_EDIT_FRAME::PluginActionScope ( ) const

inlineoverrideprotectedvirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 763 of file pcb_edit_frame.h.

References PCB.

Referenced by configureToolbars().

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

References m_redoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), 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 1706 of file eda_base_frame.cpp.

References m_undoList.

Referenced by PCB_BASE_EDIT_FRAME::AppendCopyToUndoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), PCB_BASE_EDIT_FRAME::RollbackFromUndo(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), PCB_EDIT_FRAME::RunActionPlugin(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

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

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

Referenced by EDIT_TOOL::doMoveSelection(), PCB_VIEWER_TOOLS::MeasureTool(), and EDIT_TOOL::Remove().

◆ PrepareLayerIndicator()

void PCB_EDIT_FRAME::PrepareLayerIndicator ( bool aForceRebuild = false )

Definition at line 71 of file toolbars_pcb_editor.cpp.

References LAYER_PRESENTATION::CreateLayerPairIcon(), COLOR_SETTINGS::GetColor(), PCB_BASE_EDIT_FRAME::GetColorSettings(), PCB_BASE_FRAME::GetScreen(), KiIconScale(), LAYER_PCB_BACKGROUND, LayerPairBitmap, m_prevIconVal, EDA_BASE_FRAME::m_tbTopAux, scale, and PCB_ACTIONS::selectLayerPair.

◆ 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

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

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

Referenced by PrintDrawingSheet().

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString & text )

inherited

Definition at line 1138 of file eda_base_frame.cpp.

References text.

Referenced by KICAD_MANAGER_FRAME::UnarchiveFiles().

◆ 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(), and KIWAY::Prj().

◆ Process_Special_Functions()

void PCB_EDIT_FRAME::Process_Special_Functions ( wxCommandEvent & event )

Definition at line 54 of file edit.cpp.

References ExportFootprintsToLibrary().

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

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

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

◆ ProjectChanged()

void PCB_EDIT_FRAME::ProjectChanged ( )

overridevirtual

Notification event that the project has changed.

Reimplemented from EDA_BASE_FRAME.

Definition at line 2952 of file pcb_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), PROJECT::GetProjectPath(), PCB_IO_MGR::KICAD_SEXP, PCB_IO_MGR::PluginFind(), Prj(), PythonSyncProjectName(), LOCAL_HISTORY::RegisterSaver(), traceAutoSave, and IO_ERROR::What().

◆ PropertiesPaneName()

static const wxString EDA_DRAW_FRAME::PropertiesPaneName ( )

inlinestaticinherited

Definition at line 435 of file eda_draw_frame.h.

Referenced by defaultPropertiesPaneInfo(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), PCB_EDIT_FRAME::PropertiesShown(), SCH_EDIT_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), PCB_BASE_EDIT_FRAME::ToggleProperties(), SCH_EDIT_FRAME::ToggleProperties(), SYMBOL_EDIT_FRAME::ToggleProperties(), SCH_EDIT_FRAME::updateSelectionFilterVisbility(), and SYMBOL_EDIT_FRAME::updateSelectionFilterVisbility().

◆ PropertiesShown()

bool PCB_EDIT_FRAME::PropertiesShown ( )

Definition at line 3054 of file pcb_edit_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, and EDA_DRAW_FRAME::PropertiesPaneName().

Referenced by setupUIConditions().

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

References ClearUndoORRedoList(), GetRedoCommandCount(), m_redoList, m_undoRedoCountMax, and REDO_LIST.

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

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

References ClearUndoORRedoList(), GetUndoCommandCount(), m_undoList, m_undoRedoCountMax, and UNDO_LIST.

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

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

References DisplayToolMsg(), TOOL_EVENT::getCommandStr(), TOOL_ACTION::GetFriendlyName(), m_toolManager, and m_toolStack.

Referenced by EDIT_TOOL::doMoveSelection(), PCB_VIEWER_TOOLS::MeasureTool(), and EDIT_TOOL::Remove().

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

References _, BOARD_ITEM_CONTAINER::Add(), KIGFX::PCB_VIEW::Add(), B_Mask, BOARD::BuildConnectivity(), BULK, BULK_APPEND, CHANGED, EDA_ITEM::ClearFlags(), PCB_BASE_FRAME::Compile_Ratsnest(), DELETED, BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), DRILLORIGIN, F_Mask, FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetBoard(), EDA_ITEM::GetBoundingBox(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetComponentClassManager(), BOARD::GetConnectivity(), PICKED_ITEMS_LIST::GetCount(), ZONE::GetIsRuleArea(), PICKED_ITEMS_LIST::GetItemWrapper(), PCB_BASE_FRAME::GetModel(), BOARD_ITEM::GetParentFootprint(), PCB_BASE_FRAME::GetPcbNewSettings(), PICKED_ITEMS_LIST::GetPickedItem(), PICKED_ITEMS_LIST::GetPickedItemLink(), PICKED_ITEMS_LIST::GetPickedItemStatus(), EDA_ITEM::GetPosition(), TOOLS_HOLDER::GetToolManager(), PCB_DRAW_PANEL_GAL::GetView(), GRIDORIGIN, group, KIGFX::VIEW::Hide(), PCB_BASE_FRAME::HideSolderMask(), image, BOARD::IncrementTimeStamp(), FOOTPRINT::InvalidateComponentClassCache(), COMPONENT_CLASS_MANAGER::InvalidateComponentClasses(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), EDA_BASE_FRAME::IsType(), KI_FALLTHROUGH, PCBNEW_SETTINGS::m_Display, PCB_BASE_FRAME::m_pcb, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_ShowGlobalRatsnest, TOOLS_HOLDER::m_toolManager, EDA_ITEM::m_Uuid, NEWITEM, BOARD::OnItemsCompositeUpdate(), pad, PAGESETTINGS, PCB_ARC_T, PCB_FOOTPRINT_T, PCB_NETINFO_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, TOOL_MANAGER::PostAction(), PCB_SELECTION_TOOL::RebuildSelection(), PCB_ACTIONS::rehatchShapes, BOARD_ITEM_CONTAINER::Remove(), KIGFX::PCB_VIEW::Remove(), PICKED_ITEMS_LIST::RemovePicker(), BOARD::ResolveItem(), PCB_BASE_FRAME::ResolveItem(), DS_PROXY_UNDO_ITEM::Restore(), BOARD::SanitizeNetcodes(), EDA_ITEM::SetFlags(), PICKED_ITEMS_LIST::SetPickedItemStatus(), SHOW_WITH_VIA_ALWAYS, BOARD_ITEM::SwapItemData(), EDA_ITEM::Type(), KIGFX::PCB_VIEW::UpdateCollidingItems(), UR_TRANSIENT, WS_PROXY_UNDO_ITEM_PLUS_T, and WS_PROXY_UNDO_ITEM_T.

Referenced by RestoreCopyFromRedoList(), RestoreCopyFromUndoList(), and RollbackFromUndo().

◆ PythonSyncEnvironmentVariables()

void PCB_EDIT_FRAME::PythonSyncEnvironmentVariables ( )

Synchronize the environment variables from KiCad's environment into the Python interpreter.

Definition at line 2197 of file pcb_edit_frame.cpp.

References PGM_BASE::GetLocalEnvVariables(), and Pgm().

Referenced by CommonSettingsChanged().

◆ PythonSyncProjectName()

void PCB_EDIT_FRAME::PythonSyncProjectName ( )

Synchronize the project name from KiCad's environment into the Python interpreter.

Definition at line 2213 of file pcb_edit_frame.cpp.

References PROJECT_VAR_NAME.

Referenced by ProjectChanged().

◆ ReadNetlistFromFile()

bool PCB_EDIT_FRAME::ReadNetlistFromFile	(	const wxString &	aFilename,
		NETLIST &	aNetlist,
		REPORTER &	aReporter )

Read a netlist from a file into a NETLIST object.

Parameters

aFilename	is the netlist to load.
aNetlist	is the object to populate with data.
aReporter	is a REPORTER object to display messages.

Returns: true if the netlist was read successfully.

Definition at line 53 of file netlist.cpp.

References _, DisplayErrorMessage(), NETLIST_READER::GetNetlistReader(), LAST_PATH_NETLIST, LoadFootprints(), SetLastPath(), and IO_ERROR::What().

◆ RebuildAndRefresh()

void PCB_EDIT_FRAME::RebuildAndRefresh ( )

Rebuilds board connectivity, refreshes canvas.

Definition at line 427 of file pcbnew_action_plugins.cpp.

References SELECTION_TOOL::AddItemsToSel(), KIGFX::VIEW::Clear(), SELECTION::Contains(), PCB_DRAW_PANEL_GAL::DisplayBoard(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), GetCurrentSelection(), EDA_DRAW_PANEL_GAL::GetGAL(), SELECTION::GetItems(), BOARD::GetItemSet(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::InitPreview(), PCB_BASE_FRAME::m_pcb, TOOLS_HOLDER::m_toolManager, TOOL_BASE::REDRAW, EDA_DRAW_PANEL_GAL::Refresh(), SELECTION_TOOL::RemoveItemsFromSel(), KIGFX::GAL::SetGridOrigin(), SetPageSettings(), and PCB_DRAW_PANEL_GAL::SyncLayersVisibility().

Referenced by RunActionPlugin().

◆ rebuildConnectivity()

void PCB_BASE_FRAME::rebuildConnectivity ( )

protectedinherited

Definition at line 963 of file pcb_base_frame.cpp.

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

Referenced by PCB_EDIT_FRAME::Edit_Zone_Params().

◆ ReCreateAuxiliaryToolbar()

virtual void EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar ( )

inlinevirtualinherited

Definition at line 220 of file eda_draw_frame.h.

Referenced by PCB_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), and PCB_BASE_EDIT_FRAME::unitsChangeRefresh().

◆ ReCreateHToolbar()

virtual void EDA_DRAW_FRAME::ReCreateHToolbar ( )

inlinevirtualinherited

Definition at line 217 of file eda_draw_frame.h.

Referenced by FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_WIZARD_FRAME::ReCreatePageList(), and FOOTPRINT_EDIT_FRAME::SaveFootprintAs().

◆ ReCreateLayerBox()

void PCB_EDIT_FRAME::ReCreateLayerBox ( bool aForceResizeToolbar = true )

Recreate the layer box by clearing the old list and building a new one from the new layer names and colors.

Parameters

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

Definition at line 582 of file toolbars_pcb_editor.cpp.

References _, PCB_BASE_EDIT_FRAME::m_SelLayerBox, EDA_BASE_FRAME::m_tbTopAux, and EDA_BASE_FRAME::UpdateToolbarControlSizes().

Referenced by Clear_Pcb(), OnBoardLoaded(), and UpdateUserInterface().

◆ ReCreateLeftToolbar()

virtual void EDA_DRAW_FRAME::ReCreateLeftToolbar ( )

inlinevirtualinherited

Definition at line 219 of file eda_draw_frame.h.

◆ ReCreateMenuBar()

void EDA_BASE_FRAME::ReCreateMenuBar ( )

inherited

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

References doReCreateMenuBar(), and m_isClosing.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), ClearFileHistory(), CommonSettingsChanged(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GetFileFromHistory(), HandleSystemColorChange(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), GERBVIEW_FRAME::OnClearDrlFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), GERBVIEW_FRAME::OnClearZipFileHistory(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), ShowChangedLanguage(), SIMULATOR_FRAME::SIMULATOR_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), and UpdateFileHistory().

◆ RecreateToolbars()

void EDA_BASE_FRAME::RecreateToolbars ( )

virtualinherited

Definition at line 589 of file eda_base_frame.cpp.

References config(), dummy, KICAD_AUI_TB_STYLE, LEFT, m_auimgr, m_tbLeft, m_tbRight, m_tbTopAux, m_tbTopMain, m_toolbarSettings, RIGHT, TOP_AUX, and TOP_MAIN.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), KICAD_MANAGER_FRAME::onToolbarSizeChanged(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), GERBVIEW_FRAME::ReFillLayerWidget(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), CVPCB_MAINFRAME::ShowChangedLanguage(), EDA_3D_VIEWER_FRAME::ShowChangedLanguage(), KICAD_MANAGER_FRAME::ShowChangedLanguage(), PCB_BASE_FRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), SIMULATOR_FRAME::SIMULATOR_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ ReCreateVToolbar()

virtual void EDA_DRAW_FRAME::ReCreateVToolbar ( )

inlinevirtualinherited

Definition at line 218 of file eda_draw_frame.h.

◆ redrawNetnames()

void PCB_EDIT_FRAME::redrawNetnames ( )

protected

Definition at line 751 of file pcb_edit_frame.cpp.

References BOX2ISafe(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), GetNetnameLayer(), KIGFX::VIEW::GetScale(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::Inflate(), BOX2I_MINMAX::Intersects(), Kiface(), KIFACE_BASE::KifaceSettings(), PCBNEW_SETTINGS::m_Display, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_NetNames, PCB_VIA_T, pcbIUScale, KIGFX::REPAINT, and KIGFX::VIEW::Update().

◆ RefreshCanvas()

void EDA_DRAW_FRAME::RefreshCanvas ( )

inlineoverridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 476 of file eda_draw_frame.h.

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

Referenced by SCH_EDIT_FRAME::OnImportProject().

◆ RegisterCustomToolbarControlFactory()

void EDA_BASE_FRAME::RegisterCustomToolbarControlFactory	(	const ACTION_TOOLBAR_CONTROL &	aControlDesc,
		const ACTION_TOOLBAR_CONTROL_FACTORY &	aControlFactory )

inherited

Register a creation factory for toolbar controls that are present in this frame.

The factory function takes a single argument of type ACTION_TOOLBAR*, which is the toolbar to add the controls to.

Parameters

aControlDesc	is the control descriptor
aControlFactory	A functor that creates the custom controls and then adds them to the toolbar

Definition at line 565 of file eda_base_frame.cpp.

References ACTION_TOOLBAR_CONTROL::GetName(), and m_toolbarControlFactories.

Referenced by CVPCB_MAINFRAME::configureToolbars(), EDA_DRAW_FRAME::configureToolbars(), GERBVIEW_FRAME::configureToolbars(), PCB_BASE_EDIT_FRAME::configureToolbars(), PCB_EDIT_FRAME::configureToolbars(), PL_EDITOR_FRAME::configureToolbars(), SCH_EDIT_FRAME::configureToolbars(), SYMBOL_EDIT_FRAME::configureToolbars(), and SYMBOL_VIEWER_FRAME::configureToolbars().

◆ RegisterUIUpdateHandler() [1/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 456 of file eda_base_frame.cpp.

References HandleUpdateUIEvent(), and m_uiUpdateMap.

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

◆ RegisterUIUpdateHandler() [2/2]

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

virtualinherited

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

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

Referenced by RegisterUIUpdateHandler().

◆ ReleaseFile()

void EDA_DRAW_FRAME::ReleaseFile ( )

inherited

Release the current file marked in use.

See m_file_checker.

Definition at line 238 of file eda_draw_frame.cpp.

References m_file_checker.

Referenced by PCB_EDIT_FRAME::Clear_Pcb(), API_HANDLER_PCB::handleRevertDocument(), and ~EDA_DRAW_FRAME().

◆ ReloadFootprint()

virtual void PCB_BASE_FRAME::ReloadFootprint ( FOOTPRINT * aFootprint )

inlinevirtualinherited

Reload the footprint from the library.

Parameters

aFootprint is the footprint to reload.

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 200 of file pcb_base_frame.h.

Referenced by OnFpChangeDebounceTimer().

◆ RemoveBoardChangeListener()

void PCB_BASE_FRAME::RemoveBoardChangeListener ( wxEvtHandler * aListener )

inherited

Remove aListener to from the board changed listener list.

◆ resolveCanvasType()

void EDA_DRAW_FRAME::resolveCanvasType ( )

protectedvirtualinherited

Determine the canvas type to load (with prompt if required) and initializes m_canvasType.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 1341 of file eda_draw_frame.cpp.

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

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

◆ ResolveDRCExclusions()

void PCB_EDIT_FRAME::ResolveDRCExclusions ( bool aCreateMarkers )

If aCreateMarkers then create DRC exclusion markers from the serialized data.

If false, then use the serialized data to set exclusion flags on existing markers.

Definition at line 1256 of file pcb_edit_frame.cpp.

References COMMIT::Add(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), MARKER_BASE::MARKER_DRAWING_SHEET, BOARD_COMMIT::Push(), ResolveDRCExclusions(), RPT_SEVERITY_EXCLUSION, SKIP_SET_DIRTY, SKIP_UNDO, KIGFX::PCB_VIEW::Update(), and BOARD::UpdateRatsnestExclusions().

Referenced by OpenProjectFiles(), and ResolveDRCExclusions().

◆ ResolveItem()

EDA_ITEM * PCB_BASE_FRAME::ResolveItem	(	const KIID &	aId,
		bool	aAllowNullptrReturn = false ) const

overridevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 218 of file pcb_base_frame.cpp.

References GetBoard(), and BOARD::ResolveItem().

Referenced by FocusOnItems(), PCB_EDIT_FRAME::OnCrossProbeFlashTimer(), OnFpChangeDebounceTimer(), and PCB_BASE_EDIT_FRAME::PutDataInPreviousState().

◆ RestoreAuiLayout()

void EDA_BASE_FRAME::RestoreAuiLayout ( )

inherited

Definition at line 1172 of file eda_base_frame.cpp.

References WX_AUI_JSON_SERIALIZER::Deserialize(), ADVANCED_CFG::GetCfg(), m_auiLayoutState, m_auimgr, and m_perspective.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_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 230 of file undo_redo.cpp.

References PCB_BASE_FRAME::GetCanvas(), EDA_BASE_FRAME::GetRedoCommandCount(), PCB_DRAW_PANEL_GAL::GetView(), PCB_BASE_FRAME::m_pcb, TOOLS_HOLDER::m_toolManager, PCB_BASE_FRAME::OnModify(), EDA_BASE_FRAME::PopCommandFromRedoList(), EDA_BASE_FRAME::PushCommandToUndoList(), PutDataInPreviousState(), EDA_DRAW_PANEL_GAL::Refresh(), EVENTS::SelectedItemsModified, UndoRedoBlocked(), EVENTS::UndoRedoPostEvent, EVENTS::UndoRedoPreEvent, and KIGFX::PCB_VIEW::Update().

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

References AS_GLOBAL, PCB_BASE_FRAME::GetCanvas(), EDA_BASE_FRAME::GetUndoCommandCount(), PCB_DRAW_PANEL_GAL::GetView(), PCB_BASE_FRAME::m_pcb, TOOLS_HOLDER::m_toolManager, PCB_BASE_FRAME::OnModify(), EDA_BASE_FRAME::PopCommandFromUndoList(), EDA_BASE_FRAME::PushCommandToRedoList(), PutDataInPreviousState(), EDA_DRAW_PANEL_GAL::Refresh(), EVENTS::SelectedItemsModified, TA_UNDO_REDO_POST, TA_UNDO_REDO_PRE, TC_MESSAGE, UndoRedoBlocked(), and KIGFX::PCB_VIEW::Update().

Referenced by PCB_CONTROL::Undo().

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

References ClearListAndDeleteItems(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), PCB_BASE_FRAME::m_pcb, EDA_BASE_FRAME::PopCommandFromUndoList(), PutDataInPreviousState(), EDA_DRAW_PANEL_GAL::Refresh(), undo, and KIGFX::PCB_VIEW::Update().

◆ RunActionPlugin()

void PCB_EDIT_FRAME::RunActionPlugin ( ACTION_PLUGIN * aActionPlugin )

protected

Execute action plugin's Run() method and updates undo buffer.

Parameters

aActionPlugin action plugin

Definition at line 279 of file pcbnew_action_plugins.cpp.

References _, COMMIT::Added(), CHANGED, PICKED_ITEMS_LIST::ClearItemsList(), PICKED_ITEMS_LIST::ContainsItem(), DELETED, BOARD::Drawings(), BOARD::Footprints(), PCB_BASE_FRAME::GetBoard(), PICKED_ITEMS_LIST::GetCount(), BOARD::GetItemSet(), PICKED_ITEMS_LIST::GetItemWrapper(), PICKED_ITEMS_LIST::GetPickedItem(), NEWITEM, OnModify(), EDA_BASE_FRAME::PopCommandFromUndoList(), BOARD_COMMIT::Push(), EDA_BASE_FRAME::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), RebuildAndRefresh(), COMMIT::Removed(), ACTION_PLUGIN::Run(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), ACTION_PLUGINS::SetActionRunning(), SKIP_SET_DIRTY, SKIP_UNDO, BOARD::Tracks(), and BOARD::Zones().

Referenced by OnActionPluginButton(), and OnActionPluginMenu().

◆ SaveBoard()

bool PCB_EDIT_FRAME::SaveBoard	(	bool	aSaveAs = false,
		bool	aSaveCopy = false )

Definition at line 362 of file pcbnew/files.cpp.

References AskSaveBoardFileName(), EnsureFileExtension(), PCB_BASE_FRAME::GetBoard(), PATHS::GetDefaultUserProjectsPath(), EDA_BASE_FRAME::GetMruPath(), FILEEXT::KiCadPcbFileExtension, EDA_BASE_FRAME::m_autoSaveRequired, NAMELESS_PROJECT, Prj(), SavePcbCopy(), and SavePcbFile().

Referenced by API_HANDLER_PCB::handleSaveCopyOfDocument(), and API_HANDLER_PCB::handleSaveDocument().

◆ SaveBoardAsDesignBlock()

bool PCB_EDIT_FRAME::SaveBoardAsDesignBlock ( const wxString & aLibraryName )

◆ saveBoardAsFile()

bool PCB_EDIT_FRAME::saveBoardAsFile	(	BOARD *	aBoard,
		const wxString &	aFileName,
		bool	aHeadless = false )

protected

Save a board object to a file.

Parameters

aBoard	The board object to save
aFileName	The file name to save the board to
aHeadless	If true, suppresses informational output (e.g. to be used from the API)

Returns

Definition at line 81 of file pcb_design_block_utils.cpp.

References _, DisplayError(), dummy, EDA_BASE_FRAME::IsWritable(), PCB_IO_MGR::KICAD_SEXP, PCB_IO_MGR::PluginFind(), and IO_ERROR::What().

Referenced by saveSelectionToDesignBlock().

◆ SaveBoardToDesignBlock()

bool PCB_EDIT_FRAME::SaveBoardToDesignBlock ( const LIB_ID & aLibId )

Definition at line 183 of file pcb_design_block_utils.cpp.

References _, checkOverwriteDbLayout(), PROJECT::DesignBlockLibs(), DisplayError(), DisplayErrorMessage(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), m_designBlocksPane, Prj(), DESIGN_BLOCK_LIBRARY_ADAPTER::SAVE_OK, DESIGN_BLOCK_LIBRARY_ADAPTER::SaveDesignBlock(), SavePcbCopy(), and IO_ERROR::What().

◆ SaveCanvasImageToFile()

bool EDA_DRAW_FRAME::SaveCanvasImageToFile	(	const wxString &	aFileName,
		BITMAP_TYPE	aBitmapType )

inherited

Save the current view as an image file.

Parameters

aFrame	The current draw frame view to save.
aFileName	The file name to save the image. This will overwrite an existing file.
aBitmapType	The type of bitmap create as defined by wxImage.

Returns: True if the file was successfully saved or false if the file failed to be saved.

Definition at line 1370 of file eda_draw_frame.cpp.

References BMP, GetCanvas(), image, JPG, and PNG.

Referenced by SYMBOL_EDITOR_CONTROL::ExportView(), and FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng().

◆ saveCanvasTypeSetting()

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

protectedinherited

Store the canvas type in the application settings.

Definition at line 984 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_BASE_FRAME::m_ident, and Pgm().

Referenced by ~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).

Reimplemented from PCB_BASE_FRAME.

Definition at line 173 of file undo_redo.cpp.

References PICKED_ITEMS_LIST::GetDescription(), saveCopyInUndoList(), and PICKED_ITEMS_LIST::SetDescription().

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

Reimplemented from PCB_BASE_FRAME.

Definition at line 163 of file undo_redo.cpp.

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

Referenced by PCB_EDIT_FRAME::RunActionPlugin().

◆ saveCopyInUndoList()

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

protectedinherited

◆ SavePcbCopy()

bool PCB_EDIT_FRAME::SavePcbCopy	(	const wxString &	aFileName,
		bool	aCreateProject = false,
		bool	aHeadless = false )

Write the board data structures to aFileName.

Unlike SavePcbFile, does not make anything else (no backup, broad filename change, no flag changes ...). Used under a project mgr to save under a new name the current board. When not under a project mgr, the full SavePcbFile is used.

Parameters

aFileName	The file name to write.
aCreateProject	will create an empty project alongside the board file
aHeadless	will suppress informational output (e.g. to be used from the API)

Returns: True if file was saved successfully.

Definition at line 1074 of file pcbnew/files.cpp.

References _, FILEEXT::DesignRulesFileExtension, DisplayError(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), GetSettingsManager(), EDA_BASE_FRAME::IsWritable(), PCB_IO_MGR::KICAD_SEXP, KiCopyFile(), PCB_IO_MGR::PluginFind(), FILEEXT::ProjectFileExtension, SETTINGS_MANAGER::SaveProjectCopy(), SaveProjectLocalSettings(), BOARD::SynchronizeNetsAndNetClasses(), and IO_ERROR::What().

Referenced by API_HANDLER_PCB::handleSaveCopyOfDocument(), SaveBoard(), SaveBoardAsDesignBlock(), and SaveBoardToDesignBlock().

◆ SavePcbFile()

bool PCB_EDIT_FRAME::SavePcbFile	(	const wxString &	aFileName,
		bool	addToHistory = true,
		bool	aChangeProject = true )

Write the board data structures to a aFileName.

Create a backup when requested and update flags (modified and saved flags).

Parameters

aFileName	The file name to write or wxEmptyString to prompt user for file name.
addToHistory	controls whether or not to add the saved file to the recent file list
aChangeProject	is true if the project should be changed to the new board filename

Returns: True if file was saved successfully.

Definition at line 951 of file pcbnew/files.cpp.

References _, LOCAL_HISTORY::CommitFullProjectSnapshot(), FILEEXT::DesignRulesFileExtension, DisplayError(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), WX_STRING_REPORTER::GetMessages(), PCB_BASE_FRAME::GetScreen(), GetSettingsManager(), EDA_BASE_FRAME::IsWritable(), PCB_IO_MGR::KICAD_SEXP, FILEEXT::KiCadPcbFileExtension, KiCopyFile(), Kiface(), FILEEXT::LegacyPcbFileExtension, EDA_DRAW_FRAME::LockFile(), EDA_BASE_FRAME::m_autoSavePending, EDA_BASE_FRAME::m_autoSaveRequired, EDA_BASE_FRAME::m_autoSaveTimer, EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::OUTDATED_SAVE, PCB_IO_MGR::PluginFind(), Prj(), FILEEXT::ProjectFileExtension, WX_FILENAME::ResolvePossibleSymlinks(), SETTINGS_MANAGER::SaveProject(), SETTINGS_MANAGER::SaveProjectAs(), saveProjectSettings(), BASE_SCREEN::SetContentModified(), BOARD::SetFileName(), PROJECT::SetReadOnly(), BOARD::SynchronizeNetsAndNetClasses(), BOARD::SynchronizeProperties(), LOCAL_HISTORY::TagSave(), EDA_BASE_FRAME::UpdateFileHistory(), PCB_BASE_FRAME::UpdateStatusBar(), UpdateTitle(), and IO_ERROR::What().

Referenced by OpenProjectFiles(), and SaveBoard().

◆ SaveProjectLocalSettings()

void PCB_EDIT_FRAME::SaveProjectLocalSettings ( )

overridevirtual

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.

The below automatically saves the project on exit, which is what we want to do if the project already exists. If the project doesn't already exist, we don't want to create it through this function call, because this will happen automatically when the user exits even if they didn't save a new board with a valid filename (usually an imported board).

The explicit save action in PCB_EDIT_FRAME::SavePcbFile will call SaveProject directly, so if the user does choose to save the board, the project file will get created then.

Reimplemented from EDA_BASE_FRAME.

Definition at line 141 of file pcbnew_config.cpp.

References color, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), KIGFX::PCB_RENDER_SETTINGS::GetNetColorMap(), BOARD::GetNetInfo(), NETINFO_LIST::GetNetItem(), KIGFX::VIEW::GetPainter(), PROJECT::GetProjectFile(), PROJECT::GetProjectFullName(), KIGFX::PAINTER::GetSettings(), GetSettingsManager(), PCB_DRAW_PANEL_GAL::GetView(), PCB_BASE_EDIT_FRAME::m_appearancePanel, BASE_SCREEN::m_DrawingSheetFileName, Prj(), project, BOARD::RecordDRCExclusions(), SETTINGS_MANAGER::SaveProject(), and saveProjectSettings().

Referenced by doCloseWindow(), OpenProjectFiles(), and SavePcbCopy().

◆ saveProjectSettings()

void PCB_EDIT_FRAME::saveProjectSettings ( )

overrideprotectedvirtual

Save 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 from EDA_BASE_FRAME.

Definition at line 196 of file pcbnew_config.cpp.

Referenced by SavePcbFile(), and SaveProjectLocalSettings().

◆ SaveSelectionAsDesignBlock()

bool PCB_EDIT_FRAME::SaveSelectionAsDesignBlock ( const wxString & aLibraryName )

Definition at line 347 of file pcb_design_block_utils.cpp.

References _, checkOverwriteDb(), DisplayErrorMessage(), SELECTION::Empty(), PCB_BASE_FRAME::GetBoard(), DESIGN_BLOCK::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), m_designBlocksPane, TOOLS_HOLDER::m_toolManager, Prj(), saveSelectionToDesignBlock(), DESIGN_BLOCK::SetLibId(), and DIALOG_SHIM::ShowModal().

◆ SaveSelectionToDesignBlock()

bool PCB_EDIT_FRAME::SaveSelectionToDesignBlock ( const LIB_ID & aLibId )

◆ saveSelectionToDesignBlock()

bool PCB_EDIT_FRAME::saveSelectionToDesignBlock	(	const wxString &	aNickname,
		PCB_SELECTION &	aSelection,
		DESIGN_BLOCK &	aBlock )

protected

◆ SaveSettings()

void PCB_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 1605 of file pcb_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 1017 of file eda_base_frame.cpp.

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

Referenced by SaveSettings().

◆ ScriptingConsoleEnableDisable()

void EDA_DRAW_FRAME::ScriptingConsoleEnableDisable ( )

inherited

Toggle the scripting console visibility.

Definition at line 268 of file eda_draw_frame.cpp.

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

◆ SearchPaneName()

static const wxString PCB_EDIT_FRAME::SearchPaneName ( )

inlinestatic

Returns: the name of the wxAuiPaneInfo managing the Search panel

Definition at line 147 of file pcb_edit_frame.h.

Referenced by IsSearchPaneShown(), SaveSettings(), setupUIConditions(), and ToggleSearch().

◆ SelectFootprintFromLibrary()

FOOTPRINT * PCB_BASE_FRAME::SelectFootprintFromLibrary ( 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 188 of file load_select_footprint.cpp.

References AddFootprintToHistory(), LIB_ID::Format(), FRAME_FOOTPRINT_CHOOSER, LIB_ID::IsValid(), Kiway, KIWAY_PLAYER::KIWAY_PLAYER(), loadFootprint(), LIB_ID::Parse(), and UTF8::wx_str().

◆ SelectLeftToolbarAction()

void EDA_BASE_FRAME::SelectLeftToolbarAction ( const TOOL_ACTION & aAction )

inlineinherited

Select the given action in the left toolbar group which contains it, if any.

This updates the displayed icon/tooltip and UI conditions for that group.

Definition at line 207 of file eda_base_frame.h.

References m_tbLeft.

Referenced by BOARD_EDITOR_CONTROL::OnAngleSnapModeChanged(), and FOOTPRINT_EDITOR_CONTROL::OnAngleSnapModeChanged().

◆ SelectLibrary()

wxString PCB_BASE_EDIT_FRAME::SelectLibrary	(	const wxString &	aDialogTitle,
		const wxString &	aListLabel,
		const std::vector< std::pair< wxString, bool * > > &	aExtraCheckboxes = {} )

inherited

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

Parameters

aDialogTitle	title for the dialog window
aListLabel	label for the list of libraries
aExtraCheckboxes	[optional] list of label/valuePointer pairs from which to construct extra checkboxes in the dialog. Values are written back to the pointers when the dialog is finished.

Returns: the library or wxEmptyString on abort.

Definition at line 419 of file footprint_libraries_utils.cpp.

References _, EDA_LIST_DIALOG::AddExtraCheckbox(), CreateNewLibrary(), EDA_LIST_DIALOG::GetExtraCheckboxValues(), PCB_BASE_FRAME::GetLibraryItemsForListDialog(), PROJECT::GetRString(), EDA_LIST_DIALOG::GetTextSelection(), ID_MAKE_NEW_LIBRARY, EDA_LIST_DIALOG_BASE::m_ButtonsSizer, PROJECT::PCB_LIB_NICKNAME, PROJECT::PCB_LIB_PATH, Prj(), EDA_LIST_DIALOG::SetListLabel(), PROJECT::SetRString(), and DIALOG_SHIM::ShowModal().

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary().

◆ SelectOneLayer()

PCB_LAYER_ID PCB_BASE_FRAME::SelectOneLayer	(	PCB_LAYER_ID	aDefaultLayer,
		const 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 300 of file sel_layer.cpp.

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

◆ SendCrossProbeItem()

void PCB_EDIT_FRAME::SendCrossProbeItem ( BOARD_ITEM * aSyncItem )

Send a message to the schematic editor so that it may move its cursor to an item with the same reference as the aSyncItem and highlight it.

Parameters

aSyncItem The object whose reference is used to highlight in Eeschema.

Definition at line 416 of file pcbnew/cross-probing.cpp.

References KIWAY::ExpressMail(), FormatProbeItem(), FRAME_SCH, Kiface(), Kiway, MAIL_CROSS_PROBE, MSG_TO_SCH, and SendCommand().

◆ SendCrossProbeNetName()

void PCB_EDIT_FRAME::SendCrossProbeNetName ( const wxString & aNetName )

Send a net name to Eeschema for highlighting.

Parameters

aNetName is the name of a net, or empty string to clear highlight.

Definition at line 395 of file pcbnew/cross-probing.cpp.

References KIWAY::ExpressMail(), FRAME_SCH, Kiface(), Kiway, MAIL_CROSS_PROBE, MSG_TO_SCH, SendCommand(), StrPrintf(), and TO_UTF8.

◆ SendSelectItemsToSch()

void PCB_EDIT_FRAME::SendSelectItemsToSch	(	const std::deque< EDA_ITEM * > &	aItems,
		EDA_ITEM *	aFocusItem,
		bool	aForce )

Send a message to the schematic editor to try to find schematic counterparts of specified PCB items and select them.

Parameters

aItems	are the items to try to select on schematic.
aFocusItem	set to item to select and focus on even if selection can't be represented in Schematic editor fully.
aForce	select elements in Schematic editor whether or not the user has the select option chosen.

Definition at line 339 of file pcbnew/cross-probing.cpp.

References collectItemsForSyncParts(), KIWAY::ExpressMail(), FRAME_SCH, Kiface(), Kiway, MAIL_SELECTION, MAIL_SELECTION_FORCE, MSG_TO_SCH, and SendCommand().

◆ SetActiveLayer() [1/2]

void PCB_EDIT_FRAME::SetActiveLayer ( PCB_LAYER_ID aLayer )

inlineoverridevirtual

Change the currently active layer to aLayer and also update the APPEARANCE_CONTROLS.

Reimplemented from PCB_BASE_FRAME.

Definition at line 269 of file pcb_edit_frame.h.

References SetActiveLayer().

Referenced by API_HANDLER_PCB::handleSetActiveLayer(), OnBoardLoaded(), ROUTER_TOOL::performRouting(), ROUTER_TOOL::prepareInteractive(), SetActiveLayer(), SwitchLayer(), and UpdateUserInterface().

◆ SetActiveLayer() [2/2]

void PCB_EDIT_FRAME::SetActiveLayer	(	PCB_LAYER_ID	aLayer,
		bool	aForceRedraw )

Parameters

aLayer	is the layer to set active
aForceRedraw	will repaint things that depend on layer switch even if the new active layer is the same as the previous one

Definition at line 1685 of file pcb_edit_frame.cpp.

References KIGFX::ALL, BLIND, BURIED, CLEARANCE_LAYER_FOR, PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetDisplayOptions(), PCB_DRAW_PANEL_GAL::GetView(), HIDDEN, KIGFX::VIEW_ITEM::IsBOARD_ITEM(), IsCopperLayer(), BOARD_ITEM::IsOnLayer(), PCB_ACTIONS::layerChanged, PCB_BASE_EDIT_FRAME::m_appearancePanel, TOOLS_HOLDER::m_toolManager, MICROVIA, pad, PCB_PAD_T, PCB_VIA_T, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, PCB_BASE_FRAME::SetActiveLayer(), EDA_DRAW_PANEL_GAL::SetFocus(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), KIGFX::VIEW::SetLayerVisible(), EDA_ITEM::Type(), KIGFX::VIEW::UpdateAllItemsConditionally(), and via.

◆ SetBoard() [1/2]

void PCB_EDIT_FRAME::SetBoard	(	BOARD *	aBoard,
		bool	aBuildConnectivity,
		PROGRESS_REPORTER *	aReporter = nullptr )

Returns: the primary data model.

Definition at line 721 of file pcb_edit_frame.cpp.

References BOARD::BuildConnectivity(), BOARD::GetPageSettings(), PCB_BASE_FRAME::m_pcb, Prj(), PCB_BASE_EDIT_FRAME::SetBoard(), SetPageSettings(), and BOARD::SetProject().

◆ SetBoard() [2/2]

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

inlineoverridevirtual

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

Reimplemented from PCB_BASE_EDIT_FRAME.

Definition at line 400 of file pcb_edit_frame.h.

References SetBoard().

Referenced by Clear_Pcb(), OpenProjectFiles(), and SetBoard().

◆ SetCanvas()

void EDA_DRAW_FRAME::SetCanvas ( EDA_DRAW_PANEL_GAL * aPanel )

inlineinherited

Definition at line 467 of file eda_draw_frame.h.

References m_canvas.

Referenced by SCH_BASE_FRAME::createCanvas(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), and PL_EDITOR_FRAME::PL_EDITOR_FRAME().

◆ SetDisplayOptions()

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

inherited

Update the current display options.

Parameters

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

Definition at line 1023 of file pcb_base_frame.cpp.

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

Referenced by API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), and DISPLAY_FOOTPRINTS_FRAME::LoadSettings().

◆ SetDrawBgColor()

void PCB_BASE_FRAME::SetDrawBgColor ( const COLOR4D & aColor )

overridevirtualinherited

Reimplemented from EDA_DRAW_FRAME.

Definition at line 530 of file pcb_base_frame.cpp.

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

◆ SetElementVisibility()

void PCB_EDIT_FRAME::SetElementVisibility	(	GAL_LAYER_ID	aElement,
		bool	aNewState )

Change the visibility of an element category.

Parameters

aElement	is from the enum by the same name.
aNewState	The new visibility state of the element category.

See also: enum PCB_LAYER_ID.

Definition at line 1874 of file pcb_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), LAYER_RATSNEST, BOARD::SetElementVisibility(), and KIGFX::VIEW::SetLayerVisible().

Referenced by CommonSettingsChanged(), and OnBoardLoaded().

◆ setFPWatcher()

void PCB_BASE_FRAME::setFPWatcher ( FOOTPRINT * aFootprint )

protectedinherited

Create or removes a watcher on the specified footprint.

Parameters

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

Definition at line 1077 of file pcb_base_frame.cpp.

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

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

◆ SetGridColor()

void PCB_EDIT_FRAME::SetGridColor ( const COLOR4D & aColor )

overridevirtual

Parameters

[in] aColor the new color of the grid.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1677 of file pcb_edit_frame.cpp.

References PCB_BASE_FRAME::GetCanvas(), PCB_BASE_EDIT_FRAME::GetColorSettings(), EDA_DRAW_PANEL_GAL::GetGAL(), LAYER_GRID, COLOR_SETTINGS::SetColor(), and KIGFX::GAL::SetGridColor().

◆ SetGridOrigin()

void PCB_BASE_FRAME::SetGridOrigin ( const VECTOR2I & aPoint )

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 479 of file pcb_base_frame.cpp.

References m_pcb.

◆ SetGridOverrides()

void EDA_DRAW_FRAME::SetGridOverrides ( bool aOverride )

virtualinherited

Definition at line 569 of file eda_draw_frame.cpp.

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

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

References LAYER_GRID, m_appearancePanel, and EDA_DRAW_FRAME::SetGridVisibility().

◆ 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(), m_kiway, and name.

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

◆ SetLastPath()

void PCB_EDIT_FRAME::SetLastPath	(	LAST_PATH_TYPE	aType,
		const wxString &	aLastPath )

Set the path of the last file successfully read.

Note: the file path is converted to a path relative to the project file path. If the path cannot be made relative, than m_lastNetListRead is set to and empty string. This could happen when the net list file is on a different drive than the project file. The advantage of relative paths is that is more likely to work when opening the same project from both Windows and Linux.

Parameters

aLastPath - The last file with full path successfully read.

Definition at line 1916 of file pcb_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), PROJECT::GetProjectFile(), OnModify(), Prj(), and project.

Referenced by InstallNetlistFrame(), and ReadNetlistFromFile().

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool aIsModal )

inlineinherited

Definition at line 155 of file kiway_player.h.

References m_modal.

Referenced by FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), and SYMBOL_CHOOSER_FRAME::SYMBOL_CHOOSER_FRAME().

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString & aPath )

inlineinherited

Definition at line 437 of file eda_base_frame.h.

References m_mruPath.

Referenced by AskLoadBoardFileName(), 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 888 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing, and m_messagePanel.

Referenced by PCB_BASE_FRAME::Compile_Ratsnest(), PCB_BASE_FRAME::CreateNewFootprint(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::HardRedraw(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), SCH_EDIT_FRAME::LoadSheetFromFile(), PCB_EDIT_FRAME::OnBoardLoaded(), PCB_EDIT_FRAME::OnNetlistChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), BOARD_COMMIT::Push(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SetMsgPanel(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_EDIT_FRAME::UpdateMsgPanel(), FOOTPRINT_VIEWER_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), and PL_EDITOR_FRAME::UpdateMsgPanelInfo().

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

References EDA_BASE_FRAME::m_isClosing, and m_messagePanel.

◆ SetMsgPanel() [3/3]

void EDA_DRAW_FRAME::SetMsgPanel ( EDA_ITEM * aItem )

inherited

Definition at line 911 of file eda_draw_frame.cpp.

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

◆ SetObjectVisible()

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

inherited

Definition at line 273 of file pcb_base_edit_frame.cpp.

References m_appearancePanel.

◆ SetPageSettings()

void PCB_EDIT_FRAME::SetPageSettings ( const PAGE_INFO & aPageSettings )

overridevirtual

◆ SetPlotSettings()

void PCB_BASE_FRAME::SetPlotSettings ( const PCB_PLOT_PARAMS & aSettings )

virtualinherited

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 543 of file pcb_base_frame.cpp.

References KIGFX::ALL, B_Mask, F_Mask, GetBoard(), GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), BOARD::GetVisibleLayers(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), m_pcb, PCB_VIA_T, EDA_DRAW_PANEL_GAL::Refresh(), EDA_ITEM::Type(), and KIGFX::VIEW::UpdateAllItemsConditionally().

◆ SetScreen()

virtual void EDA_DRAW_FRAME::SetScreen ( BASE_SCREEN * aScreen )

inlineprotectedvirtualinherited

Reimplemented in SCH_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 548 of file eda_draw_frame.h.

References m_currentScreen, and SetScreen().

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), SCH_EDIT_FRAME::DisplayCurrentSheet(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SetScreen(), 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 134 of file eda_draw_frame.h.

References m_polarCoords.

◆ SetTitleBlock()

void PCB_BASE_FRAME::SetTitleBlock ( const TITLE_BLOCK & aTitleBlock )

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 518 of file pcb_base_frame.cpp.

References m_pcb.

◆ SetTrackSegmentWidth()

void PCB_EDIT_FRAME::SetTrackSegmentWidth	(	PCB_TRACK *	aItem,
		PICKED_ITEMS_LIST *	aItemsListPicker,
		bool	aUseDesignRules )

Modify one track segment width or one via diameter (using DRC control).

Basic routine used by other routines when editing tracks or vias. Note that casting this to boolean will allow you to determine whether any action happened.

Parameters

aItem	the track segment or via to modify.
aItemsListPicker	the list picker to use for an undo command (can be NULL).
aUseDesignRules	true to use design rules value, false to use current designSettings value.

Definition at line 33 of file edit_track_width.cpp.

References CHANGED, PCB_TRACK::Clone(), BOARD_DESIGN_SETTINGS::GetCurrentTrackWidth(), BOARD_DESIGN_SETTINGS::GetCurrentViaDrill(), BOARD_DESIGN_SETTINGS::GetCurrentViaSize(), PCB_BASE_FRAME::GetDesignSettings(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), NETCLASS::GetuViaDiameter(), NETCLASS::GetuViaDrill(), PCB_TRACK::GetWidth(), PCB_TRACK::GetWidthConstraint(), MINOPTMAX< T >::HasOpt(), MICROVIA, MINOPTMAX< T >::Min(), MINOPTMAX< T >::Opt(), PICKED_ITEMS_LIST::PushItem(), ITEM_PICKER::SetLink(), PCB_TRACK::SetWidth(), and via.

◆ setupTools()

void PCB_EDIT_FRAME::setupTools ( )

protected

Definition at line 835 of file pcb_edit_frame.cpp.

References config, PCB_BASE_FRAME::GetCanvas(), TOOLS_HOLDER::m_actions, PCB_BASE_FRAME::m_pcb, TOOLS_HOLDER::m_toolDispatcher, and TOOLS_HOLDER::m_toolManager.

◆ setupUIConditions()

void PCB_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 890 of file pcb_edit_frame.cpp.

References PCB_ACTIONS::autoTrackWidth, EDITOR_CONDITIONS::BoundingBoxes(), CHECK, GAL_SET::Contains(), ACTIONS::copy, SELECTION_CONDITIONS::Count(), PCB_ACTIONS::createArray, CURRENT_EDIT_TOOL, CURRENT_TOOL, ACTIONS::cut, ACTIONS::deleteTool, PCB_ACTIONS::deselectNet, EDA_DRAW_FRAME::DesignBlocksPaneName(), ACTIONS::doDelete, PCB_ACTIONS::drawAlignedDimension, PCB_ACTIONS::drawArc, PCB_ACTIONS::drawBezier, 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::drawSimilarZone, PCB_ACTIONS::drawTable, PCB_ACTIONS::drawTextBox, PCB_ACTIONS::drawVia, PCB_ACTIONS::drawZone, PCB_ACTIONS::drawZoneCutout, PCB_ACTIONS::drillOrigin, ACTIONS::duplicate, ACTIONS::embeddedFiles, ENABLE, PCB_ACTIONS::flipBoard, footprintTypes, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetDesignSettings(), PCB_BASE_FRAME::GetDisplayOptions(), DRAWING_TOOL::GetDrawingMode(), KIGFX::RENDER_SETTINGS::GetHighlightNetCodes(), KIGFX::VIEW::GetPainter(), PCB_BASE_FRAME::GetPcbNewSettings(), ROUTER_TOOL::GetRouterMode(), KIGFX::PAINTER::GetSettings(), EDA_BASE_FRAME::GetUndoCommandCount(), PCB_DRAW_PANEL_GAL::GetView(), BOARD::GetVisibleElements(), PCB_EDITOR_CONDITIONS::GraphicsFillDisplay(), PCB_ACTIONS::graphicsOutlines, EDITOR_CONDITIONS::GridOverrides(), ACTIONS::gridSetOrigin, EDITOR_CONDITIONS::GridVisible(), ACTIONS::group, group, groupTypes, PCB_EDITOR_CONDITIONS::HasItems(), PCB_SELECTION_CONDITIONS::HasLockedItems(), SELECTION_CONDITIONS::HasTypes(), PCB_SELECTION_CONDITIONS::HasUnlockedItems(), PCB_ACTIONS::hideNetInRatsnest, ACTIONS::highContrastMode, PCB_ACTIONS::highlightNet, PCB_ACTIONS::highlightNetSelection, SELECTION_CONDITIONS::Idle(), DRC_TOOL::IsDRCRunning(), BOARD::IsEmpty(), KIGFX::VIEW::IsMirroredX(), BOARD_INSPECTION_TOOL::IsNetHighlightSet(), KEEP_CENTER_ADJUST_ANGLE_RADIUS, KEEP_CENTER_ENDS_ADJUST_ANGLE, KEEP_ENDPOINTS_OR_START_DIRECTION, LAYER_ZONES, LayerManagerShown(), PCB_ACTIONS::localRatsnestTool, PCB_ACTIONS::lock, PCBNEW_SETTINGS::m_ArcEditMode, EDA_BASE_FRAME::m_auimgr, PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, PCBNEW_SETTINGS::m_Display, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_DisplayRatsnestLinesCurved, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_ShowGlobalRatsnest, TOOLS_HOLDER::m_toolManager, BOARD_DESIGN_SETTINGS::m_UseConnectedTrackWidth, PCB_DISPLAY_OPTIONS::m_ZoneOpacity, ACTIONS::measureTool, PCB_ACTIONS::microwaveCreateFunctionShape, PCB_ACTIONS::microwaveCreateGap, PCB_ACTIONS::microwaveCreateLine, PCB_ACTIONS::microwaveCreateStub, PCB_ACTIONS::microwaveCreateStubArc, SELECTION_CONDITIONS::MoreThan(), NetInspectorShown(), EDITOR_CONDITIONS::NoActiveTool(), DRAWING_TOOL::NONE, NORMAL, SELECTION_CONDITIONS::NotEmpty(), SELECTION_CONDITIONS::OnlyTypes(), PCB_ACTIONS::padDisplayMode, PCB_EDITOR_CONDITIONS::PadFillDisplay(), ACTIONS::paste, ACTIONS::pasteSpecial, PCB_ARC_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, PCB_ACTIONS::placeDesignBlock, PCB_ACTIONS::placeFootprint, PCB_ACTIONS::placeLinkedDesignBlock, PCB_ACTIONS::placePoint, PCB_ACTIONS::placeReferenceImage, PCB_ACTIONS::placeText, ACTIONS::pointEditorArcKeepCenter, ACTIONS::pointEditorArcKeepEndpoint, ACTIONS::pointEditorArcKeepRadius, EDITOR_CONDITIONS::PolarCoordinates(), PropertiesShown(), PCB_ACTIONS::ratsnestLineMode, ACTIONS::redo, EDITOR_CONDITIONS::RedoAvailable(), PNS::RM_MarkObstacles, PNS::RM_Shove, PNS::RM_Walkaround, PCB_ACTIONS::routeDiffPair, PCB_ACTIONS::routerHighlightMode, PCB_ACTIONS::routerShoveMode, PCB_ACTIONS::routerWalkaroundMode, PCB_ACTIONS::routeSingleTrack, ROUTER_TOOL::RoutingInProgress(), ACTIONS::save, PCB_ACTIONS::saveBoardAsDesignBlock, PCB_ACTIONS::saveSelectionAsDesignBlock, PCB_ACTIONS::saveToLinkedDesignBlock, EDITOR_CONDITIONS::ScriptingConsoleVisible(), SearchPaneName(), ACTIONS::selectAll, ACTIONS::selectionTool, PCB_ACTIONS::selectNet, PCB_ACTIONS::selectOnSchematic, PCB_ACTIONS::selectSameSheet, PCB_ACTIONS::selectUnconnected, ACTION_MANAGER::SetConditions(), EDA_BASE_FRAME::setupUIConditions(), SHOW_FILLED, SHOW_FRACTURE_BORDERS, SHOW_TRIANGULATION, SHOW_ZONE_OUTLINE, SELECTION_CONDITIONS::ShowAlways(), PCB_ACTIONS::showDesignBlockPanel, PCB_ACTIONS::showLayersManager, PCB_ACTIONS::showNetInRatsnest, PCB_ACTIONS::showNetInspector, ACTIONS::showProperties, PCB_ACTIONS::showPythonConsole, PCB_ACTIONS::showRatsnest, ACTIONS::showSearch, PCB_EDITOR_CONDITIONS::TextFillDisplay(), PCB_ACTIONS::textOutlines, ACTIONS::toggleBoundingBoxes, ACTIONS::toggleGrid, ACTIONS::toggleGridOverrides, PCB_ACTIONS::toggleNetHighlight, ACTIONS::togglePolarCoords, PCB_ACTIONS::trackDisplayMode, PCB_EDITOR_CONDITIONS::TrackFillDisplay(), trackTypes, PCB_ACTIONS::tuneDiffPair, PCB_ACTIONS::tuneSingleTrack, PCB_ACTIONS::tuneSkew, ACTIONS::undo, ACTIONS::ungroup, PCB_ACTIONS::unlock, ACTIONS::unselectAll, PCB_ACTIONS::viaDisplayMode, PCB_EDITOR_CONDITIONS::ViaFillDisplay(), PCB_ACTIONS::zoneDisplayFilled, PCB_ACTIONS::zoneDisplayFractured, PCB_EDITOR_CONDITIONS::ZoneDisplayMode(), PCB_ACTIONS::zoneDisplayOutline, PCB_ACTIONS::zoneDisplayTriangulated, PCB_ACTIONS::zoneDuplicate, PCB_ACTIONS::zoneMerge, and ACTIONS::zoomTool.

◆ setupUnits()

void EDA_DRAW_FRAME::setupUnits ( APP_SETTINGS_BASE * aCfg )

protectedinherited

◆ SetUserUnits()

void UNITS_PROVIDER::SetUserUnits ( EDA_UNITS aUnits )

inlineinherited

Definition at line 46 of file units_provider.h.

References m_userUnits.

Referenced by EDA_BASE_FRAME::ChangeUserUnits(), PCB::IFACE::CreateKiWindow(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), IfaceOrAddress(), EDA_DRAW_FRAME::LoadSettings(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), DRC_ENGINE::RunTests(), DRC_TEST_PROVIDER::RunTests(), SaveFileAs(), and EDA_DRAW_FRAME::ToggleUserUnits().

◆ ShowBarcodePropertiesDialog()

void PCB_BASE_EDIT_FRAME::ShowBarcodePropertiesDialog ( PCB_BARCODE * aText )

inherited

Definition at line 341 of file dialog_barcode_properties.cpp.

References DIALOG_SHIM::ShowModal().

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

◆ ShowBoardSetupDialog()

void PCB_EDIT_FRAME::ShowBoardSetupDialog	(	const wxString &	aInitialPage = wxEmptyString,
		wxWindow *	aParent = nullptr )

Definition at line 1465 of file pcb_edit_frame.cpp.

References _, KIGFX::ALL, AS_ACTIVE, B_Mask, B_Paste, BOARD::BuildListOfNets(), KIWAY::CommonSettingsChanged(), F_Mask, F_Paste, WX_INFOBAR::GENERIC, KIGFX::GEOMETRY, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetPcbNewSettings(), PCB_DRAW_PANEL_GAL::GetView(), PROJECT::IncrementNetclassesTicker(), PROJECT::IncrementTextVarsTicker(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), Kiway, m_boardSetupDlg, PCBNEW_SETTINGS::m_Display, EDA_BASE_FRAME::m_infoBar, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_PadClearance, TOOLS_HOLDER::m_toolManager, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_TrackClearance, TOOL_BASE::MODEL_RELOAD, OnModify(), PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, Prj(), EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar(), EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, EDA_DRAW_PANEL_GAL::SetFocus(), TOOL_EVENT::SetHasPosition(), PAGED_DIALOG::SetInitialPage(), SHOW_WITH_VIA_ALWAYS, DIALOG_SHIM::ShowQuasiModal(), BOARD::SynchronizeNetsAndNetClasses(), BOARD::SynchronizeTuningProfileProperties(), TA_MODEL_CHANGE, TC_COMMAND, text, TEXTVARS_CHANGED, EDA_ITEM::Type(), KIGFX::VIEW::UpdateAllItemsConditionally(), and UpdateUserInterface().

Referenced by CommonSettingsChanged(), ExecuteRemoteCommand(), DIALOG_PLOT::onBoardSetup(), and Tracks_and_Vias_Size_Event().

◆ ShowChangedLanguage()

void PCB_EDIT_FRAME::ShowChangedLanguage ( )

overridevirtual

Redraw the menus and what not in current language.

Reimplemented from PCB_BASE_FRAME.

Definition at line 1886 of file pcb_edit_frame.cpp.

References _, PCB_BASE_EDIT_FRAME::m_appearancePanel, EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_netInspectorPanel, EDA_DRAW_FRAME::m_propertiesPanel, PCB_BASE_EDIT_FRAME::m_selectionFilterPanel, EDA_BASE_FRAME::ShowChangedLanguage(), and UpdateTitle().

◆ ShowExchangeFootprintsDialog()

int PCB_EDIT_FRAME::ShowExchangeFootprintsDialog	(	FOOTPRINT *	aFootprint,
		bool	aUpdateMode,
		bool	aSelectedMode )

Definition at line 2292 of file pcb_edit_frame.cpp.

References DIALOG_SHIM::ShowQuasiModal().

Referenced by ShowFootprintPropertiesDialog().

◆ ShowFindDialog()

void PCB_EDIT_FRAME::ShowFindDialog ( )

Show the Find dialog.

Definition at line 2045 of file pcb_edit_frame.cpp.

References PCB_SELECTION_TOOL::FindItem(), SELECTION::Front(), m_findDialog, TOOLS_HOLDER::m_toolManager, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_TEXT_T, SELECTION::Size(), EDA_ITEM::Type(), and UnescapeString().

Referenced by FindNext().

◆ ShowFootprintPropertiesDialog()

void PCB_EDIT_FRAME::ShowFootprintPropertiesDialog ( FOOTPRINT * aFootprint )

Definition at line 2225 of file pcb_edit_frame.cpp.

References DIALOG_FOOTPRINT_PROPERTIES::FP_PROPS_CHANGE_FP, DIALOG_FOOTPRINT_PROPERTIES::FP_PROPS_EDIT_BOARD_FP, DIALOG_FOOTPRINT_PROPERTIES::FP_PROPS_EDIT_LIBRARY_FP, DIALOG_FOOTPRINT_PROPERTIES::FP_PROPS_OK, DIALOG_FOOTPRINT_PROPERTIES::FP_PROPS_UPDATE_FP, FRAME_FOOTPRINT_EDITOR, PCB_BASE_FRAME::GetCanvas(), FOOTPRINT::GetFPID(), DIALOG_FOOTPRINT_PROPERTIES::GetReturnValue(), Kiway, FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EDA_DRAW_PANEL_GAL::Refresh(), ShowExchangeFootprintsDialog(), and DIALOG_SHIM::ShowQuasiModal().

Referenced by OnEditItemRequest().

◆ ShowGraphicItemPropertiesDialog()

void PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog ( PCB_SHAPE * aShape )

inherited

Definition at line 1049 of file pcbnew/dialogs/dialog_shape_properties.cpp.

References PCB_BASE_FRAME::GetActiveLayer(), PCB_SHAPE::GetStroke(), PCB_SHAPE::IsOnLayer(), TOOLS_HOLDER::m_toolManager, DRAWING_TOOL::SetStroke(), and DIALOG_SHIM::ShowQuasiModal().

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

◆ ShowInfoBarError() [1/2]

void EDA_BASE_FRAME::ShowInfoBarError	(	const wxString &	aErrorMsg,
		bool	aShowCloseButton,
		std::function< void(void)>	aCallback )

inherited

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.

The infobar will be closed after a timeout.

This version accepts a callback which will be called when the infobar is dismissed (either as a result of user action or a timeout). This can be useful when the caller wants to make other decorations in the canvas to highlight the error.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.
aCallback	a callback to be called when the infobar is dismissed.

Definition at line 1208 of file eda_base_frame.cpp.

References GetInfoBar(), m_infoBar, and WX_INFOBAR::ShowMessageFor().

◆ ShowInfoBarError() [2/2]

void EDA_BASE_FRAME::ShowInfoBarError	(	const wxString &	aErrorMsg,
		bool	aShowCloseButton = false,
		WX_INFOBAR::MESSAGE_TYPE	aType = WX_INFOBAR::MESSAGE_TYPE::GENERIC )

inherited

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.

The infobar will be closed after a timeout.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 1196 of file eda_base_frame.cpp.

References GetInfoBar(), m_infoBar, and WX_INFOBAR::ShowMessageFor().

Referenced by MICROWAVE_TOOL::createInductorBetween(), PCB_BASE_EDIT_FRAME::createNewLibrary(), MICROWAVE_TOOL::createPolygonShape(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), EDIT_TOOL::DeleteItems(), SYMBOL_EDIT_FRAME::ExportSymbol(), PCB_EDIT_FRAME::LoadDrawingSheet(), SCH_EDIT_FRAME::LoadDrawingSheet(), ROUTER_TOOL::prepareInteractive(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), and SYMBOL_EDIT_FRAME::saveLibrary().

◆ ShowInfoBarMsg()

void EDA_BASE_FRAME::ShowInfoBarMsg	(	const wxString &	aMsg,
		bool	aShowCloseButton = false )

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 1234 of file eda_base_frame.cpp.

References GetInfoBar(), m_infoBar, and WX_INFOBAR::ShowMessageFor().

◆ ShowInfoBarWarning()

void EDA_BASE_FRAME::ShowInfoBarWarning	(	const wxString &	aWarningMsg,
		bool	aShowCloseButton = false )

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 1223 of file eda_base_frame.cpp.

References GetInfoBar(), m_infoBar, and WX_INFOBAR::ShowMessageFor().

◆ ShowModal()

bool KIWAY_PLAYER::ShowModal	(	wxString *	aResult = nullptr,
		wxWindow *	aResultantFocusWindow = nullptr )

virtualinherited

Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal().

This is behavior is similar to a modal dialog window. Not all KIWAY_PLAYERs use this interface, so don't call this unless the implementation knows how to call DismissModal() on a button click or double click or some special event which ends the modal behavior.

Parameters

aResult	if not NULL, indicates a place to put a resultant string.
aResultantFocusWindow	if not NULL, indicates what window to pass focus to on return.

Returns: true if frame implementation called KIWAY_PLAYER::DismissModal() with aRetVal of true.

Reimplemented in FOOTPRINT_CHOOSER_FRAME, and SYMBOL_CHOOSER_FRAME.

Definition at line 95 of file kiway_player.cpp.

References IsModal(), m_modal_loop, m_modal_resultant_parent, m_modal_ret_val, and m_modal_string.

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_CHOOSER_FRAME::ShowModal(), and SYMBOL_CHOOSER_FRAME::ShowModal().

◆ ShowPadPropertiesDialog()

void PCB_BASE_FRAME::ShowPadPropertiesDialog ( PAD * aPad )

inherited

Definition at line 110 of file dialog_pad_properties.cpp.

References DIALOG_SHIM::ShowQuasiModal().

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

◆ ShowPreferences()

void EDA_BASE_FRAME::ShowPreferences	(	wxString	aStartPage,
		wxString	aStartParentPage )

inherited

Display the preferences and settings of all opened editors paged dialog, starting with a particular page.

Definition at line 1331 of file eda_base_frame.cpp.

References _, PANEL_HOTKEYS_EDITOR::ActionsList(), WX_TREEBOOK::AddLazyPage(), WX_TREEBOOK::AddLazySubPage(), KIWAY::CommonSettingsChanged(), KIWAY::FACE_GERBVIEW, KIWAY::FACE_PCB, KIWAY::FACE_PL_EDITOR, KIWAY::FACE_SCH, FRAME_FOOTPRINT_EDITOR, FRAME_GERBER, FRAME_PCB_DISPLAY3D, FRAME_PCB_EDITOR, FRAME_PL_EDITOR, FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, ACTION_MANAGER::GetActions(), ADVANCED_CFG::GetCfg(), GetFrameType(), PGM_BASE::GetSettingsManager(), PAGED_DIALOG::GetTreebook(), HOTKEYS_CHANGED, KICAD_MANAGER_FRAME_NAME, kiface(), KIWAY_HOLDER::Kiway(), LAZY_CTOR, TOOLS_HOLDER::m_toolManager, name, PANEL_3DV_DISPLAY_OPTIONS, PANEL_3DV_OPENGL, PANEL_3DV_RAYTRACING, PANEL_3DV_TOOLBARS, PANEL_DS_COLORS, PANEL_DS_DISPLAY_OPTIONS, PANEL_DS_GRIDS, PANEL_DS_TOOLBARS, PANEL_FP_COLORS, PANEL_FP_DEFAULT_FIELDS, PANEL_FP_DEFAULT_GRAPHICS_VALUES, PANEL_FP_DISPLAY_OPTIONS, PANEL_FP_EDIT_OPTIONS, PANEL_FP_GRIDS, PANEL_FP_ORIGINS_AXES, PANEL_FP_TOOLBARS, PANEL_GBR_COLORS, PANEL_GBR_DISPLAY_OPTIONS, PANEL_GBR_EXCELLON_OPTIONS, PANEL_GBR_GRIDS, PANEL_GBR_TOOLBARS, PANEL_PCB_ACTION_PLUGINS, PANEL_PCB_COLORS, PANEL_PCB_DISPLAY_OPTS, PANEL_PCB_EDIT_OPTIONS, PANEL_PCB_GRIDS, PANEL_PCB_ORIGINS_AXES, PANEL_PCB_TOOLBARS, PANEL_SCH_COLORS, PANEL_SCH_DISP_OPTIONS, PANEL_SCH_EDIT_OPTIONS, PANEL_SCH_FIELD_NAME_TEMPLATES, PANEL_SCH_GRIDS, PANEL_SCH_SIMULATOR, PANEL_SCH_TOOLBARS, PANEL_SYM_COLORS, PANEL_SYM_DISP_OPTIONS, PANEL_SYM_EDIT_GRIDS, PANEL_SYM_EDIT_OPTIONS, PANEL_SYM_TOOLBARS, Pgm(), ReadHotKeyConfigIntoActions(), TOOL_BASE::REDRAW, SETTINGS_MANAGER::Save(), PAGED_DIALOG::SetInitialPage(), and DIALOG_SHIM::ShowModal().

Referenced by OnPreferences().

◆ ShowReferenceImagePropertiesDialog()

void PCB_BASE_EDIT_FRAME::ShowReferenceImagePropertiesDialog ( BOARD_ITEM * aBitmap )

inherited

Definition at line 73 of file dialog_reference_image_properties.cpp.

References PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), TOOLS_HOLDER::m_toolManager, PCB_BASE_FRAME::OnModify(), KIGFX::VIEW::RecacheAllItems(), EVENTS::SelectedItemsModified, and DIALOG_SHIM::ShowModal().

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

◆ ShowSolderMask()

void PCB_BASE_FRAME::ShowSolderMask ( )

inherited

Definition at line 435 of file pcb_base_frame.cpp.

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

◆ ShowTargetOptionsDialog()

void PCB_EDIT_FRAME::ShowTargetOptionsDialog ( PCB_TARGET * aTarget )

Definition at line 53 of file dialog_target_properties.cpp.

References DIALOG_SHIM::ShowModal().

Referenced by OnEditItemRequest().

◆ ShowTextBoxPropertiesDialog()

int PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog ( PCB_TEXTBOX * aTextBox )

inherited

Definition at line 170 of file dialog_textbox_properties.cpp.

References DIALOG_SHIM::ShowQuasiModal().

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

◆ ShowTextPropertiesDialog()

void PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog ( PCB_TEXT * aText )

inherited

Definition at line 257 of file pcbnew/dialogs/dialog_text_properties.cpp.

References DIALOG_SHIM::ShowQuasiModal().

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

◆ StartCrossProbeFlash()

void PCB_EDIT_FRAME::StartCrossProbeFlash ( const std::vector< BOARD_ITEM * > & aItems )

Definition at line 591 of file pcb_edit_frame.cpp.

References PCB_BASE_FRAME::GetPcbNewSettings(), m_crossProbeFlashing, m_crossProbeFlashItems, m_crossProbeFlashPhase, m_crossProbeFlashTimer, and traceCrossProbeFlash.

Referenced by KiwayMailIn().

◆ StringFromOptionalValue()

wxString UNITS_PROVIDER::StringFromOptionalValue	(	std::optional< int >	aValue,
		bool	aAddUnitLabel = false,
		EDA_DATA_TYPE	aType = EDA_DATA_TYPE::DISTANCE ) const

inlineinherited

Converts an optional aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters

aValue	= optional value in internal units
aAddUnitLabel	= true to add symbol unit to the string value
aType	is the type of this value, and controls the way the value is converted to a string, and the suitable unit

Returns: A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 100 of file units_provider.h.

References DISTANCE, GetIuScale(), GetUnitsFromType(), NullUiString, and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by WX_GRID::onCellEditorHidden().

◆ StringFromValue() [1/2]

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

inlineinherited

Definition at line 114 of file units_provider.h.

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

◆ StringFromValue() [2/2]

wxString UNITS_PROVIDER::StringFromValue	(	double	aValue,
		bool	aAddUnitLabel = false,
		EDA_DATA_TYPE	aType = EDA_DATA_TYPE::DISTANCE ) const

inlineinherited

Converts aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters

aValue	= value in internal units
aAddUnitLabel	= true to add symbol unit to the string value
aType	is the type of this value, and controls the way the value is converted to a string, and the suitable unit

Returns: A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 79 of file units_provider.h.

References DISTANCE, GetIuScale(), GetUnitsFromType(), and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by Build_Board_Stackup_Table(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), PAD::doCheckPad(), VALIDATION_ERROR_TOO_LARGE< T >::Format(), VALIDATION_ERROR_TOO_SMALL< T >::Format(), formatBBox(), DRC_TEST_PROVIDER::formatMsg(), DRC_TEST_PROVIDER::formatMsg(), WX_GRID::onCellEditorHidden(), reportMax(), reportMin(), reportOpt(), and PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow().

◆ SwitchCanvas()

void PCB_EDIT_FRAME::SwitchCanvas ( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType )

overrideprotectedvirtual

Switch currently used canvas (Cairo / OpenGL).

It also reinit the layers manager that slightly changes with canvases

Reimplemented from EDA_DRAW_FRAME.

Definition at line 2038 of file pcb_edit_frame.cpp.

References EDA_DRAW_FRAME::SwitchCanvas().

◆ SwitchLayer()

void PCB_EDIT_FRAME::SwitchLayer ( PCB_LAYER_ID layer )

overridevirtual

Change the active layer in the editor.

Parameters

layer New layer to make active

Reimplemented from PCB_BASE_FRAME.

Definition at line 72 of file edit.cpp.

References PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetDisplayOptions(), IsCopperLayer(), PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, NORMAL, EDA_DRAW_PANEL_GAL::Refresh(), and SetActiveLayer().

◆ sys_search()

const SEARCH_STACK & EDA_BASE_FRAME::sys_search ( )

virtualinherited

Return a SEARCH_STACK pertaining to entire program.

This is overloaded in KICAD_MANAGER_FRAME

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 1126 of file eda_base_frame.cpp.

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

◆ TestStandalone()

int PCB_EDIT_FRAME::TestStandalone ( )

Test if standalone mode.

Returns: 0 if in standalone, -1 if Eeschema cannot be opened, -2 if the schematic cannot be opened and 1 if OK. If OK, opens Eeschema, and opens the schematic for this project

Definition at line 2097 of file pcb_edit_frame.cpp.

References _, DisplayErrorMessage(), FRAME_SCH, FILEEXT::KiCadSchematicFileExtension, Kiface(), Kiway, FILEEXT::LegacySchematicFileExtension, KIWAY_PLAYER::OpenProjectFiles(), KIWAY::Player(), and Prj().

Referenced by FetchNetlistFromSchematic().

◆ ThemeChanged()

void PCB_EDIT_FRAME::ThemeChanged ( )

overridevirtual

Called when light/dark theme is changed.

Reimplemented from EDA_BASE_FRAME.

Definition at line 2946 of file pcb_edit_frame.cpp.

References EDA_BASE_FRAME::ThemeChanged().

◆ ToggleLayersManager()

void PCB_EDIT_FRAME::ToggleLayersManager ( )

Definition at line 595 of file toolbars_pcb_editor.cpp.

References EDA_DRAW_FRAME::AppearancePanelName(), PCB_BASE_FRAME::GetPcbNewSettings(), PCB_BASE_EDIT_FRAME::m_appearancePanel, EDA_BASE_FRAME::m_auimgr, PCBNEW_SETTINGS::m_AuiPanels, m_show_layer_manager_tools, PCBNEW_SETTINGS::AUI_PANELS::right_panel_width, and SetAuiPaneSize().

◆ ToggleLibraryTree()

void PCB_EDIT_FRAME::ToggleLibraryTree ( )

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 726 of file toolbars_pcb_editor.cpp.

References PCBNEW_SETTINGS::AUI_PANELS::design_blocks_panel_docked_width, PCBNEW_SETTINGS::AUI_PANELS::design_blocks_panel_float_height, PCBNEW_SETTINGS::AUI_PANELS::design_blocks_panel_float_width, EDA_DRAW_FRAME::DesignBlocksPaneName(), PCB_BASE_FRAME::GetPcbNewSettings(), EDA_BASE_FRAME::m_auimgr, PCBNEW_SETTINGS::m_AuiPanels, m_designBlocksPane, and SetAuiPaneSize().

◆ ToggleNetInspector()

void PCB_EDIT_FRAME::ToggleNetInspector ( )

Definition at line 621 of file toolbars_pcb_editor.cpp.

References PCB_BASE_FRAME::GetPcbNewSettings(), EDA_BASE_FRAME::m_auimgr, PCBNEW_SETTINGS::m_AuiPanels, EDA_DRAW_FRAME::m_netInspectorPanel, m_show_net_inspector, PCBNEW_SETTINGS::AUI_PANELS::net_inspector_width, EDA_DRAW_FRAME::NetInspectorPanelName(), and SetAuiPaneSize().

◆ ToggleProperties()

void PCB_BASE_EDIT_FRAME::ToggleProperties ( )

overridevirtualinherited

Reimplemented from EDA_DRAW_FRAME.

Definition at line 319 of file pcb_base_edit_frame.cpp.

References PCB_BASE_FRAME::GetPcbNewSettings(), EDA_BASE_FRAME::m_auimgr, PCBNEW_SETTINGS::m_AuiPanels, EDA_DRAW_FRAME::m_propertiesPanel, PCBNEW_SETTINGS::AUI_PANELS::properties_panel_width, EDA_DRAW_FRAME::PropertiesPaneName(), and SetAuiPaneSize().

◆ ToggleSearch()

void PCB_EDIT_FRAME::ToggleSearch ( )

Definition at line 646 of file toolbars_pcb_editor.cpp.

References PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetPcbNewSettings(), EDA_BASE_FRAME::m_auimgr, PCBNEW_SETTINGS::m_AuiPanels, EDA_DRAW_FRAME::m_searchPane, m_show_search, PCBNEW_SETTINGS::AUI_PANELS::search_panel_dock_direction, PCBNEW_SETTINGS::AUI_PANELS::search_panel_height, PCBNEW_SETTINGS::AUI_PANELS::search_panel_width, SearchPaneName(), SetAuiPaneSize(), and EDA_DRAW_PANEL_GAL::SetFocus().

◆ ToggleUserUnits()

void EDA_DRAW_FRAME::ToggleUserUnits ( )

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 320 of file eda_draw_frame.cpp.

References dummy, UNITS_PROVIDER::GetUserUnits(), INCH, TOOLS_HOLDER::m_toolManager, MM, UNITS_PROVIDER::SetUserUnits(), and unitsChangeRefresh().

◆ ToolStackIsEmpty()

bool TOOLS_HOLDER::ToolStackIsEmpty ( )

inlineinherited

Definition at line 125 of file tools_holder.h.

References m_toolStack.

Referenced by PCB_SELECTION_TOOL::Init(), PCB_VIEWER_TOOLS::Init(), and EDITOR_CONDITIONS::noToolFunc().

◆ Tracks_and_Vias_Size_Event()

void PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event ( wxCommandEvent & event )

Definition at line 94 of file edit_track_width.cpp.

◆ TryBefore()

bool PCB_BASE_EDIT_FRAME::TryBefore ( wxEvent & aEvent )

overrideinherited

Definition at line 118 of file pcb_base_edit_frame.cpp.

References EDA_VIEW_SWITCHER::GetSelection(), m_appearancePanel, PRESET_SWITCH_KEY, DIALOG_SHIM::ShowModal(), and VIEWPORT_SWITCH_KEY.

◆ UndoRedoBlock()

void PCB_BASE_EDIT_FRAME::UndoRedoBlock ( bool aBlock = true )

inlineinherited

Enable/disable undo and redo operations.

Definition at line 173 of file pcb_base_edit_frame.h.

References m_undoRedoBlocked.

◆ UndoRedoBlocked()

bool PCB_BASE_EDIT_FRAME::UndoRedoBlocked ( ) const

inlineinherited

Check if the undo and redo operations are currently blocked.

Definition at line 165 of file pcb_base_edit_frame.h.

References m_undoRedoBlocked.

Referenced by RestoreCopyFromRedoList(), and RestoreCopyFromUndoList().

◆ unitsChangeRefresh()

void PCB_BASE_EDIT_FRAME::unitsChangeRefresh ( )

overrideprotectedvirtualinherited

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.

The default version only updates the status bar. Don't forget to call the default in your derived class or the status bar will not get updated properly.

Reimplemented from PCB_BASE_FRAME.

Definition at line 248 of file pcb_base_edit_frame.cpp.

References PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), TOOLS_HOLDER::m_toolManager, EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar(), EVENTS::SelectedItemsModified, PCB_BASE_FRAME::unitsChangeRefresh(), and EDA_DRAW_FRAME::UpdateProperties().

Referenced by PCB_EDIT_FRAME::OnBoardLoaded().

◆ UnregisterUIUpdateHandler() [1/2]

void EDA_BASE_FRAME::UnregisterUIUpdateHandler ( int aID )

overridevirtualinherited

Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler.

Parameters

aID	is the control ID to unregister the handler for

Reimplemented from TOOLS_HOLDER.

Definition at line 469 of file eda_base_frame.cpp.

References m_uiUpdateMap.

◆ UnregisterUIUpdateHandler() [2/2]

void TOOLS_HOLDER::UnregisterUIUpdateHandler ( const TOOL_ACTION & aAction )

virtualinherited

Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.

Parameters

aAction is the action to unregister the handler for.

Definition at line 50 of file tools_holder.cpp.

References TOOL_ACTION::GetUIId(), and UnregisterUIUpdateHandler().

Referenced by UnregisterUIUpdateHandler().

◆ Update3DView()

void PCB_BASE_FRAME::Update3DView	(	bool	aMarkDirty,
		bool	aRefresh,
		const wxString *	aTitle = nullptr )

virtualinherited

Update the 3D view, if the viewer is opened by this frame.

Parameters

aMarkDirty	alerts the 3D view that data is stale (it may not refresh instantly)
aRefresh	will tell the 3D view to refresh immediately
aTitle	is the new title of the 3D frame, or nullptr to do not change the frame title

Reimplemented in FOOTPRINT_CHOOSER_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 148 of file pcb_base_frame.cpp.

References Get3DViewerFrame(), EDA_3D_VIEWER_FRAME::Redraw(), and EDA_3D_VIEWER_FRAME::ReloadRequest().

Referenced by EDIT_TOOL::doMoveSelection(), PCB_EDIT_FRAME::HardRedraw(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PCB_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDIT_FRAME::OnModify(), PCB_EDIT_FRAME::OnModify(), BOARD_COMMIT::Push(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PCB_VIEWER_TOOLS::Show3DViewer(), FOOTPRINT_CHOOSER_FRAME::Update3DView(), FOOTPRINT_VIEWER_FRAME::Update3DView(), and FOOTPRINT_WIZARD_FRAME::Update3DView().

◆ UpdateFileHistory()

void EDA_BASE_FRAME::UpdateFileHistory	(	const wxString &	FullFileName,
		FILE_HISTORY *	aFileHistory = nullptr )

inherited

Update the list of recently opened files.

The menu is also updated, if FILE_HISTORY::UseMenu was called at init time.

Parameters

FullFileName	The full file name including the path.
aFileHistory	The FILE_HISTORY in use. If NULL, the main application file history is used.

Definition at line 1245 of file eda_base_frame.cpp.

References FILE_HISTORY::AddFileToHistory(), m_fileHistory, m_isClosing, and ReCreateMenuBar().

Referenced by SCH_EDIT_FRAME::doCloseWindow(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), BITMAP2CMP_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SaveSettings(), and GERBVIEW_FRAME::unarchiveFiles().

◆ UpdateGridSelectBox()

void EDA_DRAW_FRAME::UpdateGridSelectBox ( )

inherited

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

Definition at line 403 of file eda_draw_frame.cpp.

References _, GRID_MENU::BuildChoiceList(), EDA_BASE_FRAME::config(), DisplayUnitsMsg(), grid, m_gridSelectBox, and UpdateStatusBar().

Referenced by CommonSettingsChanged(), configureToolbars(), GERBVIEW_FRAME::unitsChangeRefresh(), and PCB_BASE_FRAME::unitsChangeRefresh().

◆ UpdateMsgPanel()

void EDA_DRAW_FRAME::UpdateMsgPanel ( )

virtualinherited

Redraw the message panel.

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 921 of file eda_draw_frame.cpp.

Referenced by PCB_BASE_FRAME::OnModify(), SCH_EDIT_FRAME::ShowChangedLanguage(), unitsChangeRefresh(), FOOTPRINT_EDIT_FRAME::UpdateMsgPanel(), and FOOTPRINT_VIEWER_FRAME::UpdateMsgPanel().

◆ UpdateProperties()

void EDA_DRAW_FRAME::UpdateProperties ( )

inherited

Definition at line 1268 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing, and m_propertiesPanel.

Referenced by unitsChangeRefresh(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), SCH_EDIT_FRAME::unitsChangeRefresh(), and PROPERTIES_TOOL::UpdateProperties().

◆ UpdateStatusBar()

void PCB_BASE_FRAME::UpdateStatusBar ( )

overridevirtualinherited

Update the status bar information.

The EDA_DRAW_FRAME level updates the absolute and relative coordinates and the zoom information. If you override this virtual method, make sure to call this subclassed method.

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in FOOTPRINT_CHOOSER_FRAME.

Definition at line 721 of file pcb_base_frame.cpp.

References EDA_DRAW_FRAME::DisplayGridMsg(), GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), GetScreen(), EDA_DRAW_FRAME::GetShowPolarCoords(), EDA_DRAW_PANEL_GAL::GetViewControls(), BASE_SCREEN::m_LocalOrigin, m_originTransforms, UNITS_PROVIDER::MessageTextFromValue(), RAD2DEG(), EDA_DRAW_FRAME::UpdateStatusBar(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PCB_VIEWER_TOOLS::NextLineMode(), OnModify(), and PCB_EDIT_FRAME::SavePcbFile().

◆ updateStatusBarWidths()

void EDA_DRAW_FRAME::updateStatusBarWidths ( )

protectedinherited

Definition at line 726 of file eda_draw_frame.cpp.

References _, and KIUI::GetTextSize().

Referenced by EDA_DRAW_FRAME().

◆ UpdateTitle()

void PCB_EDIT_FRAME::UpdateTitle ( )

Set the main window title bar text.

If file name defined by PCB_SCREEN::m_FileName is not set, the title is set to the application name appended with no file. Otherwise, the title is set to the full path and file name and read only is appended to the title if the user does not have write access to the file.

Definition at line 1964 of file pcb_edit_frame.cpp.

References _, PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), and IsContentModified().

Referenced by Clear_Pcb(), OnBoardLoaded(), OnModify(), SavePcbFile(), and ShowChangedLanguage().

◆ UpdateToolbarControlSizes()

void EDA_BASE_FRAME::UpdateToolbarControlSizes ( )

virtualinherited

Update the sizes of any controls in the toolbars of the frame.

Reimplemented in PL_EDITOR_FRAME.

Definition at line 659 of file eda_base_frame.cpp.

References m_tbLeft, m_tbRight, m_tbTopAux, and m_tbTopMain.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FOOTPRINT_EDIT_FRAME::ReCreateLayerBox(), PCB_EDIT_FRAME::ReCreateLayerBox(), and PL_EDITOR_FRAME::UpdateToolbarControlSizes().

◆ UpdateTrackWidthSelectBox()

void PCB_EDIT_FRAME::UpdateTrackWidthSelectBox	(	wxChoice *	aTrackWidthSelectBox,
		bool	aShowNetclass,
		bool	aShowEdit )

Definition at line 478 of file toolbars_pcb_editor.cpp.

References _, ComboBoxUnits(), PCB_BASE_FRAME::GetDesignSettings(), EDA_DRAW_FRAME::GetUnitPair(), BOARD_DESIGN_SETTINGS::m_TrackWidthList, and BOARD_DESIGN_SETTINGS::SetTrackWidthIndex().

Referenced by configureToolbars().

◆ UpdateUserInterface()

void PCB_EDIT_FRAME::UpdateUserInterface ( )

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

Definition at line 1994 of file pcb_edit_frame.cpp.

References LSET::AllLayersMask(), PCB_ACTIONS::angleSnapModeChanged, BOARD::BuildConnectivity(), ENUM_MAP< T >::Choices(), PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetEnabledLayers(), TOOLS_HOLDER::GetToolManager(), PCB_DRAW_PANEL_GAL::GetView(), ENUM_MAP< T >::Instance(), PCB_BASE_EDIT_FRAME::m_appearancePanel, EDA_DRAW_FRAME::m_netInspectorPanel, PCB_BASE_EDIT_FRAME::m_SelLayerBox, ENUM_MAP< T >::Map(), LSET::Name(), ReCreateLayerBox(), TOOL_MANAGER::RunAction(), LSET::Seq(), SetActiveLayer(), KIGFX::VIEW::SetLayerVisible(), ENUM_MAP< T >::Undefined(), and UNDEFINED_LAYER.

Referenced by API_HANDLER_PCB::handleSetBoardEnabledLayers(), and ShowBoardSetupDialog().

◆ UpdateVertexEditorSelection()

void PCB_BASE_EDIT_FRAME::UpdateVertexEditorSelection ( BOARD_ITEM * aItem )

inherited

Definition at line 460 of file pcb_base_edit_frame.cpp.

References m_vertexEditorPane.

Referenced by PCB_CONTROL::UpdateMessagePanel().

◆ UpdateViaSizeSelectBox()

void PCB_EDIT_FRAME::UpdateViaSizeSelectBox	(	wxChoice *	aViaSizeSelectBox,
		bool	aShowNetclass,
		bool	aShowEdit )

Definition at line 521 of file toolbars_pcb_editor.cpp.

References _, ComboBoxUnits(), PCB_BASE_FRAME::GetDesignSettings(), COMMON_TOOLS::GetLastImperialUnits(), COMMON_TOOLS::GetLastMetricUnits(), GetUserUnits(), EDA_UNIT_UTILS::IsImperialUnit(), VIA_DIMENSION::m_Diameter, VIA_DIMENSION::m_Drill, TOOLS_HOLDER::m_toolManager, BOARD_DESIGN_SETTINGS::m_ViasDimensionsList, MILS, MM, and BOARD_DESIGN_SETTINGS::SetViaSizeIndex().

Referenced by configureToolbars().

◆ UpdateZoomSelectBox()

void EDA_DRAW_FRAME::UpdateZoomSelectBox ( )

inherited

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

Definition at line 583 of file eda_draw_frame.cpp.

References _, EDA_BASE_FRAME::config(), m_canvas, APP_SETTINGS_BASE::m_Window, m_zoomSelectBox, zoom, and WINDOW_SETTINGS::zoom_factors.

Referenced by configureToolbars().

◆ ValueFromString()

int UNITS_PROVIDER::ValueFromString	(	const wxString &	aTextValue,
		EDA_DATA_TYPE	aType = EDA_DATA_TYPE::DISTANCE ) const

inlineinherited

Converts aTextValue in aUnits to internal units used by the frame.

Warning: This utilizes the current locale and will break if decimal formats differ

Parameters

aType	is the type of this value, and controls the way the string is converted to a value
aTextValue	A reference to a wxString object containing the string to convert.

Returns: internal units value

Definition at line 156 of file units_provider.h.

References DISTANCE, EDA_UNIT_UTILS::UI::DoubleValueFromString(), GetIuScale(), GetUnitsFromType(), and KiROUND().

Referenced by PIN_TABLE_DATA_MODEL::compare(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), WX_GRID::GetUnitValue(), and WX_GRID::onCellEditorHidden().

◆ VertexEditorPaneName()

wxString PCB_BASE_EDIT_FRAME::VertexEditorPaneName ( )

staticinherited

Definition at line 424 of file pcb_base_edit_frame.cpp.

Referenced by OpenVertexEditor().

◆ windowClosing()

void EDA_BASE_FRAME::windowClosing ( wxCloseEvent & event )

privateinherited

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

SaveSettings() is called for all derived wxFrames in this base class overload. Calling it from a destructor is deprecated since the wxFrame's position is not available in the destructor on linux. In other words, you should not need to call SaveSettings() anywhere, except in this one function found only in this class.

Definition at line 292 of file eda_base_frame.cpp.

References canCloseWindow(), config(), doCloseWindow(), findQuasiModalDialog(), IsModal(), m_infoBar, m_isClosing, m_isNonUserClose, and SaveSettings().

Referenced by commonInit(), and ~EDA_BASE_FRAME().

◆ Zoom_Automatique()

void EDA_DRAW_FRAME::Zoom_Automatique ( bool aWarpPointer )

virtualinherited

Redraw the screen with best zoom level and the best centering that shows all the page or the board.

Definition at line 1058 of file eda_draw_frame.cpp.

References TOOLS_HOLDER::m_toolManager, and ACTIONS::zoomFitScreen.

Referenced by PCB_EDIT_FRAME::Clear_Pcb(), GERBVIEW_FRAME::LoadFileOrShowDialog(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadZipArchiveFile(), PCB_EDIT_FRAME::OnBoardLoaded(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), GERBVIEW_FRAME::OpenProjectFiles(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and FOOTPRINT_WIZARD_FRAME::SelectFootprintWizard().

Friends And Related Symbol Documentation

◆ APPEARANCE_CONTROLS

friend class APPEARANCE_CONTROLS

friend

Definition at line 839 of file pcb_edit_frame.h.

References APPEARANCE_CONTROLS.

Referenced by APPEARANCE_CONTROLS.

◆ PCB::IFACE

friend struct PCB::IFACE

friend

Definition at line 838 of file pcb_edit_frame.h.

Member Data Documentation

◆ KICAD_AUI_TB_STYLE

int EDA_BASE_FRAME::KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND

staticconstexprprotectedinherited

Default style flags used for wxAUI toolbars.

Definition at line 644 of file eda_base_frame.h.

Referenced by RecreateToolbars().

◆ m_aboutTitle

wxString EDA_BASE_FRAME::m_aboutTitle

protectedinherited

Definition at line 789 of file eda_base_frame.h.

Referenced by BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GetAboutTitle(), GetUntranslatedAboutTitle(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ m_acceptedExts

std::map<const wxString, TOOL_ACTION*> EDA_BASE_FRAME::m_acceptedExts

protectedinherited

Associate file extensions with action to execute.

Definition at line 830 of file eda_base_frame.h.

Referenced by DoWithAcceptedFiles(), GERBVIEW_FRAME::DoWithAcceptedFiles(), KICAD_MANAGER_FRAME::DoWithAcceptedFiles(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), OnDropFiles(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), and SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME().

◆ m_AcceptedFiles

std::vector<wxFileName> EDA_BASE_FRAME::m_AcceptedFiles

protectedinherited

Definition at line 738 of file eda_base_frame.h.

Referenced by DoWithAcceptedFiles(), GERBVIEW_FRAME::DoWithAcceptedFiles(), KICAD_MANAGER_FRAME::DoWithAcceptedFiles(), PL_EDITOR_FRAME::DoWithAcceptedFiles(), and OnDropFiles().

◆ m_actions

ACTIONS* TOOLS_HOLDER::m_actions

protectedinherited

Definition at line 172 of file tools_holder.h.

◆ m_appearancePanel

APPEARANCE_CONTROLS* PCB_BASE_EDIT_FRAME::m_appearancePanel

protectedinherited

Definition at line 279 of file pcb_base_edit_frame.h.

Referenced by PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GetAppearancePanel(), handleActivateEvent(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::OnBoardLoaded(), onDarkModeToggle(), FOOTPRINT_EDIT_FRAME::OnDisplayOptionsChanged(), PCB_EDIT_FRAME::OnDisplayOptionsChanged(), PCB_BASE_EDIT_FRAME(), PCB_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), PCB_EDIT_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), SetGridVisibility(), SetObjectVisible(), FOOTPRINT_EDIT_FRAME::ShowChangedLanguage(), PCB_EDIT_FRAME::ShowChangedLanguage(), FOOTPRINT_EDIT_FRAME::ToggleLayersManager(), PCB_EDIT_FRAME::ToggleLayersManager(), TryBefore(), FOOTPRINT_EDIT_FRAME::UpdateUserInterface(), and PCB_EDIT_FRAME::UpdateUserInterface().

◆ m_auiLayoutState

nlohmann::json EDA_BASE_FRAME::m_auiLayoutState

protectedinherited

Definition at line 793 of file eda_base_frame.h.

Referenced by LoadWindowSettings(), and RestoreAuiLayout().

◆ m_auimgr

wxAuiManager EDA_BASE_FRAME::m_auimgr

protectedinherited

Definition at line 791 of file eda_base_frame.h.

Referenced by SCH_EDIT_FRAME::CaptureHierarchyPaneSize(), commonInit(), CreateInfoBar(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), SCH_EDIT_FRAME::FindNetInInspector(), FinishAUIInitialization(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_BASE_EDIT_FRAME::GetAuiManager(), KICAD_MANAGER_FRAME::HistoryPanelShown(), FOOTPRINT_EDIT_FRAME::IsLibraryTreeShown(), SYMBOL_EDIT_FRAME::IsLibraryTreeShown(), PCB_EDIT_FRAME::IsSearchPaneShown(), SCH_EDIT_FRAME::IsSearchPaneShown(), PCB_EDIT_FRAME::LayerManagerShown(), PCB_EDIT_FRAME::NetInspectorShown(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::onResizeNetNavigator(), FOOTPRINT_VIEWER_FRAME::OnSize(), FOOTPRINT_WIZARD_FRAME::OnSize(), KICAD_MANAGER_FRAME::OnSize(), SYMBOL_VIEWER_FRAME::OnSize(), OnToolbarSizeChanged(), KICAD_MANAGER_FRAME::onToolbarSizeChanged(), PCB_BASE_EDIT_FRAME::OpenVertexEditor(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PCB_EDIT_FRAME::PropertiesShown(), RecreateToolbars(), GERBVIEW_FRAME::ReFillLayerWidget(), CVPCB_MAINFRAME::refreshAfterSymbolSearch(), RestoreAuiLayout(), FOOTPRINT_WIZARD_FRAME::SaveSettings(), KICAD_MANAGER_FRAME::SaveSettings(), PCB_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), SaveWindowSettings(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), PCB_BASE_FRAME::SetDrawBgColor(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), EDA_3D_VIEWER_FRAME::ShowChangedLanguage(), EDA_DRAW_FRAME::ShowChangedLanguage(), FOOTPRINT_EDIT_FRAME::ShowChangedLanguage(), GERBVIEW_FRAME::ShowChangedLanguage(), KICAD_MANAGER_FRAME::ShowChangedLanguage(), PCB_EDIT_FRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), ThemeChanged(), EDA_3D_VIEWER_FRAME::ToggleAppearanceManager(), GERBVIEW_FRAME::ToggleLayerManager(), FOOTPRINT_EDIT_FRAME::ToggleLayersManager(), PCB_EDIT_FRAME::ToggleLayersManager(), FOOTPRINT_EDIT_FRAME::ToggleLibraryTree(), PCB_EDIT_FRAME::ToggleLibraryTree(), SCH_EDIT_FRAME::ToggleLibraryTree(), SYMBOL_EDIT_FRAME::ToggleLibraryTree(), KICAD_MANAGER_FRAME::ToggleLocalHistory(), PCB_EDIT_FRAME::ToggleNetInspector(), SCH_EDIT_FRAME::ToggleNetNavigator(), PCB_BASE_EDIT_FRAME::ToggleProperties(), SCH_EDIT_FRAME::ToggleProperties(), SYMBOL_EDIT_FRAME::ToggleProperties(), SCH_EDIT_FRAME::ToggleSchematicHierarchy(), PCB_EDIT_FRAME::ToggleSearch(), SCH_EDIT_FRAME::ToggleSearch(), GERBVIEW_FRAME::updateDCodeSelectBox(), SCH_EDIT_FRAME::updateSelectionFilterVisbility(), SYMBOL_EDIT_FRAME::updateSelectionFilterVisbility(), GERBVIEW_FRAME::UpdateTitleAndInfo(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), and KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME().

◆ m_autoSavePending

bool EDA_BASE_FRAME::m_autoSavePending

protectedinherited

Definition at line 803 of file eda_base_frame.h.

Referenced by commonInit(), EDA_DRAW_FRAME::CommonSettingsChanged(), doAutoSave(), ProcessEvent(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::saveSchematicFile().

◆ m_autoSavePermissionError

bool EDA_BASE_FRAME::m_autoSavePermissionError

protectedinherited

Definition at line 806 of file eda_base_frame.h.

Referenced by commonInit().

◆ m_autoSaveRequired

bool EDA_BASE_FRAME::m_autoSaveRequired

protectedinherited

Definition at line 804 of file eda_base_frame.h.

Referenced by commonInit(), doAutoSave(), isAutoSaveRequired(), OnModify(), PCB_EDIT_FRAME::SaveBoard(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), and SCH_EDIT_FRAME::saveSchematicFile().

◆ m_autoSaveTimer

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer

protectedinherited

Definition at line 805 of file eda_base_frame.h.

Referenced by commonInit(), EDA_DRAW_FRAME::CommonSettingsChanged(), onAutoSaveTimer(), ProcessEvent(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveSchematicFile(), and ~EDA_BASE_FRAME().

◆ m_boardSetupDlg

DIALOG_BOARD_SETUP* PCB_EDIT_FRAME::m_boardSetupDlg

private

Definition at line 855 of file pcb_edit_frame.h.

Referenced by ShowBoardSetupDialog().

◆ m_canvas

EDA_DRAW_PANEL_GAL* EDA_DRAW_FRAME::m_canvas

privateinherited

Definition at line 623 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), GetCanvas(), GetZoomLevelIndicator(), OnMove(), OnSelectGrid(), OnSelectZoom(), SetCanvas(), UpdateZoomSelectBox(), and ~EDA_DRAW_FRAME().

◆ m_canvasType

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::m_canvasType

protectedinherited

The current canvas type.

Definition at line 616 of file eda_draw_frame.h.

Referenced by CommonSettingsChanged(), SCH_BASE_FRAME::createCanvas(), EDA_DRAW_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), resolveCanvasType(), FOOTPRINT_EDIT_FRAME::resolveCanvasType(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SwitchCanvas(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), ~EDA_DRAW_FRAME(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), PCB_BASE_FRAME::~PCB_BASE_FRAME(), PL_EDITOR_FRAME::~PL_EDITOR_FRAME(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ m_colorSettings

COLOR_SETTINGS* EDA_DRAW_FRAME::m_colorSettings

protectedinherited

Definition at line 608 of file eda_draw_frame.h.

Referenced by SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME(), GetColorSettings(), SCH_BASE_FRAME::GetColorSettings(), SYMBOL_EDIT_FRAME::SwitchCanvas(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ m_configName

wxString EDA_BASE_FRAME::m_configName

protectedinherited

Definition at line 796 of file eda_base_frame.h.

Referenced by ConfigBaseName(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ m_crossProbeFlashing

bool PCB_EDIT_FRAME::m_crossProbeFlashing = false

Currently flashing guard.

Definition at line 832 of file pcb_edit_frame.h.

Referenced by OnCrossProbeFlashTimer(), and StartCrossProbeFlash().

◆ m_crossProbeFlashItems

std::vector<KIID> PCB_EDIT_FRAME::m_crossProbeFlashItems

Items to flash (by UUID)

Definition at line 831 of file pcb_edit_frame.h.

Referenced by OnCrossProbeFlashTimer(), and StartCrossProbeFlash().

◆ m_crossProbeFlashPhase

int PCB_EDIT_FRAME::m_crossProbeFlashPhase = 0

Phase counter.

Definition at line 830 of file pcb_edit_frame.h.

Referenced by OnCrossProbeFlashTimer(), and StartCrossProbeFlash().

◆ m_crossProbeFlashTimer

wxTimer PCB_EDIT_FRAME::m_crossProbeFlashTimer

Timer to toggle selection visibility for flash.

Definition at line 829 of file pcb_edit_frame.h.

Referenced by OnCrossProbeFlashTimer(), and StartCrossProbeFlash().

◆ m_currentScreen

BASE_SCREEN* EDA_DRAW_FRAME::m_currentScreen

privateinherited

current used SCREEN

Definition at line 622 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), GetScreen(), SetScreen(), and ~EDA_DRAW_FRAME().

◆ m_darkMode

bool PCB_BASE_EDIT_FRAME::m_darkMode

protectedinherited

Panel with Layers and Object Inspector tabs.

Definition at line 288 of file pcb_base_edit_frame.h.

Referenced by PCB_BASE_EDIT_FRAME().

◆ m_designBlockHistoryList

std::vector<LIB_ID> PCB_EDIT_FRAME::m_designBlockHistoryList

private

Definition at line 857 of file pcb_edit_frame.h.

◆ m_designBlocksPane

PCB_DESIGN_BLOCK_PANE* PCB_EDIT_FRAME::m_designBlocksPane

private

Definition at line 858 of file pcb_edit_frame.h.

Referenced by GetDesignBlockPane(), KiwayMailIn(), SaveBoardAsDesignBlock(), SaveBoardToDesignBlock(), SaveSelectionAsDesignBlock(), saveSelectionToDesignBlock(), SaveSettings(), and ToggleLibraryTree().

◆ m_displayIndex

int EDA_BASE_FRAME::m_displayIndex

protectedinherited

Definition at line 783 of file eda_base_frame.h.

Referenced by commonInit(), LoadWindowState(), and OnSize().

◆ m_displayOptions

PCB_DISPLAY_OPTIONS PCB_BASE_FRAME::m_displayOptions

protectedinherited

Definition at line 436 of file pcb_base_frame.h.

Referenced by GetDisplayOptions(), FOOTPRINT_EDIT_FRAME::LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), and SetDisplayOptions().

◆ m_dragAction

MOUSE_DRAG_ACTION TOOLS_HOLDER::m_dragAction

protectedinherited

Definition at line 188 of file tools_holder.h.

Referenced by CommonSettingsChanged(), GetDragAction(), and TOOLS_HOLDER().

◆ m_drawBgColor

COLOR4D EDA_DRAW_FRAME::m_drawBgColor

protectedinherited

Definition at line 588 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), GetDrawBgColor(), SetDrawBgColor(), and PCB_BASE_FRAME::SetDrawBgColor().

◆ m_dummySelection

SELECTION TOOLS_HOLDER::m_dummySelection

protectedinherited

Definition at line 175 of file tools_holder.h.

Referenced by GetCurrentSelection().

◆ m_eventCounterTimer

wxTimer* PCB_EDIT_FRAME::m_eventCounterTimer

private

Definition at line 867 of file pcb_edit_frame.h.

Referenced by ~PCB_EDIT_FRAME().

◆ m_exportNetlistAction

TOOL_ACTION* PCB_EDIT_FRAME::m_exportNetlistAction

private

The export board netlist tool action object.

This is created at runtime rather than declared statically so it doesn't show up in the list of assignable hot keys since it's only available as an advanced configuration option.

Definition at line 848 of file pcb_edit_frame.h.

Referenced by doReCreateMenuBar(), GetExportNetlistAction(), and ~PCB_EDIT_FRAME().

◆ m_file_checker

std::unique_ptr<LOCKFILE> EDA_DRAW_FRAME::m_file_checker

protectedinherited

Definition at line 585 of file eda_draw_frame.h.

Referenced by LockFile(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), and ReleaseFile().

◆ m_fileHistory

FILE_HISTORY* EDA_BASE_FRAME::m_fileHistory

protectedinherited

Definition at line 801 of file eda_base_frame.h.

Referenced by ClearFileHistory(), commonInit(), CommonSettingsChanged(), GetFileFromHistory(), GetFileHistory(), LoadSettings(), SaveSettings(), UpdateFileHistory(), and ~EDA_BASE_FRAME().

◆ m_findDialog

DIALOG_FIND* PCB_EDIT_FRAME::m_findDialog

private

Definition at line 850 of file pcb_edit_frame.h.

Referenced by doCloseWindow(), FindNext(), and ShowFindDialog().

◆ m_findReplaceData

std::unique_ptr<EDA_SEARCH_DATA> EDA_DRAW_FRAME::m_findReplaceData

protectedinherited

Definition at line 601 of file eda_draw_frame.h.

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), EDA_DRAW_FRAME(), GetFindReplaceData(), LoadSettings(), SCH_EDIT_FRAME::LoadSettings(), SaveSettings(), SCH_EDIT_FRAME::SaveSettings(), SCH_BASE_FRAME::SCH_BASE_FRAME(), and SCH_BASE_FRAME::ShowFindReplaceDialog().

◆ m_findStringHistoryList

wxArrayString EDA_DRAW_FRAME::m_findStringHistoryList

protectedinherited

Definition at line 602 of file eda_draw_frame.h.

Referenced by SCH_BASE_FRAME::doCloseWindow(), GetFindHistoryList(), LoadSettings(), SCH_BASE_FRAME::OnFindDialogClose(), SaveSettings(), and SCH_BASE_FRAME::ShowFindReplaceDialog().

◆ m_footprintDiffDlg

DIALOG_BOOK_REPORTER* PCB_EDIT_FRAME::m_footprintDiffDlg

private

Definition at line 854 of file pcb_edit_frame.h.

Referenced by doCloseWindow(), GetFootprintDiffDialog(), and onCloseModelessBookReporterDialogs().

◆ m_framePos

wxPoint EDA_BASE_FRAME::m_framePos

protectedinherited

Definition at line 780 of file eda_base_frame.h.

Referenced by BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), LoadWindowState(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SaveWindowSettings().

◆ m_frameSize

wxSize EDA_BASE_FRAME::m_frameSize

protectedinherited

Definition at line 781 of file eda_base_frame.h.

Referenced by BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), commonInit(), SCH_BASE_FRAME::createCanvas(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), LoadWindowState(), EDA_DRAW_FRAME::OnSize(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), and SaveWindowSettings().

◆ m_galDisplayOptions

GAL_DISPLAY_OPTIONS_IMPL EDA_DRAW_FRAME::m_galDisplayOptions

privateinherited

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

Definition at line 626 of file eda_draw_frame.h.

Referenced by CommonSettingsChanged(), GetGalDisplayOptions(), LoadSettings(), OnMove(), and SaveSettings().

◆ m_gridColor

COLOR4D EDA_DRAW_FRAME::m_gridColor

protectedinherited

Definition at line 587 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), GetGridColor(), SetGridColor(), and GERBVIEW_FRAME::SetGridColor().

◆ m_gridSelectBox

wxChoice* EDA_DRAW_FRAME::m_gridSelectBox

protectedinherited

Definition at line 597 of file eda_draw_frame.h.

Referenced by configureToolbars(), EDA_DRAW_FRAME(), OnSelectGrid(), OnUpdateSelectGrid(), and UpdateGridSelectBox().

◆ m_hotkeyPopup

HOTKEY_CYCLE_POPUP* EDA_DRAW_FRAME::m_hotkeyPopup

protectedinherited

Definition at line 613 of file eda_draw_frame.h.

Referenced by CreateHotkeyPopup(), EDA_DRAW_FRAME(), and GetHotkeyPopup().

◆ m_ident

FRAME_T EDA_BASE_FRAME::m_ident

protectedinherited

Definition at line 779 of file eda_base_frame.h.

Referenced by commonInit(), findQuasiModalDialog(), GetFrameType(), GetWindowSize(), IsType(), LoadWindowState(), and EDA_DRAW_FRAME::saveCanvasTypeSetting().

◆ m_immediateActions

bool TOOLS_HOLDER::m_immediateActions

protectedinherited

Definition at line 184 of file tools_holder.h.

Referenced by CommonSettingsChanged(), GetDoImmediateActions(), and TOOLS_HOLDER().

◆ m_importProperties

const std::map<std::string, UTF8>* PCB_EDIT_FRAME::m_importProperties

private

Definition at line 860 of file pcb_edit_frame.h.

Referenced by importFile(), and OpenProjectFiles().

◆ m_infoBar

WX_INFOBAR* EDA_BASE_FRAME::m_infoBar

protectedinherited

◆ m_inFpChangeTimerEvent

bool PCB_BASE_FRAME::m_inFpChangeTimerEvent

privateinherited

Definition at line 450 of file pcb_base_frame.h.

Referenced by OnFpChangeDebounceTimer(), and PCB_BASE_FRAME().

◆ m_inspectClearanceDlg

DIALOG_BOOK_REPORTER* PCB_EDIT_FRAME::m_inspectClearanceDlg

private

Definition at line 852 of file pcb_edit_frame.h.

Referenced by doCloseWindow(), GetInspectClearanceDialog(), and onCloseModelessBookReporterDialogs().

◆ m_inspectConstraintsDlg

DIALOG_BOOK_REPORTER* PCB_EDIT_FRAME::m_inspectConstraintsDlg

private

Definition at line 853 of file pcb_edit_frame.h.

Referenced by doCloseWindow(), GetInspectConstraintsDialog(), and onCloseModelessBookReporterDialogs().

◆ m_inspectDrcErrorDlg

DIALOG_BOOK_REPORTER* PCB_EDIT_FRAME::m_inspectDrcErrorDlg

private

Definition at line 851 of file pcb_edit_frame.h.

Referenced by doCloseWindow(), GetInspectDrcErrorDialog(), and onCloseModelessBookReporterDialogs().

◆ m_isClosing

bool EDA_BASE_FRAME::m_isClosing

protectedinherited

Set by the close window event handler after frames are asked if they can close.

Allows other functions when called to know our state is cleanup.

Definition at line 822 of file eda_base_frame.h.

◆ m_isNonUserClose

bool EDA_BASE_FRAME::m_isNonUserClose

protectedinherited

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

Definition at line 825 of file eda_base_frame.h.

Referenced by commonInit(), NonUserClose(), SaveSettings(), and windowClosing().

◆ m_iuScale

const EDA_IU_SCALE& UNITS_PROVIDER::m_iuScale

privateinherited

Definition at line 253 of file units_provider.h.

Referenced by GetIuScale(), and UNITS_PROVIDER().

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway

privateinherited

Definition at line 86 of file kiway_holder.h.

Referenced by HasKiway(), Kiway(), KIWAY_HOLDER(), and SetKiway().

◆ m_lastNetnamesViewport

BOX2D PCB_EDIT_FRAME::m_lastNetnamesViewport

private

Keep track of viewport so that track net labels can be adjusted when it changes.

Definition at line 865 of file pcb_edit_frame.h.

◆ m_lastToolbarIconSize

int EDA_DRAW_FRAME::m_lastToolbarIconSize

privateinherited

Definition at line 628 of file eda_draw_frame.h.

Referenced by CommonSettingsChanged(), EDA_DRAW_FRAME(), and LoadSettings().

◆ m_layerPairSettings

std::unique_ptr<LAYER_PAIR_SETTINGS> PCB_BASE_EDIT_FRAME::m_layerPairSettings

protectedinherited

Definition at line 280 of file pcb_base_edit_frame.h.

Referenced by GetLayerPairSettings(), and PCB_EDIT_FRAME::OnBoardLoaded().

◆ m_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault

protectedinherited

Definition at line 782 of file eda_base_frame.h.

Referenced by commonInit(), GERBVIEW_FRAME::GERBVIEW_FRAME(), LoadWindowState(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), and SCH_EDIT_FRAME::SCH_EDIT_FRAME().

◆ m_messagePanel

EDA_MSG_PANEL* EDA_DRAW_FRAME::m_messagePanel

protectedinherited

Definition at line 605 of file eda_draw_frame.h.

Referenced by AppendMsgPanel(), ClearMsgPanel(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_FRAME(), EraseMsgBox(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), handleActivateEvent(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SetMsgPanel(), SetMsgPanel(), SYMBOL_CHOOSER_FRAME::SYMBOL_CHOOSER_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ m_modal

bool KIWAY_PLAYER::m_modal

protectedinherited

Definition at line 190 of file kiway_player.h.

Referenced by IsModal(), KIWAY_PLAYER(), and SetModal().

◆ m_modal_loop

wxGUIEventLoop* KIWAY_PLAYER::m_modal_loop

protectedinherited

Points to nested event_loop. NULL means not modal and dismissed.

Definition at line 193 of file kiway_player.h.

Referenced by DismissModal(), IsDismissed(), KIWAY_PLAYER(), and ShowModal().

◆ m_modal_resultant_parent

wxWindow* KIWAY_PLAYER::m_modal_resultant_parent

protectedinherited

Definition at line 194 of file kiway_player.h.

Referenced by KIWAY_PLAYER(), and ShowModal().

◆ m_modal_ret_val

bool KIWAY_PLAYER::m_modal_ret_val

protectedinherited

Definition at line 196 of file kiway_player.h.

Referenced by DismissModal(), FOOTPRINT_WIZARD_FRAME::GetBuiltFootprint(), KIWAY_PLAYER(), and ShowModal().

◆ m_modal_string

wxString KIWAY_PLAYER::m_modal_string

protectedinherited

Definition at line 195 of file kiway_player.h.

Referenced by DismissModal(), and ShowModal().

◆ m_moveWarpsCursor

bool TOOLS_HOLDER::m_moveWarpsCursor

protectedinherited

Definition at line 190 of file tools_holder.h.

Referenced by CommonSettingsChanged(), GetMoveWarpsCursor(), and TOOLS_HOLDER().

◆ m_mruPath

wxString EDA_BASE_FRAME::m_mruPath

protectedinherited

Definition at line 813 of file eda_base_frame.h.

Referenced by commonInit(), FOOTPRINT_EDIT_FRAME::ExportFootprint(), BITMAP2CMP_FRAME::ExportPcbnewFormat(), SYMBOL_EDIT_FRAME::ExportSymbol(), GetMruPath(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), SYMBOL_EDIT_FRAME::ImportSymbol(), GERBVIEW_FRAME::LoadFileOrShowDialog(), GERBVIEW_FRAME::LoadGerberJobFile(), SCH_EDIT_FRAME::LoadProject(), LoadWindowSettings(), GERBVIEW_FRAME::LoadZipArchiveFile(), SCH_EDIT_FRAME::NewProject(), BITMAP2CMP_FRAME::OnLoadFile(), GERBVIEW_FRAME::OpenProjectFiles(), SaveWindowSettings(), and SetMruPath().

◆ m_msgFrameHeight

int EDA_DRAW_FRAME::m_msgFrameHeight

protectedinherited

Definition at line 606 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME().

◆ m_netInspectorPanel

NET_INSPECTOR_PANEL* EDA_DRAW_FRAME::m_netInspectorPanel

protectedinherited

Definition at line 611 of file eda_draw_frame.h.

Referenced by PCB_EDIT_FRAME::doCloseWindow(), EDA_DRAW_FRAME(), PCB_EDIT_FRAME::OnBoardLoaded(), PCB_EDIT_FRAME::SaveSettings(), ShowChangedLanguage(), PCB_EDIT_FRAME::ShowChangedLanguage(), PCB_EDIT_FRAME::ToggleNetInspector(), and PCB_EDIT_FRAME::UpdateUserInterface().

◆ m_normalFramePos

wxPoint EDA_BASE_FRAME::m_normalFramePos

protectedinherited

Definition at line 786 of file eda_base_frame.h.

Referenced by LoadWindowState(), OnMaximize(), and SaveWindowSettings().

◆ m_normalFrameSize

wxSize EDA_BASE_FRAME::m_normalFrameSize

protectedinherited

Definition at line 787 of file eda_base_frame.h.

Referenced by LoadWindowState(), OnMaximize(), and SaveWindowSettings().

◆ m_openGLFailureOccured

bool EDA_DRAW_FRAME::m_openGLFailureOccured = false

staticprotectedinherited

Has any failure occurred when switching to OpenGL in any EDA_DRAW_FRAME?

Definition at line 618 of file eda_draw_frame.h.

Referenced by CommonSettingsChanged(), resolveCanvasType(), FOOTPRINT_EDIT_FRAME::resolveCanvasType(), and ~EDA_DRAW_FRAME().

◆ m_originTransforms

PCB_ORIGIN_TRANSFORMS PCB_BASE_FRAME::m_originTransforms

protectedinherited

Definition at line 437 of file pcb_base_frame.h.

Referenced by GetOriginTransforms(), MessageTextFromCoord(), PCB_BASE_FRAME(), and UpdateStatusBar().

◆ m_overrideLocksCb

wxCheckBox* EDA_DRAW_FRAME::m_overrideLocksCb

protectedinherited

Definition at line 599 of file eda_draw_frame.h.

Referenced by configureToolbars(), EDA_DRAW_FRAME(), and GetOverrideLocks().

◆ m_pcb

BOARD* PCB_BASE_FRAME::m_pcb

protectedinherited

Definition at line 435 of file pcb_base_frame.h.

Referenced by PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), ActivateGalCanvas(), Compile_Ratsnest(), PCB_EDIT_FRAME::Edit_Zone_Params(), GetAuxOrigin(), GetBoard(), GetBoardBoundingBox(), GetCollectorsGuide(), GetDesignSettings(), GetDocumentExtents(), GetGridOrigin(), PCB_EDIT_FRAME::GetModel(), GetPageSettings(), GetPageSizeIU(), GetPlotSettings(), GetTitleBlock(), loadFootprint(), PCB_EDIT_FRAME::LoadFootprints(), PCB_EDIT_FRAME::OnBoardLoaded(), PCB_EDIT_FRAME::onCloseModelessBookReporterDialogs(), PCB_BASE_FRAME(), PlaceFootprint(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::RebuildAndRefresh(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), PCB_BASE_EDIT_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_BASE_EDIT_FRAME::SetBoard(), SetBoard(), PCB_EDIT_FRAME::SetBoard(), SetGridOrigin(), SetPageSettings(), PCB_EDIT_FRAME::SetPageSettings(), SetPlotSettings(), SetTitleBlock(), PCB_EDIT_FRAME::setupTools(), SwitchLayer(), FOOTPRINT_CHOOSER_FRAME::~FOOTPRINT_CHOOSER_FRAME(), and ~PCB_BASE_FRAME().

◆ m_perspective

wxString EDA_BASE_FRAME::m_perspective

protectedinherited

Definition at line 792 of file eda_base_frame.h.

Referenced by LoadWindowSettings(), and RestoreAuiLayout().

◆ m_polarCoords

bool EDA_DRAW_FRAME::m_polarCoords

protectedinherited

Definition at line 592 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), GetShowPolarCoords(), PCB_BASE_FRAME::LoadSettings(), PCB_BASE_FRAME::SaveSettings(), and SetShowPolarCoords().

◆ m_prevIconVal

LAYER_TOOLBAR_ICON_VALUES PCB_EDIT_FRAME::m_prevIconVal

protected

Definition at line 715 of file pcb_edit_frame.h.

Referenced by PrepareLayerIndicator().

◆ m_probingSchToPcb

bool PCB_EDIT_FRAME::m_probingSchToPcb

Definition at line 826 of file pcb_edit_frame.h.

Referenced by KiwayMailIn(), and OnCrossProbeFlashTimer().

◆ m_propertiesPanel

◆ m_redoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_redoList

protectedinherited

Definition at line 811 of file eda_base_frame.h.

Referenced by PCB_BASE_EDIT_FRAME::ClearUndoORRedoList(), PL_EDITOR_FRAME::ClearUndoORRedoList(), SCH_EDIT_FRAME::ClearUndoORRedoList(), SYMBOL_EDIT_FRAME::ClearUndoORRedoList(), GetRedoActionDescription(), GetRedoCommandCount(), PopCommandFromRedoList(), and PushCommandToRedoList().

◆ m_replaceStringHistoryList

wxArrayString EDA_DRAW_FRAME::m_replaceStringHistoryList

protectedinherited

Definition at line 603 of file eda_draw_frame.h.

Referenced by SCH_BASE_FRAME::doCloseWindow(), LoadSettings(), SCH_BASE_FRAME::OnFindDialogClose(), SaveSettings(), and SCH_BASE_FRAME::ShowFindReplaceDialog().

◆ m_searchPane

SEARCH_PANE* EDA_DRAW_FRAME::m_searchPane

protectedinherited

Definition at line 609 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), PCB_EDIT_FRAME::FocusSearch(), SCH_EDIT_FRAME::FocusSearch(), PCB_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), ShowChangedLanguage(), PCB_EDIT_FRAME::ToggleSearch(), and SCH_EDIT_FRAME::ToggleSearch().

◆ m_selectionFilterPanel

PANEL_SELECTION_FILTER* PCB_BASE_EDIT_FRAME::m_selectionFilterPanel

protectedinherited

Definition at line 278 of file pcb_base_edit_frame.h.

Referenced by FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), PCB_BASE_EDIT_FRAME(), FOOTPRINT_EDIT_FRAME::ShowChangedLanguage(), and PCB_EDIT_FRAME::ShowChangedLanguage().

◆ m_SelLayerBox

PCB_LAYER_BOX_SELECTOR* PCB_BASE_EDIT_FRAME::m_SelLayerBox

protectedinherited

Definition at line 284 of file pcb_base_edit_frame.h.

Referenced by configureToolbars(), PCB_BASE_EDIT_FRAME(), FOOTPRINT_EDIT_FRAME::ReCreateLayerBox(), PCB_EDIT_FRAME::ReCreateLayerBox(), and PCB_EDIT_FRAME::UpdateUserInterface().

◆ m_SelTrackWidthBox

wxChoice* PCB_EDIT_FRAME::m_SelTrackWidthBox

Definition at line 817 of file pcb_edit_frame.h.

Referenced by configureToolbars(), OnUpdateSelectTrackWidth(), and Tracks_and_Vias_Size_Event().

◆ m_SelViaSizeBox

wxChoice* PCB_EDIT_FRAME::m_SelViaSizeBox

Definition at line 818 of file pcb_edit_frame.h.

Referenced by configureToolbars(), OnUpdateSelectViaSize(), and Tracks_and_Vias_Size_Event().

◆ m_settingsManager

SETTINGS_MANAGER* EDA_BASE_FRAME::m_settingsManager

protectedinherited

Definition at line 799 of file eda_base_frame.h.

Referenced by commonInit(), and GetSettingsManager().

◆ m_show_layer_manager_tools

bool PCB_EDIT_FRAME::m_show_layer_manager_tools

Definition at line 820 of file pcb_edit_frame.h.

Referenced by doCloseWindow(), LoadSettings(), and ToggleLayersManager().

◆ m_show_net_inspector

bool PCB_EDIT_FRAME::m_show_net_inspector

Definition at line 822 of file pcb_edit_frame.h.

Referenced by LoadSettings(), SaveSettings(), and ToggleNetInspector().

◆ m_show_search

bool PCB_EDIT_FRAME::m_show_search

Definition at line 821 of file pcb_edit_frame.h.

Referenced by LoadSettings(), SaveSettings(), and ToggleSearch().

◆ m_showBorderAndTitleBlock

bool EDA_DRAW_FRAME::m_showBorderAndTitleBlock

protectedinherited

Definition at line 595 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_BASE_FRAME::GetBoardBoundingBox(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PrintDrawingSheet(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), and GERBVIEW_FRAME::SetElementVisibility().

◆ m_sockets

std::vector<wxSocketBase*> KIWAY_PLAYER::m_sockets

protectedinherited

Definition at line 199 of file kiway_player.h.

Referenced by OnSockRequestServer(), and ~KIWAY_PLAYER().

◆ m_socketServer

wxSocketServer* EDA_DRAW_FRAME::m_socketServer

protectedinherited

Prevents opening same file multiple times.

Definition at line 582 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME().

◆ m_spaceMouse

std::unique_ptr<NL_PCBNEW_PLUGIN> PCB_BASE_FRAME::m_spaceMouse

privateinherited

Definition at line 441 of file pcb_base_frame.h.

Referenced by ActivateGalCanvas(), handleActivateEvent(), and handleIconizeEvent().

◆ m_supportsAutoSave

bool EDA_BASE_FRAME::m_supportsAutoSave

protectedinherited

Definition at line 802 of file eda_base_frame.h.

Referenced by commonInit(), EDA_DRAW_FRAME::CommonSettingsChanged(), ProcessEvent(), and SCH_EDIT_FRAME::SCH_EDIT_FRAME().

◆ m_tabbedPanel

wxAuiNotebook* PCB_BASE_EDIT_FRAME::m_tabbedPanel

protectedinherited

Definition at line 286 of file pcb_base_edit_frame.h.

Referenced by PCB_BASE_EDIT_FRAME().

◆ m_tbLeft

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbLeft

protectedinherited

Definition at line 839 of file eda_base_frame.h.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EDA_BASE_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), OnToolbarSizeChanged(), KICAD_MANAGER_FRAME::onToolbarSizeChanged(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), RecreateToolbars(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SelectLeftToolbarAction(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and UpdateToolbarControlSizes().

◆ m_tbRight

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbRight

protectedinherited

Definition at line 838 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), OnToolbarSizeChanged(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), RecreateToolbars(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and UpdateToolbarControlSizes().

◆ m_tbTopAux

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbTopAux

protectedinherited

Definition at line 837 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), OnToolbarSizeChanged(), PCB_EDIT_FRAME::PrepareLayerIndicator(), PCB_EDIT_FRAME::ReCreateLayerBox(), RecreateToolbars(), and UpdateToolbarControlSizes().

◆ m_tbTopMain

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbTopMain

protectedinherited

Definition at line 836 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::configureToolbars(), SYMBOL_VIEWER_FRAME::configureToolbars(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), EDA_BASE_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), OnToolbarSizeChanged(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), RecreateToolbars(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SIMULATOR_FRAME::SIMULATOR_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), and UpdateToolbarControlSizes().

◆ m_toolbarControlFactories

std::map<std::string, ACTION_TOOLBAR_CONTROL_FACTORY> EDA_BASE_FRAME::m_toolbarControlFactories

protectedinherited

Definition at line 841 of file eda_base_frame.h.

Referenced by GetCustomToolbarControlFactory(), and RegisterCustomToolbarControlFactory().

◆ m_toolbarSettings

TOOLBAR_SETTINGS* EDA_BASE_FRAME::m_toolbarSettings

protectedinherited

Definition at line 833 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), RecreateToolbars(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SIMULATOR_FRAME::SIMULATOR_FRAME(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ m_toolDispatcher

TOOL_DISPATCHER* TOOLS_HOLDER::m_toolDispatcher

protectedinherited

Definition at line 173 of file tools_holder.h.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GetToolDispatcher(), EDA_BASE_FRAME::OnMenuEvent(), PANEL_PREVIEW_3D_MODEL::OnMenuEvent(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), PCB_TEST_FRAME_BASE::SetBoard(), FOOTPRINT_EDIT_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIMULATOR_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), TOOLS_HOLDER(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME(), and PCB_CALCULATOR_FRAME::~PCB_CALCULATOR_FRAME().

◆ m_toolManager

TOOL_MANAGER* TOOLS_HOLDER::m_toolManager

protectedinherited

Definition at line 171 of file tools_holder.h.

◆ m_toolStack

std::vector<std::string> TOOLS_HOLDER::m_toolStack

protectedinherited

Definition at line 177 of file tools_holder.h.

Referenced by CurrentToolName(), IsCurrentTool(), PopTool(), PushTool(), and ToolStackIsEmpty().

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type

privateinherited

Definition at line 87 of file kiway_holder.h.

Referenced by GetType(), and KIWAY_HOLDER().

◆ m_uiUpdateMap

std::map<int, UIUpdateHandler> EDA_BASE_FRAME::m_uiUpdateMap

protectedinherited

Map containing the UI update handlers registered with wx for each action.

Definition at line 818 of file eda_base_frame.h.

Referenced by RegisterUIUpdateHandler(), and UnregisterUIUpdateHandler().

◆ m_undoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_undoList

protectedinherited

Definition at line 810 of file eda_base_frame.h.

Referenced by PCB_BASE_EDIT_FRAME::ClearUndoORRedoList(), PL_EDITOR_FRAME::ClearUndoORRedoList(), SCH_EDIT_FRAME::ClearUndoORRedoList(), SYMBOL_EDIT_FRAME::ClearUndoORRedoList(), GetUndoActionDescription(), GetUndoCommandCount(), PopCommandFromUndoList(), PushCommandToUndoList(), and SCH_EDIT_FRAME::RecalculateConnections().

◆ m_undoRedoBlocked

bool PCB_BASE_EDIT_FRAME::m_undoRedoBlocked

protectedinherited

Definition at line 276 of file pcb_base_edit_frame.h.

Referenced by PCB_BASE_EDIT_FRAME(), UndoRedoBlock(), and UndoRedoBlocked().

◆ m_undoRedoCountMax

int EDA_DRAW_FRAME::m_undoRedoCountMax

protectedinherited

Definition at line 590 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), and LoadSettings().

◆ m_userUnits

EDA_UNITS UNITS_PROVIDER::m_userUnits

privateinherited

Definition at line 254 of file units_provider.h.

Referenced by GetUserUnits(), SetUserUnits(), and UNITS_PROVIDER().

◆ m_vertexEditorPane

PCB_VERTEX_EDITOR_PANE* PCB_BASE_EDIT_FRAME::m_vertexEditorPane

protectedinherited

Definition at line 282 of file pcb_base_edit_frame.h.

Referenced by CloseVertexEditor(), OnVertexEditorPaneClosed(), OpenVertexEditor(), PCB_BASE_EDIT_FRAME(), and UpdateVertexEditorSelection().

◆ m_watcher

std::unique_ptr<wxFileSystemWatcher> PCB_BASE_FRAME::m_watcher

privateinherited

Definition at line 446 of file pcb_base_frame.h.

Referenced by setFPWatcher().

◆ m_watcherDebounceTimer

wxTimer PCB_BASE_FRAME::m_watcherDebounceTimer

privateinherited

Definition at line 449 of file pcb_base_frame.h.

Referenced by OnFPChange(), OnFpChangeDebounceTimer(), and PCB_BASE_FRAME().

◆ m_watcherFileName

wxFileName PCB_BASE_FRAME::m_watcherFileName

privateinherited

Definition at line 447 of file pcb_base_frame.h.

Referenced by OnFPChange(), OnFpChangeDebounceTimer(), and setFPWatcher().

◆ m_watcherLastModified

wxDateTime PCB_BASE_FRAME::m_watcherLastModified

privateinherited

Definition at line 448 of file pcb_base_frame.h.

Referenced by OnFpChangeDebounceTimer(), and setFPWatcher().

◆ m_ZoneFillsDirty

bool PCB_EDIT_FRAME::m_ZoneFillsDirty

Definition at line 824 of file pcb_edit_frame.h.

Referenced by OnModify().

◆ m_zoomSelectBox

wxChoice* EDA_DRAW_FRAME::m_zoomSelectBox

protectedinherited

Definition at line 598 of file eda_draw_frame.h.

Referenced by configureToolbars(), EDA_DRAW_FRAME(), OnSelectZoom(), OnUpdateSelectZoom(), and UpdateZoomSelectBox().

◆ NullUiString

const wxString UNITS_PROVIDER::NullUiString = ""

inlinestaticinherited

The string that is used in the UI to represent a null value.

Definition at line 250 of file units_provider.h.

Referenced by WX_GRID::GetOptionalUnitValue(), WX_GRID::onCellEditorHidden(), OptionalValueFromString(), and StringFromOptionalValue().

The documentation for this class was generated from the following files:

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

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

◆ ~PCB_EDIT_FRAME()

◆ PCB_EDIT_FRAME()

Member Function Documentation

◆ ActivateGalCanvas()

◆ addActionPluginTools()

◆ AddApiPluginTools()

◆ AddBoardChangeListener()

◆ AddFootprintToBoard()

◆ AddLibrary()

◆ AddMenuLanguageList()

◆ AddStandardHelpMenu()

◆ AddStandardSubMenus()

◆ AngleValueFromString()

◆ AppearancePanelName()

◆ AppendCopyToUndoList()

◆ AppendMsgPanel()

◆ buildActionPluginMenus()

◆ CanAcceptApiCommands()

◆ canCloseWindow()

◆ ChangeUserUnits()

◆ Clear_Pcb()

◆ ClearFileHistory()

◆ ClearFocus()

◆ ClearListAndDeleteItems()

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ CloseVertexEditor()

◆ commonInit()

◆ CommonSettingsChanged()

◆ Compile_Ratsnest()

◆ config()

◆ ConfigBaseName()

◆ configureToolbars()

◆ CreateAndShow3D_Frame()

◆ CreateHotkeyPopup()

◆ CreateInfoBar()

◆ CreateNewFootprint()

◆ CreateNewLibrary()

◆ createNewLibrary()

◆ CreateNewProjectLibrary()

◆ CreateServer()

◆ CurrentToolName()

◆ DesignBlocksPaneName()

◆ Destroy()

◆ DismissModal()

◆ DisplayConstraintsMsg()

◆ DisplayGridMsg()

◆ DisplayToolMsg()

◆ DisplayUnitsMsg()

◆ DoAutoSave()

◆ doAutoSave()

◆ doCloseWindow()

◆ DoGenFootprintsPositionFile()

◆ doReCreateMenuBar()

◆ DoWithAcceptedFiles()

◆ Edit_Zone_Params()

◆ ensureWindowIsOnScreen()

◆ EraseMsgBox()

◆ ExchangeFootprint()

◆ ExecuteRemoteCommand()

◆ Export_IDF3()

◆ ExportFootprintsToLibrary()