PL_EDITOR_FRAME Class Reference

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. More...
bool	OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl) override
	Open a project or set of files given by aFileList. More...
bool	LoadDrawingSheetFile (const wxString &aFullFileName)
	Load a .kicad_wks drawing sheet file. More...
bool	SaveDrawingSheetFile (const wxString &aFullFileName)
	Save the current layout in a .kicad_wks drawing sheet file. More...
bool	InsertDrawingSheetFile (const wxString &aFullFileName)
	Load a .kicad_wks drawing sheet file, and add items to the current layout list. More...
bool	IsContentModified () const override
	Get if the drawing sheet has been modified but not saved. More...
void	OnExit (wxCommandEvent &aEvent)
	Event handler for the wxID_EXIT and wxID_CLOSE events. More...
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. More...
void	SetPageSettings (const PAGE_INFO &) override
const PAGE_INFO &	GetPageSettings () const override
const wxSize	GetPageSizeIU () const override
	Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view. More...
PL_DRAW_PANEL_GAL *	GetCanvas () const override
	Return a pointer to GAL-based canvas of given EDA draw frame. More...
SELECTION &	GetCurrentSelection () override
	Get the current selection from the canvas area. More...
const wxPoint &	GetGridOrigin () const override
	Return the absolute coordinates of the origin of the snap grid. More...
void	SetGridOrigin (const wxPoint &aPoint) override
wxPoint	ReturnCoordOriginCorner () const
	Calculate the position (in page, in iu) of the corner used as coordinate origin of items. More...
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. More...
void	DisplayGridMsg () override
	Display current grid size in the status bar. More...
void	UpdateStatusBar () override
	Update the status bar information. More...
void	OnNewDrawingSheet ()
	Must be called to initialize parameters when a new drawing sheet is loaded. More...
void	ReCreateVToolbar () override
	Create or update the right vertical toolbar. More...
void	ReCreateOptToolbar () override
	Create or update the left vertical toolbar. More...
void	ReCreateMenuBar () override
	Recreates the menu bar. More...
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. More...
bool	GetPageNumberOption () const
	Drawing sheet editor can show the title block using a page number 1 or another number. More...
void	UpdateTitleAndInfo ()
	Display the short filename (if exists) loaded file on the caption of the main window. More...
void	InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
	Allow a frame to load its preference panels (if any) into the preferences dialog. More...
void	LoadSettings (APP_SETTINGS_BASE *aCfg) override
	Load common frame parameters from a configuration file. More...
void	SaveSettings (APP_SETTINGS_BASE *aCfg) override
	Save common frame parameters to a configuration data file. More...
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). More...
void	OnSelectTitleBlockDisplayMode (wxCommandEvent &event)
	Toggle the display mode between the normal mode and the editor mode: In normal mode, title block texts are shown like they will be shown in other kicad applications: the format symbols in texts are replaced by the actual text. More...
void	ToPrinter (bool doPreview)
	Open a dialog frame to print layers. More...
void	Files_io (wxCommandEvent &event)
virtual void	PrintPage (const RENDER_SETTINGS *aSettings) override
	Print a page. More...
void	OnFileHistory (wxCommandEvent &event)
void	OnClearFileHistory (wxCommandEvent &aEvent)
wxString	GetCurrentFileName () const override
void	SetCurrentFileName (const wxString &aName)
	Store the current layout description file filename. More...
void	HardRedraw () override
	Refresh the library tree and redraw the window. More...
DS_DATA_ITEM *	AddDrawingSheetItem (int aType)
	Add a new item to the drawing sheet item list. More...
void	OnModify ()
	Must be called after a change in order to set the "modify" flag. More...
void	SaveCopyInUndoList ()
	Save a copy of the description (in a S expr string) for Undo/redo commands. More...
void	GetLayoutFromRedoList ()
	Redo the last edit: More...
void	GetLayoutFromUndoList ()
	Undo the last edit: More...
void	RollbackFromUndo ()
	Apply the last command in Undo List without stacking a Redo. More...
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. More...
bool	LockFile (const wxString &aFileName)
	Mark a schematic file as being in use. More...
void	ReleaseFile ()
	Release the current file marked in use. More...
void	ScriptingConsoleEnableDisable ()
	Toggles the scripting console visibility. More...
wxFindReplaceData &	GetFindReplaceData ()
wxArrayString &	GetFindHistoryList ()
bool	GetShowPolarCoords () const
	For those frames that support polar coordinates. More...
void	SetShowPolarCoords (bool aShow)
void	ToggleUserUnits () override
void	GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
	Get the pair or units in current use. More...
wxPoint	GetNearestGridPosition (const wxPoint &aPosition) const
	Return the nearest aGridSize location to aPosition. More...
wxPoint	GetNearestHalfGridPosition (const wxPoint &aPosition) const
	Return the nearest aGridSize / 2 location to aPosition. More...
virtual ORIGIN_TRANSFORMS &	GetOriginTransforms ()
	Return a reference to the default ORIGIN_TRANSFORMS object. More...
virtual COLOR4D	GetDrawBgColor () const
virtual void	SetDrawBgColor (COLOR4D aColor)
virtual COLOR_SETTINGS *	GetColorSettings () const
	Returns a pointer to the active color theme settings. More...
bool	ShowPageLimits () const
void	SetShowPageLimits (bool aShow)
bool	LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
virtual wxString	GetScreenDesc () const
virtual BASE_SCREEN *	GetScreen () const
	Return a pointer to a BASE_SCREEN or one of its derivatives. More...
void	EraseMsgBox ()
virtual void	ReCreateAuxiliaryToolbar ()
bool	IsGridVisible () const
virtual void	SetGridVisibility (bool aVisible)
virtual COLOR4D	GetGridColor ()
virtual void	SetGridColor (COLOR4D aColor)
void	OnSelectGrid (wxCommandEvent &event)
	Command event handler for selecting grid sizes. More...
void	OnGridSettings (wxCommandEvent &event)
void	UpdateGridSelectBox ()
	Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.). More...
void	OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
	Update the checked item in the grid combobox. More...
void	UpdateZoomSelectBox ()
	Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
void	OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
	Update the checked item in the zoom combobox. More...
const wxString	GetZoomLevelIndicator () const
	Return a human readable value for display in dialogs. More...
virtual void	OnSelectZoom (wxCommandEvent &event)
	Set the zoom factor when selected by the zoom list box in the main tool bar. More...
virtual void	OnSize (wxSizeEvent &event) override
	Recalculate the size of toolbars and display panel when the frame size changes. More...
void	OnMove (wxMoveEvent &aEvent) override
virtual void	Zoom_Automatique (bool aWarpPointer)
	Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...
void	FocusOnLocation (const wxPoint &aPos)
	Useful to focus on a particular location, in find functions. More...
void	AddStandardSubMenus (TOOL_MENU &aMenu)
	Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g. More...
void	PrintDrawingSheet (const RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
	Prints the drawing-sheet (frame and title block). More...
void	DisplayToolMsg (const wxString &msg) override
virtual void	OnPageSettingsChange ()
	Called when modifying the page settings. More...
void	DisplayUnitsMsg ()
	Display current unit pane in the status bar. More...
void	AppendMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
	Append a message to the message panel. More...
virtual void	ClearMsgPanel ()
	Clear all messages from the message panel. More...
void	SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
	Clear the message panel and populates it with the contents of aList. More...
void	SetMsgPanel (EDA_ITEM *aItem)
void	SetMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
	Helper function that erases the msg panel and then appends a single message. More...
virtual void	UpdateMsgPanel ()
	Redraw the message panel. More...
virtual EDA_ITEM *	GetItem (const KIID &aId) const
	Fetch an item by KIID. More...
virtual void	ActivateGalCanvas ()
	Use to start up the GAL drawing canvas. More...
virtual void	SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
	Changes the current rendering backend. More...
void	SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)
wxWindow *	GetToolCanvas () const override
	Canvas access. More...
KIGFX::GAL_DISPLAY_OPTIONS &	GetGalDisplayOptions ()
	Return a reference to the gal rendering options used by GAL for rendering. More...
void	RefreshCanvas () override
void	RecreateToolbars ()
	Rebuild all toolbars, and update the checked state of check tools. More...
virtual void	ParseArgs (wxCmdLineParser &aParser)
	Handle command-line arguments in a frame-specific way. More...
virtual bool	ShowModal (wxString *aResult=nullptr, wxWindow *aResultantFocusWindow=nullptr)
	Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...
virtual void	KiwayMailIn (KIWAY_EXPRESS &aEvent)
	Receive KIWAY_EXPRESS messages from other players. More...
bool	Destroy () override
	Our version of Destroy() which is virtual from wxWidgets. More...
bool	IsModal () const override
	Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame. More...
void	SetModal (bool aIsModal)
bool	IsDismissed ()
void	DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
void	CreateServer (int service, bool local=true)
void	OnSockRequest (wxSocketEvent &evt)
void	OnSockRequestServer (wxSocketEvent &evt)
virtual void	ExecuteRemoteCommand (const char *cmdline)
	Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242). More...
EDA_UNITS	GetUserUnits () const
	Return the user units currently in use. More...
void	SetUserUnits (EDA_UNITS aUnits)
void	ChangeUserUnits (EDA_UNITS aUnits)
SETTINGS_MANAGER *	GetSettingsManager () const
virtual SEVERITY	GetSeverity (int aErrorCode) const
bool	ProcessEvent (wxEvent &aEvent) override
	Override the default process event handler to implement the auto save feature. More...
virtual void	OnCharHook (wxKeyEvent &aKeyEvent)
	Capture the key event before it is sent to the GUI. More...
void	OnMenuEvent (wxMenuEvent &event)
	The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
virtual void	RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
	Register a UI update handler for the control with ID aID. More...
virtual void	RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
	Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...
virtual void	UnregisterUIUpdateHandler (int aID) override
	Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
virtual void	UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
	Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
void	OnMaximize (wxMaximizeEvent &aEvent)
void	SetAutoSaveInterval (int aInterval)
int	GetAutoSaveInterval () const
bool	IsType (FRAME_T aType) const
FRAME_T	GetFrameType () const
virtual const SEARCH_STACK &	sys_search ()
	Return a SEARCH_STACK pertaining to entire program. More...
virtual wxString	help_name ()
void	OnKicadAbout (wxCommandEvent &event)
void	OnPreferences (wxCommandEvent &event)
	Displays the preferences and settings of all opened editors paged dialog. More...
void	PrintMsg (const wxString &text)
void	CreateInfoBar ()
void	FinishAUIInitialization ()
WX_INFOBAR *	GetInfoBar ()
void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
void	ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...
void	ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...
virtual APP_SETTINGS_BASE *	config () const
	Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
void	LoadWindowState (const wxString &aFileName)
virtual void	LoadWindowState (const WINDOW_STATE &aState)
	Load frame state info from a configuration file. More...
void	LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
	Load window settings from the given settings object. More...
void	SaveWindowSettings (WINDOW_SETTINGS *aCfg)
	Save window settings to the given settings object. More...
virtual WINDOW_SETTINGS *	GetWindowSettings (APP_SETTINGS_BASE *aCfg)
	Return a pointer to the window settings for this frame. More...
wxString	ConfigBaseName () override
	Get the configuration base name. More...
virtual void	SaveProjectSettings ()
	Save changes to the project settings to the project (.pro) file. More...
void	ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
	Prompt the user for a hotkey file to read, and read it. More...
wxString	GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
	Fetches the file name from the file history list. More...
void	ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
	Removes all files from the file history. More...
void	UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
	Update the list of recently opened files. More...
FILE_HISTORY &	GetFileHistory ()
	Get the frame's main file history. More...
void	SetMruPath (const wxString &aPath)
wxString	GetMruPath () const
void	AddStandardHelpMenu (wxMenuBar *aMenuBar)
	Adds the standard KiCad help menu to the menubar. More...
bool	IsWritable (const wxFileName &aFileName)
	Checks if aFileName can be written. More...
void	CheckForAutoSaveFile (const wxFileName &aFileName)
	Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
virtual void	ShowChangedLanguage ()
	Redraw the menus and what not in current language. More...
virtual void	ThemeChanged ()
	Process light/dark theme change. More...
virtual void	ProjectChanged ()
	Notification event that the project has changed. More...
const wxString &	GetAboutTitle () const
wxSize	GetWindowSize ()
	Get the undecorated window size that can be used for restoring the window size. More...
virtual void	ClearUndoRedoList ()
	Clear the undo and redo list using ClearUndoORRedoList() More...
virtual void	PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
	Add a command to undo in the undo list. More...
virtual void	PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
	Add a command to redo in the redo list. More...
virtual PICKED_ITEMS_LIST *	PopCommandFromUndoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...
virtual PICKED_ITEMS_LIST *	PopCommandFromRedoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...
virtual int	GetUndoCommandCount () const
virtual int	GetRedoCommandCount () const
int	GetMaxUndoItems () const
bool	NonUserClose (bool aForce)
virtual void	HandleSystemColorChange ()
	Update the UI in response to a change in the system colors. More...
TOOL_MANAGER *	GetToolManager () const
	Return the MVC controller. More...
virtual void	PushTool (const std::string &actionName)
	NB: the definition of "tool" is different at the user level. More...
virtual void	PopTool (const std::string &actionName)
bool	ToolStackIsEmpty ()
std::string	CurrentToolName () const
bool	IsCurrentTool (const TOOL_ACTION &aAction) const
bool	GetDoImmediateActions () const
	Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...
MOUSE_DRAG_ACTION	GetDragAction () const
	Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...
bool	GetMoveWarpsCursor () const
	Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...
HOLDER_TYPE	GetType () const
KIWAY &	Kiway () const
	Return a reference to the KIWAY that this object has an opportunity to participate in. More...
PROJECT &	Prj () const
	Return a reference to the PROJECT associated with this KIWAY. More...
void	SetKiway (wxWindow *aDest, KIWAY *aKiway)
	It is only used for debugging, since "this" is not a wxWindow*. More...

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

Protected Member Functions
bool	saveCurrentPageLayout ()
void	setupUIConditions () override
	Setup the UI conditions for the various actions and their controls in this frame. More...
	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. More...
void	setupUnits (APP_SETTINGS_BASE *aCfg)
void	resolveCanvasType ()
	Determines the Canvas type to load (with prompt if required) and initializes m_canvasType. More...
EDA_DRAW_PANEL_GAL::GAL_TYPE	loadCanvasTypeSetting ()
	Returns the canvas type stored in the application settings. More...
bool	saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
	Stores the canvas type in the application settings. More...
virtual void	handleActivateEvent (wxActivateEvent &aEvent)
	Handle a window activation event. More...
void	onActivate (wxActivateEvent &aEvent)
void	kiway_express (KIWAY_EXPRESS &aEvent)
	event handler, routes to derivative specific virtual KiwayMailIn() More...
void	language_change (wxCommandEvent &event)
	An event handler called on a language menu selection. More...
void	onAutoSaveTimer (wxTimerEvent &aEvent)
	Handle the auto save timer event. More...
virtual bool	isAutoSaveRequired () const
	Return the auto save status of the application. More...
virtual bool	doAutoSave ()
	This should be overridden by the derived class to handle the auto save feature. More...
void	onSystemColorChange (wxSysColourChangedEvent &aEvent)
void	initExitKey ()
	Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
void	ensureWindowIsOnScreen ()

Static Protected Member Functions
static wxString	GetAutoSaveFilePrefix ()

Protected Attributes
PROPERTIES_FRAME *	m_propertiesPagelayout
	The last filename chosen to be proposed to the user. More...
wxSocketServer *	m_socketServer
std::vector< wxSocketBase * >	m_sockets
	interprocess communication More...
std::unique_ptr< wxSingleInstanceChecker >	m_file_checker
bool	m_showPageLimits
COLOR4D	m_gridColor
COLOR4D	m_drawBgColor
int	m_undoRedoCountMax
bool	m_polarCoords
bool	m_showBorderAndTitleBlock
long	m_firstRunDialogSetting
wxChoice *	m_gridSelectBox
wxChoice *	m_zoomSelectBox
ACTION_TOOLBAR *	m_mainToolBar
ACTION_TOOLBAR *	m_auxiliaryToolBar
ACTION_TOOLBAR *	m_drawToolBar
ACTION_TOOLBAR *	m_optionsToolBar
wxFindReplaceData *	m_findReplaceData
wxArrayString	m_findStringHistoryList
wxArrayString	m_replaceStringHistoryList
EDA_MSG_PANEL *	m_messagePanel
int	m_msgFrameHeight
COLOR_SETTINGS *	m_colorSettings
	The current canvas type. More...
EDA_DRAW_PANEL_GAL::GAL_TYPE	m_canvasType
bool	m_modal
WX_EVENT_LOOP *	m_modal_loop
	< Points to nested event_loop. NULL means not modal and dismissed. More...
wxWindow *	m_modal_resultant_parent
wxString	m_modal_string
bool	m_modal_ret_val
FRAME_T	m_ident
wxPoint	m_framePos
wxSize	m_frameSize
bool	m_maximizeByDefault
int	m_displayIndex
wxPoint	m_normalFramePos
wxSize	m_normalFrameSize
wxString	m_aboutTitle
wxAuiManager	m_auimgr
wxString	m_perspective
WX_INFOBAR *	m_infoBar
wxString	m_configName
SETTINGS_MANAGER *	m_settingsManager
FILE_HISTORY *	m_fileHistory
bool	m_hasAutoSave
bool	m_autoSaveState
int	m_autoSaveInterval
wxTimer *	m_autoSaveTimer
UNDO_REDO_CONTAINER	m_undoList
UNDO_REDO_CONTAINER	m_redoList
wxString	m_mruPath
EDA_UNITS	m_userUnits
	Map containing the UI update handlers registered with wx for each action. More...
std::map< int, UIUpdateHandler >	m_uiUpdateMap
	Set by the close window event handler after frames are asked if they can close. More...
bool	m_isClosing
	Set by NonUserClose() to indicate that the user did not request the current close. More...
bool	m_isNonUserClose
TOOL_MANAGER *	m_toolManager
ACTIONS *	m_actions
TOOL_DISPATCHER *	m_toolDispatcher
SELECTION	m_dummySelection
std::vector< std::string >	m_toolStack
bool	m_immediateActions
MOUSE_DRAG_ACTION	m_dragAction
bool	m_moveWarpsCursor

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

Private Attributes
PL_EDITOR_LAYOUT	m_pageLayout
int	m_propertiesFrameWidth
wxChoice *	m_originSelectBox
int	m_originSelectChoice
wxChoice *	m_pageSelectBox
wxPoint	m_grid_origin

Detailed Description

The main window used in the drawing sheet editor.

Definition at line 45 of file pl_editor_frame.h.

Member Enumeration Documentation

HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

{ DIALOG, FRAME, PANEL };

UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

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

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 109 of file eda_base_frame.h.

    {
        UNDO_LIST,
        REDO_LIST
    };

Constructor & Destructor Documentation

PL_EDITOR_FRAME()

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

Definition at line 84 of file pl_editor_frame.cpp.

                                                                   :
        EDA_DRAW_FRAME( aKiway, aParent, FRAME_PL_EDITOR, wxT( "PlEditorFrame" ),
                        wxDefaultPosition, wxDefaultSize,
                        KICAD_DEFAULT_DRAWFRAME_STYLE, PL_EDITOR_FRAME_NAME ),
        m_propertiesPagelayout( nullptr ),
        m_propertiesFrameWidth( 200 ),
        m_originSelectBox( nullptr ),
        m_originSelectChoice( 0 ),
        m_pageSelectBox( nullptr )
{
    m_maximizeByDefault = true;
    m_userUnits = EDA_UNITS::MILLIMETRES;

    m_showBorderAndTitleBlock   = true; // true for reference drawings.
    DS_DATA_MODEL::GetTheInstance().m_EditMode = true;
    SetShowPageLimits( true );
    m_aboutTitle = _( "KiCad Drawing Sheet Editor" );

    // Give an icon
    wxIcon icon;
    wxIconBundle icon_bundle;

    icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pagelayout_editor ) );
    icon_bundle.AddIcon( icon );
    icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pagelayout_editor_32 ) );
    icon_bundle.AddIcon( icon );
    icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pagelayout_editor_16 ) );
    icon_bundle.AddIcon( icon );

    SetIcons( icon_bundle );

    // Create GAL canvas
    auto* drawPanel = new PL_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
                                             GetGalDisplayOptions(),
                                             EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE );
    SetCanvas( drawPanel );

    LoadSettings( config() );

    wxSize pageSizeIU = GetPageLayout().GetPageSettings().GetSizeIU();
    SetScreen( new BASE_SCREEN( pageSizeIU ) );

    setupTools();
    setupUIConditions();
    ReCreateMenuBar();
    ReCreateHToolbar();
    ReCreateVToolbar();
    ReCreateOptToolbar();

    wxWindow* stsbar = GetStatusBar();
    int dims[] = {

        // balance of status bar on far left is set to a default or whatever is left over.
        -1,

        // When using GetTextSize() remember the width of '1' is not the same
        // as the width of '0' unless the font is fixed width, and it usually won't be.

        // zoom:
        KIUI::GetTextSize( wxT( "Z 762000" ), stsbar ).x + 10,

        // cursor coords
        KIUI::GetTextSize( wxT( "X 0234.567  Y 0234.567" ), stsbar ).x + 10,

        // delta distances
        KIUI::GetTextSize( wxT( "dx 0234.567  dx 0234.567" ), stsbar ).x + 10,

        // grid size
        KIUI::GetTextSize( wxT( "grid 0234.567" ), stsbar ).x + 10,

        // Coord origin (use the bigger message)
        KIUI::GetTextSize( _( "coord origin: Right Bottom page corner" ), stsbar ).x + 10,

        // units display, Inches is bigger than mm
        KIUI::GetTextSize( _( "Inches" ), stsbar ).x + 20
    };

    SetStatusWidths( arrayDim( dims ), dims );

    m_auimgr.SetManagedWindow( this );

    CreateInfoBar();
    m_propertiesPagelayout = new PROPERTIES_FRAME( this );

    // Rows; layers 4 - 6
    m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" )
                      .Top().Layer( 6 ) );
    m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" )
                      .Left().Layer( 3 ) );
    m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" )
                      .Bottom().Layer( 6 ) );

    // Columns; layers 1 - 3
    m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" )
                      .Right().Layer( 2 ) );

    m_auimgr.AddPane( m_propertiesPagelayout, EDA_PANE().Palette().Name( "Props" )
                      .Right().Layer( 3 )
                      .Caption( _( "Properties" ) )
                      .MinSize( m_propertiesPagelayout->GetMinSize() )
                      .BestSize( m_propertiesFrameWidth, -1 ) );

    // Center
    m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" )
                      .Center() );

    FinishAUIInitialization();

    resolveCanvasType();
    SwitchCanvas( m_canvasType );

    // Add the exit key handler
    setupUnits( config() );

    wxPoint originCoord = ReturnCoordOriginCorner();
    SetGridOrigin( originCoord );

    // Initialize the current drawing sheet
#if 0       //start with empty layout
    DS_DATA_MODEL::GetTheInstance().AllowVoidList( true );
    DS_DATA_MODEL::GetTheInstance().ClearList();
#else       // start with the default KiCad layout
    DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet();
#endif
    OnNewDrawingSheet();

    // Ensure the window is on top
    Raise();

    // Register a call to update the toolbar sizes. It can't be done immediately because
    // it seems to require some sizes calculated that aren't yet (at least on GTK).
    CallAfter( [&]()
               {
                   // Ensure the controls on the toolbars all are correctly sized
                    UpdateToolbarControlSizes();
               } );
}

References _, DS_DATA_MODEL::AllowVoidList(), arrayDim(), PCAD2KICAD::Center, DS_DATA_MODEL::ClearList(), config, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, KIUI::GetTextSize(), DS_DATA_MODEL::GetTheInstance(), icon_pagelayout_editor, icon_pagelayout_editor_16, icon_pagelayout_editor_32, KiBitmap(), PCAD2KICAD::Left, DS_DATA_MODEL::LoadDrawingSheet(), DS_DATA_MODEL::m_EditMode, MILLIMETRES, and PCAD2KICAD::Right.

~PL_EDITOR_FRAME()

PL_EDITOR_FRAME::~PL_EDITOR_FRAME

(

)

Definition at line 223 of file pl_editor_frame.cpp.

{
    // Ensure m_canvasType is up to date, to save it in config
    m_canvasType = GetCanvas()->GetBackend();

    // Shutdown all running tools
    if( m_toolManager )
        m_toolManager->ShutdownAllTools();
}

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 PCB_BASE_FRAME, GERBVIEW_FRAME, PCB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 696 of file eda_draw_frame.cpp.

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

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

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

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

{
    DS_DATA_ITEM * item = nullptr;

    switch( aType )
    {
    case DS_DATA_ITEM::DS_TEXT:
        item = new DS_DATA_ITEM_TEXT( wxT( "Text") );
        break;

    case DS_DATA_ITEM::DS_SEGMENT:
        item = new DS_DATA_ITEM( DS_DATA_ITEM::DS_SEGMENT );
        break;

    case DS_DATA_ITEM::DS_RECT:
        item = new DS_DATA_ITEM( DS_DATA_ITEM::DS_RECT );
        break;

    case DS_DATA_ITEM::DS_POLYPOLYGON:
        item = new DS_DATA_ITEM_POLYGONS();
        break;

    case DS_DATA_ITEM::DS_BITMAP:
    {
        wxFileDialog fileDlg( this, _( "Choose Image" ), wxEmptyString, wxEmptyString,
                              _( "Image Files" ) + wxS( " " ) + wxImage::GetImageExtWildcard(),
                              wxFD_OPEN );

        if( fileDlg.ShowModal() != wxID_OK )
            return nullptr;

        wxString fullFilename = fileDlg.GetPath();

        if( !wxFileExists( fullFilename ) )
        {
            wxMessageBox( _( "Couldn't load image from \"%s\"" ), fullFilename );
            break;
        }

        BITMAP_BASE* image = new BITMAP_BASE();

        if( !image->ReadImageFile( fullFilename ) )
        {
            wxMessageBox( _( "Couldn't load image from \"%s\"" ), fullFilename );
            delete image;
            break;
        }

        // Set the scale factor for pl_editor (it is set for Eeschema by default)
        image->SetPixelSizeIu( IU_PER_MILS * 1000.0 / image->GetPPI() );
        item = new DS_DATA_ITEM_BITMAP( image );
    }
    break;
    }

    if( item == nullptr )
        return nullptr;

    DS_DATA_MODEL::GetTheInstance().Append( item );
    item->SyncDrawItems( nullptr, GetCanvas()->GetView() );

    return item;
}

References _, DS_DATA_MODEL::Append(), 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, IU_PER_MILS, and DS_DATA_ITEM::SyncDrawItems().

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

AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar )

inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 438 of file eda_base_frame.cpp.

{
    COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
    ACTION_MENU*    helpMenu = new ACTION_MENU( false, commonControl );

    helpMenu->Add( ACTIONS::help );
    helpMenu->Add( ACTIONS::gettingStarted );
    helpMenu->Add( ACTIONS::listHotKeys );
    helpMenu->Add( ACTIONS::getInvolved );
    helpMenu->Add( ACTIONS::donate );
    helpMenu->Add( ACTIONS::reportBug );

    helpMenu->AppendSeparator();
    helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );

    aMenuBar->Append( helpMenu, _( "&Help" ) );
}

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

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

AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU &  aMenu )

inherited

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

zoom and grid).

Definition at line 488 of file eda_draw_frame.cpp.

{
    COMMON_TOOLS*     commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
    CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();

    aMenu.AddSeparator( 1000 );

    auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
    zoomMenu->SetTool( commonTools );
    aToolMenu.AddSubMenu( zoomMenu );

    auto gridMenu = std::make_shared<GRID_MENU>( this );
    gridMenu->SetTool( commonTools );
    aToolMenu.AddSubMenu( gridMenu );

    aMenu.AddMenu( zoomMenu.get(),   SELECTION_CONDITIONS::ShowAlways, 1000 );
    aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
}

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

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

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

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

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

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

canCloseWindow()

bool PL_EDITOR_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 362 of file pl_editor_frame.cpp.

{
    // Shutdown blocks must be determined and vetoed as early as possible
    if( KIPLATFORM::APP::SupportsShutdownBlockReason()
            && aEvent.GetId() == wxEVT_QUERY_END_SESSION
            && IsContentModified() )
    {
        return false;
    }

    if( IsContentModified() )
    {
        wxFileName filename = GetCurrentFileName();
        wxString   msg      = _( "Save changes to \"%s\" before closing?" );

        if( !HandleUnsavedChanges( this, wxString::Format( msg, filename.GetFullName() ),
                                   [&]() -> bool
                                   {
                                       return saveCurrentPageLayout();
                                   } ) )
        {
            return false;
        }
    }

    return true;
}

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

ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits )

inherited

Definition at line 1175 of file eda_base_frame.cpp.

{
    SetUserUnits( aUnits );
    unitsChangeRefresh();

    wxCommandEvent e( UNITS_CHANGED );
    ProcessEventLocally( e );
}

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

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

CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName &  aFileName )

inherited

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

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

Parameters

aFileName

A wxFileName object containing the file name to check.

Definition at line 1063 of file eda_base_frame.cpp.

{
    wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );

    wxFileName autoSaveFileName = aFileName;

    // Check for auto save file.
    autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );

    wxLogTrace( traceAutoSave,
                wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );

    if( !autoSaveFileName.FileExists() )
        return;

    wxString msg = wxString::Format( _(
            "Well this is potentially embarrassing!\n"
            "It appears that the last time you were editing the file\n"
            "\"%s\"\n"
            "it was not saved properly.  Do you wish to restore the last saved edits you made?" ),
            aFileName.GetFullName()
        );

    int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
                                 this );

    // Make a backup of the current file, delete the file, and rename the auto save file to
    // the file name.
    if( response == wxYES )
    {
        if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
        {
            wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
                          Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
        }
    }
    else
    {
        wxLogTrace( traceAutoSave,
                    wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );

        // Remove the auto save file when using the previous file as is.
        wxRemoveFile( autoSaveFileName.GetFullPath() );
    }
}

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

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

ClearFileHistory()

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

inherited

Removes all files from the file history.

Parameters

aFileHistory

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

Definition at line 950 of file eda_base_frame.cpp.

{
    if( !aFileHistory )
        aFileHistory = m_fileHistory;

    wxASSERT( aFileHistory );

    aFileHistory->ClearFileHistory();

    // Update the menubar to update the file history menu
    if( GetMenuBar() )
    {
        ReCreateMenuBar();
        GetMenuBar()->Refresh();
    }
}

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

Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), SCH_EDIT_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 649 of file eda_draw_frame.cpp.

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

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

Referenced by GERBVIEW_CONTROL::ClearAllLayers(), GERBVIEW_CONTROL::ClearLayer(), GERBER_FILE_IMAGE::DisplayImageInfo(), SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), DIALOG_GENDRILL::GenDrillAndMapFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), DIALOG_BOM::OnRunGenerator(), GERBVIEW_CONTROL::ReloadAllLayers(), NETLIST_DIALOG::TransferDataFromWindow(), EE_INSPECTION_TOOL::UpdateMessagePanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), 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 910 of file pl_editor_frame.cpp.

{
    if( aItemCount == 0 )
        return;

    UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
    unsigned             icnt = list.m_CommandsList.size();

    if( aItemCount > 0 )
        icnt = aItemCount;

    for( unsigned ii = 0; ii < icnt; ii++ )
    {
        if( list.m_CommandsList.size() == 0 )
            break;

        PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
        list.m_CommandsList.erase( list.m_CommandsList.begin() );

        curr_cmd->ClearListAndDeleteItems();
        delete curr_cmd;    // Delete command
    }
}

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

Referenced by SaveCopyInUndoList().

ClearUndoRedoList()

void EDA_BASE_FRAME::ClearUndoRedoList ( )

virtualinherited

Clear the undo and redo list using ClearUndoORRedoList()

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

Definition at line 1126 of file eda_base_frame.cpp.

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

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

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_EDIT_FRAME::emptyScreen(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), OnNewDrawingSheet(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and 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 609 of file pl_editor_frame.cpp.

{
    EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );

    SETTINGS_MANAGER&   settingsManager = Pgm().GetSettingsManager();
    PL_EDITOR_SETTINGS* cfg = settingsManager.GetAppSettings<PL_EDITOR_SETTINGS>();
    COLOR_SETTINGS*     colors = settingsManager.GetColorSettings( cfg->m_ColorTheme );

    GetCanvas()->GetView()->GetPainter()->GetSettings()->LoadColors( colors );

    GetCanvas()->GetView()->UpdateAllItems( KIGFX::COLOR );
    GetCanvas()->Refresh();

    RecreateToolbars();
    Layout();
    SendSizeEvent();
}

References KIGFX::COLOR, EDA_DRAW_FRAME::CommonSettingsChanged(), SETTINGS_MANAGER::GetAppSettings(), GetCanvas(), SETTINGS_MANAGER::GetColorSettings(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::GetView(), KIGFX::RENDER_SETTINGS::LoadColors(), APP_SETTINGS_BASE::m_ColorTheme, Pgm(), EDA_DRAW_FRAME::RecreateToolbars(), EDA_DRAW_PANEL_GAL::Refresh(), 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 791 of file eda_base_frame.cpp.

{
    // KICAD_MANAGER_FRAME overrides this
    return Kiface().KifaceSettings();
}

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), ZOOM_MENU::ZOOM_MENU(), and BM2CMP_FRAME::~BM2CMP_FRAME().

ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )

inlineoverridevirtualinherited

Get the configuration base name.

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

Returns

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

Reimplemented from TOOLS_HOLDER.

Definition at line 357 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 816 of file eda_base_frame.cpp.

{
#if defined( __WXOSX_MAC__ )
    m_infoBar = new WX_INFOBAR( GetToolCanvas() );
#else
    m_infoBar = new WX_INFOBAR( this, &m_auimgr );

    m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
#endif
}

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

CreateServer()

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

inherited

Definition at line 49 of file eda_dde.cpp.

{
    wxIPV4address addr;

    // Set the port number
    addr.Service( service );

    // Listen on localhost only if requested
    if( local )
        addr.Hostname( HOSTNAME );

    delete m_socketServer;
    m_socketServer = new wxSocketServer( addr );

    m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
    m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
    m_socketServer->Notify( true );
}

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

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

CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 100 of file tools_holder.cpp.

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

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

Referenced by TOOL_MANAGER::processEvent().

DECLARE_EVENT_TABLE()

PL_EDITOR_FRAME::DECLARE_EVENT_TABLE ( )

protected

Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

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

Definition at line 150 of file kiway_player.cpp.

{
    return EDA_BASE_FRAME::Destroy();
}

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

DismissModal()

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

inherited

Definition at line 161 of file kiway_player.cpp.

{
    m_modal_ret_val = aRetVal;
    m_modal_string  = aResult;

    if( m_modal_loop )
    {
        m_modal_loop->Exit();
        m_modal_loop = nullptr;      // this marks it as dismissed.
    }

    Show( false );
}

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

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

DisplayGridMsg()

void PL_EDITOR_FRAME::DisplayGridMsg ( )

overridevirtual

Display current grid size in the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 668 of file pl_editor_frame.cpp.

{
    wxString line;
    wxString gridformatter;

    switch( m_userUnits )
    {
    case EDA_UNITS::INCHES:      gridformatter = "grid %.3f"; break;
    case EDA_UNITS::MILLIMETRES: gridformatter = "grid %.4f"; break;
    default:                     gridformatter = "grid %f";   break;
    }

    double grid = To_User_Unit( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x );
    line.Printf( gridformatter, grid );

    SetStatusText( line, 4 );
}

References GetCanvas(), grid, INCHES, EDA_BASE_FRAME::m_userUnits, MILLIMETRES, and To_User_Unit().

Referenced by UpdateStatusBar().

DisplayToolMsg()

void EDA_DRAW_FRAME::DisplayToolMsg ( const wxString &  msg )

overridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 508 of file eda_draw_frame.cpp.

{
    SetStatusText( msg, 6 );
}

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

DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )

inherited

Display current unit pane in the status bar.

Definition at line 525 of file eda_draw_frame.cpp.

{
    wxString msg;

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

    SetStatusText( msg, 5 );
}

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

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

doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )

protectedvirtualinherited

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

Returns

true if the auto save was successful otherwise false.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 321 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

doCloseWindow()

void PL_EDITOR_FRAME::doCloseWindow ( )

overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 391 of file pl_editor_frame.cpp.

{
    // do not show the window because we do not want any paint event
    Show( false );

    // clean up the data before the view is destroyed
    DS_DATA_MODEL::GetTheInstance().ClearList();

    // On Linux, m_propertiesPagelayout must be destroyed
    // before deleting the main frame to avoid a crash when closing
    m_propertiesPagelayout->Destroy();
    Destroy();
}

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

ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 633 of file eda_base_frame.cpp.

{
    wxDisplay display( wxDisplay::GetFromWindow( this ) );
    wxRect    clientSize = display.GetClientArea();
    wxPoint   pos        = GetPosition();
    wxSize    size       = GetWindowSize();

    wxLogTrace( traceDisplayLocation,
                "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d", clientSize.x, clientSize.y,
                clientSize.width, clientSize.height );

    if( pos.y < clientSize.y )
    {
        wxLogTrace( traceDisplayLocation,
                    "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d", pos.y,
                    clientSize.y );
        pos.y = clientSize.y;
    }

    if( pos.x < clientSize.x )
    {
        wxLogTrace( traceDisplayLocation,
                    "ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d", pos.x,
                    clientSize.x );
        pos.x = clientSize.x;
    }

    if( pos.x + size.x - clientSize.x > clientSize.width )
    {
        int newWidth = clientSize.width - ( pos.x - clientSize.x );
        wxLogTrace( traceDisplayLocation,
                    "ensureWindowIsOnScreen: effective width %d above available %d, setting to %d",
                    pos.x + size.x, clientSize.width, newWidth );
        size.x = newWidth;
    }

    if( pos.y + size.y - clientSize.y > clientSize.height )
    {
        int newHeight = clientSize.height - ( pos.y - clientSize.y );
        wxLogTrace( traceDisplayLocation,
                    "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d",
                    pos.y + size.y, clientSize.height, newHeight );
        size.y = newHeight;
    }

    wxLogTrace( traceDisplayLocation, "Updating window position (%d, %d) with size (%d, %d)",
                pos.x, pos.y, size.x, size.y );

    SetSize( pos.x, pos.y, size.x, size.y );
}

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )

inherited

Definition at line 277 of file eda_draw_frame.cpp.

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

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

ExecuteRemoteCommand()

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

inlinevirtualinherited

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

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 196 of file kiway_player.h.

{}

Referenced by KIWAY_PLAYER::OnSockRequest().

Files_io()

void PL_EDITOR_FRAME::Files_io

(

wxCommandEvent &

event

)

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

{
    wxString       msg;
    int            id = event.GetId();
    wxString       filename = GetCurrentFileName();
    DS_DATA_MODEL& pglayout = DS_DATA_MODEL::GetTheInstance();

    if( filename.IsEmpty() && id == wxID_SAVE )
        id = wxID_SAVEAS;

    if( ( id == wxID_NEW || id == wxID_OPEN ) && IsContentModified() )
    {
        if( !HandleUnsavedChanges( this, _( "The current drawing sheet has been modified. "
                                            "Save changes?" ),
                                   [&]()->bool { return saveCurrentPageLayout(); } ) )
        {
            return;
        }
    }

    switch( id )
    {
    case wxID_NEW:
        pglayout.AllowVoidList( true );
        SetCurrentFileName( wxEmptyString );
        pglayout.ClearList();
        OnNewDrawingSheet();
        break;

    case ID_APPEND_DESCR_FILE:
    {
         wxFileDialog openFileDialog( this, _( "Append Existing Drawing Sheet" ),
                                      wxEmptyString, wxEmptyString,
                                      DrawingSheetFileWildcard(), wxFD_OPEN );

        if( openFileDialog.ShowModal() == wxID_CANCEL )
            return;

        filename = openFileDialog.GetPath();

        if( !InsertDrawingSheetFile( filename ) )
        {
            msg.Printf( _( "Unable to load %s file" ), filename );
            DisplayErrorMessage( this, msg );
        }
        else
        {
            GetScreen()->SetContentModified();
            HardRedraw();
            msg.Printf( _( "File \"%s\" inserted" ), filename );
            SetStatusText( msg );
        }
    }
        break;

    case wxID_OPEN:
    {
         wxFileDialog openFileDialog( this, _( "Open" ), wxEmptyString, wxEmptyString,
                                      DrawingSheetFileWildcard(), wxFD_OPEN );

        if( openFileDialog.ShowModal() == wxID_CANCEL )
            return;

        filename = openFileDialog.GetPath();

        if( !LoadDrawingSheetFile( filename ) )
        {
            msg.Printf( _( "Unable to load %s file" ), filename );
            DisplayErrorMessage( this, msg );
        }
        else
        {
            OnNewDrawingSheet();
            msg.Printf( _( "File \"%s\" saved." ), filename );
            SetStatusText( msg );
        }
    }
        break;

    case wxID_SAVE:
        if( !SaveDrawingSheetFile( filename ) )
        {
            msg.Printf( _( "Unable to write \"%s\"" ), filename );
            DisplayErrorMessage( this, msg );
        }
        else
        {
            msg.Printf( _("File \"%s\" saved."), filename );
            SetStatusText( msg );
        }
        break;

    case wxID_SAVEAS:
    {
        wxString dir = PATHS::GetUserTemplatesPath();
        wxFileDialog openFileDialog( this, _( "Save As" ), dir, wxEmptyString,
                                     DrawingSheetFileWildcard(),
                                     wxFD_SAVE | wxFD_OVERWRITE_PROMPT );

        if( openFileDialog.ShowModal() == wxID_CANCEL )
            return;

        filename = openFileDialog.GetPath();
        // Ensure the file has the right extension:
        // because a name like name.subname.subsubname is legal,
        // add the right extension without replacing the wxFileName
        // extension
        wxFileName fn(filename);

        if( fn.GetExt() != DrawingSheetFileExtension )
            filename << wxT(".") << DrawingSheetFileExtension;

        if( !SaveDrawingSheetFile( filename ) )
        {
            msg.Printf( _( "Unable to create \"%s\"" ), filename );
            DisplayErrorMessage( this, msg );
        }

        else
        {
            msg.Printf( _("File \"%s\" saved."), filename );
            SetStatusText( msg );

            if( GetCurrentFileName().IsEmpty() )
                SetCurrentFileName( filename );
        }
    }
        break;

    default:
        break;
    }
}

References _, DS_DATA_MODEL::AllowVoidList(), DS_DATA_MODEL::ClearList(), DisplayErrorMessage(), DrawingSheetFileExtension, DrawingSheetFileWildcard(), GetCurrentFileName(), EDA_DRAW_FRAME::GetScreen(), DS_DATA_MODEL::GetTheInstance(), PATHS::GetUserTemplatesPath(), HandleUnsavedChanges(), HardRedraw(), ID_APPEND_DESCR_FILE, InsertDrawingSheetFile(), IsContentModified(), LoadDrawingSheetFile(), OnNewDrawingSheet(), saveCurrentPageLayout(), SaveDrawingSheetFile(), BASE_SCREEN::SetContentModified(), and SetCurrentFileName().

Referenced by PL_EDIT_TOOL::ImportDrawingSheetContent(), PL_EDITOR_CONTROL::New(), PL_EDITOR_CONTROL::Open(), PL_EDITOR_CONTROL::Save(), PL_EDITOR_CONTROL::SaveAs(), and saveCurrentPageLayout().

FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 828 of file eda_base_frame.cpp.

{
#if defined( __WXOSX_MAC__ )
    m_auimgr.Update();
#else
    // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
    // hiding it.
    m_auimgr.Update();

    // We don't want the infobar displayed right away
    m_auimgr.GetPane( "InfoBar" ).Hide();
    m_auimgr.Update();
#endif
}

References EDA_BASE_FRAME::m_auimgr.

FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const wxPoint &  aPos )

inherited

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

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

Parameters

aPos	is the point to go to.

Definition at line 843 of file eda_draw_frame.cpp.

{
    bool  centerView = false;
    BOX2D r = GetCanvas()->GetView()->GetViewport();

    // Center if we're off the current view, or within 10% of its edge
    r.Inflate( - (int) r.GetWidth() / 10 );

    if( !r.Contains( aPos ) )
        centerView = true;

    // Center if we're behind an obscuring dialog, or within 10% of its edge
    wxWindow* dialog = findDialog( GetChildren() );

    if( dialog )
    {
        wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
                           dialog->GetSize() );
        dialogRect.Inflate( dialogRect.GetWidth() / 10 );

        if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
            centerView = true;
    }

    if( centerView )
    {
        // If a dialog partly obscures the window, then center on the uncovered area.
        if( dialog )
        {
            BOX2D dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
                               dialog->GetSize() );
            GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
        }
        else
            GetCanvas()->GetView()->SetCenter( aPos );
    }

    GetCanvas()->GetViewControls()->SetCrossHairCursorPosition( aPos );
}

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

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

GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 512 of file eda_base_frame.h.

{ return m_aboutTitle; }

References EDA_BASE_FRAME::m_aboutTitle.

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

GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )

inlinestaticprotectedinherited

Returns

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

Definition at line 600 of file eda_base_frame.h.

    {
        return wxT( "_autosave-" );
    }

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

GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inlineinherited

Definition at line 204 of file eda_base_frame.h.

{ return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

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

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

References EDA_DRAW_FRAME::GetCanvas().

Referenced by AddDrawingSheetItem(), CommonSettingsChanged(), DisplayGridMsg(), PL_SELECTION_TOOL::doSelectionMenu(), 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(), PLEDITOR_PRINTOUT::PrintPage(), PrintPage(), RollbackFromUndo(), PL_SELECTION_TOOL::selectMultiple(), PL_POINT_EDITOR::setEditedPoint(), setupTools(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), UpdateStatusBar(), and ~PL_EDITOR_FRAME().

GetColorSettings()

COLOR_SETTINGS * EDA_DRAW_FRAME::GetColorSettings ( ) const

virtualinherited

Returns a pointer to the active color theme settings.

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

Definition at line 1016 of file eda_draw_frame.cpp.

{
    if( !m_colorSettings )
    {
        COLOR_SETTINGS* colorSettings = Pgm().GetSettingsManager().GetColorSettings();

        const_cast<EDA_DRAW_FRAME*>( this )->m_colorSettings = colorSettings;
    }

    return m_colorSettings;
}

References EDA_DRAW_FRAME::m_colorSettings, and Pgm().

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), GERBVIEW_CONTROL::Print(), and 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 561 of file pl_editor_frame.cpp.

{
    return BASE_SCREEN::m_DrawingSheetFileName;
}

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

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

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

{
    BOX2I rv( VECTOR2I( 0, 0 ), GetPageLayout().GetPageSettings().GetSizeIU() );
    return rv;
}

References GetPageLayout(), and GetPageSettings().

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

{ return m_immediateActions; }

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

{ return m_dragAction; }

References TOOLS_HOLDER::m_dragAction.

Referenced by PL_SELECTION_TOOL::Main(), EE_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 168 of file eda_draw_frame.h.

{ return m_drawBgColor; }

References EDA_DRAW_FRAME::m_drawBgColor.

Referenced by GERBVIEW_FRAME::GetNegativeItemsColor(), PLEDITOR_PRINTOUT::PrintPage(), 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 910 of file eda_base_frame.cpp.

{
    if( !aFileHistory )
        aFileHistory = m_fileHistory;

    wxASSERT( aFileHistory );

    int baseId = aFileHistory->GetBaseId();

    wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );

    unsigned i = cmdId - baseId;

    if( i < aFileHistory->GetCount() )
    {
        wxString fn = aFileHistory->GetHistoryFile( i );

        if( wxFileName::FileExists( fn ) )
            return fn;
        else
        {
            wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
            wxMessageBox( msg );

            aFileHistory->RemoveFileFromHistory( i );
        }
    }

    // Update the menubar to update the file history menu
    if( GetMenuBar() )
    {
        ReCreateMenuBar();
        GetMenuBar()->Refresh();
    }

    return wxEmptyString;
}

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

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

    {
        return *m_fileHistory;
    }

References EDA_BASE_FRAME::m_fileHistory.

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

GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )

inlineinherited

Definition at line 101 of file eda_draw_frame.h.

{ return m_findStringHistoryList; }

References EDA_DRAW_FRAME::m_findStringHistoryList.

Referenced by DIALOG_FIND::DIALOG_FIND(), and DIALOG_FIND::search().

GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )

inlineinherited

Definition at line 100 of file eda_draw_frame.h.

{ return *m_findReplaceData; }

References EDA_DRAW_FRAME::m_findReplaceData.

Referenced by DIALOG_FIND::search().

GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 207 of file eda_base_frame.h.

{ return m_ident; }

References EDA_BASE_FRAME::m_ident.

GetGalDisplayOptions()

KIGFX::GAL_DISPLAY_OPTIONS& EDA_DRAW_FRAME::GetGalDisplayOptions ( )

inlineinherited

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

Definition at line 425 of file eda_draw_frame.h.

{ return m_galDisplayOptions; }

References EDA_DRAW_FRAME::m_galDisplayOptions.

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

GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )

inlinevirtualinherited

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

Definition at line 222 of file eda_draw_frame.h.

{ return m_gridColor; }

References EDA_DRAW_FRAME::m_gridColor.

Referenced by PCB_CONTROL::Reset().

GetGridOrigin()

const wxPoint& 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 110 of file pl_editor_frame.h.

{ return m_grid_origin; }

References m_grid_origin.

GetInfoBar()

WX_INFOBAR* EDA_BASE_FRAME::GetInfoBar ( )

inlineinherited

Returns

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

Definition at line 234 of file eda_base_frame.h.

{ return m_infoBar; }

References EDA_BASE_FRAME::m_infoBar.

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

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

{ return nullptr; }

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

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.

{
    PL_SELECTION_TOOL*  selTool = GetToolManager()->GetTool<PL_SELECTION_TOOL>();

    if ( GetRedoCommandCount() <= 0 )
        return;

    ITEM_PICKER         redoWrapper = PopCommandFromRedoList()->PopItem();
    DS_PROXY_UNDO_ITEM* redoItem = static_cast<DS_PROXY_UNDO_ITEM*>( redoWrapper.GetItem() );
    bool                pageSettingsAndTitleBlock = redoItem->Type() == WS_PROXY_UNDO_ITEM_PLUS_T;

    PICKED_ITEMS_LIST*  undoCmd = new PICKED_ITEMS_LIST();
    DS_PROXY_UNDO_ITEM* undoItem = new DS_PROXY_UNDO_ITEM( pageSettingsAndTitleBlock ? this : nullptr );
    ITEM_PICKER         undoWrapper( GetScreen(), undoItem );

    undoCmd->PushItem( undoWrapper );
    PushCommandToUndoList( undoCmd );

    selTool->ClearSelection();
    redoItem->Restore( this, GetCanvas()->GetView() );
    selTool->RebuildSelection();

    delete redoItem;

    if( pageSettingsAndTitleBlock )
        HardRedraw();   // items based off of corners will need re-calculating
    else
        GetCanvas()->Refresh();

    OnModify();
}

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.

{
    PL_SELECTION_TOOL*  selTool = GetToolManager()->GetTool<PL_SELECTION_TOOL>();

    if ( GetUndoCommandCount() <= 0 )
        return;

    ITEM_PICKER         undoWrapper = PopCommandFromUndoList()->PopItem();
    DS_PROXY_UNDO_ITEM* undoItem = static_cast<DS_PROXY_UNDO_ITEM*>( undoWrapper.GetItem() );
    bool                pageSettingsAndTitleBlock = undoItem->Type() == WS_PROXY_UNDO_ITEM_PLUS_T;

    PICKED_ITEMS_LIST*  redoCmd = new PICKED_ITEMS_LIST();
    DS_PROXY_UNDO_ITEM* redoItem = new DS_PROXY_UNDO_ITEM( pageSettingsAndTitleBlock ? this : nullptr );
    ITEM_PICKER         redoWrapper( GetScreen(), redoItem );

    redoCmd->PushItem( redoWrapper );
    PushCommandToRedoList( redoCmd );

    selTool->ClearSelection();
    undoItem->Restore( this, GetCanvas()->GetView() );
    selTool->RebuildSelection();

    delete undoItem;

    if( pageSettingsAndTitleBlock )
        HardRedraw();   // items based off of corners will need re-calculating
    else
        GetCanvas()->Refresh();

    OnModify();
}

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

GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 580 of file eda_base_frame.h.

{ return m_undoRedoCountMax; }

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

{ return m_moveWarpsCursor; }

References TOOLS_HOLDER::m_moveWarpsCursor.

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

GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 429 of file eda_base_frame.h.

{ return m_mruPath; }

References EDA_BASE_FRAME::m_mruPath.

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

GetNearestGridPosition()

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

inherited

Return the nearest aGridSize location to aPosition.

Parameters

aPosition

The position to check.

Returns

The nearest grid position.

Definition at line 785 of file eda_draw_frame.cpp.

{
    const wxPoint& gridOrigin = GetGridOrigin();
    VECTOR2D       gridSize = GetCanvas()->GetGAL()->GetGridSize();

    double xOffset = fmod( gridOrigin.x, gridSize.x );
    int    x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
    double yOffset = fmod( gridOrigin.y, gridSize.y );
    int    y = KiROUND( (aPosition.y - yOffset) / gridSize.y );

    return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
}

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

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

GetNearestHalfGridPosition()

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

inherited

Return the nearest aGridSize / 2 location to aPosition.

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

Parameters

aPosition

The position to check.

Returns

The nearest half-grid position.

Definition at line 799 of file eda_draw_frame.cpp.

{
    const wxPoint& gridOrigin = GetGridOrigin();
    VECTOR2D       gridSize = GetCanvas()->GetGAL()->GetGridSize() / 2.0;

    double xOffset = fmod( gridOrigin.x, gridSize.x );
    int    x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
    double yOffset = fmod( gridOrigin.y, gridSize.y );
    int    y = KiROUND( (aPosition.y - yOffset) / gridSize.y );

    return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
}

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

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

GetOriginTransforms()

virtual ORIGIN_TRANSFORMS& EDA_DRAW_FRAME::GetOriginTransforms ( )

inlinevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented in PCB_BASE_FRAME.

Definition at line 159 of file eda_draw_frame.h.

    { return m_originTransforms; }

References EDA_DRAW_FRAME::m_originTransforms.

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

GetPageLayout() [1/2]

const PL_EDITOR_LAYOUT& PL_EDITOR_FRAME::GetPageLayout ( ) const

inline

Definition at line 147 of file pl_editor_frame.h.

{ return m_pageLayout; }

References m_pageLayout.

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

GetPageLayout() [2/2]

PL_EDITOR_LAYOUT& PL_EDITOR_FRAME::GetPageLayout ( )

inline

Definition at line 148 of file pl_editor_frame.h.

{ return m_pageLayout; }

References m_pageLayout.

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

{
    return m_pageSelectBox->GetSelection() == 0;
}

References m_pageSelectBox.

Referenced by PrintPage().

GetPageSettings()

const PAGE_INFO & PL_EDITOR_FRAME::GetPageSettings ( ) const

overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 582 of file pl_editor_frame.cpp.

{
    return m_pageLayout.GetPageSettings();
}

References PL_EDITOR_LAYOUT::GetPageSettings(), and m_pageLayout.

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

GetPageSizeIU()

const wxSize 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 588 of file pl_editor_frame.cpp.

{
    // this function is only needed because EDA_DRAW_FRAME is not compiled
    // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
    // into an application specific source file.
    return m_pageLayout.GetPageSettings().GetSizeIU();
}

References PL_EDITOR_LAYOUT::GetPageSettings(), and m_pageLayout.

Referenced by DIALOG_INSPECTOR::ReCreateDesignList().

GetPropertiesFrame()

PROPERTIES_FRAME* PL_EDITOR_FRAME::GetPropertiesFrame ( )

inline

Definition at line 51 of file pl_editor_frame.h.

{ return m_propertiesPagelayout; }

References m_propertiesPagelayout.

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

GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 578 of file eda_base_frame.h.

{ return m_redoList.m_CommandsList.size(); }

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

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

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

Definition at line 199 of file eda_draw_frame.h.

{ return m_currentScreen; }

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(), PLEDITOR_PRINTOUT::PrintPage(), 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 939 of file eda_draw_frame.cpp.

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

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

GetSettingsManager()

SETTINGS_MANAGER* EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

Definition at line 140 of file eda_base_frame.h.

{ return m_settingsManager; }

References EDA_BASE_FRAME::m_settingsManager.

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

GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int  aErrorCode ) const

inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME.

Definition at line 142 of file eda_base_frame.h.

{ return RPT_SEVERITY_UNDEFINED; }

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

{ return m_polarCoords; }

References EDA_DRAW_FRAME::m_polarCoords.

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

GetTitleBlock()

const TITLE_BLOCK & PL_EDITOR_FRAME::GetTitleBlock ( ) const

overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 597 of file pl_editor_frame.cpp.

{
    return GetPageLayout().GetTitleBlock();
}

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

GetToolCanvas()

wxWindow* EDA_DRAW_FRAME::GetToolCanvas ( ) const

inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 420 of file eda_draw_frame.h.

{ return GetCanvas(); }

References EDA_DRAW_FRAME::GetCanvas().

GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 54 of file tools_holder.h.

{ return m_toolManager; }

References TOOLS_HOLDER::m_toolManager.

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

GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

{ return m_type; }

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 577 of file eda_base_frame.h.

{ return m_undoList.m_CommandsList.size(); }

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

Referenced by GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EDA_BASE_FRAME::PushCommandToUndoList(), RollbackFromUndo(), SCH_EDITOR_CONTROL::Undo(), and EDITOR_CONDITIONS::undoFunc().

GetUnitPair()

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

inherited

Get the pair or units in current use.

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

Definition at line 1051 of file eda_draw_frame.cpp.

{
    COMMON_TOOLS* cmnTool = m_toolManager->GetTool<COMMON_TOOLS>();

    aPrimaryUnit    = GetUserUnits();
    aSecondaryUnits = EDA_UNITS::MILS;

    if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
    {
        if( cmnTool )
            aSecondaryUnits = cmnTool->GetLastMetricUnits();
        else
            aSecondaryUnits = EDA_UNITS::MILLIMETRES;
    }
    else
    {
        if( cmnTool )
            aSecondaryUnits = cmnTool->GetLastImperialUnits();
        else
            aSecondaryUnits = EDA_UNITS::MILS;
    }
}

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

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

GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const

inlineinherited

Return the user units currently in use.

Definition at line 126 of file eda_base_frame.h.

    {
        return m_userUnits;
    }

References EDA_BASE_FRAME::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_FP_EDITOR_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), BOARD_INSPECTION_TOOL::getItemDescription(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), PL_EDITOR_LAYOUT::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), PCB_MARKER::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), RC_TREE_MODEL::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_NET_INSPECTOR::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), GERBVIEW_FRAME::UpdateStatusBar(), UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), and DRC_TOOL::userUnits().

GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE *  aCfg )

virtualinherited

Return a pointer to the window settings for this frame.

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

Parameters

aCfg	is this frame's config object

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

Definition at line 785 of file eda_base_frame.cpp.

{
    return &aCfg->m_Window;
}

References APP_SETTINGS_BASE::m_Window.

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

GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )

inherited

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

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

Returns

the undecorated window size

Definition at line 1207 of file eda_base_frame.cpp.

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

    wxSize winSize( width, height );
#else
    wxSize winSize = GetSize();
#endif

    return winSize;
}

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

GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const

inherited

Return a human readable value for display in dialogs.

Definition at line 563 of file eda_draw_frame.cpp.

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

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

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

handleActivateEvent()

void EDA_DRAW_FRAME::handleActivateEvent ( wxActivateEvent &  aEvent )

protectedvirtualinherited

Handle a window activation event.

Reimplemented in PCB_BASE_EDIT_FRAME.

Definition at line 1124 of file eda_draw_frame.cpp.

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

References EDA_DRAW_FRAME::m_messagePanel.

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

HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

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

Definition at line 1226 of file eda_base_frame.cpp.

{
    // Update the icon theme when the system theme changes and update the toolbars
    if( GetBitmapStore()->ThemeChanged() )
        ThemeChanged();

    // This isn't handled by ThemeChanged()
    if( GetMenuBar() )
    {
        // For icons in menus, icon scaling & hotkeys
        ReCreateMenuBar();
        GetMenuBar()->Refresh();
    }
}

References GetBitmapStore(), EDA_BASE_FRAME::ReCreateMenuBar(), 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 370 of file eda_base_frame.cpp.

{
    bool       checkRes  = false;
    bool       enableRes = true;
    bool       showRes   = true;
    SELECTION& selection = aFrame->GetCurrentSelection();

    try
    {
        checkRes  = aCond.checkCondition( selection );
        enableRes = aCond.enableCondition( selection );
        showRes   = aCond.showCondition( selection );
    }
    catch( std::exception& )
    {
        // Something broke with the conditions, just skip the event.
        aEvent.Skip();
        return;
    }

    aEvent.Enable( enableRes );
    aEvent.Show( showRes );

    // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
    // checked, since wxMenuItems don't want to be checked unless they actually are checkable
#if wxCHECK_VERSION( 3, 1, 5 )
    if( aEvent.IsCheckable() )
        aEvent.Check( checkRes );
#else
    bool canCheck = true;

    // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
    // see if they can be and can't just universally apply a check in this event.
    if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
        canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();

    if( canCheck )
        aEvent.Check( checkRes );
#endif
}

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

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

HardRedraw()

void PL_EDITOR_FRAME::HardRedraw ( )

overridevirtual

Refresh the library tree and redraw the window.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 803 of file pl_editor_frame.cpp.

{
    GetCanvas()->DisplayDrawingSheet();

    PL_SELECTION_TOOL*  selTool = m_toolManager->GetTool<PL_SELECTION_TOOL>();
    PL_SELECTION&       selection = selTool->GetSelection();
    DS_DATA_ITEM*       item = nullptr;

    if( selection.GetSize() == 1 )
        item = static_cast<DS_DRAW_ITEM_BASE*>( selection.Front() )->GetPeer();

    m_propertiesPagelayout->CopyPrmsFromItemToPanel( item );
    m_propertiesPagelayout->CopyPrmsFromGeneralToPanel();
    GetCanvas()->Refresh();
}

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, and EDA_DRAW_PANEL_GAL::Refresh().

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

help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 804 of file eda_base_frame.cpp.

{
    return Kiface().GetHelpFileName();
}

References KIFACE_I::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 1117 of file eda_base_frame.cpp.

{
    wxAcceleratorEntry entries[1];
    entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
    wxAcceleratorTable accel( 1, entries );
    SetAcceleratorTable( accel );
}

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 267 of file pagelayout_editor/files.cpp.

{
    if( wxFileExists( aFullFileName ) )
    {
        const bool append = true;
        SaveCopyInUndoList();
        DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( aFullFileName, append );
        return true;
    }

    return false;
}

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

Referenced by Files_io().

InstallPreferences()

void PL_EDITOR_FRAME::InstallPreferences ( PAGED_DIALOG *  , PANEL_HOTKEYS_EDITOR *    )

overridevirtual

Allow a frame to load its preference panels (if any) into the preferences dialog.

Parameters

aParent

a paged dialog into which the preference panels should be installed.

Reimplemented from EDA_BASE_FRAME.

Definition at line 476 of file pl_editor_frame.cpp.

{
    wxTreebook* book = aParent->GetTreebook();

    book->AddPage( new wxPanel( book ), _( "Drawing Sheet Editor" ) );
    book->AddSubPage( new PANEL_GAL_DISPLAY_OPTIONS( this, aParent ), _( "Display Options" ) );
    book->AddSubPage( new PANEL_PL_EDITOR_COLOR_SETTINGS( this, aParent->GetTreebook() ),
                      _( "Colors" ) );

    aHotkeysPanel->AddHotKeys( GetToolManager() );
}

References _, PANEL_HOTKEYS_EDITOR::AddHotKeys(), TOOLS_HOLDER::GetToolManager(), and PAGED_DIALOG::GetTreebook().

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.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 615 of file eda_base_frame.h.

{ return false; }

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

{
    return GetScreen() && GetScreen()->IsContentModified();
}

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

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

IsCurrentTool()

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

inherited

Definition at line 109 of file tools_holder.cpp.

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

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

Referenced by SCH_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::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 155 of file kiway_player.cpp.

{
    return !m_modal_loop;
}

References KIWAY_PLAYER::m_modal_loop.

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

IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( ) const

inherited

Definition at line 380 of file eda_draw_frame.cpp.

{
    return config()->m_Window.grid.show;
}

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

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

{ return m_modal; }

References KIWAY_PLAYER::m_modal.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), KIWAY_PLAYER::ShowModal(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType ) const

inlineinherited

Definition at line 206 of file eda_base_frame.h.

{ return m_ident == aType; }

References EDA_BASE_FRAME::m_ident.

Referenced by SYMBOL_EDITOR_CONTROL::AddLibrary(), PCB_CONTROL::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), COMMON_TOOLS::doZoomFit(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbol(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), CONVERT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), CONVERT_TOOL::LinesToPoly(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PANEL_3D_COLORS::PANEL_3D_COLORS(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SYMBOL_EDITOR_CONTROL::Revert(), SYMBOL_EDITOR_CONTROL::Save(), APPEARANCE_CONTROLS::setVisibleObjects(), EE_INSPECTION_TOOL::ShowDatasheet(), EE_INSPECTION_TOOL::ShowERCDialog(), SYMBOL_EDITOR_CONTROL::ToggleSymbolTree(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName &  aFileName )

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.

Returns

False if aFileName cannot be written.

Definition at line 1019 of file eda_base_frame.cpp.

{
    wxString msg;
    wxFileName fn = aFileName;

    // Check for absence of a file path with a file name.  Unfortunately KiCad
    // uses paths relative to the current project path without the ./ part which
    // confuses wxFileName. Making the file name path absolute may be less than
    // elegant but it solves the problem.
    if( fn.GetPath().IsEmpty() && fn.HasName() )
        fn.MakeAbsolute();

    wxCHECK_MSG( fn.IsOk(), false,
                 wxT( "File name object is invalid.  Bad programmer!" ) );
    wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
                 wxT( "File name object path <" ) + fn.GetFullPath() +
                 wxT( "> is not set.  Bad programmer!" ) );

    if( fn.IsDir() && !fn.IsDirWritable() )
    {
        msg.Printf( _( "You do not have write permissions to folder '%s'." ),
                    fn.GetPath() );
    }
    else if( !fn.FileExists() && !fn.IsDirWritable() )
    {
        msg.Printf( _( "You do not have write permissions to save file '%s' to folder '%s'." ),
                    fn.GetFullName(), fn.GetPath() );
    }
    else if( fn.FileExists() && !fn.IsFileWritable() )
    {
        msg.Printf( _( "You do not have write permissions to save file '%s'." ),
                    fn.GetFullPath() );
    }

    if( !msg.IsEmpty() )
    {
        wxMessageBox( msg );
        return false;
    }

    return true;
}

References _.

Referenced by SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::SaveEEFile(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProjectSettings().

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

    {
        wxASSERT( m_kiway );    // smoke out bugs in Debug build, then Release runs fine.
        return *m_kiway;
    }

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS &  aEvent )

protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 176 of file kiway_player.cpp.

{
    // logging support
    KiwayMailIn( aEvent );     // call the virtual, override in derived.
}

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 SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, SCH_EDIT_FRAME, PCB_EDIT_FRAME, and CVPCB_MAINFRAME.

Definition at line 70 of file kiway_player.cpp.

{
    // override this in derived classes.
}

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 183 of file kiway_player.cpp.

{
    int id = event.GetId();

    // tell all the KIWAY_PLAYERs about the language change.
    Kiway().SetLanguage( id );
}

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

{
    wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
    aFilename.SetExt( ext );

    wxString dir = aGlobalPath;


    if( isDirectory && doOpen )
    {
        if( !aIsGlobal )
        {
            dir = Prj().GetProjectPath();
        }

        wxDirDialog dlg( this, prompt, dir,
                         wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );

        if( dlg.ShowModal() == wxID_CANCEL )
            return false;

        aFilename = dlg.GetPath();
        aFilename.SetExt( ext );
    }
    else
    {
        // Ensure the file has a dummy name, otherwise GTK will display the regex from the filter
        if( aFilename.GetName().empty() )
            aFilename.SetName( "Library" );

        if( !aIsGlobal )
        {
            dir = Prj().IsNullProject() ? aFilename.GetFullPath() : Prj().GetProjectPath();
        }

        wxFileDialog dlg( this, prompt, dir, aFilename.GetFullName(),
                          wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
                                           : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );

        if( dlg.ShowModal() == wxID_CANCEL )
            return false;

        aFilename = dlg.GetPath();
        aFilename.SetExt( ext );
    }

    return true;
}

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

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

loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )

protectedinherited

Returns the canvas type stored in the application settings.

Definition at line 712 of file eda_draw_frame.cpp.

{
#ifdef __WXMAC__
    // Cairo renderer doesn't handle Retina displays so there's really only one game
    // in town for Mac
    return EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL;
#endif

    EDA_DRAW_PANEL_GAL::GAL_TYPE canvasType = EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE;
    APP_SETTINGS_BASE* cfg = Kiface().KifaceSettings();

    if( cfg )
        canvasType = static_cast<EDA_DRAW_PANEL_GAL::GAL_TYPE>( cfg->m_Graphics.canvas_type );

    if( canvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
            || canvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
    {
        wxASSERT( false );
        canvasType = EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE;
    }

    // Legacy canvas no longer supported.  Switch to Cairo, and on the first instantiation
    // the user will be prompted to switch to OpenGL
    if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
        canvasType = EDA_DRAW_PANEL_GAL::GAL_FALLBACK;

    return canvasType;
}

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

Referenced by SCH_BASE_FRAME::createCanvas(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), and EDA_DRAW_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 225 of file pagelayout_editor/files.cpp.

{
    if( wxFileExists( aFullFileName ) )
    {
        bool loaded = false;

        loaded = DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( aFullFileName );

        if( !loaded )
        {
            ShowInfoBarError( _( "Error reading drawing sheet" ), true );
            return false;
        }

        SetCurrentFileName( aFullFileName );
        UpdateFileHistory( aFullFileName );
        GetScreen()->SetContentModified( false );

        wxFileName fn = aFullFileName;
        m_infoBar->Dismiss();

        if( DS_DATA_MODEL::GetTheInstance().GetFileFormatVersionAtLoad() < SEXPR_WORKSHEET_FILE_VERSION )
        {
            m_infoBar->RemoveAllButtons();
            m_infoBar->AddCloseButton();
            m_infoBar->ShowMessage( _( "This file was created by an older version of KiCad. "
                                       "It will be converted to the new format when saved." ),
                                    wxICON_WARNING, WX_INFOBAR::MESSAGE_TYPE::OUTDATED_SAVE );
        }

        if( fn.FileExists() && !fn.IsFileWritable() )
        {
            ShowInfoBarWarning( _( "Layout file is read only." ), true );
        }

        return true;
    }

    return false;
}

References _, WX_INFOBAR::AddCloseButton(), WX_INFOBAR::Dismiss(), EDA_DRAW_FRAME::GetScreen(), DS_DATA_MODEL::GetTheInstance(), DS_DATA_MODEL::LoadDrawingSheet(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::OUTDATED_SAVE, WX_INFOBAR::RemoveAllButtons(), BASE_SCREEN::SetContentModified(), SetCurrentFileName(), SEXPR_WORKSHEET_FILE_VERSION, EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarWarning(), 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 490 of file pl_editor_frame.cpp.

{
    EDA_DRAW_FRAME::LoadSettings( aCfg );

    if( aCfg->m_Window.grid.sizes.empty() )
    {
        aCfg->m_Window.grid.sizes = { "1.0 mm",
                                      "0.50 mm",
                                      "0.25 mm",
                                      "0.20 mm",
                                      "0.10 mm" };
    }

    // Currently values read from config file are not used because the user cannot
    // change this config
    // if( aCfg->m_Window.zoom_factors.empty() )
    {
        aCfg->m_Window.zoom_factors = { ZOOM_LIST_PL_EDITOR };
    }

    PL_EDITOR_SETTINGS* cfg = dynamic_cast<PL_EDITOR_SETTINGS*>( aCfg );
    wxCHECK( cfg, /*void*/ );

    m_propertiesFrameWidth = cfg->m_PropertiesFrameWidth;
    m_originSelectChoice = cfg->m_CornerOrigin;

    SetDrawBgColor( cfg->m_BlackBackground ? BLACK : WHITE );

    PAGE_INFO::SetCustomWidthMils( cfg->m_LastCustomWidth );
    PAGE_INFO::SetCustomHeightMils( cfg->m_LastCustomHeight );

    PAGE_INFO pageInfo = GetPageSettings();
    pageInfo.SetType( cfg->m_LastPaperSize, cfg->m_LastWasPortrait );
    SetPageSettings( pageInfo );
}

References BLACK, GetPageSettings(), WINDOW_SETTINGS::grid, 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, PL_EDITOR_SETTINGS::m_PropertiesFrameWidth, m_propertiesFrameWidth, APP_SETTINGS_BASE::m_Window, PAGE_INFO::SetCustomHeightMils(), PAGE_INFO::SetCustomWidthMils(), EDA_DRAW_FRAME::SetDrawBgColor(), SetPageSettings(), PAGE_INFO::SetType(), GRID_SETTINGS::sizes, 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 685 of file eda_base_frame.cpp.

{
    LoadWindowState( aCfg->state );

    if( m_hasAutoSave )
        m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;

    m_perspective = aCfg->perspective;
    m_mruPath = aCfg->mru_path;

    TOOLS_HOLDER::CommonSettingsChanged( false, false );
}

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

Referenced by EDA_BASE_FRAME::LoadSettings().

LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString &  aFileName )

inherited

Definition at line 526 of file eda_base_frame.cpp.

{
    if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
        return;

    const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );

    if( state != nullptr )
    {
        LoadWindowState( state->window );
    }
}

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

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

LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE &  aState )

virtualinherited

Load frame state info from a configuration file.

Definition at line 540 of file eda_base_frame.cpp.

{
    bool wasDefault = false;

    m_framePos.x  = aState.pos_x;
    m_framePos.y  = aState.pos_y;
    m_frameSize.x = aState.size_x;
    m_frameSize.y = aState.size_y;

    wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
                m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );

    // Ensure minimum size is set if the stored config was zero-initialized
    if( m_frameSize.x < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
    {
        m_frameSize = defaultSize( m_ident );
        wasDefault  = true;

        wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_frameSize.x, m_frameSize.y );
    }

    wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );

    if( aState.display >= wxDisplay::GetCount() )
    {
        wxLogTrace( traceDisplayLocation, "Previous display not found" );

        // If it isn't attached, use the first display
        // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
        const unsigned int index = 0;
        wxDisplay display( index );
        wxRect    clientSize = display.GetGeometry();

        m_framePos = wxDefaultPosition;

        // Ensure the window fits on the display, since the other one could have been larger
        if( m_frameSize.x > clientSize.width )
            m_frameSize.x = clientSize.width;

        if( m_frameSize.y > clientSize.height )
            m_frameSize.y = clientSize.height;
    }
    else
    {
        wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
        wxPoint upperLeft( m_framePos.x, m_framePos.y );

        wxDisplay display( aState.display );
        wxRect clientSize = display.GetClientArea();

        int yLimTop   = clientSize.y;
        int yLimBottom = clientSize.y + clientSize.height;
        int xLimLeft  = clientSize.x;
        int xLimRight = clientSize.x + clientSize.width;

        if( upperLeft.x  > xLimRight ||  // Upper left corner too close to right edge of screen
            upperRight.x < xLimLeft  ||  // Upper right corner too close to left edge of screen
            upperLeft.y < yLimTop ||   // Upper corner too close to the bottom of the screen
            upperLeft.y > yLimBottom )
        {
            m_framePos = wxDefaultPosition;
            wxLogTrace( traceDisplayLocation, "Resetting to default position" );
        }
    }

    wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
                m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );

    SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );

    // Center the window if we reset to default
    if( m_framePos.x == -1 )
    {
        wxLogTrace( traceDisplayLocation, "Centering window" );
        Center();
        m_framePos = GetPosition();
    }

    // Record the frame sizes in an un-maximized state
    m_normalFrameSize = m_frameSize;
    m_normalFramePos  = m_framePos;

    // Maximize if we were maximized before
    if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
    {
        wxLogTrace( traceDisplayLocation, "Maximizing window" );
        Maximize();
    }

    m_displayIndex = wxDisplay::GetFromWindow( this );
}

References PCAD2KICAD::Center, 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(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.

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

false if the file was already locked, true otherwise.

Definition at line 204 of file eda_draw_frame.cpp.

{
    m_file_checker = ::LockFile( aFileName );

    return bool( m_file_checker );
}

References EDA_DRAW_FRAME::m_file_checker.

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

NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce )

inlineinherited

Definition at line 582 of file eda_base_frame.h.

    {
        m_isNonUserClose = true;
        return Close( aForce );
    }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

onActivate()

void EDA_DRAW_FRAME::onActivate ( wxActivateEvent &  aEvent )

protectedinherited

Definition at line 1133 of file eda_draw_frame.cpp.

{
    handleActivateEvent( aEvent );

    aEvent.Skip();
}

References EDA_DRAW_FRAME::handleActivateEvent().

onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent )

protectedinherited

Handle the auto save timer event.

Definition at line 314 of file eda_base_frame.cpp.

{
    if( !doAutoSave() )
        m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
}

References EDA_BASE_FRAME::doAutoSave(), EDA_BASE_FRAME::m_autoSaveInterval, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by EDA_BASE_FRAME::commonInit().

OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  aKeyEvent )

virtualinherited

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

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

Reimplemented in FOOTPRINT_VIEWER_FRAME.

Definition at line 327 of file eda_base_frame.cpp.

{
    wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( aKeyEvent ) );

    // Key events can be filtered here.
    // Currently no filtering is made.
    aKeyEvent.Skip();
}

References dump(), and kicadTraceKeyEvent.

OnClearFileHistory()

void PL_EDITOR_FRAME::OnClearFileHistory

(

wxCommandEvent &

aEvent

)

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

{
    ClearFileHistory();
}

References EDA_BASE_FRAME::ClearFileHistory().

OnExit()

void PL_EDITOR_FRAME::OnExit

(

wxCommandEvent &

aEvent

)

Event handler for the wxID_EXIT and wxID_CLOSE events.

Definition at line 352 of file pl_editor_frame.cpp.

{
    if( aEvent.GetId() == wxID_EXIT )
        Kiway().OnKiCadExit();

    if( aEvent.GetId() == wxID_CLOSE || Kiface().IsSingle() )
        Close( false );
}

References KIFACE_I::IsSingle(), Kiface(), KIWAY_HOLDER::Kiway(), and KIWAY::OnKiCadExit().

OnFileHistory()

void PL_EDITOR_FRAME::OnFileHistory

(

wxCommandEvent &

event

)

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

{
    wxString filename;

    filename = GetFileFromHistory( event.GetId(), _( "Drawing Sheet File" ) );

    if( filename != wxEmptyString )
    {
        if( IsContentModified() )
        {
            if( !HandleUnsavedChanges( this, _( "The current drawing sheet has been modified. "
                                                "Save changes?" ),
                                       [&]()->bool { return saveCurrentPageLayout(); } ) )
            {
                return;
            }
        }

        ::wxSetWorkingDirectory( ::wxPathOnly( filename ) );

        if( LoadDrawingSheetFile( filename ) )
        {
            wxString msg;
            msg.Printf( _( "File \"%s\" loaded"), filename );
            SetStatusText( msg );
        }

        OnNewDrawingSheet();
    }
}

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

OnGridSettings()

void EDA_DRAW_FRAME::OnGridSettings ( wxCommandEvent &  event )

inherited

Definition at line 368 of file eda_draw_frame.cpp.

{
    DIALOG_GRID_SETTINGS dlg( this );

    if( dlg.ShowModal() == wxID_OK )
    {
        UpdateStatusBar();
        GetCanvas()->Refresh();
    }
}

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

OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event )

inherited

Definition at line 968 of file eda_base_frame.cpp.

{
    void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
    ShowAboutDialog( this );
}

References ShowAboutDialog().

OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent &  aEvent )

inherited

Definition at line 1185 of file eda_base_frame.cpp.

{
    // When we maximize the window, we want to save the old information
    // so that we can add it to the settings on next window load.
    // Contrary to the documentation, this event seems to be generated
    // when the window is also being unmaximized on OSX, so we only
    // capture the size information when we maximize the window when on OSX.
#ifdef __WXOSX__
    if( !IsMaximized() )
#endif
    {
        m_normalFrameSize = GetWindowSize();
        m_normalFramePos  = GetPosition();
        wxLogTrace( traceDisplayLocation, "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
                    m_normalFramePos.x, m_normalFramePos.y, m_normalFrameSize.x, m_normalFrameSize.y );
    }

    // Skip event to actually maximize the window
    aEvent.Skip();
}

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

{
    if( !m_toolDispatcher )
        aEvent.Skip();
    else
        m_toolDispatcher->DispatchWxEvent( aEvent );
}

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

OnModify()

void PL_EDITOR_FRAME::OnModify ( )

inline

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

Definition at line 237 of file pl_editor_frame.h.

    {
        GetScreen()->SetContentModified();
    }

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

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

OnMove()

void EDA_DRAW_FRAME::OnMove ( wxMoveEvent &  aEvent )

overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 471 of file eda_draw_frame.cpp.

{
    // If the window is moved to a different display, the scaling factor may change
    double oldFactor = m_galDisplayOptions.m_scaleFactor;
    m_galDisplayOptions.UpdateScaleFactor();

    if( oldFactor != m_galDisplayOptions.m_scaleFactor && m_canvas )
    {
        wxSize clientSize = GetClientSize();
        GetCanvas()->GetGAL()->ResizeScreen( clientSize.x, clientSize.y );
        GetCanvas()->GetView()->MarkDirty();
    }

    aEvent.Skip();
}

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 KIGFX::GAL_DISPLAY_OPTIONS::UpdateScaleFactor().

OnNewDrawingSheet()

void PL_EDITOR_FRAME::OnNewDrawingSheet

(

)

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

Definition at line 885 of file pl_editor_frame.cpp.

{
    ClearUndoRedoList();
    GetScreen()->SetContentModified( false );
    GetCanvas()->DisplayDrawingSheet();

    m_propertiesPagelayout->CopyPrmsFromItemToPanel( nullptr );
    m_propertiesPagelayout->CopyPrmsFromGeneralToPanel();

    UpdateTitleAndInfo();

    m_toolManager->RunAction( ACTIONS::zoomFitScreen, true );

    if( GetCurrentFileName().IsEmpty() )
    {
        // Default shutdown reason until a file is loaded
        KIPLATFORM::APP::SetShutdownBlockReason( this, _( "New drawing sheet file is unsaved" ) );
    }
    else
    {
        KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Drawing sheet changes are unsaved" ) );
    }
}

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

{}

Referenced by DIALOG_PAGES_SETTINGS::TransferDataFromWindow().

OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event )

inherited

Displays the preferences and settings of all opened editors paged dialog.

Definition at line 975 of file eda_base_frame.cpp.

{
    PAGED_DIALOG dlg( this, _( "Preferences" ), true );
    wxTreebook* book = dlg.GetTreebook();

    book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );

    book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );

    PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
    book->AddPage( hotkeysPanel, _( "Hotkeys" ) );

    wxWindow* viewer3D = nullptr;

    for( unsigned i = 0; i < KIWAY_PLAYER_COUNT;  ++i )
    {
        KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );

        if( frame )
        {
            frame->InstallPreferences( &dlg, hotkeysPanel );

            if( !viewer3D )
                viewer3D = wxFindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( frame ) );
        }
    }

    if( viewer3D )
        static_cast<EDA_BASE_FRAME*>( viewer3D )->InstallPreferences( &dlg, hotkeysPanel );

    // The Kicad manager frame is not a player so we have to add it by hand
    wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );

    if( manager )
        static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );

    for( size_t i = 0; i < book->GetPageCount(); ++i )
        book->GetPage( i )->Layout();

    if( dlg.ShowModal() == wxID_OK )
        dlg.Kiway().CommonSettingsChanged( false, false );
}

References _, KIWAY::CommonSettingsChanged(), PAGED_DIALOG::GetTreebook(), EDA_BASE_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME_NAME, KIWAY_HOLDER::Kiway(), KIWAY_PLAYER_COUNT, KIWAY::Player(), and QUALIFIED_VIEWER3D_FRAMENAME.

Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch(), and COMMON_CONTROL::OpenPreferences().

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

{
    m_originSelectChoice = m_originSelectBox->GetSelection();
    UpdateStatusBar();  // Update grid origin
    GetCanvas()->DisplayDrawingSheet();
    GetCanvas()->Refresh();
}

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

{
    wxCHECK_RET( m_gridSelectBox, "m_gridSelectBox uninitialized" );

    int idx = m_gridSelectBox->GetCurrentSelection();

    if( idx == int( m_gridSelectBox->GetCount() ) - 2 )
    {
        // wxWidgets will check the separator, which we don't want.
        // Re-check the current grid.
        wxUpdateUIEvent dummy;
        OnUpdateSelectGrid( dummy );
    }
    else if( idx == int( m_gridSelectBox->GetCount() ) - 1 )
    {
        // wxWidgets will check the Grid Settings... entry, which we don't want.
        // Re-check the current grid.
        wxUpdateUIEvent dummy;
        OnUpdateSelectGrid( dummy );

        // Give a time-slice to close the menu before opening the dialog.
        // (Only matters on some versions of GTK.)
        wxSafeYield();

        m_toolManager->RunAction( ACTIONS::gridProperties, true );
    }
    else
    {
        m_toolManager->RunAction( ACTIONS::gridPreset, true, static_cast<intptr_t>( idx ) );
    }

    UpdateStatusBar();
    m_canvas->Refresh();
}

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(), and EDA_DRAW_FRAME::UpdateStatusBar().

OnSelectPage()

void PL_EDITOR_FRAME::OnSelectPage

(

wxCommandEvent &

event

)

Definition at line 406 of file pl_editor_frame.cpp.

{
    KIGFX::VIEW* view = GetCanvas()->GetView();
    view->SetLayerVisible( LAYER_DRAWINGSHEET_PAGE1, m_pageSelectBox->GetSelection() == 0 );
    view->SetLayerVisible( LAYER_DRAWINGSHEET_PAGEn, m_pageSelectBox->GetSelection() == 1 );
    GetCanvas()->Refresh();
}

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

OnSelectTitleBlockDisplayMode()

void PL_EDITOR_FRAME::OnSelectTitleBlockDisplayMode

(

wxCommandEvent &

event

)

Toggle the display mode between the normal mode and the editor mode: In normal mode, title block texts are shown like they will be shown in other kicad applications: the format symbols in texts are replaced by the actual text.

In editor mode, the format symbols in texts are not replaced by the actual text, and therefore format symbols are displayed.

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

{
    wxCHECK_RET( m_zoomSelectBox, "m_zoomSelectBox uninitialized" );

    int id = m_zoomSelectBox->GetCurrentSelection();

    if( id < 0 || !( id < (int)m_zoomSelectBox->GetCount() ) )
        return;

    m_toolManager->RunAction( ACTIONS::zoomPreset, true, static_cast<intptr_t>( id ) );
    UpdateStatusBar();
    m_canvas->Refresh();
}

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

Definition at line 541 of file eda_draw_frame.cpp.

{
    EDA_BASE_FRAME::OnSize( SizeEv );

    m_frameSize = GetClientSize( );

    SizeEv.Skip();
}

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

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

OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent &  evt )

inherited

Definition at line 71 of file eda_dde.cpp.

{
    size_t        len;
    wxSocketBase* sock = evt.GetSocket();

    switch( evt.GetSocketEvent() )
    {
    case wxSOCKET_INPUT:
        sock->Read( client_ipc_buffer, 1 );

        if( sock->LastCount() == 0 )
            break;                    // No data, occurs on opening connection

        sock->Read( client_ipc_buffer + 1, IPC_BUF_SIZE - 2 );
        len = 1 + sock->LastCount();
        client_ipc_buffer[len] = 0;
        ExecuteRemoteCommand( client_ipc_buffer );
        break;

    case wxSOCKET_LOST:
        return;
        break;

    default:
        wxPrintf( wxT( "EDA_DRAW_FRAME::OnSockRequest() error: Invalid event !" ) );
        break;
    }
}

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

OnSockRequestServer()

void KIWAY_PLAYER::OnSockRequestServer ( wxSocketEvent &  evt )

inherited

Definition at line 103 of file eda_dde.cpp.

{
    wxSocketBase*   socket;
    wxSocketServer* server = (wxSocketServer*) evt.GetSocket();

    socket = server->Accept();

    if( socket == NULL )
        return;

    m_sockets.push_back( socket );

    socket->Notify( true );
    socket->SetEventHandler( *this, ID_EDA_SOCKET_EVENT );
    socket->SetNotify( wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG );
}

References ID_EDA_SOCKET_EVENT, KIWAY_PLAYER::m_sockets, and NULL.

onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent &  aEvent )

protectedinherited

Definition at line 1242 of file eda_base_frame.cpp.

{
    // Call the handler to update the colors used in the frame
    HandleSystemColorChange();

    // Skip the change event to ensure the rest of the window controls get it
    aEvent.Skip();
}

References EDA_BASE_FRAME::HandleSystemColorChange().

OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent &  aEvent )

inherited

Update the checked item in the grid combobox.

Definition at line 308 of file eda_draw_frame.cpp.

{
    // No need to update the grid select box if it doesn't exist or the grid setting change
    // was made using the select box.
    if( m_gridSelectBox == NULL )
        return;

    int idx = config()->m_Window.grid.last_size_idx;
    idx = std::max( 0, std::min( idx, (int) m_gridSelectBox->GetCount() - 1 ) );

    if( idx != m_gridSelectBox->GetSelection() )
        m_gridSelectBox->SetSelection( idx );
}

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

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

Definition at line 429 of file eda_draw_frame.cpp.

{
    if( m_zoomSelectBox == NULL || m_zoomSelectBox->GetParent() == NULL )
        return;

    int current = 0;    // display Auto if no match found

    // check for a match within 1%
    double zoom = GetCanvas()->GetGAL()->GetZoomFactor();

    for(