The symbol library editor main window. More...

#include <symbol_edit_frame.h>

Inheritance diagram for SYMBOL_EDIT_FRAME:

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
	SYMBOL_EDIT_FRAME (KIWAY aKiway, wxWindow aParent)

	~SYMBOL_EDIT_FRAME () override

std::unique_ptr< GRID_HELPER >	MakeGridHelper () override

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

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

bool	HasLibModifications () const
	Check if any pending libraries have been modified.

bool	CanCloseSymbolFromSchematic (bool doClose)

LIB_TREE *	GetLibTree () const override

EDITOR_TABS_PANEL *	GetTabsPanel () const
	The tab strip fronting the shared canvas, or nullptr before it is mounted.

void	OnTabCharHook (wxKeyEvent &aEvent)
	Cycle symbol tabs from the char hook, since GTK cannot register WXK_TAB as an accelerator.

void	clearSymbolTabsModifiedForLibrary (const wxString &aLibrary)
	Clear the unsaved-edits flag on every tab in a saved library so its dirty indicator clears.

LIB_ID	GetTreeLIBID (int *aUnit=nullptr) const
	Return the LIB_ID of the library or symbol selected in the symbol tree.

int	GetTreeSelectionCount () const

int	GetTreeLIBIDs (std::vector< LIB_ID > &aSelection) const

LIB_SYMBOL *	GetCurSymbol () const
	Return the current symbol being edited or NULL if none selected.

void	SetCurSymbol (LIB_SYMBOL *aSymbol, bool aUpdateZoom)
	Take ownership of aSymbol and notes that it is the one currently being edited.

LIB_SYMBOL_LIBRARY_MANAGER &	GetLibManager ()

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

bool	SynchronizePins ()

wxString	AddLibraryFile (bool aCreateNew)
	Create or add an existing library to the symbol library table.

void	DdAddLibrary (wxString aLibFile)
	Add a library dropped file to the symbol library table.

void	CreateNewSymbol (const wxString &newName=wxEmptyString)
	Create a new symbol in the selected library.

void	ImportSymbol ()

void	ExportSymbol ()

void	Save ()
	Save the selected symbol or library.

void	SaveSymbolCopyAs (bool aOpenCopy)
	Save the currently selected symbol to a new name and/or location.

void	SaveLibraryAs (SAVE_LIBRARY_AS aSaveType=SAVE_LIBRARY_AS::NEW)
	Save the currently selected library to a new file.

void	SaveAll ()
	Save all modified symbols and libraries.

bool	SaveLibraryHeadless (const wxString &aLibrary)
	Save the given library (including buffered changes) without user interaction.

void	Revert (LIB_ID &aTarget, bool aConfirm=true)
	Revert unsaved changes in a symbol, restoring to the last saved state.

void	RevertAll ()

void	DeleteSymbolFromLibrary ()

void	RenameSymbolTab (const LIB_ID &aOldId, const LIB_ID &aNewId)
	Update the open tab for aOldId, if any, to the renamed symbol aNewId so its label and key track the rename.

void	CopySymbolToClipboard ()

void	LoadSymbol (const wxString &aLibrary, const wxString &aSymbol, int Unit)

void	DuplicateSymbol (bool aFromClipboard)
	Insert a duplicate symbol.

void	OnSelectUnit (wxCommandEvent &event)

void	OnSelectBodyStyle (wxCommandEvent &event)

void	ToggleProperties () override

void	ToggleLibraryTree () override

bool	IsLibraryTreeShown () const override

void	FocusLibraryTreeInput () override

void	FreezeLibraryTree ()

void	ThawLibraryTree ()

bool	IsSyncLibrariesInProgress () const

void	OnUpdateUnitNumber (wxUpdateUIEvent &event)

void	OnUpdateBodyStyle (wxUpdateUIEvent &event)

void	UpdateAfterSymbolProperties (wxString *aOldName=nullptr)

void	RebuildSymbolUnitAndBodyStyleLists ()

bool	canCloseWindow (wxCloseEvent &aCloseEvent) override

void	doCloseWindow () override

void	OnExitKiCad (wxCommandEvent &event)

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.

SYMBOL_EDITOR_SETTINGS *	GetSettings () const

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

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

void	CloseWindow (wxCommandEvent &event)
	Trigger the wxCloseEvent, which is handled by the function given to EVT_CLOSE() macro:

void	OnModify () override
	Must be called after a schematic change in order to set the "modify" flag of the current symbol.

int	GetUnit () const

void	SetUnit (int aUnit)

int	GetBodyStyle () const

void	SetBodyStyle (int aBodyStyle)

void	SetDrawSpecificUnit (bool aSpecific)

bool	GetDrawSpecificUnit () const

void	SetDrawSpecificBodyStyle (bool aSpecific)

bool	GetDrawSpecificBodyStyle () const

bool	GetShowInvisibleFields ()

bool	GetShowInvisiblePins ()

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

void	UpdateMsgPanel () override
	Redraw the message panel.

void	UpdateTitle ()
	Update the main window title bar with the current library name and read only status of the library.

bool	IsSymbolFromSchematic () const

bool	IsSymbolFromLegacyLibrary () const

void	UpdateSymbolMsgPanelInfo ()
	Display the documentation of the selected symbol.

void	SaveCopyInUndoList (const wxString &aDescription, LIB_SYMBOL *aSymbol, UNDO_REDO aUndoType=UNDO_REDO::LIBEDIT)
	Create a copy of the current symbol, and save it in the undo list.

void	PushSymbolToUndoList (const wxString &aDescription, LIB_SYMBOL *aSymbolCopy, UNDO_REDO aUndoType=UNDO_REDO::LIBEDIT)

void	GetSymbolFromUndoList ()

void	GetSymbolFromRedoList ()

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

bool	LoadSymbol (const LIB_ID &aLibId, int aUnit, int aBodyStyle)
	Select the currently active library and loads the symbol from aLibId.

void	SVGPlotSymbol (const wxString &aFullFileName)
	Create the SVG print file for the current edited symbol.

void	SyncLibraries (bool aShowProgress, bool aPreloadCancelled=false, const wxString &aForceRefresh=wxEmptyString)
	Synchronize the library manager to the symbol library table, and then the symbol tree to the library manager.

void	RefreshLibraryTree ()
	Redisplay the library tree.

void	UpdateLibraryTree (const wxDataViewItem &aTreeItem, LIB_SYMBOL *aSymbol)
	Update a symbol node in the library tree.

LIB_ID	GetTargetLibId () const override
	Return either the symbol selected in the symbol tree (if context menu is active) or the symbol on the editor canvas.

std::vector< LIB_ID >	GetSelectedLibIds () const

void	FocusOnLibId (const LIB_ID &aLibID)

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

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

void	SetScreen (BASE_SCREEN *aScreen) override

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

void	RebuildView ()

void	UpdateItem (EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false) override
	Mark an item for refresh.

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

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

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

void	LoadSymbolFromSchematic (SCH_SYMBOL *aSymbol)
	Load a symbol from the schematic to edit in place.

bool	IsSymbolEditable () const
	Test if a symbol is loaded and can be edited.

bool	IsSymbolGraphicallyEditable () const
	Test if a symbol is loaded and can be edited graphically.

bool	IsSymbolAlias () const

bool	IsCurrentSymbol (const LIB_ID &aLibId) const
	Return true if aLibId is an alias for the editor screen symbol.

void	emptyScreen ()
	Restore the empty editor screen, without any symbol or library selected.

void	ClearToolbarControl (int aId) override

void	createCanvas ()

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

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

EESCHEMA_SETTINGS *	eeconfig () const

SYMBOL_EDITOR_SETTINGS *	libeditconfig () const

APP_SETTINGS_BASE *	GetViewerSettingsBase () const

SCH_RENDER_SETTINGS *	GetRenderSettings ()

COLOR4D	GetDrawBgColor () const override

virtual bool	GetShowAllPins () const
	Allow some frames to show/hide hidden pins.

void	SetPageSettings (const PAGE_INFO &aPageSettings) override

const PAGE_INFO &	GetPageSettings () const override

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

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

void	SetGridOrigin (const VECTOR2I &aPoint) override

const TITLE_BLOCK &	GetTitleBlock () const override

void	SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override

void	UpdateStatusBar () override
	Update the status bar information.

PICKED_SYMBOL	PickSymbolFromLibrary (const SYMBOL_LIBRARY_FILTER aFilter, std::vector< PICKED_SYMBOL > &aHistoryList, std::vector< PICKED_SYMBOL > &aAlreadyPlaced, bool aShowFootprints, const LIB_ID aHighlight=nullptr, bool aAllowFields=true, SYMBOL_COMPAT_FUNC aCompatFunc=nullptr)
	Call the library viewer to select symbol to import into schematic.

LIB_SYMBOL *	GetLibSymbol (const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
	Load symbol from symbol library table.

wxString	SelectLibrary (const wxString &aDialogTitle, const wxString &aListLabel, const std::vector< std::pair< wxString, bool * > > &aExtraCheckboxes={})
	Display a list of loaded libraries and allows the user to select a library.

virtual void	RedrawScreen (const VECTOR2I &aCenterPoint, bool aWarpPointer)

void	AddToScreen (EDA_ITEM aItem, SCH_SCREEN aScreen=nullptr) override
	Add an item to the screen (and view) aScreen is the screen the item is located on, if not the current screen.

void	RemoveFromScreen (EDA_ITEM aItem, SCH_SCREEN aScreen) override
	Remove an item from the screen (and view) aScreen is the screen the item is located on, if not the current screen.

void	RefreshZoomDependentItems ()
	Mark selected items for refresh.

void	SyncView ()
	Mark all items for refresh.

void	ShowFindReplaceDialog (bool aReplace)
	Run the Find or Find & Replace dialog.

DIALOG_SCH_FIND *	GetFindReplaceDialog () const

void	ShowFindReplaceStatus (const wxString &aMsg, int aStatusTime)

void	ClearFindReplaceStatus ()

void	OnFindDialogClose ()
	Notification that the Find dialog has closed.

COLOR4D	GetLayerColor (SCH_LAYER_ID aLayer)
	Helper to retrieve a layer color from the global color settings.

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

void	OnSymChange (wxFileSystemWatcherEvent &aEvent)
	Handler for Symbol change events.

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

void	SetSymModificationTime (long long aTimestamp)
	Set the modification timestamp of the watched symbol library.

SCH_SELECTION_TOOL *	GetSelectionTool () override

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

void	HighlightSelectionFilter (const SCH_SELECTION_FILTER_OPTIONS &aOptions)

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

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

EDA_SEARCH_DATA &	GetFindReplaceData ()

wxArrayString &	GetFindHistoryList ()

wxArrayString &	GetReplaceHistoryList ()

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 void	SetDrawBgColor (const COLOR4D &aColor)

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

virtual void	SetGridVisibility (bool aVisible)

bool	IsGridOverridden ()

virtual void	SetGridOverrides (bool aOverride)

virtual COLOR4D	GetGridColor ()

virtual void	SetGridColor (const COLOR4D &aColor)

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.

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.

PROPERTIES_PANEL *	GetPropertiesPanel ()

virtual void	UpdateProperties ()

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

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

size_t	AddApiPluginMenuItems (ACTION_MENU *aMenu)
	Append actions from API plugins to the given menu.

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

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

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)

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

void	ChangeUserUnits (EDA_UNITS aUnits)

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

SETTINGS_MANAGER *	GetSettingsManager () const

virtual SEVERITY	GetSeverity (int aErrorCode) const

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

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	SelectToolbarAction (const TOOL_ACTION &aAction) override
	Select the given action in the 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 (const wxString &aStartPage, const 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, INFOBAR_MESSAGE_TYPE aType=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.

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.

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

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 wxString	GetCurrentFileName () const
	Get the full filename + path of the currently opened file in the frame.

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.

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

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

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.

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

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	MessageTextFromUnscaledValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) 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.

virtual void	IntersheetRefUpdate (SCH_GLOBALLABEL *aItem)

Static Public Member Functions
static void	clearTabModifiedState (SYMBOL_EDITOR_TAB_CONTEXT &aContext, EDITOR_TABS_MODEL &aModel)
	Clear a tab's dirty state on both the context (read on repaint) and the strip model (read on close), keeping the two stores that diverge after a save in agreement.

static void	clearSymbolTabUndoRedo (SYMBOL_EDITOR_TAB_CONTEXT &aContext)
	Free a detached context's undo/redo, which the frame's own teardown path never reaches.

static void	freeTransientUndoCommands (UNDO_REDO_CONTAINER &aList, const LIB_SYMBOL *aLiveSymbol)
	Free every command in the list and the UR_TRANSIENT-flagged copies it owns, which the shared deleters miss.

static bool	libTreeAutoHiddenForSchematicEdit (bool aWasFromSchematic, bool aRestorePending, bool aTreeShownNow)
	Resolve whether the library tree's auto-hide for a schematic edit still needs restoring on save.

static const wxString	PropertiesPaneName ()

static const wxString	NetInspectorPanelName ()

static const wxString	DesignBlocksPaneName ()

static const wxString	RemoteSymbolPaneName ()

static const wxString	AppearancePanelName ()

static void	SetOpenGLFailureOccurred ()
	Keep every frame on the fallback canvas for this session without changing the saved preference.

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.

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

Protected Member Functions
void	configureToolbars () override

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

void	doReCreateMenuBar () override

PLUGIN_ACTION_SCOPE	PluginActionScope () const override

void	updateSelectionFilterVisbility () override
	Selection filter panel doesn't have a dedicated visibility control, so show it if any other AUI panel is shown and docked.

void	onPluginAvailabilityChanged (wxCommandEvent &aEvt)

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

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

void	setSymWatcher (const LIB_ID *aSymbol)
	Creates (or removes) a watcher on the specified symbol library.

const TOOL_ACTION *	drawArcAction (ARC_DRAW_MODE aMode) const override
	The action that starts the arc tool in aMode, or nullptr in a frame without an arc tool.

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.

void	setArcModeConditions (const TOOL_ACTION &aDrawArc, const std::function< bool(const SELECTION &)> &aEnable)
	Check each arc mode's tool action while the arc tool runs in that mode.

void	syncToolbarSelections () override
	Called after the toolbars are rebuilt so a frame can select the group entries that reflect its saved state.

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_MAIL_EVENT &aEvent)
	Event handler, routes to derivative specific virtual KiwayMailIn().

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.

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

virtual bool	canRunAutoSave () const
	Return true when it is safe to run an autosave snapshot right now.

void	CheckForAutosaveFiles (const wxString &aProjectPath, const std::vector< wxString > &aExtensions)
	Check for autosave files newer than their source files for the given project.

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	saveProjectSettings ()
	Save any design-related project settings associated with this frame.

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.

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

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

Protected Attributes
PANEL_SCH_SELECTION_FILTER *	m_selectionFilterPanel

DIALOG_SCH_FIND *	m_findReplaceDialog

SCHEMATIC_SETTINGS	m_base_frame_defaults
	Only used by symbol_editor. Eeschema should be using the one inside the SCHEMATIC.

wxSocketServer *	m_socketServer

std::unique_ptr< LOCKFILE >	m_file_checker
	Prevents opening same file multiple times.

COLOR4D	m_gridColor

COLOR4D	m_drawBgColor

int	m_undoRedoCountMax

bool	m_polarCoords

bool	m_showBorderAndTitleBlock

wxChoice *	m_gridSelectBox

wxChoice *	m_zoomSelectBox

int	m_zoomCustomEntry

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

std::unique_ptr< nlohmann::json >	m_auiLayoutState

WX_INFOBAR *	m_infoBar

APPEARANCE_CONTROLS_3D *	m_appearancePanel

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

wxDateTime	m_autoSaveDeferredSince

UNDO_REDO_CONTAINER	m_undoList

UNDO_REDO_CONTAINER	m_redoList

wxString	m_mruPath

ORIGIN_TRANSFORMS	m_originTransforms

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

bool	m_uiUpdateHandlerBound
	True once the single wxID_ANY UPDATE_UI handler has been bound.

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

bool	m_closeInProgress
	Set while windowClosing() is deciding whether the frame may 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	setupTools ()

void	updateInfoBar ()

void	saveSymbolCopyAs (bool aOpenCopy)

bool	saveLibrary (const wxString &aLibrary, SAVE_LIBRARY_AS aSaveType=SAVE_LIBRARY_AS::ORIGINAL)
	Save the changes to the current library.

bool	LoadSymbolFromLib (const wxString &aLibName, const wxString &aSymbolName, int aUnit=0, int aBodyStyle=0)
	Load a symbol from a library, optionally setting the selected unit and body style.

bool	LoadOneLibrarySymbol (LIB_SYMBOL *aLibEntry, const wxString &aLibrary, int aUnit, int aBodyStyle)
	Create a copy of aLibEntry into memory.

bool	backupLibrary (const wxFileName &aOriginalFile, wxString &aErrorMsg)
	Create a backup copy of a symbol library.

LIB_SYMBOL *	getTargetSymbol () const
	Return currently edited symbol.

wxString	getTargetLib () const
	Return either the library selected in the symbol tree, if context menu is active or the library that is currently modified.

void	centerItemIdleHandler (wxIdleEvent &aEvent)

bool	saveAllLibraries (bool aRequireConfirmation)
	Return true when the operation has succeeded (all requested libraries have been saved or none was selected and confirmed by OK).

bool	saveCurrentSymbol ()
	Save the current symbol.

void	ensureUniqueName (LIB_SYMBOL *aSymbol, const wxString &aLibrary)
	Rename LIB_SYMBOL aliases to avoid conflicts before adding a symbol to a library.

bool	addLibTableEntry (const wxString &aLibFile, LIBRARY_TABLE_SCOPE aScope=LIBRARY_TABLE_SCOPE::GLOBAL)
	Add aLibFile to the symbol library table defined by aScope.

bool	replaceLibTableEntry (const wxString &aLibNickname, const wxString &aLibFile)
	Replace the file path of the symbol library table entry aLibNickname with aLibFile.

void	detachActiveSymbolTab ()
	Snapshot the active tab's view and selection into its context without deleting the document.

void	activateSymbolTab (SYMBOL_EDITOR_TAB_CONTEXT *aContext)
	Make aContext the active tab, borrowing its working symbol, undo/redo, view and selection, without deleting the previously active document.

SYMBOL_EDITOR_TAB_CONTEXT *	findOrCreateSymbolTab (const wxString &aLib, const wxString &aName, int aUnit, int aBodyStyle, bool aAsPreview, bool *aWasCreated=nullptr)
	Open aName from aLib in a tab, creating it when absent, and return the activated context.

SYMBOL_EDITOR_TAB_CONTEXT *	findOrCreateSymbolInstanceTab (LIB_SYMBOL aSymbol, SCH_SCREEN aScreen, const KIID &aSchematicSymbolUUID, const wxString &aReference, int aUnit, int aBodyStyle)
	Find or create the instance tab for a placed schematic symbol and make it active.

SYMBOL_EDITOR_TAB_CONTEXT *	CreateUnsavedSymbolTab (LIB_SYMBOL aSymbol, SCH_SCREEN aScreen)
	Open a new tab over a transient working symbol and screen and make it active.

SYMBOL_EDITOR_TAB_CONTEXT *	symbolTabContextForIndex (int aIdx) const
	Resolve the tab context for a panel tab index, or nullptr.

SYMBOL_EDITOR_TAB_CONTEXT *	symbolTabContextForKey (const wxString &aKey) const
	Resolve the tab context for a tab key, or nullptr.

void	dropSymbolTabContext (const wxString &aKey)
	Drop the inactive context for aKey from m_tabContexts, freeing its undo/redo.

bool	promptAndCloseSymbolTab (int aIdx)
	Prompt for unsaved changes on the tab and drop its context.

bool	promptToSaveInactiveInstanceTabs ()
	Prompt to save each dirty instance (symbol from schematic) tab that is not the active one, since the active tab's unsaved state is handled by CanCloseSymbolFromSchematic.

bool	hasDirtyInactiveInstanceTabs () const
	True if any non-active instance (schematic) tab has unsaved edits.

void	closeAllSymbolTabsSilently ()
	Close every tab without prompting and return the frame to the empty state.

void	closeSymbolTab (const LIB_ID &aLibId)
	Close the open tab for aLibId, if any, without prompting and leaving the other tabs open.

EDITOR_TAB_CONTEXT::VIEW_SNAPSHOT	captureSymbolViewSnapshot () const
	Capture the current view zoom/center for the active tab's snapshot.

void	restoreSymbolViewSnapshot (const EDITOR_TAB_CONTEXT::VIEW_SNAPSHOT &aSnapshot)
	Restore a previously captured view zoom/center.

std::vector< KIID >	captureSymbolSelectionKiids () const
	Capture the KIIDs of the current selection for the active tab's snapshot.

void	restoreSymbolSelectionKiids (const std::vector< KIID > &aKiids)
	Reselect the items named by aKiids after a reload rebuilt the view.

void	restoreSymbolTabsFromSettings ()
	Recreate tabs from the persisted open-tab list once the libraries have loaded.

void	storeSymbolTabsToSettings ()
	Write the current tab set into the editor settings for the next session.

void	onUpdateUI (wxUpdateUIEvent &aEvent)

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
SCH_SCREEN *	m_dummyScreen
	Helper screen used when no symbol is loaded.

LIB_SYMBOL *	m_symbol

wxComboBox *	m_unitSelectBox

wxComboBox *	m_bodyStyleSelectBox

SYMBOL_TREE_PANE *	m_treePane

LIB_SYMBOL_LIBRARY_MANAGER *	m_libMgr

SYMBOL_EDITOR_SETTINGS *	m_settings

std::vector< std::unique_ptr< SYMBOL_EDITOR_TAB_CONTEXT > >	m_tabContexts

SYMBOL_EDITOR_TAB_CONTEXT *	m_activeTab = nullptr

EDITOR_TABS_PANEL *	m_tabsPanel = nullptr

bool	m_loadingSymbolTab = false

bool	m_silentSymbolTabClose = false
	While true, promptAndCloseSymbolTab() skips the unsaved-changes dialog.

LIB_ID	m_centerItemOnIdle

int	m_unit
	The unit number to edit and show.

int	m_bodyStyle
	Show the normal shape (m_bodyStyle <= 1) or the DeMorgan converted shape (m_bodyStyle > 1)

bool	m_drawSpecificUnit
	When editing a symbol: only apply new graphic items to the current unit.

bool	m_drawSpecificBodyStyle
	When editing a symbol: only apply new graphic items to the current body style.

bool	m_isSymbolFromSchematic
	Flag if the symbol being edited was loaded directly from a schematic.

bool	m_libTreeAutoHiddenForSchematicEdit
	True while a schematic-edit auto-hide of the library tree still needs restoring on save.

KIID	m_schematicSymbolUUID

wxString	m_reference
	RefDes of the symbol (only valid if symbol was loaded from schematic)

bool	m_syncLibrariesInProgress

std::unique_ptr< API_HANDLER_SYMBOL >	m_apiHandler

std::unique_ptr< API_HANDLER_COMMON >	m_apiHandlerCommon

std::unique_ptr< API_HANDLER_LIBRARIES >	m_apiLibrariesHandler

std::unique_ptr< wxFileSystemWatcher >	m_watcher
	These are file watchers for the symbol library tables.

wxFileName	m_watcherFileName

long long	m_watcherTimestamp

bool	m_watcherIsDir

wxTimer	m_watcherDebounceTimer

bool	m_inSymChangeTimerEvent

std::unique_ptr< NL_SCHEMATIC_PLUGIN >	m_spaceMouse

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

Static Private Attributes
static bool	m_showDeMorgan = false

Friends
struct	SYMBOL_EDITOR_TABS_TEST_FIXTURE

Detailed Description

The symbol library editor main window.

Definition at line 72 of file symbol_edit_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

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

Constructor & Destructor Documentation

◆ SYMBOL_EDIT_FRAME()

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

Definition at line 160 of file symbol_edit_frame.cpp.

References _, _HKI, activateSymbolTab(), configureToolbars(), EDA_BASE_FRAME::CreateInfoBar(), ACTIONS::ddAddLibrary, SCH_ACTIONS::ddImportGraphics, defaultPropertiesPaneInfo(), defaultSchSelectionFilterPaneInfo(), DESIGN_BLOCK, TOOL_DISPATCHER::DispatchWxEvent(), EDA_EVT_PLUGIN_AVAILABILITY_CHANGED, EDA_BASE_FRAME::FinishAUIInitialization(), FRAME_SCH_SYMBOL_EDITOR, PGM_BASE::GetApiServer(), GetAppSettings(), SCH_BASE_FRAME::GetCanvas(), GetColorSettings(), SCH_SELECTION_TOOL::GetFilter(), EDA_DRAW_FRAME::GetGalDisplayOptions(), SCH_BASE_FRAME::GetRenderSettings(), SCH_BASE_FRAME::GetScreen(), GetSettings(), GetToolbarSettings(), TOOLS_HOLDER::GetToolManager(), icon_libedit, icon_libedit_16, icon_libedit_32, KiBitmap(), KICAD_DEFAULT_DRAWFRAME_STYLE, FILEEXT::KiCadSymbolLibFileExtension, Kiface(), LAYER_SCHEMATIC_GRID_AXES, LIB_EDIT_FRAME_NAME, LoadSettings(), EDA_BASE_FRAME::m_aboutTitle, EDA_BASE_FRAME::m_acceptedExts, m_apiHandler, m_apiHandlerCommon, m_apiLibrariesHandler, EDA_BASE_FRAME::m_auimgr, KIGFX::GAL_DISPLAY_OPTIONS::m_axesEnabled, m_bodyStyle, m_bodyStyleSelectBox, EDA_DRAW_FRAME::m_colorSettings, m_drawSpecificBodyStyle, m_drawSpecificUnit, m_dummyScreen, m_isSymbolFromSchematic, m_libMgr, m_libTreeAutoHiddenForSchematicEdit, EDA_DRAW_FRAME::m_messagePanel, EDA_DRAW_FRAME::m_propertiesPanel, SCH_BASE_FRAME::m_selectionFilterPanel, m_settings, m_symbol, m_syncLibrariesInProgress, m_tabsPanel, EDA_BASE_FRAME::m_tbLeft, EDA_BASE_FRAME::m_tbRight, EDA_BASE_FRAME::m_tbTopMain, EDA_BASE_FRAME::m_toolbarSettings, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, m_treePane, m_unit, m_unitSelectBox, onPluginAvailabilityChanged(), OnTabCharHook(), Pgm(), promptAndCloseSymbolTab(), EDA_DRAW_FRAME::PropertiesPaneName(), RebuildSymbolUnitAndBodyStyleLists(), EDA_BASE_FRAME::ReCreateMenuBar(), EDA_BASE_FRAME::RecreateToolbars(), KICAD_API_SERVER::RegisterHandler(), EDA_DRAW_FRAME::resolveCanvasType(), ResolveTabVisualState(), EDA_BASE_FRAME::RestoreAuiLayout(), restoreSymbolTabsFromSettings(), SCH_BASE_FRAME::SCH_BASE_FRAME(), schIUScale, SetAuiPaneSize(), BOX2< Vec >::SetOrigin(), SetScreen(), KIPLATFORM::APP::SetShutdownBlockReason(), BOX2< Vec >::SetSize(), setupTools(), setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), FILEEXT::SVGFileExtension, SYMBOL_EDIT_FRAME(), symbolTabContextForIndex(), SyncLibraries(), SCH_BASE_FRAME::SyncView(), updateSelectionFilterVisbility(), UpdateSymbolMsgPanelInfo(), and ACTIONS::zoomFitScreen.

Referenced by SYMBOL_EDIT_FRAME().

◆ ~SYMBOL_EDIT_FRAME()

SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME ( )

override

Member Function Documentation

◆ ActivateGalCanvas()

void SCH_BASE_FRAME::ActivateGalCanvas ( )

overridevirtualinherited

Use to start up the GAL drawing canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 338 of file sch_base_frame.cpp.

References EDA_DRAW_FRAME::ActivateGalCanvas(), GetCanvas(), m_spaceMouse, pcbIUScale, and schIUScale.

Referenced by createCanvas(), and SCH_DRAW_PANEL::OnShow().

◆ activateSymbolTab()

void SYMBOL_EDIT_FRAME::activateSymbolTab ( SYMBOL_EDITOR_TAB_CONTEXT * aContext )

private

Make aContext the active tab, borrowing its working symbol, undo/redo, view and selection, without deleting the previously active document.

Definition at line 140 of file symbol_edit_frame_tabs.cpp.

Referenced by CreateUnsavedSymbolTab(), findOrCreateSymbolInstanceTab(), findOrCreateSymbolTab(), promptAndCloseSymbolTab(), promptToSaveInactiveInstanceTabs(), and SYMBOL_EDIT_FRAME().

◆ AddApiPluginMenuItems()

size_t EDA_DRAW_FRAME::AddApiPluginMenuItems ( ACTION_MENU * aMenu )

inherited

Append actions from API plugins to the given menu.

Parameters

aMenu is the menu to add the plugin actions to

Returns: the number of actions added to the menu

Definition at line 1513 of file eda_draw_frame.cpp.

References KIUI::AddMenuItem(), EDA_BASE_FRAME::config(), PGM_BASE::GetCommonSettings(), GetOrderedPluginActions(), PGM_BASE::GetPluginManager(), KIPLATFORM::UI::IsDarkTheme(), KiBitmapBundleDef(), COMMON_SETTINGS::m_Appearance, EDA_BASE_FRAME::m_ident, BITMAP_STORE::MakeBitmapBundleDef(), API_PLUGIN_MANAGER::MenuBindings(), OnApiPluginInvoke(), Pgm(), PluginActionScope(), puzzle_piece, and COMMON_SETTINGS::APPEARANCE::toolbar_icon_size.

Referenced by FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), and SYMBOL_EDIT_FRAME::doReCreateMenuBar().

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

References API_PLUGIN_MANAGER::ButtonBindings(), EDA_BASE_FRAME::config(), PGM_BASE::GetCommonSettings(), GetOrderedPluginActions(), PGM_BASE::GetPluginManager(), KIPLATFORM::UI::IsDarkTheme(), IsPluginActionButtonVisible(), COMMON_SETTINGS::m_Appearance, EDA_BASE_FRAME::m_ident, BITMAP_STORE::MakeBitmapBundleDef(), OnApiPluginInvoke(), Pgm(), PluginActionScope(), and COMMON_SETTINGS::APPEARANCE::toolbar_icon_size.

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

◆ AddLibraryFile()

wxString SYMBOL_EDIT_FRAME::AddLibraryFile ( bool aCreateNew )

Create or add an existing library to the symbol library table.

Definition at line 1331 of file symbol_edit_frame.cpp.

References _, LIB_TREE::CenterLibId(), DisplayError(), PGM_BASE::GetLibraryManager(), GetLibTree(), EDA_BASE_FRAME::GetSettingsManager(), FILEDLG_HOOK_NEW_LIBRARY::GetUseGlobalTable(), GLOBAL, LIBRARY_MANAGER_ADAPTER::HasLibrary(), KICAD_MESSAGE_DIALOG, FILEEXT::KiCadSymbolLibFileExtension, FILEEXT::KiCadSymbolLibFileWildcard(), EDA_DRAW_FRAME::LibraryFileBrowser(), SYMBOL_LIBRARY_ADAPTER::LoadOne(), m_libMgr, m_treePane, LIBRARY_ERROR::message, Pgm(), Prj(), PROJECT, LIB_TREE::SelectLibId(), SYMBOL, PROJECT_SCH::SymbolLibAdapter(), SyncLibraries(), LIBRARY_MANAGER::Table(), and table.

Referenced by saveSymbolCopyAs().

◆ addLibTableEntry()

bool SYMBOL_EDIT_FRAME::addLibTableEntry	(	const wxString &	aLibFile,
		LIBRARY_TABLE_SCOPE	aScope = LIBRARY_TABLE_SCOPE::GLOBAL )

private

Add aLibFile to the symbol library table defined by aScope.

Note: The library defined by aLibFile must be a KiCad (s-expression) library.

Parameters

aLibFile	is the full path and file name of the symbol library to add to the table.
aScope	defines if aLibFile is added to the global or project library table.

Returns: true if successful or false if a failure occurs.

Definition at line 2349 of file symbol_edit_frame.cpp.

References _, PGM_BASE::GetLibraryManager(), PGM_BASE::GetLocalEnvVariables(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), LIBRARY_MANAGER_ADAPTER::HasLibrary(), KICAD_MESSAGE_DIALOG, SYMBOL_LIBRARY_ADAPTER::LoadOne(), LIBRARY_ERROR::message, normalizedPath(), NormalizePath(), Pgm(), Prj(), PROJECT, LIBRARY_MANAGER::ReloadTables(), LIBRARY_TABLE_ROW::SetNickname(), LIBRARY_TABLE_ROW::SetType(), LIBRARY_TABLE_ROW::SetURI(), SCH_IO_MGR::ShowType(), SYMBOL, PROJECT_SCH::SymbolLibAdapter(), FILEEXT::SymbolLibraryTableFileName, LIBRARY_MANAGER::Table(), and table.

Referenced by saveLibrary().

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

◆ AddToScreen()

void SCH_BASE_FRAME::AddToScreen	(	EDA_ITEM *	aItem,
		SCH_SCREEN *	aScreen = nullptr )

overridevirtualinherited

Add an item to the screen (and view) aScreen is the screen the item is located on, if not the current screen.

Implements SCHEMATIC_HOLDER.

Definition at line 460 of file sch_base_frame.cpp.

References KIGFX::VIEW::Add(), SCH_SCREEN::Append(), GetCanvas(), GetScreen(), SCH_DRAW_PANEL::GetView(), SCH_TABLECELL_T, EDA_ITEM::Type(), and UpdateItem().

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ AngleValueFromString()

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

inlineinherited

Definition at line 191 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 435 of file eda_draw_frame.h.

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

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

◆ backupLibrary()

bool SYMBOL_EDIT_FRAME::backupLibrary	(	const wxFileName &	aOriginalFile,
		wxString &	aErrorMsg )

private

Create a backup copy of a symbol library.

For packed symbol libraries, a copy is made of the original file name with extension is set to .bak. For unpacked symbol libraries, a zip archive is created containing all of the symbol library files (.kicad_sym) is created using the last file path name + "_backup.zip".

Parameters

	aOriginalFile	contains the library path and/or file name.
[out]	aErrorMsg	will contain an error message if the backup fails.

Return values

true	if the backup succeeded.
false	if the backup failed.

Definition at line 1665 of file symbol_edit_frame.cpp.

References _, and KIPLATFORM::IO::CLOUD_SYNC_BUFFER_SIZE.

Referenced by saveLibrary().

◆ CanAcceptApiCommands()

virtual bool EDA_BASE_FRAME::CanAcceptApiCommands ( )

inlinevirtualinherited

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 in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 643 of file eda_base_frame.h.

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

◆ CanCloseSymbolFromSchematic()

bool SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic ( bool doClose )

Definition at line 801 of file symbol_edit_frame.cpp.

References _, FRAME_SCH, GetCurSymbol(), HandleUnsavedChanges(), IsContentModified(), Kiway, m_reference, m_schematicSymbolUUID, KIWAY::Player(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), and SetCurSymbol().

Referenced by canCloseWindow().

◆ canCloseWindow()

bool SYMBOL_EDIT_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 830 of file symbol_edit_frame.cpp.

References _, CanCloseSymbolFromSchematic(), SCH_BASE_FRAME::GetScreen(), hasDirtyInactiveInstanceTabs(), IsContentModified(), m_activeTab, m_isSymbolFromSchematic, m_libMgr, promptToSaveInactiveInstanceTabs(), saveAllLibraries(), saveCurrentSymbol(), KIDIALOG::ShowModal(), and KIPLATFORM::APP::SupportsShutdownBlockReason().

◆ canRunAutoSave()

virtual bool EDA_BASE_FRAME::canRunAutoSave ( ) const

inlineprotectedvirtualinherited

Return true when it is safe to run an autosave snapshot right now.

The autosave serializes the whole document on the UI thread, which can take several seconds on large designs. Doing that while the user is mid-interaction (routing a track, dragging items, editing points) freezes the UI and causes the deferred input to be misinterpreted. Derived frames override this to defer the snapshot until the interactive operation finishes; the timer is rescheduled when this returns false so no edits are lost.

Returns: true if an autosave may run now, false to defer it to a later timer tick.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 696 of file eda_base_frame.h.

Referenced by doAutoSave().

◆ captureSymbolSelectionKiids()

std::vector< KIID > SYMBOL_EDIT_FRAME::captureSymbolSelectionKiids ( ) const

private

Capture the KIIDs of the current selection for the active tab's snapshot.

Definition at line 76 of file symbol_edit_frame_tabs.cpp.

References SCH_SELECTION_TOOL::GetSelection(), and TOOLS_HOLDER::m_toolManager.

Referenced by detachActiveSymbolTab().

◆ captureSymbolViewSnapshot()

EDITOR_TAB_CONTEXT::VIEW_SNAPSHOT SYMBOL_EDIT_FRAME::captureSymbolViewSnapshot ( ) const

private

Capture the current view zoom/center for the active tab's snapshot.

Definition at line 48 of file symbol_edit_frame_tabs.cpp.

References EDITOR_TAB_CONTEXT::VIEW_SNAPSHOT::center, SCH_BASE_FRAME::GetCanvas(), EDITOR_TAB_CONTEXT::VIEW_SNAPSHOT::scale, and EDITOR_TAB_CONTEXT::VIEW_SNAPSHOT::valid.

Referenced by detachActiveSymbolTab().

◆ centerItemIdleHandler()

void SYMBOL_EDIT_FRAME::centerItemIdleHandler ( wxIdleEvent & aEvent )

private

Definition at line 191 of file symbol_editor.cpp.

References centerItemIdleHandler(), m_centerItemOnIdle, and m_treePane.

Referenced by centerItemIdleHandler(), and LoadSymbol().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1934 of file eda_base_frame.cpp.

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

◆ CheckForAutosaveFiles()

void EDA_BASE_FRAME::CheckForAutosaveFiles	(	const wxString &	aProjectPath,
		const std::vector< wxString > &	aExtensions )

protectedinherited

Check for autosave files newer than their source files for the given project.

If found, present the user with the recovery dialog so they can pick what to do with each file (restore, keep current, or keep both as a sibling copy). Cancel leaves every autosave on disk so the dialog can offer it again next open. The open always proceeds either way.

Recovery files are only written while the backup format is Zip, but any left over from a prior session are always offered here regardless of the current format. In incremental mode the user otherwise recovers via the Local History restore dialog.

Parameters

aProjectPath	path to the project directory.
aExtensions	Only autosave files whose source has one of these extensions are considered. PCB editor passes kicad_pcb, schematic editor passes kicad_sch.

Definition at line 466 of file eda_base_frame.cpp.

References _, buildRecoveredFileName(), CANCEL, LOCAL_HISTORY::FindStaleAutosaveFiles(), DIALOG_AUTOSAVE_RECOVERY::GetChoice(), DIALOG_AUTOSAVE_RECOVERY::GetSelectedStale(), KEEP_BOTH, KEEP_CURRENT, KIWAY_HOLDER::Kiway(), KIWAY::LocalHistory(), and RESTORE.

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

◆ ClearFileHistory()

void EDA_BASE_FRAME::ClearFileHistory ( )

virtualinherited

Remove all files from the file history.

Reimplemented in GERBVIEW_FRAME.

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

◆ ClearFindReplaceStatus()

void SCH_BASE_FRAME::ClearFindReplaceStatus ( )

inherited

Definition at line 583 of file sch_base_frame.cpp.

References EDA_BASE_FRAME::m_infoBar.

◆ ClearFocus()

virtual void EDA_DRAW_FRAME::ClearFocus ( )

inlinevirtualinherited

Definition at line 309 of file eda_draw_frame.h.

References FocusOnItem().

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

◆ ClearMsgPanel()

void SYMBOL_EDIT_FRAME::ClearMsgPanel ( )

inlineoverridevirtual

Clear all messages from the message panel.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 319 of file symbol_edit_frame.h.

References UpdateSymbolMsgPanelInfo().

Referenced by saveLibrary().

◆ clearSymbolTabsModifiedForLibrary()

void SYMBOL_EDIT_FRAME::clearSymbolTabsModifiedForLibrary ( const wxString & aLibrary )

Clear the unsaved-edits flag on every tab in a saved library so its dirty indicator clears.

Definition at line 314 of file symbol_edit_frame_tabs.cpp.

References clearTabModifiedState(), m_tabContexts, and m_tabsPanel.

Referenced by saveLibrary().

◆ clearSymbolTabUndoRedo()

void SYMBOL_EDIT_FRAME::clearSymbolTabUndoRedo ( SYMBOL_EDITOR_TAB_CONTEXT & aContext )

static

Free a detached context's undo/redo, which the frame's own teardown path never reaches.

Definition at line 295 of file symbol_edit_frame_tabs.cpp.

References freeTransientUndoCommands(), EDITOR_TAB_CONTEXT::RedoList(), and EDITOR_TAB_CONTEXT::UndoList().

Referenced by closeAllSymbolTabsSilently(), dropSymbolTabContext(), promptAndCloseSymbolTab(), and ~SYMBOL_EDIT_FRAME().

◆ clearTabModifiedState()

void SYMBOL_EDIT_FRAME::clearTabModifiedState	(	SYMBOL_EDITOR_TAB_CONTEXT &	aContext,
		EDITOR_TABS_MODEL &	aModel )

static

Clear a tab's dirty state on both the context (read on repaint) and the strip model (read on close), keeping the two stores that diverge after a save in agreement.

Definition at line 303 of file symbol_edit_frame_tabs.cpp.

References SYMBOL_EDITOR_TAB_CONTEXT::GetScreen(), SYMBOL_EDITOR_TAB_CONTEXT::GetTabKey(), and EDITOR_TABS_MODEL::MarkModified().

Referenced by BOOST_AUTO_TEST_CASE(), and clearSymbolTabsModifiedForLibrary().

◆ ClearToolbarControl()

void SYMBOL_EDIT_FRAME::ClearToolbarControl ( int aId )

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 228 of file toolbars_symbol_editor.cpp.

References EDA_BASE_FRAME::ClearToolbarControl(), ID_LIBEDIT_SELECT_BODY_STYLE, ID_LIBEDIT_SELECT_UNIT_NUMBER, m_bodyStyleSelectBox, and m_unitSelectBox.

◆ ClearUndoORRedoList()

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

overridevirtual

Free the undo or redo list from aList 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)

Parameters

whichList	= the UNDO_REDO_CONTAINER to clear
aItemCount	= the count of items to remove. < 0 for all items items are removed from the beginning of the list. So this function can be called to remove old commands

Reimplemented from EDA_BASE_FRAME.

Definition at line 2188 of file symbol_edit_frame.cpp.

References PICKED_ITEMS_LIST::ClearItemsList(), freeTransientUndoCommands(), PICKED_ITEMS_LIST::GetCount(), PICKED_ITEMS_LIST::GetPickedItem(), EDA_ITEM::HasFlag(), EDA_BASE_FRAME::m_redoList, m_symbol, EDA_BASE_FRAME::m_undoList, EDA_BASE_FRAME::UNDO_LIST, and UR_TRANSIENT.

Referenced by PushSymbolToUndoList().

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

References ClearUndoORRedoList(), REDO_LIST, and UNDO_LIST.

Referenced by PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_EDIT_FRAME::closeAllSymbolTabsSilently(), SYMBOL_EDIT_FRAME::emptyScreen(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbol(), SCH_EDIT_FRAME::OnImportProject(), PL_EDITOR_FRAME::OnNewDrawingSheet(), SCH_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::promptAndCloseSymbolTab(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), SCH_EDIT_FRAME::SetSchematic(), ~EDA_BASE_FRAME(), SCH_EDIT_FRAME::~SCH_EDIT_FRAME(), and SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME().

◆ closeAllSymbolTabsSilently()

void SYMBOL_EDIT_FRAME::closeAllSymbolTabsSilently ( )

private

Close every tab without prompting and return the frame to the empty state.

Used by the paths that leave the tab model. The caller handles any unsaved-change prompting.

Definition at line 628 of file symbol_edit_frame_tabs.cpp.

References clearSymbolTabUndoRedo(), EDA_BASE_FRAME::ClearUndoRedoList(), SCH_BASE_FRAME::GetScreen(), m_activeTab, m_dummyScreen, m_silentSymbolTabClose, m_symbol, m_tabContexts, m_tabsPanel, and SetScreen().

Referenced by emptyScreen().

◆ closeSymbolTab()

void SYMBOL_EDIT_FRAME::closeSymbolTab ( const LIB_ID & aLibId )

private

Close the open tab for aLibId, if any, without prompting and leaving the other tabs open.

The panel selects a successor when the closed tab was active.

Definition at line 661 of file symbol_edit_frame_tabs.cpp.

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), m_silentSymbolTabClose, m_tabsPanel, and SYMBOL_EDITOR_TAB_CONTEXT::MakeTabKey().

Referenced by DeleteSymbolFromLibrary().

◆ CloseWindow()

void SYMBOL_EDIT_FRAME::CloseWindow ( wxCommandEvent & event )

inline

Trigger the wxCloseEvent, which is handled by the function given to EVT_CLOSE() macro:

EVT_CLOSE( SYMBOL_EDIT_FRAME::OnCloseWindow )

Definition at line 292 of file symbol_edit_frame.h.

◆ commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T aFrameType )

privateinherited

Collect common initialization functions used in all CTORs.

Definition at line 137 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_closeInProgress, 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(), KIPLATFORM::UI::SetWMClass(), and windowClosing().

Referenced by commonInit(), and EDA_BASE_FRAME().

◆ CommonSettingsChanged()

void SYMBOL_EDIT_FRAME::CommonSettingsChanged ( int aFlags )

overridevirtual

Called after the preferences dialog is run.

Reimplemented from SCH_BASE_FRAME.

Definition at line 1813 of file symbol_edit_frame.cpp.

References KIGFX::ALL, SCH_BASE_FRAME::CommonSettingsChanged(), ENVVARS_CHANGED, EDA_DRAW_PANEL_GAL::ForceRefresh(), GetAppSettings(), SCH_BASE_FRAME::GetCanvas(), EDA_DRAW_FRAME::GetGalDisplayOptions(), SCH_BASE_FRAME::GetRenderSettings(), SCH_DRAW_PANEL::GetView(), SCH_RENDER_SETTINGS::m_ShowHiddenFields, SCH_RENDER_SETTINGS::m_ShowHiddenPins, SCH_RENDER_SETTINGS::m_ShowPinAltIcons, SCH_RENDER_SETTINGS::m_ShowPinsElectricalType, m_symbol, GAL_DISPLAY_OPTIONS_IMPL::ReadWindowSettings(), EDA_BASE_FRAME::RecreateToolbars(), EDA_DRAW_PANEL_GAL::Refresh(), SyncLibraries(), and KIGFX::VIEW::UpdateAllItems().

◆ config()

APP_SETTINGS_BASE * SYMBOL_EDIT_FRAME::config ( ) const

overridevirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 518 of file symbol_edit_frame.cpp.

References GetSettings().

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

References m_configName.

◆ configureToolbars()

void SYMBOL_EDIT_FRAME::configureToolbars ( )

overrideprotectedvirtual

◆ CopySymbolToClipboard()

void SYMBOL_EDIT_FRAME::CopySymbolToClipboard ( )

Definition at line 1348 of file symbol_editor.cpp.

References LIB_SYMBOL::Flatten(), SCH_IO_KICAD_SEXPR::FormatLibSymbol(), STRING_FORMATTER::GetString(), GetTreeLIBIDs(), m_libMgr, and KICAD_FORMAT::Prettify().

Referenced by SYMBOL_EDITOR_CONTROL::CutCopyDelete().

◆ createCanvas()

void SCH_BASE_FRAME::createCanvas ( )

inherited

Definition at line 328 of file sch_base_frame.cpp.

References ActivateGalCanvas(), EDA_DRAW_FRAME::GetGalDisplayOptions(), EDA_DRAW_FRAME::loadCanvasTypeSetting(), EDA_DRAW_FRAME::m_canvasType, EDA_BASE_FRAME::m_frameSize, and EDA_DRAW_FRAME::SetCanvas().

Referenced by SCH_BASE_FRAME().

◆ CreateHotkeyPopup()

void EDA_DRAW_FRAME::CreateHotkeyPopup ( )

virtualinherited

Definition at line 1265 of file eda_draw_frame.cpp.

References m_hotkeyPopup.

Referenced by showTabSwitcher().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 1337 of file eda_base_frame.cpp.

References TOOLS_HOLDER::GetToolCanvas(), and m_infoBar.

Referenced by DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GERBVIEW_FRAME::GERBVIEW_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().

◆ CreateNewSymbol()

void SYMBOL_EDIT_FRAME::CreateNewSymbol ( const wxString & newName = wxEmptyString )

Create a new symbol in the selected library.

Parameters

newName is the name of the symbol to derive the new symbol from or empty to create a new root symbol.

Definition at line 300 of file symbol_editor.cpp.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol().

◆ CreateServer()

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

inherited

Definition at line 188 of file kiway_player.cpp.

References HOSTNAME(), ID_EDA_SOCKET_EVENT_SERV, and m_socketServer.

◆ CreateUnsavedSymbolTab()

SYMBOL_EDITOR_TAB_CONTEXT * SYMBOL_EDIT_FRAME::CreateUnsavedSymbolTab	(	LIB_SYMBOL *	aSymbol,
		SCH_SCREEN *	aScreen )

private

Open a new tab over a transient working symbol and screen and make it active.

For a brand-new symbol with no library identity yet: the tab reads as unnamed and is never de-duplicated against another tab; RenameSymbolTab() promotes it once a save names it. The context takes ownership of both objects.

Definition at line 479 of file symbol_edit_frame_tabs.cpp.

References activateSymbolTab(), SYMBOL_EDITOR_TAB_CONTEXT::GetDisplayName(), SYMBOL_EDITOR_TAB_CONTEXT::GetTabKey(), m_tabContexts, and m_tabsPanel.

Referenced by CreateNewSymbol().

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 127 of file tools_holder.cpp.

References m_toolStack, and ACTIONS::selectionTool.

Referenced by EDA_DRAW_FRAME::setArcModeConditions(), and ShowChangedLanguage().

◆ DdAddLibrary()

void SYMBOL_EDIT_FRAME::DdAddLibrary ( wxString aLibFile )

Add a library dropped file to the symbol library table.

Definition at line 1430 of file symbol_edit_frame.cpp.

References _, DisplayError(), KIWAY::ExpressMail(), FRAME_SCH_SYMBOL_EDITOR, PGM_BASE::GetLibraryManager(), LIBRARY_MANAGER_ADAPTER::HasLibrary(), KICAD_MESSAGE_DIALOG, Kiway, SYMBOL_LIBRARY_ADAPTER::LoadOne(), m_libMgr, MAIL_LIB_EDIT, MAIL_RELOAD_LIB, LIBRARY_ERROR::message, Pgm(), Prj(), PROJECT, SYMBOL, PROJECT_SCH::SymbolLibAdapter(), LIBRARY_MANAGER::Table(), and table.

◆ DeleteSymbolFromLibrary()

void SYMBOL_EDIT_FRAME::DeleteSymbolFromLibrary ( )

Definition at line 1275 of file symbol_editor.cpp.

References _, closeSymbolTab(), emptyScreen(), GetCurSymbol(), GetParentChain(), GetSelectedLibIds(), GetTargetLibId(), IsOK(), KICAD_MESSAGE_DIALOG, m_libMgr, m_tabsPanel, m_treePane, and name.

Referenced by SYMBOL_EDITOR_CONTROL::CutCopyDelete().

◆ DesignBlocksPaneName()

static const wxString EDA_DRAW_FRAME::DesignBlocksPaneName ( )

inlinestaticinherited

Definition at line 431 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 152 of file kiway_player.cpp.

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

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprintFromWizard(), 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(), SelectFootprintFromChooser(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ detachActiveSymbolTab()

void SYMBOL_EDIT_FRAME::detachActiveSymbolTab ( )

private

Snapshot the active tab's view and selection into its context without deleting the document.

Definition at line 122 of file symbol_edit_frame_tabs.cpp.

References captureSymbolSelectionKiids(), captureSymbolViewSnapshot(), SCH_BASE_FRAME::GetScreen(), m_activeTab, m_bodyStyle, EDA_BASE_FRAME::m_redoList, m_symbol, EDA_BASE_FRAME::m_undoList, and m_unit.

Referenced by activateSymbolTab().

◆ DismissModal()

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

inherited

Definition at line 166 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::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 676 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 685 of file eda_draw_frame.cpp.

References _, EDA_BASE_FRAME::config(), EDA_BASE_FRAME::GetWindowSettings(), WINDOW_SETTINGS::grid, GRID_SETTINGS::grids, GRID_SETTINGS::last_size_idx, and EDA_BASE_FRAME::m_isClosing.

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 667 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 701 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 EDA_BASE_FRAME::doAutoSave ( )

protectedvirtualinherited

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

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

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 527 of file eda_base_frame.cpp.

References COMMON_SETTINGS::AutosaveUsesLocalHistory(), canRunAutoSave(), GetAutoSaveInterval(), PGM_BASE::GetCommonSettings(), KIWAY_HOLDER::Kiway(), KIWAY::LocalHistory(), COMMON_SETTINGS::AUTO_BACKUP::location, m_autoSaveDeferredSince, m_autoSaveRequired, COMMON_SETTINGS::m_Backup, Pgm(), KIWAY_HOLDER::Prj(), PROJECT_DIR, LOCAL_HISTORY::RunRegisteredSaversAndCommit(), LOCAL_HISTORY::RunRegisteredSaversAsAutosaveFiles(), and traceAutoSave.

Referenced by PCB_EDIT_FRAME::DoAutoSave(), SCH_EDIT_FRAME::doAutoSave(), and onAutoSaveTimer().

◆ doCloseWindow()

void SYMBOL_EDIT_FRAME::doCloseWindow ( )

overridevirtual

Reimplemented from SCH_BASE_FRAME.

Definition at line 892 of file symbol_edit_frame.cpp.

References KICAD_API_SERVER::DeregisterHandler(), KIWAY_PLAYER::Destroy(), SCH_BASE_FRAME::doCloseWindow(), EDA_EVT_PLUGIN_AVAILABILITY_CHANGED, PGM_BASE::GetApiServer(), GetLibTree(), Kiface(), m_apiHandler, m_apiHandlerCommon, m_apiLibrariesHandler, TOOLS_HOLDER::m_toolManager, onPluginAvailabilityChanged(), Pgm(), and LIB_TREE::ShutdownPreviews().

◆ doReCreateMenuBar()

void SYMBOL_EDIT_FRAME::doReCreateMenuBar ( )

overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 35 of file menubar_symbol_editor.cpp.

References _, ACTION_MENU::Add(), EDA_DRAW_FRAME::AddApiPluginMenuItems(), ACTION_MENU::AddClose(), ACTIONS::addLibrary, EDA_BASE_FRAME::AddMenuLanguageList(), EDA_BASE_FRAME::AddStandardHelpMenu(), ACTION_MENU::CHECK, SCH_ACTIONS::checkSymbol, SCH_ACTIONS::closeSymbolTab, SCH_ACTIONS::compareLibraryWithFile, ACTIONS::configurePaths, ACTIONS::copy, ACTIONS::copyAsText, ACTIONS::cut, ACTIONS::doDelete, SCH_ACTIONS::drawArc, SCH_ACTIONS::drawBezier, SCH_ACTIONS::drawCircle, SCH_ACTIONS::drawEllipse, SCH_ACTIONS::drawEllipseArc, SCH_ACTIONS::drawRectangle, SCH_ACTIONS::drawSymbolLines, SCH_ACTIONS::drawSymbolPolygon, SCH_ACTIONS::drawSymbolTextBox, ACTIONS::duplicate, SCH_ACTIONS::editLibSymbolWithLibEdit, SCH_ACTIONS::editSymbolPinMaps, export_file, SCH_ACTIONS::exportSymbol, SCH_ACTIONS::exportSymbolAsSVG, SCH_ACTIONS::exportSymbolView, ACTIONS::find, ACTIONS::findAndReplace, import, SCH_ACTIONS::importGraphics, SCH_ACTIONS::importSymbol, IsSymbolFromSchematic(), TOOLS_HOLDER::m_toolManager, ACTIONS::newLibrary, SCH_ACTIONS::newSymbol, SCH_ACTIONS::nextSymbolTab, ACTION_MENU::NORMAL, ACTIONS::openPreferences, ACTIONS::paste, Pgm(), SCH_ACTIONS::pinTable, SCH_ACTIONS::placeSymbolPin, SCH_ACTIONS::placeSymbolText, ACTIONS::pluginsReload, ACTIONS::pluginsShowFolder, SCH_ACTIONS::prevSymbolTab, puzzle_piece, ACTIONS::redo, ACTIONS::revert, ACTIONS::save, ACTIONS::saveAll, SCH_ACTIONS::saveLibraryAs, SCH_ACTIONS::saveSymbolAs, SCH_ACTIONS::saveSymbolCopyAs, ACTIONS::selectAll, ACTION_MENU::SetIcon(), ACTION_MENU::SetTitle(), ACTIONS::showDatasheet, SCH_ACTIONS::showHiddenFields, SCH_ACTIONS::showHiddenPins, ACTIONS::showLibraryTree, ACTIONS::showProperties, ACTIONS::showSymbolBrowser, ACTIONS::showSymbolLibTable, SCH_ACTIONS::symbolProperties, SCH_ACTIONS::togglePinAltIcons, ACTIONS::undo, ACTIONS::unselectAll, SCH_ACTIONS::updateSymbolFields, ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, ACTIONS::zoomRedraw, and ACTIONS::zoomTool.

◆ DoWithAcceptedFiles()

void EDA_BASE_FRAME::DoWithAcceptedFiles ( )

protectedvirtualinherited

Execute action on accepted dropped file.

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

Reimplemented in GERBVIEW_FRAME, KICAD_MANAGER_FRAME, and PL_EDITOR_FRAME.

Definition at line 1794 of file eda_base_frame.cpp.

References m_acceptedExts, m_AcceptedFiles, and TOOLS_HOLDER::m_toolManager.

Referenced by OnDropFiles().

◆ drawArcAction()

const TOOL_ACTION * SCH_BASE_FRAME::drawArcAction ( ARC_DRAW_MODE aMode ) const

overrideprotectedvirtualinherited

The action that starts the arc tool in aMode, or nullptr in a frame without an arc tool.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 797 of file sch_base_frame.cpp.

References SCH_ACTIONS::DrawArcForMode().

◆ dropSymbolTabContext()

void SYMBOL_EDIT_FRAME::dropSymbolTabContext ( const wxString & aKey )

private

Drop the inactive context for aKey from m_tabContexts, freeing its undo/redo.

Used when the panel evicts a preview tab so its now-orphaned context is not left behind to be persisted.

Definition at line 346 of file symbol_edit_frame_tabs.cpp.

References clearSymbolTabUndoRedo(), m_activeTab, m_tabContexts, and symbolTabContextForKey().

Referenced by findOrCreateSymbolTab().

◆ DuplicateSymbol()

void SYMBOL_EDIT_FRAME::DuplicateSymbol ( bool aFromClipboard )

Insert a duplicate symbol.

If aFromClipboard is true then action is a paste.

Definition at line 1387 of file symbol_editor.cpp.

References ensureUniqueName(), GetBodyStyle(), GetClipboardUTF8(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), GetTargetLibId(), GetUnit(), LoadOneLibrarySymbol(), m_libMgr, m_treePane, SCH_IO_KICAD_SEXPR::ParseLibSymbols(), IO_ERROR::Problem(), and SyncLibraries().

Referenced by SYMBOL_EDITOR_CONTROL::DuplicateSymbol().

◆ eeconfig()

EESCHEMA_SETTINGS * SCH_BASE_FRAME::eeconfig ( ) const

inherited

Definition at line 189 of file sch_base_frame.cpp.

References EDA_BASE_FRAME::config().

◆ emptyScreen()

void SYMBOL_EDIT_FRAME::emptyScreen ( )

Restore the empty editor screen, without any symbol or library selected.

Definition at line 1798 of file symbol_edit_frame.cpp.

References EDA_BASE_FRAME::ClearUndoRedoList(), closeAllSymbolTabsSilently(), GetLibTree(), m_dummyScreen, TOOLS_HOLDER::m_toolManager, SetCurSymbol(), SetScreen(), LIB_TREE::Unselect(), and ACTIONS::zoomFitScreen.

Referenced by DeleteSymbolFromLibrary(), and Revert().

◆ ensureUniqueName()

void SYMBOL_EDIT_FRAME::ensureUniqueName	(	LIB_SYMBOL *	aSymbol,
		const wxString &	aLibrary )

private

Rename LIB_SYMBOL aliases to avoid conflicts before adding a symbol to a library.

Definition at line 1441 of file symbol_editor.cpp.

References LIB_SYMBOL::GetName(), m_libMgr, and LIB_SYMBOL::SetName().

Referenced by DuplicateSymbol().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 1151 of file eda_base_frame.cpp.

References GetWindowSize(), and traceDisplayLocation.

Referenced by OnSize().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )

inherited

Definition at line 373 of file eda_draw_frame.cpp.

References m_messagePanel.

◆ ExecuteRemoteCommand()

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

inlinevirtualinherited

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

Subclasses should override to implement actual command handlers.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 166 of file kiway_player.h.

Referenced by OnSockRequest().

◆ ExportSymbol()

◆ findDialogs()

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

protectedinherited

Definition at line 1050 of file eda_draw_frame.cpp.

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

◆ findOrCreateSymbolInstanceTab()

SYMBOL_EDITOR_TAB_CONTEXT * SYMBOL_EDIT_FRAME::findOrCreateSymbolInstanceTab	(	LIB_SYMBOL *	aSymbol,
		SCH_SCREEN *	aScreen,
		const KIID &	aSchematicSymbolUUID,
		const wxString &	aReference,
		int	aUnit,
		int	aBodyStyle )

private

Find or create the instance tab for a placed schematic symbol and make it active.

Re-editing the same placed symbol focuses the existing tab; otherwise a session-only instance tab is created over the supplied transient working symbol/screen, which the context adopts. The caller's objects are consumed only when a new tab is created; on a focus of an existing tab they are deleted here.

Definition at line 441 of file symbol_edit_frame_tabs.cpp.

References activateSymbolTab(), SYMBOL_EDITOR_TAB_CONTEXT::GetDisplayName(), m_tabContexts, m_tabsPanel, SYMBOL_EDITOR_TAB_CONTEXT::MakeInstanceTabKey(), SYMBOL_EDITOR_TAB_CONTEXT::SetBodyStyle(), SYMBOL_EDITOR_TAB_CONTEXT::SetUnit(), and symbolTabContextForKey().

Referenced by LoadSymbolFromSchematic().

◆ findOrCreateSymbolTab()

SYMBOL_EDITOR_TAB_CONTEXT * SYMBOL_EDIT_FRAME::findOrCreateSymbolTab	(	const wxString &	aLib,
		const wxString &	aName,
		int	aUnit,
		int	aBodyStyle,
		bool	aAsPreview,
		bool *	aWasCreated = nullptr )

private

Open aName from aLib in a tab, creating it when absent, and return the activated context.

Definition at line 379 of file symbol_edit_frame_tabs.cpp.

References activateSymbolTab(), dropSymbolTabContext(), m_libMgr, m_tabContexts, m_tabsPanel, SYMBOL_EDITOR_TAB_CONTEXT::MakeTabKey(), SYMBOL_EDITOR_TAB_CONTEXT::SetBodyStyle(), SYMBOL_EDITOR_TAB_CONTEXT::SetUnit(), and symbolTabContextForKey().

Referenced by LoadOneLibrarySymbol(), and restoreSymbolTabsFromSettings().

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

privateinherited

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

void SYMBOL_EDIT_FRAME::FocusLibraryTreeInput ( )

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1016 of file symbol_edit_frame.cpp.

References LIB_TREE::FocusSearchFieldIfExists(), and GetLibTree().

◆ FocusOnItem()

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

overridevirtual

Focus on a particular canvas item.

Parameters

aItem	is the item to focus on. nullptr clears the focus.
aAllowScroll	is the flag to enable item scrolling.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1949 of file symbol_edit_frame.cpp.

References EDA_ITEM::ClearBrightened(), EDA_DRAW_FRAME::FocusOnLocation(), SCH_ITEM::GetBodyStyle(), EDA_ITEM::GetFocusPosition(), SCH_ITEM::GetUnit(), EDA_ITEM::IsBrightened(), KIGFX::VIEW_ITEM::IsSCH_ITEM(), m_symbol, EDA_ITEM::m_Uuid, niluuid, pin, SetBodyStyle(), EDA_ITEM::SetBrightened(), SetUnit(), UpdateItem(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FocusOnLibId()

void SYMBOL_EDIT_FRAME::FocusOnLibId ( const LIB_ID & aLibID )

Definition at line 1648 of file symbol_edit_frame.cpp.

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

Referenced by SYMBOL_EDITOR_CONTROL::RenameSymbol().

◆ 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.
aAllowScroll	is the flag to enable location scrolling.

Definition at line 1064 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(), PCB_EDIT_FRAME::HandleRemoteNetHighlight(), SCH_EDIT_FRAME::onNetNavigatorSelection(), and SCH_SELECTION_TOOL::SyncSelection().

◆ freeTransientUndoCommands()

void SYMBOL_EDIT_FRAME::freeTransientUndoCommands	(	UNDO_REDO_CONTAINER &	aList,
		const LIB_SYMBOL *	aLiveSymbol )

static

Free every command in the list and the UR_TRANSIENT-flagged copies it owns, which the shared deleters miss.

aLiveSymbol is the working symbol, guarded against to avoid a double-free.

Definition at line 265 of file symbol_edit_frame_tabs.cpp.

References PICKED_ITEMS_LIST::ClearItemsList(), PICKED_ITEMS_LIST::GetCount(), PICKED_ITEMS_LIST::GetPickedItem(), EDA_ITEM::HasFlag(), UNDO_REDO_CONTAINER::m_CommandsList, and UR_TRANSIENT.

Referenced by clearSymbolTabUndoRedo(), ClearUndoORRedoList(), and SYMBOL_EDITOR_TABS_TEST_FIXTURE::freeTransientUndoCommands().

◆ FreezeLibraryTree()

void SYMBOL_EDIT_FRAME::FreezeLibraryTree ( )

Definition at line 1022 of file symbol_edit_frame.cpp.

References m_libMgr, and m_treePane.

Referenced by KiwayMailIn(), and saveLibrary().

◆ GetAboutTitle()

wxString EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 541 of file eda_base_frame.h.

References m_aboutTitle.

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inherited

Definition at line 415 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(), doAutoSave(), onAutoSaveTimer(), and ProcessEvent().

◆ GetBodyStyle()

int SYMBOL_EDIT_FRAME::GetBodyStyle ( ) const

inline

Definition at line 307 of file symbol_edit_frame.h.

References m_bodyStyle.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), EE_GRAPHIC_TOOL::applySymbolEditorFlags(), EE_GRAPHIC_TOOL::drawManagedShape(), DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditLibrarySymbol(), SCH_SELECTION_TOOL::Init(), LoadSymbol(), SCH_SELECTION_TOOL::Reset(), SCH_SELECTION_TOOL::Selectable(), SVGPlotSymbol(), and updateInfoBar().

◆ GetCanvas()

SCH_DRAW_PANEL * SCH_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 310 of file sch_base_frame.cpp.

References EDA_DRAW_FRAME::GetCanvas().

◆ GetColorSettings()

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

overridevirtual

Returns a pointer to the active color theme settings.

Reimplemented from SCH_BASE_FRAME.

Definition at line 524 of file symbol_edit_frame.cpp.

References DEFAULT_THEME, GetAppSettings(), GetSettings(), and APP_SETTINGS_BASE::m_ColorTheme.

Referenced by SVGPlotSymbol().

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const

inlinevirtualinherited

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

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

Returns: the filename and full path to the open file

Reimplemented in KICAD_MANAGER_FRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, and SCH_EDIT_FRAME.

Definition at line 449 of file eda_base_frame.h.

Referenced by SaveSettings().

◆ GetCurrentSelection()

SELECTION & SYMBOL_EDIT_FRAME::GetCurrentSelection ( )

overridevirtual

Get the current selection from the canvas area.

Returns: the current selection.

Reimplemented from TOOLS_HOLDER.

Definition at line 2226 of file symbol_edit_frame.cpp.

References TOOLS_HOLDER::m_toolManager.

◆ GetCurSymbol()

LIB_SYMBOL * SYMBOL_EDIT_FRAME::GetCurSymbol ( ) const

inline

Return the current symbol being edited or NULL if none selected.

This is a LIB_SYMBOL that I own, it is at best a copy of one in a library.

Definition at line 164 of file symbol_edit_frame.h.

References m_symbol.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CanCloseSymbolFromSchematic(), SYMBOL_EDITOR_CONTROL::ChangeUnit(), EE_GRAPHIC_TOOL::commitItem(), DeleteSymbolFromLibrary(), EE_GRAPHIC_TOOL::drawManagedShape(), SYMBOL_EDITOR_CONTROL::EditLibrarySymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), SCH_PROPERTIES_PANEL::getSelection(), IsContentModified(), KiwayMailIn(), LoadOneLibrarySymbol(), LoadSymbol(), LoadSymbol(), SCH_COMMIT::makeImage(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), Revert(), saveCurrentSymbol(), SetBodyStyle(), and SetUnit().

◆ GetCustomToolbarControlFactory()

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

inherited

Definition at line 724 of file eda_base_frame.cpp.

References m_toolbarControlFactories.

Referenced by ACTION_TOOLBAR::ApplyConfiguration().

◆ GetDocumentExtents()

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

overridevirtual

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 1932 of file symbol_edit_frame.cpp.

References m_bodyStyle, m_symbol, m_unit, and schIUScale.

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

COLOR4D SCH_BASE_FRAME::GetDrawBgColor ( ) const

overridevirtualinherited

Reimplemented from EDA_DRAW_FRAME.

Definition at line 639 of file sch_base_frame.cpp.

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

◆ GetDrawSpecificBodyStyle()

bool SYMBOL_EDIT_FRAME::GetDrawSpecificBodyStyle ( ) const

inline

Definition at line 314 of file symbol_edit_frame.h.

References m_drawSpecificBodyStyle.

Referenced by EE_GRAPHIC_TOOL::applySymbolEditorFlags().

◆ GetDrawSpecificUnit()

bool SYMBOL_EDIT_FRAME::GetDrawSpecificUnit ( ) const

inline

Definition at line 311 of file symbol_edit_frame.h.

References m_drawSpecificUnit.

Referenced by EE_GRAPHIC_TOOL::applySymbolEditorFlags().

◆ 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::AddFilesToMenu 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 1468 of file eda_base_frame.cpp.

References _, KICAD_MESSAGE_DIALOG, 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 433 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(), SCH_EDIT_FRAME::doReCreateMenuBar(), and GERBVIEW_FRAME::OnClearGbrFileHistory().

◆ GetFindHistoryList()

wxArrayString & EDA_DRAW_FRAME::GetFindHistoryList ( )

inlineinherited

Definition at line 107 of file eda_draw_frame.h.

References m_findStringHistoryList.

◆ GetFindReplaceData()

EDA_SEARCH_DATA & EDA_DRAW_FRAME::GetFindReplaceData ( )

inherited

Definition at line 193 of file eda_draw_frame.cpp.

References m_findReplaceData.

◆ GetFindReplaceDialog()

DIALOG_SCH_FIND * SCH_BASE_FRAME::GetFindReplaceDialog ( ) const

inlineinherited

Definition at line 249 of file sch_base_frame.h.

References m_findReplaceDialog.

◆ 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(), EDA_SHAPE::ShapeGetMsgPanelInfo(), ShowPreferences(), 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 1176 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 475 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(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_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()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )

inlinevirtualinherited

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

Definition at line 222 of file eda_draw_frame.h.

References m_gridColor.

◆ GetGridOrigin()

const VECTOR2I & SCH_BASE_FRAME::GetGridOrigin ( ) const

inlineoverridevirtualinherited

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 147 of file sch_base_frame.h.

◆ GetHotkeyPopup()

HOTKEY_CYCLE_POPUP * EDA_DRAW_FRAME::GetHotkeyPopup ( )

inlineinherited

Definition at line 501 of file eda_draw_frame.h.

References m_hotkeyPopup.

Referenced by showTabSwitcher().

◆ 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 PCB_CONTROL::AppendBoard(), PCB_EDIT_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::CopyVariant(), SCH_EDIT_FRAME::EditVariantDescription(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbol(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::RenameVariant(), ShowInfoBarError(), ShowInfoBarError(), ShowInfoBarMsg(), ShowInfoBarWarning(), FOOTPRINT_EDIT_FRAME::updateInfoBar(), SYMBOL_EDIT_FRAME::updateInfoBar(), and SCH_EDIT_FRAME::ValidateNewVariantName().

◆ GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 51 of file units_provider.h.

References m_iuScale.

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

◆ GetLayerColor()

COLOR4D SCH_BASE_FRAME::GetLayerColor ( SCH_LAYER_ID aLayer )

inherited

Helper to retrieve a layer color from the global color settings.

Definition at line 511 of file sch_base_frame.cpp.

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

◆ GetLibManager()

LIB_SYMBOL_LIBRARY_MANAGER & SYMBOL_EDIT_FRAME::GetLibManager ( )

Definition at line 1247 of file symbol_edit_frame.cpp.

References m_libMgr.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), SYMBOL_EDITOR_CONTROL::CompareLibraryWithFile(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::FlattenSymbol(), and SYMBOL_EDITOR_CONTROL::RenameSymbol().

◆ GetLibraryItemsForListDialog()

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

inherited

Definition at line 663 of file sch_base_frame.cpp.

References _, alg::contains(), PGM_BASE::GetCommonSettings(), LIBRARY_MANAGER_ADAPTER::GetLibraryDescription(), LIBRARY_MANAGER_ADAPTER::GetLibraryNames(), LIB_TREE_MODEL_ADAPTER::GetPinningSymbol(), PROJECT::GetProjectFile(), COMMON_SETTINGS::m_Session, Pgm(), COMMON_SETTINGS::SESSION::pinned_symbol_libs, KIWAY_HOLDER::Prj(), project, and PROJECT_SCH::SymbolLibAdapter().

Referenced by SAVE_SYMBOL_AS_DIALOG::SAVE_SYMBOL_AS_DIALOG(), and SelectLibrary().

◆ GetLibSymbol()

LIB_SYMBOL * SCH_BASE_FRAME::GetLibSymbol	(	const LIB_ID &	aLibId,
		bool	aUseCacheLib = false,
		bool	aShowErrorMsg = false )

inherited

Load symbol from symbol library table.

Parameters

aLibId	is the symbol library identifier to load.
aUseCacheLib	set to true to fall back to cache library if symbol is not found in symbol library table.
aShowErrorMsg	set to true to show any error messages.

Returns: The symbol found in the library or NULL if the symbol was not found.

Definition at line 280 of file sch_base_frame.cpp.

References LEGACY_SYMBOL_LIBS::GetCacheLibrary(), PROJECT_SCH::LegacySchLibs(), KIWAY_HOLDER::Prj(), SchGetLibSymbol(), and PROJECT_SCH::SymbolLibAdapter().

Referenced by PlaceRemoteDownloadedSymbol(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_EDIT_FRAME::SelectUnit(), and DIALOG_CHANGE_SYMBOLS::updateFieldsList().

◆ GetLibTree()

LIB_TREE * SYMBOL_EDIT_FRAME::GetLibTree ( ) const

inlineoverridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 108 of file symbol_edit_frame.h.

References m_treePane.

Referenced by activateSymbolTab(), AddLibraryFile(), doCloseWindow(), emptyScreen(), FocusLibraryTreeInput(), FocusOnLibId(), GetTreeLIBID(), GetTreeLIBIDs(), GetTreeSelectionCount(), KiwayMailIn(), OnModify(), RefreshLibraryTree(), SaveSettings(), SetCurSymbol(), ShowChangedLanguage(), SyncLibraries(), and UpdateLibraryTree().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 614 of file eda_base_frame.h.

References m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

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

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

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

◆ 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

aScope	is the scope of the plugins to get.
aCfg	is the settings to read the plugin ordering from.

Definition at line 1479 of file eda_draw_frame.cpp.

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

Referenced by AddApiPluginMenuItems(), AddApiPluginTools(), and PCB_EDIT_FRAME::GetOrderedPluginActions().

◆ GetOriginTransforms()

ORIGIN_TRANSFORMS & EDA_BASE_FRAME::GetOriginTransforms ( )

inlineoverridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from UNITS_PROVIDER.

Reimplemented in PCB_BASE_FRAME.

Definition at line 141 of file eda_base_frame.h.

References m_originTransforms.

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

◆ GetOverrideLocks()

bool EDA_DRAW_FRAME::GetOverrideLocks ( ) const

inherited

Definition at line 513 of file eda_draw_frame.cpp.

References m_overrideLocksCb.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), PCB_POINT_EDITOR::OnSelectionChange(), and ValidateNetSwapLocks().

◆ GetPageSettings()

const PAGE_INFO & SCH_BASE_FRAME::GetPageSettings ( ) const

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 223 of file sch_base_frame.cpp.

References SCH_SCREEN::GetPageSettings(), and GetScreen().

Referenced by SCH_EDIT_FRAME::InitSheet().

◆ GetPageSizeIU()

const VECTOR2I SCH_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 229 of file sch_base_frame.cpp.

References SCH_SCREEN::GetPageSettings(), GetScreen(), PAGE_INFO::GetSizeIU(), and schIUScale.

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard().

◆ GetPropertiesPanel()

PROPERTIES_PANEL * EDA_DRAW_FRAME::GetPropertiesPanel ( )

inlineinherited

Definition at line 421 of file eda_draw_frame.h.

References m_propertiesPanel.

◆ GetRedoActionDescription()

wxString EDA_BASE_FRAME::GetRedoActionDescription ( ) const

virtualinherited

Reimplemented in CVPCB_MAINFRAME.

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

◆ GetRenderSettings()

SCH_RENDER_SETTINGS * SCH_BASE_FRAME::GetRenderSettings ( )

inherited

Definition at line 316 of file sch_base_frame.cpp.

References GetCanvas().

Referenced by SYMBOL_EDIT_FRAME::activateSymbolTab(), SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), SCH_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSettings(), SYMBOL_VIEWER_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::RebuildView(), SYMBOL_EDIT_FRAME::SaveSettings(), SYMBOL_VIEWER_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SYMBOL_VIEWER_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SYMBOL_EDIT_FRAME::SVGPlotSymbol(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), SYMBOL_EDITOR_CONTROL::ToggleHiddenFields(), SYMBOL_EDITOR_CONTROL::ToggleHiddenPins(), and SYMBOL_VIEWER_FRAME::updatePreviewSymbol().

◆ GetReplaceHistoryList()

wxArrayString & EDA_DRAW_FRAME::GetReplaceHistoryList ( )

inlineinherited

Definition at line 108 of file eda_draw_frame.h.

References m_replaceStringHistoryList.

◆ GetRunMenuCommandDescription()

wxString EDA_BASE_FRAME::GetRunMenuCommandDescription ( const TOOL_ACTION & aAction )

inherited

Definition at line 916 of file eda_base_frame.cpp.

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

◆ GetScreen()

SCH_SCREEN * SCH_BASE_FRAME::GetScreen ( ) const

overridevirtualinherited

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.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 183 of file sch_base_frame.cpp.

References EDA_DRAW_FRAME::GetScreen().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1169 of file eda_draw_frame.cpp.

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

◆ GetSelectedLibIds()

std::vector< LIB_ID > SYMBOL_EDIT_FRAME::GetSelectedLibIds ( ) const

Returns: a list of selected items in the symbol tree

Definition at line 1523 of file symbol_edit_frame.cpp.

References GetTreeLIBIDs().

Referenced by SYMBOL_EDITOR_CONTROL::CutCopyDelete(), DeleteSymbolFromLibrary(), and SYMBOL_EDITOR_CONTROL::Init().

◆ GetSelectionTool()

SCH_SELECTION_TOOL * SCH_BASE_FRAME::GetSelectionTool ( )

overridevirtualinherited

Reimplemented from SCHEMATIC_HOLDER.

Definition at line 991 of file sch_base_frame.cpp.

References TOOLS_HOLDER::m_toolManager.

◆ GetSettings()

SYMBOL_EDITOR_SETTINGS * SYMBOL_EDIT_FRAME::GetSettings ( ) const

inline

Definition at line 277 of file symbol_edit_frame.h.

References m_settings.

Referenced by activateSymbolTab(), config(), GetColorSettings(), LoadSettings(), SaveSettings(), SetScreen(), setupTools(), SYMBOL_EDIT_FRAME(), and SYMBOL_EDITOR_CONTROL::ToggleSyncedPinsMode().

◆ GetSettingsManager()

SETTINGS_MANAGER * EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int aErrorCode ) const

inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME, and SCH_EDIT_FRAME.

Definition at line 149 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

◆ GetShowAllPins()

virtual bool SCH_BASE_FRAME::GetShowAllPins ( ) const

inlinevirtualinherited

Allow some frames to show/hide hidden pins.

The default impl shows all pins.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 141 of file sch_base_frame.h.

◆ GetShowInvisibleFields()

bool SYMBOL_EDIT_FRAME::GetShowInvisibleFields ( )

Definition at line 2526 of file symbol_edit_frame.cpp.

References SCH_BASE_FRAME::libeditconfig(), and SYMBOL_EDITOR_SETTINGS::m_ShowHiddenFields.

Referenced by SCH_SELECTION_TOOL::narrowSelection(), and SCH_SELECTION_TOOL::Selectable().

◆ GetShowInvisiblePins()

bool SYMBOL_EDIT_FRAME::GetShowInvisiblePins ( )

Definition at line 2533 of file symbol_edit_frame.cpp.

References SCH_BASE_FRAME::libeditconfig(), and SYMBOL_EDITOR_SETTINGS::m_ShowHiddenPins.

Referenced by SCH_SELECTION_TOOL::narrowSelection().

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const

inlineinherited

For those frames that support polar coordinates.

Definition at line 122 of file eda_draw_frame.h.

References m_polarCoords.

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

◆ GetSymbolFromRedoList()

◆ GetSymbolFromUndoList()

◆ GetTabsPanel()

EDITOR_TABS_PANEL * SYMBOL_EDIT_FRAME::GetTabsPanel ( ) const

inline

The tab strip fronting the shared canvas, or nullptr before it is mounted.

Definition at line 113 of file symbol_edit_frame.h.

References m_tabsPanel.

Referenced by SYMBOL_EDITOR_CONTROL::CloseTab(), SYMBOL_EDITOR_CONTROL::NextTab(), SYMBOL_EDITOR_CONTROL::PrevTab(), and showTabSwitcher().

◆ getTargetLib()

wxString SYMBOL_EDIT_FRAME::getTargetLib ( ) const

private

Return either the library selected in the symbol tree, if context menu is active or the library that is currently modified.

Definition at line 1531 of file symbol_edit_frame.cpp.

References LIB_ID::GetLibNickname(), and GetTargetLibId().

Referenced by CreateNewSymbol(), ImportSymbol(), and saveLibrary().

◆ GetTargetLibId()

LIB_ID SYMBOL_EDIT_FRAME::GetTargetLibId ( ) const

overridevirtual

Return either the symbol selected in the symbol tree (if context menu is active) or the symbol on the editor canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1509 of file symbol_edit_frame.cpp.

References empty(), GetTreeLIBID(), IsLibraryTreeShown(), and m_symbol.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), DeleteSymbolFromLibrary(), DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::FlattenSymbol(), getTargetLib(), RevertAll(), SaveLibraryAs(), and setupUIConditions().

◆ getTargetSymbol()

LIB_SYMBOL * SYMBOL_EDIT_FRAME::getTargetSymbol ( ) const

private

Return currently edited symbol.

Definition at line 1495 of file symbol_edit_frame.cpp.

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), GetTreeLIBID(), IsLibraryTreeShown(), LIB_ID::IsValid(), m_libMgr, and m_symbol.

Referenced by ExportSymbol(), saveSymbolCopyAs(), and setupUIConditions().

◆ GetTitleBlock()

const TITLE_BLOCK & SCH_BASE_FRAME::GetTitleBlock ( ) const

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 236 of file sch_base_frame.cpp.

References GetScreen(), and SCH_SCREEN::GetTitleBlock().

◆ GetToolCanvas()

wxWindow * EDA_DRAW_FRAME::GetToolCanvas ( ) const

inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 468 of file eda_draw_frame.h.

References GetCanvas().

◆ GetToolDispatcher()

TOOL_DISPATCHER * TOOLS_HOLDER::GetToolDispatcher ( ) const

inlineinherited

Definition at line 53 of file tools_holder.h.

References m_toolDispatcher.

◆ GetToolManager()

TOOL_MANAGER * TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 51 of file tools_holder.h.

References m_toolManager.

◆ GetTreeLIBID()

LIB_ID SYMBOL_EDIT_FRAME::GetTreeLIBID ( int * aUnit = nullptr ) const

Return the LIB_ID of the library or symbol selected in the symbol tree.

Definition at line 1478 of file symbol_edit_frame.cpp.

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

Referenced by SYMBOL_EDITOR_CONTROL::CompareLibraryWithFile(), SYMBOL_EDITOR_CONTROL::EditSymbol(), GetTargetLibId(), getTargetSymbol(), SYMBOL_EDITOR_CONTROL::OpenDirectory(), SYMBOL_EDITOR_CONTROL::OpenWithTextEditor(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), and Save().

◆ GetTreeLIBIDs()

int SYMBOL_EDIT_FRAME::GetTreeLIBIDs ( std::vector< LIB_ID > & aSelection ) const

Definition at line 1489 of file symbol_edit_frame.cpp.

References GetLibTree(), and LIB_TREE::GetSelectedLibIds().

Referenced by CopySymbolToClipboard(), and GetSelectedLibIds().

◆ GetTreeSelectionCount()

int SYMBOL_EDIT_FRAME::GetTreeSelectionCount ( ) const

Definition at line 1484 of file symbol_edit_frame.cpp.

References GetLibTree(), and LIB_TREE::GetSelectionCount().

Referenced by SYMBOL_EDITOR_CONTROL::Init().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 47 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 224 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 1910 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 608 of file eda_base_frame.h.

References m_undoList.

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

◆ GetUnit()

int SYMBOL_EDIT_FRAME::GetUnit ( ) const

inline

Definition at line 304 of file symbol_edit_frame.h.

References m_unit.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), EE_GRAPHIC_TOOL::applySymbolEditorFlags(), SYMBOL_EDITOR_CONTROL::ChangeUnit(), EE_GRAPHIC_TOOL::drawManagedShape(), DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditLibrarySymbol(), SCH_SELECTION_TOOL::Init(), LoadSymbol(), SCH_SELECTION_TOOL::Reset(), SCH_SELECTION_TOOL::Selectable(), SVGPlotSymbol(), and updateInfoBar().

◆ 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 1363 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 202 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 543 of file eda_base_frame.h.

References m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 41 of file units_provider.h.

References m_userUnits.

Referenced by FOOTPRINT_EDIT_FRAME::borrowBoardNonDestructive(), PGE::IFACE::CreateKiWindow(), DIALOG_SHIM::DIALOG_SHIM(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME(), WX_GRID::getColumnUnits(), RC_ITEM::GetJsonViolation(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUnitPair(), GetUnitsFromType(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), MARGIN_OFFSET_BINDER::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PopulateConstraintList(), POSITION_RELATIVE_TOOL::PositionRelative(), EDA_DRAW_FRAME::SaveSettings(), SCH_EDIT_FRAME::SaveSettings(), PCB_BASE_FRAME::SetBoard(), WX_GRID::SetUnitsProvider(), EDA_DRAW_FRAME::ToggleUserUnits(), EDA_DRAW_FRAME::unitsChangeRefresh(), PCB_BASE_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), PL_EDITOR_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), and GRID::UserUnitsMessageText().

◆ GetViewerSettingsBase()

APP_SETTINGS_BASE * SCH_BASE_FRAME::GetViewerSettingsBase ( ) const

inherited

Definition at line 201 of file sch_base_frame.cpp.

References FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, FRAME_SCH_VIEWER, FRAME_SYMBOL_CHOOSER, GetAppSettings(), and EDA_BASE_FRAME::GetFrameType().

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

References APP_SETTINGS_BASE::m_Window.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::IsGridOverridden(), EDA_DRAW_FRAME::IsGridVisible(), LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), EDA_DRAW_FRAME::SetGridOverrides(), EDA_DRAW_FRAME::SetGridVisibility(), EDA_DRAW_FRAME::UpdateGridSelectBox(), and EDA_DRAW_FRAME::UpdateZoomSelectBox().

◆ 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 1969 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 SCH_BASE_FRAME::handleActivateEvent ( wxActivateEvent & aEvent )

overrideprotectedvirtualinherited

Handle a window activation event.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 645 of file sch_base_frame.cpp.

References EDA_DRAW_FRAME::handleActivateEvent(), and m_spaceMouse.

◆ handleIconizeEvent()

void SCH_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 654 of file sch_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 1993 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 ACTION_CONDITIONS used.

Definition at line 632 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 SYMBOL_EDIT_FRAME::HardRedraw ( )

overridevirtual

Rebuild the GAL and redraw the screen.

Call when something went wrong.

Reimplemented from SCH_BASE_FRAME.

Definition at line 1908 of file symbol_edit_frame.cpp.

References alg::contains(), SCH_SELECTION_TOOL::GetSelection(), m_symbol, TOOLS_HOLDER::m_toolManager, RebuildView(), and SyncLibraries().

◆ hasDirtyInactiveInstanceTabs()

bool SYMBOL_EDIT_FRAME::hasDirtyInactiveInstanceTabs ( ) const

private

True if any non-active instance (schematic) tab has unsaved edits.

Used to veto a session-end query early, since those tabs are invisible to IsContentModified (which sees only the active tab).

Definition at line 566 of file symbol_edit_frame_tabs.cpp.

References m_activeTab, and m_tabContexts.

Referenced by canCloseWindow().

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

References m_kiway.

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

◆ HasLibModifications()

bool SYMBOL_EDIT_FRAME::HasLibModifications ( ) const

Check if any pending libraries have been modified.

This only checks for modified libraries. If a new symbol was created and modified and no libraries have been modified, the return value will be false.

Returns: True if there are any pending library modifications.

Definition at line 2161 of file symbol_edit_frame.cpp.

References m_libMgr.

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 1325 of file eda_base_frame.cpp.

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

◆ HighlightSelectionFilter()

void SCH_BASE_FRAME::HighlightSelectionFilter ( const SCH_SELECTION_FILTER_OPTIONS & aOptions )

inherited

Definition at line 1000 of file sch_base_frame.cpp.

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

◆ ImportSymbol()

void SYMBOL_EDIT_FRAME::ImportSymbol ( )

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

Referenced by commonInit().

◆ IntersheetRefUpdate()

virtual void SCHEMATIC_HOLDER::IntersheetRefUpdate ( SCH_GLOBALLABEL * aItem )

inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 47 of file schematic_holder.h.

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

References m_autoSaveRequired.

Referenced by onAutoSaveTimer(), and ProcessEvent().

◆ IsClosing()

bool EDA_BASE_FRAME::IsClosing ( ) const

inlineinherited

Definition at line 622 of file eda_base_frame.h.

References m_isClosing.

Referenced by SIMULATOR_FRAME::onSimFinished().

◆ IsContentModified()

bool SYMBOL_EDIT_FRAME::IsContentModified ( ) const

overridevirtual

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

Returns: true if the any changes have not been saved

Reimplemented from EDA_BASE_FRAME.

Definition at line 2169 of file symbol_edit_frame.cpp.

References GetCurSymbol(), SCH_BASE_FRAME::GetScreen(), IsContentModified(), and m_libMgr.

Referenced by CanCloseSymbolFromSchematic(), canCloseWindow(), IsContentModified(), LoadSymbol(), LoadSymbol(), and OnModify().

◆ IsCurrentSymbol()

bool SYMBOL_EDIT_FRAME::IsCurrentSymbol ( const LIB_ID & aLibId ) const

Return true if aLibId is an alias for the editor screen symbol.

Definition at line 1788 of file symbol_edit_frame.cpp.

References LIB_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), m_libMgr, and m_symbol.

Referenced by SYMBOL_EDITOR_CONTROL::RenameSymbol(), and Revert().

◆ IsCurrentTool()

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

inherited

Definition at line 136 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 160 of file kiway_player.cpp.

References m_modal_loop.

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

◆ IsGridOverridden()

bool EDA_DRAW_FRAME::IsGridOverridden ( )

inherited

Definition at line 552 of file eda_draw_frame.cpp.

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

Referenced by EDITOR_CONDITIONS::gridOverridesFunc().

◆ IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( )

inherited

Definition at line 522 of file eda_draw_frame.cpp.

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

Referenced by EDITOR_CONDITIONS::gridFunc().

◆ IsLibraryTreeShown()

bool SYMBOL_EDIT_FRAME::IsLibraryTreeShown ( ) const

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1010 of file symbol_edit_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, and m_treePane.

Referenced by SYMBOL_EDITOR_CONTROL::EditLibrarySymbol(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), GetTargetLibId(), getTargetSymbol(), LoadSymbolFromSchematic(), promptAndCloseSymbolTab(), Save(), setupUIConditions(), and ToggleLibraryTree().

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

References m_modal.

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

◆ IsPluginActionButtonVisible()

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

staticinherited

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

◆ IsSymbolAlias()

bool SYMBOL_EDIT_FRAME::IsSymbolAlias ( ) const

Definition at line 2479 of file symbol_edit_frame.cpp.

References m_symbol.

Referenced by activateSymbolTab(), IsSymbolGraphicallyEditable(), RebuildView(), SCH_SELECTION_TOOL::Selectable(), SetCurSymbol(), and updateInfoBar().

◆ IsSymbolEditable()

bool SYMBOL_EDIT_FRAME::IsSymbolEditable ( ) const

Test if a symbol is loaded and can be edited.

The following conditions are required for a symbol to be editable:

The symbol must selected from either a library or the schematic.
The symbol must not be from a legacy library.

Note that many things are not editable in a non-root symbol (ie: an alias), but others are so this routine is true for an alias symbol. Use IsSymbolGraphicallyEditable() to test if a symbol's graphical elements can be edited.

Definition at line 2485 of file symbol_edit_frame.cpp.

References IsSymbolFromLegacyLibrary(), IsSymbolFromSchematic(), and m_symbol.

Referenced by setupUIConditions().

◆ IsSymbolFromLegacyLibrary()

bool SYMBOL_EDIT_FRAME::IsSymbolFromLegacyLibrary ( ) const

Definition at line 1072 of file symbol_edit_frame.cpp.

References LIBRARY_MANAGER_ADAPTER::GetRow(), m_symbol, Prj(), SCH_IO_MGR::ShowType(), and PROJECT_SCH::SymbolLibAdapter().

Referenced by activateSymbolTab(), IsSymbolEditable(), IsSymbolGraphicallyEditable(), RebuildView(), SetCurSymbol(), setupUIConditions(), and updateInfoBar().

◆ IsSymbolFromSchematic()

bool SYMBOL_EDIT_FRAME::IsSymbolFromSchematic ( ) const

inline

Definition at line 335 of file symbol_edit_frame.h.

References EDA_BASE_FRAME::m_isClosing, and m_isSymbolFromSchematic.

Referenced by activateSymbolTab(), doReCreateMenuBar(), SYMBOL_EDITOR_CONTROL::EditLibrarySymbol(), IsSymbolEditable(), IsSymbolGraphicallyEditable(), LoadOneLibrarySymbol(), LoadSymbol(), LoadSymbol(), OnModify(), RebuildView(), saveCurrentSymbol(), SetCurSymbol(), setupUIConditions(), UpdateAfterSymbolProperties(), and updateInfoBar().

◆ IsSymbolGraphicallyEditable()

bool SYMBOL_EDIT_FRAME::IsSymbolGraphicallyEditable ( ) const

Test if a symbol is loaded and can be edited graphically.

The following conditions are required for a symbol to be graphically editable:

The symbol must be selected from either a library or the schematic.
The symbol must not be from a legacy library.
The symbol must not be an alias unless it is from a schematic.

This returns false for an alias symbol that is not from a schematic, even though some of its fields can be edited. Use IsSymbolEditable() to test if a symbol can be edited in any way.

Definition at line 2491 of file symbol_edit_frame.cpp.

References IsSymbolAlias(), IsSymbolFromLegacyLibrary(), IsSymbolFromSchematic(), and m_symbol.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), EE_GRAPHIC_TOOL::ImportGraphics(), and setupUIConditions().

◆ IsSyncLibrariesInProgress()

bool SYMBOL_EDIT_FRAME::IsSyncLibrariesInProgress ( ) const

inline

Definition at line 262 of file symbol_edit_frame.h.

References m_syncLibrariesInProgress.

◆ 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(), SCH_COMMIT::SCH_COMMIT(), and NET_CHAIN_MENU::update().

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

References m_kiway.

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_MAIL_EVENT & aEvent )

protectedinherited

Event handler, routes to derivative specific virtual KiwayMailIn().

Definition at line 181 of file kiway_player.cpp.

References KiwayMailIn().

◆ KiwayMailIn()

void SYMBOL_EDIT_FRAME::KiwayMailIn ( KIWAY_MAIL_EVENT & aEvent )

overridevirtual

Receive KIWAY_MAIL_EVENT messages from other players.

Override it in derived classes.

Reimplemented from KIWAY_PLAYER.

Definition at line 2011 of file symbol_edit_frame.cpp.

References _, LIB_TREE::CenterLibId(), KIWAY_MAIL_EVENT::Command(), DisplayErrorMessage(), LIB_TREE::ExpandLibId(), LIBRARY_MANAGER_ADAPTER::FindRowByURI(), FreezeLibraryTree(), GetCurSymbol(), LIBRARY_MANAGER::GetFullURI(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibNickname(), GetLibTree(), LIB_SYMBOL::GetName(), KIWAY_MAIL_EVENT::GetPayload(), LIBRARY_MANAGER_ADAPTER::GetRow(), LIBRARY_MANAGER_ADAPTER::HasLibrary(), Kiway, m_libMgr, TOOLS_HOLDER::m_toolManager, m_treePane, MAIL_LIB_EDIT, MAIL_REFRESH_SYMBOL, MAIL_RELOAD_LIB, TOOL_BASE::MODEL_RELOAD, Prj(), RebuildSymbolUnitAndBodyStyleLists(), RefreshLibraryTree(), LIB_TREE::SelectLibId(), SetCurSymbol(), PROJECT_SCH::SymbolLibAdapter(), SyncLibraries(), ThawLibraryTree(), TOOLS_HOLDER::ToolStackIsEmpty(), traceLibWatch, and UnescapeString().

◆ libeditconfig()

SYMBOL_EDITOR_SETTINGS * SCH_BASE_FRAME::libeditconfig ( ) const

inherited

Definition at line 195 of file sch_base_frame.cpp.

References EDA_BASE_FRAME::config().

Referenced by SYMBOL_EDIT_FRAME::GetShowInvisibleFields(), SYMBOL_EDIT_FRAME::GetShowInvisiblePins(), and SYMBOL_EDIT_FRAME::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 1183 of file eda_draw_frame.cpp.

References KIPLATFORM::UI::AllowNetworkFileSystems(), 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().

◆ libTreeAutoHiddenForSchematicEdit()

bool SYMBOL_EDIT_FRAME::libTreeAutoHiddenForSchematicEdit	(	bool	aWasFromSchematic,
		bool	aRestorePending,
		bool	aTreeShownNow )

static

Resolve whether the library tree's auto-hide for a schematic edit still needs restoring on save.

A chained schematic edit finds the tree already auto-hidden and keeps the pending restore; a tree hidden by an explicit user toggle carries no pending restore.

Definition at line 2232 of file symbol_edit_frame.cpp.

Referenced by SYMBOL_EDITOR_TABS_TEST_FIXTURE::libTreeAutoHiddenForSchematicEdit(), and LoadSymbolFromSchematic().

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )

protectedinherited

Return the canvas type stored in the application settings.

Definition at line 940 of file eda_draw_frame.cpp.

References EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, Pgm(), and EDA_DRAW_PANEL_GAL::ResolveStoredCanvasType().

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

◆ LoadOneLibrarySymbol()

bool SYMBOL_EDIT_FRAME::LoadOneLibrarySymbol	(	LIB_SYMBOL *	aLibEntry,
		const wxString &	aLibrary,
		int	aUnit,
		int	aBodyStyle )

private

Create a copy of aLibEntry into memory.

Parameters

aLibEntry	A pointer to the LIB_SYMBOL object to an already loaded symbol.
aLibrary	the path to the library file that aLibEntry was loaded from. This is for error messaging purposes only.
aUnit	the initial unit to show.
aBodyStyle	the initial DeMorgan variant to show.

Returns: True if a copy of aLibEntry was successfully copied.

Definition at line 229 of file symbol_editor.cpp.

References KIGFX::ALL, ACTIONS::cancelInteractive, EDA_BASE_FRAME::ClearUndoRedoList(), WX_INFOBAR::Dismiss(), findOrCreateSymbolTab(), SCH_BASE_FRAME::GetCanvas(), GetCurSymbol(), EDA_BASE_FRAME::GetInfoBar(), LIB_SYMBOL::GetLibId(), LIB_SYMBOL::GetName(), SCH_DRAW_PANEL::GetView(), IsSymbolFromSchematic(), m_bodyStyle, m_libMgr, TOOLS_HOLDER::m_toolManager, m_unit, RebuildSymbolUnitAndBodyStyleLists(), EDA_BASE_FRAME::ReCreateMenuBar(), EDA_BASE_FRAME::RecreateToolbars(), SCH_BASE_FRAME::setSymWatcher(), KIGFX::VIEW::UpdateAllItems(), UpdateMsgPanel(), and ACTIONS::zoomFitScreen.

Referenced by DuplicateSymbol(), LoadSymbol(), and LoadSymbolFromLib().

◆ LoadSettings()

void SYMBOL_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 SCH_BASE_FRAME.

Definition at line 447 of file symbol_edit_frame.cpp.

References SCH_BASE_FRAME::GetRenderSettings(), GetSettings(), SCH_BASE_FRAME::LoadSettings(), m_settings, SCH_RENDER_SETTINGS::m_ShowHiddenFields, SCH_RENDER_SETTINGS::m_ShowHiddenPins, SCH_RENDER_SETTINGS::m_ShowPinAltIcons, SCH_RENDER_SETTINGS::m_ShowPinsElectricalType, and KIGFX::RENDER_SETTINGS::SetDefaultFont().

Referenced by SYMBOL_EDIT_FRAME().

◆ LoadSymbol() [1/2]

bool SYMBOL_EDIT_FRAME::LoadSymbol	(	const LIB_ID &	aLibId,
		int	aUnit,
		int	aBodyStyle )

Select the currently active library and loads the symbol from aLibId.

Parameters

aLibId	is the LIB_ID of the symbol to select.
aUnit	the unit to show
aBodyStyle	the DeMorgan variant to show

Returns: true if the symbol defined by aLibId was loaded.

Definition at line 118 of file symbol_editor.cpp.

References _, centerItemIdleHandler(), DisplayErrorMessage(), SCH_IO_MGR::EnumFromStr(), GetBodyStyle(), GetCurSymbol(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), PGM_BASE::GetLibraryManager(), LIBRARY_MANAGER::GetRow(), SCH_BASE_FRAME::GetScreen(), LIB_SYMBOL::GetSourceLibId(), LIB_ID::GetUniStringLibId(), LIB_ID::GetUniStringLibItemName(), GetUnit(), HandleUnsavedChanges(), IsContentModified(), IsSymbolFromSchematic(), LIB_ID::IsValid(), SYMBOL_LIBRARY_ADAPTER::LoadSymbol(), LoadSymbolFromLib(), m_centerItemOnIdle, m_treePane, Pgm(), Prj(), saveCurrentSymbol(), SCH_BASE_FRAME::setSymWatcher(), SYMBOL, PROJECT_SCH::SymbolLibAdapter(), LIBRARY_TABLE_ROW::Type(), and IO_ERROR::What().

◆ LoadSymbol() [2/2]

void SYMBOL_EDIT_FRAME::LoadSymbol	(	const wxString &	aLibrary,
		const wxString &	aSymbol,
		int	Unit )

◆ LoadSymbolFromLib()

bool SYMBOL_EDIT_FRAME::LoadSymbolFromLib	(	const wxString &	aLibName,
		const wxString &	aSymbolName,
		int	aUnit = 0,
		int	aBodyStyle = 0 )

private

Load a symbol from a library, optionally setting the selected unit and body style.

Parameters

aLibName	The nickname of the library
aSymbolName	The symbol alias name to load from the current library.
aUnit	Unit to be selected
aBodyStyle	Body style to be selected

Returns: true if the symbol loaded correctly.

Definition at line 198 of file symbol_editor.cpp.

References _, DisplayErrorMessage(), LoadOneLibrarySymbol(), SYMBOL_LIBRARY_ADAPTER::LoadSymbol(), TOOLS_HOLDER::m_toolManager, Prj(), RebuildSymbolUnitAndBodyStyleLists(), PROJECT_SCH::SymbolLibAdapter(), UnescapeString(), IO_ERROR::What(), and ACTIONS::zoomFitScreen.

Referenced by LoadSymbol(), and updateInfoBar().

◆ LoadSymbolFromSchematic()

void SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic ( SCH_SYMBOL * aSymbol )

Load a symbol from the schematic to edit in place.

Parameters

aSymbol the symbol to edit.

Definition at line 2245 of file symbol_edit_frame.cpp.

References KIGFX::ALL, findOrCreateSymbolInstanceTab(), LIB_SYMBOL::Flatten(), SCH_ITEM::GetBodyStyle(), SCH_BASE_FRAME::GetCanvas(), SCH_SYMBOL::GetFields(), SCH_SYMBOL::GetLibId(), SCH_SYMBOL::GetLibSymbolRef(), SCH_SYMBOL::GetOrientation(), SCH_SYMBOL::GetPosition(), SCH_ITEM::GetUnit(), SCH_DRAW_PANEL::GetView(), IsLibraryTreeShown(), libTreeAutoHiddenForSchematicEdit(), EDA_BASE_FRAME::m_auimgr, m_isSymbolFromSchematic, m_libTreeAutoHiddenForSchematicEdit, TOOLS_HOLDER::m_toolManager, m_treePane, EDA_ITEM::m_Uuid, TOOL_BASE::MODEL_RELOAD, RebuildSymbolUnitAndBodyStyleLists(), EDA_BASE_FRAME::ReCreateMenuBar(), EDA_BASE_FRAME::RecreateToolbars(), EDA_DRAW_PANEL_GAL::Refresh(), SetDrawSpecificUnit(), SCH_FIELD::SetPosition(), SCH_BASE_FRAME::setSymWatcher(), SYM_MIRROR_X, SYM_MIRROR_Y, SYM_ORIENT_180, SYM_ORIENT_270, SYM_ORIENT_90, KIGFX::VIEW::UpdateAllItems(), updateInfoBar(), updateSelectionFilterVisbility(), UpdateSymbolMsgPanelInfo(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_EDITOR_CONTROL::EditWithSymbolEditor().

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

References defaultSize(), WINDOW_STATE::display, index, 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 1030 of file eda_base_frame.cpp.

References LoadWindowState(), Pgm(), and KIWAY_HOLDER::Prj().

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

References m_file_checker.

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

◆ MakeGridHelper()

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

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 2144 of file symbol_edit_frame.cpp.

References TOOLS_HOLDER::m_toolManager.

◆ MessageTextFromMinOptMax()

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

inlineinherited

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

◆ MessageTextFromUnscaledValue()

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

inlineinherited

Definition at line 137 of file units_provider.h.

References DISTANCE, EDA_UNIT_UTILS::UI::MessageTextFromValue(), unityScale, and UNSCALED.

Referenced by DRC_ENGINE::EvalRules().

◆ MessageTextFromValue() [1/2]

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

inlineinherited

Definition at line 130 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 123 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 429 of file eda_draw_frame.h.

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

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce )

inlineinherited

Definition at line 624 of file eda_base_frame.h.

References m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onActivate()

void EDA_DRAW_FRAME::onActivate ( wxActivateEvent & aEvent )

protectedinherited

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

References API_PLUGIN_MANAGER::ButtonBindings(), PGM_BASE::GetPluginManager(), API_PLUGIN_MANAGER::InvokeAction(), EDA_BASE_FRAME::m_ident, API_PLUGIN_MANAGER::MenuBindings(), Pgm(), and reporter.

Referenced by AddApiPluginMenuItems(), and AddApiPluginTools().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protectedinherited

Handle the auto save timer event.

Definition at line 421 of file eda_base_frame.cpp.

References doAutoSave(), GetAutoSaveInterval(), ID_AUTO_SAVE_TIMER, isAutoSaveRequired(), m_autoSavePending, m_autoSaveTimer, and m_isClosing.

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

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

References dump(), and kicadTraceKeyEvent.

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

References name, and KISTATUSBAR::WARNING_ICON.

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

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

◆ OnExitKiCad()

void SYMBOL_EDIT_FRAME::OnExitKiCad ( wxCommandEvent & event )

Definition at line 1036 of file symbol_edit_frame.cpp.

References Kiway, and KIWAY::OnKiCadExit().

◆ OnFindDialogClose()

void SCH_BASE_FRAME::OnFindDialogClose ( )

inherited

Notification that the Find dialog has closed.

Definition at line 589 of file sch_base_frame.cpp.

References m_findReplaceDialog, EDA_DRAW_FRAME::m_findStringHistoryList, EDA_DRAW_FRAME::m_replaceStringHistoryList, TOOLS_HOLDER::m_toolManager, and ACTIONS::updateFind.

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent & aEvent )

protectedinherited

Definition at line 2019 of file eda_base_frame.cpp.

References handleIconizeEvent().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

Definition at line 1523 of file eda_base_frame.cpp.

References EDA_BASE_FRAME(), and ShowAboutDialog().

◆ OnLanguageSelectionEvent()

void EDA_BASE_FRAME::OnLanguageSelectionEvent ( wxCommandEvent & aEvent )

protectedinherited

An event handler called on a language menu selection.

Definition at line 2073 of file eda_base_frame.cpp.

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

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

inherited

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

References TOOLS_HOLDER::m_toolDispatcher.

◆ OnModify()

void SYMBOL_EDIT_FRAME::OnModify ( )

overridevirtual

Must be called after a schematic change in order to set the "modify" flag of the current symbol.

Reimplemented from EDA_BASE_FRAME.

Definition at line 1254 of file symbol_edit_frame.cpp.

References GetLibTree(), SCH_BASE_FRAME::GetScreen(), IsContentModified(), IsSymbolFromSchematic(), m_activeTab, EDA_BASE_FRAME::m_isClosing, m_libMgr, m_symbol, m_tabsPanel, EDA_BASE_FRAME::OnModify(), LIB_TREE::RefreshLibTree(), and BASE_SCREEN::SetContentModified().

Referenced by CreateNewSymbol(), GetSymbolFromRedoList(), GetSymbolFromUndoList(), API_HANDLER_SYMBOL::onModified(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), and UpdateAfterSymbolProperties().

◆ OnMove()

void EDA_DRAW_FRAME::OnMove ( wxMoveEvent & aEvent )

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 628 of file eda_draw_frame.cpp.

References GetCanvas(), m_canvas, m_galDisplayOptions, and EDA_DRAW_PANEL_GAL::ResizeGal().

Referenced by EDA_DRAW_FRAME().

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

◆ onPluginAvailabilityChanged()

void SYMBOL_EDIT_FRAME::onPluginAvailabilityChanged ( wxCommandEvent & aEvt )

protected

Definition at line 792 of file symbol_edit_frame.cpp.

References EDA_BASE_FRAME::ReCreateMenuBar(), EDA_BASE_FRAME::RecreateToolbars(), and traceApi.

Referenced by doCloseWindow(), and SYMBOL_EDIT_FRAME().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

inherited

Definition at line 1530 of file eda_base_frame.cpp.

References ShowPreferences().

◆ OnSelectBodyStyle()

void SYMBOL_EDIT_FRAME::OnSelectBodyStyle ( wxCommandEvent & event )

Definition at line 1063 of file symbol_edit_frame.cpp.

References SetBodyStyle().

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

References dummy, ACTIONS::gridPreset, ACTIONS::gridProperties, m_canvas, m_gridSelectBox, TOOLS_HOLDER::m_toolManager, OnUpdateSelectGrid(), and UpdateStatusBar().

◆ OnSelectUnit()

void SYMBOL_EDIT_FRAME::OnSelectUnit ( wxCommandEvent & event )

Definition at line 1048 of file symbol_edit_frame.cpp.

References SetUnit().

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

References m_canvas, TOOLS_HOLDER::m_toolManager, m_zoomCustomEntry, 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 720 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().

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent & evt )

inherited

Definition at line 214 of file kiway_player.cpp.

References client_ipc_buffer, ExecuteRemoteCommand(), and IPC_BUF_SIZE.

◆ OnSockRequestServer()

void KIWAY_PLAYER::OnSockRequestServer ( wxSocketEvent & evt )

inherited

Definition at line 244 of file kiway_player.cpp.

References ID_EDA_SOCKET_EVENT, and m_sockets.

◆ OnSymChange()

void SCH_BASE_FRAME::OnSymChange ( wxFileSystemWatcherEvent & aEvent )

inherited

Handler for Symbol change events.

Responds to the filesystem watcher set in setSymWatcher.

Definition at line 878 of file sch_base_frame.cpp.

References m_watcher, m_watcherDebounceTimer, m_watcherFileName, m_watcherIsDir, and traceLibWatch.

Referenced by setSymWatcher().

◆ OnSymChangeDebounceTimer()

void SCH_BASE_FRAME::OnSymChangeDebounceTimer ( wxTimerEvent & aEvent )

inherited

Handler for the filesystem watcher debounce timer.

Definition at line 910 of file sch_base_frame.cpp.

References _, KIWAY::ExpressMail(), FRAME_SCH_SYMBOL_EDITOR, FRAME_SCH_VIEWER, GetScreen(), EDA_BASE_FRAME::IsContentModified(), IsOK(), FILEEXT::KiCadSymbolLibFileExtension, Kiway, m_inSymChangeTimerEvent, m_watcherDebounceTimer, m_watcherFileName, m_watcherIsDir, m_watcherTimestamp, MAIL_REFRESH_SYMBOL, KIPLATFORM::IO::TimestampDir(), TOOLS_HOLDER::ToolStackIsEmpty(), and traceLibWatch.

Referenced by SCH_BASE_FRAME().

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent & aEvent )

protectedinherited

Definition at line 2009 of file eda_base_frame.cpp.

References HandleSystemColorChange().

◆ OnTabCharHook()

void SYMBOL_EDIT_FRAME::OnTabCharHook ( wxKeyEvent & aEvent )

Cycle symbol tabs from the char hook, since GTK cannot register WXK_TAB as an accelerator.

Definition at line 234 of file symbol_edit_frame_tabs.cpp.

References m_tabsPanel.

Referenced by SYMBOL_EDIT_FRAME().

◆ OnToolbarSizeChanged()

void EDA_BASE_FRAME::OnToolbarSizeChanged ( )

inherited

Update toolbars if desired toolbar icon changed.

Definition at line 861 of file eda_base_frame.cpp.

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

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged().

◆ OnUpdateBodyStyle()

void SYMBOL_EDIT_FRAME::OnUpdateBodyStyle ( wxUpdateUIEvent & event )

Definition at line 1057 of file symbol_edit_frame.cpp.

References m_symbol.

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent & aEvent )

inherited

Update the checked item in the grid wxchoice.

Definition at line 406 of file eda_draw_frame.cpp.

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

Referenced by OnSelectGrid().

◆ OnUpdateSelectZoom()

void EDA_DRAW_FRAME::OnUpdateSelectZoom ( wxUpdateUIEvent & aEvent )

inherited

Update the checked item in the zoom wxchoice.

Definition at line 424 of file eda_draw_frame.cpp.

References _, EDA_BASE_FRAME::config(), GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_BASE_FRAME::GetWindowSettings(), KIGFX::GAL::GetZoomFactor(), m_zoomCustomEntry, m_zoomSelectBox, text, zoom, and WINDOW_SETTINGS::zoom_factors.

◆ onUpdateUI()

void EDA_BASE_FRAME::onUpdateUI ( wxUpdateUIEvent & aEvent )

privateinherited

Definition at line 621 of file eda_base_frame.cpp.

References m_uiUpdateMap.

Referenced by RegisterUIUpdateHandler().

◆ OnUpdateUnitNumber()

void SYMBOL_EDIT_FRAME::OnUpdateUnitNumber ( wxUpdateUIEvent & event )

Definition at line 1042 of file symbol_edit_frame.cpp.

References m_symbol.

◆ OpenProjectFiles()

virtual bool KIWAY_PLAYER::OpenProjectFiles	(	const std::vector< wxString > &	aFileList,
		int	aCtl = 0 )

inlinevirtualinherited

Open a project or set of files given by aFileList.

This is generalized in the direction of worst case. In a typical case aFileList will only hold a single file, like "myboard.kicad_pcb" because any KIWAY_PLAYER is only in one KIWAY and the KIWAY owns the PROJECT. Therefore opening files from multiple projects into the same KIWAY_PLAYER is precluded.

Each derived class should handle this in a way specific to its needs. No filename prompting is done inside here for any file or project. There should be no need to call this with aFileList which is empty. However, calling it with a single filename which does not exist should indicate to the implementer that a new session is being started and that the given name is the desired name for the data file at time of save.

This function does not support "appending". Use a different function for that. Any prior project data tree should be cleared before loading the new stuff. Therefore, one of the first things an implementation should do is test for existence of the first file in the list, and if it does not exist, treat it as a new session, possibly with a UI notification to that effect.

After loading the window should update its Title as part of this operation. If the KIWAY_PLAYER needs to, it can load the *.pro file as part of this operation.

If the KIWAY_PLAYER cannot load any of the file(s) in the list, then it should say why through some GUI interface, and return false.

Parameters

aFileList	includes files that this frame should open according to the knowledge in the derived wxFrame. In almost every case, the list will have only a single file in it.
aCtl	is a set of bit flags ORed together from the set of KICTL_* #defined above.

Returns: true if all requested files were opened OK, else false.

Reimplemented in BITMAP2CMP_FRAME, CVPCB_MAINFRAME, FOOTPRINT_EDIT_FRAME, GERBVIEW_FRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, and SCH_EDIT_FRAME.

Definition at line 102 of file kiway_player.h.

Referenced by PANEL_JOBSET::EnsurePcbSchFramesOpen(), BACK_ANNOTATE::FetchNetlistFromPCB(), PGM_SINGLE_TOP::MacOpenFile(), PGM_TEST_FRAME::MacOpenFile(), SCH_EDIT_FRAME::OnOpenPcbnew(), PGM_KICAD::OnPgmInit(), PGM_SINGLE_TOP::OnPgmInit(), SCH_EDIT_FRAME::OnUpdatePCB(), and PCB_EDIT_FRAME::TestStandalone().

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

◆ PickSymbolFromLibrary()

PICKED_SYMBOL SCH_BASE_FRAME::PickSymbolFromLibrary	(	const SYMBOL_LIBRARY_FILTER *	aFilter,
		std::vector< PICKED_SYMBOL > &	aHistoryList,
		std::vector< PICKED_SYMBOL > &	aAlreadyPlaced,
		bool	aShowFootprints,
		const LIB_ID *	aHighlight = nullptr,
		bool	aAllowFields = true,
		SYMBOL_COMPAT_FUNC	aCompatFunc = nullptr )

inherited

Call the library viewer to select symbol to import into schematic.

If the library viewer is currently running, it is closed and reopened in modal mode.

aAllowFields chooses whether or not features that permit the user to edit fields (e.g. footprint selection) should be enabled. This should be false when they would have no effect, for example loading a part into symbol_editor.

Parameters

aFilter	is an optional SYMBOL_LIBRARY_FILTER filter to pass the allowed library names and/or the library name to load the symbol from and/or some other filter
aHistoryList	is the list of previously loaded symbols - will be edited.
aAlreadyPlaced	is a list of symbols that have already been placed.
aHighlight	is the name of symbol to highlight in the list. highlights none if there isn't one by that name.
aShowFootprints	is the whether to show footprints in the dialog.
aAllowFields	is whether to allow field editing in the dialog.
aCompatFunc	is an optional callback used to flag and describe symbols that are not compatible as variant alternates for the current base symbol.

Returns: the selected symbol

Definition at line 46 of file picksymbol.cpp.

References PICKED_SYMBOL::BodyStyle, PICKED_SYMBOL::Fields, DIALOG_SYMBOL_CHOOSER::g_Mutex, DIALOG_SYMBOL_CHOOSER::GetChooserPanel(), DIALOG_SYMBOL_CHOOSER::GetFields(), DIALOG_SYMBOL_CHOOSER::GetKeepSymbol(), DIALOG_SYMBOL_CHOOSER::GetPlaceAllUnits(), DIALOG_SYMBOL_CHOOSER::GetSelectedLibId(), LIB_ID::IsValid(), PICKED_SYMBOL::KeepSymbol, PICKED_SYMBOL::LibId, PICKED_SYMBOL::PlaceAllUnits, PANEL_SYMBOL_CHOOSER::SetCompatibilityCallback(), DIALOG_SHIM::ShowModal(), and PICKED_SYMBOL::Unit.

Referenced by DIALOG_EDIT_SYMBOLS_LIBID::setLibIdByBrowser().

◆ PluginActionScope()

PLUGIN_ACTION_SCOPE SYMBOL_EDIT_FRAME::PluginActionScope ( ) const

inlineoverrideprotectedvirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 502 of file symbol_edit_frame.h.

References SYMBOL.

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

References m_undoList.

Referenced by PCB_BASE_EDIT_FRAME::AppendCopyToUndoList(), SCH_EDIT_FRAME::CopyVariant(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), API_HANDLER_SCH::handleCopyVariant(), API_HANDLER_SCH::handleDeleteVariant(), API_HANDLER_SCH::handleRenameVariant(), SCH_EDIT_FRAME::RemoveVariant(), SCH_EDIT_FRAME::RenameVariant(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), PCB_BASE_EDIT_FRAME::RollbackFromUndo(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), 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 79 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().

◆ 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

aSettings	are the rendering settings used for printing.
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 1139 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 1331 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 32 of file kiway_holder.cpp.

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

Referenced by DESIGN_BLOCK_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), AskSaveBoardFileName(), DIALOG_MIGRATE_3D_MODELS::AutoMigrateByFilename(), DIALOG_SYMBOL_REMAP::backupProject(), DIALOG_MIGRATE_3D_MODELS::BoardHasUnresolvedWrlReferences(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesList(), PCB_BASE_FRAME::canCloseWindow(), SIMULATOR_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), EDA_BASE_FRAME::CommonSettingsChanged(), SCH_INSPECTION_TOOL::CompareSchematicWithFile(), SCH_INSPECTION_TOOL::CompareSchematicWithHistory(), DIALOG_MIGRATE_3D_MODELS::CountUnresolvedWrlReferences(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_LIB_FIELDS_TABLE::createDatasheetEditor(), DIALOG_SYMBOL_FIELDS_TABLE::createDatasheetEditor(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_DRC_RULE_EDITOR::DIALOG_DRC_RULE_EDITOR(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_FOOTPRINT_FIELDS_TABLE::DIALOG_FOOTPRINT_FIELDS_TABLE(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::DIALOG_LIB_FOOTPRINT_FIELDS_TABLE(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), CVPCB_MAINFRAME::DisplayStatus(), EDA_BASE_FRAME::doAutoSave(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), DIALOG_GENDRILL::genDrillAndMapFiles(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TABLECELL_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), EDA_3D_VIEWER_FRAME::getExportFileName(), PCB_BASE_FRAME::GetLibraryItemsForListDialog(), SCH_BASE_FRAME::GetLibraryItemsForListDialog(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), FIELDS_GRID_TABLE::initGrid(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::loadFootprints(), KICAD_MANAGER_FRAME::LoadProject(), SIMULATOR_FRAME::LoadSettings(), SIMULATOR_FRAME::LoadSimulator(), EDA_BASE_FRAME::LoadWindowState(), EDA_3D_VIEWER_FRAME::NewDisplay(), DIALOG_SIM_MODEL< T >::onBrowseButtonClick(), DIALOG_EXPORT_2581::onBrowseClicked(), DIALOG_EXPORT_ODBPP::onBrowseClicked(), DIALOG_EXPORT_STEP::onBrowseClicked(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowseClicked(), DIALOG_REMOTE_SYMBOL_CONFIG::onBrowseDestination(), DIALOG_IMPORT_NETLIST::onBrowseNetlistFiles(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_FIELDS_TABLE::OnExport(), DIALOG_EXPORT_STEP::onExportButton(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), DIALOG_GENDRILL::onGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_CONFIG_EQUFILES::OnOkClick(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_PLOT::onOpenOutputDirectory(), DIALOG_GEN_FOOTPRINT_POSITION::onOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::onOutputDirectoryBrowseClicked(), DIALOG_PLOT::onOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::onOutputDirectoryBrowseClicked(), DIALOG_FIELDS_TABLE::OnOutputFileBrowseClicked(), DIALOG_BOARD_SETUP::onPageChanged(), DIALOG_SCHEMATIC_SETUP::onPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_DRC::OnSaveReport(), DIALOG_ERC::OnSaveReport(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), EDA_DRAW_FRAME::PrintDrawingSheet(), KICAD_MANAGER_FRAME::PrintPrjInfo(), KICAD_MANAGER_FRAME::ProjectChanged(), CVPCB_MAINFRAME::readNetListAndFpFiles(), EDA_3D_VIEWER_FRAME::ReloadRequest(), SIMULATOR_FRAME::ReloadSimulator(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), DIALOG_LIB_FIELDS_TABLE::resolveTextVar(), DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::resolveTextVar(), KICAD_MANAGER_FRAME::RestoreCommitFromHistory(), KICAD_MANAGER_FRAME::RestoreLocalHistory(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), KICAD_MANAGER_FRAME::SaveOpenJobSetsToLocalSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SIMULATOR_FRAME::SaveSettings(), DIALOG_EXPORT_2581::saveToProject(), SCH_BASE_FRAME::SelectLibrary(), PCB_BASE_FRAME::setFPWatcher(), GERBVIEW_FRAME::SetPageSettings(), SCH_BASE_FRAME::setSymWatcher(), BOARD_EDITOR_CONTROL::ShowEeschema(), PL_EDITOR_FRAME::SyncDataItem(), KICAD_MANAGER_FRAME::ToggleLocalHistory(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_SIM_MODEL< T >::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataToWindow(), KICAD_MANAGER_FRAME::UnarchiveFiles(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), DIALOG_FIELD_PROPERTIES::UpdateField(), SIMULATOR_FRAME::UpdateTitle(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), and EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME().

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

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

Referenced by STARTWIZARD::CheckAndRun(), KIWAY::ProcessEvent(), SYMBOL_VIEWER_FRAME::SelectNextSymbol(), SYMBOL_VIEWER_FRAME::SelectPreviousSymbol(), and KIWAY::SetLanguage().

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )

inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in KICAD_MANAGER_FRAME, PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 539 of file eda_base_frame.h.

Referenced by KIWAY::ProjectChanged(), and SCH_EDIT_FRAME::ProjectChanged().

◆ promptAndCloseSymbolTab()

bool SYMBOL_EDIT_FRAME::promptAndCloseSymbolTab ( int aIdx )

private

Prompt for unsaved changes on the tab and drop its context.

Returns false if the user cancels.

Definition at line 495 of file symbol_edit_frame_tabs.cpp.

References _, activateSymbolTab(), SYMBOL_EDITOR_TAB_CONTEXT::AdoptWorkingObjects(), clearSymbolTabUndoRedo(), EDA_BASE_FRAME::ClearUndoRedoList(), SYMBOL_EDITOR_TAB_CONTEXT::GetDisplayName(), SCH_BASE_FRAME::GetScreen(), IsLibraryTreeShown(), SYMBOL_EDITOR_TAB_CONTEXT::IsModified(), m_activeTab, m_dummyScreen, m_isSymbolFromSchematic, m_reference, m_schematicSymbolUUID, m_silentSymbolTabClose, m_symbol, m_tabContexts, m_treePane, niluuid, saveCurrentSymbol(), SetScreen(), KIDIALOG::ShowModal(), and symbolTabContextForIndex().

Referenced by SYMBOL_EDIT_FRAME().

◆ promptToSaveInactiveInstanceTabs()

bool SYMBOL_EDIT_FRAME::promptToSaveInactiveInstanceTabs ( )

private

Prompt to save each dirty instance (symbol from schematic) tab that is not the active one, since the active tab's unsaved state is handled by CanCloseSymbolFromSchematic.

Returns false if the user cancels so the window close can be vetoed.

Definition at line 578 of file symbol_edit_frame_tabs.cpp.

References _, activateSymbolTab(), m_activeTab, m_tabContexts, saveCurrentSymbol(), and KIDIALOG::ShowModal().

Referenced by canCloseWindow().

◆ PropertiesPaneName()

static const wxString EDA_DRAW_FRAME::PropertiesPaneName ( )

inlinestaticinherited

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

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

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

Referenced by SCH_EDIT_FRAME::CopyVariant(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), API_HANDLER_SCH::handleAddVariant(), API_HANDLER_SCH::handleCopyVariant(), API_HANDLER_SCH::handleDeleteVariant(), API_HANDLER_SCH::handleRenameVariant(), API_HANDLER_SCH::handleSetVariantDescription(), SYMBOL_EDIT_FRAME::PushSymbolToUndoList(), SCH_EDIT_FRAME::RemoveVariant(), SCH_EDIT_FRAME::RenameVariant(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PL_EDITOR_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), and SCH_EDIT_FRAME::ShowAddVariantDialog().

◆ PushSymbolToUndoList()

void SYMBOL_EDIT_FRAME::PushSymbolToUndoList	(	const wxString &	aDescription,
		LIB_SYMBOL *	aSymbolCopy,
		UNDO_REDO	aUndoType = UNDO_REDO::LIBEDIT )

Definition at line 31 of file symbol_editor_undo_redo.cpp.

References LIB_SYMBOL::ClearEditFlags(), LIB_SYMBOL::ClearTempFlags(), ClearUndoORRedoList(), SCH_BASE_FRAME::GetScreen(), EDA_BASE_FRAME::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), EDA_BASE_FRAME::REDO_LIST, PICKED_ITEMS_LIST::SetDescription(), EDA_ITEM::SetFlags(), and UR_TRANSIENT.

Referenced by 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 53 of file tools_holder.cpp.

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

Referenced by PCB_VIEWER_TOOLS::MeasureTool().

◆ RebuildSymbolUnitAndBodyStyleLists()

void SYMBOL_EDIT_FRAME::RebuildSymbolUnitAndBodyStyleLists ( )

Definition at line 920 of file symbol_edit_frame.cpp.

References DEMORGAN_ALT, DEMORGAN_STD, m_bodyStyle, m_bodyStyleSelectBox, m_symbol, m_unit, and m_unitSelectBox.

Referenced by activateSymbolTab(), GetSymbolFromRedoList(), GetSymbolFromUndoList(), KiwayMailIn(), LoadOneLibrarySymbol(), LoadSymbolFromLib(), LoadSymbolFromSchematic(), saveLibrary(), SYMBOL_EDIT_FRAME(), and UpdateAfterSymbolProperties().

◆ RebuildView()

void SYMBOL_EDIT_FRAME::RebuildView ( )

Definition at line 1889 of file symbol_edit_frame.cpp.

References KIGFX::ALL, KIGFX::SCH_VIEW::ClearHiddenFlags(), SCH_DRAW_PANEL::DisplaySymbol(), SCH_BASE_FRAME::GetCanvas(), SCH_BASE_FRAME::GetRenderSettings(), SCH_DRAW_PANEL::GetView(), KIGFX::SCH_VIEW::HideDrawingSheet(), IsSymbolAlias(), IsSymbolFromLegacyLibrary(), IsSymbolFromSchematic(), m_bodyStyle, SCH_RENDER_SETTINGS::m_ShowBodyStyle, SCH_RENDER_SETTINGS::m_ShowDisabled, SCH_RENDER_SETTINGS::m_ShowGraphicsDisabled, SCH_RENDER_SETTINGS::m_ShowUnit, m_symbol, TOOLS_HOLDER::m_toolManager, m_unit, TOOL_BASE::MODEL_RELOAD, EDA_DRAW_PANEL_GAL::Refresh(), and KIGFX::VIEW::UpdateAllItems().

Referenced by EE_GRAPHIC_TOOL::commitItem(), GetSymbolFromRedoList(), GetSymbolFromUndoList(), HardRedraw(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SetBodyStyle(), SetUnit(), and UpdateAfterSymbolProperties().

◆ ReCreateAuxiliaryToolbar()

virtual void EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar ( )

inlinevirtualinherited

Reimplemented in PCB_EDIT_FRAME.

Definition at line 209 of file eda_draw_frame.h.

Referenced by PCB_BASE_EDIT_FRAME::unitsChangeRefresh().

◆ ReCreateHToolbar()

virtual void EDA_DRAW_FRAME::ReCreateHToolbar ( )

inlinevirtualinherited

Definition at line 206 of file eda_draw_frame.h.

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

◆ ReCreateLeftToolbar()

virtual void EDA_DRAW_FRAME::ReCreateLeftToolbar ( )

inlinevirtualinherited

Definition at line 208 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 879 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::LoadOneLibrarySymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), GERBVIEW_FRAME::OnClearDrlFileHistory(), GERBVIEW_FRAME::OnClearGbrFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), GERBVIEW_FRAME::OnClearZipFileHistory(), FOOTPRINT_EDIT_FRAME::onPluginAvailabilityChanged(), PCB_EDIT_FRAME::onPluginAvailabilityChanged(), SCH_EDIT_FRAME::onPluginAvailabilityChanged(), SYMBOL_EDIT_FRAME::onPluginAvailabilityChanged(), 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 757 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, syncToolbarSelections(), 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(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), FOOTPRINT_EDIT_FRAME::onPluginAvailabilityChanged(), PCB_EDIT_FRAME::onPluginAvailabilityChanged(), SCH_EDIT_FRAME::onPluginAvailabilityChanged(), SYMBOL_EDIT_FRAME::onPluginAvailabilityChanged(), 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 207 of file eda_draw_frame.h.

◆ RedrawScreen()

void SCH_BASE_FRAME::RedrawScreen	(	const VECTOR2I &	aCenterPoint,
		bool	aWarpPointer )

virtualinherited

Definition at line 289 of file sch_base_frame.cpp.

References KIGFX::VIEW_CONTROLS::CenterOnCursor(), GetCanvas(), SCH_DRAW_PANEL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), EDA_DRAW_PANEL_GAL::Refresh(), and KIGFX::VIEW::SetCenter().

◆ RefreshCanvas()

void EDA_DRAW_FRAME::RefreshCanvas ( )

inlineoverridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 477 of file eda_draw_frame.h.

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

Referenced by SCH_EDIT_FRAME::OnImportProject().

◆ RefreshLibraryTree()

void SYMBOL_EDIT_FRAME::RefreshLibraryTree ( )

Redisplay the library tree.

Used after changing modified states, descriptions, etc.

Definition at line 1642 of file symbol_edit_frame.cpp.

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

Referenced by KiwayMailIn().

◆ RefreshZoomDependentItems()

void SCH_BASE_FRAME::RefreshZoomDependentItems ( )

inherited

Mark selected items for refresh.

Definition at line 426 of file sch_base_frame.cpp.

References KIGFX::SCH_PAINTER::g_ScaledSelectionTypes, GetCanvas(), KIGFX::VIEW::GetGAL(), EDA_ITEM::GetParent(), SCH_SELECTION_TOOL::GetSelection(), SCH_DRAW_PANEL::GetView(), KIGFX::GAL::GetWorldScale(), TOOLS_HOLDER::m_toolManager, KIGFX::REPAINT, SCH_SYMBOL_T, EDA_ITEM::Type(), and KIGFX::SCH_VIEW::Update().

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

References ACTION_TOOLBAR_CONTROL::GetName(), and m_toolbarControlFactories.

Referenced by CVPCB_MAINFRAME::configureToolbars(), EDA_DRAW_FRAME::configureToolbars(), FOOTPRINT_EDIT_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 596 of file eda_base_frame.cpp.

References HandleUpdateUIEvent(), m_uiUpdateHandlerBound, m_uiUpdateMap, and onUpdateUI().

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

References m_file_checker.

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

◆ RemoteSymbolPaneName()

static const wxString EDA_DRAW_FRAME::RemoteSymbolPaneName ( )

inlinestaticinherited

Definition at line 433 of file eda_draw_frame.h.

Referenced by defaultRemoteSymbolPaneInfo(), SCH_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SCH_EDIT_FRAME::setupUIConditions(), SCH_EDIT_FRAME::ShowChangedLanguage(), and SCH_EDIT_FRAME::ToggleRemoteSymbolPanel().

◆ RemoveFromScreen()

void SCH_BASE_FRAME::RemoveFromScreen	(	EDA_ITEM *	aItem,
		SCH_SCREEN *	aScreen )

overridevirtualinherited

Remove an item from the screen (and view) aScreen is the screen the item is located on, if not the current screen.

Implements SCHEMATIC_HOLDER.

Definition at line 483 of file sch_base_frame.cpp.

References GetCanvas(), GetScreen(), SCH_DRAW_PANEL::GetView(), KIGFX::VIEW::Remove(), SCH_TABLECELL_T, EDA_ITEM::Type(), and UpdateItem().

Referenced by SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_FRAME::PutDataInPreviousState(), and SCH_EDIT_FRAME::TrimWire().

◆ RenameSymbolTab()

void SYMBOL_EDIT_FRAME::RenameSymbolTab	(	const LIB_ID &	aOldId,
		const LIB_ID &	aNewId )

Update the open tab for aOldId, if any, to the renamed symbol aNewId so its label and key track the rename.

Definition at line 681 of file symbol_edit_frame_tabs.cpp.

References UTF8::empty(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), m_activeTab, m_tabsPanel, SYMBOL_EDITOR_TAB_CONTEXT::MakeTabKey(), and symbolTabContextForKey().

Referenced by GetSymbolFromRedoList(), GetSymbolFromUndoList(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), saveSymbolCopyAs(), and UpdateAfterSymbolProperties().

◆ replaceLibTableEntry()

bool SYMBOL_EDIT_FRAME::replaceLibTableEntry	(	const wxString &	aLibNickname,
		const wxString &	aLibFile )

private

Replace the file path of the symbol library table entry aLibNickname with aLibFile.

Note: The library defined by aLibFile must be a KiCad (s-expression) library.

Parameters

aLibNickname	is the nickname of an existing library table entry.
aLibFile	is the full path and file name of the symbol library to replace in the table.

Returns: true if successful or false if a failure occurs.

Definition at line 2410 of file symbol_edit_frame.cpp.

References _, PGM_BASE::GetLibraryManager(), PGM_BASE::GetLocalEnvVariables(), PROJECT::GetProjectPath(), LIBRARY_MANAGER_ADAPTER::GetRow(), GLOBAL, KICAD_MESSAGE_DIALOG, SYMBOL_LIBRARY_ADAPTER::LoadOne(), LIBRARY_ERROR::message, normalizedPath(), NormalizePath(), Pgm(), Prj(), PROJECT, LIBRARY_MANAGER::ReloadTables(), LIBRARY_TABLE_ROW::SetType(), LIBRARY_TABLE_ROW::SetURI(), SYMBOL, PROJECT_SCH::SymbolLibAdapter(), LIBRARY_MANAGER::Table(), and table.

Referenced by saveLibrary().

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

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

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

◆ ResolveItem()

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

inlinevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented in PCB_BASE_FRAME, and SCH_EDIT_FRAME.

Definition at line 440 of file eda_draw_frame.h.

Referenced by PCB_MARKER::GetMsgPanelInfo(), and SCH_MARKER::GetMsgPanelInfo().

◆ RestoreAuiLayout()

void EDA_BASE_FRAME::RestoreAuiLayout ( )

inherited

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

◆ restoreSymbolSelectionKiids()

void SYMBOL_EDIT_FRAME::restoreSymbolSelectionKiids ( const std::vector< KIID > & aKiids )

private

Reselect the items named by aKiids after a reload rebuilt the view.

Definition at line 96 of file symbol_edit_frame_tabs.cpp.

References SELECTION_TOOL::AddItemToSel(), SCH_BASE_FRAME::GetScreen(), SCH_SCREEN::Items(), and TOOLS_HOLDER::m_toolManager.

Referenced by activateSymbolTab().

◆ restoreSymbolTabsFromSettings()

void SYMBOL_EDIT_FRAME::restoreSymbolTabsFromSettings ( )

private

Recreate tabs from the persisted open-tab list once the libraries have loaded.

Definition at line 709 of file symbol_edit_frame_tabs.cpp.

References SYMBOL_EDITOR_SETTINGS::OPEN_TAB::bodyStyle, findOrCreateSymbolTab(), SYMBOL_EDITOR_TAB_CONTEXT::GetTabKey(), SYMBOL_EDITOR_SETTINGS::OPEN_TAB::lib, m_libMgr, m_loadingSymbolTab, m_settings, m_tabsPanel, SYMBOL_EDITOR_SETTINGS::OPEN_TAB::name, SYMBOL_EDITOR_SETTINGS::OPEN_TAB::preview, and SYMBOL_EDITOR_SETTINGS::OPEN_TAB::unit.

Referenced by SYMBOL_EDIT_FRAME().

◆ restoreSymbolViewSnapshot()

void SYMBOL_EDIT_FRAME::restoreSymbolViewSnapshot ( const EDITOR_TAB_CONTEXT::VIEW_SNAPSHOT & aSnapshot )

private

Restore a previously captured view zoom/center.

Definition at line 63 of file symbol_edit_frame_tabs.cpp.

References EDITOR_TAB_CONTEXT::VIEW_SNAPSHOT::center, SCH_BASE_FRAME::GetCanvas(), EDITOR_TAB_CONTEXT::VIEW_SNAPSHOT::scale, and EDITOR_TAB_CONTEXT::VIEW_SNAPSHOT::valid.

Referenced by activateSymbolTab().

◆ Revert()

void SYMBOL_EDIT_FRAME::Revert	(	LIB_ID &	aTarget,
		bool	aConfirm = true )

Revert unsaved changes in a symbol, restoring to the last saved state.

Can modify aTarget if the unsaved changes include a change in symbol name.

Definition at line 1457 of file symbol_editor.cpp.

References _, ConfirmRevertDialog(), emptyScreen(), GetCurSymbol(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ID::GetUniStringLibItemName(), IsCurrentSymbol(), LoadSymbol(), m_libMgr, m_treePane, m_unit, and UTF8::wx_str().

Referenced by RevertAll().

◆ RevertAll()

void SYMBOL_EDIT_FRAME::RevertAll ( )

Definition at line 1515 of file symbol_editor.cpp.

References GetTargetLibId(), m_libMgr, and Revert().

◆ Save()

void SYMBOL_EDIT_FRAME::Save ( )

Save the selected symbol or library.

Definition at line 406 of file symbol_editor.cpp.

References _, GetTreeLIBID(), LIB_ID::GetUniStringLibNickname(), IsLibraryTreeShown(), m_activeTab, m_libMgr, m_treePane, NEW, OKOrCancelDialog(), ORIGINAL, saveCurrentSymbol(), and saveLibrary().

Referenced by SYMBOL_EDITOR_CONTROL::Save().

◆ SaveAll()

void SYMBOL_EDIT_FRAME::SaveAll ( )

Save all modified symbols and libraries.

Definition at line 293 of file symbol_editor.cpp.

References m_treePane, and saveAllLibraries().

Referenced by SYMBOL_EDITOR_CONTROL::Save().

◆ saveAllLibraries()

bool SYMBOL_EDIT_FRAME::saveAllLibraries ( bool aRequireConfirmation )

private

Return true when the operation has succeeded (all requested libraries have been saved or none was selected and confirmed by OK).

Parameters

aRequireConfirmation when true, the user must be asked to confirm.

Definition at line 1769 of file symbol_editor.cpp.

References _, EDA_BASE_FRAME::m_infoBar, m_libMgr, NEW, OKOrCancelDialog(), ORIGINAL, saveLibrary(), and UnsavedChangesDialog().

Referenced by canCloseWindow(), and SaveAll().

◆ SaveCanvasImageToFile()

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

inherited

Save the current view as an image file.

Parameters

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

void SYMBOL_EDIT_FRAME::SaveCopyInUndoList	(	const wxString &	aDescription,
		LIB_SYMBOL *	aSymbol,
		UNDO_REDO	aUndoType = UNDO_REDO::LIBEDIT )

Create a copy of the current symbol, and save it in the undo list.

Because a symbol in library editor does not have a lot of primitives, the full data is duplicated. It is not worth to try to optimize this save function.

Definition at line 54 of file symbol_editor_undo_redo.cpp.

References PushSymbolToUndoList().

◆ saveCurrentSymbol()

bool SYMBOL_EDIT_FRAME::saveCurrentSymbol ( )

private

Save the current symbol.

Definition at line 66 of file symbol_editor.cpp.

References _, DisplayErrorMessage(), FRAME_SCH, GetCurSymbol(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibNickname(), SCH_BASE_FRAME::GetScreen(), BASE_SCREEN::IsContentModified(), IsSymbolFromSchematic(), Kiway, m_libMgr, m_schematicSymbolUUID, m_symbol, NEW, OKOrCancelDialog(), ORIGINAL, KIWAY::Player(), saveLibrary(), saveSymbolCopyAs(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), and BASE_SCREEN::SetContentModified().

Referenced by canCloseWindow(), LoadSymbol(), LoadSymbol(), promptAndCloseSymbolTab(), promptToSaveInactiveInstanceTabs(), and Save().

◆ saveLibrary()

bool SYMBOL_EDIT_FRAME::saveLibrary	(	const wxString &	aLibrary,
		SAVE_LIBRARY_AS	aSaveType = SAVE_LIBRARY_AS::ORIGINAL )

private

Save the changes to the current library.

A backup file of the current library is saved with the .bak extension before the changes made to the library are saved.

Parameters

aLibrary	is the library name.
aSaveType	is the type library save to perform.

See also: LIBRARY_SAVE_AS

Returns: True if the library was successfully saved.

Definition at line 1559 of file symbol_editor.cpp.

References _, ADD_GLOBAL_TABLE_ENTRY, ADD_PROJECT_TABLE_ENTRY, addLibTableEntry(), KIPLATFORM::UI::AllowNetworkFileSystems(), backupLibrary(), ACTIONS::cancelInteractive, ClearMsgPanel(), clearSymbolTabsModifiedForLibrary(), DisplayErrorMessage(), fileType(), FreezeLibraryTree(), LIBRARY_MANAGER::GetFullURI(), SYMBOL_LIBRARY_SAVE_AS_FILEDLG_HOOK::GetOption(), LIBRARY_MANAGER_ADAPTER::GetRow(), PROJECT::GetRString(), getTargetLib(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), LIBRARY_MANAGER_ADAPTER::HasLibrary(), FILEEXT::KiCadSymbolLibFileExtension, FILEEXT::KiCadSymbolLibFileWildcard(), SEARCH_STACK::LastVisitedPath(), m_libMgr, TOOLS_HOLDER::m_toolManager, NORMAL_SAVE_AS, ORIGINAL, PACKED, Prj(), PROJECT, RebuildSymbolUnitAndBodyStyleLists(), REPLACE_TABLE_ENTRY, replaceLibTableEntry(), PROJECT::SCH_LIB_PATH, PROJECT_SCH::SchSearchS(), PROJECT::SetRString(), SCH_BASE_FRAME::SetSymModificationTime(), EDA_BASE_FRAME::ShowInfoBarError(), PROJECT_SCH::SymbolLibAdapter(), SyncLibraries(), ThawLibraryTree(), KIPLATFORM::IO::TimestampDir(), and UNPACKED.

Referenced by Save(), saveAllLibraries(), saveCurrentSymbol(), SaveLibraryAs(), and SaveLibraryHeadless().

◆ SaveLibraryAs()

void SYMBOL_EDIT_FRAME::SaveLibraryAs ( SAVE_LIBRARY_AS aSaveType = SAVE_LIBRARY_AS::NEW )

Save the currently selected library to a new file.

Definition at line 443 of file symbol_editor.cpp.

References LIB_ID::GetLibNickname(), GetTargetLibId(), m_treePane, and saveLibrary().

Referenced by SYMBOL_EDITOR_CONTROL::Save(), and updateInfoBar().

◆ SaveLibraryHeadless()

bool SYMBOL_EDIT_FRAME::SaveLibraryHeadless ( const wxString & aLibrary )

Save the given library (including buffered changes) without user interaction.

Used by the API handler; returns false if the library is read-only or the save fails.

Definition at line 1763 of file symbol_editor.cpp.

References ORIGINAL, and saveLibrary().

◆ SaveProjectLocalSettings()

virtual void EDA_BASE_FRAME::SaveProjectLocalSettings ( )

inlinevirtualinherited

Save changes to the project local settings.

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

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

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 385 of file eda_base_frame.h.

◆ saveProjectSettings()

virtual void EDA_BASE_FRAME::saveProjectSettings ( )

inlineprotectedvirtualinherited

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 in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 751 of file eda_base_frame.h.

◆ SaveSettings()

void SYMBOL_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 SCH_BASE_FRAME.

Definition at line 461 of file symbol_edit_frame.cpp.

References EDA_DRAW_FRAME::GetGalDisplayOptions(), GetLibTree(), SCH_BASE_FRAME::GetRenderSettings(), GetSettings(), LIB_TREE::GetSortMode(), TOOLS_HOLDER::GetToolManager(), EDA_BASE_FRAME::m_auimgr, KIGFX::GAL_DISPLAY_OPTIONS::m_axesEnabled, m_libTreeAutoHiddenForSchematicEdit, EDA_DRAW_FRAME::m_propertiesPanel, m_settings, SCH_RENDER_SETTINGS::m_ShowHiddenFields, SCH_RENDER_SETTINGS::m_ShowHiddenPins, SCH_RENDER_SETTINGS::m_ShowPinAltIcons, SCH_RENDER_SETTINGS::m_ShowPinsElectricalType, m_treePane, EDA_DRAW_FRAME::PropertiesPaneName(), SCH_BASE_FRAME::SaveSettings(), storeSymbolTabsToSettings(), and updateSelectionFilterVisbility().

◆ SaveSymbolCopyAs()

void SYMBOL_EDIT_FRAME::SaveSymbolCopyAs ( bool aOpenCopy )

Save the currently selected symbol to a new name and/or location.

Definition at line 455 of file symbol_editor.cpp.

References m_treePane, and saveSymbolCopyAs().

Referenced by SYMBOL_EDITOR_CONTROL::Save(), and updateInfoBar().

◆ saveSymbolCopyAs()

void SYMBOL_EDIT_FRAME::saveSymbolCopyAs ( bool aOpenCopy )

private

If we save over a symbol that is in the inheritance chain of the symbol we're saving, we'll end up with a circular inheritance chain, which is bad.

Definition at line 884 of file symbol_editor.cpp.

References _, AddLibraryFile(), CheckForParentalChainConflicts(), CheckSavingIntoOwnInheritance(), SYMBOL_SAVE_AS_HANDLER::DoSave(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), GetParentChain(), SCH_BASE_FRAME::GetScreen(), getTargetSymbol(), SCH_FIELD::GetText(), LIB_SYMBOL::GetValueField(), ID_MAKE_NEW_LIBRARY, ID_OVERWRITE_CONFLICTS, ID_RENAME_CONFLICTS, LIB_SYMBOL::IsDerived(), LoadSymbol(), m_activeTab, m_libMgr, m_symbol, m_tabsPanel, SYMBOL_SAVE_AS_HANDLER::OVERWRITE, RenameSymbolTab(), BASE_SCREEN::SetContentModified(), LIB_SYMBOL::SetLibId(), DIALOG_SHIM::ShowModal(), KIDIALOG::ShowModal(), SyncLibraries(), and UnescapeString().

Referenced by saveCurrentSymbol(), and SaveSymbolCopyAs().

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

◆ SelectLibrary()

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

inherited

Display a list of loaded libraries and allows the user to select a library.

Parameters

aDialogTitle	title for the dialog window
aListLabel	label over 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 nickname used in the symbol library table.

Definition at line 711 of file sch_base_frame.cpp.

References _, EDA_LIST_DIALOG::AddExtraCheckbox(), SYMBOL_LIBRARY_MANAGER::CreateLibrary(), DisplayError(), EDA_LIST_DIALOG::GetExtraCheckboxValues(), GetLibraryItemsForListDialog(), PROJECT::GetRString(), EDA_LIST_DIALOG::GetTextSelection(), FILEDLG_HOOK_NEW_LIBRARY::GetUseGlobalTable(), GLOBAL, LIBRARY_MANAGER_ADAPTER::HasLibrary(), ID_MAKE_NEW_LIBRARY, FILEEXT::KiCadSymbolLibFileExtension, FILEEXT::KiCadSymbolLibFileWildcard(), EDA_DRAW_FRAME::LibraryFileBrowser(), EDA_LIST_DIALOG_BASE::m_ButtonsSizer, KIWAY_HOLDER::Prj(), PROJECT, PROJECT::SCH_LIB_PATH, PROJECT::SCH_LIB_SELECT, EDA_LIST_DIALOG::SetListLabel(), PROJECT::SetRString(), DIALOG_SHIM::ShowModal(), and PROJECT_SCH::SymbolLibAdapter().

Referenced by SYMBOL_EDIT_FRAME::ImportSymbol().

◆ SelectToolbarAction()

void EDA_BASE_FRAME::SelectToolbarAction ( const TOOL_ACTION & aAction )

overridevirtualinherited

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

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

Reimplemented from TOOLS_HOLDER.

Definition at line 741 of file eda_base_frame.cpp.

References m_tbLeft, m_tbRight, m_tbTopAux, and m_tbTopMain.

Referenced by BOARD_EDITOR_CONTROL::OnAngleSnapModeChanged(), FOOTPRINT_EDITOR_CONTROL::OnAngleSnapModeChanged(), EDA_DRAW_FRAME::syncToolbarSelections(), and EDA_DRAW_FRAME::unitsChangeRefresh().

◆ setArcModeConditions()

void EDA_DRAW_FRAME::setArcModeConditions	(	const TOOL_ACTION &	aDrawArc,
		const std::function< bool(const SELECTION &)> &	aEnable )

protectedinherited

Check each arc mode's tool action while the arc tool runs in that mode.

Parameters

aDrawArc	is the arc tool action without a mode; its name must begin every arc tool action's name.
aEnable	enables the arc tool actions.

Definition at line 1298 of file eda_draw_frame.cpp.

References CENTER_START_END, EDA_BASE_FRAME::config(), TOOLS_HOLDER::CurrentToolName(), drawArcAction(), TOOL_ACTION::GetName(), IncrementArcDrawMode(), APP_SETTINGS_BASE::m_ArcDrawMode, TOOLS_HOLDER::m_toolManager, and ACTION_MANAGER::SetConditions().

Referenced by FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), and SYMBOL_EDIT_FRAME::setupUIConditions().

◆ SetBodyStyle()

void SYMBOL_EDIT_FRAME::SetBodyStyle ( int aBodyStyle )

Definition at line 1303 of file symbol_edit_frame.cpp.

References ACTIONS::cancelInteractive, GetCurSymbol(), m_bodyStyle, m_bodyStyleSelectBox, TOOLS_HOLDER::m_toolManager, TOOL_BASE::MODEL_RELOAD, RebuildView(), ACTIONS::selectionClear, and UpdateSymbolMsgPanelInfo().

Referenced by FocusOnItem(), and OnSelectBodyStyle().

◆ SetCanvas()

void EDA_DRAW_FRAME::SetCanvas ( EDA_DRAW_PANEL_GAL * aPanel )

inlineinherited

Definition at line 466 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(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), and PL_EDITOR_FRAME::PL_EDITOR_FRAME().

◆ SetCurSymbol()

void SYMBOL_EDIT_FRAME::SetCurSymbol	(	LIB_SYMBOL *	aSymbol,
		bool	aUpdateZoom )

Take ownership of aSymbol and notes that it is the one currently being edited.

Definition at line 1204 of file symbol_edit_frame.cpp.

References KIGFX::VIEW::Clear(), KIGFX::SCH_VIEW::ClearHiddenFlags(), SCH_DRAW_PANEL::DisplaySymbol(), SCH_BASE_FRAME::GetCanvas(), GetLibTree(), SCH_BASE_FRAME::GetRenderSettings(), SCH_BASE_FRAME::GetScreen(), SCH_DRAW_PANEL::GetView(), KIGFX::SCH_VIEW::HideDrawingSheet(), IsSymbolAlias(), IsSymbolFromLegacyLibrary(), IsSymbolFromSchematic(), m_activeTab, m_bodyStyle, EDA_DRAW_FRAME::m_propertiesPanel, SCH_RENDER_SETTINGS::m_ShowBodyStyle, SCH_RENDER_SETTINGS::m_ShowDisabled, SCH_RENDER_SETTINGS::m_ShowGraphicsDisabled, SCH_RENDER_SETTINGS::m_ShowUnit, m_symbol, TOOLS_HOLDER::m_toolManager, m_unit, TOOL_BASE::MODEL_RELOAD, EDA_DRAW_PANEL_GAL::Refresh(), ACTIONS::selectionClear, LIB_TREE::SelectLibId(), LIB_TREE::Unselect(), updateInfoBar(), and ACTIONS::zoomFitScreen.

Referenced by CanCloseSymbolFromSchematic(), emptyScreen(), KiwayMailIn(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), and SCH_COMMIT::revertLibEdit().

◆ SetDrawBgColor()

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

inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME.

Definition at line 171 of file eda_draw_frame.h.

References m_drawBgColor.

Referenced by PL_EDITOR_FRAME::LoadSettings(), and GERBVIEW_FRAME::SetVisibleElementColor().

◆ SetDrawSpecificBodyStyle()

void SYMBOL_EDIT_FRAME::SetDrawSpecificBodyStyle ( bool aSpecific )

inline

Definition at line 313 of file symbol_edit_frame.h.

References m_drawSpecificBodyStyle.

◆ SetDrawSpecificUnit()

void SYMBOL_EDIT_FRAME::SetDrawSpecificUnit ( bool aSpecific )

inline

Definition at line 310 of file symbol_edit_frame.h.

References m_drawSpecificUnit.

Referenced by LoadSymbol(), and LoadSymbolFromSchematic().

◆ SetGridColor()

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

inlinevirtualinherited

Reimplemented in GERBVIEW_FRAME, and PCB_EDIT_FRAME.

Definition at line 223 of file eda_draw_frame.h.

References m_gridColor.

◆ SetGridOrigin()

void SCH_BASE_FRAME::SetGridOrigin ( const VECTOR2I & aPoint )

inlineoverridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 152 of file sch_base_frame.h.

◆ SetGridOverrides()

void EDA_DRAW_FRAME::SetGridOverrides ( bool aOverride )

virtualinherited

Definition at line 560 of file eda_draw_frame.cpp.

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

◆ SetGridVisibility()

void EDA_DRAW_FRAME::SetGridVisibility ( bool aVisible )

virtualinherited

Reimplemented in GERBVIEW_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 530 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::config(), GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_PANEL_GAL::GetView(), EDA_BASE_FRAME::GetWindowSettings(), WINDOW_SETTINGS::grid, KIGFX::VIEW::MarkTargetDirty(), EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::GAL::SetGridVisibility(), GRID_SETTINGS::show, and KIGFX::TARGET_NONCACHED.

Referenced by GERBVIEW_FRAME::SetGridVisibility(), and PCB_BASE_EDIT_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 39 of file kiway_holder.cpp.

References ignore_unused(), m_kiway, and name.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), InvokePcbLibTableEditor(), and InvokeSchEditSymbolLibTable().

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool aIsModal )

inlineinherited

Definition at line 144 of file kiway_player.h.

References m_modal.

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

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString & aPath )

inlineinherited

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

References EDA_BASE_FRAME::m_isClosing, and m_messagePanel.

Referenced by SCH_EDIT_FRAME::ChangeSheetFile(), PCB_BASE_FRAME::CreateNewFootprint(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::HandleRemoteNetHighlight(), 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::onVariantSelected(), 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 899 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 909 of file eda_draw_frame.cpp.

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

◆ SetOpenGLFailureOccurred()

static void EDA_DRAW_FRAME::SetOpenGLFailureOccurred ( )

inlinestaticinherited

Keep every frame on the fallback canvas for this session without changing the saved preference.

Definition at line 458 of file eda_draw_frame.h.

References m_openGLFailureOccured.

Referenced by EDA_DRAW_PANEL_GAL::handleContextLoss(), EDA_DRAW_PANEL_GAL::recoverFromGalError(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

◆ SetPageSettings()

void SCH_BASE_FRAME::SetPageSettings ( const PAGE_INFO & aPageSettings )

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 217 of file sch_base_frame.cpp.

References GetScreen(), and SCH_SCREEN::SetPageSettings().

◆ SetScreen()

void SYMBOL_EDIT_FRAME::SetScreen ( BASE_SCREEN * aScreen )

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1876 of file symbol_edit_frame.cpp.

References SCH_BASE_FRAME::GetCanvas(), GetSettings(), TOOLS_HOLDER::m_toolManager, TOOL_BASE::MODEL_RELOAD, and EDA_DRAW_FRAME::SetScreen().

Referenced by activateSymbolTab(), closeAllSymbolTabsSilently(), emptyScreen(), promptAndCloseSymbolTab(), SYMBOL_EDIT_FRAME(), and ~SYMBOL_EDIT_FRAME().

◆ SetShowPolarCoords()

void EDA_DRAW_FRAME::SetShowPolarCoords ( bool aShow )

inlineinherited

Definition at line 123 of file eda_draw_frame.h.

References m_polarCoords.

◆ SetSymModificationTime()

void SCH_BASE_FRAME::SetSymModificationTime ( long long aTimestamp )

inlineinherited

Set the modification timestamp of the watched symbol library.

For single-file libraries this is the file modification time. For directory-based libraries (.kicad_symdir) this is a hash of modification times from KIPLATFORM::IO::TimestampDir().

Definition at line 287 of file sch_base_frame.h.

References m_watcherTimestamp.

Referenced by SYMBOL_EDIT_FRAME::saveLibrary().

◆ setSymWatcher()

void SCH_BASE_FRAME::setSymWatcher ( const LIB_ID * aSymbol )

protectedinherited

Creates (or removes) a watcher on the specified symbol library.

Parameters

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

Definition at line 803 of file sch_base_frame.cpp.

References UTF8::c_str(), ExpandEnvVarSubstitutions(), LIBRARY_MANAGER::GetFullURI(), LIB_ID::GetLibNickname(), PGM_BASE::GetLibraryManager(), KIPLATFORM::ENV::IsNetworkPath(), FILEEXT::KiCadSymbolLibFileExtension, m_watcher, m_watcherFileName, m_watcherIsDir, m_watcherTimestamp, OnSymChange(), Pgm(), KIWAY_HOLDER::Prj(), SYMBOL, KIPLATFORM::IO::TimestampDir(), and traceLibWatch.

Referenced by SYMBOL_EDIT_FRAME::LoadOneLibrarySymbol(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), and SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME().

◆ SetTitleBlock()

void SCH_BASE_FRAME::SetTitleBlock ( const TITLE_BLOCK & aTitleBlock )

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 243 of file sch_base_frame.cpp.

References GetScreen(), and SCH_SCREEN::SetTitleBlock().

◆ SetUnit()

void SYMBOL_EDIT_FRAME::SetUnit ( int aUnit )

Definition at line 1282 of file symbol_edit_frame.cpp.

References ACTIONS::cancelInteractive, GetCurSymbol(), TOOLS_HOLDER::m_toolManager, m_unit, m_unitSelectBox, TOOL_BASE::MODEL_RELOAD, RebuildView(), ACTIONS::selectionClear, and UpdateSymbolMsgPanelInfo().

Referenced by SYMBOL_EDITOR_CONTROL::ChangeUnit(), FocusOnItem(), and OnSelectUnit().

◆ setupTools()

void SYMBOL_EDIT_FRAME::setupTools ( )

private

Definition at line 535 of file symbol_edit_frame.cpp.

References SCH_BASE_FRAME::GetCanvas(), SCH_BASE_FRAME::GetScreen(), GetSettings(), TOOLS_HOLDER::m_actions, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, and EDA_DRAW_PANEL_GAL::SetEventDispatcher().

Referenced by SYMBOL_EDIT_FRAME().

◆ setupUIConditions()

void SYMBOL_EDIT_FRAME::setupUIConditions ( )

overrideprotectedvirtual

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 571 of file symbol_edit_frame.cpp.

References EDITOR_CONDITIONS::BoundingBoxes(), CHECK, ACTIONS::copy, ACTIONS::copyAsText, EDITOR_CONDITIONS::CurrentTool(), ACTIONS::cut, SCH_ACTIONS::cycleBodyStyle, ACTIONS::deleteTool, ACTIONS::doDelete, SCH_ACTIONS::drawArc, SCH_ACTIONS::drawBezier, SCH_ACTIONS::drawCircle, SCH_ACTIONS::drawEllipse, SCH_ACTIONS::drawEllipseArc, SCH_ACTIONS::drawRectangle, SCH_ACTIONS::drawSymbolLines, SCH_ACTIONS::drawSymbolPolygon, SCH_ACTIONS::drawSymbolTextBox, ACTIONS::duplicate, EDIT_TOOL, SCH_ACTIONS::editLibSymbolWithLibEdit, SCH_ACTIONS::editSymbolPinMaps, UTF8::empty(), ENABLE, LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), GetTargetLibId(), getTargetSymbol(), EDITOR_CONDITIONS::GridOverrides(), EDITOR_CONDITIONS::GridVisible(), SELECTION_CONDITIONS::Idle(), SCH_ACTIONS::importGraphics, SCH_ACTIONS::importSymbol, IsLibraryTreeShown(), IsSymbolEditable(), IsSymbolFromLegacyLibrary(), IsSymbolFromSchematic(), IsSymbolGraphicallyEditable(), SCH_BASE_FRAME::libeditconfig(), EDA_BASE_FRAME::m_auimgr, m_libMgr, SYMBOL_EDITOR_SETTINGS::m_ShowHiddenFields, SYMBOL_EDITOR_SETTINGS::m_ShowHiddenPins, SYMBOL_EDITOR_SETTINGS::m_ShowPinAltIcons, SYMBOL_EDITOR_SETTINGS::m_ShowPinElectricalType, m_symbol, TOOLS_HOLDER::m_toolManager, SCH_ACTIONS::mirrorH, SCH_ACTIONS::mirrorV, SCH_ACTIONS::newSymbol, EDITOR_CONDITIONS::NoActiveTool(), SELECTION_CONDITIONS::NotEmpty(), ACTIONS::paste, SCH_ACTIONS::pinTable, SCH_ACTIONS::placeSymbolAnchor, SCH_ACTIONS::placeSymbolPin, SCH_ACTIONS::placeSymbolText, EDA_DRAW_FRAME::PropertiesPaneName(), ACTIONS::redo, EDITOR_CONDITIONS::RedoAvailable(), ACTIONS::revert, SCH_ACTIONS::rotateCCW, SCH_ACTIONS::rotateCW, SCH_ACTIONS::runERC, ACTIONS::save, ACTIONS::saveAll, SCH_ACTIONS::saveLibraryAs, SCH_ACTIONS::saveSymbolAs, SCH_ACTIONS::saveSymbolCopyAs, ACTIONS::selectAll, ACTIONS::selectionTool, EDA_DRAW_FRAME::setArcModeConditions(), ACTION_MANAGER::SetConditions(), EDA_BASE_FRAME::setupUIConditions(), SELECTION_CONDITIONS::ShowAlways(), ACTIONS::showDatasheet, SCH_ACTIONS::showElectricalTypes, SCH_ACTIONS::showHiddenFields, SCH_ACTIONS::showHiddenPins, ACTIONS::showLibraryTree, ACTIONS::showProperties, SCH_ACTIONS::symbolProperties, SynchronizePins(), ACTIONS::toggleBoundingBoxes, ACTIONS::toggleGrid, ACTIONS::toggleGridOverrides, SCH_ACTIONS::togglePinAltIcons, SCH_ACTIONS::toggleSyncedPinsMode, ACTIONS::undo, EDITOR_CONDITIONS::UndoAvailable(), ACTIONS::unselectAll, SCH_ACTIONS::updateSymbolFields, and ACTIONS::zoomTool.

Referenced by SYMBOL_EDIT_FRAME().

◆ setupUnits()

void EDA_DRAW_FRAME::setupUnits ( APP_SETTINGS_BASE * aCfg )

protectedinherited

◆ SetUserUnits()

void UNITS_PROVIDER::SetUserUnits ( EDA_UNITS aUnits )

inlineinherited

Definition at line 42 of file units_provider.h.

References m_userUnits.

Referenced by EDA_BASE_FRAME::ChangeUserUnits(), PGE::IFACE::CreateKiWindow(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), EDA_DRAW_FRAME::LoadSettings(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), DRC_ENGINE::RunTests(), DRC_TEST_PROVIDER::RunTests(), and EDA_DRAW_FRAME::ToggleUserUnits().

◆ ShowChangedLanguage()

void SYMBOL_EDIT_FRAME::ShowChangedLanguage ( )

overridevirtual

Redraw the menus and what not in current language.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1845 of file symbol_edit_frame.cpp.

References _, KIGFX::ALL, SCH_BASE_FRAME::GetCanvas(), GetLibTree(), SCH_BASE_FRAME::GetRenderSettings(), SCH_DRAW_PANEL::GetView(), EDA_BASE_FRAME::m_auimgr, m_treePane, EDA_BASE_FRAME::RecreateToolbars(), EDA_DRAW_PANEL_GAL::Refresh(), EDA_BASE_FRAME::ShowChangedLanguage(), LIB_TREE::ShowChangedLanguage(), KIGFX::VIEW::UpdateAllItems(), UpdateMsgPanel(), and UpdateTitle().

◆ ShowFindReplaceDialog()

void SCH_BASE_FRAME::ShowFindReplaceDialog ( bool aReplace )

inherited

Run the Find or Find & Replace dialog.

Definition at line 517 of file sch_base_frame.cpp.

References SELECTION::Front(), SCH_SYMBOL::GetField(), SCH_FIND_REPLACE_TOOL::GetLastFoundItem(), SCH_FIELD::GetText(), EDA_DRAW_FRAME::m_findReplaceData, m_findReplaceDialog, EDA_DRAW_FRAME::m_findStringHistoryList, EDA_DRAW_FRAME::m_replaceStringHistoryList, TOOLS_HOLDER::m_toolManager, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_SHEET_PIN_T, SCH_SYMBOL_T, SCH_TEXT_T, SELECTION::Size(), EDA_ITEM::Type(), UnescapeString(), and VALUE.

◆ ShowFindReplaceStatus()

void SCH_BASE_FRAME::ShowFindReplaceStatus	(	const wxString &	aMsg,
		int	aStatusTime )

inherited

Definition at line 573 of file sch_base_frame.cpp.

References EDA_BASE_FRAME::m_infoBar.

◆ 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 1407 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,
		INFOBAR_MESSAGE_TYPE	aType = 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.
aType	is the type of infobar message to show.

Definition at line 1393 of file eda_base_frame.cpp.

References GetInfoBar(), m_infoBar, and WX_INFOBAR::ShowMessageFor().

Referenced by PCB_CONTROL::AppendDesignBlock(), SYMBOL_EDITOR_CONTROL::CompareLibraryWithFile(), SCH_INSPECTION_TOOL::CompareSchematicWithFile(), SCH_INSPECTION_TOOL::CompareSchematicWithHistory(), 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(), SCH_EDIT_FRAME::RecalculateConnections(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SYMBOL_EDIT_FRAME::saveLibrary(), SCH_INSPECTION_TOOL::showSchematicComparison(), and ValidateNetSwapLocks().

◆ 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

aMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 1437 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

aWarningMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 1424 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 97 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::CreateFootprintFromWizard(), SelectFootprintFromChooser(), FOOTPRINT_CHOOSER_FRAME::ShowModal(), and SYMBOL_CHOOSER_FRAME::ShowModal().

◆ ShowPreferences()

void EDA_BASE_FRAME::ShowPreferences	(	const wxString &	aStartPage,
		const wxString &	aStartParentPage )

inherited

Display the preferences and settings of all opened editors paged dialog, starting with a particular page.

Definition at line 1536 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(), 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_SNAPPING, 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_SNAPPING, PANEL_FP_TOOLBARS, PANEL_GBR_COLORS, PANEL_GBR_DISPLAY_OPTIONS, PANEL_GBR_EXCELLON_OPTIONS, PANEL_GBR_GRIDS, PANEL_GBR_SNAPPING, 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_SNAPPING, 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_SNAPPING, PANEL_SCH_TOOLBARS, PANEL_SYM_COLORS, PANEL_SYM_DISP_OPTIONS, PANEL_SYM_EDIT_GRIDS, PANEL_SYM_EDIT_OPTIONS, PANEL_SYM_SNAPPING, PANEL_SYM_TOOLBARS, Pgm(), ReadHotKeyConfigIntoActions(), TOOL_BASE::REDRAW, SETTINGS_MANAGER::Save(), PAGED_DIALOG::SetInitialPage(), and DIALOG_SHIM::ShowModal().

Referenced by OnPreferences().

◆ storeSymbolTabsToSettings()

void SYMBOL_EDIT_FRAME::storeSymbolTabsToSettings ( )

private

Write the current tab set into the editor settings for the next session.

Definition at line 753 of file symbol_edit_frame_tabs.cpp.

References SYMBOL_EDITOR_SETTINGS::OPEN_TAB::bodyStyle, SYMBOL_EDITOR_SETTINGS::OPEN_TAB::lib, m_activeTab, m_settings, m_tabContexts, m_tabsPanel, SYMBOL_EDITOR_SETTINGS::OPEN_TAB::name, SYMBOL_EDITOR_SETTINGS::OPEN_TAB::preview, and SYMBOL_EDITOR_SETTINGS::OPEN_TAB::unit.

Referenced by SaveSettings().

◆ 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 96 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 110 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 75 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(), DRC_TEST_PROVIDER::formatMsg(), WX_GRID::onCellEditorHidden(), reportMax(), reportMin(), reportOpt(), PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow(), and UpdateDrillCells().

◆ SVGPlotSymbol()

void SYMBOL_EDIT_FRAME::SVGPlotSymbol ( const wxString & aFullFileName )

Create the SVG print file for the current edited symbol.

Parameters

aFullFileName is the full filename

Definition at line 25 of file symbol_editor_plotter.cpp.

References GetBodyStyle(), GetColorSettings(), SCH_BASE_FRAME::GetRenderSettings(), GetSymbolPlotBBox(), GetUnit(), SCH_RENDER_SETTINGS::LoadColors(), m_symbol, PlotSymbolToSVG(), and KIGFX::RENDER_SETTINGS::SetDefaultPenWidth().

Referenced by SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG().

◆ SwitchCanvas()

void SYMBOL_EDIT_FRAME::SwitchCanvas ( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType )

overridevirtual

Switch currently used canvas ( Cairo / OpenGL).

Reimplemented from EDA_DRAW_FRAME.

Definition at line 2150 of file symbol_edit_frame.cpp.

References SCH_BASE_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), LAYER_SCHEMATIC_GRID_AXES, EDA_DRAW_FRAME::m_colorSettings, KIGFX::GAL::SetAxesColor(), KIGFX::GAL::SetAxesEnabled(), and EDA_DRAW_FRAME::SwitchCanvas().

◆ symbolTabContextForIndex()

SYMBOL_EDITOR_TAB_CONTEXT * SYMBOL_EDIT_FRAME::symbolTabContextForIndex ( int aIdx ) const

private

Resolve the tab context for a panel tab index, or nullptr.

The panel owns tab order, so the index maps through the panel's key, not into m_tabContexts directly.

Definition at line 365 of file symbol_edit_frame_tabs.cpp.

References m_tabsPanel, and symbolTabContextForKey().

Referenced by promptAndCloseSymbolTab(), and SYMBOL_EDIT_FRAME().

◆ symbolTabContextForKey()

SYMBOL_EDITOR_TAB_CONTEXT * SYMBOL_EDIT_FRAME::symbolTabContextForKey ( const wxString & aKey ) const

private

Resolve the tab context for a tab key, or nullptr.

Definition at line 334 of file symbol_edit_frame_tabs.cpp.

References m_tabContexts.

Referenced by dropSymbolTabContext(), findOrCreateSymbolInstanceTab(), findOrCreateSymbolTab(), RenameSymbolTab(), and symbolTabContextForIndex().

◆ SynchronizePins()

bool SYMBOL_EDIT_FRAME::SynchronizePins ( )

Definition at line 1325 of file symbol_edit_frame.cpp.

References m_settings, and m_symbol.

Referenced by setupUIConditions().

◆ SyncLibraries()

void SYMBOL_EDIT_FRAME::SyncLibraries	(	bool	aShowProgress,
		bool	aPreloadCancelled = false,
		const wxString &	aForceRefresh = wxEmptyString )

Synchronize the library manager to the symbol library table, and then the symbol tree to the library manager.

Optionally displays a progress dialog.

Definition at line 1537 of file symbol_edit_frame.cpp.

References _, LIBRARY_MANAGER_ADAPTER::BlockUntilLoaded(), LIB_TREE::ExpandLibId(), LIB_TREE::GetExpandedLibraries(), GetLibTree(), LIB_TREE::GetSelectedLibId(), LIB_ID::IsValid(), m_libMgr, m_syncLibrariesInProgress, m_treePane, Prj(), THROTTLE::Ready(), LIB_TREE::Regenerate(), LIB_TREE::SelectLibId(), LIB_ID::SetLibItemName(), PROJECT_SCH::SymbolLibAdapter(), LIB_TREE::Unselect(), and APP_PROGRESS_DIALOG::Update().

Referenced by AddLibraryFile(), CommonSettingsChanged(), CreateNewSymbol(), DuplicateSymbol(), ExportSymbol(), HardRedraw(), ImportSymbol(), KiwayMailIn(), saveLibrary(), saveSymbolCopyAs(), and SYMBOL_EDIT_FRAME().

◆ syncToolbarSelections()

void EDA_DRAW_FRAME::syncToolbarSelections ( )

overrideprotectedvirtualinherited

Called after the toolbars are rebuilt so a frame can select the group entries that reflect its saved state.

Reimplemented from EDA_BASE_FRAME.

Definition at line 1331 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::config(), drawArcAction(), APP_SETTINGS_BASE::m_ArcDrawMode, and EDA_BASE_FRAME::SelectToolbarAction().

◆ SyncView()

void SCH_BASE_FRAME::SyncView ( )

inherited

Mark all items for refresh.

Definition at line 501 of file sch_base_frame.cpp.

References KIGFX::ALL, GetCanvas(), SCH_DRAW_PANEL::GetView(), TOOLS_HOLDER::m_toolManager, TOOL_BASE::MODEL_RELOAD, and KIGFX::VIEW::UpdateAllItems().

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDIT_FRAME::importFile(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

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

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

◆ ThawLibraryTree()

void SYMBOL_EDIT_FRAME::ThawLibraryTree ( )

Definition at line 1029 of file symbol_edit_frame.cpp.

References m_libMgr, and m_treePane.

Referenced by KiwayMailIn(), and saveLibrary().

◆ ThemeChanged()

void EDA_BASE_FRAME::ThemeChanged ( )

virtualinherited

Process light/dark theme change.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 997 of file eda_base_frame.cpp.

References ClearScaledBitmapCache(), and m_auimgr.

Referenced by CommonSettingsChanged(), HandleSystemColorChange(), and PCB_EDIT_FRAME::ThemeChanged().

◆ ToggleLibraryTree()

void SYMBOL_EDIT_FRAME::ToggleLibraryTree ( )

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 996 of file symbol_edit_frame.cpp.

References IsLibraryTreeShown(), EDA_BASE_FRAME::m_auimgr, m_libTreeAutoHiddenForSchematicEdit, m_treePane, and updateSelectionFilterVisbility().

Referenced by SYMBOL_EDITOR_CONTROL::EditLibrarySymbol(), and SCH_EDITOR_CONTROL::EditWithSymbolEditor().

◆ ToggleProperties()

void SYMBOL_EDIT_FRAME::ToggleProperties ( )

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 975 of file symbol_edit_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_propertiesPanel, m_settings, EDA_DRAW_FRAME::PropertiesPaneName(), SetAuiPaneSize(), and updateSelectionFilterVisbility().

◆ ToggleUserUnits()

void EDA_DRAW_FRAME::ToggleUserUnits ( )

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 310 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 120 of file tools_holder.h.

References m_toolStack.

Referenced by PCB_SELECTION_TOOL::Init(), PCB_VIEWER_TOOLS::Init(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDITOR_CONDITIONS::noToolFunc(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), and SCH_BASE_FRAME::OnSymChangeDebounceTimer().

◆ unitsChangeRefresh()

void EDA_DRAW_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 EDA_BASE_FRAME.

Reimplemented in GERBVIEW_FRAME, PCB_BASE_EDIT_FRAME, PCB_BASE_FRAME, and SCH_EDIT_FRAME.

Definition at line 290 of file eda_draw_frame.cpp.

References UNITS_PROVIDER::GetUserUnits(), INCH, ACTIONS::inchesUnits, TOOLS_HOLDER::m_toolManager, ACTIONS::millimetersUnits, MILS, ACTIONS::milsUnits, MM, EDA_BASE_FRAME::SelectToolbarAction(), UpdateMsgPanel(), UpdateProperties(), UpdateStatusBar(), and ACTIONS::updateUnits.

Referenced by ToggleUserUnits(), GERBVIEW_FRAME::unitsChangeRefresh(), PCB_BASE_FRAME::unitsChangeRefresh(), and SCH_EDIT_FRAME::unitsChangeRefresh().

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

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

Referenced by UnregisterUIUpdateHandler().

◆ UpdateAfterSymbolProperties()

void SYMBOL_EDIT_FRAME::UpdateAfterSymbolProperties ( wxString * aOldName = nullptr )

Definition at line 1227 of file symbol_editor.cpp.

References _, DisplayErrorMessage(), IsSymbolFromSchematic(), m_libMgr, m_symbol, m_treePane, OnModify(), RebuildSymbolUnitAndBodyStyleLists(), RebuildView(), RenameSymbolTab(), UnescapeString(), UpdateLibraryTree(), and UpdateMsgPanel().

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

References _, GRID_MENU::BuildChoiceList(), EDA_BASE_FRAME::config(), DisplayUnitsMsg(), EDA_BASE_FRAME::GetWindowSettings(), grid, m_gridSelectBox, and UpdateStatusBar().

Referenced by CommonSettingsChanged(), configureToolbars(), GERBVIEW_FRAME::unitsChangeRefresh(), and PCB_BASE_FRAME::unitsChangeRefresh().

◆ updateInfoBar()

void SYMBOL_EDIT_FRAME::updateInfoBar ( )

private

◆ UpdateItem()

void SYMBOL_EDIT_FRAME::UpdateItem	(	EDA_ITEM *	aItem,
		bool	isAddOrDelete = false,
		bool	aUpdateRtree = false )

overridevirtual

Mark an item for refresh.

Reimplemented from SCH_BASE_FRAME.

Definition at line 2499 of file symbol_edit_frame.cpp.

References SCH_BASE_FRAME::UpdateItem().

Referenced by FocusOnItem().

◆ UpdateLibraryTree()

void SYMBOL_EDIT_FRAME::UpdateLibraryTree	(	const wxDataViewItem &	aTreeItem,
		LIB_SYMBOL *	aSymbol )

Update a symbol node in the library tree.

Definition at line 1654 of file symbol_edit_frame.cpp.

References GetLibTree(), LIB_TREE::RefreshLibTree(), and LIB_TREE_NODE_ITEM::Update().

Referenced by SYMBOL_EDITOR_CONTROL::FlattenSymbol(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), and UpdateAfterSymbolProperties().

◆ UpdateMsgPanel()

void SYMBOL_EDIT_FRAME::UpdateMsgPanel ( )

inlineoverridevirtual

Redraw the message panel.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 324 of file symbol_edit_frame.h.

References UpdateSymbolMsgPanelInfo().

Referenced by CreateNewSymbol(), LoadOneLibrarySymbol(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), ShowChangedLanguage(), and UpdateAfterSymbolProperties().

◆ UpdateProperties()

void EDA_DRAW_FRAME::UpdateProperties ( )

virtualinherited

Reimplemented in PCB_EDIT_FRAME.

Definition at line 1256 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing, and m_propertiesPanel.

Referenced by SCH_EDIT_FRAME::onVariantSelected(), SCH_EDIT_FRAME::SetCurrentVariant(), unitsChangeRefresh(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), PCB_EDIT_FRAME::UpdateProperties(), and PROPERTIES_TOOL::UpdateProperties().

◆ updateSelectionFilterVisbility()

void SYMBOL_EDIT_FRAME::updateSelectionFilterVisbility ( )

overrideprotectedvirtual

Selection filter panel doesn't have a dedicated visibility control, so show it if any other AUI panel is shown and docked.

Reimplemented from SCH_BASE_FRAME.

Definition at line 2511 of file symbol_edit_frame.cpp.

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

Referenced by LoadSymbolFromSchematic(), SaveSettings(), SYMBOL_EDIT_FRAME(), ToggleLibraryTree(), and ToggleProperties().

◆ UpdateStatusBar()

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

Definition at line 250 of file sch_base_frame.cpp.

References EDA_DRAW_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), GetScreen(), EDA_DRAW_PANEL_GAL::GetViewControls(), BASE_SCREEN::m_LocalOrigin, UNITS_PROVIDER::MessageTextFromValue(), EDA_DRAW_FRAME::UpdateStatusBar(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ updateStatusBarWidths()

void EDA_DRAW_FRAME::updateStatusBarWidths ( )

protectedinherited

Definition at line 730 of file eda_draw_frame.cpp.

References _, and KIUI::GetTextSize().

Referenced by EDA_DRAW_FRAME().

◆ UpdateSymbolMsgPanelInfo()

void SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo ( )

Display the documentation of the selected symbol.

Definition at line 1844 of file symbol_editor.cpp.

References _, EDA_DRAW_FRAME::AppendMsgPanel(), EDA_DRAW_FRAME::ClearMsgPanel(), m_symbol, and UnescapeString().

Referenced by activateSymbolTab(), ClearMsgPanel(), LoadSymbolFromSchematic(), SetBodyStyle(), SetUnit(), SYMBOL_EDIT_FRAME(), and UpdateMsgPanel().

◆ UpdateTitle()

void SYMBOL_EDIT_FRAME::UpdateTitle ( )

Update the main window title bar with the current library name and read only status of the library.

Definition at line 60 of file symbol_editor.cpp.

References _.

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

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

References _, EDA_BASE_FRAME::config(), EDA_BASE_FRAME::GetWindowSettings(), m_canvas, m_zoomCustomEntry, 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 159 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().

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

References canCloseWindow(), config(), doCloseWindow(), findQuasiModalDialog(), IsModal(), m_closeInProgress, 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 1044 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

◆ SYMBOL_EDITOR_TABS_TEST_FIXTURE

friend struct SYMBOL_EDITOR_TABS_TEST_FIXTURE

friend

Definition at line 75 of file symbol_edit_frame.h.

References SYMBOL_EDITOR_TABS_TEST_FIXTURE.

Referenced by SYMBOL_EDITOR_TABS_TEST_FIXTURE.

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

Referenced by RecreateToolbars().

◆ m_aboutTitle

wxString EDA_BASE_FRAME::m_aboutTitle

protectedinherited

Definition at line 834 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 888 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 781 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_activeTab

SYMBOL_EDITOR_TAB_CONTEXT* SYMBOL_EDIT_FRAME::m_activeTab = nullptr

private

Definition at line 752 of file symbol_edit_frame.h.

Referenced by activateSymbolTab(), canCloseWindow(), closeAllSymbolTabsSilently(), detachActiveSymbolTab(), dropSymbolTabContext(), GetSymbolFromRedoList(), GetSymbolFromUndoList(), hasDirtyInactiveInstanceTabs(), OnModify(), promptAndCloseSymbolTab(), promptToSaveInactiveInstanceTabs(), RenameSymbolTab(), Save(), saveSymbolCopyAs(), SetCurSymbol(), storeSymbolTabsToSettings(), and ~SYMBOL_EDIT_FRAME().

◆ m_apiHandler

std::unique_ptr<API_HANDLER_SYMBOL> SYMBOL_EDIT_FRAME::m_apiHandler

private

Definition at line 798 of file symbol_edit_frame.h.

Referenced by doCloseWindow(), SYMBOL_EDIT_FRAME(), and ~SYMBOL_EDIT_FRAME().

◆ m_apiHandlerCommon

std::unique_ptr<API_HANDLER_COMMON> SYMBOL_EDIT_FRAME::m_apiHandlerCommon

private

Definition at line 799 of file symbol_edit_frame.h.

Referenced by doCloseWindow(), SYMBOL_EDIT_FRAME(), and ~SYMBOL_EDIT_FRAME().

◆ m_apiLibrariesHandler

std::unique_ptr<API_HANDLER_LIBRARIES> SYMBOL_EDIT_FRAME::m_apiLibrariesHandler

private

Definition at line 800 of file symbol_edit_frame.h.

Referenced by doCloseWindow(), SYMBOL_EDIT_FRAME(), and ~SYMBOL_EDIT_FRAME().

◆ m_appearancePanel

APPEARANCE_CONTROLS_3D* EDA_BASE_FRAME::m_appearancePanel

protectedinherited

Definition at line 840 of file eda_base_frame.h.

Referenced by EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), EDA_3D_VIEWER_FRAME::GetAppearanceManager(), EDA_3D_VIEWER_FRAME::LoadSettings(), EDA_3D_VIEWER_FRAME::OnDarkModeToggle(), EDA_3D_VIEWER_FRAME::ReloadRequest(), EDA_3D_VIEWER_FRAME::SaveSettings(), EDA_3D_VIEWER_FRAME::ShowChangedLanguage(), EDA_3D_VIEWER_FRAME::ToggleAppearanceManager(), EDA_3D_VIEWER_FRAME::TryBefore(), and EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME().

◆ m_auiLayoutState

std::unique_ptr<nlohmann::json> EDA_BASE_FRAME::m_auiLayoutState

protectedinherited

Definition at line 838 of file eda_base_frame.h.

Referenced by LoadWindowSettings(), and RestoreAuiLayout().

◆ m_auimgr

wxAuiManager EDA_BASE_FRAME::m_auimgr

protectedinherited

Definition at line 836 of file eda_base_frame.h.

◆ m_autoSaveDeferredSince

wxDateTime EDA_BASE_FRAME::m_autoSaveDeferredSince

protectedinherited

Definition at line 856 of file eda_base_frame.h.

Referenced by doAutoSave(), and ProcessEvent().

◆ m_autoSavePending

bool EDA_BASE_FRAME::m_autoSavePending

protectedinherited

Definition at line 848 of file eda_base_frame.h.

Referenced by commonInit(), EDA_DRAW_FRAME::CommonSettingsChanged(), onAutoSaveTimer(), ProcessEvent(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProject().

◆ m_autoSavePermissionError

bool EDA_BASE_FRAME::m_autoSavePermissionError

protectedinherited

Definition at line 851 of file eda_base_frame.h.

Referenced by commonInit().

◆ m_autoSaveRequired

bool EDA_BASE_FRAME::m_autoSaveRequired

protectedinherited

Definition at line 849 of file eda_base_frame.h.

Referenced by commonInit(), doAutoSave(), isAutoSaveRequired(), OnModify(), PCB_EDIT_FRAME::SaveBoard(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProject().

◆ m_autoSaveTimer

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer

protectedinherited

Definition at line 850 of file eda_base_frame.h.

Referenced by commonInit(), EDA_DRAW_FRAME::CommonSettingsChanged(), onAutoSaveTimer(), ProcessEvent(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), and ~EDA_BASE_FRAME().

◆ m_base_frame_defaults

SCHEMATIC_SETTINGS SCH_BASE_FRAME::m_base_frame_defaults

protectedinherited

Only used by symbol_editor. Eeschema should be using the one inside the SCHEMATIC.

Definition at line 324 of file sch_base_frame.h.

Referenced by SCH_BASE_FRAME().

◆ m_bodyStyle

int SYMBOL_EDIT_FRAME::m_bodyStyle

private

Show the normal shape (m_bodyStyle <= 1) or the DeMorgan converted shape (m_bodyStyle > 1)

Definition at line 768 of file symbol_edit_frame.h.

Referenced by activateSymbolTab(), detachActiveSymbolTab(), GetBodyStyle(), GetDocumentExtents(), LoadOneLibrarySymbol(), RebuildSymbolUnitAndBodyStyleLists(), RebuildView(), SetBodyStyle(), SetCurSymbol(), and SYMBOL_EDIT_FRAME().

◆ m_bodyStyleSelectBox

wxComboBox* SYMBOL_EDIT_FRAME::m_bodyStyleSelectBox

private

Definition at line 742 of file symbol_edit_frame.h.

Referenced by ClearToolbarControl(), configureToolbars(), RebuildSymbolUnitAndBodyStyleLists(), SetBodyStyle(), and SYMBOL_EDIT_FRAME().

◆ m_canvas

EDA_DRAW_PANEL_GAL* EDA_DRAW_FRAME::m_canvas

privateinherited

Definition at line 645 of file eda_draw_frame.h.

Referenced by configureToolbars(), 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 638 of file eda_draw_frame.h.

Referenced by SCH_BASE_FRAME::createCanvas(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), resolveCanvasType(), FOOTPRINT_EDIT_FRAME::resolveCanvasType(), SwitchCanvas(), ~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_centerItemOnIdle

LIB_ID SYMBOL_EDIT_FRAME::m_centerItemOnIdle

private

Definition at line 762 of file symbol_edit_frame.h.

Referenced by centerItemIdleHandler(), and LoadSymbol().

◆ m_closeInProgress

bool EDA_BASE_FRAME::m_closeInProgress

protectedinherited

Set while windowClosing() is deciding whether the frame may close.

The unsaved-changes prompt pumps messages, so a second close event can be dispatched before m_isClosing is set; running the teardown re-entrantly corrupts the frame.

Definition at line 880 of file eda_base_frame.h.

Referenced by commonInit(), and windowClosing().

◆ m_colorSettings

COLOR_SETTINGS* EDA_DRAW_FRAME::m_colorSettings

protectedinherited

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

Referenced by ConfigBaseName(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ m_currentScreen

BASE_SCREEN* EDA_DRAW_FRAME::m_currentScreen

privateinherited

current used SCREEN

Definition at line 644 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), GetScreen(), SetScreen(), and ~EDA_DRAW_FRAME().

◆ m_displayIndex

int EDA_BASE_FRAME::m_displayIndex

protectedinherited

Definition at line 828 of file eda_base_frame.h.

Referenced by commonInit(), LoadWindowState(), and OnSize().

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

Referenced by EDA_DRAW_FRAME(), GetDrawBgColor(), SetDrawBgColor(), and PCB_BASE_FRAME::SetDrawBgColor().

◆ m_drawSpecificBodyStyle

bool SYMBOL_EDIT_FRAME::m_drawSpecificBodyStyle

private

When editing a symbol: only apply new graphic items to the current body style.

Definition at line 774 of file symbol_edit_frame.h.

Referenced by GetDrawSpecificBodyStyle(), SetDrawSpecificBodyStyle(), and SYMBOL_EDIT_FRAME().

◆ m_drawSpecificUnit

bool SYMBOL_EDIT_FRAME::m_drawSpecificUnit

private

When editing a symbol: only apply new graphic items to the current unit.

Definition at line 771 of file symbol_edit_frame.h.

Referenced by GetDrawSpecificUnit(), SetDrawSpecificUnit(), and SYMBOL_EDIT_FRAME().

◆ m_dummyScreen

SCH_SCREEN* SYMBOL_EDIT_FRAME::m_dummyScreen

private

Helper screen used when no symbol is loaded.

Definition at line 737 of file symbol_edit_frame.h.

Referenced by closeAllSymbolTabsSilently(), emptyScreen(), promptAndCloseSymbolTab(), SYMBOL_EDIT_FRAME(), and ~SYMBOL_EDIT_FRAME().

◆ m_dummySelection

SELECTION TOOLS_HOLDER::m_dummySelection

protectedinherited

Definition at line 175 of file tools_holder.h.

Referenced by GetCurrentSelection().

◆ m_file_checker

std::unique_ptr<LOCKFILE> EDA_DRAW_FRAME::m_file_checker

protectedinherited

Prevents opening same file multiple times.

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

Referenced by ClearFileHistory(), commonInit(), CommonSettingsChanged(), GetFileFromHistory(), GetFileHistory(), LoadSettings(), SaveSettings(), UpdateFileHistory(), and ~EDA_BASE_FRAME().

◆ m_findReplaceData

std::unique_ptr<EDA_SEARCH_DATA> EDA_DRAW_FRAME::m_findReplaceData

protectedinherited

Definition at line 623 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_findReplaceDialog

DIALOG_SCH_FIND* SCH_BASE_FRAME::m_findReplaceDialog

protectedinherited

Definition at line 321 of file sch_base_frame.h.

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), doCloseWindow(), GetFindReplaceDialog(), OnFindDialogClose(), SCH_BASE_FRAME(), and ShowFindReplaceDialog().

◆ m_findStringHistoryList

wxArrayString EDA_DRAW_FRAME::m_findStringHistoryList

protectedinherited

Definition at line 624 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_framePos

wxPoint EDA_BASE_FRAME::m_framePos

protectedinherited

Definition at line 825 of file eda_base_frame.h.

Referenced by BITMAP2CMP_FRAME::BITMAP2CMP_FRAME(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME(), LoadWindowState(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SaveWindowSettings().

◆ m_frameSize

wxSize EDA_BASE_FRAME::m_frameSize

protectedinherited

Definition at line 826 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(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_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 648 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 608 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 618 of file eda_draw_frame.h.

Referenced by ClearToolbarControl(), configureToolbars(), EDA_DRAW_FRAME(), OnSelectGrid(), OnUpdateSelectGrid(), and UpdateGridSelectBox().

◆ m_hotkeyPopup

HOTKEY_CYCLE_POPUP* EDA_DRAW_FRAME::m_hotkeyPopup

protectedinherited

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

Referenced by EDA_DRAW_FRAME::AddApiPluginMenuItems(), EDA_DRAW_FRAME::AddApiPluginTools(), commonInit(), findQuasiModalDialog(), GetFrameType(), GetWindowSize(), IsType(), LoadWindowState(), EDA_DRAW_FRAME::OnApiPluginInvoke(), 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_infoBar

WX_INFOBAR* EDA_BASE_FRAME::m_infoBar

protectedinherited

◆ m_inSymChangeTimerEvent

bool SCH_BASE_FRAME::m_inSymChangeTimerEvent

privateinherited

Definition at line 334 of file sch_base_frame.h.

Referenced by OnSymChangeDebounceTimer(), and SCH_BASE_FRAME().

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

Referenced by commonInit(), NonUserClose(), SaveSettings(), and windowClosing().

◆ m_isSymbolFromSchematic

bool SYMBOL_EDIT_FRAME::m_isSymbolFromSchematic

private

Flag if the symbol being edited was loaded directly from a schematic.

Definition at line 777 of file symbol_edit_frame.h.

Referenced by activateSymbolTab(), canCloseWindow(), IsSymbolFromSchematic(), LoadSymbolFromSchematic(), promptAndCloseSymbolTab(), and SYMBOL_EDIT_FRAME().

◆ m_iuScale

const EDA_IU_SCALE& UNITS_PROVIDER::m_iuScale

privateinherited

Definition at line 256 of file units_provider.h.

Referenced by GetIuScale(), and UNITS_PROVIDER().

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway

privateinherited

Definition at line 85 of file kiway_holder.h.

Referenced by HasKiway(), Kiway(), KIWAY_HOLDER(), and SetKiway().

◆ m_lastToolbarIconSize

int EDA_DRAW_FRAME::m_lastToolbarIconSize

privateinherited

Definition at line 650 of file eda_draw_frame.h.

Referenced by CommonSettingsChanged(), EDA_DRAW_FRAME(), and LoadSettings().

◆ m_libMgr

LIB_SYMBOL_LIBRARY_MANAGER* SYMBOL_EDIT_FRAME::m_libMgr

private

◆ m_libTreeAutoHiddenForSchematicEdit

bool SYMBOL_EDIT_FRAME::m_libTreeAutoHiddenForSchematicEdit

private

True while a schematic-edit auto-hide of the library tree still needs restoring on save.

Definition at line 780 of file symbol_edit_frame.h.

Referenced by LoadSymbolFromSchematic(), SaveSettings(), SYMBOL_EDIT_FRAME(), and ToggleLibraryTree().

◆ m_loadingSymbolTab

bool SYMBOL_EDIT_FRAME::m_loadingSymbolTab = false

private

Definition at line 757 of file symbol_edit_frame.h.

Referenced by restoreSymbolTabsFromSettings().

◆ m_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault

protectedinherited

Definition at line 827 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

◆ m_modal

bool KIWAY_PLAYER::m_modal

protectedinherited

Definition at line 174 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 177 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 178 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 180 of file kiway_player.h.

Referenced by DismissModal(), KIWAY_PLAYER(), and ShowModal().

◆ m_modal_string

wxString KIWAY_PLAYER::m_modal_string

protectedinherited

Definition at line 179 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 863 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 628 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), and FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_FRAME().

◆ m_netInspectorPanel

NET_INSPECTOR_PANEL* EDA_DRAW_FRAME::m_netInspectorPanel

protectedinherited

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

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

◆ m_normalFrameSize

wxSize EDA_BASE_FRAME::m_normalFrameSize

protectedinherited

Definition at line 832 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 640 of file eda_draw_frame.h.

Referenced by resolveCanvasType(), FOOTPRINT_EDIT_FRAME::resolveCanvasType(), SetOpenGLFailureOccurred(), and ~EDA_DRAW_FRAME().

◆ m_originTransforms

ORIGIN_TRANSFORMS EDA_BASE_FRAME::m_originTransforms

protectedinherited

Definition at line 865 of file eda_base_frame.h.

Referenced by GetOriginTransforms().

◆ m_overrideLocksCb

wxCheckBox* EDA_DRAW_FRAME::m_overrideLocksCb

protectedinherited

Definition at line 621 of file eda_draw_frame.h.

Referenced by ClearToolbarControl(), configureToolbars(), EDA_DRAW_FRAME(), and GetOverrideLocks().

◆ m_perspective

wxString EDA_BASE_FRAME::m_perspective

protectedinherited

Definition at line 837 of file eda_base_frame.h.

Referenced by LoadWindowSettings(), and RestoreAuiLayout().

◆ m_polarCoords

bool EDA_DRAW_FRAME::m_polarCoords

protectedinherited

Definition at line 613 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), GetShowPolarCoords(), PCB_BASE_FRAME::LoadSettings(), PCB_BASE_FRAME::SaveSettings(), and SetShowPolarCoords().

◆ m_propertiesPanel

PROPERTIES_PANEL* EDA_DRAW_FRAME::m_propertiesPanel

protectedinherited

◆ m_redoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_redoList

protectedinherited

Definition at line 861 of file eda_base_frame.h.

Referenced by SYMBOL_EDIT_FRAME::activateSymbolTab(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_BASE_EDIT_FRAME::ClearUndoORRedoList(), PL_EDITOR_FRAME::ClearUndoORRedoList(), SCH_EDIT_FRAME::ClearUndoORRedoList(), SYMBOL_EDIT_FRAME::ClearUndoORRedoList(), FOOTPRINT_EDIT_FRAME::detachActiveFootprintTab(), SYMBOL_EDIT_FRAME::detachActiveSymbolTab(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintTab(), GetRedoActionDescription(), GetRedoCommandCount(), FOOTPRINT_EDIT_FRAME::installFootprintTabBoard(), PopCommandFromRedoList(), FOOTPRINT_EDIT_FRAME::promptAndCloseFootprintTab(), PushCommandToRedoList(), FOOTPRINT_EDIT_FRAME::RefreshLibraryFootprintTab(), and FOOTPRINT_EDIT_FRAME::RevertFootprint().

◆ m_reference

wxString SYMBOL_EDIT_FRAME::m_reference

private

RefDes of the symbol (only valid if symbol was loaded from schematic)

Definition at line 785 of file symbol_edit_frame.h.

Referenced by activateSymbolTab(), CanCloseSymbolFromSchematic(), promptAndCloseSymbolTab(), and updateInfoBar().

◆ m_replaceStringHistoryList

wxArrayString EDA_DRAW_FRAME::m_replaceStringHistoryList

protectedinherited

Definition at line 625 of file eda_draw_frame.h.

Referenced by SCH_BASE_FRAME::doCloseWindow(), GetReplaceHistoryList(), LoadSettings(), SCH_BASE_FRAME::OnFindDialogClose(), SaveSettings(), and SCH_BASE_FRAME::ShowFindReplaceDialog().

◆ m_schematicSymbolUUID

KIID SYMBOL_EDIT_FRAME::m_schematicSymbolUUID

private

Definition at line 782 of file symbol_edit_frame.h.

Referenced by activateSymbolTab(), CanCloseSymbolFromSchematic(), promptAndCloseSymbolTab(), and saveCurrentSymbol().

◆ m_searchPane

SEARCH_PANE* EDA_DRAW_FRAME::m_searchPane

protectedinherited

Definition at line 631 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_SCH_SELECTION_FILTER* SCH_BASE_FRAME::m_selectionFilterPanel

protectedinherited

Definition at line 320 of file sch_base_frame.h.

Referenced by SCH_EDIT_FRAME::LoadProjectSettings(), SCH_BASE_FRAME(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SCH_EDIT_FRAME::ShowChangedLanguage(), and SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME().

◆ m_settings

SYMBOL_EDITOR_SETTINGS* SYMBOL_EDIT_FRAME::m_settings

private

Definition at line 746 of file symbol_edit_frame.h.

Referenced by GetSettings(), LoadSettings(), restoreSymbolTabsFromSettings(), SaveSettings(), storeSymbolTabsToSettings(), SYMBOL_EDIT_FRAME(), SynchronizePins(), and ToggleProperties().

◆ m_settingsManager

SETTINGS_MANAGER* EDA_BASE_FRAME::m_settingsManager

protectedinherited

Definition at line 844 of file eda_base_frame.h.

Referenced by commonInit(), and GetSettingsManager().

◆ m_showBorderAndTitleBlock

bool EDA_DRAW_FRAME::m_showBorderAndTitleBlock

protectedinherited

Definition at line 616 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_showDeMorgan

bool SYMBOL_EDIT_FRAME::m_showDeMorgan = false

staticprivate

Definition at line 790 of file symbol_edit_frame.h.

◆ m_silentSymbolTabClose

bool SYMBOL_EDIT_FRAME::m_silentSymbolTabClose = false

private

While true, promptAndCloseSymbolTab() skips the unsaved-changes dialog.

Definition at line 760 of file symbol_edit_frame.h.

Referenced by closeAllSymbolTabsSilently(), closeSymbolTab(), and promptAndCloseSymbolTab().

◆ m_sockets

std::vector<wxSocketBase*> KIWAY_PLAYER::m_sockets

protectedinherited

Definition at line 183 of file kiway_player.h.

Referenced by OnSockRequestServer(), and ~KIWAY_PLAYER().

◆ m_socketServer

wxSocketServer* EDA_DRAW_FRAME::m_socketServer

protectedinherited

Definition at line 603 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME().

◆ m_spaceMouse

std::unique_ptr<NL_SCHEMATIC_PLUGIN> SCH_BASE_FRAME::m_spaceMouse

privateinherited

Definition at line 339 of file sch_base_frame.h.

Referenced by ActivateGalCanvas(), handleActivateEvent(), and handleIconizeEvent().

◆ m_supportsAutoSave

bool EDA_BASE_FRAME::m_supportsAutoSave

protectedinherited

Definition at line 847 of file eda_base_frame.h.

Referenced by commonInit(), EDA_DRAW_FRAME::CommonSettingsChanged(), ProcessEvent(), and SCH_EDIT_FRAME::SCH_EDIT_FRAME().

◆ m_symbol

LIB_SYMBOL* SYMBOL_EDIT_FRAME::m_symbol

private

◆ m_syncLibrariesInProgress

bool SYMBOL_EDIT_FRAME::m_syncLibrariesInProgress

private

Definition at line 796 of file symbol_edit_frame.h.

Referenced by IsSyncLibrariesInProgress(), SYMBOL_EDIT_FRAME(), and SyncLibraries().

◆ m_tabContexts

std::vector<std::unique_ptr<SYMBOL_EDITOR_TAB_CONTEXT> > SYMBOL_EDIT_FRAME::m_tabContexts

private

Definition at line 751 of file symbol_edit_frame.h.

Referenced by clearSymbolTabsModifiedForLibrary(), closeAllSymbolTabsSilently(), CreateUnsavedSymbolTab(), dropSymbolTabContext(), findOrCreateSymbolInstanceTab(), findOrCreateSymbolTab(), hasDirtyInactiveInstanceTabs(), promptAndCloseSymbolTab(), promptToSaveInactiveInstanceTabs(), storeSymbolTabsToSettings(), symbolTabContextForKey(), and ~SYMBOL_EDIT_FRAME().

◆ m_tabsPanel

EDITOR_TABS_PANEL* SYMBOL_EDIT_FRAME::m_tabsPanel = nullptr

private

Definition at line 753 of file symbol_edit_frame.h.

Referenced by clearSymbolTabsModifiedForLibrary(), closeAllSymbolTabsSilently(), closeSymbolTab(), CreateUnsavedSymbolTab(), DeleteSymbolFromLibrary(), findOrCreateSymbolInstanceTab(), findOrCreateSymbolTab(), GetTabsPanel(), OnModify(), OnTabCharHook(), RenameSymbolTab(), restoreSymbolTabsFromSettings(), saveSymbolCopyAs(), storeSymbolTabsToSettings(), SYMBOL_EDIT_FRAME(), symbolTabContextForIndex(), and ~SYMBOL_EDIT_FRAME().

◆ m_tbLeft

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbLeft

protectedinherited

Definition at line 897 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(), SelectToolbarAction(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and UpdateToolbarControlSizes().

◆ m_tbRight

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbRight

protectedinherited

Definition at line 896 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(), SelectToolbarAction(), SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME(), and UpdateToolbarControlSizes().

◆ m_tbTopAux

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbTopAux

protectedinherited

Definition at line 895 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(), SelectToolbarAction(), and UpdateToolbarControlSizes().

◆ m_tbTopMain

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbTopMain

protectedinherited

◆ m_toolbarControlFactories

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

protectedinherited

Definition at line 899 of file eda_base_frame.h.

Referenced by GetCustomToolbarControlFactory(), and RegisterCustomToolbarControlFactory().

◆ m_toolbarSettings

TOOLBAR_SETTINGS* EDA_BASE_FRAME::m_toolbarSettings

protectedinherited

Definition at line 891 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_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(), FOOTPRINT_WIZARD_FRAME::FOOTPRINT_WIZARD_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_treePane

SYMBOL_TREE_PANE* SYMBOL_EDIT_FRAME::m_treePane

private

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type

privateinherited

Definition at line 86 of file kiway_holder.h.

Referenced by GetType(), and KIWAY_HOLDER().

◆ m_uiUpdateHandlerBound

bool EDA_BASE_FRAME::m_uiUpdateHandlerBound

protectedinherited

True once the single wxID_ANY UPDATE_UI handler has been bound.

Definition at line 871 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME(), and RegisterUIUpdateHandler().

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

Referenced by onUpdateUI(), RegisterUIUpdateHandler(), and UnregisterUIUpdateHandler().

◆ m_undoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_undoList

protectedinherited

◆ m_undoRedoCountMax

int EDA_DRAW_FRAME::m_undoRedoCountMax

protectedinherited

Definition at line 611 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), and LoadSettings().

◆ m_unit

int SYMBOL_EDIT_FRAME::m_unit

private

The unit number to edit and show.

Definition at line 765 of file symbol_edit_frame.h.

Referenced by activateSymbolTab(), detachActiveSymbolTab(), GetDocumentExtents(), GetUnit(), LoadOneLibrarySymbol(), RebuildSymbolUnitAndBodyStyleLists(), RebuildView(), Revert(), SetCurSymbol(), SetUnit(), and SYMBOL_EDIT_FRAME().

◆ m_unitSelectBox

wxComboBox* SYMBOL_EDIT_FRAME::m_unitSelectBox

private

Definition at line 740 of file symbol_edit_frame.h.

Referenced by ClearToolbarControl(), configureToolbars(), RebuildSymbolUnitAndBodyStyleLists(), SetUnit(), and SYMBOL_EDIT_FRAME().

◆ m_userUnits

EDA_UNITS UNITS_PROVIDER::m_userUnits

privateinherited

Definition at line 257 of file units_provider.h.

Referenced by GetUserUnits(), SetUserUnits(), and UNITS_PROVIDER().

◆ m_watcher

std::unique_ptr<wxFileSystemWatcher> SCH_BASE_FRAME::m_watcher

privateinherited

These are file watchers for the symbol library tables.

Definition at line 329 of file sch_base_frame.h.

Referenced by OnSymChange(), and setSymWatcher().

◆ m_watcherDebounceTimer

wxTimer SCH_BASE_FRAME::m_watcherDebounceTimer

privateinherited

Definition at line 333 of file sch_base_frame.h.

Referenced by OnSymChange(), OnSymChangeDebounceTimer(), and SCH_BASE_FRAME().

◆ m_watcherFileName

wxFileName SCH_BASE_FRAME::m_watcherFileName

privateinherited

Definition at line 330 of file sch_base_frame.h.

Referenced by OnSymChange(), OnSymChangeDebounceTimer(), and setSymWatcher().

◆ m_watcherIsDir

bool SCH_BASE_FRAME::m_watcherIsDir

privateinherited

Definition at line 332 of file sch_base_frame.h.

Referenced by OnSymChange(), OnSymChangeDebounceTimer(), SCH_BASE_FRAME(), and setSymWatcher().

◆ m_watcherTimestamp

long long SCH_BASE_FRAME::m_watcherTimestamp

privateinherited

Definition at line 331 of file sch_base_frame.h.

Referenced by OnSymChangeDebounceTimer(), SCH_BASE_FRAME(), SetSymModificationTime(), and setSymWatcher().

◆ m_zoomCustomEntry

int EDA_DRAW_FRAME::m_zoomCustomEntry

protectedinherited

Definition at line 620 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME(), OnSelectZoom(), OnUpdateSelectZoom(), and UpdateZoomSelectBox().

◆ m_zoomSelectBox

wxChoice* EDA_DRAW_FRAME::m_zoomSelectBox

protectedinherited

Definition at line 619 of file eda_draw_frame.h.

Referenced by ClearToolbarControl(), 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 253 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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ HOLDER_TYPE

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ SYMBOL_EDIT_FRAME()

◆ ~SYMBOL_EDIT_FRAME()

Member Function Documentation

◆ ActivateGalCanvas()

◆ activateSymbolTab()

◆ AddApiPluginMenuItems()

◆ AddApiPluginTools()

◆ AddLibraryFile()

◆ addLibTableEntry()

◆ AddMenuLanguageList()

◆ AddStandardHelpMenu()

◆ AddStandardSubMenus()

◆ AddToScreen()

◆ AngleValueFromString()

◆ AppearancePanelName()

◆ AppendMsgPanel()

◆ backupLibrary()

◆ CanAcceptApiCommands()

◆ CanCloseSymbolFromSchematic()

◆ canCloseWindow()

◆ canRunAutoSave()

◆ captureSymbolSelectionKiids()

◆ captureSymbolViewSnapshot()

◆ centerItemIdleHandler()

◆ ChangeUserUnits()

◆ CheckForAutosaveFiles()

◆ ClearFileHistory()

◆ ClearFindReplaceStatus()

◆ ClearFocus()

◆ ClearMsgPanel()

◆ clearSymbolTabsModifiedForLibrary()

◆ clearSymbolTabUndoRedo()

◆ clearTabModifiedState()

◆ ClearToolbarControl()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ closeAllSymbolTabsSilently()

◆ closeSymbolTab()

◆ CloseWindow()

◆ commonInit()

◆ CommonSettingsChanged()

◆ config()

◆ ConfigBaseName()

◆ configureToolbars()

◆ CopySymbolToClipboard()

◆ createCanvas()

◆ CreateHotkeyPopup()

◆ CreateInfoBar()

◆ CreateNewSymbol()

◆ CreateServer()

◆ CreateUnsavedSymbolTab()

◆ CurrentToolName()

◆ DdAddLibrary()

◆ DeleteSymbolFromLibrary()

◆ DesignBlocksPaneName()

◆ Destroy()

◆ detachActiveSymbolTab()

◆ DismissModal()

◆ DisplayConstraintsMsg()

◆ DisplayGridMsg()

◆ DisplayToolMsg()

◆ DisplayUnitsMsg()

◆ doAutoSave()

◆ doCloseWindow()