The main window used in the drawing sheet editor. More...

#include <pl_editor_frame.h>

Inheritance diagram for PL_EDITOR_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
	PL_EDITOR_FRAME (KIWAY aKiway, wxWindow aParent)

	~PL_EDITOR_FRAME ()

PROPERTIES_FRAME *	GetPropertiesFrame ()

void	ShowDesignInspector ()
	Show the dialog displaying the list of DS_DATA_ITEM items in the page layout.

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

bool	LoadDrawingSheetFile (const wxString &aFullFileName)
	Load a .kicad_wks drawing sheet file.

bool	SaveDrawingSheetFile (const wxString &aFullFileName)
	Save the current layout in a .kicad_wks drawing sheet file.

bool	InsertDrawingSheetFile (const wxString &aFullFileName)
	Load a .kicad_wks drawing sheet file, and add items to the current layout list.

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

void	OnExit (wxCommandEvent &aEvent)
	Event handler for the wxID_EXIT and wxID_CLOSE events.

bool	canCloseWindow (wxCloseEvent &aCloseEvent) override

void	doCloseWindow () override

void	setupTools ()

void	ReCreateHToolbar () override

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

void	SetPageSettings (const PAGE_INFO &) override

const PAGE_INFO &	GetPageSettings () const override

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

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

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

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

void	SetGridOrigin (const VECTOR2I &aPoint) override

VECTOR2I	ReturnCoordOriginCorner () const
	Calculate the position (in page, in iu) of the corner used as coordinate origin of items.

const TITLE_BLOCK &	GetTitleBlock () const override

void	SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override

void	CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
	Notification event that some of the common (suite-wide) settings have changed.

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

void	UpdateStatusBar () override
	Update the status bar information.

void	OnNewDrawingSheet ()
	Must be called to initialize parameters when a new drawing sheet is loaded.

void	ReCreateVToolbar () override
	Create or update the right vertical toolbar.

void	ReCreateOptToolbar () override
	Create or update the left vertical toolbar.

const PL_EDITOR_LAYOUT &	GetPageLayout () const

PL_EDITOR_LAYOUT &	GetPageLayout ()

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

bool	GetPageNumberOption () const
	Drawing sheet editor can show the title block using a page number 1 or another number.

void	UpdateTitleAndInfo ()
	Display the short filename (if exists) loaded file on the caption of the main window.

void	UpdateMsgPanelInfo ()
	Display the size of the sheet to the message panel.

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

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

void	OnSelectPage (wxCommandEvent &event)

void	OnSelectCoordOriginCorner (wxCommandEvent &event)
	Called when the user select one of the 4 page corner as corner reference (or the left top paper corner).

void	ToPrinter (bool doPreview)
	Open a dialog frame to print layers.

void	Files_io (wxCommandEvent &event)

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

void	OnFileHistory (wxCommandEvent &event)

void	OnClearFileHistory (wxCommandEvent &aEvent)

wxString	GetCurrentFileName () const override

void	SetCurrentFileName (const wxString &aName)
	Store the current layout description file filename.

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

DS_DATA_ITEM *	AddDrawingSheetItem (int aType)
	Add a new item to the drawing sheet item list.

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

void	SaveCopyInUndoList ()
	Save a copy of the description (in a S expr string) for Undo/redo commands.

void	GetLayoutFromRedoList ()
	Redo the last edit:

void	GetLayoutFromUndoList ()
	Undo the last edit:

void	RollbackFromUndo ()
	Apply the last command in Undo List without stacking a Redo.

void	ClearUndoORRedoList (UNDO_REDO_LIST whichList, int aItemCount=-1) override
	Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.

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

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

void	ScriptingConsoleEnableDisable ()
	Toggles the scripting console visibility.

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

EDA_SEARCH_DATA &	GetFindReplaceData ()

wxArrayString &	GetFindHistoryList ()

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

void	SetShowPolarCoords (bool aShow)

void	ToggleUserUnits () override

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

virtual std::unique_ptr< GRID_HELPER >	MakeGridHelper ()

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

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

virtual COLOR4D	GetDrawBgColor () const

virtual void	SetDrawBgColor (const COLOR4D &aColor)

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

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

virtual wxString	GetScreenDesc () const

virtual wxString	GetFullScreenDesc () const

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

void	EraseMsgBox ()

virtual void	ReCreateAuxiliaryToolbar ()

bool	IsGridVisible () const

virtual void	SetGridVisibility (bool aVisible)

bool	IsGridOverridden () const

virtual void	SetGridOverrides (bool aOverride)

virtual COLOR4D	GetGridColor ()

virtual void	SetGridColor (const COLOR4D &aColor)

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

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

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

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

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

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

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

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

void	OnMove (wxMoveEvent &aEvent) override

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

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

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

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

void	DisplayToolMsg (const wxString &msg) override

void	DisplayConstraintsMsg (const wxString &msg)

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

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

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

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

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

void	SetMsgPanel (EDA_ITEM *aItem)

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

virtual void	UpdateMsgPanel ()
	Redraw the message panel.

virtual LIB_TREE *	GetLibTree () const

virtual LIB_ID	GetTargetLibId () const

virtual bool	IsLibraryTreeShown () const

virtual void	ToggleLibraryTree ()

virtual void	FocusLibraryTreeInput ()

PROPERTIES_PANEL *	GetPropertiesPanel ()

void	UpdateProperties ()

virtual void	ToggleProperties ()

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

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

virtual void	SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
	Changes the current rendering backend.

void	SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)

wxWindow *	GetToolCanvas () const override
	Canvas access.

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

void	RefreshCanvas () override

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

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

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

HOTKEY_CYCLE_POPUP *	GetHotkeyPopup ()

virtual void	CreateHotkeyPopup ()

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

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

virtual PLUGIN_ACTION_SCOPE	PluginActionScope () const

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

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

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

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

void	SetModal (bool aIsModal)

bool	IsDismissed ()

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

void	CreateServer (int service, bool local=true)

void	OnSockRequest (wxSocketEvent &evt)

void	OnSockRequestServer (wxSocketEvent &evt)

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

void	ChangeUserUnits (EDA_UNITS aUnits)

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

SETTINGS_MANAGER *	GetSettingsManager () const

virtual SEVERITY	GetSeverity (int aErrorCode) const

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

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

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

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

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

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

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

void	OnMaximize (wxMaximizeEvent &aEvent)

int	GetAutoSaveInterval () const

bool	IsType (FRAME_T aType) const

FRAME_T	GetFrameType () const

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

virtual wxString	help_name ()

void	OnKicadAbout (wxCommandEvent &event)

void	OnPreferences (wxCommandEvent &event)

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

void	PrintMsg (const wxString &text)

void	CreateInfoBar ()

void	FinishAUIInitialization ()

WX_INFOBAR *	GetInfoBar ()

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

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

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

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

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

void	LoadWindowState (const wxString &aFileName)

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

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

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

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

wxString	ConfigBaseName () override
	Get the configuration base name.

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

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

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

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

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

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

void	SetMruPath (const wxString &aPath)

wxString	GetMruPath () const

void	ReCreateMenuBar ()
	Recreates the menu bar.

void	SetMenuBar (wxMenuBar *menu_bar) override

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

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

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

virtual void	DeleteAutoSaveFile (const wxFileName &aFileName)

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

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

const wxString &	GetAboutTitle () const

const wxString &	GetUntranslatedAboutTitle () const

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

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

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

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

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

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

virtual int	GetUndoCommandCount () const

virtual int	GetRedoCommandCount () const

virtual wxString	GetUndoActionDescription () const

virtual wxString	GetRedoActionDescription () const

int	GetMaxUndoItems () const

bool	NonUserClose (bool aForce)

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

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

TOOL_MANAGER *	GetToolManager () const
	Return the MVC controller.

TOOL_DISPATCHER *	GetToolDispatcher () const

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

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

bool	ToolStackIsEmpty ()

std::string	CurrentToolName () const

bool	IsCurrentTool (const TOOL_ACTION &aAction) const

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

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

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

HOLDER_TYPE	GetType () const

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

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

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

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

EDA_UNITS	GetUserUnits () const

void	SetUserUnits (EDA_UNITS aUnits)

const EDA_IU_SCALE &	GetIuScale () const

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

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

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

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

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

wxString	MessageTextFromMinOptMax (const MINOPTMAX< int > &aValue) const

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

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

EDA_ANGLE	AngleValueFromString (const wxString &aTextValue) const

Static Public Member Functions
static const wxString	PropertiesPaneName ()

static const wxString	NetInspectorPanelName ()

static const wxString	DesignBlocksPaneName ()

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

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

Protected Member Functions
bool	saveCurrentPageLayout ()

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

void	doReCreateMenuBar () override

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

	DECLARE_EVENT_TABLE ()

virtual void	SetScreen (BASE_SCREEN *aScreen)

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

void	setupUnits (APP_SETTINGS_BASE *aCfg)

void	updateStatusBarWidths ()

std::vector< wxWindow * >	findDialogs ()

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

EDA_DRAW_PANEL_GAL::GAL_TYPE	loadCanvasTypeSetting (APP_SETTINGS_BASE *aCfg=nullptr)
	Returns the canvas type stored in the application settings.

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

void	onActivate (wxActivateEvent &aEvent)

virtual void	addApiPluginTools ()
	Append actions from API plugins to the main toolbar.

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

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

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

void	onIconize (wxIconizeEvent &aEvent)

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

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

void	onSystemColorChange (wxSysColourChangedEvent &aEvent)

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

void	ensureWindowIsOnScreen ()

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

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

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

Protected Attributes
PROPERTIES_FRAME *	m_propertiesPagelayout
	The last filename chosen to be proposed to the user.

wxSocketServer *	m_socketServer
	Prevents opening same file multiple times.

std::unique_ptr< LOCKFILE >	m_file_checker

COLOR4D	m_gridColor

COLOR4D	m_drawBgColor

int	m_undoRedoCountMax

bool	m_polarCoords

bool	m_showBorderAndTitleBlock

wxChoice *	m_gridSelectBox

wxChoice *	m_zoomSelectBox

ACTION_TOOLBAR *	m_mainToolBar

ACTION_TOOLBAR *	m_auxiliaryToolBar

ACTION_TOOLBAR *	m_drawToolBar

ACTION_TOOLBAR *	m_optionsToolBar

std::unique_ptr< EDA_SEARCH_DATA >	m_findReplaceData

wxArrayString	m_findStringHistoryList

wxArrayString	m_replaceStringHistoryList

EDA_MSG_PANEL *	m_messagePanel

int	m_msgFrameHeight

COLOR_SETTINGS *	m_colorSettings

SEARCH_PANE *	m_searchPane

PROPERTIES_PANEL *	m_propertiesPanel

NET_INSPECTOR_PANEL *	m_netInspectorPanel

HOTKEY_CYCLE_POPUP *	m_hotkeyPopup
	The current canvas type.

EDA_DRAW_PANEL_GAL::GAL_TYPE	m_canvasType

bool	m_modal

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

wxWindow *	m_modal_resultant_parent

wxString	m_modal_string

bool	m_modal_ret_val

std::vector< wxSocketBase * >	m_sockets
	interprocess communication

std::vector< wxFileName >	m_AcceptedFiles

FRAME_T	m_ident

wxPoint	m_framePos

wxSize	m_frameSize

bool	m_maximizeByDefault

int	m_displayIndex

wxPoint	m_normalFramePos

wxSize	m_normalFrameSize

wxString	m_aboutTitle

wxAuiManager	m_auimgr

wxString	m_perspective

WX_INFOBAR *	m_infoBar

APPEARANCE_CONTROLS_3D *	m_appearancePanel

wxString	m_configName

SETTINGS_MANAGER *	m_settingsManager

FILE_HISTORY *	m_fileHistory

bool	m_supportsAutoSave

bool	m_autoSavePending

bool	m_autoSaveRequired

wxTimer *	m_autoSaveTimer

UNDO_REDO_CONTAINER	m_undoList

UNDO_REDO_CONTAINER	m_redoList

wxString	m_mruPath

ORIGIN_TRANSFORMS	m_originTransforms

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

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

bool	m_isNonUserClose

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

TOOL_MANAGER *	m_toolManager

ACTIONS *	m_actions

TOOL_DISPATCHER *	m_toolDispatcher

SELECTION	m_dummySelection

std::vector< std::string >	m_toolStack

bool	m_immediateActions

MOUSE_DRAG_ACTION	m_dragAction

bool	m_moveWarpsCursor

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

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

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

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

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

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

wxWindow *	findQuasiModalDialog ()

Private Attributes
PL_EDITOR_LAYOUT	m_pageLayout

int	m_propertiesFrameWidth

wxChoice *	m_originSelectBox

int	m_originSelectChoice

wxChoice *	m_pageSelectBox

wxString	m_mruImagePath

VECTOR2I	m_grid_origin

std::unique_ptr< NL_PL_EDITOR_PLUGIN >	m_spaceMouse

BASE_SCREEN *	m_currentScreen
	current used SCREEN

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

GAL_DISPLAY_OPTIONS_IMPL	m_galDisplayOptions

int	m_lastToolbarIconSize

KIWAY *	m_kiway

HOLDER_TYPE	m_type

const EDA_IU_SCALE &	m_iuScale

EDA_UNITS	m_userUnits

Detailed Description

The main window used in the drawing sheet editor.

Definition at line 47 of file pl_editor_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 41 of file kiway_holder.h.

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

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

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 113 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ PL_EDITOR_FRAME()

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

◆ ~PL_EDITOR_FRAME()

PL_EDITOR_FRAME::~PL_EDITOR_FRAME ( )

Definition at line 247 of file pl_editor_frame.cpp.

References EDA_DRAW_PANEL_GAL::GetBackend(), GetCanvas(), EDA_DRAW_FRAME::m_canvasType, TOOLS_HOLDER::m_toolManager, and TOOL_MANAGER::ShutdownAllTools().

Member Function Documentation

◆ ActivateGalCanvas()

void EDA_DRAW_FRAME::ActivateGalCanvas ( )

virtualinherited

Use to start up the GAL drawing canvas.

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

Definition at line 855 of file eda_draw_frame.cpp.

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

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

◆ addApiPluginTools()

void EDA_DRAW_FRAME::addApiPluginTools ( )

protectedvirtualinherited

Append actions from API plugins to the main toolbar.

Definition at line 1368 of file eda_draw_frame.cpp.

References API_PLUGIN_MANAGER::ButtonBindings(), API_PLUGIN_MANAGER::GetActionsForScope(), KIPLATFORM::UI::IsDarkTheme(), EDA_DRAW_FRAME::m_mainToolBar, EDA_DRAW_FRAME::OnApiPluginInvoke(), Pgm(), and EDA_DRAW_FRAME::PluginActionScope().

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

◆ AddDrawingSheetItem()

DS_DATA_ITEM * PL_EDITOR_FRAME::AddDrawingSheetItem ( int aType )

Add a new item to the drawing sheet item list.

Parameters

aType	is the type of item: DS_TEXT, DS_SEGMENT, DS_RECT, DS_POLYPOLYGON
aIdx	is the position in list to insert the new item.

Returns: a reference to the new item.

Definition at line 854 of file pl_editor_frame.cpp.

References _, DS_DATA_MODEL::Append(), drawSheetIUScale, DS_DATA_ITEM::DS_BITMAP, DS_DATA_ITEM::DS_POLYPOLYGON, DS_DATA_ITEM::DS_RECT, DS_DATA_ITEM::DS_SEGMENT, DS_DATA_ITEM::DS_TEXT, GetCanvas(), DS_DATA_MODEL::GetTheInstance(), image, EDA_IU_SCALE::IU_PER_MILS, m_mruImagePath, and DS_DATA_ITEM::SyncDrawItems().

Referenced by PL_DRAWING_TOOLS::DrawShape(), and PL_DRAWING_TOOLS::PlaceItem().

◆ AddMenuLanguageList()

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

protectedinherited

Function AddMenuLanguageList creates a menu list for language choice, and add it as submenu to MasterMenu.

Parameters

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

Definition at line 1641 of file eda_base_frame.cpp.

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

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

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar * aMenuBar )

inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 520 of file eda_base_frame.cpp.

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU & aMenu )

inherited

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

zoom and grid).

Definition at line 595 of file eda_draw_frame.cpp.

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

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

◆ AngleValueFromString()

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

inlineinherited

Definition at line 188 of file units_provider.h.

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

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

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

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

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

◆ CanAcceptApiCommands()

virtual bool EDA_BASE_FRAME::CanAcceptApiCommands ( )

inlinevirtualinherited

Checks if this frame is ready to accept API commands.

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

Reimplemented in PCB_EDIT_FRAME.

Definition at line 608 of file eda_base_frame.h.

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

◆ canCloseWindow()

bool PL_EDITOR_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 398 of file pl_editor_frame.cpp.

References _, GetCurrentFileName(), HandleUnsavedChanges(), IsContentModified(), and KIPLATFORM::APP::SupportsShutdownBlockReason().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1522 of file eda_base_frame.cpp.

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

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

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName & aFileName )

virtualinherited

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

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

Parameters

aFileName A wxFileName object containing the file name to check.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1366 of file eda_base_frame.cpp.

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ ClearFileHistory()

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

inherited

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

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

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

◆ ClearMsgPanel()

void EDA_DRAW_FRAME::ClearMsgPanel ( )

virtualinherited

Clear all messages from the message panel.

Reimplemented in SYMBOL_EDIT_FRAME.

Definition at line 810 of file eda_draw_frame.cpp.

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

Referenced by GERBVIEW_CONTROL::ClearAllLayers(), GERBVIEW_CONTROL::ClearLayer(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GENDRILL::GenDrillAndMapFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), DIALOG_BOM::OnRunGenerator(), GERBVIEW_CONTROL::ReloadAllLayers(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), EE_INSPECTION_TOOL::UpdateMessagePanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo(), and GERBVIEW_FRAME::UpdateTitleAndInfo().

◆ ClearUndoORRedoList()

void PL_EDITOR_FRAME::ClearUndoORRedoList	(	UNDO_REDO_LIST	aList,
		int	aItemCount = `-1`
	)

overridevirtual

Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.

Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN. Commands are deleted from the older to the last.

Parameters

aList	= the UNDO_REDO_CONTAINER of commands.
aItemCount	number of old commands to delete. -1 to remove all old commands this will empty the list of commands.

Reimplemented from EDA_BASE_FRAME.

Definition at line 945 of file pl_editor_frame.cpp.

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

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

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

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

◆ commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T aFrameType )

privateinherited

Collect common initialization functions used in all CTORs.

Definition at line 129 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ CommonSettingsChanged()

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

overridevirtual

Notification event that some of the common (suite-wide) settings have changed.

Update menus, toolbars, local variables, etc.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 637 of file pl_editor_frame.cpp.

References KIGFX::COLOR, EDA_DRAW_FRAME::CommonSettingsChanged(), EDA_DRAW_PANEL_GAL::ForceRefresh(), SETTINGS_MANAGER::GetAppSettings(), GetCanvas(), SETTINGS_MANAGER::GetColorSettings(), EDA_DRAW_FRAME::GetGalDisplayOptions(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), PGM_BASE::GetSettingsManager(), EDA_DRAW_PANEL_GAL::GetView(), KIGFX::RENDER_SETTINGS::LoadColors(), APP_SETTINGS_BASE::m_ColorTheme, APP_SETTINGS_BASE::m_Window, Pgm(), GAL_DISPLAY_OPTIONS_IMPL::ReadWindowSettings(), EDA_DRAW_FRAME::RecreateToolbars(), and KIGFX::VIEW::UpdateAllItems().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const

virtualinherited

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

Reimplemented in SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 883 of file eda_base_frame.cpp.

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

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

References EDA_BASE_FRAME::m_configName.

◆ CreateHotkeyPopup()

void EDA_DRAW_FRAME::CreateHotkeyPopup ( )

virtualinherited

Definition at line 1240 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_hotkeyPopup.

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

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 908 of file eda_base_frame.cpp.

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

Referenced by SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME().

◆ CreateServer()

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

inherited

Definition at line 43 of file eda_dde.cpp.

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

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

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 122 of file tools_holder.cpp.

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

Referenced by TOOLS_HOLDER::ShowChangedLanguage().

◆ DECLARE_EVENT_TABLE()

PL_EDITOR_FRAME::DECLARE_EVENT_TABLE ( )

protected

◆ DeleteAutoSaveFile()

void EDA_BASE_FRAME::DeleteAutoSaveFile ( const wxFileName & aFileName )

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1415 of file eda_base_frame.cpp.

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

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

◆ DesignBlocksPaneName()

static const wxString EDA_DRAW_FRAME::DesignBlocksPaneName ( )

inlinestaticinherited

Definition at line 420 of file eda_draw_frame.h.

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

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

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

Definition at line 171 of file kiway_player.cpp.

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

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

◆ DismissModal()

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

inherited

Definition at line 185 of file kiway_player.cpp.

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

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

◆ DisplayConstraintsMsg()

void EDA_DRAW_FRAME::DisplayConstraintsMsg ( const wxString & msg )

inherited

Definition at line 621 of file eda_draw_frame.cpp.

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

◆ DisplayGridMsg()

void PL_EDITOR_FRAME::DisplayGridMsg ( )

overridevirtual

Display current grid size in the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 699 of file pl_editor_frame.cpp.

References drawSheetIUScale, GetCanvas(), UNITS_PROVIDER::GetUserUnits(), grid, and EDA_UNIT_UTILS::UI::ToUserUnit().

Referenced by UpdateStatusBar().

◆ DisplayToolMsg()

void EDA_DRAW_FRAME::DisplayToolMsg ( const wxString & msg )

overridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 615 of file eda_draw_frame.cpp.

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )

inherited

Display current unit pane in the status bar.

Definition at line 641 of file eda_draw_frame.cpp.

References _, and UNITS_PROVIDER::GetUserUnits().

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )

protectedvirtualinherited

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

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 352 of file eda_base_frame.cpp.

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void PL_EDITOR_FRAME::doCloseWindow ( )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 427 of file pl_editor_frame.cpp.

References DS_DATA_MODEL::ClearList(), KIWAY_PLAYER::Destroy(), DS_DATA_MODEL::GetTheInstance(), and m_propertiesPagelayout.

◆ doReCreateMenuBar()

void PL_EDITOR_FRAME::doReCreateMenuBar ( )

overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 40 of file pagelayout_editor/menubar.cpp.

References _, ACTION_MENU::Add(), ACTION_MENU::AddClose(), FILE_HISTORY::AddFilesToMenu(), EDA_BASE_FRAME::AddMenuLanguageList(), ACTION_MENU::AddQuit(), EDA_BASE_FRAME::AddStandardHelpMenu(), PL_ACTIONS::appendImportedDrawingSheet, ACTION_MENU::Clone(), ACTIONS::copy, ACTIONS::cut, ACTIONS::doDelete, ACTIONS::doNew, PL_ACTIONS::drawLine, PL_ACTIONS::drawRectangle, ACTION_CONDITIONS::Enable(), FILE_HISTORY::FileHistoryNotEmpty(), EDA_BASE_FRAME::GetFileHistory(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::m_toolManager, ACTIONS::open, ACTIONS::openPreferences, ACTIONS::paste, PL_ACTIONS::placeImage, PL_ACTIONS::placeText, PL_ACTIONS::previewSettings, ACTIONS::print, ACTIONS::redo, EDA_BASE_FRAME::RegisterUIUpdateHandler(), ACTIONS::save, ACTIONS::saveAs, ACTION_MENU::SetIcon(), EDA_BASE_FRAME::SetMenuBar(), ACTION_MENU::SetTitle(), PL_ACTIONS::showInspector, ACTIONS::undo, FILE_HISTORY::UpdateClearText(), ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, ACTIONS::zoomRedraw, and ACTIONS::zoomTool.

◆ DoWithAcceptedFiles()

void PL_EDITOR_FRAME::DoWithAcceptedFiles ( )

overrideprotectedvirtual

Execute action on accepted dropped file.

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 329 of file pagelayout_editor/files.cpp.

References KICTL_CREATE, EDA_BASE_FRAME::m_AcceptedFiles, and OpenProjectFiles().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 732 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )

inherited

Definition at line 354 of file eda_draw_frame.cpp.

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

inlinevirtualinherited

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

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 177 of file kiway_player.h.

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

◆ Files_io()

void PL_EDITOR_FRAME::Files_io ( wxCommandEvent & event )

◆ findDialogs()

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

protectedinherited

Definition at line 977 of file eda_draw_frame.cpp.

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

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

privateinherited

Definition at line 200 of file eda_base_frame.cpp.

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

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

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 920 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::m_auimgr.

Referenced by SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME().

◆ FocusLibraryTreeInput()

virtual void EDA_DRAW_FRAME::FocusLibraryTreeInput ( )

inlinevirtualinherited

Reimplemented in SYMBOL_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 408 of file eda_draw_frame.h.

Referenced by LIBRARY_EDITOR_CONTROL::LibraryTreeSearch().

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const VECTOR2I & aPos )

inherited

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

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

Parameters

aPos	is the point to go to.

Definition at line 991 of file eda_draw_frame.cpp.

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

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

◆ GetAboutTitle()

const wxString & EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 511 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_aboutTitle.

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inherited

Definition at line 332 of file eda_base_frame.cpp.

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

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

◆ GetCanvas()

PL_DRAW_PANEL_GAL * PL_EDITOR_FRAME::GetCanvas ( ) const

overridevirtual

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 824 of file pl_editor_frame.cpp.

References EDA_DRAW_FRAME::GetCanvas().

Referenced by AddDrawingSheetItem(), CommonSettingsChanged(), DisplayGridMsg(), PL_DRAWING_TOOLS::DrawShape(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), HardRedraw(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_SELECTION_TOOL::Main(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_INSPECTOR::onCellClicked(), OnNewDrawingSheet(), OnSelectCoordOriginCorner(), OnSelectPage(), PROPERTIES_FRAME::OnSetDefaultValues(), PL_DRAWING_TOOLS::PlaceItem(), PrintPage(), PLEDITOR_PRINTOUT::PrintPage(), RollbackFromUndo(), PL_SELECTION_TOOL::selectMultiple(), PL_POINT_EDITOR::setEditedPoint(), setupTools(), UpdateStatusBar(), and ~PL_EDITOR_FRAME().

◆ GetColorSettings()

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

virtualinherited

Returns a pointer to the active color theme settings.

Reimplemented in FOOTPRINT_CHOOSER_FRAME, DISPLAY_FOOTPRINTS_FRAME, SCH_BASE_FRAME, SYMBOL_EDIT_FRAME, GERBVIEW_FRAME, PCB_BASE_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 1246 of file eda_draw_frame.cpp.

References SETTINGS_MANAGER::GetColorSettings(), PGM_BASE::GetSettingsManager(), EDA_DRAW_FRAME::m_colorSettings, and Pgm().

Referenced by DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ GetCurrentFileName()

wxString PL_EDITOR_FRAME::GetCurrentFileName ( ) const

overridevirtual

Returns: the filename of the current layout descr file If this is the default (no loaded file) returns a empty name or a new design.

Reimplemented from EDA_BASE_FRAME.

Definition at line 589 of file pl_editor_frame.cpp.

References BASE_SCREEN::m_DrawingSheetFileName.

Referenced by canCloseWindow(), Files_io(), OnNewDrawingSheet(), PL_EDITOR_CONTROL::PageSetup(), and UpdateTitleAndInfo().

◆ GetCurrentSelection()

SELECTION & PL_EDITOR_FRAME::GetCurrentSelection ( )

overridevirtual

Get the current selection from the canvas area.

Returns: the current selection.

Reimplemented from TOOLS_HOLDER.

Definition at line 830 of file pl_editor_frame.cpp.

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

◆ GetDocumentExtents()

const BOX2I PL_EDITOR_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 505 of file pl_editor_frame.cpp.

References drawSheetIUScale, GetPageLayout(), GetPageSettings(), and EDA_IU_SCALE::IU_PER_MILS.

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const

inlineinherited

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

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

Definition at line 138 of file tools_holder.h.

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

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

Definition at line 144 of file tools_holder.h.

References TOOLS_HOLDER::m_dragAction.

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

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const

inlinevirtualinherited

Reimplemented in SCH_BASE_FRAME.

Definition at line 180 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_drawBgColor.

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

◆ GetFileFromHistory()

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

inherited

Fetches the file name from the file history list.

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

Parameters

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

Returns: a wxString containing the selected filename

Definition at line 1003 of file eda_base_frame.cpp.

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

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

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString & EDA_DRAW_FRAME::GetFindHistoryList ( )

inlineinherited

Definition at line 118 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_findStringHistoryList.

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

◆ GetFindReplaceData()

EDA_SEARCH_DATA & EDA_DRAW_FRAME::GetFindReplaceData ( )

inlineinherited

Definition at line 117 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_findReplaceData.

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

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 203 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_ident.

Referenced by KIWAY_PLAYER::Destroy(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), SCH_BASE_FRAME::GetViewerSettingsBase(), PCB_BASE_FRAME::GetViewerSettingsBase(), COMMON_TOOLS::GridProperties(), FIELDS_GRID_TABLE::initGrid(), PCB_ORIGIN_TRANSFORMS::invertXAxis(), PCB_ORIGIN_TRANSFORMS::invertYAxis(), PANEL_SCH_SELECTION_FILTER::PANEL_SCH_SELECTION_FILTER(), PCB_FIELDS_GRID_TABLE::PCB_FIELDS_GRID_TABLE(), LIBRARY_EDITOR_CONTROL::PinLibrary(), EDA_BASE_FRAME::ShowPreferences(), COMMON_CONTROL::ShowProjectManager(), LIBRARY_EDITOR_CONTROL::UnpinLibrary(), and SCH_PROPERTIES_PANEL::updateFontList().

◆ GetFullScreenDesc()

wxString EDA_DRAW_FRAME::GetFullScreenDesc ( ) const

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1104 of file eda_draw_frame.cpp.

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

◆ GetGalDisplayOptions()

GAL_DISPLAY_OPTIONS_IMPL & EDA_DRAW_FRAME::GetGalDisplayOptions ( )

inlineinherited

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

Definition at line 457 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_galDisplayOptions.

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

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )

inlinevirtualinherited

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

Definition at line 234 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_gridColor.

Referenced by PCB_CONTROL::Reset().

◆ GetGridOrigin()

const VECTOR2I & PL_EDITOR_FRAME::GetGridOrigin ( ) const

inlineoverridevirtual

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 112 of file pl_editor_frame.h.

References m_grid_origin.

◆ GetHotkeyPopup()

HOTKEY_CYCLE_POPUP * EDA_DRAW_FRAME::GetHotkeyPopup ( )

inlineinherited

Definition at line 493 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_hotkeyPopup.

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

◆ GetInfoBar()

WX_INFOBAR * EDA_BASE_FRAME::GetInfoBar ( )

inlineinherited

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

Definition at line 233 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_infoBar.

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

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

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

◆ GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 59 of file units_provider.h.

References UNITS_PROVIDER::m_iuScale.

Referenced by UNITS_PROVIDER::AngleValueFromString(), GRID_MENU::BuildChoiceList(), RC_ITEM::GetJsonViolation(), UNITS_PROVIDER::MessageTextFromMinOptMax(), UNITS_PROVIDER::MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::onUnitsChanged(), UNITS_PROVIDER::OptionalValueFromString(), PANEL_GRID_SETTINGS::RebuildGridSizes(), COMMON_TOOLS::Reset(), UNITS_PROVIDER::StringFromOptionalValue(), UNITS_PROVIDER::StringFromValue(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), GRID::UserUnitsMessageText(), and UNITS_PROVIDER::ValueFromString().

◆ GetLayoutFromRedoList()

void PL_EDITOR_FRAME::GetLayoutFromRedoList ( )

Redo the last edit:

Place the current edited layout in undo list.
Get the previous version of the current edited layout.

Definition at line 52 of file pl_editor_undo_redo.cpp.

References PL_SELECTION_TOOL::ClearSelection(), GetCanvas(), ITEM_PICKER::GetItem(), EDA_BASE_FRAME::GetRedoCommandCount(), EDA_DRAW_FRAME::GetScreen(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), HardRedraw(), OnModify(), EDA_BASE_FRAME::PopCommandFromRedoList(), PICKED_ITEMS_LIST::PopItem(), EDA_BASE_FRAME::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), PL_SELECTION_TOOL::RebuildSelection(), EDA_DRAW_PANEL_GAL::Refresh(), DS_PROXY_UNDO_ITEM::Restore(), EDA_ITEM::Type(), and WS_PROXY_UNDO_ITEM_PLUS_T.

Referenced by PL_EDIT_TOOL::Redo().

◆ GetLayoutFromUndoList()

void PL_EDITOR_FRAME::GetLayoutFromUndoList ( )

Undo the last edit:

Place the current layout in Redo list.
Get the previous version of the current edited layout.

Definition at line 89 of file pl_editor_undo_redo.cpp.

References PL_SELECTION_TOOL::ClearSelection(), GetCanvas(), ITEM_PICKER::GetItem(), EDA_DRAW_FRAME::GetScreen(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), EDA_BASE_FRAME::GetUndoCommandCount(), HardRedraw(), OnModify(), EDA_BASE_FRAME::PopCommandFromUndoList(), PICKED_ITEMS_LIST::PopItem(), EDA_BASE_FRAME::PushCommandToRedoList(), PICKED_ITEMS_LIST::PushItem(), PL_SELECTION_TOOL::RebuildSelection(), EDA_DRAW_PANEL_GAL::Refresh(), DS_PROXY_UNDO_ITEM::Restore(), EDA_ITEM::Type(), and WS_PROXY_UNDO_ITEM_PLUS_T.

Referenced by PL_EDIT_TOOL::Undo().

◆ GetLibTree()

virtual LIB_TREE * EDA_DRAW_FRAME::GetLibTree ( ) const

inlinevirtualinherited

Reimplemented in SYMBOL_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 403 of file eda_draw_frame.h.

Referenced by LIBRARY_EDITOR_CONTROL::AddContextMenuItems(), LIBRARY_EDITOR_CONTROL::PinLibrary(), LIBRARY_EDITOR_CONTROL::regenerateLibraryTree(), and LIBRARY_EDITOR_CONTROL::UnpinLibrary().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 584 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

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

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

Definition at line 150 of file tools_holder.h.

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 423 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_mruPath.

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

◆ GetNearestGridPosition()

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

inherited

Return the nearest aGridSize location to aPosition.

Parameters

aPosition The position to check.

Returns: The nearest grid position.

Definition at line 930 of file eda_draw_frame.cpp.

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

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

◆ GetNearestHalfGridPosition()

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

inherited

Return the nearest aGridSize / 2 location to aPosition.

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

Parameters

aPosition The position to check.

Returns: The nearest half-grid position.

Definition at line 944 of file eda_draw_frame.cpp.

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

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

◆ GetOriginTransforms()

ORIGIN_TRANSFORMS & EDA_BASE_FRAME::GetOriginTransforms ( )

inlineoverridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from UNITS_PROVIDER.

Reimplemented in PCB_BASE_FRAME.

Definition at line 132 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_originTransforms.

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

◆ GetPageLayout() [1/2]

PL_EDITOR_LAYOUT & PL_EDITOR_FRAME::GetPageLayout ( )

inline

Definition at line 148 of file pl_editor_frame.h.

References m_pageLayout.

◆ GetPageLayout() [2/2]

const PL_EDITOR_LAYOUT & PL_EDITOR_FRAME::GetPageLayout ( ) const

inline

Definition at line 147 of file pl_editor_frame.h.

References m_pageLayout.

Referenced by GetDocumentExtents(), GetTitleBlock(), and DIALOG_INSPECTOR::ReCreateDesignList().

◆ GetPageNumberOption()

bool PL_EDITOR_FRAME::GetPageNumberOption ( ) const

Drawing sheet editor can show the title block using a page number 1 or another number.

This is because some items can be shown (or not) only on page 1 (a feature which looks like word processing option "page 1 differs from other pages").

Returns: true if the page 1 is selected, and false if not.

Definition at line 976 of file pl_editor_frame.cpp.

References m_pageSelectBox.

Referenced by PrintPage().

◆ GetPageSettings()

const PAGE_INFO & PL_EDITOR_FRAME::GetPageSettings ( ) const

overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 610 of file pl_editor_frame.cpp.

References PL_EDITOR_LAYOUT::GetPageSettings(), and m_pageLayout.

Referenced by GetDocumentExtents(), LoadSettings(), PLEDITOR_PRINTOUT::PrintPage(), SaveSettings(), ToPrinter(), and UpdateMsgPanelInfo().

◆ GetPageSizeIU()

const VECTOR2I PL_EDITOR_FRAME::GetPageSizeIU ( ) const

overridevirtual

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 616 of file pl_editor_frame.cpp.

References drawSheetIUScale, PL_EDITOR_LAYOUT::GetPageSettings(), PAGE_INFO::GetSizeIU(), EDA_IU_SCALE::IU_PER_MILS, and m_pageLayout.

Referenced by DIALOG_INSPECTOR::ReCreateDesignList().

◆ GetPropertiesFrame()

PROPERTIES_FRAME * PL_EDITOR_FRAME::GetPropertiesFrame ( )

inline

Definition at line 53 of file pl_editor_frame.h.

References m_propertiesPagelayout.

Referenced by DIALOG_INSPECTOR::onCellClicked(), PL_POINT_EDITOR::updateItem(), and PL_EDITOR_CONTROL::UpdateMessagePanel().

◆ GetPropertiesPanel()

PROPERTIES_PANEL * EDA_DRAW_FRAME::GetPropertiesPanel ( )

inlineinherited

Definition at line 410 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_propertiesPanel.

◆ GetRedoActionDescription()

wxString EDA_BASE_FRAME::GetRedoActionDescription ( ) const

virtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 1507 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 579 of file eda_base_frame.h.

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

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

◆ GetScreen()

virtual BASE_SCREEN * EDA_DRAW_FRAME::GetScreen ( ) const

inlinevirtualinherited

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

Definition at line 209 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_currentScreen.

Referenced by GERBVIEW_FRAME::Clear_DrawLayers(), EDA_DRAW_PANEL_GAL::DoRePaint(), Files_io(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), SCH_BASE_FRAME::GetScreen(), PCB_BASE_FRAME::GetScreen(), IsContentModified(), LoadDrawingSheetFile(), OnModify(), OnNewDrawingSheet(), PrintPage(), PLEDITOR_PRINTOUT::PrintPage(), COMMON_TOOLS::ResetLocalCoords(), SaveCopyInUndoList(), SaveDrawingSheetFile(), SetPageSettings(), GERBVIEW_FRAME::SetPageSettings(), GERBVIEW_FRAME::UpdateStatusBar(), and UpdateStatusBar().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const

virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1097 of file eda_draw_frame.cpp.

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

◆ GetSettingsManager()

SETTINGS_MANAGER * EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

Definition at line 138 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_settingsManager.

Referenced by KICAD_MANAGER_FRAME::canCloseWindow(), EDA_3D_VIEWER_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), DIALOG_PLOT_SCHEMATIC::getColorSettings(), EESCHEMA_HELPERS::GetSettingsManager(), GetSettingsManager(), KICAD_MANAGER_FRAME::LoadProject(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SCH_EDIT_FRAME::OnImportProject(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::saveProjectSettings(), KICAD_MANAGER_FRAME::SaveSettings(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int aErrorCode ) const

inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 140 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const

inlineinherited

For those frames that support polar coordinates.

Definition at line 132 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_polarCoords.

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

◆ GetTargetLibId()

virtual LIB_ID EDA_DRAW_FRAME::GetTargetLibId ( ) const

inlinevirtualinherited

Reimplemented in SYMBOL_EDIT_FRAME.

Definition at line 404 of file eda_draw_frame.h.

Referenced by LIBRARY_EDITOR_CONTROL::regenerateLibraryTree().

◆ GetTitleBlock()

const TITLE_BLOCK & PL_EDITOR_FRAME::GetTitleBlock ( ) const

overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 625 of file pl_editor_frame.cpp.

References GetPageLayout(), and PL_EDITOR_LAYOUT::GetTitleBlock().

◆ GetToolCanvas()

wxWindow * EDA_DRAW_FRAME::GetToolCanvas ( ) const

inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 452 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolDispatcher()

TOOL_DISPATCHER * TOOLS_HOLDER::GetToolDispatcher ( ) const

inlineinherited

Definition at line 57 of file tools_holder.h.

References TOOLS_HOLDER::m_toolDispatcher.

Referenced by LIB_TREE_MODEL_ADAPTER::GetToolDispatcher().

◆ GetToolManager()

TOOL_MANAGER * TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), SCH_SEARCH_HANDLER::ActivateItem(), PCB_SEARCH_HANDLER::ActivateItem(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_PROPERTIES_PANEL::AfterCommit(), PCB_PROPERTIES_PANEL::AfterCommit(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), SCH_NAVIGATE_TOOL::Back(), PCB_EDIT_FRAME::CanAcceptApiCommands(), SCH_NAVIGATE_TOOL::changeSheet(), TOOLS_HOLDER::CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DESIGN_BLOCK_PANE::DESIGN_BLOCK_PANE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), KIGFX::SCH_VIEW::DisplaySheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), SIMULATOR_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SCH_FIELD::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), SCH_DRAWING_TOOLS::doSyncSheetsPins(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SIMULATOR_CONTROL::ExportPlotToSchematic(), SCH_NAVIGATE_TOOL::Forward(), GERBVIEW_FRAME::GERBVIEW_FRAME(), DESIGN_BLOCK_TREE_MODEL_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), PCB_TUNING_PATTERN::GetPreviewItems(), SCH_PROPERTIES_PANEL::getPropertyFromEvent(), PCB_PROPERTIES_PANEL::getPropertyFromEvent(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), API_HANDLER_PCB::handleInteractiveMoveItems(), API_HANDLER_PCB::handleRefillZones(), DIALOG_PAD_PROPERTIES::initValues(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_GENERATORS::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnDeleteOneClick(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemRClick(), DIALOG_ERC::OnERCItemSelected(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_GENERATORS::OnItemSelected(), PANEL_KICAD_LAUNCHER::onLauncherButtonClick(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), SCH_EDIT_FRAME::onNetNavigatorSelection(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), GERBER_LAYER_WIDGET::onPopupSelection(), DIALOG_GENERATORS::OnRebuildAllClick(), DIALOG_GENERATORS::OnRebuildTypeClick(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), DIALOG_CREATE_ARRAY::OnSelectCenterButton(), HIERARCHY_PANE::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), PCB_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected(), PANEL_SCH_SELECTION_FILTER::PANEL_SCH_SELECTION_FILTER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_PRINTOUT::PrintPage(), SIMULATOR_CONTROL::Probe(), SYMBOL_EDIT_FRAME::PushSymbolToUndoList(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), PCB_BASE_FRAME::rebuildConnectivity(), SCH_EDIT_FRAME::RecalculateConnections(), SIMULATOR_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReloadFootprint(), RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), SCH_COMMIT::SCH_COMMIT(), DIALOG_FIND::search(), SCH_SEARCH_HANDLER::SelectItems(), PCB_SEARCH_HANDLER::SelectItems(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_MAINFRAME::setupEventHandlers(), FOOTPRINT_EDIT_FRAME::setupTools(), TOOLS_HOLDER::ShowChangedLanguage(), APPEARANCE_CONTROLS::showNetclass(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), SIMULATOR_CONTROL::Tune(), SCH_PROPERTIES_PANEL::UpdateData(), PCB_PROPERTIES_PANEL::UpdateData(), DIALOG_DRC::updateDisplayedCounts(), CVPCB_MAINFRAME::updateFootprintViewerOnIdle(), NET_GRID_TABLE::updateNetVisibility(), SCH_PROPERTIES_PANEL::valueChanged(), PCB_PROPERTIES_PANEL::valueChanged(), SCH_PROPERTIES_PANEL::valueChanging(), PCB_PROPERTIES_PANEL::valueChanging(), GLOBAL_EDIT_TOOL::ZonesManager(), DIALOG_IMPORT_NETLIST::~DIALOG_IMPORT_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 48 of file kiway_holder.h.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoActionDescription()

wxString EDA_BASE_FRAME::GetUndoActionDescription ( ) const

virtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 1498 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 578 of file eda_base_frame.h.

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

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

◆ GetUnitPair()

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

overridevirtualinherited

Get the pair or units in current use.

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

Reimplemented from UNITS_PROVIDER.

Definition at line 1281 of file eda_draw_frame.cpp.

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

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

◆ GetUntranslatedAboutTitle()

const wxString & EDA_BASE_FRAME::GetUntranslatedAboutTitle ( ) const

inlineinherited

Definition at line 513 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_aboutTitle.

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

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 45 of file units_provider.h.

References UNITS_PROVIDER::m_userUnits.

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

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE * aCfg )

virtualinherited

Return a pointer to the window settings for this frame.

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

Parameters

aCfg	is this frame's config object

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, SIMULATOR_FRAME, SYMBOL_CHOOSER_FRAME, SYMBOL_DIFF_FRAME, SYMBOL_VIEWER_FRAME, FOOTPRINT_CHOOSER_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 877 of file eda_base_frame.cpp.

References APP_SETTINGS_BASE::m_Window.

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

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )

inherited

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

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

Returns: the undecorated window size

Definition at line 1558 of file eda_base_frame.cpp.

References KICAD_MAIN_FRAME_T, and EDA_BASE_FRAME::m_ident.

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

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const

inherited

Return a human readable value for display in dialogs.

Definition at line 720 of file eda_draw_frame.cpp.

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

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

◆ handleActivateEvent()

void PL_EDITOR_FRAME::handleActivateEvent ( wxActivateEvent & aEvent )

overrideprivatevirtual

Handle a window activation event.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 994 of file pl_editor_frame.cpp.

References EDA_DRAW_FRAME::handleActivateEvent(), and m_spaceMouse.

◆ handleIconizeEvent()

void PL_EDITOR_FRAME::handleIconizeEvent ( wxIconizeEvent & aEvent )

overrideprivatevirtual

Handle a window iconize event.

Parameters

aEvent is the data for the event.

Reimplemented from EDA_BASE_FRAME.

Definition at line 1003 of file pl_editor_frame.cpp.

References EDA_BASE_FRAME::handleIconizeEvent(), and m_spaceMouse.

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

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

Definition at line 1582 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

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

staticinherited

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

enabled, checked, etc.).

Parameters

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

Definition at line 401 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

void PL_EDITOR_FRAME::HardRedraw ( )

overridevirtual

Refresh the library tree and redraw the window.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 836 of file pl_editor_frame.cpp.

References PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), GetCanvas(), PL_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), m_propertiesPagelayout, TOOLS_HOLDER::m_toolManager, EDA_DRAW_PANEL_GAL::Refresh(), and UpdateMsgPanelInfo().

Referenced by Files_io(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), PL_EDITOR_CONTROL::PageSetup(), RollbackFromUndo(), and PL_EDITOR_CONTROL::TitleBlockDisplayMode().

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const

inlineinherited

Safety check before asking for the Kiway reference.

Returns: true if kiway is non-null

Definition at line 65 of file kiway_holder.h.

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 896 of file eda_base_frame.cpp.

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

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

inherited

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

Parameters

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

◆ initExitKey()

void EDA_BASE_FRAME::initExitKey ( )

protectedinherited

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

This is useful in sub-applications to pass the event up to a non-owning window.

Definition at line 1440 of file eda_base_frame.cpp.

◆ InsertDrawingSheetFile()

bool PL_EDITOR_FRAME::InsertDrawingSheetFile ( const wxString & aFullFileName )

Load a .kicad_wks drawing sheet file, and add items to the current layout list.

Parameters

aFullFileName is the filename.

Definition at line 280 of file pagelayout_editor/files.cpp.

References DS_DATA_MODEL::GetTheInstance(), DS_DATA_MODEL::LoadDrawingSheet(), and SaveCopyInUndoList().

Referenced by Files_io().

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const

inlineprotectedvirtualinherited

Return the auto save status of the application.

Override this function if your derived frame supports automatic file saving.

Definition at line 635 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_autoSaveRequired.

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool PL_EDITOR_FRAME::IsContentModified ( ) const

overridevirtual

Get if the drawing sheet has been modified but not saved.

Returns: true if the any changes have not been saved

Reimplemented from EDA_BASE_FRAME.

Definition at line 382 of file pl_editor_frame.cpp.

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

Referenced by canCloseWindow(), Files_io(), OnFileHistory(), saveCurrentPageLayout(), and UpdateTitleAndInfo().

◆ IsCurrentTool()

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

inherited

Definition at line 131 of file tools_holder.cpp.

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

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

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )

inherited

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

Definition at line 179 of file kiway_player.cpp.

References KIWAY_PLAYER::m_modal_loop.

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

◆ IsGridOverridden()

bool EDA_DRAW_FRAME::IsGridOverridden ( ) const

inherited

Definition at line 513 of file eda_draw_frame.cpp.

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

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

◆ IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( ) const

inherited

Definition at line 483 of file eda_draw_frame.cpp.

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

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

◆ IsLibraryTreeShown()

virtual bool EDA_DRAW_FRAME::IsLibraryTreeShown ( ) const

inlinevirtualinherited

Reimplemented in SYMBOL_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 406 of file eda_draw_frame.h.

Referenced by LIBRARY_EDITOR_CONTROL::LibraryTreeSearch().

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const

inlineoverridevirtualinherited

Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame.

In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing.

Reimplemented from EDA_BASE_FRAME.

Definition at line 154 of file kiway_player.h.

References KIWAY_PLAYER::m_modal.

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

◆ IsScriptingConsoleVisible()

bool EDA_DRAW_FRAME::IsScriptingConsoleVisible ( )

inherited

Gets the current visibility of the scripting console window.

Definition at line 258 of file eda_draw_frame.cpp.

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

Referenced by EDITOR_CONDITIONS::consoleVisibleFunc().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inlineinherited

Definition at line 202 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_ident.

◆ IsWritable()

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

inherited

Checks if aFileName can be written.

The function performs a number of tests on aFileName to verify that it can be saved. If aFileName defines a path with no file name, them the path is tested for user write permission. If aFileName defines a file name that does not exist in the path, the path is tested for user write permission. If aFileName defines a file that already exits, the file name is tested for user write permissions.

‍
Note
The file name path must be set or an assertion will be raised on debug builds and return false on release builds.

Parameters

aFileName The full path and/or file name of the file to test.

aVerbose If true will show an error dialog if the file is not writable

Returns
False if aFileName cannot be written.

Definition at line 1323 of file eda_base_frame.cpp.

References _, and DisplayErrorMessage().

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

◆ Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const

inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 55 of file kiway_holder.h.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesList(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), BOARD_INSPECTION_TOOL::constructDiffPanel(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), KIWAY_PLAYER::Destroy(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), PANEL_JOBS::EnsurePcbSchFramesOpen(), SIMULATOR_CONTROL::ExportPlotToSchematic(), BACK_ANNOTATE::FetchNetlistFromPCB(), PANEL_SYMBOL_CHOOSER::FinishSetup(), IMPORT_PROJ_HELPER::ImportIndividualFile(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), PGM_SINGLE_TOP::MacOpenFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PCB_CALCULATOR_FRAME::OnExit(), SIMULATOR_FRAME::onExit(), SAVE_AS_TRAVERSER::OnFile(), KIGFX::WX_VIEW_CONTROLS::onMotion(), PANEL_JOB_OUTPUT::OnOutputRunClick(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), PANEL_JOBS::OnRunAllJobsClick(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PANEL_JOBS::openJobOptionsForListItem(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PCB_FIELDS_GRID_TABLE::PCB_FIELDS_GRID_TABLE(), KIWAY_HOLDER::Prj(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), CVPCB_CONTROL::ShowFootprintViewer(), showFrame(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), FP_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), COMMON_CONTROL::ShowProjectManager(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), DIALOG_ERC::testErc(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), SIMULATOR_CONTROL::Tune(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS & aEvent )

protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 200 of file kiway_player.cpp.

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS & aEvent )

virtualinherited

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

Reimplemented in CVPCB_MAINFRAME, SCH_EDIT_FRAME, PCB_EDIT_FRAME, SYMBOL_DIFF_FRAME, SYMBOL_EDIT_FRAME, SYMBOL_VIEWER_FRAME, FOOTPRINT_CHOOSER_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 88 of file kiway_player.cpp.

Referenced by KIWAY_PLAYER::kiway_express(), and KIWAY::ProcessEvent().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent & event )

protectedinherited

An event handler called on a language menu selection.

Definition at line 207 of file kiway_player.cpp.

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

◆ LibraryFileBrowser()

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

inherited

Parameters

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

Returns: true for OK; false for Cancel.

Definition at line 1111 of file eda_draw_frame.cpp.

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

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

◆ loadCanvasTypeSetting()

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

protectedinherited

Returns the canvas type stored in the application settings.

Parameters

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

Definition at line 871 of file eda_draw_frame.cpp.

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

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

◆ LoadDrawingSheetFile()

bool PL_EDITOR_FRAME::LoadDrawingSheetFile ( const wxString & aFullFileName )

Load a .kicad_wks drawing sheet file.

Parameters

aFullFileName is the filename.

Definition at line 234 of file pagelayout_editor/files.cpp.

References _, WX_INFOBAR::AddCloseButton(), WX_INFOBAR::Dismiss(), DisplayErrorMessage(), EDA_DRAW_FRAME::GetScreen(), DS_DATA_MODEL::GetTheInstance(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::OUTDATED_SAVE, WX_INFOBAR::RemoveAllButtons(), BASE_SCREEN::SetContentModified(), SetCurrentFileName(), SEXPR_WORKSHEET_FILE_VERSION, WX_INFOBAR::ShowMessage(), and EDA_BASE_FRAME::UpdateFileHistory().

Referenced by Files_io(), OnFileHistory(), and OpenProjectFiles().

◆ LoadSettings()

void PL_EDITOR_FRAME::LoadSettings ( APP_SETTINGS_BASE * aCfg )

overridevirtual

Load common frame parameters from a configuration file.

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 512 of file pl_editor_frame.cpp.

References BLACK, GetPageSettings(), WINDOW_SETTINGS::grid, GRID_SETTINGS::grids, EDA_DRAW_FRAME::LoadSettings(), PL_EDITOR_SETTINGS::m_BlackBackground, PL_EDITOR_SETTINGS::m_CornerOrigin, PL_EDITOR_SETTINGS::m_LastCustomHeight, PL_EDITOR_SETTINGS::m_LastCustomWidth, PL_EDITOR_SETTINGS::m_LastPaperSize, PL_EDITOR_SETTINGS::m_LastWasPortrait, m_originSelectChoice, m_propertiesFrameWidth, PL_EDITOR_SETTINGS::m_PropertiesFrameWidth, APP_SETTINGS_BASE::m_Window, PAGE_INFO::SetCustomHeightMils(), PAGE_INFO::SetCustomWidthMils(), EDA_DRAW_FRAME::SetDrawBgColor(), SetPageSettings(), PAGE_INFO::SetType(), WHITE, WINDOW_SETTINGS::zoom_factors, and ZOOM_LIST_PL_EDITOR.

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS * aCfg )

inherited

Load window settings from the given settings object.

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

Definition at line 785 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE & aState )

virtualinherited

Load frame state info from a configuration file.

Definition at line 637 of file eda_base_frame.cpp.

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

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString & aFileName )

inherited

Definition at line 623 of file eda_base_frame.cpp.

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

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

◆ LockFile()

bool EDA_DRAW_FRAME::LockFile ( const wxString & aFileName )

inherited

Mark a schematic file as being in use.

Use ReleaseFile() to undo this.

Parameters

aFileName full path to the file.

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

Definition at line 202 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_file_checker, and Pgm().

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

◆ MakeGridHelper()

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

virtualinherited

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 529 of file eda_draw_frame.cpp.

Referenced by COMMON_TOOLS::CursorControl().

◆ MessageTextFromMinOptMax()

wxString UNITS_PROVIDER::MessageTextFromMinOptMax ( const MINOPTMAX< int > & aValue ) const

inlineinherited

Definition at line 141 of file units_provider.h.

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

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

◆ MessageTextFromValue() [1/2]

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

inlineinherited

Definition at line 134 of file units_provider.h.

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

◆ MessageTextFromValue() [2/2]

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

inlineinherited

A lower-precision version of StringFromValue().

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

Definition at line 127 of file units_provider.h.

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

◆ NetInspectorPanelName()

static const wxString EDA_DRAW_FRAME::NetInspectorPanelName ( )

inlinestaticinherited

Definition at line 418 of file eda_draw_frame.h.

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

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce )

inlineinherited

Definition at line 592 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onActivate()

void EDA_DRAW_FRAME::onActivate ( wxActivateEvent & aEvent )

protectedinherited

Definition at line 1326 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::handleActivateEvent().

◆ OnApiPluginInvoke()

void EDA_DRAW_FRAME::OnApiPluginInvoke ( wxCommandEvent & aEvent )

virtualinherited

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

Definition at line 1399 of file eda_draw_frame.cpp.

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

Referenced by EDA_DRAW_FRAME::addApiPluginTools().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protectedinherited

Handle the auto save timer event.

Definition at line 338 of file eda_base_frame.cpp.

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

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

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent & aKeyEvent )

virtualinherited

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

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

Reimplemented in SYMBOL_VIEWER_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 358 of file eda_base_frame.cpp.

References dump(), and kicadTraceKeyEvent.

◆ OnClearFileHistory()

void PL_EDITOR_FRAME::OnClearFileHistory ( wxCommandEvent & aEvent )

Definition at line 90 of file pagelayout_editor/files.cpp.

References EDA_BASE_FRAME::ClearFileHistory().

◆ OnDropFiles()

void EDA_BASE_FRAME::OnDropFiles ( wxDropFilesEvent & aEvent )

protectedvirtualinherited

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

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

Definition at line 1291 of file eda_base_frame.cpp.

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

◆ OnExit()

void PL_EDITOR_FRAME::OnExit ( wxCommandEvent & aEvent )

Event handler for the wxID_EXIT and wxID_CLOSE events.

Definition at line 388 of file pl_editor_frame.cpp.

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

◆ OnFileHistory()

void PL_EDITOR_FRAME::OnFileHistory ( wxCommandEvent & event )

Definition at line 55 of file pagelayout_editor/files.cpp.

References _, EDA_BASE_FRAME::GetFileFromHistory(), HandleUnsavedChanges(), IsContentModified(), LoadDrawingSheetFile(), OnNewDrawingSheet(), and saveCurrentPageLayout().

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent & aEvent )

protectedinherited

Definition at line 1608 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::handleIconizeEvent().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

Definition at line 1061 of file eda_base_frame.cpp.

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

inherited

Definition at line 1534 of file eda_base_frame.cpp.

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

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent & event )

inherited

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

Definition at line 368 of file eda_base_frame.cpp.

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

◆ OnModify()

void PL_EDITOR_FRAME::OnModify ( )

overridevirtual

Must be called after a change in order to set the "modify" flag.

Reimplemented from EDA_BASE_FRAME.

Definition at line 370 of file pl_editor_frame.cpp.

References EDA_DRAW_FRAME::GetScreen(), EDA_BASE_FRAME::OnModify(), BASE_SCREEN::SetContentModified(), and UpdateTitleAndInfo().

Referenced by PL_EDIT_TOOL::DoDelete(), PL_DRAWING_TOOLS::DrawShape(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PROPERTIES_FRAME::OnAcceptPrms(), PL_EDITOR_CONTROL::PageSetup(), and PL_DRAWING_TOOLS::PlaceItem().

◆ OnMove()

void EDA_DRAW_FRAME::OnMove ( wxMoveEvent & aEvent )

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 578 of file eda_draw_frame.cpp.

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

◆ OnNewDrawingSheet()

void PL_EDITOR_FRAME::OnNewDrawingSheet ( )

Must be called to initialize parameters when a new drawing sheet is loaded.

Definition at line 920 of file pl_editor_frame.cpp.

References _, EDA_BASE_FRAME::ClearUndoRedoList(), PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), GetCanvas(), GetCurrentFileName(), EDA_DRAW_FRAME::GetScreen(), m_propertiesPagelayout, TOOLS_HOLDER::m_toolManager, TOOL_MANAGER::RunAction(), BASE_SCREEN::SetContentModified(), KIPLATFORM::APP::SetShutdownBlockReason(), UpdateTitleAndInfo(), and ACTIONS::zoomFitScreen.

Referenced by Files_io(), OnFileHistory(), and OpenProjectFiles().

◆ OnPageSettingsChange()

virtual void EDA_DRAW_FRAME::OnPageSettingsChange ( )

inlinevirtualinherited

Called when modifying the page settings.

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

Reimplemented in SCH_EDIT_FRAME.

Definition at line 340 of file eda_draw_frame.h.

Referenced by DIALOG_PAGES_SETTINGS::TransferDataFromWindow().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

inherited

Definition at line 1068 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::ShowPreferences().

◆ OnSelectCoordOriginCorner()

void PL_EDITOR_FRAME::OnSelectCoordOriginCorner ( wxCommandEvent & event )

Called when the user select one of the 4 page corner as corner reference (or the left top paper corner).

Definition at line 451 of file pl_editor_frame.cpp.

References PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), GetCanvas(), m_originSelectBox, m_originSelectChoice, EDA_DRAW_PANEL_GAL::Refresh(), and UpdateStatusBar().

◆ OnSelectGrid()

void EDA_DRAW_FRAME::OnSelectGrid ( wxCommandEvent & event )

inherited

Command event handler for selecting grid sizes.

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

Parameters

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

Definition at line 444 of file eda_draw_frame.cpp.

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

◆ OnSelectPage()

void PL_EDITOR_FRAME::OnSelectPage ( wxCommandEvent & event )

Definition at line 442 of file pl_editor_frame.cpp.

References GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), LAYER_DRAWINGSHEET_PAGE1, LAYER_DRAWINGSHEET_PAGEn, m_pageSelectBox, EDA_DRAW_PANEL_GAL::Refresh(), and KIGFX::VIEW::SetLayerVisible().

◆ OnSelectZoom()

void EDA_DRAW_FRAME::OnSelectZoom ( wxCommandEvent & event )

virtualinherited

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

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

Definition at line 560 of file eda_draw_frame.cpp.

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

◆ OnSize()

void EDA_DRAW_FRAME::OnSize ( wxSizeEvent & event )

overridevirtualinherited

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

Reimplemented from EDA_BASE_FRAME.

Reimplemented in SYMBOL_DIFF_FRAME, SYMBOL_VIEWER_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 657 of file eda_draw_frame.cpp.

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

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

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent & evt )

inherited

Definition at line 69 of file eda_dde.cpp.

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

◆ OnSockRequestServer()

void KIWAY_PLAYER::OnSockRequestServer ( wxSocketEvent & evt )

inherited

Definition at line 99 of file eda_dde.cpp.

References ID_EDA_SOCKET_EVENT, and KIWAY_PLAYER::m_sockets.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent & aEvent )

protectedinherited

Definition at line 1598 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ OnToolbarSizeChanged()

void EDA_DRAW_FRAME::OnToolbarSizeChanged ( )

inherited

Update toolbars if desired toolbar icon changed.

Definition at line 1189 of file eda_draw_frame.cpp.

References EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_auxiliaryToolBar, EDA_DRAW_FRAME::m_drawToolBar, EDA_DRAW_FRAME::m_mainToolBar, and EDA_DRAW_FRAME::m_optionsToolBar.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged().

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent & aEvent )

inherited

Update the checked item in the grid wxchoice.

Definition at line 387 of file eda_draw_frame.cpp.

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

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

◆ OnUpdateSelectZoom()

void EDA_DRAW_FRAME::OnUpdateSelectZoom ( wxUpdateUIEvent & aEvent )

inherited

Update the checked item in the zoom wxchoice.

Definition at line 405 of file eda_draw_frame.cpp.

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

◆ OpenProjectFiles()

bool PL_EDITOR_FRAME::OpenProjectFiles	(	const std::vector< wxString > &	aFileList,
		int	aCtl
	)

overridevirtual

Open a project or set of files given by aFileList.

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

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

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

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

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

Parameters

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

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

Reimplemented from KIWAY_PLAYER.

Definition at line 353 of file pl_editor_frame.cpp.

References _, LoadDrawingSheetFile(), and OnNewDrawingSheet().

Referenced by DoWithAcceptedFiles().

◆ OptionalValueFromString()

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

inlineinherited

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

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

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

Parameters

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

Returns: internal units value

Definition at line 175 of file units_provider.h.

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

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

◆ PluginActionScope()

virtual PLUGIN_ACTION_SCOPE EDA_DRAW_FRAME::PluginActionScope ( ) const

inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 513 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::addApiPluginTools().

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )

virtualinherited

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

Definition at line 1492 of file eda_base_frame.cpp.

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

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

◆ PopCommandFromUndoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromUndoList ( )

virtualinherited

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

Definition at line 1486 of file eda_base_frame.cpp.

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

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

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const TOOL_EVENT & aEvent )

virtualinherited

Pops a tool from the stack.

Parameters

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

Definition at line 77 of file tools_holder.cpp.

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

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawOneBezier(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), DRAWING_TOOL::InteractivePlaceWithPreview(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), EDIT_TOOL::Remove(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintDrawingSheet()

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

inherited

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

Parameters

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

Definition at line 1067 of file eda_draw_frame.cpp.

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

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

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString & text )

inherited

Definition at line 902 of file eda_base_frame.cpp.

References text.

Referenced by KICAD_MANAGER_FRAME::OnUnarchiveFiles().

◆ PrintPage()

void PL_EDITOR_FRAME::PrintPage ( const RENDER_SETTINGS * aSettings )

overridevirtual

Print a page.

Parameters

aDC	is the device context used by the print function.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 801 of file pl_editor_frame.cpp.

References PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), drawSheetIUScale, DS_DATA_ITEM::DS_BITMAP, GetCanvas(), DS_DATA_MODEL::GetItems(), GetPageNumberOption(), BITMAP_BASE::GetPPI(), EDA_DRAW_FRAME::GetScreen(), DS_DATA_MODEL::GetTheInstance(), EDA_IU_SCALE::IU_PER_MILS, EDA_DRAW_FRAME::PrintDrawingSheet(), EDA_DRAW_PANEL_GAL::Refresh(), BITMAP_BASE::SetPixelSizeIu(), and BASE_SCREEN::SetVirtualPageNumber().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

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

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent & aEvent )

overrideinherited

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

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

Definition at line 289 of file eda_base_frame.cpp.

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

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

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )

inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in KICAD_MANAGER_FRAME, and PCB_EDIT_FRAME.

Definition at line 509 of file eda_base_frame.h.

Referenced by KIWAY::ProjectChanged().

◆ PropertiesPaneName()

static const wxString EDA_DRAW_FRAME::PropertiesPaneName ( )

inlinestaticinherited

Definition at line 416 of file eda_draw_frame.h.

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

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST * aItem )

virtualinherited

Add a command to redo in the redo list.

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

Definition at line 1471 of file eda_base_frame.cpp.

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

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

◆ PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST * aItem )

virtualinherited

Add a command to undo in the undo list.

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

Definition at line 1456 of file eda_base_frame.cpp.

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

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

◆ PushTool()

void TOOLS_HOLDER::PushTool ( const TOOL_EVENT & aEvent )

virtualinherited

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

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

Pushes a tool to the stack.

Parameters

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

Definition at line 56 of file tools_holder.cpp.

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

◆ ReCreateAuxiliaryToolbar()

virtual void EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar ( )

inlinevirtualinherited

Reimplemented in GERBVIEW_FRAME, and PCB_EDIT_FRAME.

Definition at line 216 of file eda_draw_frame.h.

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

◆ ReCreateHToolbar()

void PL_EDITOR_FRAME::ReCreateHToolbar ( )

overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 32 of file toolbars_pl_editor.cpp.

References _, ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddScaledSeparator(), ACTION_TOOLBAR::CANCEL, ACTION_TOOLBAR::ClearToolbar(), ACTIONS::doNew, KIUI::GetTextSize(), ID_H_TOOLBAR, ID_SELECT_COORDINATE_ORIGIN, ID_SELECT_PAGE_NUMBER, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, ACTION_TOOLBAR::KiRealize(), PL_ACTIONS::layoutEditMode, PL_ACTIONS::layoutNormalMode, EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_mainToolBar, m_originSelectBox, m_originSelectChoice, m_pageSelectBox, ACTIONS::open, PL_ACTIONS::previewSettings, ACTIONS::print, ACTIONS::redo, ACTIONS::save, ACTION_TOOLBAR::SetAuiManager(), PL_ACTIONS::showInspector, ACTION_TOOLBAR::TOGGLE, ACTIONS::undo, ACTION_TOOLBAR::UpdateControlWidth(), ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, ACTIONS::zoomRedraw, and ACTIONS::zoomTool.

◆ ReCreateMenuBar()

void EDA_BASE_FRAME::ReCreateMenuBar ( )

inherited

Recreates the menu bar.

Needed when the language or icons are changed

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

Definition at line 487 of file eda_base_frame.cpp.

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

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

◆ ReCreateOptToolbar()

void PL_EDITOR_FRAME::ReCreateOptToolbar ( )

overridevirtual

Create or update the left vertical toolbar.

Note: This is currently not used.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 160 of file toolbars_pl_editor.cpp.

References ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddToolContextMenu(), ACTION_TOOLBAR::ClearToolbar(), TOOL_MANAGER::GetTool(), ACTIONS::gridProperties, ID_OPT_TOOLBAR, ACTIONS::inchesUnits, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, ACTION_TOOLBAR::KiRealize(), EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_optionsToolBar, TOOLS_HOLDER::m_toolManager, ACTIONS::millimetersUnits, ACTIONS::milsUnits, ACTION_TOOLBAR::SetAuiManager(), ACTION_TOOLBAR::TOGGLE, and ACTIONS::toggleGrid.

◆ RecreateToolbars()

void EDA_DRAW_FRAME::RecreateToolbars ( )

inherited

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

Definition at line 1170 of file eda_draw_frame.cpp.

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

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

◆ ReCreateVToolbar()

void PL_EDITOR_FRAME::ReCreateVToolbar ( )

overridevirtual

Create or update the right vertical toolbar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 131 of file toolbars_pl_editor.cpp.

References ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddScaledSeparator(), PL_ACTIONS::appendImportedDrawingSheet, ACTION_TOOLBAR::ClearToolbar(), ACTIONS::deleteTool, PL_ACTIONS::drawLine, PL_ACTIONS::drawRectangle, ID_V_TOOLBAR, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, ACTION_TOOLBAR::KiRealize(), EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_drawToolBar, PL_ACTIONS::placeImage, PL_ACTIONS::placeText, ACTIONS::selectionTool, ACTION_TOOLBAR::SetAuiManager(), and ACTION_TOOLBAR::TOGGLE.

◆ RefreshCanvas()

void EDA_DRAW_FRAME::RefreshCanvas ( )

inlineoverridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 459 of file eda_draw_frame.h.

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

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

◆ RegisterUIUpdateHandler() [1/2]

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

virtualinherited

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

Parameters

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

Definition at line 42 of file tools_holder.cpp.

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

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

◆ RegisterUIUpdateHandler() [2/2]

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

overridevirtualinherited

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

Parameters

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

Reimplemented from TOOLS_HOLDER.

Definition at line 377 of file eda_base_frame.cpp.

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

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

◆ ReleaseFile()

void EDA_DRAW_FRAME::ReleaseFile ( )

inherited

Release the current file marked in use.

See m_file_checker.

Definition at line 195 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::m_file_checker.

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

◆ resolveCanvasType()

void EDA_DRAW_FRAME::resolveCanvasType ( )

protectedvirtualinherited

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

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 1305 of file eda_draw_frame.cpp.

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

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

◆ ReturnCoordOriginCorner()

VECTOR2I PL_EDITOR_FRAME::ReturnCoordOriginCorner ( ) const

Calculate the position (in page, in iu) of the corner used as coordinate origin of items.

Definition at line 659 of file pl_editor_frame.cpp.

References DS_DATA_ITEM::DS_SEGMENT, dummy, LB_CORNER, LT_CORNER, m_originSelectChoice, RB_CORNER, and RT_CORNER.

Referenced by UpdateStatusBar().

◆ RollbackFromUndo()

void PL_EDITOR_FRAME::RollbackFromUndo ( )

Apply the last command in Undo List without stacking a Redo.

Used to clean the Undo stack after canceling a command.

Definition at line 125 of file pl_editor_undo_redo.cpp.

References PL_SELECTION_TOOL::ClearSelection(), GetCanvas(), ITEM_PICKER::GetItem(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), EDA_BASE_FRAME::GetUndoCommandCount(), EDA_DRAW_PANEL_GAL::GetView(), HardRedraw(), EDA_BASE_FRAME::PopCommandFromUndoList(), PICKED_ITEMS_LIST::PopItem(), PL_SELECTION_TOOL::RebuildSelection(), EDA_DRAW_PANEL_GAL::Refresh(), DS_PROXY_UNDO_ITEM::Restore(), TOOL_MANAGER::RunAction(), EDA_ITEM::Type(), WS_PROXY_UNDO_ITEM_PLUS_T, and ACTIONS::zoomFitScreen.

Referenced by PL_DRAWING_TOOLS::DrawShape(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_EDITOR_CONTROL::PageSetup(), and PL_DRAWING_TOOLS::PlaceItem().

◆ SaveCanvasImageToFile()

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

inherited

Save the current view as an image file.

Parameters

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

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

Definition at line 1334 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::GetCanvas(), and image.

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

◆ saveCanvasTypeSetting()

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

protectedinherited

Stores the canvas type in the application settings.

Definition at line 900 of file eda_draw_frame.cpp.

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

Referenced by EDA_DRAW_FRAME::~EDA_DRAW_FRAME().

◆ SaveCopyInUndoList()

void PL_EDITOR_FRAME::SaveCopyInUndoList ( )

Save a copy of the description (in a S expr string) for Undo/redo commands.

Definition at line 34 of file pl_editor_undo_redo.cpp.

References ClearUndoORRedoList(), EDA_DRAW_FRAME::GetScreen(), EDA_BASE_FRAME::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), and EDA_BASE_FRAME::REDO_LIST.

Referenced by PL_EDIT_TOOL::DoDelete(), PL_DRAWING_TOOLS::DrawShape(), InsertDrawingSheetFile(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PROPERTIES_FRAME::OnAcceptPrms(), PL_EDITOR_CONTROL::PageSetup(), and PL_DRAWING_TOOLS::PlaceItem().

◆ saveCurrentPageLayout()

bool PL_EDITOR_FRAME::saveCurrentPageLayout ( )

protected

Definition at line 45 of file pagelayout_editor/files.cpp.

References Files_io(), and IsContentModified().

Referenced by Files_io(), and OnFileHistory().

◆ SaveDrawingSheetFile()

bool PL_EDITOR_FRAME::SaveDrawingSheetFile ( const wxString & aFullFileName )

Save the current layout in a .kicad_wks drawing sheet file.

Parameters

aFullFileName is the filename.

Definition at line 294 of file pagelayout_editor/files.cpp.

References WX_INFOBAR::Dismiss(), KIPLATFORM::IO::DuplicatePermissions(), WX_INFOBAR::GetMessageType(), EDA_DRAW_FRAME::GetScreen(), DS_DATA_MODEL::GetTheInstance(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::OUTDATED_SAVE, DS_DATA_MODEL::Save(), BASE_SCREEN::SetContentModified(), and UpdateTitleAndInfo().

Referenced by Files_io().

◆ SaveProjectLocalSettings()

virtual void EDA_BASE_FRAME::SaveProjectLocalSettings ( )

inlinevirtualinherited

Save changes to the project local settings.

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

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 365 of file eda_base_frame.h.

◆ saveProjectSettings()

virtual void EDA_BASE_FRAME::saveProjectSettings ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 678 of file eda_base_frame.h.

◆ SaveSettings()

void PL_EDITOR_FRAME::SaveSettings ( APP_SETTINGS_BASE * aCfg )

overridevirtual

Save common frame parameters to a configuration data file.

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 552 of file pl_editor_frame.cpp.

References BLACK, PAGE_INFO::GetCustomHeightMils(), PAGE_INFO::GetCustomWidthMils(), EDA_DRAW_FRAME::GetDrawBgColor(), GetPageSettings(), PAGE_INFO::GetType(), PAGE_INFO::IsPortrait(), m_originSelectChoice, m_propertiesFrameWidth, m_propertiesPagelayout, and EDA_DRAW_FRAME::SaveSettings().

◆ SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings ( WINDOW_SETTINGS * aCfg )

inherited

Save window settings to the given settings object.

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

Definition at line 796 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ ScriptingConsoleEnableDisable()

void EDA_DRAW_FRAME::ScriptingConsoleEnableDisable ( )

inherited

Toggles the scripting console visibility.

Definition at line 225 of file eda_draw_frame.cpp.

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

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

◆ SetCanvas()

void EDA_DRAW_FRAME::SetCanvas ( EDA_DRAW_PANEL_GAL * aPanel )

inlineinherited

Definition at line 450 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_canvas.

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

◆ SetCurrentFileName()

void PL_EDITOR_FRAME::SetCurrentFileName ( const wxString & aName )

Store the current layout description file filename.

Definition at line 595 of file pl_editor_frame.cpp.

References BASE_SCREEN::m_DrawingSheetFileName.

Referenced by Files_io(), and LoadDrawingSheetFile().

◆ SetDrawBgColor()

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

inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME.

Definition at line 181 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_drawBgColor.

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

◆ SetGridColor()

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

inlinevirtualinherited

Reimplemented in GERBVIEW_FRAME, and PCB_EDIT_FRAME.

Definition at line 235 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_gridColor.

◆ SetGridOrigin()

void PL_EDITOR_FRAME::SetGridOrigin ( const VECTOR2I & aPoint )

inlineoverridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 113 of file pl_editor_frame.h.

References m_grid_origin.

Referenced by UpdateStatusBar().

◆ SetGridOverrides()

void EDA_DRAW_FRAME::SetGridOverrides ( bool aOverride )

virtualinherited

Definition at line 521 of file eda_draw_frame.cpp.

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

Referenced by COMMON_TOOLS::ToggleGridOverrides().

◆ SetGridVisibility()

void EDA_DRAW_FRAME::SetGridVisibility ( bool aVisible )

virtualinherited

Reimplemented in GERBVIEW_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 491 of file eda_draw_frame.cpp.

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

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

◆ SetKiway()

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

inherited

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

"this" is a KIWAY_HOLDER mix-in.

Parameters

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

Definition at line 43 of file kiway_holder.cpp.

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

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

◆ SetMenuBar()

void EDA_BASE_FRAME::SetMenuBar ( wxMenuBar * menu_bar )

overrideinherited

Definition at line 504 of file eda_base_frame.cpp.

References _.

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

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool aIsModal )

inlineinherited

Definition at line 155 of file kiway_player.h.

References KIWAY_PLAYER::m_modal.

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

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString & aPath )

inlineinherited

Definition at line 421 of file eda_base_frame.h.

References EDA_BASE_FRAME::m_mruPath.

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

◆ SetMsgPanel() [1/3]

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

inherited

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

Parameters

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

Definition at line 817 of file eda_draw_frame.cpp.

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

Referenced by BOARD_INSPECTION_TOOL::ClearHighlight(), PCB_BASE_FRAME::Compile_Ratsnest(), PCB_BASE_FRAME::CreateNewFootprint(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawOneBezier(), SCH_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::GenIPC2581File(), PCB_EDIT_FRAME::GenODBPPFiles(), PCB_EDIT_FRAME::HardRedraw(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), SCH_EDIT_FRAME::LoadSheetFromFile(), PCB_EDIT_FRAME::onBoardLoaded(), PCB_EDIT_FRAME::OnNetlistChanged(), SCH_PRINTOUT::OnPrintPage(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveSchematicFile(), EDA_DRAW_FRAME::SetMsgPanel(), SCH_DRAWING_TOOLS::SingleClickPlace(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), PL_POINT_EDITOR::updateItem(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_EDIT_FRAME::UpdateMsgPanel(), FOOTPRINT_VIEWER_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), UpdateMsgPanelInfo(), and EE_POINT_EDITOR::updateParentItem().

◆ SetMsgPanel() [2/3]

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

inherited

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

Parameters

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

Definition at line 829 of file eda_draw_frame.cpp.

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

◆ SetMsgPanel() [3/3]

void EDA_DRAW_FRAME::SetMsgPanel ( EDA_ITEM * aItem )

inherited

Definition at line 840 of file eda_draw_frame.cpp.

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

◆ SetPageSettings()

void PL_EDITOR_FRAME::SetPageSettings ( const PAGE_INFO & aPageSettings )

overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 601 of file pl_editor_frame.cpp.

References drawSheetIUScale, EDA_DRAW_FRAME::GetScreen(), PAGE_INFO::GetSizeIU(), BASE_SCREEN::InitDataPoints(), EDA_IU_SCALE::IU_PER_MILS, m_pageLayout, and PL_EDITOR_LAYOUT::SetPageSettings().

Referenced by LoadSettings().

◆ SetScreen()

virtual void EDA_DRAW_FRAME::SetScreen ( BASE_SCREEN * aScreen )

inlineprotectedvirtualinherited

Reimplemented in SCH_EDIT_FRAME, and SYMBOL_EDIT_FRAME.

Definition at line 519 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_currentScreen.

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

◆ SetShowPolarCoords()

void EDA_DRAW_FRAME::SetShowPolarCoords ( bool aShow )

inlineinherited

Definition at line 133 of file eda_draw_frame.h.

References EDA_DRAW_FRAME::m_polarCoords.

Referenced by COMMON_TOOLS::TogglePolarCoords().

◆ SetTitleBlock()

void PL_EDITOR_FRAME::SetTitleBlock ( const TITLE_BLOCK & aTitleBlock )

overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 631 of file pl_editor_frame.cpp.

References m_pageLayout, and PL_EDITOR_LAYOUT::SetTitleBlock().

◆ setupTools()

void PL_EDITOR_FRAME::setupTools ( )

Definition at line 258 of file pl_editor_frame.cpp.

References EDA_BASE_FRAME::config(), GetCanvas(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::InvokeTool(), TOOLS_HOLDER::m_actions, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::SetEnvironment(), and EDA_DRAW_PANEL_GAL::SetEventDispatcher().

◆ setupUIConditions()

void PL_EDITOR_FRAME::setupUIConditions ( )

overrideprotectedvirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 286 of file pl_editor_frame.cpp.

References PL_ACTIONS::appendImportedDrawingSheet, CHECK, ACTIONS::copy, EDITOR_CONDITIONS::CurrentTool(), ACTIONS::cut, ACTIONS::deleteTool, ACTIONS::doDelete, PL_ACTIONS::drawLine, PL_ACTIONS::drawRectangle, ENABLE, EDITOR_CONDITIONS::FullscreenCursor(), TOOL_MANAGER::GetActionManager(), DS_DATA_MODEL::GetTheInstance(), EDITOR_CONDITIONS::GridVisible(), SELECTION_CONDITIONS::Idle(), ACTIONS::inchesUnits, PL_ACTIONS::layoutEditMode, PL_ACTIONS::layoutNormalMode, DS_DATA_MODEL::m_EditMode, TOOLS_HOLDER::m_toolManager, ACTIONS::millimetersUnits, ACTIONS::milsUnits, EDITOR_CONDITIONS::NoActiveTool(), SELECTION_CONDITIONS::NotEmpty(), ACTIONS::paste, PL_ACTIONS::placeImage, PL_ACTIONS::placeText, ACTIONS::redo, EDITOR_CONDITIONS::RedoAvailable(), ACTIONS::save, ACTIONS::selectionTool, ACTION_MANAGER::SetConditions(), EDA_BASE_FRAME::setupUIConditions(), SELECTION_CONDITIONS::ShowAlways(), SELECTION_CONDITIONS::ShowNever(), ACTIONS::toggleCursorStyle, ACTIONS::toggleGrid, ACTIONS::undo, EDITOR_CONDITIONS::UndoAvailable(), EDITOR_CONDITIONS::Units(), and ACTIONS::zoomTool.

◆ setupUnits()

void EDA_DRAW_FRAME::setupUnits ( APP_SETTINGS_BASE * aCfg )

protectedinherited

Definition at line 1259 of file eda_draw_frame.cpp.

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

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

◆ SetUserUnits()

void UNITS_PROVIDER::SetUserUnits ( EDA_UNITS aUnits )

inlineinherited

Definition at line 46 of file units_provider.h.

References UNITS_PROVIDER::m_userUnits.

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

◆ ShowChangedLanguage()

void EDA_DRAW_FRAME::ShowChangedLanguage ( )

overridevirtualinherited

Redraw the menus and what not in current language.

Reimplemented from EDA_BASE_FRAME.

Reimplemented in PCB_BASE_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 1207 of file eda_draw_frame.cpp.

References _, EDA_BASE_FRAME::m_auimgr, EDA_DRAW_FRAME::m_netInspectorPanel, EDA_DRAW_FRAME::m_propertiesPanel, EDA_DRAW_FRAME::m_searchPane, and EDA_BASE_FRAME::ShowChangedLanguage().

Referenced by GERBVIEW_FRAME::ShowChangedLanguage(), and PCB_BASE_FRAME::ShowChangedLanguage().

◆ ShowDesignInspector()

void PL_EDITOR_FRAME::ShowDesignInspector ( )

Show the dialog displaying the list of DS_DATA_ITEM items in the page layout.

Definition at line 368 of file design_inspector.cpp.

References DIALOG_SHIM::ShowModal().

Referenced by PL_EDITOR_CONTROL::ShowInspector().

◆ ShowInfoBarError() [1/2]

void EDA_BASE_FRAME::ShowInfoBarError	(	const wxString &	aErrorMsg,
		bool	aShowCloseButton,
		std::function< void(void)>	aCallback
	)

inherited

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

The infobar will be closed after a timeout.

This version accepts a callback which will be called when the infobar is dismissed (either as a result of user action or a timeout). This can be useful when the caller wants to make other decorations in the canvas to highlight the error.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.
aCallback	a callback to be called when the infobar is dismissed.

Definition at line 948 of file eda_base_frame.cpp.

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

◆ ShowInfoBarError() [2/2]

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

inherited

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

The infobar will be closed after a timeout.

Parameters

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

Definition at line 936 of file eda_base_frame.cpp.

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

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

◆ ShowInfoBarMsg()

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

inherited

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

The infobar will be closed after a timeout.

Parameters

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

Definition at line 974 of file eda_base_frame.cpp.

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

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

◆ ShowInfoBarWarning()

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

inherited

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

The infobar will be closed after a timeout.

Parameters

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

Definition at line 963 of file eda_base_frame.cpp.

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

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

◆ ShowModal()

bool KIWAY_PLAYER::ShowModal	(	wxString *	aResult = `nullptr`,
		wxWindow *	aResultantFocusWindow = `nullptr`
	)

virtualinherited

Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal().

This is behavior is similar to a modal dialog window. Not all KIWAY_PLAYERs use this interface, so don't call this unless the implementation knows how to call DismissModal() on a button click or double click or some special event which ends the modal behavior.

Parameters

aResult	if not NULL, indicates a place to put a resultant string.
aResultantFocusWindow	if not NULL, indicates what window to pass focus to on return.

Returns: true if frame implementation called KIWAY_PLAYER::DismissModal() with aRetVal of true.

Reimplemented in FOOTPRINT_CHOOSER_FRAME, SYMBOL_CHOOSER_FRAME, and SYMBOL_DIFF_FRAME.

Definition at line 94 of file kiway_player.cpp.

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

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

◆ ShowPreferences()

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

inherited

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

Definition at line 1074 of file eda_base_frame.cpp.

References _, PANEL_HOTKEYS_EDITOR::ActionsList(), WX_TREEBOOK::AddLazyPage(), WX_TREEBOOK::AddLazySubPage(), KIWAY::CommonSettingsChanged(), KIWAY::FACE_GERBVIEW, KIWAY::FACE_PCB, KIWAY::FACE_PL_EDITOR, KIWAY::FACE_SCH, FRAME_FOOTPRINT_EDITOR, FRAME_GERBER, FRAME_PCB_DISPLAY3D, FRAME_PCB_EDITOR, FRAME_PL_EDITOR, FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, KIWAY::GetActions(), KIFACE_BASE::GetActions(), ADVANCED_CFG::GetCfg(), EDA_BASE_FRAME::GetFrameType(), PGM_BASE::GetSettingsManager(), PAGED_DIALOG::GetTreebook(), kiface(), KIWAY::KiFACE(), KIWAY_HOLDER::Kiway(), LAZY_CTOR, ADVANCED_CFG::m_EnableGit, TOOLS_HOLDER::m_toolManager, PANEL_3DV_DISPLAY_OPTIONS, PANEL_3DV_OPENGL, PANEL_3DV_RAYTRACING, PANEL_DS_COLORS, PANEL_DS_DISPLAY_OPTIONS, PANEL_DS_GRIDS, PANEL_FP_COLORS, PANEL_FP_DEFAULT_VALUES, PANEL_FP_DISPLAY_OPTIONS, PANEL_FP_EDIT_OPTIONS, PANEL_FP_GRIDS, PANEL_FP_ORIGINS_AXES, PANEL_GBR_COLORS, PANEL_GBR_DISPLAY_OPTIONS, PANEL_GBR_EXCELLON_OPTIONS, PANEL_GBR_GRIDS, PANEL_PCB_ACTION_PLUGINS, PANEL_PCB_COLORS, PANEL_PCB_DISPLAY_OPTS, PANEL_PCB_EDIT_OPTIONS, PANEL_PCB_GRIDS, PANEL_PCB_ORIGINS_AXES, PANEL_SCH_ANNO_OPTIONS, PANEL_SCH_COLORS, PANEL_SCH_DISP_OPTIONS, PANEL_SCH_EDIT_OPTIONS, PANEL_SCH_FIELD_NAME_TEMPLATES, PANEL_SCH_GRIDS, PANEL_SCH_SIMULATOR, PANEL_SYM_COLORS, PANEL_SYM_DISP_OPTIONS, PANEL_SYM_EDIT_GRIDS, PANEL_SYM_EDIT_OPTIONS, Pgm(), ReadHotKeyConfigIntoActions(), TOOL_BASE::REDRAW, TOOL_MANAGER::ResetTools(), SETTINGS_MANAGER::Save(), PAGED_DIALOG::SetInitialPage(), and DIALOG_SHIM::ShowModal().

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

◆ StringFromOptionalValue()

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

inlineinherited

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

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

Parameters

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

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

Definition at line 104 of file units_provider.h.

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

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

◆ StringFromValue() [1/2]

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

inlineinherited

Definition at line 114 of file units_provider.h.

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

◆ StringFromValue() [2/2]

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

inlineinherited

Converts aValue in internal units into a united string.

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

Parameters

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

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

Definition at line 83 of file units_provider.h.

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

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

◆ SwitchCanvas()

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

virtualinherited

Changes the current rendering backend.

Reimplemented in SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 862 of file eda_draw_frame.cpp.

References EDA_DRAW_FRAME::ActivateGalCanvas(), EDA_DRAW_PANEL_GAL::GetBackend(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_FRAME::m_canvasType, and EDA_DRAW_PANEL_GAL::SwitchBackend().

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_EDIT_FRAME::SwitchCanvas(), FOOTPRINT_EDIT_FRAME::SwitchCanvas(), and PCB_EDIT_FRAME::SwitchCanvas().

◆ sys_search()

const SEARCH_STACK & EDA_BASE_FRAME::sys_search ( )

virtualinherited

Return a SEARCH_STACK pertaining to entire program.

This is overloaded in KICAD_MANAGER_FRAME

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 890 of file eda_base_frame.cpp.

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

◆ ThemeChanged()

void EDA_BASE_FRAME::ThemeChanged ( )

virtualinherited

Process light/dark theme change.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 590 of file eda_base_frame.cpp.

References ClearScaledBitmapCache(), and EDA_BASE_FRAME::m_auimgr.

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

◆ ToggleLibraryTree()

virtual void EDA_DRAW_FRAME::ToggleLibraryTree ( )

inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 407 of file eda_draw_frame.h.

Referenced by LIBRARY_EDITOR_CONTROL::LibraryTreeSearch(), and LIBRARY_EDITOR_CONTROL::ToggleLibraryTree().

◆ ToggleProperties()

virtual void EDA_DRAW_FRAME::ToggleProperties ( )

inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 414 of file eda_draw_frame.h.

◆ ToggleUserUnits()

void EDA_DRAW_FRAME::ToggleUserUnits ( )

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 277 of file eda_draw_frame.cpp.

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

◆ ToolStackIsEmpty()

bool TOOLS_HOLDER::ToolStackIsEmpty ( )

inlineinherited

◆ ToPrinter()

void PL_EDITOR_FRAME::ToPrinter ( bool doPreview )

Open a dialog frame to print layers.

Definition at line 460 of file pl_editor_frame.cpp.

References _, PAGE_INFO::GetHeightMils(), GetPageSettings(), PAGE_INFO::GetPaperId(), PAGE_INFO::GetWidthMils(), PAGE_INFO::GetWxOrientation(), InvokeDialogPrint(), InvokeDialogPrintPreview(), PAGE_INFO::IsCustom(), PAGE_INFO::IsPortrait(), and EDA_UNIT_UTILS::Mils2mm().

Referenced by PL_EDITOR_CONTROL::Print().

◆ unitsChangeRefresh()

void EDA_DRAW_FRAME::unitsChangeRefresh ( )

overrideprotectedvirtualinherited

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

The default version only updates the status bar. Don't forget to call the default in your derived class or the status bar will not get updated properly.

Reimplemented from EDA_BASE_FRAME.

Reimplemented in PCB_BASE_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 265 of file eda_draw_frame.cpp.

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

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

◆ UnregisterUIUpdateHandler() [1/2]

void TOOLS_HOLDER::UnregisterUIUpdateHandler ( const TOOL_ACTION & aAction )

virtualinherited

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

Parameters

aAction is the action to unregister the handler for.

Definition at line 49 of file tools_holder.cpp.

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

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

◆ UnregisterUIUpdateHandler() [2/2]

void EDA_BASE_FRAME::UnregisterUIUpdateHandler ( int aID )

overridevirtualinherited

Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler.

Parameters

aID	is the control ID to unregister the handler for

Reimplemented from TOOLS_HOLDER.

Definition at line 390 of file eda_base_frame.cpp.

References EDA_BASE_FRAME::m_uiUpdateMap.

◆ UpdateFileHistory()

void EDA_BASE_FRAME::UpdateFileHistory	(	const wxString &	FullFileName,
		FILE_HISTORY *	aFileHistory = `nullptr`
	)

inherited

Update the list of recently opened files.

The menu is also updated, if FILE_HISTORY::UseMenu was called at init time.

Parameters

FullFileName	The full file name including the path.
aFileHistory	The FILE_HISTORY in use. If NULL, the main application file history is used.

Definition at line 985 of file eda_base_frame.cpp.

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

Referenced by SCH_EDIT_FRAME::doCloseWindow(), LoadDrawingSheetFile(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), BITMAP2CMP_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), EDA_BASE_FRAME::SaveSettings(), and GERBVIEW_FRAME::unarchiveFiles().

◆ UpdateGridSelectBox()

void EDA_DRAW_FRAME::UpdateGridSelectBox ( )

inherited

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

Definition at line 361 of file eda_draw_frame.cpp.

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

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::unitsChangeRefresh(), and PCB_BASE_FRAME::unitsChangeRefresh().

◆ UpdateMsgPanel()

void EDA_DRAW_FRAME::UpdateMsgPanel ( )

virtualinherited

Redraw the message panel.

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 850 of file eda_draw_frame.cpp.

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), PCB_BASE_FRAME::OnModify(), SCH_EDIT_FRAME::ShowChangedLanguage(), EDA_DRAW_FRAME::unitsChangeRefresh(), FOOTPRINT_EDIT_FRAME::UpdateMsgPanel(), and FOOTPRINT_VIEWER_FRAME::UpdateMsgPanel().

◆ UpdateMsgPanelInfo()

void PL_EDITOR_FRAME::UpdateMsgPanelInfo ( )

Display the size of the sheet to the message panel.

Definition at line 982 of file pl_editor_frame.cpp.

References _, drawSheetIUScale, GetPageSettings(), PAGE_INFO::GetSizeIU(), EDA_IU_SCALE::IU_PER_MILS, UNITS_PROVIDER::MessageTextFromValue(), EDA_DRAW_FRAME::SetMsgPanel(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by HardRedraw(), and PL_EDITOR_CONTROL::UpdateMessagePanel().

◆ UpdateProperties()

void EDA_DRAW_FRAME::UpdateProperties ( )

inherited

Definition at line 1231 of file eda_draw_frame.cpp.

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

Referenced by SCH_EDIT_FRAME::unitsChangeRefresh(), EDA_DRAW_FRAME::unitsChangeRefresh(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), and PROPERTIES_TOOL::UpdateProperties().

◆ UpdateStatusBar()

void PL_EDITOR_FRAME::UpdateStatusBar ( )

overridevirtual

Update the status bar information.

The EDA_DRAW_FRAME level updates the absolute and relative coordinates and the zoom information. If you override this virtual method, make sure to call this subclassed method.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 719 of file pl_editor_frame.cpp.

References _, DisplayGridMsg(), drawSheetIUScale, GetCanvas(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), EDA_DRAW_FRAME::GetScreen(), UNITS_PROVIDER::GetUserUnits(), EDA_DRAW_PANEL_GAL::GetViewControls(), EDA_DRAW_FRAME::GetZoomLevelIndicator(), BASE_SCREEN::m_LocalOrigin, m_originSelectBox, m_originSelectChoice, ReturnCoordOriginCorner(), SetGridOrigin(), EDA_UNIT_UTILS::UI::ToUserUnit(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by OnSelectCoordOriginCorner().

◆ updateStatusBarWidths()

void EDA_DRAW_FRAME::updateStatusBarWidths ( )

protectedinherited

Definition at line 667 of file eda_draw_frame.cpp.

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

◆ UpdateTitleAndInfo()

void PL_EDITOR_FRAME::UpdateTitleAndInfo ( )

Display the short filename (if exists) loaded file on the caption of the main window.

Definition at line 570 of file pl_editor_frame.cpp.

References _, GetCurrentFileName(), and IsContentModified().

Referenced by Files_io(), OnModify(), OnNewDrawingSheet(), and SaveDrawingSheetFile().

◆ UpdateToolbarControlSizes()

void PL_EDITOR_FRAME::UpdateToolbarControlSizes ( )

overridevirtual

Update the sizes of any controls in the toolbars of the frame.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 188 of file toolbars_pl_editor.cpp.

References ID_SELECT_COORDINATE_ORIGIN, ID_SELECT_PAGE_NUMBER, EDA_DRAW_FRAME::m_mainToolBar, and ACTION_TOOLBAR::UpdateControlWidth().

◆ UpdateZoomSelectBox()

void EDA_DRAW_FRAME::UpdateZoomSelectBox ( )

inherited

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

Definition at line 535 of file eda_draw_frame.cpp.

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

Referenced by GERBVIEW_FRAME::ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), and FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar().

◆ ValueFromString()

int UNITS_PROVIDER::ValueFromString	(	const wxString &	aTextValue,
		EDA_DATA_TYPE	aType = `EDA_DATA_TYPE::DISTANCE`
	)		const

inlineinherited

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

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

Parameters

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

Returns: internal units value

Definition at line 155 of file units_provider.h.

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

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

◆ windowClosing()

void EDA_BASE_FRAME::windowClosing ( wxCloseEvent & event )

privateinherited

(with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings().

SaveSettings() is called for all derived wxFrames in this base class overload. Calling it from a destructor is deprecated since the wxFrame's position is not available in the destructor on linux. In other words, you should not need to call SaveSettings() anywhere, except in this one function found only in this class.

Definition at line 219 of file eda_base_frame.cpp.

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

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

◆ Zoom_Automatique()

void EDA_DRAW_FRAME::Zoom_Automatique ( bool aWarpPointer )

virtualinherited

Redraw the screen with best zoom level and the best centering that shows all the page or the board.

Definition at line 970 of file eda_draw_frame.cpp.

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

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

Member Data Documentation

◆ KICAD_AUI_TB_STYLE

constexpr int EDA_BASE_FRAME::KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND

staticconstexprprotectedinherited

< Default style flags used for wxAUI toolbars.

Definition at line 612 of file eda_base_frame.h.

◆ m_aboutTitle

wxString EDA_BASE_FRAME::m_aboutTitle

protectedinherited

Definition at line 747 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_BASE_FRAME::GetAboutTitle(), EDA_BASE_FRAME::GetUntranslatedAboutTitle(), KICAD_MANAGER_FRAME::KICAD_MANAGER_FRAME(), and SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME().

◆ m_acceptedExts

std::map<const wxString, TOOL_ACTION*> EDA_BASE_FRAME::m_acceptedExts

protectedinherited

Associates files extensions with action to execute.

Definition at line 786 of file eda_base_frame.h.

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

◆ m_AcceptedFiles

std::vector<wxFileName> EDA_BASE_FRAME::m_AcceptedFiles

protectedinherited

Definition at line 696 of file eda_base_frame.h.

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

◆ m_actions

ACTIONS* TOOLS_HOLDER::m_actions

protectedinherited

Definition at line 168 of file tools_holder.h.

Referenced by PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), and KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME().

◆ m_appearancePanel

APPEARANCE_CONTROLS_3D* EDA_BASE_FRAME::m_appearancePanel

protectedinherited

Definition at line 752 of file eda_base_frame.h.

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

◆ m_auimgr

wxAuiManager EDA_BASE_FRAME::m_auimgr

protectedinherited

Definition at line 749 of file eda_base_frame.h.

◆ m_autoSavePending

bool EDA_BASE_FRAME::m_autoSavePending

protectedinherited

Definition at line 760 of file eda_base_frame.h.

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

◆ m_autoSaveRequired

bool EDA_BASE_FRAME::m_autoSaveRequired

protectedinherited

Definition at line 761 of file eda_base_frame.h.

Referenced by SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::Files_io_from_id(), EDA_BASE_FRAME::isAutoSaveRequired(), EDA_BASE_FRAME::OnModify(), SCH_EDIT_FRAME::OnModify(), SYMBOL_EDIT_FRAME::OnModify(), PCB_BASE_FRAME::OnModify(), and SCH_EDIT_FRAME::SaveProject().

◆ m_autoSaveTimer

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer

protectedinherited

Definition at line 762 of file eda_base_frame.h.

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

◆ m_auxiliaryToolBar

ACTION_TOOLBAR* EDA_DRAW_FRAME::m_auxiliaryToolBar

protectedinherited

Definition at line 576 of file eda_draw_frame.h.

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

◆ m_canvas

EDA_DRAW_PANEL_GAL* EDA_DRAW_FRAME::m_canvas

privateinherited

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

Definition at line 602 of file eda_draw_frame.h.

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

◆ m_canvasType

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::m_canvasType

protectedinherited

Definition at line 595 of file eda_draw_frame.h.

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

◆ m_colorSettings

COLOR_SETTINGS* EDA_DRAW_FRAME::m_colorSettings

protectedinherited

Definition at line 587 of file eda_draw_frame.h.

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

◆ m_configName

wxString EDA_BASE_FRAME::m_configName

protectedinherited

Definition at line 753 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::ConfigBaseName().

◆ m_currentScreen

BASE_SCREEN* EDA_DRAW_FRAME::m_currentScreen

privateinherited

current used SCREEN

Definition at line 601 of file eda_draw_frame.h.

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

◆ m_displayIndex

int EDA_BASE_FRAME::m_displayIndex

protectedinherited

Definition at line 741 of file eda_base_frame.h.

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

◆ m_dragAction

MOUSE_DRAG_ACTION TOOLS_HOLDER::m_dragAction

protectedinherited

Definition at line 184 of file tools_holder.h.

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

◆ m_drawBgColor

COLOR4D EDA_DRAW_FRAME::m_drawBgColor

protectedinherited

Definition at line 564 of file eda_draw_frame.h.

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

◆ m_drawToolBar

ACTION_TOOLBAR* EDA_DRAW_FRAME::m_drawToolBar

protectedinherited

Definition at line 577 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::OnToolbarSizeChanged(), EDA_DRAW_FRAME::RecreateToolbars(), SCH_EDIT_FRAME::ReCreateVToolbar(), SYMBOL_EDIT_FRAME::ReCreateVToolbar(), ReCreateVToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateVToolbar(), and PCB_EDIT_FRAME::ReCreateVToolbar().

◆ m_dummySelection

SELECTION TOOLS_HOLDER::m_dummySelection

protectedinherited

Definition at line 171 of file tools_holder.h.

Referenced by TOOLS_HOLDER::GetCurrentSelection().

◆ m_file_checker

std::unique_ptr<LOCKFILE> EDA_DRAW_FRAME::m_file_checker

protectedinherited

Definition at line 561 of file eda_draw_frame.h.

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

◆ m_fileHistory

FILE_HISTORY* EDA_BASE_FRAME::m_fileHistory

protectedinherited

Definition at line 758 of file eda_base_frame.h.

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

◆ m_findReplaceData

std::unique_ptr<EDA_SEARCH_DATA> EDA_DRAW_FRAME::m_findReplaceData

protectedinherited

Definition at line 580 of file eda_draw_frame.h.

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

◆ m_findStringHistoryList

wxArrayString EDA_DRAW_FRAME::m_findStringHistoryList

protectedinherited

Definition at line 581 of file eda_draw_frame.h.

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

◆ m_framePos

wxPoint EDA_BASE_FRAME::m_framePos

protectedinherited

Definition at line 738 of file eda_base_frame.h.

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

◆ m_frameSize

wxSize EDA_BASE_FRAME::m_frameSize

protectedinherited

Definition at line 739 of file eda_base_frame.h.

Referenced by SCH_BASE_FRAME::createCanvas(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_BASE_FRAME::LoadWindowState(), EDA_DRAW_FRAME::OnSize(), and EDA_BASE_FRAME::SaveWindowSettings().

◆ m_galDisplayOptions

GAL_DISPLAY_OPTIONS_IMPL EDA_DRAW_FRAME::m_galDisplayOptions

privateinherited

Definition at line 605 of file eda_draw_frame.h.

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

◆ m_grid_origin

VECTOR2I PL_EDITOR_FRAME::m_grid_origin

private

Definition at line 290 of file pl_editor_frame.h.

Referenced by GetGridOrigin(), and SetGridOrigin().

◆ m_gridColor

COLOR4D EDA_DRAW_FRAME::m_gridColor

protectedinherited

Definition at line 563 of file eda_draw_frame.h.

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

◆ m_gridSelectBox

wxChoice* EDA_DRAW_FRAME::m_gridSelectBox

protectedinherited

Definition at line 572 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::OnSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), GERBVIEW_FRAME::ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), and EDA_DRAW_FRAME::UpdateGridSelectBox().

◆ m_hotkeyPopup

HOTKEY_CYCLE_POPUP* EDA_DRAW_FRAME::m_hotkeyPopup

protectedinherited

The current canvas type.

Definition at line 592 of file eda_draw_frame.h.

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

◆ m_ident

FRAME_T EDA_BASE_FRAME::m_ident

protectedinherited

Definition at line 737 of file eda_base_frame.h.

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

◆ m_immediateActions

bool TOOLS_HOLDER::m_immediateActions

protectedinherited

Definition at line 180 of file tools_holder.h.

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

◆ m_infoBar

◆ m_isClosing

bool EDA_BASE_FRAME::m_isClosing

protectedinherited

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

Definition at line 778 of file eda_base_frame.h.

Referenced by EDA_DRAW_FRAME::AppendMsgPanel(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), EDA_DRAW_FRAME::ClearMsgPanel(), GERBVIEW_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), SYMBOL_EDIT_FRAME::IsSymbolFromSchematic(), EDA_BASE_FRAME::ProcessEvent(), EDA_BASE_FRAME::ReCreateMenuBar(), EDA_BASE_FRAME::SaveSettings(), KICAD_MANAGER_FRAME::SaveSettings(), EDA_DRAW_FRAME::SetMsgPanel(), EDA_BASE_FRAME::UpdateFileHistory(), and EDA_BASE_FRAME::windowClosing().

◆ m_isNonUserClose

bool EDA_BASE_FRAME::m_isNonUserClose

protectedinherited

Definition at line 781 of file eda_base_frame.h.

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

◆ m_iuScale

const EDA_IU_SCALE& UNITS_PROVIDER::m_iuScale

privateinherited

Definition at line 200 of file units_provider.h.

Referenced by UNITS_PROVIDER::GetIuScale().

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway

privateinherited

Definition at line 86 of file kiway_holder.h.

Referenced by KIWAY_HOLDER::SetKiway().

◆ m_lastToolbarIconSize

int EDA_DRAW_FRAME::m_lastToolbarIconSize

privateinherited

Definition at line 607 of file eda_draw_frame.h.

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

◆ m_mainToolBar

ACTION_TOOLBAR* EDA_DRAW_FRAME::m_mainToolBar

protectedinherited

Definition at line 575 of file eda_draw_frame.h.

Referenced by PCB_EDIT_FRAME::AddActionPluginTools(), EDA_DRAW_FRAME::addApiPluginTools(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_DRAW_FRAME::OnToolbarSizeChanged(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), SYMBOL_EDIT_FRAME::ReCreateHToolbar(), SYMBOL_VIEWER_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateLayerBox(), EDA_DRAW_FRAME::RecreateToolbars(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), DISPLAY_FOOTPRINTS_FRAME::UpdateToolbarControlSizes(), GERBVIEW_FRAME::UpdateToolbarControlSizes(), UpdateToolbarControlSizes(), FOOTPRINT_EDIT_FRAME::UpdateToolbarControlSizes(), PCB_EDIT_FRAME::UpdateToolbarControlSizes(), DISPLAY_FOOTPRINTS_FRAME::updateView(), and FOOTPRINT_VIEWER_FRAME::updateView().

◆ m_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault

protectedinherited

Definition at line 740 of file eda_base_frame.h.

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

◆ m_messagePanel

EDA_MSG_PANEL* EDA_DRAW_FRAME::m_messagePanel

protectedinherited

Definition at line 584 of file eda_draw_frame.h.

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

◆ m_modal

bool KIWAY_PLAYER::m_modal

protectedinherited

Definition at line 190 of file kiway_player.h.

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

◆ m_modal_loop

wxGUIEventLoop* KIWAY_PLAYER::m_modal_loop

protectedinherited

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

Definition at line 193 of file kiway_player.h.

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

◆ m_modal_resultant_parent

wxWindow* KIWAY_PLAYER::m_modal_resultant_parent

protectedinherited

Definition at line 194 of file kiway_player.h.

Referenced by KIWAY_PLAYER::ShowModal().

◆ m_modal_ret_val

bool KIWAY_PLAYER::m_modal_ret_val

protectedinherited

Definition at line 196 of file kiway_player.h.

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

◆ m_modal_string

wxString KIWAY_PLAYER::m_modal_string

protectedinherited

Definition at line 195 of file kiway_player.h.

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

◆ m_moveWarpsCursor

bool TOOLS_HOLDER::m_moveWarpsCursor

protectedinherited

Definition at line 186 of file tools_holder.h.

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

◆ m_mruImagePath

wxString PL_EDITOR_FRAME::m_mruImagePath

private

Definition at line 288 of file pl_editor_frame.h.

Referenced by AddDrawingSheetItem().

◆ m_mruPath

wxString EDA_BASE_FRAME::m_mruPath

protectedinherited

Definition at line 769 of file eda_base_frame.h.

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

◆ m_msgFrameHeight

int EDA_DRAW_FRAME::m_msgFrameHeight

protectedinherited

Definition at line 585 of file eda_draw_frame.h.

◆ m_netInspectorPanel

NET_INSPECTOR_PANEL* EDA_DRAW_FRAME::m_netInspectorPanel

protectedinherited

Definition at line 590 of file eda_draw_frame.h.

Referenced by PCB_EDIT_FRAME::onBoardLoaded(), PCB_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::ShowChangedLanguage(), PCB_EDIT_FRAME::ShowChangedLanguage(), PCB_EDIT_FRAME::ToggleNetInspector(), PCB_EDIT_FRAME::UpdateUserInterface(), and PCB_EDIT_FRAME::~PCB_EDIT_FRAME().

◆ m_normalFramePos

wxPoint EDA_BASE_FRAME::m_normalFramePos

protectedinherited

Definition at line 744 of file eda_base_frame.h.

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

◆ m_normalFrameSize

wxSize EDA_BASE_FRAME::m_normalFrameSize

protectedinherited

Definition at line 745 of file eda_base_frame.h.

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

◆ m_openGLFailureOccured

bool EDA_DRAW_FRAME::m_openGLFailureOccured = false

staticprotectedinherited

Has any failure occured when switching to OpenGL in any EDA_DRAW_FRAME?

Definition at line 597 of file eda_draw_frame.h.

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

◆ m_optionsToolBar

ACTION_TOOLBAR* EDA_DRAW_FRAME::m_optionsToolBar

protectedinherited

Definition at line 578 of file eda_draw_frame.h.

Referenced by GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_DRAW_FRAME::OnToolbarSizeChanged(), DISPLAY_FOOTPRINTS_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_FRAME::ReCreateOptToolbar(), GERBVIEW_FRAME::ReCreateOptToolbar(), ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), and EDA_DRAW_FRAME::RecreateToolbars().

◆ m_originSelectBox

wxChoice* PL_EDITOR_FRAME::m_originSelectBox

private

Definition at line 284 of file pl_editor_frame.h.

Referenced by OnSelectCoordOriginCorner(), ReCreateHToolbar(), and UpdateStatusBar().

◆ m_originSelectChoice

int PL_EDITOR_FRAME::m_originSelectChoice

private

Definition at line 285 of file pl_editor_frame.h.

Referenced by LoadSettings(), OnSelectCoordOriginCorner(), ReCreateHToolbar(), ReturnCoordOriginCorner(), SaveSettings(), and UpdateStatusBar().

◆ m_originTransforms

ORIGIN_TRANSFORMS EDA_BASE_FRAME::m_originTransforms

protectedinherited

Definition at line 771 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::GetOriginTransforms().

◆ m_pageLayout

PL_EDITOR_LAYOUT PL_EDITOR_FRAME::m_pageLayout

private

Definition at line 280 of file pl_editor_frame.h.

Referenced by GetPageLayout(), GetPageSettings(), GetPageSizeIU(), SetPageSettings(), and SetTitleBlock().

◆ m_pageSelectBox

wxChoice* PL_EDITOR_FRAME::m_pageSelectBox

private

Definition at line 286 of file pl_editor_frame.h.

Referenced by GetPageNumberOption(), OnSelectPage(), and ReCreateHToolbar().

◆ m_perspective

wxString EDA_BASE_FRAME::m_perspective

protectedinherited

Definition at line 750 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::LoadWindowSettings().

◆ m_polarCoords

bool EDA_DRAW_FRAME::m_polarCoords

protectedinherited

Definition at line 568 of file eda_draw_frame.h.

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

◆ m_propertiesFrameWidth

int PL_EDITOR_FRAME::m_propertiesFrameWidth

private

Definition at line 282 of file pl_editor_frame.h.

Referenced by LoadSettings(), and SaveSettings().

◆ m_propertiesPagelayout

PROPERTIES_FRAME* PL_EDITOR_FRAME::m_propertiesPagelayout

protected

The last filename chosen to be proposed to the user.

Definition at line 277 of file pl_editor_frame.h.

Referenced by doCloseWindow(), GetPropertiesFrame(), HardRedraw(), OnNewDrawingSheet(), and SaveSettings().

◆ m_propertiesPanel

PROPERTIES_PANEL* EDA_DRAW_FRAME::m_propertiesPanel

protectedinherited

Definition at line 589 of file eda_draw_frame.h.

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

◆ m_redoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_redoList

protectedinherited

Definition at line 767 of file eda_base_frame.h.

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

◆ m_replaceStringHistoryList

wxArrayString EDA_DRAW_FRAME::m_replaceStringHistoryList

protectedinherited

Definition at line 582 of file eda_draw_frame.h.

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

◆ m_searchPane

SEARCH_PANE* EDA_DRAW_FRAME::m_searchPane

protectedinherited

Definition at line 588 of file eda_draw_frame.h.

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

◆ m_settingsManager

SETTINGS_MANAGER* EDA_BASE_FRAME::m_settingsManager

protectedinherited

Definition at line 756 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::GetSettingsManager().

◆ m_showBorderAndTitleBlock

bool EDA_DRAW_FRAME::m_showBorderAndTitleBlock

protectedinherited

Definition at line 570 of file eda_draw_frame.h.

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

◆ m_sockets

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

protectedinherited

interprocess communication

Definition at line 199 of file kiway_player.h.

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

◆ m_socketServer

wxSocketServer* EDA_DRAW_FRAME::m_socketServer

protectedinherited

Prevents opening same file multiple times.

Definition at line 558 of file eda_draw_frame.h.

◆ m_spaceMouse

std::unique_ptr<NL_PL_EDITOR_PLUGIN> PL_EDITOR_FRAME::m_spaceMouse

private

Definition at line 292 of file pl_editor_frame.h.

Referenced by handleActivateEvent(), and handleIconizeEvent().

◆ m_supportsAutoSave

bool EDA_BASE_FRAME::m_supportsAutoSave

protectedinherited

Definition at line 759 of file eda_base_frame.h.

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

◆ m_toolDispatcher

◆ m_toolManager

TOOL_MANAGER* TOOLS_HOLDER::m_toolManager

protectedinherited

Definition at line 167 of file tools_holder.h.

◆ m_toolStack

std::vector<std::string> TOOLS_HOLDER::m_toolStack

protectedinherited

Definition at line 173 of file tools_holder.h.

Referenced by TOOLS_HOLDER::CurrentToolName(), TOOLS_HOLDER::IsCurrentTool(), TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), and TOOLS_HOLDER::ToolStackIsEmpty().

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type

privateinherited

Definition at line 87 of file kiway_holder.h.

◆ m_uiUpdateMap

std::map<int, UIUpdateHandler> EDA_BASE_FRAME::m_uiUpdateMap

protectedinherited

< Map containing the UI update handlers registered with wx for each action.

Set by the close window event handler after frames are asked if they can close. Allows other functions when called to know our state is cleanup.

Definition at line 774 of file eda_base_frame.h.

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

◆ m_undoList

UNDO_REDO_CONTAINER EDA_BASE_FRAME::m_undoList

protectedinherited

Definition at line 766 of file eda_base_frame.h.

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

◆ m_undoRedoCountMax

int EDA_DRAW_FRAME::m_undoRedoCountMax

protectedinherited

Definition at line 566 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::LoadSettings().

◆ m_userUnits

EDA_UNITS UNITS_PROVIDER::m_userUnits

privateinherited

Definition at line 201 of file units_provider.h.

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

◆ m_zoomSelectBox

wxChoice* EDA_DRAW_FRAME::m_zoomSelectBox

protectedinherited

Definition at line 573 of file eda_draw_frame.h.

Referenced by EDA_DRAW_FRAME::OnSelectZoom(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), GERBVIEW_FRAME::ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), and EDA_DRAW_FRAME::UpdateZoomSelectBox().

◆ NullUiString

const wxString UNITS_PROVIDER::NullUiString = ""

inlinestaticinherited

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

Definition at line 197 of file units_provider.h.

Referenced by WX_GRID::GetOptionalUnitValue(), WX_GRID::onCellEditorHidden(), UNITS_PROVIDER::OptionalValueFromString(), and UNITS_PROVIDER::StringFromOptionalValue().

The documentation for this class was generated from the following files:

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ HOLDER_TYPE

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ PL_EDITOR_FRAME()

◆ ~PL_EDITOR_FRAME()

Member Function Documentation

◆ ActivateGalCanvas()

◆ addApiPluginTools()

◆ AddDrawingSheetItem()

◆ AddMenuLanguageList()

◆ AddStandardHelpMenu()

◆ AddStandardSubMenus()

◆ AngleValueFromString()

◆ AppendMsgPanel()

◆ CanAcceptApiCommands()

◆ canCloseWindow()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ ClearFileHistory()

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ commonInit()

◆ CommonSettingsChanged()

◆ config()

◆ ConfigBaseName()

◆ CreateHotkeyPopup()

◆ CreateInfoBar()

◆ CreateServer()

◆ CurrentToolName()

◆ DECLARE_EVENT_TABLE()

◆ DeleteAutoSaveFile()

◆ DesignBlocksPaneName()

◆ Destroy()

◆ DismissModal()

◆ DisplayConstraintsMsg()

◆ DisplayGridMsg()

◆ DisplayToolMsg()

◆ DisplayUnitsMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ doReCreateMenuBar()

◆ DoWithAcceptedFiles()

◆ ensureWindowIsOnScreen()

◆ EraseMsgBox()

◆ ExecuteRemoteCommand()

◆ Files_io()

◆ findDialogs()

◆ findQuasiModalDialog()

◆ FinishAUIInitialization()

◆ FocusLibraryTreeInput()

◆ FocusOnLocation()

◆ GetAboutTitle()

◆ GetAutoSaveInterval()

◆ GetCanvas()

◆ GetColorSettings()

◆ GetCurrentFileName()

◆ GetCurrentSelection()

◆ GetDocumentExtents()

◆ GetDoImmediateActions()

◆ GetDragAction()

◆ GetDrawBgColor()

◆ GetFileFromHistory()

◆ GetFileHistory()

◆ GetFindHistoryList()

◆ GetFindReplaceData()

◆ GetFrameType()

◆ GetFullScreenDesc()

◆ GetGalDisplayOptions()