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 }
	Specifies 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

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

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

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

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

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

LIB_TREE_NODE *	GetCurrentTreeNode () const

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

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

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

SYMBOL_LIBRARY_MANAGER &	GetLibManager ()

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

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

bool	SynchronizePins ()

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

void	CreateNewSymbol ()
	Create a new symbol in the selected library. More...

void	ImportSymbol ()

void	ExportSymbol ()

void	Save ()
	Save the selected symbol or library. More...

void	SaveSymbolAs ()
	Save the currently selected symbol to a new name and/or location. More...

void	SaveLibraryAs ()
	Save the currently selected library to a new file. More...

void	SaveAll ()
	Save all modified symbols and libraries. More...

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

void	RevertAll ()

void	DeleteSymbolFromLibrary ()

void	CopySymbolToClipboard ()

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

void	DuplicateSymbol (bool aFromClipboard)
	Insert a duplicate symbol. More...

void	OnSelectUnit (wxCommandEvent &event)

void	OnToggleSymbolTree (wxCommandEvent &event)

bool	IsSymbolTreeShown ()

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

void	ReCreateVToolbar () override

void	ReCreateOptToolbar () override

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

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

SYMBOL_EDITOR_SETTINGS *	GetSettings () const

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

COLOR_SETTINGS *	GetColorSettings () const override
	Returns a pointer to the active color theme settings. More...

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

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

int	GetUnit () const

void	SetUnit (int aUnit)

int	GetConvert () const

void	SetConvert (int aConvert)

bool	GetShowDeMorgan () const

void	SetShowDeMorgan (bool show)

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

bool	IsSymbolFromSchematic () const

bool	IsSymbolFromLegacyLibrary () const

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

void	SaveCopyInUndoList (EDA_ITEM *aItem, UNDO_REDO aUndoType=UNDO_REDO::LIBEDIT, bool aAppend=false)
	Create a copy of the current symbol, and save it in the undo list. More...

void	GetSymbolFromUndoList ()

void	GetSymbolFromRedoList ()

void	RollbackSymbolFromUndo ()

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

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

void	PrintPage (const RENDER_SETTINGS *aSettings) override
	Print a page. More...

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

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

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

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

void	InstallPreferences (PAGED_DIALOG aParent, PANEL_HOTKEYS_EDITOR aHotkeysPanel) override
	Allow the symbol editor to install its preferences panel into the preferences dialog. More...

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

void	ShowChangedLanguage () override

void	SetScreen (BASE_SCREEN *aScreen) override

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

void	RebuildView ()

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

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

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

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

bool	IsSymbolAlias () const
	Restore the empty editor screen, without any symbol or library selected. More...

void	emptyScreen ()
	Return either the symbol selected in the symbol tree, if context menu is active or the currently modified symbol. More...

LIB_ID	GetTargetLibId () const

void	createCanvas ()

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

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

EESCHEMA_SETTINGS *	eeconfig () const

SYMBOL_EDITOR_SETTINGS *	libeditconfig () const

KIGFX::SCH_RENDER_SETTINGS *	GetRenderSettings ()

COLOR4D	GetDrawBgColor () const override

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

void	SetPageSettings (const PAGE_INFO &aPageSettings) override

const PAGE_INFO &	GetPageSettings () const override

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

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

void	SetGridOrigin (const wxPoint &aPoint) override

const TITLE_BLOCK &	GetTitleBlock () const override

void	SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override

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

PICKED_SYMBOL	PickSymbolFromLibTree (const SCHLIB_FILTER aFilter, std::vector< PICKED_SYMBOL > &aHistoryList, bool aUseLibBrowser, int aUnit, int aConvert, bool aShowFootprints, const LIB_ID aHighlight=nullptr, bool aAllowFields=true)
	Call the library viewer to select symbol to import into schematic. More...

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

PICKED_SYMBOL	PickSymbolFromLibBrowser (wxTopLevelWindow aParent, const SCHLIB_FILTER aFilter, const LIB_ID &aPreselectedLibId, int aUnit, int aConvert)
	Call the library viewer to select symbol to import into schematic. More...

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

virtual void	CenterScreen (const wxPoint &aCenterPoint, bool aWarpPointer)

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

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

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

void	RefreshSelection ()
	Mark selected items for refresh. More...

void	SyncView ()
	Mark all items for refresh. More...

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

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

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

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

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

wxFindReplaceData &	GetFindReplaceData ()

wxArrayString &	GetFindHistoryList ()

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

void	SetShowPolarCoords (bool aShow)

void	ToggleUserUnits () override

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

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

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

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

virtual void	SetDrawBgColor (const COLOR4D &aColor)

bool	ShowPageLimits () const

void	SetShowPageLimits (bool aShow)

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

virtual wxString	GetScreenDesc () const

void	EraseMsgBox ()

virtual void	ReCreateAuxiliaryToolbar ()

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

bool	IsGridVisible () const

virtual void	SetGridVisibility (bool aVisible)

virtual COLOR4D	GetGridColor ()

virtual void	SetGridColor (const COLOR4D &aColor)

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

void	OnGridSettings (wxCommandEvent &event)

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

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

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

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

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

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

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

void	OnMove (wxMoveEvent &aEvent) override

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

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

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

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

void	DisplayToolMsg (const wxString &msg) override

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

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

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

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

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

void	SetMsgPanel (EDA_ITEM *aItem)

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

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

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

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

void	SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)

wxWindow *	GetToolCanvas () const override
	Canvas access. More...

KIGFX::GAL_DISPLAY_OPTIONS &	GetGalDisplayOptions ()
	Return a reference to the gal rendering options used by GAL for rendering. More...

void	RefreshCanvas () override

void	RecreateToolbars ()
	Rebuild all toolbars, and update the checked state of check tools. More...

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

virtual void	ParseArgs (wxCmdLineParser &aParser)
	Handle command-line arguments in a frame-specific way. More...

virtual bool	ShowModal (wxString aResult=nullptr, wxWindow aResultantFocusWindow=nullptr)
	Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...

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

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

void	SetModal (bool aIsModal)

bool	IsDismissed ()

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

void	CreateServer (int service, bool local=true)

void	OnSockRequest (wxSocketEvent &evt)

void	OnSockRequestServer (wxSocketEvent &evt)

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

EDA_UNITS	GetUserUnits () const
	Return the user units currently in use. More...

void	SetUserUnits (EDA_UNITS aUnits)

void	ChangeUserUnits (EDA_UNITS aUnits)

SETTINGS_MANAGER *	GetSettingsManager () const

virtual SEVERITY	GetSeverity (int aErrorCode) const

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

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

void	OnMenuEvent (wxMenuEvent &event)
	The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...

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

virtual void	RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
	Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...

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

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

void	OnMaximize (wxMaximizeEvent &aEvent)

void	SetAutoSaveInterval (int aInterval)

int	GetAutoSaveInterval () const

bool	IsType (FRAME_T aType) const

FRAME_T	GetFrameType () const

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

virtual wxString	help_name ()

void	OnKicadAbout (wxCommandEvent &event)

void	OnPreferences (wxCommandEvent &event)
	Displays the preferences and settings of all opened editors paged dialog. More...

void	PrintMsg (const wxString &text)

void	CreateInfoBar ()

void	FinishAUIInitialization ()

WX_INFOBAR *	GetInfoBar ()

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

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

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

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

void	LoadWindowState (const wxString &aFileName)

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

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

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

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

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

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

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

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

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

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

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

void	SetMruPath (const wxString &aPath)

wxString	GetMruPath () const

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

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

bool	IsWritable (const wxFileName &aFileName)
	Checks if aFileName can be written. More...

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

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

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

const wxString &	GetAboutTitle () const

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

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

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

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

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

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

virtual int	GetUndoCommandCount () const

virtual int	GetRedoCommandCount () const

int	GetMaxUndoItems () const

bool	NonUserClose (bool aForce)

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

TOOL_MANAGER *	GetToolManager () const
	Return the MVC controller. More...

virtual void	PushTool (const std::string &actionName)
	NB: the definition of "tool" is different at the user level. More...

virtual void	PopTool (const std::string &actionName)

bool	ToolStackIsEmpty ()

std::string	CurrentToolName () const

bool	IsCurrentTool (const TOOL_ACTION &aAction) const

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

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

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

HOLDER_TYPE	GetType () const

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

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

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

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

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

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

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

void	unitsChangeRefresh () override
	Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...

void	setupUnits (APP_SETTINGS_BASE *aCfg)

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

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

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

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

void	onActivate (wxActivateEvent &aEvent)

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

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

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

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

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

void	onSystemColorChange (wxSysColourChangedEvent &aEvent)

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

void	ensureWindowIsOnScreen ()

Static Protected Member Functions
static wxString	GetAutoSaveFilePrefix ()

Protected Attributes
SCHEMATIC_SETTINGS	m_base_frame_defaults
	These are only used by symbol_editor. More...

wxSocketServer *	m_socketServer

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

std::unique_ptr< wxSingleInstanceChecker >	m_file_checker

bool	m_showPageLimits

COLOR4D	m_gridColor

COLOR4D	m_drawBgColor

int	m_undoRedoCountMax

bool	m_polarCoords

bool	m_showBorderAndTitleBlock

long	m_firstRunDialogSetting

wxChoice *	m_gridSelectBox

wxChoice *	m_zoomSelectBox

ACTION_TOOLBAR *	m_mainToolBar

ACTION_TOOLBAR *	m_auxiliaryToolBar

ACTION_TOOLBAR *	m_drawToolBar

ACTION_TOOLBAR *	m_optionsToolBar

wxFindReplaceData *	m_findReplaceData

wxArrayString	m_findStringHistoryList

wxArrayString	m_replaceStringHistoryList

EDA_MSG_PANEL *	m_messagePanel

int	m_msgFrameHeight

COLOR_SETTINGS *	m_colorSettings
	The current canvas type. More...

EDA_DRAW_PANEL_GAL::GAL_TYPE	m_canvasType

bool	m_modal

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

wxWindow *	m_modal_resultant_parent

wxString	m_modal_string

bool	m_modal_ret_val

FRAME_T	m_ident

wxPoint	m_framePos

wxSize	m_frameSize

bool	m_maximizeByDefault

int	m_displayIndex

wxPoint	m_normalFramePos

wxSize	m_normalFrameSize

wxString	m_aboutTitle

wxAuiManager	m_auimgr

wxString	m_perspective

WX_INFOBAR *	m_infoBar

wxString	m_configName

SETTINGS_MANAGER *	m_settingsManager

FILE_HISTORY *	m_fileHistory

bool	m_hasAutoSave

bool	m_autoSaveState

int	m_autoSaveInterval

wxTimer *	m_autoSaveTimer

UNDO_REDO_CONTAINER	m_undoList

UNDO_REDO_CONTAINER	m_redoList

wxString	m_mruPath

EDA_UNITS	m_userUnits
	Map containing the UI update handlers registered with wx for each action. More...

std::map< int, UIUpdateHandler >	m_uiUpdateMap
	Set by the close window event handler after frames are asked if they can close. More...

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

bool	m_isNonUserClose

TOOL_MANAGER *	m_toolManager

ACTIONS *	m_actions

TOOL_DISPATCHER *	m_toolDispatcher

SELECTION	m_dummySelection

std::vector< std::string >	m_toolStack

bool	m_immediateActions

MOUSE_DRAG_ACTION	m_dragAction

bool	m_moveWarpsCursor

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

Private Types
enum	TABLE_SCOPE { GLOBAL_LIB_TABLE, PROJECT_LIB_TABLE }

Private Member Functions
void	setupTools ()

void	saveSymbolAs ()

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

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

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

wxString	SelectLibraryFromList ()
	Display a list of loaded libraries in the symbol library and allows the user to select a library. More...

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

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

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

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

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

wxString	getTargetLib () const

bool	saveAllLibraries (bool aRequireConfirmation)
	Save the current symbol. More...

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

void	storeCurrentSymbol ()
	Return true if aLibId is an alias for the editor screen symbol. More...

bool	isCurrentSymbol (const LIB_ID &aLibId) const
	Rename LIB_SYMBOL aliases to avoid conflicts before adding a symbol to a library. More...

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

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

Private Attributes
SCH_SCREEN *	m_dummyScreen
	< Helper screen used when no symbol is loaded More...

LIB_SYMBOL *	m_symbol

wxComboBox *	m_unitSelectBox

SYMBOL_TREE_PANE *	m_treePane

SYMBOL_LIBRARY_MANAGER *	m_libMgr

SYMBOL_EDITOR_SETTINGS *	m_settings

int	m_unit

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

bool	m_isSymbolFromSchematic

wxString	m_reference
	The reference of the symbol. More...

Static Private Attributes
static bool	m_showDeMorgan = false

Detailed Description

The symbol library editor main window.

Definition at line 52 of file symbol_edit_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

39 { DIALOG, FRAME, PANEL };

KIWAY_HOLDER::DIALOG

Definition: kiway_holder.h:39

KIWAY_HOLDER::PANEL

Definition: kiway_holder.h:39

KIWAY_HOLDER::FRAME

Definition: kiway_holder.h:39

◆ TABLE_SCOPE

enum SYMBOL_EDIT_FRAME::TABLE_SCOPE

private

Enumerator
GLOBAL_LIB_TABLE
PROJECT_LIB_TABLE

Definition at line 471 of file symbol_edit_frame.h.

     {
         GLOBAL_LIB_TABLE,
         PROJECT_LIB_TABLE
     };

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

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

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 109 of file eda_base_frame.h.

     {
         UNDO_LIST,
         REDO_LIST
     };

Constructor & Destructor Documentation

◆ SYMBOL_EDIT_FRAME()

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

Definition at line 97 of file symbol_edit_frame.cpp.

                                                                        :
         SCH_BASE_FRAME( aKiway, aParent, FRAME_SCH_SYMBOL_EDITOR, _( "Library Editor" ),
                         wxDefaultPosition, wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE,
                         LIB_EDIT_FRAME_NAME ),
         m_unitSelectBox( nullptr ),
         m_isSymbolFromSchematic( false )
 {
     SetShowDeMorgan( false );
     m_SyncPinEdit = false;
 
     m_symbol = nullptr;
     m_treePane = nullptr;
     m_libMgr = nullptr;
     m_unit = 1;
     m_convert = 1;
     m_aboutTitle = _( "KiCad Symbol Editor" );
 
     wxIcon icon;
     wxIconBundle icon_bundle;
 
     icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_libedit ) );
     icon_bundle.AddIcon( icon );
     icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_libedit_32 ) );
     icon_bundle.AddIcon( icon );
     icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_libedit_16 ) );
     icon_bundle.AddIcon( icon );
 
     SetIcons( icon_bundle );
 
     m_settings = Pgm().GetSettingsManager().GetAppSettings<SYMBOL_EDITOR_SETTINGS>();
     LoadSettings( m_settings );
 
     // Ensure axis are always drawn
     KIGFX::GAL_DISPLAY_OPTIONS& gal_opts = GetGalDisplayOptions();
     gal_opts.m_axesEnabled = true;
 
     m_dummyScreen = new SCH_SCREEN();
     SetScreen( m_dummyScreen );
     GetScreen()->m_Center = true;
 
     GetCanvas()->GetViewControls()->SetCrossHairCursorPosition( VECTOR2D( 0, 0 ), false );
 
     GetRenderSettings()->LoadColors( GetColorSettings() );
     GetCanvas()->GetGAL()->SetAxesColor( m_colorSettings->GetColor( LAYER_SCHEMATIC_GRID_AXES ) );
 
     setupTools();
     setupUIConditions();
 
     m_libMgr = new SYMBOL_LIBRARY_MANAGER( *this );
 
     // Preload libraries before using SyncLibraries the first time, as the preload is threaded
     WX_PROGRESS_REPORTER reporter( this, _( "Loading Symbol Libraries" ),
                                    m_libMgr->GetLibraryCount(), true );
     m_libMgr->Preload( reporter );
 
     SyncLibraries( false );
     m_treePane = new SYMBOL_TREE_PANE( this, m_libMgr );
 
     ReCreateMenuBar();
     ReCreateHToolbar();
     ReCreateVToolbar();
     ReCreateOptToolbar();
 
     updateTitle();
     UpdateSymbolMsgPanelInfo();
     RebuildSymbolUnitsList();
 
     m_auimgr.SetManagedWindow( this );
 
     CreateInfoBar();
     m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" )
                       .Top().Layer( 6 ) );
     m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" )
                       .Bottom().Layer( 6 ) );
 
     m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" )
                       .Left().Layer( 3 ) );
     m_auimgr.AddPane( m_treePane, EDA_PANE().Palette().Name( "SymbolTree" )
                       .Left().Layer( 2 )
                       .Caption( _( "Libraries" ) )
                       .MinSize( 250, -1 ).BestSize( 250, -1 ) );
     m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" )
                       .Right().Layer( 2 ) );
 
     m_auimgr.AddPane( GetCanvas(), wxAuiPaneInfo().Name( "DrawFrame" )
                       .CentrePane() );
 
     FinishAUIInitialization();
 
     if( m_settings->m_LibWidth > 0 )
     {
         wxAuiPaneInfo& treePane = m_auimgr.GetPane( "SymbolTree" );
 
         // wxAUI hack: force width by setting MinSize() and then Fixed()
         // thanks to ZenJu http://trac.wxwidgets.org/ticket/13180
         treePane.MinSize( m_settings->m_LibWidth, -1 );
         treePane.Fixed();
         m_auimgr.Update();
 
         // now make it resizable again
         treePane.Resizable();
         m_auimgr.Update();
 
         // Note: DO NOT call m_auimgr.Update() anywhere after this; it will nuke the size
         // back to minimum.
         treePane.MinSize( 250, -1 );
     }
 
     Raise();
     Show( true );
 
     SyncView();
     GetCanvas()->GetView()->UseDrawPriority( true );
     GetCanvas()->GetGAL()->SetAxesEnabled( true );
 
     setupUnits( m_settings );
 
     // Set the working/draw area size to display a symbol to a reasonable value:
     // A 600mm x 600mm with a origin at the area center looks like a large working area
     double max_size_x = Millimeter2iu( 600 );
     double max_size_y = Millimeter2iu( 600 );
     BOX2D bbox;
     bbox.SetOrigin( -max_size_x /2, -max_size_y/2 );
     bbox.SetSize( max_size_x, max_size_y );
     GetCanvas()->GetView()->SetBoundary( bbox );
 
     m_toolManager->RunAction( ACTIONS::zoomFitScreen, true );
 
     KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Library changes are unsaved" ) );
 
     // Catch unhandled accelerator command characters that were no handled by the library tree
     // panel.
     Bind( wxEVT_CHAR, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
     Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
 
     // Ensure the window is on top
     Raise();
 }

References _, TOOL_DISPATCHER::DispatchWxEvent(), icon_libedit, icon_libedit_16, icon_libedit_32, KiBitmap(), LAYER_SCHEMATIC_GRID_AXES, PCAD2KICAD::Left, KIGFX::GAL_DISPLAY_OPTIONS::m_axesEnabled, Millimeter2iu(), Pgm(), PCAD2KICAD::Right, BOX2< Vec >::SetOrigin(), KIPLATFORM::APP::SetShutdownBlockReason(), BOX2< Vec >::SetSize(), and ACTIONS::zoomFitScreen.

◆ ~SYMBOL_EDIT_FRAME()

SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME ( )

override

Definition at line 237 of file symbol_edit_frame.cpp.

 {
     // Shutdown all running tools
     if( m_toolManager )
         m_toolManager->ShutdownAllTools();
 
     if( IsSymbolFromSchematic() )
     {
         delete m_symbol;
         m_symbol = nullptr;
 
         SCH_SCREEN* screen = GetScreen();
         delete screen;
         m_isSymbolFromSchematic = false;
     }
     // current screen is destroyed in EDA_DRAW_FRAME
     SetScreen( m_dummyScreen );
 
     auto libedit = Pgm().GetSettingsManager().GetAppSettings<SYMBOL_EDITOR_SETTINGS>();
     Pgm().GetSettingsManager().Save( libedit );
 
     delete m_libMgr;
 }

References SCH_BASE_FRAME::GetScreen(), IsSymbolFromSchematic(), libedit, m_dummyScreen, m_isSymbolFromSchematic, m_libMgr, m_symbol, TOOLS_HOLDER::m_toolManager, Pgm(), SetScreen(), and TOOL_MANAGER::ShutdownAllTools().

Member Function Documentation

◆ ActivateGalCanvas()

void EDA_DRAW_FRAME::ActivateGalCanvas ( )

virtualinherited

Use to start up the GAL drawing canvas.

Reimplemented in GERBVIEW_FRAME, PCB_BASE_FRAME, PCB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 703 of file eda_draw_frame.cpp.

 {
     GetCanvas()->SetEvtHandlerEnabled( true );
     GetCanvas()->StartDrawing();
 }

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

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), SCH_BASE_FRAME::createCanvas(), SCH_DRAW_PANEL::OnShow(), and EDA_DRAW_FRAME::SwitchCanvas().

◆ AddLibraryFile()

bool SYMBOL_EDIT_FRAME::AddLibraryFile ( bool aCreateNew )

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

Definition at line 802 of file symbol_edit_frame.cpp.

 {
     // Select the target library table (global/project)
     SYMBOL_LIB_TABLE* libTable = selectSymLibTable();
 
     if( !libTable )
         return false;
 
     wxFileName fn = m_libMgr->GetUniqueLibraryName();
 
     if( !LibraryFileBrowser( !aCreateNew, fn, KiCadSymbolLibFileWildcard(),
                              KiCadSymbolLibFileExtension, false,
                              ( libTable == &SYMBOL_LIB_TABLE::GetGlobalLibTable() ),
                              PATHS::GetDefaultUserSymbolsPath() ) )
     {
         return false;
     }
 
     wxString libName = fn.GetName();
 
     if( libName.IsEmpty() )
         return false;
 
     if( m_libMgr->LibraryExists( libName ) )
     {
         DisplayError( this, wxString::Format( _( "Library '%s' already exists." ), libName ) );
         return false;
     }
 
     if( aCreateNew )
     {
         if( !m_libMgr->CreateLibrary( fn.GetFullPath(), libTable ) )
         {
             DisplayError( this, wxString::Format( _( "Could not create the library file '%s'.\n"
                                                      "Make sure you have write permissions and try again." ),
                                                   fn.GetFullPath() ) );
             return false;
         }
     }
     else
     {
         if( !m_libMgr->AddLibrary( fn.GetFullPath(), libTable ) )
         {
             DisplayError( this, _( "Could not open the library file." ) );
             return false;
         }
     }
 
     bool globalTable = ( libTable == &SYMBOL_LIB_TABLE::GetGlobalLibTable() );
     saveSymbolLibTables( globalTable, !globalTable );
 
     std::string packet = fn.GetFullPath().ToStdString();
     this->Kiway().ExpressMail( FRAME_SCH_SYMBOL_EDITOR, MAIL_LIB_EDIT, packet );
 
     return true;
 }

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

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

 {
     wxFileName fn = aLibFile;
     wxFileName libTableFileName( Prj().GetProjectPath(),
                                  SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
     wxString libNickname = fn.GetName();
     SYMBOL_LIB_TABLE* libTable = Prj().SchSymbolLibTable();
     const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables();
 
     if( libTable->HasLibrary( libNickname ) )
     {
         wxString tmp;
         int suffix = 1;
 
         while( libTable->HasLibrary( libNickname ) )
         {
             tmp.Printf( "%s%d", fn.GetName(), suffix );
             libNickname = tmp;
             suffix += 1;
         }
     }
 
     SYMBOL_LIB_TABLE_ROW* row = new SYMBOL_LIB_TABLE_ROW();
     row->SetNickName( libNickname );
 
     wxString normalizedPath = NormalizePath( aLibFile, &envVars, Prj().GetProjectPath() );
 
     if( aScope == GLOBAL_LIB_TABLE )
     {
         libTable = &SYMBOL_LIB_TABLE::GetGlobalLibTable();
         libTableFileName = SYMBOL_LIB_TABLE::GetGlobalTableFileName();
 
         // We cannot normalize against the current project path when saving to global table.
         normalizedPath = NormalizePath( aLibFile, &envVars, wxEmptyString );
     }
 
     if( normalizedPath.IsEmpty() )
         normalizedPath = aLibFile;
 
     row->SetFullURI( normalizedPath );
 
     wxCHECK( libTable->InsertRow( row ), false );
 
     try
     {
         libTable->Save( libTableFileName.GetFullPath() );
     }
     catch( const IO_ERROR& ioe )
     {
         wxString msg = aScope == GLOBAL_LIB_TABLE ? _( "Error saving global library table." )
                                                   : _( "Error saving project library table." );
 
         wxMessageDialog dlg( this, msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
         dlg.SetExtendedMessage( ioe.What() );
         dlg.ShowModal();
 
         return false;
     }
 
     return true;
 }

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

Referenced by saveLibrary().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar * aMenuBar )

inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 440 of file eda_base_frame.cpp.

 {
     COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
     ACTION_MENU*    helpMenu = new ACTION_MENU( false, commonControl );
 
     helpMenu->Add( ACTIONS::help );
     helpMenu->Add( ACTIONS::gettingStarted );
     helpMenu->Add( ACTIONS::listHotKeys );
     helpMenu->Add( ACTIONS::getInvolved );
     helpMenu->Add( ACTIONS::donate );
     helpMenu->Add( ACTIONS::reportBug );
 
     helpMenu->AppendSeparator();
     helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
 
     // Trailing space keeps OSX from hijacking our menu (and disabling everything in it).
     aMenuBar->Append( helpMenu, _( "&Help" ) + wxS( " " ) );
 }

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU & aMenu )

inherited

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

zoom and grid).

Definition at line 494 of file eda_draw_frame.cpp.

 {
     COMMON_TOOLS*     commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
     CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
 
     aMenu.AddSeparator( 1000 );
 
     auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
     zoomMenu->SetTool( commonTools );
     aToolMenu.AddSubMenu( zoomMenu );
 
     auto gridMenu = std::make_shared<GRID_MENU>( this );
     gridMenu->SetTool( commonTools );
     aToolMenu.AddSubMenu( gridMenu );
 
     aMenu.AddMenu( zoomMenu.get(),   SELECTION_CONDITIONS::ShowAlways, 1000 );
     aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
 }

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

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

◆ AddToScreen()

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

inherited

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

Definition at line 363 of file sch_base_frame.cpp.

 {
     auto screen = aScreen;
 
     if( aScreen == nullptr )
         screen = GetScreen();
 
     screen->Append( (SCH_ITEM*) aItem );
 
     if( screen == GetScreen() )
     {
         GetCanvas()->GetView()->Add( aItem );
         UpdateItem( aItem, true );           // handle any additional parent semantics
     }
 }

References KIGFX::VIEW::Add(), SCH_BASE_FRAME::GetCanvas(), SCH_BASE_FRAME::GetScreen(), SCH_DRAW_PANEL::GetView(), and SCH_BASE_FRAME::UpdateItem().

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_FRAME::AddJunction(), SCH_EDIT_FRAME::BreakSegment(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::DeleteJunction(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), and SCH_EDIT_FRAME::SchematicCleanUp().

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

 {
     if( m_messagePanel )
         m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
 }

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

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

◆ backupFile()

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

private

Return currently edited symbol.

Definition at line 1027 of file symbol_edit_frame.cpp.

 {
     if( aOriginalFile.FileExists() )
     {
         wxFileName backupFileName( aOriginalFile );
         backupFileName.SetExt( aBackupExt );
 
         if( backupFileName.FileExists() )
             wxRemoveFile( backupFileName.GetFullPath() );
 
         if( !wxCopyFile( aOriginalFile.GetFullPath(), backupFileName.GetFullPath() ) )
         {
             DisplayError( this, wxString::Format( _( "Failed to save backup to '%s'." ),
                                                   backupFileName.GetFullPath() ) );
             return false;
         }
     }
 
     return true;
 }

References _, DisplayError(), and Format().

Referenced by saveLibrary().

◆ canCloseWindow()

bool SYMBOL_EDIT_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 502 of file symbol_edit_frame.cpp.

 {
     // Shutdown blocks must be determined and vetoed as early as possible
     if( KIPLATFORM::APP::SupportsShutdownBlockReason() && aEvent.GetId() == wxEVT_QUERY_END_SESSION
             && IsContentModified() )
     {
         return false;
     }
 
     if( m_isSymbolFromSchematic && IsContentModified() )
     {
         SCH_EDIT_FRAME* schframe = (SCH_EDIT_FRAME*) Kiway().Player( FRAME_SCH, false );
 
         switch( UnsavedChangesDialog( this,
                                       _( "Save changes to schematic before closing?" ),
                                       nullptr ) )
         {
         case wxID_YES:
             if( schframe && GetCurSymbol() )  // Should be always the case
                 schframe->SaveSymbolToSchematic( *GetCurSymbol());
 
             return true;
 
         case wxID_NO: return true;
 
         default:
         case wxID_CANCEL: return false;
         }
     }
 
     if( !saveAllLibraries( true ) )
     {
         return false;
     }
 
     return true;
 }

References _, FRAME_SCH, GetCurSymbol(), IsContentModified(), KIWAY_HOLDER::Kiway(), m_isSymbolFromSchematic, KIWAY::Player(), saveAllLibraries(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), KIPLATFORM::APP::SupportsShutdownBlockReason(), and UnsavedChangesDialog().

◆ CenterScreen()

void SCH_BASE_FRAME::CenterScreen	(	const wxPoint &	aCenterPoint,
		bool	aWarpPointer
	)

virtualinherited

Definition at line 254 of file sch_base_frame.cpp.

 {
     GetCanvas()->GetView()->SetCenter( aCenterPoint );
 
     if( aWarpPointer )
         GetCanvas()->GetViewControls()->WarpCursor( aCenterPoint, true );
 
     GetCanvas()->Refresh();
 }

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

Referenced by SCH_EDITOR_CONTROL::FindSymbolAndItem().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1181 of file eda_base_frame.cpp.

 {
     SetUserUnits( aUnits );
     unitsChangeRefresh();
 
     wxCommandEvent e( UNITS_CHANGED );
     ProcessEventLocally( e );
 }

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

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

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName & aFileName )

inherited

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.

Definition at line 1069 of file eda_base_frame.cpp.

 {
     wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
 
     wxFileName autoSaveFileName = aFileName;
 
     // Check for auto save file.
     autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
 
     wxLogTrace( traceAutoSave,
                 wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
 
     if( !autoSaveFileName.FileExists() )
         return;
 
     wxString msg = wxString::Format( _(
             "Well this is potentially embarrassing!\n"
             "It appears that the last time you were editing the file\n"
             "\"%s\"\n"
             "it was not saved properly.  Do you wish to restore the last saved edits you made?" ),
             aFileName.GetFullName()
         );
 
     int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
                                  this );
 
     // Make a backup of the current file, delete the file, and rename the auto save file to
     // the file name.
     if( response == wxYES )
     {
         if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
         {
             wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
                           Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
         }
     }
     else
     {
         wxLogTrace( traceAutoSave,
                     wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
 
         // Remove the auto save file when using the previous file as is.
         wxRemoveFile( autoSaveFileName.GetFullPath() );
     }
 }

References _, Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), Pgm(), and traceAutoSave.

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

◆ ClearFileHistory()

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

inherited

Removes all files from the file history.

Parameters

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

Definition at line 956 of file eda_base_frame.cpp.

 {
     if( !aFileHistory )
         aFileHistory = m_fileHistory;
 
     wxASSERT( aFileHistory );
 
     aFileHistory->ClearFileHistory();
 
     // Update the menubar to update the file history menu
     if( GetMenuBar() )
     {
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 }

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

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

◆ ClearMsgPanel()

void SYMBOL_EDIT_FRAME::ClearMsgPanel ( )

inlineoverridevirtual

Clear all messages from the message panel.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 230 of file symbol_edit_frame.h.

     {
         UpdateSymbolMsgPanelInfo();
     }

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

 {
     if( aItemCount == 0 )
         return;
 
     UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
 
     for( PICKED_ITEMS_LIST* command : list.m_CommandsList )
     {
         command->ClearListAndDeleteItems();
         delete command;
     }
 
     list.m_CommandsList.clear();
 }

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

◆ ClearUndoRedoList()

void EDA_BASE_FRAME::ClearUndoRedoList ( )

virtualinherited

Clear the undo and redo list using ClearUndoORRedoList()

Picked items are deleted by ClearUndoORRedoList() according to their status.

Definition at line 1132 of file eda_base_frame.cpp.

 {
     ClearUndoORRedoList( UNDO_LIST );
     ClearUndoORRedoList( REDO_LIST );
 }

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

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), emptyScreen(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), LoadSymbolFromCurrentLib(), PL_EDITOR_FRAME::OnNewDrawingSheet(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and EDA_BASE_FRAME::~EDA_BASE_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 209 of file symbol_edit_frame.h.

     {
         // Generate a wxCloseEvent
         Close( false );
     }

◆ CommonSettingsChanged()

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

overridevirtual

Called after the preferences dialog is run.

Reimplemented from SCH_BASE_FRAME.

Definition at line 1079 of file symbol_edit_frame.cpp.

 {
     SCH_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
 
     GetCanvas()->GetGAL()->SetAxesColor( m_colorSettings->GetColor( LAYER_SCHEMATIC_GRID_AXES ) );
     GetCanvas()->GetGAL()->DrawGrid();
 
     RecreateToolbars();
 
     if( aEnvVarsChanged )
         SyncLibraries( true );
 
     Layout();
     SendSizeEvent();
 }

References SCH_BASE_FRAME::CommonSettingsChanged(), KIGFX::GAL::DrawGrid(), SCH_BASE_FRAME::GetCanvas(), COLOR_SETTINGS::GetColor(), EDA_DRAW_PANEL_GAL::GetGAL(), LAYER_SCHEMATIC_GRID_AXES, EDA_DRAW_FRAME::m_colorSettings, EDA_DRAW_FRAME::RecreateToolbars(), KIGFX::GAL::SetAxesColor(), and SyncLibraries().

◆ config()

APP_SETTINGS_BASE * SYMBOL_EDIT_FRAME::config ( ) const

overridevirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 290 of file symbol_edit_frame.cpp.

 {
     return static_cast<APP_SETTINGS_BASE*>( GetSettings() );
 }

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

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

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CopySymbolToClipboard()

void SYMBOL_EDIT_FRAME::CopySymbolToClipboard ( )

Definition at line 778 of file symbol_editor.cpp.

 {
     int dummyUnit;
     LIB_ID libId = m_treePane->GetLibTree()->GetSelectedLibId( &dummyUnit );
     LIB_SYMBOL* symbol = m_libMgr->GetBufferedSymbol( libId.GetLibItemName(),
                                                       libId.GetLibNickname() );
 
     if( !symbol )
         return;
 
     std::unique_ptr< LIB_SYMBOL> tmp = symbol->Flatten();
     STRING_FORMATTER formatter;
     SCH_SEXPR_PLUGIN::FormatLibSymbol( tmp.get(), formatter );
 
     wxLogNull doNotLog; // disable logging of failed clipboard actions
 
     auto clipboard = wxTheClipboard;
     wxClipboardLocker clipboardLock( clipboard );
 
     if( !clipboardLock || !clipboard->IsOpened() )
         return;
 
     auto data = new wxTextDataObject( wxString( formatter.GetString().c_str(), wxConvUTF8 ) );
     clipboard->SetData( data );
 
     clipboard->Flush();
 }

References LIB_SYMBOL::Flatten(), SCH_SEXPR_PLUGIN::FormatLibSymbol(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SYMBOL_TREE_PANE::GetLibTree(), LIB_TREE::GetSelectedLibId(), STRING_FORMATTER::GetString(), m_libMgr, and m_treePane.

Referenced by SYMBOL_EDITOR_CONTROL::CutCopyDelete().

◆ createCanvas()

void SCH_BASE_FRAME::createCanvas ( )

inherited

Definition at line 285 of file sch_base_frame.cpp.

 {
     m_canvasType = loadCanvasTypeSetting();
 
     // Allows only a CAIRO or OPENGL canvas:
     if( m_canvasType != EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL
             && m_canvasType != EDA_DRAW_PANEL_GAL::GAL_FALLBACK )
     {
         m_canvasType = EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL;
     }
 
     SetCanvas( new SCH_DRAW_PANEL( this, wxID_ANY, wxPoint( 0, 0 ), m_frameSize,
                                    GetGalDisplayOptions(), m_canvasType ) );
     ActivateGalCanvas();
 }

References EDA_DRAW_FRAME::ActivateGalCanvas(), EDA_DRAW_PANEL_GAL::GAL_FALLBACK, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, 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().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 821 of file eda_base_frame.cpp.

 {
 #if defined( __WXOSX_MAC__ )
     m_infoBar = new WX_INFOBAR( GetToolCanvas() );
 #else
     m_infoBar = new WX_INFOBAR( this, &m_auimgr );
 
     m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
 #endif
 }

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

◆ CreateNewSymbol()

void SYMBOL_EDIT_FRAME::CreateNewSymbol ( )

Create a new symbol in the selected library.

Definition at line 382 of file symbol_editor.cpp.

 {
     m_toolManager->RunAction( ACTIONS::cancelInteractive, true );
 
     wxArrayString rootSymbols;
     wxString lib = getTargetLib();
 
     if( !m_libMgr->LibraryExists( lib ) )
     {
         lib = SelectLibraryFromList();
 
         if( !m_libMgr->LibraryExists( lib ) )
             return;
     }
 
     m_libMgr->GetRootSymbolNames( lib, rootSymbols );
 
     rootSymbols.Sort();
 
     DIALOG_LIB_NEW_SYMBOL dlg( this, &rootSymbols );
     dlg.SetMinSize( dlg.GetSize() );
 
     if( dlg.ShowModal() == wxID_CANCEL )
         return;
 
     if( dlg.GetName().IsEmpty() )
     {
         wxMessageBox( _( "This new symbol has no name and cannot be created." ) );
         return;
     }
 
     wxString name = dlg.GetName();
 
     // Currently, symbol names cannot include a space, that breaks libraries:
     name.Replace( " ", "_" );
 
     // Test if there is a symbol with this name already.
     if( !lib.empty() && m_libMgr->SymbolExists( name, lib ) )
     {
         wxString msg = wxString::Format( _( "Symbol '%s' already exists in library '%s'." ),
                                          name,
                                          lib );
 
         KIDIALOG errorDlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
         errorDlg.SetOKLabel( _( "Overwrite" ) );
         errorDlg.DoNotShowCheckbox( __FILE__, __LINE__ );
 
         if( errorDlg.ShowModal() == wxID_CANCEL )
             return;
     }
 
     LIB_SYMBOL new_symbol( name );  // do not create symbol on the heap, it will be buffered soon
 
     wxString parentSymbolName = dlg.GetParentSymbolName();
 
     if( parentSymbolName.IsEmpty() )
     {
         new_symbol.GetReferenceField().SetText( dlg.GetReference() );
         new_symbol.SetUnitCount( dlg.GetUnitCount() );
 
         // Initialize new_symbol.m_TextInside member:
         // if 0, pin text is outside the body (on the pin)
         // if > 0, pin text is inside the body
         if( dlg.GetPinNameInside() )
         {
             new_symbol.SetPinNameOffset( dlg.GetPinTextPosition() );
 
             if( new_symbol.GetPinNameOffset() == 0 )
                 new_symbol.SetPinNameOffset( 1 );
         }
         else
         {
             new_symbol.SetPinNameOffset( 0 );
         }
 
         ( dlg.GetPowerSymbol() ) ? new_symbol.SetPower() : new_symbol.SetNormal();
         new_symbol.SetShowPinNumbers( dlg.GetShowPinNumber() );
         new_symbol.SetShowPinNames( dlg.GetShowPinName() );
         new_symbol.LockUnits( dlg.GetLockItems() );
         new_symbol.SetIncludeInBom( dlg.GetIncludeInBom() );
         new_symbol.SetIncludeOnBoard( dlg.GetIncludeOnBoard() );
 
         if( dlg.GetUnitCount() < 2 )
             new_symbol.LockUnits( false );
 
         new_symbol.SetConversion( dlg.GetAlternateBodyStyle() );
 
         // must be called after loadSymbol, that calls SetShowDeMorgan, but
         // because the symbol is empty,it looks like it has no alternate body
         SetShowDeMorgan( dlg.GetAlternateBodyStyle() );
     }
     else
     {
         LIB_SYMBOL* parent = m_libMgr->GetAlias( parentSymbolName, lib );
         wxCHECK( parent, /* void */ );
         new_symbol.SetParent( parent );
 
         // Inherit the parent mandatory field attributes.
         for( int id = 0; id < MANDATORY_FIELDS; ++id )
         {
             LIB_FIELD* field = new_symbol.GetFieldById( id );
 
             // the MANDATORY_FIELDS are exactly that in RAM.
             wxCHECK( field, /* void */ );
 
             LIB_FIELD* parentField = parent->GetFieldById( id );
 
             wxCHECK( parentField, /* void */ );
 
             *field = *parentField;
 
             switch( id )
             {
             case REFERENCE_FIELD:
                 // parent's reference already copied
                 break;
 
             case VALUE_FIELD:
                 field->SetText( name );
                 break;
 
             case FOOTPRINT_FIELD:
             case DATASHEET_FIELD:
                 // - footprint might be the same as parent, but might not
                 // - datasheet is most likely different
                 // - probably best to play it safe and copy neither
                 field->SetText( wxEmptyString );
                 break;
             }
 
             field->SetParent( &new_symbol );
         }
     }
 
     m_libMgr->UpdateSymbol( &new_symbol, lib );
     SyncLibraries( false );
     LoadSymbol( name, lib, 1 );
 }

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.

 {
     wxIPV4address addr;
 
     // Set the port number
     addr.Service( service );
 
     // Listen on localhost only if requested
     if( local )
         addr.Hostname( HOSTNAME );
 
     delete m_socketServer;
     m_socketServer = new wxSocketServer( addr );
 
     m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
     m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
     m_socketServer->Notify( true );
 }

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

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

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 100 of file tools_holder.cpp.

 {
     if( m_toolStack.empty() )
         return ACTIONS::selectionTool.GetName();
     else
         return m_toolStack.back();
 }

References TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by TOOL_MANAGER::processEvent(), and TOOLS_HOLDER::ShowChangedLanguage().

◆ DeleteSymbolFromLibrary()

void SYMBOL_EDIT_FRAME::DeleteSymbolFromLibrary ( )

Definition at line 737 of file symbol_editor.cpp.

 {
     LIB_ID libId = GetTargetLibId();
 
     if( m_libMgr->IsSymbolModified( libId.GetLibItemName(), libId.GetLibNickname() )
         && !IsOK( this, wxString::Format( _( "The symbol '%s' has been modified.\n"
                                              "Do you want to remove it from the library?" ),
                                           libId.GetUniStringLibItemName() ) ) )
     {
         return;
     }
 
     if( m_libMgr->HasDerivedSymbols( libId.GetLibItemName(), libId.GetLibNickname() ) )
     {
         wxString msg;
 
         msg.Printf( _( "The symbol %s is used to derive other symbols.\n"
                        "Deleting this symbol will delete all of the symbols derived from it.\n\n"
                        "Do you wish to delete this symbol and all of its derivatives?" ),
                     libId.GetLibItemName().wx_str() );
 
         wxMessageDialog::ButtonLabel yesButtonLabel( _( "Delete Symbol" ) );
         wxMessageDialog::ButtonLabel noButtonLabel( _( "Keep Symbol" ) );
 
         wxMessageDialog dlg( this, msg, _( "Warning" ),
                              wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION | wxCENTER );
         dlg.SetYesNoLabels( yesButtonLabel, noButtonLabel );
 
         if( dlg.ShowModal() == wxID_NO )
             return;
     }
 
     if( isCurrentSymbol( libId ) )
         emptyScreen();
 
     m_libMgr->RemoveSymbol( libId.GetLibItemName(), libId.GetLibNickname() );
 
     m_treePane->GetLibTree()->RefreshLibTree();
 }

References _, emptyScreen(), Format(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SYMBOL_TREE_PANE::GetLibTree(), GetTargetLibId(), LIB_ID::GetUniStringLibItemName(), SYMBOL_LIBRARY_MANAGER::HasDerivedSymbols(), isCurrentSymbol(), IsOK(), SYMBOL_LIBRARY_MANAGER::IsSymbolModified(), m_libMgr, m_treePane, LIB_TREE::RefreshLibTree(), SYMBOL_LIBRARY_MANAGER::RemoveSymbol(), and UTF8::wx_str().

Referenced by SYMBOL_EDITOR_CONTROL::CutCopyDelete().

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

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

Definition at line 154 of file kiway_player.cpp.

 {
     return EDA_BASE_FRAME::Destroy();
 }

Referenced by DISPLAY_FOOTPRINTS_FRAME::doCloseWindow(), GERBVIEW_FRAME::doCloseWindow(), SYMBOL_VIEWER_FRAME::doCloseWindow(), PL_EDITOR_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), PCB_BASE_FRAME::SelectFootprintFromLibBrowser(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ DismissModal()

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

inherited

Definition at line 166 of file kiway_player.cpp.

 {
     m_modal_ret_val = aRetVal;
     m_modal_string  = aResult;
 
     if( m_modal_loop )
     {
         m_modal_loop->Exit();
         m_modal_loop = nullptr;      // this marks it as dismissed.
     }
 
     Show( false );
 }

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

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), and SYMBOL_VIEWER_FRAME::FinishModal().

◆ DisplayGridMsg()

void EDA_DRAW_FRAME::DisplayGridMsg ( )

virtualinherited

Display current grid size in the status bar.

Reimplemented in PCB_BASE_FRAME, GERBVIEW_FRAME, and PL_EDITOR_FRAME.

Definition at line 520 of file eda_draw_frame.cpp.

 {
     wxString line;
 
     line.Printf( "grid %s",
                  MessageTextFromValue( GetUserUnits(), GetCanvas()->GetGAL()->GetGridSize().x,
                                        false ) );
 
     SetStatusText( line, 4 );
 }

References EDA_DRAW_FRAME::GetCanvas(), EDA_BASE_FRAME::GetUserUnits(), and MessageTextFromValue().

Referenced by SCH_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

void EDA_DRAW_FRAME::DisplayToolMsg ( const wxString & msg )

overridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 514 of file eda_draw_frame.cpp.

 {
     SetStatusText( msg, 6 );
 }

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )

inherited

Display current unit pane in the status bar.

Definition at line 532 of file eda_draw_frame.cpp.

 {
     wxString msg;
 
     switch( m_userUnits )
     {
     case EDA_UNITS::INCHES:      msg = _( "inches" ); break;
     case EDA_UNITS::MILS:        msg = _( "mils" );   break;
     case EDA_UNITS::MILLIMETRES: msg = _( "mm" );     break;
     default:                     msg = _( "Units" );  break;
     }
 
     SetStatusText( msg, 5 );
 }

References _, INCHES, EDA_BASE_FRAME::m_userUnits, MILLIMETRES, and MILS.

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )

protectedvirtualinherited

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

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 323 of file eda_base_frame.cpp.

 {
     wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden.  Bad programmer!" ) );
 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void SYMBOL_EDIT_FRAME::doCloseWindow ( )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 541 of file symbol_edit_frame.cpp.

 {
     Destroy();
 }

References KIWAY_PLAYER::Destroy().

◆ DuplicateSymbol()

void SYMBOL_EDIT_FRAME::DuplicateSymbol ( bool aFromClipboard )

Insert a duplicate symbol.

If aFromClipboard is true then action is a paste.

Definition at line 807 of file symbol_editor.cpp.

 {
     int dummyUnit;
     LIB_ID libId = m_treePane->GetLibTree()->GetSelectedLibId( &dummyUnit );
     wxString lib = libId.GetLibNickname();
 
     if( !m_libMgr->LibraryExists( lib ) )
         return;
 
     LIB_SYMBOL* srcSymbol = nullptr;
     LIB_SYMBOL* newSymbol = nullptr;
 
     if( aFromClipboard )
     {
         wxLogNull doNotLog; // disable logging of failed clipboard actions
 
         auto clipboard = wxTheClipboard;
         wxClipboardLocker clipboardLock( clipboard );
 
         if( !clipboardLock || ! clipboard->IsSupported( wxDF_TEXT ) )
             return;
 
         wxTextDataObject data;
         clipboard->GetData( data );
         wxString symbolSource = data.GetText();
 
         STRING_LINE_READER reader( TO_UTF8( symbolSource ), "Clipboard" );
 
         try
         {
             newSymbol = SCH_SEXPR_PLUGIN::ParseLibSymbol( reader );
         }
         catch( IO_ERROR& e )
         {
             wxLogMessage( "Can not paste: %s", e.Problem() );
             return;
         }
     }
     else
     {
         srcSymbol = m_libMgr->GetBufferedSymbol( libId.GetLibItemName(), lib );
 
         wxCHECK( srcSymbol, /* void */ );
 
         newSymbol = new LIB_SYMBOL( *srcSymbol );
 
         // Derive from same parent.
         if( srcSymbol->IsAlias() )
         {
             std::shared_ptr< LIB_SYMBOL > srcParent = srcSymbol->GetParent().lock();
 
             wxCHECK( srcParent, /* void */ );
 
             newSymbol->SetParent( srcParent.get() );
         }
     }
 
     if( !newSymbol )
         return;
 
     ensureUniqueName( newSymbol, lib );
     m_libMgr->UpdateSymbol( newSymbol, lib );
 
     LoadOneLibrarySymbolAux( newSymbol, lib, GetUnit(), GetConvert() );
 
     SyncLibraries( false );
     m_treePane->GetLibTree()->SelectLibId( LIB_ID( lib, newSymbol->GetName() ) );
 
     delete newSymbol;
 }

References ensureUniqueName(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), GetConvert(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SYMBOL_TREE_PANE::GetLibTree(), LIB_SYMBOL::GetName(), LIB_SYMBOL::GetParent(), LIB_TREE::GetSelectedLibId(), GetUnit(), LIB_SYMBOL::IsAlias(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), LoadOneLibrarySymbolAux(), m_libMgr, m_treePane, SCH_SEXPR_PLUGIN::ParseLibSymbol(), IO_ERROR::Problem(), LIB_TREE::SelectLibId(), LIB_SYMBOL::SetParent(), SyncLibraries(), TO_UTF8, and SYMBOL_LIBRARY_MANAGER::UpdateSymbol().

Referenced by SYMBOL_EDITOR_CONTROL::DuplicateSymbol().

◆ eeconfig()

EESCHEMA_SETTINGS * SCH_BASE_FRAME::eeconfig ( ) const

inherited

Definition at line 116 of file sch_base_frame.cpp.

 {
     return dynamic_cast<EESCHEMA_SETTINGS*>( config() );
 }

References EDA_BASE_FRAME::config().

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AllowCaseSensitiveFileNameClashes(), DIALOG_BOM::DIALOG_BOM(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::editFieldText(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SCH_EDIT_FRAME::GetShowAllPins(), DIALOG_BOM::installGeneratorsList(), SCH_EDIT_FRAME::LoadSettings(), EE_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), DIALOG_PRINT_USING_PRINTER::OnMonochromeChecked(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_PRINTOUT::PrintPage(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), DIALOG_PRINT_USING_PRINTER::SavePrintOptions(), SCH_EDIT_FRAME::SaveSettings(), EE_SELECTION_TOOL::Selectable(), SCH_EDIT_FRAME::SelectUnit(), SCH_EDIT_FRAME::setupUIConditions(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_EDITOR_CONTROL::ToggleForceHV(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataToWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), and DIALOG_BOM::~DIALOG_BOM().

◆ emptyScreen()

void SYMBOL_EDIT_FRAME::emptyScreen ( )

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

Definition at line 1067 of file symbol_edit_frame.cpp.

 {
     m_treePane->GetLibTree()->Unselect();
     SetCurLib( wxEmptyString );
     SetCurSymbol( nullptr, false );
     SetScreen( m_dummyScreen );
     ClearUndoRedoList();
     m_toolManager->RunAction( ACTIONS::zoomFitScreen, true );
     Refresh();
 }

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

Referenced by DeleteSymbolFromLibrary(), and Revert().

◆ ensureUniqueName()

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

private

Definition at line 879 of file symbol_editor.cpp.

 {
     wxCHECK( aSymbol, /* void */ );
 
     int      i = 1;
     wxString newName = aSymbol->GetName();
 
     // Append a number to the name until the name is unique in the library.
     while( m_libMgr->SymbolExists( newName, aLibrary ) )
         newName.Printf( "%s_%d", aSymbol->GetName(), i++ );
 
     aSymbol->SetName( newName );
 }

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

Referenced by DuplicateSymbol().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 637 of file eda_base_frame.cpp.

 {
     wxDisplay display( wxDisplay::GetFromWindow( this ) );
     wxRect    clientSize = display.GetClientArea();
     wxPoint   pos        = GetPosition();
     wxSize    size       = GetWindowSize();
 
     wxLogTrace( traceDisplayLocation,
                 "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d", clientSize.x, clientSize.y,
                 clientSize.width, clientSize.height );
 
     if( pos.y < clientSize.y )
     {
         wxLogTrace( traceDisplayLocation,
                     "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d", pos.y,
                     clientSize.y );
         pos.y = clientSize.y;
     }
 
     if( pos.x < clientSize.x )
     {
         wxLogTrace( traceDisplayLocation,
                     "ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d", pos.x,
                     clientSize.x );
         pos.x = clientSize.x;
     }
 
     if( pos.x + size.x - clientSize.x > clientSize.width )
     {
         int newWidth = clientSize.width - ( pos.x - clientSize.x );
         wxLogTrace( traceDisplayLocation,
                     "ensureWindowIsOnScreen: effective width %d above available %d, setting to %d",
                     pos.x + size.x, clientSize.width, newWidth );
         size.x = newWidth;
     }
 
     if( pos.y + size.y - clientSize.y > clientSize.height )
     {
         int newHeight = clientSize.height - ( pos.y - clientSize.y );
         wxLogTrace( traceDisplayLocation,
                     "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d",
                     pos.y + size.y, clientSize.height, newHeight );
         size.y = newHeight;
     }
 
     wxLogTrace( traceDisplayLocation, "Updating window position (%d, %d) with size (%d, %d)",
                 pos.x, pos.y, size.x, size.y );
 
     SetSize( pos.x, pos.y, size.x, size.y );
 }

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )

inherited

Definition at line 289 of file eda_draw_frame.cpp.

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

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

inlinevirtualinherited

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

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 196 of file kiway_player.h.

196 {}

Referenced by KIWAY_PLAYER::OnSockRequest().

◆ ExportSymbol()

void SYMBOL_EDIT_FRAME::ExportSymbol ( )

Definition at line 112 of file symbol_editor_import_export.cpp.

 {
     wxString msg, title;
     LIB_SYMBOL* symbol = getTargetSymbol();
 
     if( !symbol )
     {
         ShowInfoBarError( _( "There is no symbol selected to save." ) );
         return;
     }
 
     wxFileName fn;
 
     fn.SetName( symbol->GetName().Lower() );
     fn.SetExt( KiCadSymbolLibFileExtension );
 
     wxFileDialog dlg( this, _( "Export Symbol" ), m_mruPath, fn.GetFullName(),
                       KiCadSymbolLibFileWildcard(), wxFD_SAVE );
 
     if( dlg.ShowModal() == wxID_CANCEL )
         return;
 
     fn = dlg.GetPath();
     fn.MakeAbsolute();
 
     LIB_SYMBOL* old_symbol = nullptr;
     SCH_IO_MGR::SCH_FILE_T pluginType = SCH_IO_MGR::GuessPluginTypeFromLibPath( fn.GetFullPath() );
     SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( SCH_IO_MGR::FindPlugin( pluginType ) );
 
     if( fn.FileExists() )
     {
         try
         {
             old_symbol = pi->LoadSymbol( fn.GetFullPath(), symbol->GetName() );
         }
         catch( const IO_ERROR& ioe )
         {
             msg.Printf( _( "Error occurred attempting to load symbol library file '%s'." ),
                         fn.GetFullPath() );
             DisplayErrorMessage( this, msg, ioe.What() );
             return;
         }
 
         if( old_symbol )
         {
             msg.Printf( _( "Symbol %s already exists in library '%s'." ),
                         UnescapeString( symbol->GetName() ),
                         fn.GetFullName() );
 
             KIDIALOG errorDlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
             errorDlg.SetOKLabel( _( "Overwrite" ) );
             errorDlg.DoNotShowCheckbox( __FILE__, __LINE__ );
 
             if( errorDlg.ShowModal() == wxID_CANCEL )
                 return;
         }
     }
 
     if( fn.Exists() && !fn.IsDirWritable() )
     {
         msg.Printf( _( "Insufficient permissions to save library '%s'." ),
                     fn.GetFullPath() );
         DisplayError( this, msg );
         return;
     }
 
     try
     {
         if( !fn.FileExists() )
             pi->CreateSymbolLib( fn.GetFullPath() );
 
         // The flattened symbol is most likely what the user would want.  As some point in
         // the future as more of the symbol library inheritance is implemented, this may have
         // to be changes to save symbols of inherited symbols.
         pi->SaveSymbol( fn.GetFullPath(), symbol->Flatten().release() );
     }
     catch( const IO_ERROR& ioe )
     {
         msg.Printf( _( "Failed to create symbol library file '%s'." ), fn.GetFullPath() );
         DisplayErrorMessage( this, msg, ioe.What() );
         msg.Printf( _( "Error creating symbol library '%s'." ), fn.GetFullName() );
         SetStatusText( msg );
         return;
     }
 
     m_mruPath = fn.GetPath();
 
     msg.Printf( _( "Symbol %s saved to library '%s'." ),
                 UnescapeString( symbol->GetName() ),
                 fn.GetFullPath() );
     SetStatusText( msg );
 
     // See if the user wants it added to a library table (global or project)
     SYMBOL_LIB_TABLE* libTable = selectSymLibTable( true );
 
     if( libTable )
     {
         if( !m_libMgr->AddLibrary( fn.GetFullPath(), libTable ) )
         {
             DisplayError( this, _( "Could not open the library file." ) );
             return;
         }
 
         bool globalTable = ( libTable == &SYMBOL_LIB_TABLE::GetGlobalLibTable() );
         saveSymbolLibTables( globalTable, !globalTable );
     }
 }

References _, SYMBOL_LIBRARY_MANAGER::AddLibrary(), DisplayError(), DisplayErrorMessage(), KIDIALOG::DoNotShowCheckbox(), LIB_SYMBOL::Flatten(), SYMBOL_LIB_TABLE::GetGlobalLibTable(), LIB_SYMBOL::GetName(), getTargetSymbol(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), KiCadSymbolLibFileExtension, KiCadSymbolLibFileWildcard(), m_libMgr, EDA_BASE_FRAME::m_mruPath, SCH_BASE_FRAME::saveSymbolLibTables(), selectSymLibTable(), EDA_BASE_FRAME::ShowInfoBarError(), KIDIALOG::ShowModal(), UnescapeString(), and IO_ERROR::What().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 833 of file eda_base_frame.cpp.

 {
 #if defined( __WXOSX_MAC__ )
     m_auimgr.Update();
 #else
     // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
     // hiding it.
     m_auimgr.Update();
 
     // We don't want the infobar displayed right away
     m_auimgr.GetPane( "InfoBar" ).Hide();
     m_auimgr.Update();
 #endif
 }

References EDA_BASE_FRAME::m_auimgr.

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const wxPoint & aPos )

inherited

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

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

Parameters

aPos	is the point to go to.

Definition at line 851 of file eda_draw_frame.cpp.

 {
     bool  centerView = false;
     BOX2D r = GetCanvas()->GetView()->GetViewport();
 
     // Center if we're off the current view, or within 10% of its edge
     r.Inflate( - (int) r.GetWidth() / 10 );
 
     if( !r.Contains( aPos ) )
         centerView = true;
 
     // Center if we're behind an obscuring dialog, or within 10% of its edge
     wxWindow* dialog = findDialog( GetChildren() );
 
     if( dialog )
     {
         wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
                            dialog->GetSize() );
         dialogRect.Inflate( dialogRect.GetWidth() / 10 );
 
         if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
             centerView = true;
     }
 
     if( centerView )
     {
         // If a dialog partly obscures the window, then center on the uncovered area.
         if( dialog )
         {
             BOX2D dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
                               dialog->GetSize() );
             GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
         }
         else
             GetCanvas()->GetView()->SetCenter( aPos );
     }
 
     GetCanvas()->GetViewControls()->SetCrossHairCursorPosition( aPos );
 }

References BOX2< Vec >::Contains(), findDialog(), 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(), and KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition().

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

◆ FreezeLibraryTree()

void SYMBOL_EDIT_FRAME::FreezeLibraryTree ( )

Definition at line 592 of file symbol_edit_frame.cpp.

 {
     m_treePane->Freeze();
     m_libMgr->GetAdapter()->Freeze();
 }

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

Referenced by saveLibrary().

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 513 of file eda_base_frame.h.

513 { return m_aboutTitle; }

EDA_BASE_FRAME::m_aboutTitle

wxString m_aboutTitle

Definition: eda_base_frame.h:703

References EDA_BASE_FRAME::m_aboutTitle.

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

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )

inlinestaticprotectedinherited

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

Definition at line 601 of file eda_base_frame.h.

     {
         return wxT( "_autosave-" );
     }

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inlineinherited

Definition at line 204 of file eda_base_frame.h.

204 { return m_autoSaveInterval; }

EDA_BASE_FRAME::m_autoSaveInterval

int m_autoSaveInterval

Definition: eda_base_frame.h:719

References EDA_BASE_FRAME::m_autoSaveInterval.

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

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

References EDA_DRAW_FRAME::GetCanvas().

◆ GetColorSettings()

COLOR_SETTINGS * SYMBOL_EDIT_FRAME::GetColorSettings ( ) const

overridevirtual

Returns a pointer to the active color theme settings.

Reimplemented from SCH_BASE_FRAME.

Definition at line 296 of file symbol_edit_frame.cpp.

 {
     SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 
     if( GetSettings()->m_UseEeschemaColorSettings )
         return mgr.GetColorSettings( mgr.GetAppSettings<EESCHEMA_SETTINGS>()->m_ColorTheme );
     else
         return mgr.GetColorSettings( GetSettings()->m_ColorTheme );
 }

References SETTINGS_MANAGER::GetAppSettings(), SETTINGS_MANAGER::GetColorSettings(), GetSettings(), APP_SETTINGS_BASE::m_ColorTheme, and Pgm().

Referenced by SVGPlotSymbol().

◆ GetConvert()

int SYMBOL_EDIT_FRAME::GetConvert ( ) const

inline

Definition at line 224 of file symbol_edit_frame.h.

224 { return m_convert; }

SYMBOL_EDIT_FRAME::m_convert

int m_convert

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

Definition: symbol_edit_frame.h:542

References m_convert.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_EDITOR_PIN_TOOL::CreatePin(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), EE_SELECTION_TOOL::Init(), LoadSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), EE_SELECTION_TOOL::Reset(), EE_SELECTION_TOOL::Selectable(), SetCurSymbol(), SVGPlotSymbol(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ GetCurLib()

wxString SYMBOL_EDIT_FRAME::GetCurLib ( ) const

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

Definition at line 650 of file symbol_edit_frame.cpp.

 {
     wxString libNickname = Prj().GetRString( PROJECT::SCH_LIBEDIT_CUR_LIB );
 
     if( !libNickname.empty() )
     {
         if( !Prj().SchSymbolLibTable()->HasLibrary( libNickname ) )
         {
             Prj().SetRString( PROJECT::SCH_LIBEDIT_CUR_LIB, wxEmptyString );
             libNickname = wxEmptyString;
         }
     }
 
     return libNickname;
 }

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

Referenced by GetSymbolFromRedoList(), GetSymbolFromUndoList(), 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 PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 439 of file eda_base_frame.h.

439 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

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

 {
     return m_toolManager->GetTool<EE_SELECTION_TOOL>()->GetSelection();
 }

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

◆ GetCurrentTreeNode()

LIB_TREE_NODE * SYMBOL_EDIT_FRAME::GetCurrentTreeNode ( ) const

Definition at line 891 of file symbol_edit_frame.cpp.

 {
     return m_treePane->GetLibTree()->GetCurrentTreeNode();
 }

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

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

◆ 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 103 of file symbol_edit_frame.h.

103 { return m_symbol; }

SYMBOL_EDIT_FRAME::m_symbol

LIB_SYMBOL * m_symbol

Definition: symbol_edit_frame.h:530

References m_symbol.

◆ GetDocumentExtents()

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

overridevirtual

Returns bbox of document with option to not include some items.

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

Parameters

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

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1151 of file symbol_edit_frame.cpp.

 {
     if( !m_symbol )
     {
         return BOX2I( VECTOR2I( Mils2iu( -100 ), Mils2iu( -100 ) ),
                       VECTOR2I( Mils2iu( 200 ), Mils2iu( 200 ) ) );
     }
     else
     {
         EDA_RECT boundingBox = m_symbol->Flatten()->GetUnitBoundingBox( m_unit, m_convert );
         return BOX2I( boundingBox.GetOrigin(), VECTOR2I( boundingBox.GetWidth(),
                                                          boundingBox.GetHeight() ) );
     }
 }

References boundingBox(), LIB_SYMBOL::Flatten(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetWidth(), m_convert, m_symbol, and m_unit.

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const

inlineinherited

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

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

Definition at line 129 of file tools_holder.h.

129 { return m_immediateActions; }

TOOLS_HOLDER::m_immediateActions

bool m_immediateActions

Definition: tools_holder.h:171

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

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

Definition at line 135 of file tools_holder.h.

135 { return m_dragAction; }

TOOLS_HOLDER::m_dragAction

MOUSE_DRAG_ACTION m_dragAction

Definition: tools_holder.h:175

References TOOLS_HOLDER::m_dragAction.

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

◆ GetDrawBgColor()

COLOR4D SCH_BASE_FRAME::GetDrawBgColor ( ) const

overridevirtualinherited

Reimplemented from EDA_DRAW_FRAME.

Definition at line 436 of file sch_base_frame.cpp.

 {
     return GetColorSettings()->GetColor( LAYER_SCHEMATIC_BACKGROUND );
 }

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

Referenced by SCH_PRINTOUT::PrintPage().

◆ GetFileFromHistory()

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

inherited

Fetches the file name from the file history list.

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

Parameters

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

Returns: a wxString containing the selected filename

Definition at line 916 of file eda_base_frame.cpp.

 {
     if( !aFileHistory )
         aFileHistory = m_fileHistory;
 
     wxASSERT( aFileHistory );
 
     int baseId = aFileHistory->GetBaseId();
 
     wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
 
     unsigned i = cmdId - baseId;
 
     if( i < aFileHistory->GetCount() )
     {
         wxString fn = aFileHistory->GetHistoryFile( i );
 
         if( wxFileName::FileExists( fn ) )
         {
             return fn;
         }
         else
         {
             DisplayErrorMessage( this, wxString::Format( _( "File '%s' was not found." ), fn ) );
             aFileHistory->RemoveFileFromHistory( i );
         }
     }
 
     // Update the menubar to update the file history menu
     if( GetMenuBar() )
     {
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 
     return wxEmptyString;
 }

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

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

◆ GetFileHistory()

FILE_HISTORY& EDA_BASE_FRAME::GetFileHistory ( )

inlineinherited

Get the frame's main file history.

Returns: the main file history

Definition at line 423 of file eda_base_frame.h.

     {
         return *m_fileHistory;
     }

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )

inlineinherited

Definition at line 106 of file eda_draw_frame.h.

106 { return m_findStringHistoryList; }

EDA_DRAW_FRAME::m_findStringHistoryList

wxArrayString m_findStringHistoryList

Definition: eda_draw_frame.h:513

References EDA_DRAW_FRAME::m_findStringHistoryList.

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

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )

inlineinherited

Definition at line 105 of file eda_draw_frame.h.

105 { return *m_findReplaceData; }

EDA_DRAW_FRAME::m_findReplaceData

wxFindReplaceData * m_findReplaceData

Definition: eda_draw_frame.h:512

References EDA_DRAW_FRAME::m_findReplaceData.

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

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 207 of file eda_base_frame.h.

207 { return m_ident; }

EDA_BASE_FRAME::m_ident

FRAME_T m_ident

Definition: eda_base_frame.h:693

References EDA_BASE_FRAME::m_ident.

◆ GetGalDisplayOptions()

KIGFX::GAL_DISPLAY_OPTIONS& EDA_DRAW_FRAME::GetGalDisplayOptions ( )

inlineinherited

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

Definition at line 430 of file eda_draw_frame.h.

430 { return m_galDisplayOptions; }

EDA_DRAW_FRAME::m_galDisplayOptions

KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions

Default display origin transforms object.

Definition: eda_draw_frame.h:529

References EDA_DRAW_FRAME::m_galDisplayOptions.

Referenced by SCH_BASE_FRAME::createCanvas(), EDITOR_CONDITIONS::cursorFunc(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_VIEWER_FRAME::LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), DIALOG_PAD_PROPERTIES::prepareCanvas(), FOOTPRINT_EDIT_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), SaveSettings(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), COMMON_TOOLS::ToggleCursor(), and COMMON_TOOLS::ToggleCursorStyle().

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )

inlinevirtualinherited

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

Definition at line 227 of file eda_draw_frame.h.

227 { return m_gridColor; }

EDA_DRAW_FRAME::m_gridColor

COLOR4D m_gridColor

Definition: eda_draw_frame.h:494

References EDA_DRAW_FRAME::m_gridColor.

Referenced by PCB_CONTROL::Reset().

◆ GetGridOrigin()

const wxPoint& 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 124 of file sch_base_frame.h.

     {
         static wxPoint zero;
         return zero;
     }

◆ GetInfoBar()

WX_INFOBAR* EDA_BASE_FRAME::GetInfoBar ( )

inlineinherited

Returns: the WX_INFOBAR that can be displayed on the top of the canvas.

Definition at line 234 of file eda_base_frame.h.

234 { return m_infoBar; }

EDA_BASE_FRAME::m_infoBar

WX_INFOBAR * m_infoBar

Definition: eda_base_frame.h:708

References EDA_BASE_FRAME::m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), LoadOneLibrarySymbolAux(), APPEARANCE_CONTROLS::onReadOnlySwatch(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SetCurSymbol(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), EDA_BASE_FRAME::ShowInfoBarWarning(), SCH_DRAWING_TOOLS::SingleClickPlace(), and PCB_CONTROL::unfilledZoneCheck().

◆ GetItem()

virtual EDA_ITEM* EDA_DRAW_FRAME::GetItem ( const KIID & aId ) const

inlinevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 398 of file eda_draw_frame.h.

398 { return nullptr; }

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

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

 {
     return GetColorSettings()->GetColor( aLayer );
 }

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

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard().

◆ GetLibManager()

SYMBOL_LIBRARY_MANAGER & SYMBOL_EDIT_FRAME::GetLibManager ( )

Definition at line 777 of file symbol_edit_frame.cpp.

 {
     wxASSERT( m_libMgr );
     return *m_libMgr;
 }

References m_libMgr.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), 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 194 of file sch_base_frame.cpp.

 {
     SYMBOL_LIB* cache = ( aUseCacheLib ) ? Prj().SchLibs()->GetCacheLibrary() : nullptr;
 
     return SchGetLibSymbol( aLibId, Prj().SchSymbolLibTable(), cache, this, aShowErrorMsg );
 }

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

Referenced by SCH_EDIT_FRAME::CreateArchiveLibrary(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_BASE_FRAME::PickSymbolFromLibTree(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and DIALOG_CHANGE_SYMBOLS::updateFieldsList().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 581 of file eda_base_frame.h.

581 { return m_undoRedoCountMax; }

EDA_BASE_FRAME::m_undoRedoCountMax

int m_undoRedoCountMax

Definition: eda_base_frame.h:722

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

141 { return m_moveWarpsCursor; }

TOOLS_HOLDER::m_moveWarpsCursor

bool m_moveWarpsCursor

Definition: tools_holder.h:177

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 430 of file eda_base_frame.h.

430 { return m_mruPath; }

EDA_BASE_FRAME::m_mruPath

wxString m_mruPath

Definition: eda_base_frame.h:727

References EDA_BASE_FRAME::m_mruPath.

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

◆ GetNearestGridPosition()

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

inherited

Return the nearest aGridSize location to aPosition.

Parameters

aPosition The position to check.

Returns: The nearest grid position.

Definition at line 792 of file eda_draw_frame.cpp.

 {
     const wxPoint& gridOrigin = GetGridOrigin();
     VECTOR2D       gridSize = GetCanvas()->GetGAL()->GetGridSize();
 
     double xOffset = fmod( gridOrigin.x, gridSize.x );
     int    x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
     double yOffset = fmod( gridOrigin.y, gridSize.y );
     int    y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
 
     return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
 }

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

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), and SCH_DRAWING_TOOLS::sizeSheet().

◆ GetNearestHalfGridPosition()

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

inherited

Return the nearest aGridSize / 2 location to aPosition.

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

Parameters

aPosition The position to check.

Returns: The nearest half-grid position.

Definition at line 806 of file eda_draw_frame.cpp.

 {
     const wxPoint& gridOrigin = GetGridOrigin();
     VECTOR2D       gridSize = GetCanvas()->GetGAL()->GetGridSize() / 2.0;
 
     double xOffset = fmod( gridOrigin.x, gridSize.x );
     int    x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
     double yOffset = fmod( gridOrigin.y, gridSize.y );
     int    y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
 
     return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
 }

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

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

◆ GetOriginTransforms()

virtual ORIGIN_TRANSFORMS& EDA_DRAW_FRAME::GetOriginTransforms ( )

inlinevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented in PCB_BASE_FRAME.

Definition at line 164 of file eda_draw_frame.h.

165 { return m_originTransforms; }

EDA_DRAW_FRAME::m_originTransforms

ORIGIN_TRANSFORMS m_originTransforms

Definition: eda_draw_frame.h:532

References EDA_DRAW_FRAME::m_originTransforms.

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

◆ GetPageSettings()

const PAGE_INFO & SCH_BASE_FRAME::GetPageSettings ( ) const

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 134 of file sch_base_frame.cpp.

 {
     return GetScreen()->GetPageSettings();
 }

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

Referenced by DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF().

◆ GetPageSizeIU()

const wxSize 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 140 of file sch_base_frame.cpp.

 {
     // GetSizeIU is compile time dependent:
     return GetScreen()->GetPageSettings().GetSizeIU();
 }

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

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 579 of file eda_base_frame.h.

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

UNDO_REDO_CONTAINER::m_CommandsList

std::vector< PICKED_ITEMS_LIST * > m_CommandsList

Definition: undo_redo_container.h:308

EDA_BASE_FRAME::m_redoList

UNDO_REDO_CONTAINER m_redoList

Definition: eda_base_frame.h:725

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

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

◆ GetRenderSettings()

KIGFX::SCH_RENDER_SETTINGS * SCH_BASE_FRAME::GetRenderSettings ( )

inherited

Definition at line 278 of file sch_base_frame.cpp.

 {
     KIGFX::PAINTER* painter = GetCanvas()->GetView()->GetPainter();
     return static_cast<KIGFX::SCH_RENDER_SETTINGS*>( painter->GetSettings() );
 }

References SCH_BASE_FRAME::GetCanvas(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), and SCH_DRAW_PANEL::GetView().

Referenced by DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), SCH_EDIT_FRAME::LoadProjectSettings(), SYMBOL_VIEWER_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSettings(), LoadSettings(), DIALOG_PIN_PROPERTIES::OnPaintShowPanel(), DIALOG_PLOT_SCHEMATIC::plotSchematic(), SCH_PRINTOUT::PrintPage(), RebuildView(), SYMBOL_VIEWER_FRAME::SaveSettings(), SaveSettings(), SetCurSymbol(), SYMBOL_VIEWER_FRAME::setupUIConditions(), setupUIConditions(), SYMBOL_EDITOR_CONTROL::ShowElectricalTypes(), SVGPlotSymbol(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), PANEL_SYM_EDITING_OPTIONS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), PANEL_SYM_EDITING_OPTIONS::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 110 of file sch_base_frame.cpp.

 {
     return (SCH_SCREEN*) EDA_DRAW_FRAME::GetScreen();
 }

References EDA_DRAW_FRAME::GetScreen().

Referenced by SCH_BASE_FRAME::AddToScreen(), EE_SELECTION_TOOL::CollectHits(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), EE_SELECTION_TOOL::GetNode(), SCH_BASE_FRAME::GetPageSettings(), SCH_BASE_FRAME::GetPageSizeIU(), GetSymbolFromRedoList(), GetSymbolFromUndoList(), SCH_BASE_FRAME::GetTitleBlock(), IsContentModified(), LoadOneLibrarySymbolAux(), LoadSymbol(), EDIT_POINTS_FACTORY::Make(), OnModify(), PrintPage(), EE_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RemoveFromScreen(), Save(), SaveCopyInUndoList(), EE_SELECTION_TOOL::SelectConnection(), SCH_BASE_FRAME::SetPageSettings(), SCH_BASE_FRAME::SetTitleBlock(), SYMBOL_VIEWER_FRAME::setupTools(), setupTools(), storeCurrentSymbol(), SVGPlotSymbol(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), SCH_BASE_FRAME::UpdateStatusBar(), updateTitle(), and ~SYMBOL_EDIT_FRAME().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 948 of file eda_draw_frame.cpp.

 {
     // Virtual function. Base class implementation returns an empty string.
     return wxEmptyString;
 }

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), and EDA_DRAW_FRAME::PrintDrawingSheet().

◆ GetSettings()

SYMBOL_EDITOR_SETTINGS* SYMBOL_EDIT_FRAME::GetSettings ( ) const

inline

Definition at line 194 of file symbol_edit_frame.h.

     {
         return m_settings;
     }

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(), PANEL_SYM_EDITING_OPTIONS::TransferDataFromWindow(), PANEL_SYM_EDITING_OPTIONS::TransferDataToWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), 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 140 of file eda_base_frame.h.

140 { return m_settingsManager; }

EDA_BASE_FRAME::m_settingsManager

SETTINGS_MANAGER * m_settingsManager

Definition: eda_base_frame.h:713

References EDA_BASE_FRAME::m_settingsManager.

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CreateNewProject(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_PLOT_SCHEMATIC::getColorSettings(), GetSettingsManager(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), SCH_EDIT_FRAME::OnImportProject(), GERBER_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int aErrorCode ) const

inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME.

Definition at line 142 of file eda_base_frame.h.

142 { return RPT_SEVERITY_UNDEFINED; }

RPT_SEVERITY_UNDEFINED

Definition: report_severity.h:27

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

118 { return true; }

Referenced by EE_SELECTION_TOOL::Selectable().

◆ GetShowDeMorgan()

bool SYMBOL_EDIT_FRAME::GetShowDeMorgan ( ) const

inline

Definition at line 227 of file symbol_edit_frame.h.

227 { return m_showDeMorgan; }

SYMBOL_EDIT_FRAME::m_showDeMorgan

static bool m_showDeMorgan

Definition: symbol_edit_frame.h:557

References m_showDeMorgan.

Referenced by setupUIConditions(), and DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow().

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const

inlineinherited

For those frames that support polar coordinates.

Definition at line 120 of file eda_draw_frame.h.

120 { return m_polarCoords; }

EDA_DRAW_FRAME::m_polarCoords

bool m_polarCoords

Definition: eda_draw_frame.h:499

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

Definition at line 59 of file symbol_editor_undo_redo.cpp.

 {
     if( GetRedoCommandCount() <= 0 )
         return;
 
     m_toolManager->RunAction( EE_ACTIONS::clearSelection, true );
 
     // Load the last redo entry
     PICKED_ITEMS_LIST* redoCommand = PopCommandFromRedoList();
     ITEM_PICKER redoWrapper = redoCommand->PopItem();
     delete redoCommand;
     LIB_SYMBOL* symbol = (LIB_SYMBOL*) redoWrapper.GetItem();
     wxCHECK( symbol, /* void */ );
     symbol->ClearFlags( UR_TRANSIENT );
     UNDO_REDO undoRedoType = redoWrapper.GetStatus();
 
     // Store the current symbol in the undo buffer
     PICKED_ITEMS_LIST* undoCommand = new PICKED_ITEMS_LIST();
     LIB_SYMBOL* oldSymbol = m_symbol;
     oldSymbol->SetFlags( UR_TRANSIENT );
     ITEM_PICKER undoWrapper( GetScreen(), oldSymbol, undoRedoType );
     undoCommand->PushItem( undoWrapper );
     PushCommandToUndoList( undoCommand );
 
     // Do not delete the previous symbol by calling SetCurSymbol( symbol )
     // which calls delete <previous symbol>.
     // <previous symbol> is now put in undo list and is owned by this list
     // Just set the current symbol to the symbol which come from the redo list
     m_symbol = symbol;
 
     if( undoRedoType == UNDO_REDO::LIB_RENAME )
     {
         wxString lib = GetCurLib();
         m_libMgr->UpdateSymbolAfterRename( symbol, oldSymbol->GetName(), lib );
 
         // Reselect the renamed symbol
         m_treePane->GetLibTree()->SelectLibId( LIB_ID( lib, symbol->GetName() ) );
     }
 
     RebuildSymbolUnitsList();
     SetShowDeMorgan( symbol->HasConversion() );
     updateTitle();
 
     RebuildView();
     OnModify();
 }

References EDA_ITEM::ClearFlags(), EE_ACTIONS::clearSelection, GetCurLib(), ITEM_PICKER::GetItem(), SYMBOL_TREE_PANE::GetLibTree(), LIB_SYMBOL::GetName(), EDA_BASE_FRAME::GetRedoCommandCount(), SCH_BASE_FRAME::GetScreen(), ITEM_PICKER::GetStatus(), LIB_SYMBOL::HasConversion(), LIB_RENAME, m_libMgr, m_symbol, TOOLS_HOLDER::m_toolManager, m_treePane, OnModify(), EDA_BASE_FRAME::PopCommandFromRedoList(), PICKED_ITEMS_LIST::PopItem(), EDA_BASE_FRAME::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), RebuildSymbolUnitsList(), RebuildView(), TOOL_MANAGER::RunAction(), LIB_TREE::SelectLibId(), EDA_ITEM::SetFlags(), SetShowDeMorgan(), SYMBOL_LIBRARY_MANAGER::UpdateSymbolAfterRename(), updateTitle(), and UR_TRANSIENT.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Redo().

◆ GetSymbolFromUndoList()

void SYMBOL_EDIT_FRAME::GetSymbolFromUndoList ( )

Definition at line 107 of file symbol_editor_undo_redo.cpp.

 {
     if( GetUndoCommandCount() <= 0 )
         return;
 
     m_toolManager->RunAction( EE_ACTIONS::clearSelection, true );
 
     // Load the last undo entry
     PICKED_ITEMS_LIST* undoCommand = PopCommandFromUndoList();
     ITEM_PICKER undoWrapper = undoCommand->PopItem();
     delete undoCommand;
     LIB_SYMBOL* symbol = (LIB_SYMBOL*) undoWrapper.GetItem();
     wxCHECK( symbol, /* void */ );
     symbol->ClearFlags( UR_TRANSIENT );
     UNDO_REDO undoRedoType = undoWrapper.GetStatus();
 
     // Store the current symbol in the redo buffer
     PICKED_ITEMS_LIST* redoCommand = new PICKED_ITEMS_LIST();
     LIB_SYMBOL* oldSymbol = m_symbol;
     oldSymbol->SetFlags( UR_TRANSIENT );
     ITEM_PICKER redoWrapper( GetScreen(), oldSymbol, undoRedoType );
     redoCommand->PushItem( redoWrapper );
     PushCommandToRedoList( redoCommand );
 
     // Do not delete the previous symbol by calling SetCurSymbol( symbol ),
     // which calls delete <previous symbol>.
     // <previous symbol> is now put in redo list and is owned by this list.
     // Just set the current symbol to the symbol which come from the undo list
     m_symbol = symbol;
 
     if( undoRedoType == UNDO_REDO::LIB_RENAME )
     {
         wxString lib = GetCurLib();
         m_libMgr->UpdateSymbolAfterRename( symbol, oldSymbol->GetName(), lib );
 
         // Reselect the renamed symbol
         m_treePane->GetLibTree()->SelectLibId( LIB_ID( lib, symbol->GetName() ) );
     }
 
     RebuildSymbolUnitsList();
     SetShowDeMorgan( symbol->HasConversion() );
     updateTitle();
 
     RebuildView();
     OnModify();
 }

References EDA_ITEM::ClearFlags(), EE_ACTIONS::clearSelection, GetCurLib(), ITEM_PICKER::GetItem(), SYMBOL_TREE_PANE::GetLibTree(), LIB_SYMBOL::GetName(), SCH_BASE_FRAME::GetScreen(), ITEM_PICKER::GetStatus(), EDA_BASE_FRAME::GetUndoCommandCount(), LIB_SYMBOL::HasConversion(), LIB_RENAME, m_libMgr, m_symbol, TOOLS_HOLDER::m_toolManager, m_treePane, OnModify(), EDA_BASE_FRAME::PopCommandFromUndoList(), PICKED_ITEMS_LIST::PopItem(), EDA_BASE_FRAME::PushCommandToRedoList(), PICKED_ITEMS_LIST::PushItem(), RebuildSymbolUnitsList(), RebuildView(), TOOL_MANAGER::RunAction(), LIB_TREE::SelectLibId(), 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 897 of file symbol_edit_frame.cpp.

 {
     return GetTargetLibId().GetLibNickname();
 }

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

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

◆ GetTargetLibId()

LIB_ID SYMBOL_EDIT_FRAME::GetTargetLibId ( ) const

Definition at line 880 of file symbol_edit_frame.cpp.

 {
     LIB_ID id = GetTreeLIBID();
 
     if( id.GetLibNickname().empty() && m_symbol )
         id = m_symbol->GetLibId();
 
     return id;
 }

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

Referenced by DeleteSymbolFromLibrary(), getTargetLib(), SYMBOL_EDITOR_CONTROL::Init(), RegenerateLibraryTree(), Revert(), Save(), SaveLibraryAs(), SaveSymbolAs(), 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 866 of file symbol_edit_frame.cpp.

 {
     LIB_ID libId = GetTreeLIBID();
 
     if( libId.IsValid() )
     {
         LIB_SYMBOL* alias = m_libMgr->GetAlias( libId.GetLibItemName(), libId.GetLibNickname() );
         return alias;
     }
 
     return m_symbol;
 }

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

Referenced by ExportSymbol(), Save(), and saveSymbolAs().

◆ GetTitleBlock()

const TITLE_BLOCK & SCH_BASE_FRAME::GetTitleBlock ( ) const

overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 147 of file sch_base_frame.cpp.

 {
     wxASSERT( GetScreen() );
     return GetScreen()->GetTitleBlock();
 }

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

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), and DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG().

◆ GetToolCanvas()

wxWindow* EDA_DRAW_FRAME::GetToolCanvas ( ) const

inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 425 of file eda_draw_frame.h.

425 { return GetCanvas(); }

EDA_DRAW_FRAME::GetCanvas

virtual EDA_DRAW_PANEL_GAL * GetCanvas() const

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

Definition: eda_draw_frame.h:422

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 54 of file tools_holder.h.

54 { return m_toolManager; }

TOOLS_HOLDER::m_toolManager

TOOL_MANAGER * m_toolManager

Definition: tools_holder.h:158

References TOOLS_HOLDER::m_toolManager.

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

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

 {
     return m_treePane->GetLibTree()->GetSelectedLibId( aUnit );
 }

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

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditSymbol(), GetTargetLibId(), getTargetSymbol(), and SYMBOL_EDITOR_CONTROL::Init().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

46 { return m_type; }

KIWAY_HOLDER::m_type

HOLDER_TYPE m_type

Definition: kiway_holder.h:76

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 578 of file eda_base_frame.h.

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

EDA_BASE_FRAME::m_undoList

UNDO_REDO_CONTAINER m_undoList

Definition: eda_base_frame.h:724

UNDO_REDO_CONTAINER::m_CommandsList

std::vector< PICKED_ITEMS_LIST * > m_CommandsList

Definition: undo_redo_container.h:308

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

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), GetSymbolFromUndoList(), EDA_BASE_FRAME::PushCommandToUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), 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
	)

inherited

Get the pair or units in current use.

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

Definition at line 1060 of file eda_draw_frame.cpp.

 {
     COMMON_TOOLS* cmnTool = m_toolManager->GetTool<COMMON_TOOLS>();
 
     aPrimaryUnit    = GetUserUnits();
     aSecondaryUnits = EDA_UNITS::MILS;
 
     if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
     {
         if( cmnTool )
             aSecondaryUnits = cmnTool->GetLastMetricUnits();
         else
             aSecondaryUnits = EDA_UNITS::MILLIMETRES;
     }
     else
     {
         if( cmnTool )
             aSecondaryUnits = cmnTool->GetLastImperialUnits();
         else
             aSecondaryUnits = EDA_UNITS::MILS;
     }
 }

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

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

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const

inlineinherited

Return the user units currently in use.

Definition at line 126 of file eda_base_frame.h.

     {
         return m_userUnits;
     }

References EDA_BASE_FRAME::m_userUnits.

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE * aCfg )

virtualinherited

Return a pointer to the window settings for this frame.

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

Parameters

aCfg	is this frame's config object

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

Definition at line 790 of file eda_base_frame.cpp.

 {
     return &aCfg->m_Window;
 }

References APP_SETTINGS_BASE::m_Window.

Referenced by EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), EDA_BASE_FRAME::SaveSettings(), and EDA_DRAW_FRAME::SaveSettings().

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )

inherited

Get the undecorated window size that can be used for restoring the window size.

This is needed for GTK, since the normal wxWidgets GetSize() call will return a window size that includes the window decorations added by the window manager.

Returns: the undecorated window size

Definition at line 1215 of file eda_base_frame.cpp.

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

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

 {
     // returns a human readable value which can be displayed as zoom
     // level indicator in dialogs.
     double zoom = m_canvas->GetGAL()->GetZoomFactor();
     return wxString::Format( wxT( "Z %.2f" ), zoom );
 }

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

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

◆ handleActivateEvent()

void EDA_DRAW_FRAME::handleActivateEvent ( wxActivateEvent & aEvent )

protectedvirtualinherited

Handle a window activation event.

Reimplemented in PCB_BASE_EDIT_FRAME.

Definition at line 1133 of file eda_draw_frame.cpp.

 {
     // Force a refresh of the message panel to ensure that the text is the right color
     // when the window activates
     if( !IsIconized() )
         m_messagePanel->Refresh();
 }

References EDA_DRAW_FRAME::m_messagePanel.

Referenced by PCB_BASE_EDIT_FRAME::handleActivateEvent(), and EDA_DRAW_FRAME::onActivate().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

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

Definition at line 1234 of file eda_base_frame.cpp.

 {
     // Update the icon theme when the system theme changes and update the toolbars
     GetBitmapStore()->ThemeChanged();
     ThemeChanged();
 
     // This isn't handled by ThemeChanged()
     if( GetMenuBar() )
     {
         // For icons in menus, icon scaling & hotkeys
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 }

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

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

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

staticinherited

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

enabled, checked, etc.).

Parameters

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

Definition at line 372 of file eda_base_frame.cpp.

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

References ACTION_CONDITIONS::checkCondition, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), and ACTION_CONDITIONS::showCondition.

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

 {
     SyncLibraries( true );
 
     if( m_symbol )
     {
         EE_SELECTION_TOOL* selectionTool = m_toolManager->GetTool<EE_SELECTION_TOOL>();
         EE_SELECTION&      selection = selectionTool->GetSelection();
 
         for( LIB_ITEM& item : m_symbol->GetDrawItems() )
         {
             if( !alg::contains( selection, &item ) )
                 item.ClearSelected();
             else
                 item.SetSelected();
         }
     }
 
     RebuildView();
 }

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

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

 {
     wxCHECK( m_libMgr, false );
 
     return m_libMgr->HasModifications();
 }

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

 {
     return Kiface().GetHelpFileName();
 }

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

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

inherited

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

Parameters

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

◆ ImportSymbol()

void SYMBOL_EDIT_FRAME::ImportSymbol ( )

Definition at line 37 of file symbol_editor_import_export.cpp.

 {
     wxString msg;
     wxString libName = getTargetLib();
 
     if( !m_libMgr->LibraryExists( libName ) )
     {
         libName = SelectLibraryFromList();
 
         if( !m_libMgr->LibraryExists( libName ) )
             return;
     }
 
     wxString wildcards = KiCadSymbolLibFileWildcard();
 
     wildcards += "|" + LegacySymbolLibFileWildcard();
 
     wxFileDialog dlg( this, _( "Import Symbol" ), m_mruPath, wxEmptyString,
                       wildcards, wxFD_OPEN | wxFD_FILE_MUST_EXIST );
 
     if( dlg.ShowModal() == wxID_CANCEL )
         return;
 
     wxFileName fn = dlg.GetPath();
 
     if( fn.GetExt().IsEmpty() )
         fn.SetExt( (dlg.GetFilterIndex() == 0) ?
                    KiCadSymbolLibFileExtension : LegacySymbolLibFileExtension );
 
     m_mruPath = fn.GetPath();
 
     wxArrayString symbols;
     SCH_IO_MGR::SCH_FILE_T piType = SCH_IO_MGR::GuessPluginTypeFromLibPath( fn.GetFullPath() );
     SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( SCH_IO_MGR::FindPlugin( piType ) );
 

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

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

◆ AddLibraryFile()

◆ addLibTableEntry()

◆ AddStandardHelpMenu()

◆ AddStandardSubMenus()

◆ AddToScreen()

◆ AppendMsgPanel()

◆ backupFile()

◆ canCloseWindow()

◆ CenterScreen()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ ClearFileHistory()

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ CloseWindow()

◆ CommonSettingsChanged()

◆ config()

◆ ConfigBaseName()

◆ CopySymbolToClipboard()

◆ createCanvas()

◆ CreateInfoBar()

◆ CreateNewSymbol()

◆ CreateServer()

◆ CurrentToolName()

◆ DeleteSymbolFromLibrary()

◆ Destroy()

◆ DismissModal()

◆ DisplayGridMsg()

◆ DisplayToolMsg()

◆ DisplayUnitsMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ DuplicateSymbol()

◆ eeconfig()

◆ emptyScreen()

◆ ensureUniqueName()

◆ ensureWindowIsOnScreen()

◆ EraseMsgBox()

◆ ExecuteRemoteCommand()

◆ ExportSymbol()

◆ FinishAUIInitialization()

◆ FocusOnLocation()

◆ FreezeLibraryTree()

◆ GetAboutTitle()

◆ GetAutoSaveFilePrefix()

◆ GetAutoSaveInterval()

◆ GetCanvas()

◆ GetColorSettings()

◆ GetConvert()

◆ GetCurLib()

◆ GetCurrentFileName()

◆ GetCurrentSelection()

◆ GetCurrentTreeNode()

◆ GetCurSymbol()

◆ GetDocumentExtents()

◆ GetDoImmediateActions()

◆ GetDragAction()