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)

wxString	GetCurLib () const
	The nickname of the current library being edited and empty string if none.

wxString	SetCurLib (const wxString &aLibNickname)
	Set the current library nickname and returns the old library nickname.

LIB_TREE *	GetLibTree () const override

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 the currently selected library to a new file.

void	SaveAll ()
	Save all modified symbols and libraries.

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

void	RevertAll ()

void	DeleteSymbolFromLibrary ()

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

void	ToggleLibraryTree () override

bool	IsLibraryTreeShown () const override

void	FocusLibraryTreeInput () override

void	FreezeLibraryTree ()

void	ThawLibraryTree ()

void	OnUpdateUnitNumber (wxUpdateUIEvent &event)

void	UpdateAfterSymbolProperties (wxString *aOldName=nullptr)

void	RebuildSymbolUnitsList ()

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)

bool	GetShowDeMorgan () const

void	SetShowDeMorgan (bool show)

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, const VECTOR2I &aOffset)
	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

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_EXPRESS &mail) override
	Receive KIWAY_EXPRESS messages from other players.

void	FocusOnItem (EDA_ITEM *aItem) 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	IsSymbolAlias () const
	Return true if aLibId is an alias for the editor screen symbol.

bool	IsCurrentSymbol (const LIB_ID &aLibId) const
	Restore the empty editor screen, without any symbol or library selected.

void	emptyScreen ()

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)
	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	SelectLibraryFromList ()
	Display a list of loaded libraries and allows the user to select a library.

SYMBOL_LIB_TABLE *	SelectSymLibTable (bool aOptional=false)
	Display a dialog asking the user to select a symbol library table.

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.

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 (const wxDateTime &aTime)
	Set the modification time of the symbol library table file.

SCH_SELECTION_TOOL *	GetSelectionTool () override

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

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

void	ScriptingConsoleEnableDisable ()
	Toggle the scripting console visibility.

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

EDA_SEARCH_DATA &	GetFindReplaceData ()

wxArrayString &	GetFindHistoryList ()

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

void	SetShowPolarCoords (bool aShow)

void	ToggleUserUnits () override

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

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

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

virtual void	SetDrawBgColor (const COLOR4D &aColor)

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

virtual wxString	GetScreenDesc () const

virtual wxString	GetFullScreenDesc () const

void	EraseMsgBox ()

virtual void	ReCreateHToolbar ()

virtual void	ReCreateVToolbar ()

virtual void	ReCreateLeftToolbar ()

virtual void	ReCreateAuxiliaryToolbar ()

bool	IsGridVisible () const

virtual void	SetGridVisibility (bool aVisible)

bool	IsGridOverridden () const

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

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

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

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

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

virtual PLUGIN_ACTION_SCOPE	PluginActionScope () const

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	OnMaximize (wxMaximizeEvent &aEvent)

int	GetAutoSaveInterval () const

bool	IsType (FRAME_T aType) const

FRAME_T	GetFrameType () const

virtual const SEARCH_STACK &	sys_search ()
	Return a SEARCH_STACK pertaining to entire program.

virtual wxString	help_name ()

void	OnKicadAbout (wxCommandEvent &event)

void	OnPreferences (wxCommandEvent &event)

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

void	PrintMsg (const wxString &text)

void	CreateInfoBar ()

void	FinishAUIInitialization ()

WX_INFOBAR *	GetInfoBar ()

void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

void	ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar.

void	ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar.

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.

void	ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
	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.

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

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

virtual void	DeleteAutoSaveFile (const wxFileName &aFileName)

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

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

const wxString &	GetAboutTitle () const

const wxString &	GetUntranslatedAboutTitle () const

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

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

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

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

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

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

virtual int	GetUndoCommandCount () const

virtual int	GetRedoCommandCount () const

virtual wxString	GetUndoActionDescription () const

virtual wxString	GetRedoActionDescription () const

int	GetMaxUndoItems () const

bool	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	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 const wxString	PropertiesPaneName ()

static const wxString	NetInspectorPanelName ()

static const wxString	DesignBlocksPaneName ()

static const wxString	AppearancePanelName ()

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

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

static void	HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
	Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g.

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

Public Attributes
bool	m_SyncPinEdit
	Set to true to synchronize pins at the same position when editing symbols with multiple units or multiple body styles.

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

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	handleActivateEvent (wxActivateEvent &aEvent) override
	Handle a window activation event.

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

bool	saveSymbolLibTables (bool aGlobal, bool aProject)
	Save Symbol Library Tables to disk.

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

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	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 (APP_SETTINGS_BASE *aCfg=nullptr)
	Return the canvas type stored in the application settings.

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

void	onActivate (wxActivateEvent &aEvent)

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

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

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

void	onIconize (wxIconizeEvent &aEvent)

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

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

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.

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

Protected Attributes
SCHEMATIC_SETTINGS	m_base_frame_defaults
	These are only used by symbol_editor.

PANEL_SCH_SELECTION_FILTER *	m_selectionFilterPanel

wxSocketServer *	m_socketServer
	Prevents opening same file multiple times.

std::unique_ptr< LOCKFILE >	m_file_checker

COLOR4D	m_gridColor

COLOR4D	m_drawBgColor

int	m_undoRedoCountMax

bool	m_polarCoords

bool	m_showBorderAndTitleBlock

wxChoice *	m_gridSelectBox

wxChoice *	m_zoomSelectBox

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

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

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_isClosing
	Set by the close window event handler after frames are asked if they can close.

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

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

TOOLBAR_SETTINGS *	m_toolbarSettings

ACTION_TOOLBAR *	m_tbTopMain

ACTION_TOOLBAR *	m_tbTopAux

ACTION_TOOLBAR *	m_tbRight

ACTION_TOOLBAR *	m_tbLeft

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

TOOL_MANAGER *	m_toolManager

ACTIONS *	m_actions

TOOL_DISPATCHER *	m_toolDispatcher

SELECTION	m_dummySelection

std::vector< std::string >	m_toolStack

bool	m_immediateActions

MOUSE_DRAG_ACTION	m_dragAction

bool	m_moveWarpsCursor

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

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

Private Types
enum	TABLE_SCOPE { GLOBAL_LIB_TABLE , PROJECT_LIB_TABLE }

Private Member Functions
void	setupTools ()

void	saveSymbolCopyAs (bool aOpenCopy)

bool	saveLibrary (const wxString &aLibrary, bool aNewFile)
	Save the changes to the current library.

void	SelectActiveLibrary (const wxString &aLibrary=wxEmptyString)
	Set the current active library to aLibrary.

bool	LoadSymbolFromCurrentLib (const wxString &aSymbolName, int aUnit=0, int aBodyStyle=0)
	Load a symbol from the current active library, optionally setting the selected unit and convert.

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

bool	backupFile (const wxFileName &aOriginalFile, const wxString &aBackupExt)
	Return currently edited symbol.

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

wxString	getTargetLib () const

void	centerItemIdleHandler (wxIdleEvent &aEvent)

bool	saveAllLibraries (bool aRequireConfirmation)
	Save the current symbol.

bool	saveCurrentSymbol ()
	Store the currently modified symbol in the library manager buffer.

void	storeCurrentSymbol ()
	Rename LIB_SYMBOL aliases to avoid conflicts before adding a symbol to a library.

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

bool	addLibTableEntry (const wxString &aLibFile, TABLE_SCOPE aScope=GLOBAL_LIB_TABLE)
	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	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

SYMBOL_TREE_PANE *	m_treePane

LIB_SYMBOL_LIBRARY_MANAGER *	m_libMgr

SYMBOL_EDITOR_SETTINGS *	m_settings

LIB_ID	m_centerItemOnIdle

int	m_unit

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

bool	m_isSymbolFromSchematic

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

wxString	m_reference

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

wxFileName	m_watcherFileName

wxDateTime	m_watcherLastModified

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

Detailed Description

The symbol library editor main window.

Definition at line 49 of file symbol_edit_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 41 of file kiway_holder.h.

◆ TABLE_SCOPE

enum SYMBOL_EDIT_FRAME::TABLE_SCOPE

private

Enumerator
GLOBAL_LIB_TABLE
PROJECT_LIB_TABLE

Definition at line 491 of file symbol_edit_frame.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 116 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ SYMBOL_EDIT_FRAME()

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

◆ ~SYMBOL_EDIT_FRAME()

SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME ( )

override

Definition at line 286 of file symbol_edit_frame.cpp.

References SCH_BASE_FRAME::GetScreen(), PGM_BASE::GetSettingsManager(), IsSymbolFromSchematic(), m_dummyScreen, m_isSymbolFromSchematic, m_libMgr, m_symbol, TOOLS_HOLDER::m_toolManager, Pgm(), SETTINGS_MANAGER::Save(), SetScreen(), SCH_BASE_FRAME::setSymWatcher(), and TOOL_MANAGER::ShutdownAllTools().

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 373 of file sch_base_frame.cpp.

References EDA_DRAW_FRAME::ActivateGalCanvas(), SCH_BASE_FRAME::GetCanvas(), and SCH_BASE_FRAME::m_spaceMouse.

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

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

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

Referenced by SCH_EDIT_FRAME::configureToolbars(), and PCB_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 1077 of file symbol_edit_frame.cpp.

References _, SYMBOL_LIBRARY_MANAGER::AddLibrary(), SYMBOL_LIBRARY_MANAGER::CreateLibrary(), DisplayError(), KIWAY::ExpressMail(), FRAME_SCH_SYMBOL_EDITOR, PATHS::GetDefaultUserSymbolsPath(), SYMBOL_LIB_TABLE::GetGlobalLibTable(), SYMBOL_LIBRARY_MANAGER::GetUniqueLibraryName(), FILEEXT::KiCadSymbolLibFileExtension, FILEEXT::KiCadSymbolLibFileWildcard(), Kiway, SYMBOL_LIBRARY_MANAGER::LibraryExists(), EDA_DRAW_FRAME::LibraryFileBrowser(), m_libMgr, MAIL_LIB_EDIT, SCH_BASE_FRAME::saveSymbolLibTables(), and SCH_BASE_FRAME::SelectSymLibTable().

Referenced by saveSymbolCopyAs().

◆ addLibTableEntry()

bool SYMBOL_EDIT_FRAME::addLibTableEntry	(	const wxString &	aLibFile,
		TABLE_SCOPE	aScope = `GLOBAL_LIB_TABLE`
	)

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

References _, SYMBOL_LIB_TABLE::GetGlobalLibTable(), SYMBOL_LIB_TABLE::GetGlobalTableFileName(), PGM_BASE::GetLocalEnvVariables(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), GLOBAL_LIB_TABLE, LIB_TABLE::HasLibrary(), LIB_TABLE::InsertRow(), NormalizePath(), Pgm(), Prj(), LIB_TABLE::Save(), PROJECT_SCH::SchSymbolLibTable(), LIB_TABLE_ROW::SetFullURI(), LIB_TABLE_ROW::SetNickName(), and IO_ERROR::What().

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

References _, ACTION_MENU::Add(), LanguagesList, LANGUAGE_DESCR::m_KI_Lang_Identifier, LANGUAGE_DESCR::m_Lang_Label, ACTION_MENU::SetIcon(), and ACTION_MENU::SetTitle().

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

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar * aMenuBar )

inherited

Add the standard KiCad help menu to the menubar.

Definition at line 642 of file eda_base_frame.cpp.

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU & aMenu )

inherited

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

zoom and grid).

Definition at line 629 of file eda_draw_frame.cpp.

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

Referenced by SCH_SELECTION_TOOL::Init(), PICKER_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), PCB_SELECTION_TOOL::Init(), and 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 484 of file sch_base_frame.cpp.

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

Referenced by SCH_EDIT_FRAME::AddJunction(), SCH_EDIT_TOOL::ChangeTextType(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_DRAWING_TOOLS::SingleClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ AngleValueFromString()

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

inlineinherited

Definition at line 186 of file units_provider.h.

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

Referenced by PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), and PCB_FIELDS_GRID_TABLE::SetValue().

◆ AppearancePanelName()

static const wxString EDA_DRAW_FRAME::AppearancePanelName ( )

inlinestaticinherited

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

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

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

◆ backupFile()

bool SYMBOL_EDIT_FRAME::backupFile	(	const wxFileName &	aOriginalFile,
		const wxString &	aBackupExt
	)

private

Return currently edited symbol.

Definition at line 1317 of file symbol_edit_frame.cpp.

References _, and DisplayError().

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.

Definition at line 641 of file eda_base_frame.h.

Referenced by PCB_EDIT_FRAME::CanAcceptApiCommands(), and API_HANDLER_EDITOR::checkForBusy().

◆ CanCloseSymbolFromSchematic()

bool SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic ( bool doClose )

Definition at line 631 of file symbol_edit_frame.cpp.

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

Referenced by canCloseWindow().

◆ canCloseWindow()

bool SYMBOL_EDIT_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 665 of file symbol_edit_frame.cpp.

References CanCloseSymbolFromSchematic(), LIB_SYMBOL_LIBRARY_MANAGER::GetAdapter(), IsContentModified(), m_isSymbolFromSchematic, m_libMgr, saveAllLibraries(), and KIPLATFORM::APP::SupportsShutdownBlockReason().

◆ centerItemIdleHandler()

void SYMBOL_EDIT_FRAME::centerItemIdleHandler ( wxIdleEvent & aEvent )

private

Definition at line 216 of file symbol_editor.cpp.

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

Referenced by centerItemIdleHandler(), and LoadSymbol().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1676 of file eda_base_frame.cpp.

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

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

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName & aFileName )

virtualinherited

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

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

Parameters

aFileName A wxFileName object containing the file name to check.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1519 of file eda_base_frame.cpp.

References _, FILEEXT::AutoSaveFilePrefix, EDA_BASE_FRAME::DeleteAutoSaveFile(), KIPLATFORM::IO::DuplicatePermissions(), Pgm(), and traceAutoSave.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ ClearFileHistory()

void EDA_BASE_FRAME::ClearFileHistory ( FILE_HISTORY * aFileHistory = nullptr )

inherited

Remove all files from the file history.

Parameters

aFileHistory The FILE_HISTORY in use. If null, the main application file history is used

Definition at line 1163 of file eda_base_frame.cpp.

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

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

◆ ClearFocus()

virtual void EDA_DRAW_FRAME::ClearFocus ( )

inlinevirtualinherited

Definition at line 315 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::FocusOnItem().

Referenced by SCH_NAVIGATE_TOOL::changeSheet(), SCH_EDIT_FRAME::HardRedraw(), PCB_SELECTION_TOOL::Main(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_ERC::OnCancelClick(), DIALOG_SYMBOL_FIELDS_TABLE::OnClose(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_GROUP_PROPERTIES::OnRemoveMember(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected(), SCH_EDIT_FRAME::SetCurrentSheet(), DIALOG_DRC::~DIALOG_DRC(), DIALOG_FOOTPRINT_CHECKER::~DIALOG_FOOTPRINT_CHECKER(), DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES(), and DIALOG_LIB_EDIT_PIN_TABLE::~DIALOG_LIB_EDIT_PIN_TABLE().

◆ ClearMsgPanel()

void SYMBOL_EDIT_FRAME::ClearMsgPanel ( )

inlineoverridevirtual

Clear all messages from the message panel.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 243 of file symbol_edit_frame.h.

References UpdateSymbolMsgPanelInfo().

Referenced by saveLibrary().

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

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

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

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

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), emptyScreen(), SCH_EDIT_FRAME::importFile(), PCB_EDIT_FRAME::ImportSpecctraSession(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), LoadOneLibrarySymbolAux(), LoadSymbolFromCurrentLib(), SCH_EDIT_FRAME::OnImportProject(), PL_EDITOR_FRAME::OnNewDrawingSheet(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), EDA_BASE_FRAME::~EDA_BASE_FRAME(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

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

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

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ CommonSettingsChanged()

void SYMBOL_EDIT_FRAME::CommonSettingsChanged ( int aFlags )

overridevirtual

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

References EDA_BASE_FRAME::m_configName.

◆ configureToolbars()

void SYMBOL_EDIT_FRAME::configureToolbars ( )

overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 159 of file toolbars_symbol_editor.cpp.

References EDA_BASE_FRAME::configureToolbars(), ID_LIBEDIT_SELECT_UNIT_NUMBER, LISTBOX_WIDTH, m_unitSelectBox, EDA_BASE_FRAME::RegisterCustomToolbarControlFactory(), and ACTION_TOOLBAR_CONTROLS::unitSelector.

◆ CopySymbolToClipboard()

void SYMBOL_EDIT_FRAME::CopySymbolToClipboard ( )

Definition at line 1339 of file symbol_editor.cpp.

References LIB_SYMBOL::Flatten(), SCH_IO_KICAD_SEXPR::FormatLibSymbol(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), 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 363 of file sch_base_frame.cpp.

References SCH_BASE_FRAME::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::SCH_BASE_FRAME().

◆ CreateHotkeyPopup()

void EDA_DRAW_FRAME::CreateHotkeyPopup ( )

virtualinherited

Definition at line 1253 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_hotkeyPopup.

Referenced by PCB_CONTROL::ContrastModeFeedback(), SCH_EDITOR_CONTROL::GridFeedback(), and PCB_CONTROL::SnapModeFeedback().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 1028 of file eda_base_frame.cpp.

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

Referenced by SYMBOL_DIFF_FRAME::SYMBOL_DIFF_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 343 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 43 of file eda_dde.cpp.

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

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

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 120 of file tools_holder.cpp.

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

Referenced by TOOLS_HOLDER::ShowChangedLanguage().

◆ DdAddLibrary()

void SYMBOL_EDIT_FRAME::DdAddLibrary ( wxString aLibFile )

Add a library dropped file to the symbol library table.

Definition at line 1136 of file symbol_edit_frame.cpp.

References _, SYMBOL_LIBRARY_MANAGER::AddLibrary(), DisplayError(), KIWAY::ExpressMail(), FRAME_SCH_SYMBOL_EDITOR, SYMBOL_LIB_TABLE::GetGlobalLibTable(), Kiway, SYMBOL_LIBRARY_MANAGER::LibraryExists(), m_libMgr, MAIL_LIB_EDIT, SCH_BASE_FRAME::saveSymbolLibTables(), and SCH_BASE_FRAME::SelectSymLibTable().

Referenced by SYMBOL_EDITOR_CONTROL::DdAddLibrary().

◆ DeleteAutoSaveFile()

void EDA_BASE_FRAME::DeleteAutoSaveFile ( const wxFileName & aFileName )

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1569 of file eda_base_frame.cpp.

References FILEEXT::AutoSaveFilePrefix, Pgm(), and traceAutoSave.

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ DeleteSymbolFromLibrary()

void SYMBOL_EDIT_FRAME::DeleteSymbolFromLibrary ( )

Definition at line 1291 of file symbol_editor.cpp.

References _, emptyScreen(), SYMBOL_TREE_PANE::GetLibTree(), GetSelectedLibIds(), GetTargetLibId(), SYMBOL_LIBRARY_MANAGER::HasDerivedSymbols(), IsCurrentSymbol(), IsOK(), SYMBOL_LIBRARY_MANAGER::IsSymbolModified(), m_libMgr, m_treePane, LIB_TREE::RefreshLibTree(), and SYMBOL_LIBRARY_MANAGER::RemoveSymbol().

Referenced by SYMBOL_EDITOR_CONTROL::CutCopyDelete().

◆ DesignBlocksPaneName()

static const wxString EDA_DRAW_FRAME::DesignBlocksPaneName ( )

inlinestaticinherited

Definition at line 427 of file eda_draw_frame.h.

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

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

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

Definition at line 150 of file kiway_player.cpp.

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

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

◆ DismissModal()

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

inherited

Definition at line 164 of file kiway_player.cpp.

References KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_ret_val, and KIWAY_PLAYER::m_modal_string.

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

◆ DisplayConstraintsMsg()

void EDA_DRAW_FRAME::DisplayConstraintsMsg ( const wxString & msg )

inherited

Definition at line 658 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing.

Referenced by EDIT_TOOL::doMoveSelection(), and DRAWING_TOOL::UpdateStatusBar().

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

References _, TOOL_MANAGER::GetSettings(), WINDOW_SETTINGS::grid, GRID_SETTINGS::grids, GRID_SETTINGS::last_size_idx, EDA_BASE_FRAME::m_isClosing, TOOLS_HOLDER::m_toolManager, and APP_SETTINGS_BASE::m_Window.

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

◆ DisplayToolMsg()

void EDA_DRAW_FRAME::DisplayToolMsg ( const wxString & msg )

overridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 649 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing.

Referenced by EDIT_TOOL::Duplicate(), and PCB_CONTROL::Paste().

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )

inherited

Display current unit pane in the status bar.

Definition at line 684 of file eda_draw_frame.cpp.

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

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )

protectedvirtualinherited

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

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 361 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void SYMBOL_EDIT_FRAME::doCloseWindow ( )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 688 of file symbol_edit_frame.cpp.

References KIWAY_PLAYER::Destroy(), SCH_BASE_FRAME::GetCanvas(), GetLibTree(), LIB_TREE::ShutdownPreviews(), and EDA_DRAW_PANEL_GAL::StopDrawing().

◆ doReCreateMenuBar()

void SYMBOL_EDIT_FRAME::doReCreateMenuBar ( )

overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 36 of file menubar_symbol_editor.cpp.

References _, ACTION_MENU::Add(), ACTION_MENU::AddClose(), ACTIONS::addLibrary, EDA_BASE_FRAME::AddMenuLanguageList(), EDA_BASE_FRAME::AddStandardHelpMenu(), ACTION_MENU::CHECK, SCH_ACTIONS::checkSymbol, ACTIONS::configurePaths, ACTIONS::copy, ACTIONS::copyAsText, ACTIONS::cut, ACTIONS::doDelete, SCH_ACTIONS::drawArc, SCH_ACTIONS::drawBezier, SCH_ACTIONS::drawCircle, SCH_ACTIONS::drawRectangle, SCH_ACTIONS::drawSymbolLines, SCH_ACTIONS::drawSymbolPolygon, SCH_ACTIONS::drawSymbolTextBox, ACTIONS::duplicate, SCH_ACTIONS::editLibSymbolWithLibEdit, SCH_ACTIONS::exportSymbol, SCH_ACTIONS::exportSymbolAsSVG, SCH_ACTIONS::exportSymbolView, TOOL_MANAGER::GetTool(), SCH_ACTIONS::importGraphics, SCH_ACTIONS::importSymbol, IsSymbolFromSchematic(), TOOLS_HOLDER::m_toolManager, ACTIONS::newLibrary, SCH_ACTIONS::newSymbol, ACTION_MENU::NORMAL, ACTIONS::openPreferences, ACTIONS::paste, SCH_ACTIONS::pinTable, SCH_ACTIONS::placeSymbolPin, SCH_ACTIONS::placeSymbolText, 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(), SCH_ACTIONS::setUnitDisplayName, 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 1466 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::OnDropFiles().

◆ DuplicateSymbol()

void SYMBOL_EDIT_FRAME::DuplicateSymbol ( bool aFromClipboard )

Insert a duplicate symbol.

If aFromClipboard is true then action is a paste.

Definition at line 1378 of file symbol_editor.cpp.

References ensureUniqueName(), GetBodyStyle(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), GetClipboardUTF8(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SYMBOL_TREE_PANE::GetLibTree(), GetTargetLibId(), GetUnit(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), LoadOneLibrarySymbolAux(), m_libMgr, m_treePane, SCH_IO_KICAD_SEXPR::ParseLibSymbols(), IO_ERROR::Problem(), LIB_TREE::SelectLibId(), SyncLibraries(), and SYMBOL_LIBRARY_MANAGER::UpdateSymbol().

Referenced by SYMBOL_EDITOR_CONTROL::DuplicateSymbol().

◆ eeconfig()

EESCHEMA_SETTINGS * SCH_BASE_FRAME::eeconfig ( ) const

inherited

Definition at line 138 of file sch_base_frame.cpp.

References EDA_BASE_FRAME::config().

◆ emptyScreen()

void SYMBOL_EDIT_FRAME::emptyScreen ( )

Definition at line 1357 of file symbol_edit_frame.cpp.

References EDA_BASE_FRAME::ClearUndoRedoList(), GetLibTree(), m_dummyScreen, TOOLS_HOLDER::m_toolManager, Refresh(), TOOL_MANAGER::RunAction(), SetCurLib(), SetCurSymbol(), SetScreen(), LIB_TREE::Unselect(), and ACTIONS::zoomFitScreen.

Referenced by DeleteSymbolFromLibrary(), KiwayMailIn(), and Revert().

◆ ensureUniqueName()

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

private

Definition at line 1432 of file symbol_editor.cpp.

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

Referenced by DuplicateSymbol().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 852 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )

inherited

Definition at line 390 of file eda_draw_frame.cpp.

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

inlinevirtualinherited

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

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 177 of file kiway_player.h.

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

◆ ExportSymbol()

void SYMBOL_EDIT_FRAME::ExportSymbol ( )

◆ findDialogs()

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

protectedinherited

Definition at line 1026 of file eda_draw_frame.cpp.

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

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

privateinherited

Definition at line 208 of file eda_base_frame.cpp.

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

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

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 1040 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::m_auimgr.

Referenced by SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME().

◆ FocusLibraryTreeInput()

void SYMBOL_EDIT_FRAME::FocusLibraryTreeInput ( )

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 772 of file symbol_edit_frame.cpp.

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

◆ FocusOnItem()

void SYMBOL_EDIT_FRAME::FocusOnItem ( EDA_ITEM * aItem )

overridevirtual

Focus on a particular canvas item.

Parameters

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1502 of file symbol_edit_frame.cpp.

References EDA_ITEM::ClearBrightened(), EDA_DRAW_FRAME::FocusOnLocation(), LIB_SYMBOL::GetFields(), EDA_ITEM::GetFocusPosition(), LIB_SYMBOL::GetPins(), EDA_ITEM::IsBrightened(), KIGFX::VIEW_ITEM::IsSCH_ITEM(), m_symbol, EDA_ITEM::m_Uuid, niluuid, pin, EDA_ITEM::SetBrightened(), UpdateItem(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::OnCellSelected().

◆ FocusOnLibId()

void SYMBOL_EDIT_FRAME::FocusOnLibId ( const LIB_ID & aLibID )

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

inherited

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

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

Parameters

aPos	is the point to go to.

Definition at line 1040 of file eda_draw_frame.cpp.

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

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

◆ FreezeLibraryTree()

void SYMBOL_EDIT_FRAME::FreezeLibraryTree ( )

Definition at line 778 of file symbol_edit_frame.cpp.

References LIB_SYMBOL_LIBRARY_MANAGER::GetAdapter(), m_libMgr, and m_treePane.

Referenced by KiwayMailIn(), and saveLibrary().

◆ GetAboutTitle()

const wxString & EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 543 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_aboutTitle.

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inherited

Definition at line 341 of file eda_base_frame.cpp.

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

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

◆ GetBodyStyle()

int SYMBOL_EDIT_FRAME::GetBodyStyle ( ) const

inline

Definition at line 234 of file symbol_edit_frame.h.

References m_bodyStyle.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_EDITOR_PIN_TOOL::CreatePin(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditLibrarySymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SCH_SELECTION_TOOL::Init(), LoadSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), SCH_SELECTION_TOOL::Reset(), SCH_SELECTION_TOOL::Selectable(), SetCurSymbol(), SVGPlotSymbol(), DIALOG_PIN_PROPERTIES::TransferDataFromWindow(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ 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 345 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 360 of file symbol_edit_frame.cpp.

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

Referenced by SVGPlotSymbol().

◆ GetCurLib()

wxString SYMBOL_EDIT_FRAME::GetCurLib ( ) const

The nickname of the current library being edited and empty string if none.

Definition at line 829 of file symbol_edit_frame.cpp.

References PROJECT::GetRString(), Prj(), PROJECT::SCH_LIBEDIT_CUR_LIB, PROJECT_SCH::SchSymbolLibTable(), and PROJECT::SetRString().

Referenced by GetSymbolFromRedoList(), GetSymbolFromUndoList(), KiwayMailIn(), LoadSymbolFromCurrentLib(), SetCurLib(), storeCurrentSymbol(), SyncLibraries(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), UpdateAfterSymbolProperties(), and UpdateTitle().

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const

inlinevirtualinherited

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

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

Returns: the filename and full path to the open file

Reimplemented in SCH_EDIT_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, and PCB_EDIT_FRAME.

Definition at line 437 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::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 1751 of file symbol_edit_frame.cpp.

References TOOL_MANAGER::GetTool(), and 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 108 of file symbol_edit_frame.h.

References m_symbol.

◆ GetCustomToolbarControlFactory()

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

inherited

Definition at line 503 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::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 1485 of file symbol_edit_frame.cpp.

References LIB_SYMBOL::Flatten(), m_bodyStyle, m_symbol, m_unit, EDA_IU_SCALE::mmToIU(), 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 TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

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

Definition at line 144 of file tools_holder.h.

References TOOLS_HOLDER::m_dragAction.

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

◆ GetDrawBgColor()

COLOR4D SCH_BASE_FRAME::GetDrawBgColor ( ) const

overridevirtualinherited

Reimplemented from EDA_DRAW_FRAME.

Definition at line 579 of file sch_base_frame.cpp.

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

◆ GetFileFromHistory()

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

inherited

Fetch the file name from the file history list.

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

Parameters

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

Returns: a wxString containing the selected filename

Definition at line 1123 of file eda_base_frame.cpp.

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

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), BITMAP2CMP_FRAME::OnFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), SCH_EDIT_FRAME::OnLoadFile(), and GERBVIEW_FRAME::OnZipFileHistory().

◆ GetFileHistory()

FILE_HISTORY & EDA_BASE_FRAME::GetFileHistory ( )

inlineinherited

Get the frame's main file history.

Returns: the main file history

Definition at line 421 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString & EDA_DRAW_FRAME::GetFindHistoryList ( )

inlineinherited

Definition at line 118 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_findStringHistoryList.

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

◆ GetFindReplaceData()

EDA_SEARCH_DATA & EDA_DRAW_FRAME::GetFindReplaceData ( )

inlineinherited

Definition at line 117 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_findReplaceData.

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

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 206 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_ident.

Referenced by LIBRARY_EDITOR_CONTROL::changeSelectedPinStatus(), KIWAY_PLAYER::Destroy(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), EDA_3D_CONTROLLER::ExportImage(), FIELDS_GRID_TABLE::getColumnCount(), FIELDS_GRID_TABLE::getField(), SCH_BASE_FRAME::GetViewerSettingsBase(), PCB_BASE_FRAME::GetViewerSettingsBase(), FIELDS_GRID_TABLE::getVisibleRowCount(), COMMON_TOOLS::GridProperties(), SCH_GROUP_TOOL::Group(), PCB_GROUP_TOOL::Group(), PCB_ORIGIN_TRANSFORMS::invertXAxis(), PCB_ORIGIN_TRANSFORMS::invertYAxis(), PANEL_SCH_SELECTION_FILTER::PANEL_SCH_SELECTION_FILTER(), SCH_GROUP_TOOL::PickNewMember(), PCB_GROUP_TOOL::PickNewMember(), EDA_3D_CONTROLLER::ReloadBoard(), EDA_BASE_FRAME::ShowPreferences(), COMMON_CONTROL::ShowProjectManager(), EDA_3D_CONTROLLER::ToggleLayersManager(), EDA_3D_CONTROLLER::ToggleRaytracing(), EDA_3D_CONTROLLER::ToggleVisibility(), and SCH_PROPERTIES_PANEL::updateFontList().

◆ GetFullScreenDesc()

wxString EDA_DRAW_FRAME::GetFullScreenDesc ( ) const

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1154 of file eda_draw_frame.cpp.

Referenced by EDA_DRAW_FRAME::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 462 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_galDisplayOptions.

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

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )

inlinevirtualinherited

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

Definition at line 230 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_gridColor.

Referenced by PCB_CONTROL::Reset().

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

◆ GetHotkeyPopup()

HOTKEY_CYCLE_POPUP * EDA_DRAW_FRAME::GetHotkeyPopup ( )

inlineinherited

Definition at line 488 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_hotkeyPopup.

Referenced by PCB_CONTROL::ContrastModeFeedback(), SCH_EDITOR_CONTROL::GridFeedback(), and PCB_CONTROL::SnapModeFeedback().

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

References EDA_BASE_FRAME::m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), PCB_EDIT_FRAME::CommonSettingsChanged(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_MOVE_TOOL::doMoveSelection(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawVia(), SCH_DRAWING_TOOLS::ImportSheet(), LoadOneLibrarySymbolAux(), PL_EDIT_TOOL::Main(), APPEARANCE_CONTROLS::onReadOnlySwatch(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_EDITOR_CONTROL::PlaceLinkedDesignBlock(), PCB_CONTROL::PlaceLinkedDesignBlock(), SCH_DRAWING_TOOLS::PlaceSymbol(), APPEARANCE_CONTROLS_3D::rebuildLayers(), FOOTPRINT_EDIT_FRAME::ReloadFootprint(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SCH_EDITOR_CONTROL::SaveToLinkedDesignBlock(), PCB_CONTROL::SaveToLinkedDesignBlock(), SetCurSymbol(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), EDA_BASE_FRAME::ShowInfoBarWarning(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and PCB_CONTROL::unfilledZoneCheck().

◆ GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 55 of file units_provider.h.

References UNITS_PROVIDER::m_iuScale.

Referenced by UNITS_PROVIDER::AngleValueFromString(), GRID_MENU::BuildChoiceList(), RC_ITEM::GetJsonViolation(), UNITS_PROVIDER::MessageTextFromMinOptMax(), UNITS_PROVIDER::MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::onUnitsChanged(), UNITS_PROVIDER::OptionalValueFromString(), PANEL_GRID_SETTINGS::RebuildGridSizes(), COMMON_TOOLS::Reset(), UNITS_PROVIDER::StringFromOptionalValue(), UNITS_PROVIDER::StringFromValue(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), GRID::UserUnitsMessageText(), and UNITS_PROVIDER::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 535 of file sch_base_frame.cpp.

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

◆ GetLibManager()

LIB_SYMBOL_LIBRARY_MANAGER & SYMBOL_EDIT_FRAME::GetLibManager ( )

Definition at line 1024 of file symbol_edit_frame.cpp.

References m_libMgr.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_CONTROL::OpenDirectory(), SYMBOL_EDITOR_CONTROL::OpenWithTextEditor(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ 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.
aShowErrorMessage	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 229 of file sch_base_frame.cpp.

References KIWAY_HOLDER::Prj(), SchGetLibSymbol(), PROJECT_SCH::SchLibs(), and PROJECT_SCH::SchSymbolLibTable().

Referenced by SCH_EDIT_FRAME::CreateArchiveLibrary(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), SCH_DRAWING_TOOLS::PlaceSymbol(), 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 92 of file symbol_edit_frame.h.

References SYMBOL_TREE_PANE::GetLibTree(), and m_treePane.

Referenced by 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 616 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

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

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

Definition at line 150 of file tools_holder.h.

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 428 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_mruPath.

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

◆ GetNearestGridPosition()

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

inherited

Return the nearest aGridSize location to aPosition.

Parameters

aPosition The position to check.

Returns: The nearest grid position.

Definition at line 980 of file eda_draw_frame.cpp.

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

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

◆ GetNearestHalfGridPosition()

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

inherited

Return the nearest aGridSize / 2 location to aPosition.

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

Parameters

aPosition The position to check.

Returns: The nearest half-grid position.

Definition at line 994 of file eda_draw_frame.cpp.

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

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

◆ GetOrderedPluginActions()

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

staticinherited

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

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

Parameters

aCfg	is the settings to read the plugin ordering from.

Definition at line 1395 of file eda_draw_frame.cpp.

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

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

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

References EDA_BASE_FRAME::m_originTransforms.

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

◆ GetPageSettings()

const PAGE_INFO & SCH_BASE_FRAME::GetPageSettings ( ) const

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 172 of file sch_base_frame.cpp.

References SCH_SCREEN::GetPageSettings(), and SCH_BASE_FRAME::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 178 of file sch_base_frame.cpp.

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

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard().

◆ GetPropertiesPanel()

PROPERTIES_PANEL * EDA_DRAW_FRAME::GetPropertiesPanel ( )

inlineinherited

Definition at line 417 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_propertiesPanel.

◆ GetRedoActionDescription()

wxString EDA_BASE_FRAME::GetRedoActionDescription ( ) const

virtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 1661 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::GetRedoCommandCount(), UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_redoList.

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 611 of file eda_base_frame.h.

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

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

◆ GetRenderSettings()

SCH_RENDER_SETTINGS * SCH_BASE_FRAME::GetRenderSettings ( )

inherited

Definition at line 351 of file sch_base_frame.cpp.

References SCH_BASE_FRAME::GetCanvas().

Referenced by SCH_SELECTION_TOOL::autostartEvent(), SCH_SELECTION_TOOL::CollectHits(), SCH_EDIT_FRAME::CommonSettingsChanged(), CommonSettingsChanged(), SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSettings(), LoadSettings(), SYMBOL_VIEWER_FRAME::LoadSettings(), DIALOG_SHAPE_PROPERTIES::onBorderSwatch(), DIALOG_SHAPE_PROPERTIES::onFillRadioButton(), DIALOG_PLOT_SCHEMATIC::plotSchematic(), SCH_PRINTOUT::PrintPage(), RebuildView(), SaveSettings(), SYMBOL_VIEWER_FRAME::SaveSettings(), SCH_SELECTION_TOOL::selectMultiple(), SetCurSymbol(), SYMBOL_VIEWER_FRAME::setupUIConditions(), ShowChangedLanguage(), SYMBOL_EDITOR_CONTROL::ShowElectricalTypes(), SYMBOL_EDITOR_CONTROL::ShowPinNumbers(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SVGPlotSymbol(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), SCH_EDITOR_CONTROL::TogglePinAltIcons(), SYMBOL_EDITOR_CONTROL::TogglePinAltIcons(), DIALOG_SHAPE_PROPERTIES::TransferDataToWindow(), and SYMBOL_VIEWER_FRAME::updatePreviewSymbol().

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

References EDA_DRAW_FRAME::GetScreen().

Referenced by SCH_POINT_EDITOR::addCorner(), SCH_BASE_FRAME::AddToScreen(), SYMBOL_EDITOR_MOVE_TOOL::AlignElements(), SCH_SELECTION_TOOL::CollectHits(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SCH_SELECTION_TOOL::GetNode(), SCH_BASE_FRAME::GetPageSettings(), SCH_BASE_FRAME::GetPageSizeIU(), GetSymbolFromRedoList(), GetSymbolFromUndoList(), SCH_BASE_FRAME::GetTitleBlock(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), FIELDS_GRID_TABLE::initGrid(), IsContentModified(), LoadOneLibrarySymbolAux(), LoadSymbol(), SCH_POINT_EDITOR::Main(), SCH_POINT_EDITOR::makePointsAndBehavior(), OnModify(), SCH_BASE_FRAME::OnSymChangeDebounceTimer(), PushSymbolToUndoList(), SCH_SELECTION_TOOL::RebuildSelection(), SCH_POINT_EDITOR::removeCorner(), SCH_BASE_FRAME::RemoveFromScreen(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), saveCurrentSymbol(), SCH_SELECTION_TOOL::SelectConnection(), SCH_SELECTION_TOOL::selectMultiple(), SCH_BASE_FRAME::SetPageSettings(), SCH_BASE_FRAME::SetTitleBlock(), setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), storeCurrentSymbol(), SVGPlotSymbol(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), SCH_SELECTION_TOOL::SyncSelection(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_PROPERTIES_PANEL::updateFontList(), SCH_BASE_FRAME::UpdateItem(), SCH_BASE_FRAME::UpdateStatusBar(), UpdateTitle(), SCH_PROPERTIES_PANEL::valueChanged(), and ~SYMBOL_EDIT_FRAME().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1147 of file eda_draw_frame.cpp.

Referenced by EDA_DRAW_FRAME::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 1216 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 803 of file sch_base_frame.cpp.

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

◆ GetSettings()

SYMBOL_EDITOR_SETTINGS * SYMBOL_EDIT_FRAME::GetSettings ( ) const

inline

Definition at line 204 of file symbol_edit_frame.h.

References m_settings.

Referenced by config(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), GetColorSettings(), LoadSettings(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), SaveSettings(), setupTools(), DIALOG_LIB_EDIT_PIN_TABLE::~DIALOG_LIB_EDIT_PIN_TABLE(), and DIALOG_LIB_SYMBOL_PROPERTIES::~DIALOG_LIB_SYMBOL_PROPERTIES().

◆ GetSettingsManager()

SETTINGS_MANAGER * EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

Definition at line 141 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_settingsManager.

Referenced by KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CreateNewProject(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), BOARD_EDITOR_CONTROL::ExportSTEP(), EESCHEMA_HELPERS::GetSettingsManager(), GetSettingsManager(), KICAD_MANAGER_FRAME::LoadProject(), BOARD_EDITOR_CONTROL::New(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::saveProjectSettings(), KICAD_MANAGER_FRAME::SaveSettings(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), KICAD_MANAGER_FRAME::UnarchiveFiles(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int aErrorCode ) const

inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 143 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

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

Referenced by SCH_SELECTION_TOOL::Selectable().

◆ GetShowDeMorgan()

bool SYMBOL_EDIT_FRAME::GetShowDeMorgan ( ) const

inline

Definition at line 237 of file symbol_edit_frame.h.

References m_showDeMorgan.

Referenced by setupUIConditions(), DIALOG_LIB_EDIT_PIN_TABLE::TransferDataToWindow(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetShowInvisibleFields()

bool SYMBOL_EDIT_FRAME::GetShowInvisibleFields ( )

Definition at line 2004 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 2011 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 132 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_polarCoords.

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

◆ GetSymbolFromRedoList()

void SYMBOL_EDIT_FRAME::GetSymbolFromRedoList ( )

◆ GetSymbolFromUndoList()

void SYMBOL_EDIT_FRAME::GetSymbolFromUndoList ( )

Definition at line 120 of file symbol_editor_undo_redo.cpp.

References EDA_ITEM::ClearFlags(), GetCurLib(), ITEM_PICKER::GetGroupId(), ITEM_PICKER::GetItem(), SYMBOL_TREE_PANE::GetLibTree(), LIB_SYMBOL::GetName(), SCH_BASE_FRAME::GetScreen(), ITEM_PICKER::GetStatus(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), EDA_BASE_FRAME::GetUndoCommandCount(), LIB_SYMBOL::HasAlternateBodyStyle(), m_libMgr, m_symbol, m_treePane, OnModify(), EDA_BASE_FRAME::PopCommandFromUndoList(), EDA_BASE_FRAME::PushCommandToRedoList(), PICKED_ITEMS_LIST::PushItem(), RebuildSymbolUnitsList(), RebuildView(), LIB_TREE::SelectLibId(), PICKED_ITEMS_LIST::SetDescription(), EDA_ITEM::SetFlags(), SetShowDeMorgan(), SYMBOL_LIBRARY_MANAGER::UpdateSymbolAfterRename(), UpdateTitle(), and UR_TRANSIENT.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Undo().

◆ getTargetLib()

wxString SYMBOL_EDIT_FRAME::getTargetLib ( ) const

private

Definition at line 1224 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 1202 of file symbol_edit_frame.cpp.

References empty(), LIB_SYMBOL::GetLibId(), GetTreeLIBID(), IsLibraryTreeShown(), and m_symbol.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), DeleteSymbolFromLibrary(), DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), getTargetLib(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::HasPreview(), SYMBOL_EDITOR_CONTROL::Init(), Revert(), SaveLibraryAs(), and setupUIConditions().

◆ getTargetSymbol()

LIB_SYMBOL * SYMBOL_EDIT_FRAME::getTargetSymbol ( ) 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 1188 of file symbol_edit_frame.cpp.

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SYMBOL_LIBRARY_MANAGER::GetSymbol(), 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 185 of file sch_base_frame.cpp.

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

◆ GetToolCanvas()

wxWindow * EDA_DRAW_FRAME::GetToolCanvas ( ) const

inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 457 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolDispatcher()

TOOL_DISPATCHER * TOOLS_HOLDER::GetToolDispatcher ( ) const

inlineinherited

Definition at line 57 of file tools_holder.h.

References TOOLS_HOLDER::m_toolDispatcher.

Referenced by LIB_TREE_MODEL_ADAPTER::GetToolDispatcher().

◆ GetToolManager()

TOOL_MANAGER * TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

References TOOLS_HOLDER::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 1171 of file symbol_edit_frame.cpp.

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

Referenced by SYMBOL_EDITOR_CONTROL::EditSymbol(), GetTargetLibId(), getTargetSymbol(), SYMBOL_EDITOR_CONTROL::Init(), 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 1182 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 1177 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 48 of file kiway_holder.h.

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

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

References EDA_BASE_FRAME::GetUndoCommandCount(), UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_undoList.

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 610 of file eda_base_frame.h.

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

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

◆ GetUnit()

int SYMBOL_EDIT_FRAME::GetUnit ( ) const

inline

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

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

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

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

References UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::IsMetricUnit().

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

◆ GetUntranslatedAboutTitle()

const wxString & EDA_BASE_FRAME::GetUntranslatedAboutTitle ( ) const

inlineinherited

Definition at line 545 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_aboutTitle.

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

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 45 of file units_provider.h.

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_BOOK_REPORTER::AddHTMLPage(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), PG_UNIT_EDITOR::CreateControls(), PCB::IFACE::CreateKiWindow(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::drawShape(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), PCB_NET_INSPECTOR_PANEL::generateReport(), BOARD_EDITOR_CONTROL::GenFootprintsReport(), WX_GRID::getColumnUnits(), RC_ITEM::GetJsonViolation(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), UNITS_PROVIDER::GetUnitPair(), EDA_DRAW_FRAME::GetUnitPair(), UNITS_PROVIDER::GetUnitsFromType(), GetUserUnits(), IfaceOrAddress(), UNIT_BINDER::init(), FIELDS_GRID_TABLE::initGrid(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), DIALOG_ERC::OnSaveReport(), PANEL_PREVIEW_3D_MODEL::onUnitsChanged(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::onUnitsChanged(), DIALOG_GENERATORS::onUnitsChanged(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PANEL_SETUP_TIME_DOMAIN_PARAMETERS::PANEL_SETUP_TIME_DOMAIN_PARAMETERS(), PCB_FIELDS_GRID_TABLE::PCB_FIELDS_GRID_TABLE(), PG_UNIT_EDITOR::PG_UNIT_EDITOR(), PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), SaveFileAs(), EDA_DRAW_FRAME::SaveSettings(), PCB_BASE_FRAME::SetBoard(), WX_GRID::SetUnitsProvider(), PIN_TABLE_DATA_MODEL::SetValue(), FIELDS_GRID_TABLE::SetValue(), PCB_FIELDS_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), PCB_BASE_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), PG_UNIT_EDITOR::UpdateFrame(), PL_EDITOR_FRAME::UpdateStatusBar(), DRC_TOOL::userUnits(), and GRID::UserUnitsMessageText().

◆ GetViewerSettingsBase()

APP_SETTINGS_BASE * SCH_BASE_FRAME::GetViewerSettingsBase ( ) const

inherited

Definition at line 150 of file sch_base_frame.cpp.

References FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, FRAME_SCH_VIEWER, FRAME_SYMBOL_CHOOSER, 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, SIMULATOR_FRAME, SYMBOL_CHOOSER_FRAME, SYMBOL_DIFF_FRAME, SYMBOL_VIEWER_FRAME, FOOTPRINT_CHOOSER_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 997 of file eda_base_frame.cpp.

References APP_SETTINGS_BASE::m_Window.

Referenced by COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), COMMON_TOOLS::GridFastCycle(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), COMMON_TOOLS::OnGridChanged(), COMMON_TOOLS::Reset(), EDA_BASE_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), COMMON_TOOLS::ToggleCursor(), and COMMON_TOOLS::ToggleCursorStyle().

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

References KICAD_MAIN_FRAME_T, and EDA_BASE_FRAME::m_ident.

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

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const

inherited

Return a human readable value for display in dialogs.

Definition at line 769 of file eda_draw_frame.cpp.

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

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

◆ handleActivateEvent()

void SCH_BASE_FRAME::handleActivateEvent ( wxActivateEvent & aEvent )

overrideprotectedvirtualinherited

Handle a window activation event.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 585 of file sch_base_frame.cpp.

References EDA_DRAW_FRAME::handleActivateEvent(), and SCH_BASE_FRAME::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 594 of file sch_base_frame.cpp.

References EDA_BASE_FRAME::handleIconizeEvent(), and SCH_BASE_FRAME::m_spaceMouse.

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

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

Definition at line 1736 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

void EDA_BASE_FRAME::HandleUpdateUIEvent	(	wxUpdateUIEvent &	aEvent,
		EDA_BASE_FRAME *	aFrame,
		ACTION_CONDITIONS	aCond
	)

staticinherited

Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g.

enabled, checked, etc.).

Parameters

aEvent	is the wxUpdateUIEvent to be processed.
aFrame	is the frame to get the selection from
aCond	are the #UI SELECTION_CONDITIONS used

Definition at line 410 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::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 1461 of file symbol_edit_frame.cpp.

References SCH_ITEM::ClearCaches(), alg::contains(), LIB_SYMBOL::GetDrawItems(), SCH_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), m_symbol, TOOLS_HOLDER::m_toolManager, RebuildView(), and SyncLibraries().

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const

inlineinherited

Safety check before asking for the Kiway reference.

Returns: true if kiway is non-null

Definition at line 65 of file kiway_holder.h.

Referenced by 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 1693 of file symbol_edit_frame.cpp.

References SYMBOL_LIBRARY_MANAGER::HasModifications(), and m_libMgr.

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 1016 of file eda_base_frame.cpp.

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

void EDA_BASE_FRAME::ImportHotkeyConfigFromFile	(	std::map< std::string, TOOL_ACTION * >	aActionMap,
		const wxString &	aDefaultShortname
	)

inherited

Prompt the user for a hotkey file to read, and read it.

Parameters

aActionMap	current hotkey map (over which the imported hotkeys will be applied).
aDefaultShortname	a default short name (extension not needed) like Eeschema, KiCad...

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

◆ IntersheetRefUpdate()

virtual void SCHEMATIC_HOLDER::IntersheetRefUpdate ( SCH_GLOBALLABEL * aItem )

inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 47 of file schematic_holder.h.

Referenced by SCHEMATIC::RecomputeIntersheetRefs().

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

References EDA_BASE_FRAME::m_autoSaveRequired.

Referenced by EDA_BASE_FRAME::ProcessEvent().

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

References GetCurSymbol(), SYMBOL_LIBRARY_MANAGER::GetLibraryNames(), SCH_BASE_FRAME::GetScreen(), IsContentModified(), SYMBOL_LIBRARY_MANAGER::IsLibraryModified(), SYMBOL_LIBRARY_MANAGER::IsLibraryReadOnly(), and m_libMgr.

Referenced by CanCloseSymbolFromSchematic(), canCloseWindow(), IsContentModified(), LoadSymbol(), storeCurrentSymbol(), and UpdateTitle().

◆ IsCurrentSymbol()

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

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

Definition at line 1346 of file symbol_edit_frame.cpp.

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

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

◆ IsCurrentTool()

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

inherited

Definition at line 129 of file tools_holder.cpp.

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

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

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )

inherited

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

Definition at line 158 of file kiway_player.cpp.

References KIWAY_PLAYER::m_modal_loop.

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

◆ IsGridOverridden()

bool EDA_DRAW_FRAME::IsGridOverridden ( ) const

inherited

Definition at line 546 of file eda_draw_frame.cpp.

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

Referenced by EDITOR_CONDITIONS::gridOverridesFunc(), and COMMON_TOOLS::ToggleGridOverrides().

◆ IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( ) const

inherited

Definition at line 516 of file eda_draw_frame.cpp.

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

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), EDITOR_CONDITIONS::gridFunc(), GERBVIEW_FRAME::IsElementVisible(), PICKER_TOOL::Main(), GERBER_LAYER_WIDGET::OnRenderEnable(), and COMMON_TOOLS::ToggleGrid().

◆ IsLibraryTreeShown()

bool SYMBOL_EDIT_FRAME::IsLibraryTreeShown ( ) const

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 766 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(), 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 154 of file kiway_player.h.

References KIWAY_PLAYER::m_modal.

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

◆ IsPluginActionButtonVisible()

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

staticinherited

Definition at line 1380 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 EDA_DRAW_FRAME::AddApiPluginTools().

◆ IsScriptingConsoleVisible()

bool EDA_DRAW_FRAME::IsScriptingConsoleVisible ( )

inherited

Get the current visibility of the scripting console window.

Definition at line 295 of file eda_draw_frame.cpp.

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

Referenced by EDITOR_CONDITIONS::consoleVisibleFunc().

◆ IsSymbolAlias()

bool SYMBOL_EDIT_FRAME::IsSymbolAlias ( ) const

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

Definition at line 1965 of file symbol_edit_frame.cpp.

References LIB_SYMBOL::IsRoot(), and m_symbol.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_SELECTION_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), RebuildView(), SCH_SELECTION_TOOL::Selectable(), SetCurSymbol(), and setupUIConditions().

◆ 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 no longer returns false for an alias.

Definition at line 1971 of file symbol_edit_frame.cpp.

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

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_SELECTION_TOOL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), and setupUIConditions().

◆ IsSymbolFromLegacyLibrary()

bool SYMBOL_EDIT_FRAME::IsSymbolFromLegacyLibrary ( ) const

Definition at line 815 of file symbol_edit_frame.cpp.

References LIB_SYMBOL::GetLibNickname(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), SYMBOL_LIB_TABLE_ROW::GetType(), m_libMgr, m_symbol, and SCH_IO_MGR::ShowType().

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), IsSymbolEditable(), RebuildView(), SetCurSymbol(), and setupUIConditions().

◆ IsSymbolFromSchematic()

bool SYMBOL_EDIT_FRAME::IsSymbolFromSchematic ( ) const

inline

Definition at line 259 of file symbol_edit_frame.h.

References EDA_BASE_FRAME::m_isClosing, and m_isSymbolFromSchematic.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), doReCreateMenuBar(), SYMBOL_EDITOR_CONTROL::EditLibrarySymbol(), IsSymbolEditable(), LoadOneLibrarySymbolAux(), LoadSymbol(), OnModify(), RebuildView(), saveCurrentSymbol(), SetCurSymbol(), setupUIConditions(), UpdateTitle(), and ~SYMBOL_EDIT_FRAME().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inlineinherited

Definition at line 205 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_ident.

Referenced by SYMBOL_EDITOR_CONTROL::AddLibrary(), PCB_CONTROL::AddLibrary(), BOARD_COMMIT::BOARD_COMMIT(), PCB_POINT_EDITOR::changeArcEditMode(), PCB_BASE_EDIT_FRAME::configureToolbars(), SYMBOL_EDITOR_CONTROL::DdAddLibrary(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::DistributeItems(), COMMON_TOOLS::doZoomFit(), RECTANGLE_POINT_EDIT_BEHAVIOR::dragPinsOnEdge(), SYMBOL_EDITOR_CONTROL::ExportSymbol(), PCB_EDITOR_CONDITIONS::get45degModeFunc(), SCH_BASE_FRAME::GetColorSettings(), FOOTPRINT::GetMsgPanelInfo(), SYMBOL_EDITOR_CONTROL::Init(), CONVERT_TOOL::Init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PCB_CONTROL::IterateFootprint(), PCB_BASE_FRAME::loadFootprint(), PCB_CONTROL::LoadFpFromBoard(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_CONTROL::Paste(), PCB_CONTROL::pruneItemLayers(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), EE_GRID_HELPER::queryVisible(), PROPERTIES_PANEL::rebuildProperties(), PCB_SELECTION_TOOL::Reset(), SYMBOL_EDITOR_CONTROL::Revert(), PCB_CONTROL::SaveFpToBoard(), SCH_COMMIT::SCH_COMMIT(), SCH_SELECTION_TOOL::selectMultiple(), APPEARANCE_CONTROLS::setVisibleObjects(), SCH_INSPECTION_TOOL::ShowDatasheet(), SYMBOL_EDITOR_CONTROL::ToggleProperties(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

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

References _, and DisplayErrorMessage().

Referenced by SCH_EDIT_FRAME::doAutoSave(), BOARD_EDITOR_CONTROL::GenIPC2581File(), PCB_EDIT_FRAME::saveBoardAsFile(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveProjectSettings(), and SCH_EDIT_FRAME::saveSchematicFile().

◆ Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const

inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 55 of file kiway_holder.h.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), IMPORT_PROJ_HELPER::addLocalLibraries(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesList(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), BOARD_INSPECTION_TOOL::constructDiffPanel(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), KIWAY_PLAYER::Destroy(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), IMPORT_PROJ_HELPER::doImport(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), PANEL_JOBSET::EnsurePcbSchFramesOpen(), SIMULATOR_CONTROL::ExportPlotToSchematic(), BACK_ANNOTATE::FetchNetlistFromPCB(), PANEL_SYMBOL_CHOOSER::FinishSetup(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), PGM_SINGLE_TOP::MacOpenFile(), PLUGIN_CONTENT_MANAGER::MarkInstalled(), DESIGN_BLOCK_CONTROL::notifyOtherFrames(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PCB_CALCULATOR_FRAME::OnExit(), SIMULATOR_FRAME::onExit(), SAVE_AS_TRAVERSER::OnFile(), PANEL_DESTINATION::OnGenerate(), PANEL_JOBSET::OnGenerateAllDestinationsClick(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), PANEL_COMPONENT_CLASS_CONDITION_FOOTPRINT::OnShowLibraryClick(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), PANEL_JOBSET::OpenJobOptionsForListItem(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::PCB_DESIGN_BLOCK_PREVIEW_WIDGET(), KIWAY_HOLDER::Prj(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), SCH_EDITOR_CONTROL::rescueProject(), SCH_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), BOARD_EDITOR_CONTROL::ShowEeschema(), CVPCB_CONTROL::ShowFootprintViewer(), showFrame(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), FP_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), COMMON_CONTROL::ShowProjectManager(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), DIALOG_ERC::testErc(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), SIMULATOR_CONTROL::Tune(), KICAD_MANAGER_FRAME::UnarchiveFiles(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS & aEvent )

protectedinherited

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

Definition at line 179 of file kiway_player.cpp.

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void SYMBOL_EDIT_FRAME::KiwayMailIn ( KIWAY_EXPRESS & aEvent )

overridevirtual

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

Reimplemented from KIWAY_PLAYER.

Definition at line 1553 of file symbol_edit_frame.cpp.

References _, LIB_TREE::CenterLibId(), KIWAY_EXPRESS::Command(), DisplayErrorMessage(), emptyScreen(), LIB_TREE::ExpandLibId(), SYMBOL_LIB_TABLE::FindRow(), LIB_TABLE::FindRowByURI(), FreezeLibraryTree(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), GetCurLib(), GetCurSymbol(), LIB_TABLE_ROW::GetFullURI(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibNickname(), GetLibTree(), LIB_SYMBOL::GetName(), LIB_TABLE_ROW::GetNickName(), KIWAY_EXPRESS::GetPayload(), SYMBOL_LIBRARY_MANAGER::GetScreen(), LIB_TABLE::HasLibrary(), m_dummyScreen, m_libMgr, TOOLS_HOLDER::m_toolManager, m_treePane, MAIL_LIB_EDIT, MAIL_REFRESH_SYMBOL, MAIL_RELOAD_LIB, TOOL_BASE::MODEL_RELOAD, Prj(), RebuildSymbolUnitsList(), RefreshLibraryTree(), TOOL_MANAGER::ResetTools(), PROJECT_SCH::SchSymbolLibTable(), LIB_TREE::SelectLibId(), SetCurLib(), SetCurSymbol(), SetScreen(), SetShowDeMorgan(), SyncLibraries(), ThawLibraryTree(), UnescapeString(), and SYMBOL_LIBRARY_MANAGER::UpdateLibraryBuffer().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent & event )

protectedinherited

An event handler called on a language menu selection.

Definition at line 186 of file kiway_player.cpp.

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

◆ libeditconfig()

SYMBOL_EDITOR_SETTINGS * SCH_BASE_FRAME::libeditconfig ( ) const

inherited

Definition at line 144 of file sch_base_frame.cpp.

References EDA_BASE_FRAME::config().

Referenced by DIALOG_IMPORT_GFX_SCH::DIALOG_IMPORT_GFX_SCH(), GetShowInvisibleFields(), GetShowInvisiblePins(), setupUIConditions(), SYMBOL_EDITOR_CONTROL::ToggleHiddenFields(), SYMBOL_EDITOR_CONTROL::ToggleHiddenPins(), and SYMBOL_EDITOR_CONTROL::TogglePinAltIcons().

◆ LibraryFileBrowser()

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

inherited

Parameters

doOpen	if true runs an Open Library browser, otherwise New Library
aFilename	for New may contain a default name; in both cases return the chosen filename.
wildcard	a wildcard to filter the displayed files
ext	the library file extension
isDirectory	indicates the library files are directories

Returns: true for OK; false for Cancel.

Definition at line 1161 of file eda_draw_frame.cpp.

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

Referenced by DESIGN_BLOCK_PANE::AddDesignBlockLibrary(), PCB_BASE_EDIT_FRAME::AddLibrary(), AddLibraryFile(), DESIGN_BLOCK_PANE::createNewDesignBlockLibrary(), PCB_BASE_EDIT_FRAME::createNewLibrary(), and SCH_EDITOR_CONTROL::ExportSymbolsToLibrary().

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( APP_SETTINGS_BASE * aCfg = nullptr )

protectedinherited

Return the canvas type stored in the application settings.

Parameters

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

Definition at line 921 of file eda_draw_frame.cpp.

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

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

◆ LoadOneLibrarySymbolAux()

bool SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux	(	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. Create a backup copy of a file with requested extension.

Definition at line 260 of file symbol_editor.cpp.

References KIGFX::ALL, ACTIONS::cancelInteractive, EDA_BASE_FRAME::ClearUndoRedoList(), WX_INFOBAR::Dismiss(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), SCH_BASE_FRAME::GetCanvas(), GetCurSymbol(), EDA_BASE_FRAME::GetInfoBar(), LIB_SYMBOL::GetLibId(), LIB_SYMBOL::GetName(), SCH_BASE_FRAME::GetScreen(), SYMBOL_LIBRARY_MANAGER::GetScreen(), SCH_DRAW_PANEL::GetView(), IsSymbolFromSchematic(), m_bodyStyle, m_dummyScreen, m_isSymbolFromSchematic, m_libMgr, m_symbol, TOOLS_HOLDER::m_toolManager, m_unit, TOOL_BASE::MODEL_RELOAD, RebuildSymbolUnitsList(), EDA_BASE_FRAME::ReCreateMenuBar(), EDA_BASE_FRAME::RecreateToolbars(), Refresh(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::RunAction(), SetCurLib(), SetCurSymbol(), SetScreen(), SetShowDeMorgan(), SCH_BASE_FRAME::setSymWatcher(), KIGFX::VIEW::UpdateAllItems(), UpdateMsgPanel(), and UpdateTitle().

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

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

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

◆ 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 147 of file symbol_editor.cpp.

References _, centerItemIdleHandler(), DisplayErrorMessage(), LIB_TREE::ExpandLibId(), GetBodyStyle(), GetCurSymbol(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), SYMBOL_TREE_PANE::GetLibTree(), SCH_BASE_FRAME::GetScreen(), LIB_SYMBOL::GetSourceLibId(), LIB_ID::GetUniStringLibId(), LIB_ID::GetUniStringLibItemName(), GetUnit(), HandleUnsavedChanges(), IsContentModified(), IsSymbolFromSchematic(), LIB_ID::IsValid(), SYMBOL_LIB_TABLE::LoadSymbol(), LoadSymbolFromCurrentLib(), m_centerItemOnIdle, m_libMgr, m_treePane, Prj(), saveCurrentSymbol(), PROJECT_SCH::SchSymbolLibTable(), SelectActiveLibrary(), LIB_TREE::SelectLibId(), SCH_BASE_FRAME::setSymWatcher(), and IO_ERROR::What().

◆ LoadSymbol() [2/2]

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

◆ LoadSymbolFromCurrentLib()

bool SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib	(	const wxString &	aSymbolName,
		int	aUnit = `0`,
		int	aBodyStyle = `0`
	)

private

Load a symbol from the current active library, optionally setting the selected unit and convert.

Parameters

aSymbolName	The symbol alias name to load from the current library.
aUnit	Unit to be selected
aBodyStyle	Convert to be selected

Returns: true if the symbol loaded correctly.

Definition at line 223 of file symbol_editor.cpp.

References _, EDA_BASE_FRAME::ClearUndoRedoList(), DisplayErrorMessage(), GetCurLib(), GetCurSymbol(), LIB_SYMBOL::IsMulti(), LoadOneLibrarySymbolAux(), SYMBOL_LIB_TABLE::LoadSymbol(), m_SyncPinEdit, TOOLS_HOLDER::m_toolManager, Prj(), RebuildSymbolUnitsList(), TOOL_MANAGER::RunAction(), PROJECT_SCH::SchSymbolLibTable(), SetShowDeMorgan(), LIB_SYMBOL::UnitsLocked(), IO_ERROR::What(), and ACTIONS::zoomFitScreen.

Referenced by LoadSymbol(), and SetCurSymbol().

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

References KIGFX::ALL, SCH_ITEM::GetBodyStyle(), SCH_BASE_FRAME::GetCanvas(), GetCurSymbol(), SCH_SYMBOL::GetFields(), SCH_SYMBOL::GetLibId(), SCH_SYMBOL::GetLibSymbolRef(), SCH_SYMBOL::GetOrientation(), SCH_SYMBOL::GetPosition(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), SCH_ITEM::GetUnit(), SCH_DRAW_PANEL::GetView(), IsLibraryTreeShown(), m_bodyStyle, m_isSymbolFromSchematic, m_reference, m_schematicSymbolUUID, m_symbol, TOOLS_HOLDER::m_toolManager, m_unit, EDA_ITEM::m_Uuid, TOOL_BASE::MODEL_RELOAD, RebuildSymbolUnitsList(), EDA_BASE_FRAME::ReCreateMenuBar(), EDA_BASE_FRAME::RecreateToolbars(), EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::ResetTools(), SetCurSymbol(), SCH_FIELD::SetPosition(), SetScreen(), SetShowDeMorgan(), SCH_BASE_FRAME::setSymWatcher(), SYM_MIRROR_X, SYM_MIRROR_Y, SYM_ORIENT_180, SYM_ORIENT_270, SYM_ORIENT_90, ToggleLibraryTree(), tools, KIGFX::VIEW::UpdateAllItems(), UpdateSymbolMsgPanelInfo(), UpdateTitle(), 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 905 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE & aState )

virtualinherited

Load frame state info from a configuration file.

Definition at line 756 of file eda_base_frame.cpp.

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

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

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

◆ LockFile()

bool EDA_DRAW_FRAME::LockFile ( const wxString & aFileName )

inherited

Mark a schematic file as being in use.

Use ReleaseFile() to undo this.

Parameters

aFileName full path to the file.

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

Definition at line 239 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_file_checker, and Pgm().

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

◆ MakeGridHelper()

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

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1676 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 137 of file units_provider.h.

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

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

◆ 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(), 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 UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUnitsFromType(), and EDA_UNIT_UTILS::UI::MessageTextFromValue().

◆ NetInspectorPanelName()

static const wxString EDA_DRAW_FRAME::NetInspectorPanelName ( )

inlinestaticinherited

Definition at line 425 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 EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onActivate()

void EDA_DRAW_FRAME::onActivate ( wxActivateEvent & aEvent )

protectedinherited

Definition at line 1338 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::handleActivateEvent().

◆ OnApiPluginInvoke()

void EDA_DRAW_FRAME::OnApiPluginInvoke ( wxCommandEvent & aEvent )

virtualinherited

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

Definition at line 1464 of file eda_draw_frame.cpp.

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

Referenced by EDA_DRAW_FRAME::AddApiPluginTools().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protectedinherited

Handle the auto save timer event.

Definition at line 347 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::commonInit(), and EDA_BASE_FRAME::~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 SYMBOL_VIEWER_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 367 of file eda_base_frame.cpp.

References dump(), and kicadTraceKeyEvent.

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

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

◆ OnExitKiCad()

void SYMBOL_EDIT_FRAME::OnExitKiCad ( wxCommandEvent & event )

Definition at line 792 of file symbol_edit_frame.cpp.

References Kiway, and KIWAY::OnKiCadExit().

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent & aEvent )

protectedinherited

Definition at line 1762 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::handleIconizeEvent().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

Definition at line 1181 of file eda_base_frame.cpp.

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

inherited

Definition at line 1688 of file eda_base_frame.cpp.

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

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent & event )

inherited

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

Definition at line 377 of file eda_base_frame.cpp.

References TOOL_DISPATCHER::DispatchWxEvent(), and 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 1031 of file symbol_edit_frame.cpp.

References GetLibTree(), SCH_BASE_FRAME::GetScreen(), IsSymbolFromSchematic(), EDA_BASE_FRAME::m_isClosing, EDA_BASE_FRAME::OnModify(), LIB_TREE::RefreshLibTree(), BASE_SCREEN::SetContentModified(), storeCurrentSymbol(), and UpdateTitle().

Referenced by SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SYMBOL_EDITOR_EDIT_TOOL::editTextBoxProperties(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), GetSymbolFromRedoList(), GetSymbolFromUndoList(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_COMMIT::pushLibEdit(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SYMBOL_EDITOR_EDIT_TOOL::SetUnitDisplayName(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), and UpdateAfterSymbolProperties().

◆ OnMove()

void EDA_DRAW_FRAME::OnMove ( wxMoveEvent & aEvent )

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 612 of file eda_draw_frame.cpp.

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

◆ OnPageSettingsChange()

virtual void EDA_DRAW_FRAME::OnPageSettingsChange ( )

inlinevirtualinherited

Called when modifying the page settings.

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

Reimplemented in SCH_EDIT_FRAME.

Definition at line 347 of file eda_draw_frame.h.

Referenced by DIALOG_PAGES_SETTINGS::TransferDataFromWindow().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

inherited

Definition at line 1188 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::ShowPreferences().

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

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

◆ OnSelectUnit()

void SYMBOL_EDIT_FRAME::OnSelectUnit ( wxCommandEvent & event )

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

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

◆ OnSize()

void EDA_DRAW_FRAME::OnSize ( wxSizeEvent & event )

overridevirtualinherited

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

Reimplemented from EDA_BASE_FRAME.

Reimplemented in SYMBOL_DIFF_FRAME, SYMBOL_VIEWER_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 703 of file eda_draw_frame.cpp.

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

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

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent & evt )

inherited

Definition at line 69 of file eda_dde.cpp.

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

◆ OnSockRequestServer()

void KIWAY_PLAYER::OnSockRequestServer ( wxSocketEvent & evt )

inherited

Definition at line 99 of file eda_dde.cpp.

References ID_EDA_SOCKET_EVENT, and KIWAY_PLAYER::m_sockets.

◆ 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 739 of file sch_base_frame.cpp.

References SCH_BASE_FRAME::m_watcher, SCH_BASE_FRAME::m_watcherDebounceTimer, SCH_BASE_FRAME::m_watcherFileName, KIWAY_HOLDER::Prj(), and PROJECT_SCH::SchLibs().

Referenced by SCH_BASE_FRAME::setSymWatcher().

◆ OnSymChangeDebounceTimer()

void SCH_BASE_FRAME::OnSymChangeDebounceTimer ( wxTimerEvent & aEvent )

inherited

Handler for the filesystem watcher debounce timer.

Definition at line 761 of file sch_base_frame.cpp.

References _, KIWAY::ExpressMail(), FRAME_SCH_SYMBOL_EDITOR, FRAME_SCH_VIEWER, SCH_BASE_FRAME::GetScreen(), EDA_BASE_FRAME::IsContentModified(), IsOK(), Kiway, SCH_BASE_FRAME::m_inSymChangeTimerEvent, SCH_BASE_FRAME::m_watcherDebounceTimer, SCH_BASE_FRAME::m_watcherFileName, SCH_BASE_FRAME::m_watcherLastModified, and MAIL_REFRESH_SYMBOL.

Referenced by SCH_BASE_FRAME::SCH_BASE_FRAME().

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent & aEvent )

protectedinherited

Definition at line 1752 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ OnToolbarSizeChanged()

void EDA_BASE_FRAME::OnToolbarSizeChanged ( )

inherited

Update toolbars if desired toolbar icon changed.

Definition at line 607 of file eda_base_frame.cpp.

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

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged().

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent & aEvent )

inherited

Update the checked item in the grid wxchoice.

Definition at line 423 of file eda_draw_frame.cpp.

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

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

◆ OnUpdateSelectZoom()

void EDA_DRAW_FRAME::OnUpdateSelectZoom ( wxUpdateUIEvent & aEvent )

inherited

Update the checked item in the zoom wxchoice.

Definition at line 441 of file eda_draw_frame.cpp.

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

◆ OnUpdateUnitNumber()

void SYMBOL_EDIT_FRAME::OnUpdateUnitNumber ( wxUpdateUIEvent & event )

Definition at line 798 of file symbol_edit_frame.cpp.

References LIB_SYMBOL::GetUnitCount(), and 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, GERBVIEW_FRAME, PL_EDITOR_FRAME, CVPCB_MAINFRAME, SCH_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 113 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_SINGLE_TOP::OnPgmInit(), PGM_KICAD::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 173 of file units_provider.h.

References EDA_UNIT_UTILS::UI::DoubleValueFromString(), UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUnitsFromType(), and UNITS_PROVIDER::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`
	)

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

Returns: the selected symbol

Definition at line 51 of file picksymbol.cpp.

References alg::delete_if(), PICKED_SYMBOL::Fields, DIALOG_SYMBOL_CHOOSER::g_Mutex, DIALOG_SYMBOL_CHOOSER::GetFields(), DIALOG_SYMBOL_CHOOSER::GetSelectedLibId(), LIB_ID::IsValid(), PICKED_SYMBOL::LibId, DIALOG_SHIM::ShowModal(), and PICKED_SYMBOL::Unit.

Referenced by SCH_DRAWING_TOOLS::PlaceSymbol(), and DIALOG_EDIT_SYMBOLS_LIBID::setLibIdByBrowser().

◆ PluginActionScope()

virtual PLUGIN_ACTION_SCOPE EDA_DRAW_FRAME::PluginActionScope ( ) const

inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 508 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::AddApiPluginTools().

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

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

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

◆ PopCommandFromUndoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromUndoList ( )

virtualinherited

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

Definition at line 1640 of file eda_base_frame.cpp.

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

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

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const TOOL_EVENT & aEvent )

virtualinherited

Pops a tool from the stack.

Parameters

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

Definition at line 78 of file tools_holder.cpp.

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

◆ PrintDrawingSheet()

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

inherited

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

Parameters

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

Definition at line 1117 of file eda_draw_frame.cpp.

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

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

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString & text )

inherited

Definition at line 1022 of file eda_base_frame.cpp.

References text.

Referenced by KICAD_MANAGER_FRAME::UnarchiveFiles().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

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

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent & aEvent )

overrideinherited

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

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

Definition at line 297 of file eda_base_frame.cpp.

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

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

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )

inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in KICAD_MANAGER_FRAME, and PCB_EDIT_FRAME.

Definition at line 541 of file eda_base_frame.h.

Referenced by KIWAY::ProjectChanged().

◆ PropertiesPaneName()

static const wxString EDA_DRAW_FRAME::PropertiesPaneName ( )

inlinestaticinherited

Definition at line 423 of file eda_draw_frame.h.

Referenced by defaultPropertiesPaneInfo(), PCB_EDIT_FRAME::PropertiesShown(), SCH_EDIT_FRAME::SaveSettings(), SaveSettings(), SCH_EDIT_FRAME::setupUIConditions(), setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), SCH_EDIT_FRAME::ToggleProperties(), ToggleProperties(), PCB_BASE_EDIT_FRAME::ToggleProperties(), SCH_EDIT_FRAME::updateSelectionFilterVisbility(), and 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 1625 of file eda_base_frame.cpp.

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

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

◆ PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST * aItem )

virtualinherited

Add a command to undo in the undo list.

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

Definition at line 1610 of file eda_base_frame.cpp.

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

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

◆ PushSymbolToUndoList()

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

Definition at line 34 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 SCH_COMMIT::pushLibEdit(), and SaveCopyInUndoList().

◆ PushTool()

void TOOLS_HOLDER::PushTool ( const TOOL_EVENT & aEvent )

virtualinherited

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

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

Pushes a tool to the stack.

Parameters

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

Definition at line 57 of file tools_holder.cpp.

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

◆ RebuildSymbolUnitsList()

void SYMBOL_EDIT_FRAME::RebuildSymbolUnitsList ( )

Definition at line 700 of file symbol_edit_frame.cpp.

References LIB_SYMBOL::GetUnitCount(), LIB_SYMBOL::GetUnitDisplayName(), m_symbol, m_unit, and m_unitSelectBox.

Referenced by GetSymbolFromRedoList(), GetSymbolFromUndoList(), KiwayMailIn(), LoadOneLibrarySymbolAux(), LoadSymbolFromCurrentLib(), LoadSymbolFromSchematic(), saveLibrary(), SYMBOL_EDITOR_EDIT_TOOL::SetUnitDisplayName(), and UpdateAfterSymbolProperties().

◆ RebuildView()

void SYMBOL_EDIT_FRAME::RebuildView ( )

Definition at line 1442 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(), TOOL_MANAGER::ResetTools(), and KIGFX::VIEW::UpdateAllItems().

Referenced by SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), GetSymbolFromRedoList(), GetSymbolFromUndoList(), HardRedraw(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SetUnit(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and UpdateAfterSymbolProperties().

◆ ReCreateAuxiliaryToolbar()

virtual void EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar ( )

inlinevirtualinherited

Definition at line 217 of file eda_draw_frame.h.

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

◆ ReCreateHToolbar()

virtual void EDA_DRAW_FRAME::ReCreateHToolbar ( )

inlinevirtualinherited

Reimplemented in SYMBOL_DIFF_FRAME.

Definition at line 214 of file eda_draw_frame.h.

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

◆ ReCreateLeftToolbar()

virtual void EDA_DRAW_FRAME::ReCreateLeftToolbar ( )

inlinevirtualinherited

Reimplemented in SYMBOL_DIFF_FRAME.

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

References EDA_BASE_FRAME::doReCreateMenuBar(), and EDA_BASE_FRAME::m_isClosing.

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

◆ RecreateToolbars()

void EDA_BASE_FRAME::RecreateToolbars ( )

virtualinherited

Definition at line 520 of file eda_base_frame.cpp.

References ACTION_TOOLBAR::ApplyConfiguration(), EDA_BASE_FRAME::config(), dummy, TOOLBAR_SETTINGS::GetToolbarConfig(), EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, EDA_BASE_FRAME::m_auimgr, EDA_BASE_FRAME::m_tbLeft, EDA_BASE_FRAME::m_tbRight, EDA_BASE_FRAME::m_tbTopAux, EDA_BASE_FRAME::m_tbTopMain, EDA_BASE_FRAME::m_toolbarSettings, and ACTION_TOOLBAR::SetAuiManager().

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), SCH_EDIT_FRAME::CommonSettingsChanged(), CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), LoadOneLibrarySymbolAux(), LoadSymbolFromSchematic(), KICAD_MANAGER_FRAME::onToolbarSizeChanged(), GERBVIEW_FRAME::ReFillLayerWidget(), EDA_3D_VIEWER_FRAME::ShowChangedLanguage(), CVPCB_MAINFRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ShowChangedLanguage(), ShowChangedLanguage(), PCB_BASE_FRAME::ShowChangedLanguage(), and KICAD_MANAGER_FRAME::ShowChangedLanguage().

◆ ReCreateVToolbar()

virtual void EDA_DRAW_FRAME::ReCreateVToolbar ( )

inlinevirtualinherited

Reimplemented in SYMBOL_DIFF_FRAME.

Definition at line 215 of file eda_draw_frame.h.

◆ RedrawScreen()

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

virtualinherited

Definition at line 324 of file sch_base_frame.cpp.

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

Referenced by DIALOG_ERC::OnERCItemSelected(), and DIALOG_MIGRATE_BUSES::onItemSelected().

◆ RefreshCanvas()

void EDA_DRAW_FRAME::RefreshCanvas ( )

inlineoverridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 464 of file eda_draw_frame.h.

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

Referenced by DIALOG_DRC::OnDRCItemSelected(), and SCH_EDIT_FRAME::OnImportProject().

◆ RefreshLibraryTree()

void SYMBOL_EDIT_FRAME::RefreshLibraryTree ( )

Redisplay the library tree.

Used after changing modified states, descriptions, etc.

Definition at line 1294 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 450 of file sch_base_frame.cpp.

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

Referenced by KIGFX::SCH_VIEW::SetScale().

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

References ACTION_TOOLBAR_CONTROL::GetName(), and EDA_BASE_FRAME::m_toolbarControlFactories.

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

◆ RegisterUIUpdateHandler() [1/2]

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

virtualinherited

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

Parameters

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

Definition at line 43 of file tools_holder.cpp.

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

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

◆ RegisterUIUpdateHandler() [2/2]

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

overridevirtualinherited

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

Parameters

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

Reimplemented from TOOLS_HOLDER.

Definition at line 386 of file eda_base_frame.cpp.

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

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

◆ ReleaseFile()

void EDA_DRAW_FRAME::ReleaseFile ( )

inherited

Release the current file marked in use.

See m_file_checker.

Definition at line 232 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_file_checker.

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

◆ 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 507 of file sch_base_frame.cpp.

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

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_MOVE_TOOL::clearNewDragLines(), SCH_EDIT_FRAME::DeleteJunction(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_MOVE_TOOL::trimDanglingLines(), and SCH_EDIT_FRAME::TrimWire().

◆ 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

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

References _, SYMBOL_LIB_TABLE::FindRow(), SYMBOL_LIB_TABLE::GetGlobalLibTable(), SYMBOL_LIB_TABLE::GetGlobalTableFileName(), PGM_BASE::GetLocalEnvVariables(), PROJECT::GetProjectPath(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), NormalizePath(), Pgm(), Prj(), LIB_TABLE::Save(), PROJECT_SCH::SchSymbolLibTable(), LIB_TABLE_ROW::SetFullURI(), SYMBOL_LIB_TABLE_ROW::SetType(), and IO_ERROR::What().

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

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

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

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

Definition at line 434 of file eda_draw_frame.h.

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

◆ Revert()

void SYMBOL_EDIT_FRAME::Revert ( bool aConfirm = true )

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

Definition at line 1448 of file symbol_editor.cpp.

References _, SYMBOL_LIBRARY_MANAGER::ClearSymbolModified(), ConfirmRevertDialog(), emptyScreen(), GetCurSymbol(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SYMBOL_TREE_PANE::GetLibTree(), GetTargetLibId(), LIB_ID::GetUniStringLibItemName(), IsCurrentSymbol(), LoadSymbol(), m_libMgr, m_treePane, m_unit, SYMBOL_LIBRARY_MANAGER::RevertLibrary(), SYMBOL_LIBRARY_MANAGER::RevertSymbol(), LIB_TREE::SelectLibId(), SYMBOL_LIBRARY_MANAGER::SymbolExists(), and UTF8::wx_str().

Referenced by RevertAll().

◆ RevertAll()

void SYMBOL_EDIT_FRAME::RevertAll ( )

Definition at line 1507 of file symbol_editor.cpp.

References m_libMgr, Revert(), and SYMBOL_LIBRARY_MANAGER::RevertAll().

◆ Save()

void SYMBOL_EDIT_FRAME::Save ( )

Save the selected symbol or library.

Definition at line 513 of file symbol_editor.cpp.

References _, SYMBOL_TREE_PANE::GetLibTree(), GetTreeLIBID(), LIB_ID::GetUniStringLibNickname(), SYMBOL_LIBRARY_MANAGER::IsLibraryReadOnly(), IsLibraryTreeShown(), m_libMgr, m_treePane, OKOrCancelDialog(), LIB_TREE::RefreshLibTree(), saveCurrentSymbol(), saveLibrary(), and UpdateTitle().

Referenced by SYMBOL_EDITOR_CONTROL::Save().

◆ SaveAll()

void SYMBOL_EDIT_FRAME::SaveAll ( )

Save all modified symbols and libraries.

Definition at line 336 of file symbol_editor.cpp.

References SYMBOL_TREE_PANE::GetLibTree(), m_treePane, LIB_TREE::RefreshLibTree(), and saveAllLibraries().

Referenced by SYMBOL_EDITOR_CONTROL::Save().

◆ saveAllLibraries()

bool SYMBOL_EDIT_FRAME::saveAllLibraries ( bool aRequireConfirmation )

private

Save the current symbol.

Definition at line 1677 of file symbol_editor.cpp.

References _, WX_INFOBAR::Dismiss(), SYMBOL_LIBRARY_MANAGER::GetLibraryNames(), SYMBOL_LIBRARY_MANAGER::IsLibraryModified(), SYMBOL_LIBRARY_MANAGER::IsLibraryReadOnly(), EDA_BASE_FRAME::m_infoBar, m_libMgr, OKOrCancelDialog(), saveLibrary(), WX_INFOBAR::ShowMessageFor(), UnsavedChangesDialog(), and UpdateTitle().

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

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

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

Definition at line 1346 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::GetCanvas(), and image.

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

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

Referenced by EDA_DRAW_FRAME::~EDA_DRAW_FRAME().

◆ SaveCopyInUndoList()

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

References PushSymbolToUndoList().

Referenced by SCH_TOOL_BASE< T >::saveCopyInUndoList(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ saveCurrentSymbol()

bool SYMBOL_EDIT_FRAME::saveCurrentSymbol ( )

private

Store the currently modified symbol in the library manager buffer.

Definition at line 103 of file symbol_editor.cpp.

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

Referenced by LoadSymbol(), and Save().

◆ saveLibrary()

bool SYMBOL_EDIT_FRAME::saveLibrary	(	const wxString &	aLibrary,
		bool	aNewFile
	)

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.
aNewFile	Ask for a new file name to save the library.

Returns: True if the library was successfully saved.

Definition at line 1551 of file symbol_editor.cpp.

References _, addLibTableEntry(), backupFile(), ACTIONS::cancelInteractive, SYMBOL_LIBRARY_MANAGER::ClearLibraryModified(), ClearMsgPanel(), DisplayErrorMessage(), fileType(), FreezeLibraryTree(), LIB_TABLE::GetFullURI(), SYMBOL_FILEDLG_SAVE_AS::GetOption(), PROJECT::GetRString(), getTargetLib(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), LIB_TABLE::HasLibrary(), SYMBOL_LIBRARY_MANAGER::IsLibraryReadOnly(), FILEEXT::KiCadSymbolLibFileExtension, FILEEXT::KiCadSymbolLibFileWildcard(), SEARCH_STACK::LastVisitedPath(), m_libMgr, TOOLS_HOLDER::m_toolManager, Prj(), PROJECT_LIB_TABLE, RebuildSymbolUnitsList(), replaceLibTableEntry(), TOOL_MANAGER::RunAction(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), PROJECT::SCH_LIB_PATH, PROJECT_SCH::SchSearchS(), PROJECT_SCH::SchSymbolLibTable(), PROJECT::SetRString(), SCH_BASE_FRAME::SetSymModificationTime(), EDA_BASE_FRAME::ShowInfoBarError(), SyncLibraries(), and ThawLibraryTree().

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

◆ SaveLibraryAs()

void SYMBOL_EDIT_FRAME::SaveLibraryAs ( )

Save the currently selected library to a new file.

Definition at line 545 of file symbol_editor.cpp.

References LIB_ID::GetLibNickname(), SYMBOL_TREE_PANE::GetLibTree(), GetTargetLibId(), m_treePane, LIB_TREE::RefreshLibTree(), and saveLibrary().

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

◆ SaveProjectLocalSettings()

virtual void EDA_BASE_FRAME::SaveProjectLocalSettings ( )

inlinevirtualinherited

Save changes to the project local settings.

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

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 370 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 SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 714 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 328 of file symbol_edit_frame.cpp.

◆ SaveSymbolCopyAs()

void SYMBOL_EDIT_FRAME::SaveSymbolCopyAs ( bool aOpenCopy )

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

Definition at line 557 of file symbol_editor.cpp.

References SYMBOL_TREE_PANE::GetLibTree(), m_treePane, LIB_TREE::RefreshLibTree(), and saveSymbolCopyAs().

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

◆ 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 947 of file symbol_editor.cpp.

References _, AddLibraryFile(), CheckForParentalChainConflicts(), CheckSavingIntoOwnInheritance(), SYMBOL_SAVE_AS_HANDLER::DoSave(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SAVE_AS_DIALOG::GetSymbolName(), getTargetSymbol(), EDA_TEXT::GetText(), EDA_LIST_DIALOG::GetTextSelection(), LIB_SYMBOL::GetValueField(), ID_MAKE_NEW_LIBRARY, ID_OVERWRITE_CONFLICTS, ID_RENAME_CONFLICTS, SYMBOL_LIBRARY_MANAGER::IsLibraryReadOnly(), LoadSymbol(), m_libMgr, SYMBOL_SAVE_AS_HANDLER::OVERWRITE, SYMBOL_SAVE_AS_HANDLER::RENAME, DIALOG_SHIM::ShowModal(), KIDIALOG::ShowModal(), SyncLibraries(), and UnescapeString().

Referenced by SaveSymbolCopyAs().

◆ saveSymbolLibTables()

bool SCH_BASE_FRAME::saveSymbolLibTables	(	bool	aGlobal,
		bool	aProject
	)

protectedinherited

Save Symbol Library Tables to disk.

Parameters

aGlobal	when true, the Global Table is saved.
aProject	when true, the Project Table is saved.

Returns: True when all requested actions succeeded.

Definition at line 240 of file sch_base_frame.cpp.

References _, DisplayErrorMessage(), SYMBOL_LIB_TABLE::GetGlobalLibTable(), SYMBOL_LIB_TABLE::GetGlobalTableFileName(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), KIWAY_HOLDER::Prj(), LIB_TABLE::Save(), PROJECT_SCH::SchSymbolLibTable(), and IO_ERROR::What().

Referenced by AddLibraryFile(), and DdAddLibrary().

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

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

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ ScriptingConsoleEnableDisable()

void EDA_DRAW_FRAME::ScriptingConsoleEnableDisable ( )

inherited

Toggle the scripting console visibility.

Definition at line 262 of file eda_draw_frame.cpp.

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

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

◆ SelectActiveLibrary()

void SYMBOL_EDIT_FRAME::SelectActiveLibrary ( const wxString & aLibrary = wxEmptyString )

private

Set the current active library to aLibrary.

Parameters

aLibrary the nickname of the library in the symbol library table. If empty, display list of available libraries to select from.

Definition at line 89 of file symbol_editor.cpp.

References SCH_BASE_FRAME::SelectLibraryFromList(), SetCurLib(), and UpdateTitle().

Referenced by LoadSymbol().

◆ SelectLibraryFromList()

wxString SCH_BASE_FRAME::SelectLibraryFromList ( )

inherited

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

This list is sorted, with the library cache always at end of the list

Returns: the library nickname used in the symbol library table.

Definition at line 603 of file sch_base_frame.cpp.

References _, alg::contains(), PGM_BASE::GetCommonSettings(), LIB_TABLE::GetLogicalLibs(), LIB_TREE_MODEL_ADAPTER::GetPinningSymbol(), PROJECT::GetProjectFile(), PROJECT::GetRString(), EDA_LIST_DIALOG::GetTextSelection(), PROJECT_FILE::m_PinnedSymbolLibs, COMMON_SETTINGS::m_Session, name, Pgm(), COMMON_SETTINGS::SESSION::pinned_symbol_libs, KIWAY_HOLDER::Prj(), PROJECT::SCH_LIB_SELECT, PROJECT_SCH::SchSymbolLibTable(), PROJECT::SetRString(), EDA_BASE_FRAME::ShowInfoBarError(), and DIALOG_SHIM::ShowModal().

Referenced by CreateNewSymbol(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), ImportSymbol(), and SelectActiveLibrary().

◆ SelectSymLibTable()

SYMBOL_LIB_TABLE * SCH_BASE_FRAME::SelectSymLibTable ( bool aOptional = false )

inherited

Display a dialog asking the user to select a symbol library table.

Parameters

aOptional if set the Cancel button will be relabelled "Skip".

Returns: Pointer to the selected symbol library table or nullptr if canceled.

Definition at line 280 of file sch_base_frame.cpp.

References _, SYMBOL_LIB_TABLE::GetGlobalLibTable(), KIWAY_HOLDER::Prj(), and PROJECT_SCH::SchSymbolLibTable().

Referenced by AddLibraryFile(), DdAddLibrary(), and SCH_EDITOR_CONTROL::ExportSymbolsToLibrary().

◆ SetBodyStyle()

void SYMBOL_EDIT_FRAME::SetBodyStyle ( int aBodyStyle )

inline

Definition at line 235 of file symbol_edit_frame.h.

References m_bodyStyle.

Referenced by SYMBOL_EDITOR_CONTROL::OnDeMorgan().

◆ SetCanvas()

void EDA_DRAW_FRAME::SetCanvas ( EDA_DRAW_PANEL_GAL * aPanel )

inlineinherited

Definition at line 455 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_canvas.

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

◆ SetCurLib()

wxString SYMBOL_EDIT_FRAME::SetCurLib ( const wxString & aLibNickname )

Set the current library nickname and returns the old library nickname.

Definition at line 846 of file symbol_edit_frame.cpp.

References GetCurLib(), Prj(), PROJECT::SCH_LIBEDIT_CUR_LIB, PROJECT_SCH::SchSymbolLibTable(), and PROJECT::SetRString().

Referenced by emptyScreen(), KiwayMailIn(), LoadOneLibrarySymbolAux(), and SelectActiveLibrary().

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

References _, WX_INFOBAR::AddButton(), KIGFX::VIEW::Clear(), KIGFX::SCH_VIEW::ClearHiddenFlags(), WX_INFOBAR::Dismiss(), SCH_DRAW_PANEL::DisplaySymbol(), SCH_ACTIONS::editLibSymbolWithLibEdit, GetBodyStyle(), SCH_BASE_FRAME::GetCanvas(), LIB_ID::GetFullLibraryName(), EDA_BASE_FRAME::GetInfoBar(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibNickname(), GetLibTree(), LIB_SYMBOL::GetName(), SCH_BASE_FRAME::GetRenderSettings(), LIB_SYMBOL::GetRootSymbol(), TOOLS_HOLDER::GetToolManager(), GetUnit(), SCH_DRAW_PANEL::GetView(), KIGFX::SCH_VIEW::HideDrawingSheet(), InvokeSchEditSymbolLibTable(), SYMBOL_LIBRARY_MANAGER::IsLibraryReadOnly(), LIB_SYMBOL::IsMulti(), LIB_SYMBOL::IsRoot(), IsSymbolAlias(), IsSymbolFromLegacyLibrary(), IsSymbolFromSchematic(), Kiway, LoadSymbolFromCurrentLib(), m_bodyStyle, m_libMgr, m_reference, SCH_RENDER_SETTINGS::m_ShowBodyStyle, SCH_RENDER_SETTINGS::m_ShowDisabled, SCH_RENDER_SETTINGS::m_ShowGraphicsDisabled, SCH_RENDER_SETTINGS::m_ShowUnit, m_symbol, m_SyncPinEdit, TOOLS_HOLDER::m_toolManager, m_unit, TOOL_BASE::MODEL_RELOAD, Prj(), EDA_DRAW_PANEL_GAL::Refresh(), WX_INFOBAR::RemoveAllButtons(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::RunAction(), SaveLibraryAs(), SaveSymbolCopyAs(), PROJECT::SCH_LIBEDIT_CUR_SYMBOL, ACTIONS::selectionClear, LIB_TREE::SelectLibId(), PROJECT::SetRString(), WX_INFOBAR::ShowMessage(), KIDIALOG::ShowModal(), UnescapeString(), LIB_SYMBOL::UnitsLocked(), LIB_TREE::Unselect(), and ACTIONS::zoomFitScreen.

Referenced by CanCloseSymbolFromSchematic(), emptyScreen(), KiwayMailIn(), LoadOneLibrarySymbolAux(), LoadSymbolFromSchematic(), 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 181 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_drawBgColor.

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

◆ SetGridColor()

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

inlinevirtualinherited

Reimplemented in GERBVIEW_FRAME, and PCB_EDIT_FRAME.

Definition at line 231 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_gridColor.

◆ SetGridOrigin()

void SCH_BASE_FRAME::SetGridOrigin ( const VECTOR2I & aPoint )

inlineoverridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 144 of file sch_base_frame.h.

◆ SetGridOverrides()

void EDA_DRAW_FRAME::SetGridOverrides ( bool aOverride )

virtualinherited

Definition at line 554 of file eda_draw_frame.cpp.

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

Referenced by COMMON_TOOLS::ToggleGridOverrides().

◆ SetGridVisibility()

void EDA_DRAW_FRAME::SetGridVisibility ( bool aVisible )

virtualinherited

Reimplemented in GERBVIEW_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 524 of file eda_draw_frame.cpp.

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

Referenced by APPEARANCE_CONTROLS::onObjectVisibilityChanged(), GERBVIEW_FRAME::SetGridVisibility(), PCB_BASE_EDIT_FRAME::SetGridVisibility(), and COMMON_TOOLS::ToggleGrid().

◆ SetKiway()

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

inherited

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

"this" is a KIWAY_HOLDER mix-in.

Parameters

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

Definition at line 43 of file kiway_holder.cpp.

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

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

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool aIsModal )

inlineinherited

Definition at line 155 of file kiway_player.h.

References KIWAY_PLAYER::m_modal.

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

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString & aPath )

inlineinherited

Definition at line 426 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_mruPath.

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

◆ SetMsgPanel() [1/3]

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

inherited

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

Parameters

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

Definition at line 867 of file eda_draw_frame.cpp.

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

Referenced by BOARD_INSPECTION_TOOL::ClearHighlight(), PCB_BASE_FRAME::Compile_Ratsnest(), PCB_BASE_FRAME::CreateNewFootprint(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawOneBezier(), SCH_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), BOARD_EDITOR_CONTROL::GenIPC2581File(), 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_PRINTOUT::OnPrintPage(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveSchematicFile(), EDA_DRAW_FRAME::SetMsgPanel(), SCH_DRAWING_TOOLS::SingleClickPlace(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), PL_POINT_EDITOR::updateItem(), SCH_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_EDIT_FRAME::UpdateMsgPanel(), FOOTPRINT_VIEWER_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), PL_EDITOR_FRAME::UpdateMsgPanelInfo(), and SCH_POINT_EDITOR::updateParentItem().

◆ SetMsgPanel() [2/3]

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

inherited

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

Parameters

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

Definition at line 879 of file eda_draw_frame.cpp.

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

◆ SetMsgPanel() [3/3]

void EDA_DRAW_FRAME::SetMsgPanel ( EDA_ITEM * aItem )

inherited

Definition at line 890 of file eda_draw_frame.cpp.

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

◆ SetPageSettings()

void SCH_BASE_FRAME::SetPageSettings ( const PAGE_INFO & aPageSettings )

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 166 of file sch_base_frame.cpp.

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

◆ SetScreen()

void SYMBOL_EDIT_FRAME::SetScreen ( BASE_SCREEN * aScreen )

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1432 of file symbol_edit_frame.cpp.

References TOOLS_HOLDER::m_toolManager, TOOL_BASE::MODEL_RELOAD, TOOL_MANAGER::ResetTools(), and EDA_DRAW_FRAME::SetScreen().

Referenced by emptyScreen(), KiwayMailIn(), LoadOneLibrarySymbolAux(), LoadSymbolFromSchematic(), and ~SYMBOL_EDIT_FRAME().

◆ SetShowDeMorgan()

void SYMBOL_EDIT_FRAME::SetShowDeMorgan ( bool show )

inline

Definition at line 238 of file symbol_edit_frame.h.

References m_showDeMorgan.

Referenced by CreateNewSymbol(), GetSymbolFromRedoList(), GetSymbolFromUndoList(), KiwayMailIn(), LoadOneLibrarySymbolAux(), LoadSymbolFromCurrentLib(), LoadSymbolFromSchematic(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), and UpdateAfterSymbolProperties().

◆ SetShowPolarCoords()

void EDA_DRAW_FRAME::SetShowPolarCoords ( bool aShow )

inlineinherited

Definition at line 133 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_polarCoords.

Referenced by COMMON_TOOLS::TogglePolarCoords().

◆ SetSymModificationTime()

void SCH_BASE_FRAME::SetSymModificationTime ( const wxDateTime & aTime )

inlineinherited

Set the modification time of the symbol library table file.

This is used to detect changes to the symbol library table file.

Parameters

aTime is the modification time of the symbol library table file.

Definition at line 265 of file sch_base_frame.h.

References SCH_BASE_FRAME::m_watcherLastModified.

Referenced by 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 675 of file sch_base_frame.cpp.

References DisplayInfoMessage(), SYMBOL_LIB_TABLE::FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_ID::GetLibNickname(), SCH_BASE_FRAME::m_watcher, SCH_BASE_FRAME::m_watcherFileName, SCH_BASE_FRAME::m_watcherLastModified, SCH_BASE_FRAME::OnSymChange(), KIWAY_HOLDER::Prj(), PROJECT_SCH::SchSymbolLibTable(), and IO_ERROR::What().

Referenced by LoadOneLibrarySymbolAux(), LoadSymbol(), LoadSymbolFromSchematic(), and ~SYMBOL_EDIT_FRAME().

◆ SetTitleBlock()

void SCH_BASE_FRAME::SetTitleBlock ( const TITLE_BLOCK & aTitleBlock )

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 192 of file sch_base_frame.cpp.

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

◆ SetUnit()

void SYMBOL_EDIT_FRAME::SetUnit ( int aUnit )

Definition at line 1050 of file symbol_edit_frame.cpp.

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

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

◆ setupTools()

void SYMBOL_EDIT_FRAME::setupTools ( )

private

Definition at line 371 of file symbol_edit_frame.cpp.

References SCH_BASE_FRAME::GetCanvas(), SCH_BASE_FRAME::GetScreen(), GetSettings(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::InvokeTool(), TOOLS_HOLDER::m_actions, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::SetEnvironment(), and EDA_DRAW_PANEL_GAL::SetEventDispatcher().

◆ setupUIConditions()

void SYMBOL_EDIT_FRAME::setupUIConditions ( )

overrideprotectedvirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 405 of file symbol_edit_frame.cpp.

◆ setupUnits()

void EDA_DRAW_FRAME::setupUnits ( APP_SETTINGS_BASE * aCfg )

protectedinherited

Definition at line 1271 of file eda_draw_frame.cpp.

References TOOL_MANAGER::GetTool(), ACTIONS::inchesUnits, APP_SETTINGS_BASE::SYSTEM::last_imperial_units, APP_SETTINGS_BASE::SYSTEM::last_metric_units, APP_SETTINGS_BASE::m_System, TOOLS_HOLDER::m_toolManager, ACTIONS::millimetersUnits, ACTIONS::milsUnits, TOOL_MANAGER::RunAction(), COMMON_TOOLS::SetLastUnits(), and APP_SETTINGS_BASE::SYSTEM::units.

Referenced by GERBVIEW_FRAME::GERBVIEW_FRAME(), and SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME().

◆ SetUserUnits()

void UNITS_PROVIDER::SetUserUnits ( EDA_UNITS aUnits )

inlineinherited

Definition at line 46 of file units_provider.h.

References UNITS_PROVIDER::m_userUnits.

Referenced by EDA_BASE_FRAME::ChangeUserUnits(), PCB::IFACE::CreateKiWindow(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), IfaceOrAddress(), EDA_DRAW_FRAME::LoadSettings(), DRC_TEST_PROVIDER::RunTests(), DRC_ENGINE::RunTests(), SaveFileAs(), and EDA_DRAW_FRAME::ToggleUserUnits().

◆ ShowChangedLanguage()

void SYMBOL_EDIT_FRAME::ShowChangedLanguage ( )

overridevirtual

Reimplemented from TOOLS_HOLDER.

Definition at line 1401 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(), LIB_TREE::ShowChangedLanguage(), EDA_BASE_FRAME::ShowChangedLanguage(), KIGFX::VIEW::UpdateAllItems(), UpdateMsgPanel(), and UpdateTitle().

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

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), WX_INFOBAR::SetCallback(), and WX_INFOBAR::ShowMessageFor().

◆ ShowInfoBarError() [2/2]

void EDA_BASE_FRAME::ShowInfoBarError	(	const wxString &	aErrorMsg,
		bool	aShowCloseButton = `false`,
		WX_INFOBAR::MESSAGE_TYPE	aType = `WX_INFOBAR::MESSAGE_TYPE::GENERIC`
	)

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

The infobar will be closed after a timeout.

Parameters

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

Definition at line 1056 of file eda_base_frame.cpp.

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), MICROWAVE_TOOL::createInductorBetween(), DESIGN_BLOCK_PANE::createNewDesignBlockLibrary(), PCB_BASE_EDIT_FRAME::createNewLibrary(), MICROWAVE_TOOL::createPolygonShape(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), DESIGN_BLOCK_PANE::DeleteDesignBlockFromLibrary(), DESIGN_BLOCK_PANE::DeleteDesignBlockLibrary(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), EDIT_TOOL::DeleteItems(), BOARD_INSPECTION_TOOL::DiffFootprint(), SCH_INSPECTION_TOOL::DiffSymbol(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), DRAWING_TOOL::DrawVia(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), DESIGN_BLOCK_PANE::EditDesignBlockProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), ExportSymbol(), SCH_NAVIGATE_TOOL::HypertextCommand(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), SCH_EDIT_FRAME::LoadDrawingSheet(), PCB_EDIT_FRAME::LoadDrawingSheet(), ROUTER_TOOL::prepareInteractive(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), saveLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), SCH_INSPECTION_TOOL::ShowDatasheet(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields(), SCH_PROPERTIES_PANEL::valueChanging(), and PCB_PROPERTIES_PANEL::valueChanging().

◆ ShowInfoBarMsg()

void EDA_BASE_FRAME::ShowInfoBarMsg	(	const wxString &	aMsg,
		bool	aShowCloseButton = `false`
	)

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters

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

Definition at line 1094 of file eda_base_frame.cpp.

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_MOVE_TOOL::doMoveSelection(), SCH_DRAWING_TOOLS::DrawSheet(), PL_EDIT_TOOL::Main(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceNextSymbolUnit(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DIALOG_FIND::search(), SCH_DRAWING_TOOLS::SyncAllSheetsPins(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ShowInfoBarWarning()

void EDA_BASE_FRAME::ShowInfoBarWarning	(	const wxString &	aWarningMsg,
		bool	aShowCloseButton = `false`
	)

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters

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

Definition at line 1083 of file eda_base_frame.cpp.

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by DRAWING_TOOL::PlaceTuningPattern(), SCH_EDIT_TOOL::RepeatDrawItem(), and FOOTPRINT_EDITOR_CONTROL::tryToSaveFootprintInLibrary().

◆ 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, SYMBOL_CHOOSER_FRAME, and SYMBOL_DIFF_FRAME.

Definition at line 95 of file kiway_player.cpp.

References KIWAY_PLAYER::IsModal(), KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_resultant_parent, KIWAY_PLAYER::m_modal_ret_val, and KIWAY_PLAYER::m_modal_string.

Referenced by FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_CHOOSER_FRAME::ShowModal(), and SYMBOL_CHOOSER_FRAME::ShowModal().

◆ ShowPreferences()

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

inherited

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

Definition at line 1194 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(), KIFACE_BASE::GetActions(), ADVANCED_CFG::GetCfg(), EDA_BASE_FRAME::GetFrameType(), PGM_BASE::GetSettingsManager(), PAGED_DIALOG::GetTreebook(), HOTKEYS_CHANGED, KICAD_MANAGER_FRAME_NAME, kiface(), KIWAY::KiFACE(), KIWAY_HOLDER::Kiway(), LAZY_CTOR, TOOLS_HOLDER::m_toolManager, name, PANEL_3DV_DISPLAY_OPTIONS, PANEL_3DV_OPENGL, PANEL_3DV_RAYTRACING, PANEL_3DV_TOOLBARS, PANEL_DS_COLORS, PANEL_DS_DISPLAY_OPTIONS, PANEL_DS_GRIDS, PANEL_DS_TOOLBARS, PANEL_FP_COLORS, PANEL_FP_DEFAULT_FIELDS, PANEL_FP_DEFAULT_GRAPHICS_VALUES, PANEL_FP_DISPLAY_OPTIONS, PANEL_FP_EDIT_OPTIONS, PANEL_FP_GRIDS, PANEL_FP_ORIGINS_AXES, PANEL_FP_TOOLBARS, PANEL_GBR_COLORS, PANEL_GBR_DISPLAY_OPTIONS, PANEL_GBR_EXCELLON_OPTIONS, PANEL_GBR_GRIDS, PANEL_GBR_TOOLBARS, PANEL_PCB_ACTION_PLUGINS, PANEL_PCB_COLORS, PANEL_PCB_DISPLAY_OPTS, PANEL_PCB_EDIT_OPTIONS, PANEL_PCB_GRIDS, PANEL_PCB_ORIGINS_AXES, PANEL_PCB_TOOLBARS, PANEL_SCH_ANNO_OPTIONS, PANEL_SCH_COLORS, PANEL_SCH_DISP_OPTIONS, PANEL_SCH_EDIT_OPTIONS, PANEL_SCH_FIELD_NAME_TEMPLATES, PANEL_SCH_GRIDS, PANEL_SCH_SIMULATOR, PANEL_SCH_TOOLBARS, PANEL_SYM_COLORS, PANEL_SYM_DISP_OPTIONS, PANEL_SYM_EDIT_GRIDS, PANEL_SYM_EDIT_OPTIONS, PANEL_SYM_TOOLBARS, Pgm(), ReadHotKeyConfigIntoActions(), TOOL_BASE::REDRAW, TOOL_MANAGER::ResetTools(), SETTINGS_MANAGER::Save(), PAGED_DIALOG::SetInitialPage(), and DIALOG_SHIM::ShowModal().

Referenced by COMMON_TOOLS::GridProperties(), EDA_BASE_FRAME::OnPreferences(), APPEARANCE_CONTROLS::onReadOnlySwatch(), and COMMON_CONTROL::OpenPreferences().

◆ storeCurrentSymbol()

void SYMBOL_EDIT_FRAME::storeCurrentSymbol ( )

private

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

Definition at line 1339 of file symbol_edit_frame.cpp.

References GetCurLib(), SCH_BASE_FRAME::GetScreen(), IsContentModified(), m_libMgr, m_symbol, and SYMBOL_LIBRARY_MANAGER::UpdateSymbol().

Referenced by OnModify().

◆ StringFromOptionalValue()

wxString UNITS_PROVIDER::StringFromOptionalValue	(	std::optional< int >	aValue,
		bool	aAddUnitLabel = `false`,
		EDA_DATA_TYPE	aType = `EDA_DATA_TYPE::DISTANCE`
	)		const

inlineinherited

Converts an optional aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters

aValue	= optional value in internal units
aAddUnitLabel	= true to add symbol unit to the string value
aType	is the type of this value, and controls the way the value is converted to a string, and the suitable unit

Returns: A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 100 of file units_provider.h.

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUnitsFromType(), UNITS_PROVIDER::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(), EDA_UNIT_UTILS::UI::StringFromValue(), and unityScale.

◆ StringFromValue() [2/2]

wxString UNITS_PROVIDER::StringFromValue	(	double	aValue,
		bool	aAddUnitLabel = `false`,
		EDA_DATA_TYPE	aType = `EDA_DATA_TYPE::DISTANCE`
	)		const

inlineinherited

Converts aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters

aValue	= value in internal units
aAddUnitLabel	= true to add symbol unit to the string value
aType	is the type of this value, and controls the way the value is converted to a string, and the suitable unit

Returns: A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 79 of file units_provider.h.

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUnitsFromType(), and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by DIALOG_PLOT::applyPlotSettings(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PAD::doCheckPad(), PIN_INFO_FORMATTER::Format(), VALIDATION_ERROR_TOO_LARGE< T >::Format(), VALIDATION_ERROR_TOO_SMALL< T >::Format(), formatBBox(), DRC_TEST_PROVIDER::formatMsg(), FIELDS_GRID_TABLE::GetValue(), PCB_FIELDS_GRID_TABLE::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), PCB_CONTROL::PlaceStackup(), reportMax(), reportMin(), reportOpt(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::TransferDataFromWindow(), PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate(), and PANEL_SETUP_NETCLASSES::validateNetclassClearance().

◆ SVGPlotSymbol()

void SYMBOL_EDIT_FRAME::SVGPlotSymbol	(	const wxString &	aFullFileName,
		const VECTOR2I &	aOffset
	)

Create the SVG print file for the current edited symbol.

Parameters

aFullFileName	is the full filename
aOffset	is a plot offset, in iu

Definition at line 31 of file symbol_editor_plotter.cpp.

References SVG_PLOTTER::EndPlot(), GetBodyStyle(), GetColorSettings(), SCH_SCREEN::GetPageSettings(), SCH_BASE_FRAME::GetRenderSettings(), SCH_BASE_FRAME::GetScreen(), GetUnit(), EDA_IU_SCALE::IU_PER_MILS, SCH_RENDER_SETTINGS::LoadColors(), m_symbol, PLOTTER::OpenFile(), LIB_SYMBOL::Plot(), LIB_SYMBOL::PlotFields(), scale, schIUScale, PLOTTER::SetColorMode(), PLOTTER::SetCreator(), KIGFX::RENDER_SETTINGS::SetDefaultPenWidth(), PLOTTER::SetPageSettings(), PLOTTER::SetRenderSettings(), SVG_PLOTTER::SetViewport(), and SVG_PLOTTER::StartPlot().

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

References SCH_BASE_FRAME::GetCanvas(), COLOR_SETTINGS::GetColor(), 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().

◆ SynchronizePins()

bool SYMBOL_EDIT_FRAME::SynchronizePins ( )

Definition at line 1071 of file symbol_edit_frame.cpp.

References LIB_SYMBOL::IsMulti(), m_symbol, m_SyncPinEdit, and LIB_SYMBOL::UnitsLocked().

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SYMBOL_EDITOR_PIN_TOOL::CreatePin(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), and SYMBOL_EDITOR_PIN_TOOL::RepeatPin().

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

References _, LIB_TREE::CenterLibId(), LIB_SYMBOL_LIBRARY_MANAGER::GetAdapter(), GetCurLib(), GetLibTree(), LIB_SYMBOL::GetName(), LIB_TREE::GetSelectedLibId(), LIB_ID::IsValid(), m_libMgr, m_symbol, m_treePane, LIB_TREE::Regenerate(), LIB_TREE::SelectLibId(), LIB_ID::SetLibItemName(), LIB_SYMBOL_LIBRARY_MANAGER::Sync(), LIB_TREE::Unselect(), and APP_PROGRESS_DIALOG::Update().

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

◆ SyncView()

void SCH_BASE_FRAME::SyncView ( )

inherited

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

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

◆ ThawLibraryTree()

void SYMBOL_EDIT_FRAME::ThawLibraryTree ( )

Definition at line 785 of file symbol_edit_frame.cpp.

References LIB_SYMBOL_LIBRARY_MANAGER::GetAdapter(), 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 709 of file eda_base_frame.cpp.

References ClearScaledBitmapCache(), and EDA_BASE_FRAME::m_auimgr.

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

◆ ToggleLibraryTree()

void SYMBOL_EDIT_FRAME::ToggleLibraryTree ( )

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 756 of file symbol_edit_frame.cpp.

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

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

◆ ToggleProperties()

void SYMBOL_EDIT_FRAME::ToggleProperties ( )

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 730 of file symbol_edit_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, SYMBOL_EDITOR_SETTINGS::m_AuiPanels, EDA_DRAW_FRAME::m_propertiesPanel, m_settings, SYMBOL_EDITOR_SETTINGS::AUI_PANELS::properties_panel_width, EDA_DRAW_FRAME::PropertiesPaneName(), Refresh(), SetAuiPaneSize(), and updateSelectionFilterVisbility().

◆ ToggleUserUnits()

void EDA_DRAW_FRAME::ToggleUserUnits ( )

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 314 of file eda_draw_frame.cpp.

References dummy, TOOL_MANAGER::GetTool(), UNITS_PROVIDER::GetUserUnits(), TOOLS_HOLDER::m_toolManager, UNITS_PROVIDER::SetUserUnits(), and EDA_DRAW_FRAME::unitsChangeRefresh().

◆ ToolStackIsEmpty()

bool TOOLS_HOLDER::ToolStackIsEmpty ( )

inlineinherited

◆ 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 PCB_BASE_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 302 of file eda_draw_frame.cpp.

References TOOLS_HOLDER::m_toolManager, TOOL_MANAGER::RunAction(), EDA_DRAW_FRAME::UpdateMsgPanel(), EDA_DRAW_FRAME::UpdateProperties(), EDA_DRAW_FRAME::UpdateStatusBar(), and ACTIONS::updateUnits.

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

◆ UnregisterUIUpdateHandler() [1/2]

void TOOLS_HOLDER::UnregisterUIUpdateHandler ( const TOOL_ACTION & aAction )

virtualinherited

Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.

Parameters

aAction is the action to unregister the handler for.

Definition at line 50 of file tools_holder.cpp.

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

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

◆ UnregisterUIUpdateHandler() [2/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 399 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::m_uiUpdateMap.

◆ UpdateAfterSymbolProperties()

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

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

References FILE_HISTORY::AddFileToHistory(), EDA_BASE_FRAME::m_fileHistory, EDA_BASE_FRAME::m_isClosing, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by SCH_EDIT_FRAME::doCloseWindow(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), BITMAP2CMP_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), EDA_BASE_FRAME::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 397 of file eda_draw_frame.cpp.

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

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

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

References SCH_BASE_FRAME::UpdateItem().

Referenced by FocusOnItem(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SYMBOL_EDITOR_EDIT_TOOL::Swap().

◆ UpdateLibraryTree()

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

Update a symbol node in the library tree.

Definition at line 1306 of file symbol_edit_frame.cpp.

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

Referenced by SYMBOL_EDITOR_CONTROL::RenameSymbol().

◆ UpdateMsgPanel()

void SYMBOL_EDIT_FRAME::UpdateMsgPanel ( )

inlineoverridevirtual

Redraw the message panel.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 248 of file symbol_edit_frame.h.

References UpdateSymbolMsgPanelInfo().

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

◆ UpdateProperties()

void EDA_DRAW_FRAME::UpdateProperties ( )

inherited

Definition at line 1244 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_isClosing, EDA_DRAW_FRAME::m_propertiesPanel, and PROPERTIES_PANEL::UpdateData().

Referenced by SCH_EDIT_FRAME::unitsChangeRefresh(), EDA_DRAW_FRAME::unitsChangeRefresh(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), 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 1989 of file symbol_edit_frame.cpp.

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

Referenced by ToggleLibraryTree(), and ToggleProperties().

◆ UpdateStatusBar()

void SCH_BASE_FRAME::UpdateStatusBar ( )

overridevirtualinherited

Update the status bar information.

The status bar can draw itself. This is not a drawing function per se, but rather updates lines of text held by the components within the status bar which is owned by the wxFrame.

Reimplemented from EDA_BASE_FRAME.

Definition at line 199 of file sch_base_frame.cpp.

References EDA_DRAW_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), SCH_BASE_FRAME::GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), SCH_BASE_FRAME::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 713 of file eda_draw_frame.cpp.

References _, arrayDim(), and KIUI::GetTextSize().

◆ UpdateSymbolMsgPanelInfo()

void SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo ( )

Display the documentation of the selected symbol.

Definition at line 1754 of file symbol_editor.cpp.

References _, EDA_DRAW_FRAME::AppendMsgPanel(), EDA_DRAW_FRAME::ClearMsgPanel(), LIB_SYMBOL::GetDatasheetField(), LIB_SYMBOL::GetDescription(), LIB_SYMBOL::GetKeyWords(), LIB_SYMBOL::GetName(), LIB_SYMBOL::GetParent(), EDA_TEXT::GetText(), LIB_SYMBOL::IsDerived(), LIB_SYMBOL::IsGlobalPower(), LIB_SYMBOL::IsLocalPower(), m_bodyStyle, m_symbol, m_unit, and UnescapeString().

Referenced by ClearMsgPanel(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), LoadSymbolFromSchematic(), SetUnit(), 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 57 of file symbol_editor.cpp.

References _, Format(), GetCurLib(), GetCurSymbol(), SCH_BASE_FRAME::GetScreen(), IsContentModified(), SYMBOL_LIBRARY_MANAGER::IsLibraryReadOnly(), IsSymbolFromSchematic(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), m_libMgr, m_reference, and UnescapeString().

Referenced by CanCloseSymbolFromSchematic(), GetSymbolFromRedoList(), GetSymbolFromUndoList(), LoadOneLibrarySymbolAux(), LoadSymbolFromSchematic(), OnModify(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), Save(), saveAllLibraries(), SelectActiveLibrary(), ShowChangedLanguage(), and UpdateAfterSymbolProperties().

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

References EDA_BASE_FRAME::m_tbLeft, EDA_BASE_FRAME::m_tbRight, EDA_BASE_FRAME::m_tbTopAux, EDA_BASE_FRAME::m_tbTopMain, and ACTION_TOOLBAR::UpdateControlWidths().

Referenced by 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 568 of file eda_draw_frame.cpp.

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

Referenced by EDA_DRAW_FRAME::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 152 of file units_provider.h.

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

Referenced by PIN_TABLE_DATA_MODEL::compare(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), WX_GRID::GetUnitValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onCopperLayersSelCount(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortDiffPairsClick(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortTrackWidthsClick(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortViaSizesClick(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), FIELDS_GRID_TABLE::SetValue(), PCB_FIELDS_GRID_TABLE::SetValue(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PIN_INFO_FORMATTER::UpdatePin(), and DIALOG_FOOTPRINT_PROPERTIES::Validate().

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

References EDA_BASE_FRAME::canCloseWindow(), EDA_BASE_FRAME::config(), WX_INFOBAR::Dismiss(), EDA_BASE_FRAME::doCloseWindow(), EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::IsModal(), EDA_BASE_FRAME::m_infoBar, EDA_BASE_FRAME::m_isClosing, EDA_BASE_FRAME::m_isNonUserClose, and EDA_BASE_FRAME::SaveSettings().

Referenced by EDA_BASE_FRAME::commonInit(), and EDA_BASE_FRAME::~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 1020 of file eda_draw_frame.cpp.

References TOOLS_HOLDER::m_toolManager, TOOL_MANAGER::RunAction(), and ACTIONS::zoomFitScreen.

Referenced by PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), PCB_CONTROL::DdImportFootprint(), GERBVIEW_FRAME::LoadFileOrShowDialog(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadZipArchiveFile(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PCB_EDIT_FRAME::OnBoardLoaded(), GERBVIEW_FRAME::OpenProjectFiles(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and FOOTPRINT_WIZARD_FRAME::SelectFootprintWizard().

Member Data Documentation

◆ KICAD_AUI_TB_STYLE

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

Referenced by EDA_BASE_FRAME::RecreateToolbars().

◆ m_aboutTitle

wxString EDA_BASE_FRAME::m_aboutTitle

protectedinherited

Definition at line 790 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_BASE_FRAME::GetAboutTitle(), EDA_BASE_FRAME::GetUntranslatedAboutTitle(), and SYMBOL_DIFF_FRAME::SYMBOL_DIFF_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 829 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::DoWithAcceptedFiles(), GERBVIEW_FRAME::DoWithAcceptedFiles(), KICAD_MANAGER_FRAME::DoWithAcceptedFiles(), GERBVIEW_FRAME::GERBVIEW_FRAME(), and EDA_BASE_FRAME::OnDropFiles().

◆ m_AcceptedFiles

std::vector<wxFileName> EDA_BASE_FRAME::m_AcceptedFiles

protectedinherited

Definition at line 739 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::DoWithAcceptedFiles(), GERBVIEW_FRAME::DoWithAcceptedFiles(), KICAD_MANAGER_FRAME::DoWithAcceptedFiles(), PL_EDITOR_FRAME::DoWithAcceptedFiles(), and EDA_BASE_FRAME::OnDropFiles().

◆ m_actions

ACTIONS* TOOLS_HOLDER::m_actions

protectedinherited

Definition at line 172 of file tools_holder.h.

◆ m_appearancePanel

APPEARANCE_CONTROLS_3D* EDA_BASE_FRAME::m_appearancePanel

protectedinherited

Definition at line 795 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_auimgr

wxAuiManager EDA_BASE_FRAME::m_auimgr

protectedinherited

Definition at line 792 of file eda_base_frame.h.

◆ m_autoSavePending

bool EDA_BASE_FRAME::m_autoSavePending

protectedinherited

Definition at line 803 of file eda_base_frame.h.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::DoAutoSave(), SCH_EDIT_FRAME::doAutoSave(), and EDA_BASE_FRAME::ProcessEvent().

◆ m_autoSaveRequired

bool EDA_BASE_FRAME::m_autoSaveRequired

protectedinherited

Definition at line 804 of file eda_base_frame.h.

Referenced by PCB_EDIT_FRAME::DoAutoSave(), SCH_EDIT_FRAME::doAutoSave(), EDA_BASE_FRAME::isAutoSaveRequired(), EDA_BASE_FRAME::OnModify(), PCB_EDIT_FRAME::SaveBoard(), and SCH_EDIT_FRAME::SaveProject().

◆ m_autoSaveTimer

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer

protectedinherited

Definition at line 805 of file eda_base_frame.h.

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

◆ m_base_frame_defaults

SCHEMATIC_SETTINGS SCH_BASE_FRAME::m_base_frame_defaults

protectedinherited

These are only used by symbol_editor.

Eeschema should be using the one inside the SCHEMATIC.

Definition at line 300 of file sch_base_frame.h.

◆ m_bodyStyle

int SYMBOL_EDIT_FRAME::m_bodyStyle

private

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

Definition at line 564 of file symbol_edit_frame.h.

Referenced by GetBodyStyle(), GetDocumentExtents(), LoadOneLibrarySymbolAux(), LoadSymbolFromSchematic(), RebuildView(), SetBodyStyle(), SetCurSymbol(), setupUIConditions(), and UpdateSymbolMsgPanelInfo().

◆ m_canvas

EDA_DRAW_PANEL_GAL* EDA_DRAW_FRAME::m_canvas

privateinherited

Definition at line 610 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_FRAME::GetZoomLevelIndicator(), EDA_DRAW_FRAME::OnMove(), EDA_DRAW_FRAME::OnSelectGrid(), EDA_DRAW_FRAME::OnSelectZoom(), EDA_DRAW_FRAME::SetCanvas(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), and EDA_DRAW_FRAME::~EDA_DRAW_FRAME().

◆ m_canvasType

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::m_canvasType

protectedinherited

The current canvas type.

Definition at line 603 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::createCanvas(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_DRAW_FRAME::resolveCanvasType(), FOOTPRINT_EDIT_FRAME::resolveCanvasType(), EDA_DRAW_FRAME::SwitchCanvas(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), PCB_BASE_FRAME::~PCB_BASE_FRAME(), PL_EDITOR_FRAME::~PL_EDITOR_FRAME(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ m_centerItemOnIdle

LIB_ID SYMBOL_EDIT_FRAME::m_centerItemOnIdle

private

Definition at line 558 of file symbol_edit_frame.h.

Referenced by centerItemIdleHandler(), and LoadSymbol().

◆ m_colorSettings

COLOR_SETTINGS* EDA_DRAW_FRAME::m_colorSettings

protectedinherited

Definition at line 595 of file eda_draw_frame.h.

Referenced by SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME::GetColorSettings(), SCH_BASE_FRAME::GetColorSettings(), SwitchCanvas(), and SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME().

◆ m_configName

wxString EDA_BASE_FRAME::m_configName

protectedinherited

Definition at line 796 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::ConfigBaseName().

◆ m_currentScreen

BASE_SCREEN* EDA_DRAW_FRAME::m_currentScreen

privateinherited

current used SCREEN

Definition at line 609 of file eda_draw_frame.h.

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

◆ m_displayIndex

int EDA_BASE_FRAME::m_displayIndex

protectedinherited

Definition at line 784 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::LoadWindowState(), and EDA_BASE_FRAME::OnSize().

◆ m_dragAction

MOUSE_DRAG_ACTION TOOLS_HOLDER::m_dragAction

protectedinherited

Definition at line 188 of file tools_holder.h.

Referenced by TOOLS_HOLDER::CommonSettingsChanged(), and TOOLS_HOLDER::GetDragAction().

◆ m_drawBgColor

COLOR4D EDA_DRAW_FRAME::m_drawBgColor

protectedinherited

Definition at line 576 of file eda_draw_frame.h.

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

◆ m_dummyScreen

SCH_SCREEN* SYMBOL_EDIT_FRAME::m_dummyScreen

private

< Helper screen used when no symbol is loaded

Definition at line 548 of file symbol_edit_frame.h.

Referenced by emptyScreen(), KiwayMailIn(), LoadOneLibrarySymbolAux(), and ~SYMBOL_EDIT_FRAME().

◆ m_dummySelection

SELECTION TOOLS_HOLDER::m_dummySelection

protectedinherited

Definition at line 175 of file tools_holder.h.

Referenced by TOOLS_HOLDER::GetCurrentSelection().

◆ m_file_checker

std::unique_ptr<LOCKFILE> EDA_DRAW_FRAME::m_file_checker

protectedinherited

Definition at line 573 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::LockFile(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), and EDA_DRAW_FRAME::ReleaseFile().

◆ m_fileHistory

FILE_HISTORY* EDA_BASE_FRAME::m_fileHistory

protectedinherited

Definition at line 801 of file eda_base_frame.h.

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

◆ m_findReplaceData

std::unique_ptr<EDA_SEARCH_DATA> EDA_DRAW_FRAME::m_findReplaceData

protectedinherited

Definition at line 588 of file eda_draw_frame.h.

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), EDA_DRAW_FRAME::GetFindReplaceData(), SCH_EDIT_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), SCH_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), and SCH_EDIT_FRAME::ShowFindReplaceDialog().

◆ m_findStringHistoryList

wxArrayString EDA_DRAW_FRAME::m_findStringHistoryList

protectedinherited

Definition at line 589 of file eda_draw_frame.h.

Referenced by SCH_EDIT_FRAME::doCloseWindow(), EDA_DRAW_FRAME::GetFindHistoryList(), EDA_DRAW_FRAME::LoadSettings(), SCH_EDIT_FRAME::OnFindDialogClose(), EDA_DRAW_FRAME::SaveSettings(), and SCH_EDIT_FRAME::ShowFindReplaceDialog().

◆ m_framePos

wxPoint EDA_BASE_FRAME::m_framePos

protectedinherited

Definition at line 781 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::LoadWindowState(), and EDA_BASE_FRAME::SaveWindowSettings().

◆ m_frameSize

wxSize EDA_BASE_FRAME::m_frameSize

protectedinherited

Definition at line 782 of file eda_base_frame.h.

Referenced by SCH_BASE_FRAME::createCanvas(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_BASE_FRAME::LoadWindowState(), EDA_DRAW_FRAME::OnSize(), and EDA_BASE_FRAME::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 613 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME::GetGalDisplayOptions(), EDA_DRAW_FRAME::LoadSettings(), EDA_DRAW_FRAME::OnMove(), and EDA_DRAW_FRAME::SaveSettings().

◆ m_gridColor

COLOR4D EDA_DRAW_FRAME::m_gridColor

protectedinherited

Definition at line 575 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::GetGridColor(), EDA_DRAW_FRAME::SetGridColor(), and GERBVIEW_FRAME::SetGridColor().

◆ m_gridSelectBox

wxChoice* EDA_DRAW_FRAME::m_gridSelectBox

protectedinherited

Definition at line 585 of file eda_draw_frame.h.

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

◆ m_hotkeyPopup

HOTKEY_CYCLE_POPUP* EDA_DRAW_FRAME::m_hotkeyPopup

protectedinherited

Definition at line 600 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::CreateHotkeyPopup(), and EDA_DRAW_FRAME::GetHotkeyPopup().

◆ m_ident

FRAME_T EDA_BASE_FRAME::m_ident

protectedinherited

Definition at line 780 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::GetFrameType(), EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::IsType(), EDA_BASE_FRAME::LoadWindowState(), and EDA_DRAW_FRAME::saveCanvasTypeSetting().

◆ m_immediateActions

bool TOOLS_HOLDER::m_immediateActions

protectedinherited

Definition at line 184 of file tools_holder.h.

Referenced by TOOLS_HOLDER::CommonSettingsChanged(), and TOOLS_HOLDER::GetDoImmediateActions().

◆ m_infoBar

WX_INFOBAR* EDA_BASE_FRAME::m_infoBar

protectedinherited

◆ m_inSymChangeTimerEvent

bool SCH_BASE_FRAME::m_inSymChangeTimerEvent

privateinherited

Definition at line 311 of file sch_base_frame.h.

Referenced by SCH_BASE_FRAME::OnSymChangeDebounceTimer().

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

Referenced by EDA_DRAW_FRAME::AppendMsgPanel(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), EDA_DRAW_FRAME::ClearMsgPanel(), EDA_DRAW_FRAME::DisplayConstraintsMsg(), EDA_DRAW_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayToolMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), GERBVIEW_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), IsSymbolFromSchematic(), SCH_EDIT_FRAME::OnModify(), OnModify(), PCB_BASE_FRAME::OnModify(), PL_EDITOR_FRAME::OnModify(), FOOTPRINT_EDIT_FRAME::OnModify(), PCB_EDIT_FRAME::OnModify(), EDA_BASE_FRAME::ProcessEvent(), EDA_BASE_FRAME::ReCreateMenuBar(), EDA_BASE_FRAME::SaveSettings(), KICAD_MANAGER_FRAME::SaveSettings(), EDA_DRAW_FRAME::SetMsgPanel(), EDA_BASE_FRAME::UpdateFileHistory(), EDA_DRAW_FRAME::UpdateProperties(), EDA_DRAW_FRAME::UpdateStatusBar(), and EDA_BASE_FRAME::windowClosing().

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

Referenced by EDA_BASE_FRAME::NonUserClose(), EDA_BASE_FRAME::SaveSettings(), and EDA_BASE_FRAME::windowClosing().

◆ m_isSymbolFromSchematic

bool SYMBOL_EDIT_FRAME::m_isSymbolFromSchematic

private

Definition at line 567 of file symbol_edit_frame.h.

Referenced by canCloseWindow(), IsSymbolFromSchematic(), LoadOneLibrarySymbolAux(), LoadSymbolFromSchematic(), and ~SYMBOL_EDIT_FRAME().

◆ m_iuScale

const EDA_IU_SCALE& UNITS_PROVIDER::m_iuScale

privateinherited

Definition at line 251 of file units_provider.h.

Referenced by UNITS_PROVIDER::GetIuScale().

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway

privateinherited

Definition at line 86 of file kiway_holder.h.

Referenced by KIWAY_HOLDER::SetKiway().

◆ m_lastToolbarIconSize

int EDA_DRAW_FRAME::m_lastToolbarIconSize

privateinherited

Definition at line 615 of file eda_draw_frame.h.

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

◆ m_libMgr

LIB_SYMBOL_LIBRARY_MANAGER* SYMBOL_EDIT_FRAME::m_libMgr

private

◆ m_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault

protectedinherited

Definition at line 783 of file eda_base_frame.h.

Referenced by GERBVIEW_FRAME::GERBVIEW_FRAME(), and EDA_BASE_FRAME::LoadWindowState().

◆ m_messagePanel

EDA_MSG_PANEL* EDA_DRAW_FRAME::m_messagePanel

protectedinherited

Definition at line 592 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::AppendMsgPanel(), EDA_DRAW_FRAME::ClearMsgPanel(), EDA_DRAW_FRAME::EraseMsgBox(), FOOTPRINT_CHOOSER_FRAME::FOOTPRINT_CHOOSER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_DRAW_FRAME::handleActivateEvent(), EDA_DRAW_FRAME::SetMsgPanel(), SYMBOL_CHOOSER_FRAME::SYMBOL_CHOOSER_FRAME(), and SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME().

◆ m_modal

bool KIWAY_PLAYER::m_modal

protectedinherited

Definition at line 190 of file kiway_player.h.

Referenced by KIWAY_PLAYER::IsModal(), and KIWAY_PLAYER::SetModal().

◆ m_modal_loop

wxGUIEventLoop* KIWAY_PLAYER::m_modal_loop

protectedinherited

Points to nested event_loop. NULL means not modal and dismissed.

Definition at line 193 of file kiway_player.h.

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

◆ m_modal_resultant_parent

wxWindow* KIWAY_PLAYER::m_modal_resultant_parent

protectedinherited

Definition at line 194 of file kiway_player.h.

Referenced by KIWAY_PLAYER::ShowModal().

◆ m_modal_ret_val

bool KIWAY_PLAYER::m_modal_ret_val

protectedinherited

Definition at line 196 of file kiway_player.h.

Referenced by KIWAY_PLAYER::DismissModal(), FOOTPRINT_WIZARD_FRAME::GetBuiltFootprint(), and KIWAY_PLAYER::ShowModal().

◆ m_modal_string

wxString KIWAY_PLAYER::m_modal_string

protectedinherited

Definition at line 195 of file kiway_player.h.

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

◆ m_moveWarpsCursor

bool TOOLS_HOLDER::m_moveWarpsCursor

protectedinherited

Definition at line 190 of file tools_holder.h.

Referenced by TOOLS_HOLDER::CommonSettingsChanged(), and TOOLS_HOLDER::GetMoveWarpsCursor().

◆ m_mruPath

wxString EDA_BASE_FRAME::m_mruPath

protectedinherited

Definition at line 812 of file eda_base_frame.h.

Referenced by FOOTPRINT_EDIT_FRAME::ExportFootprint(), BITMAP2CMP_FRAME::ExportPcbnewFormat(), ExportSymbol(), EDA_BASE_FRAME::GetMruPath(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), ImportSymbol(), GERBVIEW_FRAME::LoadFileOrShowDialog(), GERBVIEW_FRAME::LoadGerberJobFile(), SCH_EDIT_FRAME::LoadProject(), EDA_BASE_FRAME::LoadWindowSettings(), GERBVIEW_FRAME::LoadZipArchiveFile(), SCH_EDIT_FRAME::NewProject(), BITMAP2CMP_FRAME::OnLoadFile(), GERBVIEW_FRAME::OpenProjectFiles(), EDA_BASE_FRAME::SaveWindowSettings(), and EDA_BASE_FRAME::SetMruPath().

◆ m_msgFrameHeight

int EDA_DRAW_FRAME::m_msgFrameHeight

protectedinherited

Definition at line 593 of file eda_draw_frame.h.

◆ m_netInspectorPanel

NET_INSPECTOR_PANEL* EDA_DRAW_FRAME::m_netInspectorPanel

protectedinherited

Definition at line 598 of file eda_draw_frame.h.

Referenced by PCB_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::OnBoardLoaded(), PCB_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::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 787 of file eda_base_frame.h.

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

◆ m_normalFrameSize

wxSize EDA_BASE_FRAME::m_normalFrameSize

protectedinherited

Definition at line 788 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::LoadWindowState(), EDA_BASE_FRAME::OnMaximize(), and EDA_BASE_FRAME::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 605 of file eda_draw_frame.h.

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

◆ m_originTransforms

ORIGIN_TRANSFORMS EDA_BASE_FRAME::m_originTransforms

protectedinherited

Definition at line 814 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::GetOriginTransforms().

◆ m_perspective

wxString EDA_BASE_FRAME::m_perspective

protectedinherited

Definition at line 793 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::LoadWindowSettings().

◆ m_polarCoords

bool EDA_DRAW_FRAME::m_polarCoords

protectedinherited

Definition at line 580 of file eda_draw_frame.h.

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

◆ m_propertiesPanel

PROPERTIES_PANEL* EDA_DRAW_FRAME::m_propertiesPanel

protectedinherited

Definition at line 597 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::GetPropertiesPanel(), SCH_EDIT_FRAME::SaveSettings(), SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), PCB_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::ShowChangedLanguage(), EDA_DRAW_FRAME::ShowChangedLanguage(), PCB_EDIT_FRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ToggleProperties(), ToggleProperties(), PCB_BASE_EDIT_FRAME::ToggleProperties(), and EDA_DRAW_FRAME::UpdateProperties().

◆ m_redoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_redoList

protectedinherited

Definition at line 810 of file eda_base_frame.h.

Referenced by SCH_EDIT_FRAME::ClearUndoORRedoList(), ClearUndoORRedoList(), PL_EDITOR_FRAME::ClearUndoORRedoList(), PCB_BASE_EDIT_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetRedoActionDescription(), EDA_BASE_FRAME::GetRedoCommandCount(), EDA_BASE_FRAME::PopCommandFromRedoList(), and EDA_BASE_FRAME::PushCommandToRedoList().

◆ m_reference

wxString SYMBOL_EDIT_FRAME::m_reference

private

Definition at line 571 of file symbol_edit_frame.h.

Referenced by CanCloseSymbolFromSchematic(), LoadSymbolFromSchematic(), SetCurSymbol(), and UpdateTitle().

◆ m_replaceStringHistoryList

wxArrayString EDA_DRAW_FRAME::m_replaceStringHistoryList

protectedinherited

Definition at line 590 of file eda_draw_frame.h.

Referenced by SCH_EDIT_FRAME::doCloseWindow(), EDA_DRAW_FRAME::LoadSettings(), SCH_EDIT_FRAME::OnFindDialogClose(), EDA_DRAW_FRAME::SaveSettings(), and SCH_EDIT_FRAME::ShowFindReplaceDialog().

◆ m_schematicSymbolUUID

KIID SYMBOL_EDIT_FRAME::m_schematicSymbolUUID

private

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

Definition at line 568 of file symbol_edit_frame.h.

Referenced by CanCloseSymbolFromSchematic(), LoadSymbolFromSchematic(), and saveCurrentSymbol().

◆ m_searchPane

SEARCH_PANE* EDA_DRAW_FRAME::m_searchPane

protectedinherited

Definition at line 596 of file eda_draw_frame.h.

Referenced by SCH_EDIT_FRAME::FocusSearch(), PCB_EDIT_FRAME::FocusSearch(), SCH_EDIT_FRAME::SaveSettings(), PCB_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ToggleSearch(), and PCB_EDIT_FRAME::ToggleSearch().

◆ m_selectionFilterPanel

PANEL_SCH_SELECTION_FILTER* SCH_BASE_FRAME::m_selectionFilterPanel

protectedinherited

Definition at line 302 of file sch_base_frame.h.

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

◆ m_settings

SYMBOL_EDITOR_SETTINGS* SYMBOL_EDIT_FRAME::m_settings

private

Definition at line 556 of file symbol_edit_frame.h.

Referenced by GetSettings(), LoadSettings(), SaveSettings(), and ToggleProperties().

◆ m_settingsManager

SETTINGS_MANAGER* EDA_BASE_FRAME::m_settingsManager

protectedinherited

Definition at line 799 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::GetSettingsManager().

◆ m_showBorderAndTitleBlock

bool EDA_DRAW_FRAME::m_showBorderAndTitleBlock

protectedinherited

Definition at line 583 of file eda_draw_frame.h.

Referenced by GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_BASE_FRAME::GetBoardBoundingBox(), EDA_DRAW_FRAME::PrintDrawingSheet(), and GERBVIEW_FRAME::SetElementVisibility().

◆ m_showDeMorgan

bool SYMBOL_EDIT_FRAME::m_showDeMorgan = false

staticprivate

Definition at line 576 of file symbol_edit_frame.h.

Referenced by GetShowDeMorgan(), and SetShowDeMorgan().

◆ m_sockets

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

protectedinherited

Definition at line 199 of file kiway_player.h.

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

◆ m_socketServer

wxSocketServer* EDA_DRAW_FRAME::m_socketServer

protectedinherited

Prevents opening same file multiple times.

Definition at line 570 of file eda_draw_frame.h.

◆ m_spaceMouse

std::unique_ptr<NL_SCHEMATIC_PLUGIN> SCH_BASE_FRAME::m_spaceMouse

privateinherited

Definition at line 313 of file sch_base_frame.h.

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

◆ m_supportsAutoSave

bool EDA_BASE_FRAME::m_supportsAutoSave

protectedinherited

Definition at line 802 of file eda_base_frame.h.

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

◆ m_symbol

LIB_SYMBOL* SYMBOL_EDIT_FRAME::m_symbol

private

◆ m_SyncPinEdit

bool SYMBOL_EDIT_FRAME::m_SyncPinEdit

Set to true to synchronize pins at the same position when editing symbols with multiple units or multiple body styles.

Deleting or moving pins will affect all pins at the same location. When units are interchangeable, synchronizing editing of pins is usually the best way, because if units are interchangeable, it implies that all similar pins are at the same location. When units are not interchangeable, do not synchronize editing of pins, because each symbol is specific, and there are no (or few) similar pins between units.

Setting this to false allows editing each pin per symbol or body style regardless other pins at the same location. This requires the user to open each symbol or body style to make changes to the other pins at the same location.

To know if others pins must be coupled when editing a pin, use SynchronizePins() instead of m_syncPinEdit, because SynchronizePins() is more reliable (takes in account the fact units are interchangeable, there are more than one unit).

Todo:: Determine why this member variable is public when all the rest are private and either make it private or document why it needs to be public.

Definition at line 544 of file symbol_edit_frame.h.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), LoadSymbolFromCurrentLib(), DIALOG_PIN_PROPERTIES::OnPropertiesChange(), SetCurSymbol(), setupUIConditions(), SynchronizePins(), SYMBOL_EDITOR_CONTROL::ToggleSyncedPinsMode(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ m_tbLeft

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbLeft

protectedinherited

Definition at line 838 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_BASE_FRAME::OnToolbarSizeChanged(), KICAD_MANAGER_FRAME::onToolbarSizeChanged(), EDA_BASE_FRAME::RecreateToolbars(), and EDA_BASE_FRAME::UpdateToolbarControlSizes().

◆ m_tbRight

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbRight

protectedinherited

Definition at line 837 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME(), EDA_BASE_FRAME::OnToolbarSizeChanged(), EDA_BASE_FRAME::RecreateToolbars(), and EDA_BASE_FRAME::UpdateToolbarControlSizes().

◆ m_tbTopAux

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbTopAux

protectedinherited

Definition at line 836 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_BASE_FRAME::OnToolbarSizeChanged(), PCB_EDIT_FRAME::PrepareLayerIndicator(), PCB_EDIT_FRAME::ReCreateLayerBox(), EDA_BASE_FRAME::RecreateToolbars(), and EDA_BASE_FRAME::UpdateToolbarControlSizes().

◆ m_tbTopMain

ACTION_TOOLBAR* EDA_BASE_FRAME::m_tbTopMain

protectedinherited

Definition at line 835 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::configureToolbars(), SYMBOL_VIEWER_FRAME::configureToolbars(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), EDA_BASE_FRAME::EDA_BASE_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_BASE_FRAME::OnToolbarSizeChanged(), EDA_BASE_FRAME::RecreateToolbars(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), and EDA_BASE_FRAME::UpdateToolbarControlSizes().

◆ m_toolbarControlFactories

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

protectedinherited

Definition at line 840 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::GetCustomToolbarControlFactory(), and EDA_BASE_FRAME::RegisterCustomToolbarControlFactory().

◆ m_toolbarSettings

TOOLBAR_SETTINGS* EDA_BASE_FRAME::m_toolbarSettings

protectedinherited

Definition at line 832 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), and EDA_BASE_FRAME::RecreateToolbars().

◆ m_toolDispatcher

TOOL_DISPATCHER* TOOLS_HOLDER::m_toolDispatcher

protectedinherited

◆ 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 TOOLS_HOLDER::CurrentToolName(), TOOLS_HOLDER::IsCurrentTool(), TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), and TOOLS_HOLDER::ToolStackIsEmpty().

◆ m_treePane

SYMBOL_TREE_PANE* SYMBOL_EDIT_FRAME::m_treePane

private

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type

privateinherited

Definition at line 87 of file kiway_holder.h.

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

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler(), and EDA_BASE_FRAME::UnregisterUIUpdateHandler().

◆ m_undoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_undoList

protectedinherited

Definition at line 809 of file eda_base_frame.h.

Referenced by SCH_EDIT_FRAME::ClearUndoORRedoList(), ClearUndoORRedoList(), PL_EDITOR_FRAME::ClearUndoORRedoList(), PCB_BASE_EDIT_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetUndoActionDescription(), EDA_BASE_FRAME::GetUndoCommandCount(), EDA_BASE_FRAME::PopCommandFromUndoList(), EDA_BASE_FRAME::PushCommandToUndoList(), and SCH_EDIT_FRAME::RecalculateConnections().

◆ m_undoRedoCountMax

int EDA_DRAW_FRAME::m_undoRedoCountMax

protectedinherited

Definition at line 578 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::LoadSettings().

◆ m_unit

int SYMBOL_EDIT_FRAME::m_unit

private

Definition at line 561 of file symbol_edit_frame.h.

Referenced by GetDocumentExtents(), GetUnit(), LoadOneLibrarySymbolAux(), LoadSymbolFromSchematic(), RebuildSymbolUnitsList(), RebuildView(), Revert(), SetCurSymbol(), SetUnit(), and UpdateSymbolMsgPanelInfo().

◆ m_unitSelectBox

wxComboBox* SYMBOL_EDIT_FRAME::m_unitSelectBox

private

Definition at line 552 of file symbol_edit_frame.h.

Referenced by configureToolbars(), RebuildSymbolUnitsList(), and SetUnit().

◆ m_userUnits

EDA_UNITS UNITS_PROVIDER::m_userUnits

privateinherited

Definition at line 252 of file units_provider.h.

Referenced by UNITS_PROVIDER::GetUserUnits(), and UNITS_PROVIDER::SetUserUnits().

◆ m_watcher

std::unique_ptr<wxFileSystemWatcher> SCH_BASE_FRAME::m_watcher

privateinherited

These are file watchers for the symbol library tables.

Definition at line 307 of file sch_base_frame.h.

Referenced by SCH_BASE_FRAME::OnSymChange(), and SCH_BASE_FRAME::setSymWatcher().

◆ m_watcherDebounceTimer

wxTimer SCH_BASE_FRAME::m_watcherDebounceTimer

privateinherited

Definition at line 310 of file sch_base_frame.h.

Referenced by SCH_BASE_FRAME::OnSymChange(), SCH_BASE_FRAME::OnSymChangeDebounceTimer(), and SCH_BASE_FRAME::SCH_BASE_FRAME().

◆ m_watcherFileName

wxFileName SCH_BASE_FRAME::m_watcherFileName

privateinherited

Definition at line 308 of file sch_base_frame.h.

Referenced by SCH_BASE_FRAME::OnSymChange(), SCH_BASE_FRAME::OnSymChangeDebounceTimer(), and SCH_BASE_FRAME::setSymWatcher().

◆ m_watcherLastModified

wxDateTime SCH_BASE_FRAME::m_watcherLastModified

privateinherited

Definition at line 309 of file sch_base_frame.h.

Referenced by SCH_BASE_FRAME::OnSymChangeDebounceTimer(), SCH_BASE_FRAME::SetSymModificationTime(), and SCH_BASE_FRAME::setSymWatcher().

◆ m_zoomSelectBox

wxChoice* EDA_DRAW_FRAME::m_zoomSelectBox

protectedinherited

Definition at line 586 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::configureToolbars(), EDA_DRAW_FRAME::OnSelectZoom(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), and EDA_DRAW_FRAME::UpdateZoomSelectBox().

◆ NullUiString

const wxString UNITS_PROVIDER::NullUiString = ""

inlinestaticinherited

The string that is used in the UI to represent a null value.

Definition at line 248 of file units_provider.h.

Referenced by WX_GRID::GetOptionalUnitValue(), WX_GRID::onCellEditorHidden(), UNITS_PROVIDER::OptionalValueFromString(), and UNITS_PROVIDER::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

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ HOLDER_TYPE

◆ TABLE_SCOPE

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ SYMBOL_EDIT_FRAME()

◆ ~SYMBOL_EDIT_FRAME()

Member Function Documentation

◆ ActivateGalCanvas()

◆ AddApiPluginTools()

◆ AddLibraryFile()

◆ addLibTableEntry()

◆ AddMenuLanguageList()

◆ AddStandardHelpMenu()

◆ AddStandardSubMenus()

◆ AddToScreen()

◆ AngleValueFromString()

◆ AppearancePanelName()

◆ AppendMsgPanel()

◆ backupFile()

◆ CanAcceptApiCommands()

◆ CanCloseSymbolFromSchematic()

◆ canCloseWindow()

◆ centerItemIdleHandler()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ ClearFileHistory()

◆ ClearFocus()

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ CloseWindow()

◆ commonInit()

◆ CommonSettingsChanged()

◆ config()

◆ ConfigBaseName()

◆ configureToolbars()

◆ CopySymbolToClipboard()

◆ createCanvas()

◆ CreateHotkeyPopup()

◆ CreateInfoBar()

◆ CreateNewSymbol()

◆ CreateServer()

◆ CurrentToolName()

◆ DdAddLibrary()

◆ DeleteAutoSaveFile()

◆ DeleteSymbolFromLibrary()

◆ DesignBlocksPaneName()

◆ Destroy()

◆ DismissModal()

◆ DisplayConstraintsMsg()

◆ DisplayGridMsg()

◆ DisplayToolMsg()

◆ DisplayUnitsMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ doReCreateMenuBar()

◆ DoWithAcceptedFiles()

◆ DuplicateSymbol()

◆ eeconfig()

◆ emptyScreen()

◆ ensureUniqueName()

◆ ensureWindowIsOnScreen()

◆ EraseMsgBox()

◆ ExecuteRemoteCommand()

◆ ExportSymbol()

◆ findDialogs()