KiCad PCB EDA Suite
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:
EDA_DRAW_FRAME KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER UNITS_PROVIDER

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_FRAMEGetPropertiesFrame ()
 
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_INFOGetPageSettings () 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_GALGetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame. More...
 
SELECTIONGetCurrentSelection () override
 Get the current selection from the canvas area. More...
 
const VECTOR2IGetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const VECTOR2I &aPoint) override
 
VECTOR2I ReturnCoordOriginCorner () const
 Calculate the position (in page, in iu) of the corner used as coordinate origin of items. More...
 
const TITLE_BLOCKGetTitleBlock () 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_LAYOUTGetPageLayout () const
 
PL_EDITOR_LAYOUTGetPageLayout ()
 
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 UpdateMsgPanelInfo ()
 Display the size of the sheet to the message panel. 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_ITEMAddDrawingSheetItem (int aType)
 Add a new item to the drawing sheet item list. More...
 
void OnModify () override
 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...
 
bool IsScriptingConsoleVisible ()
 Gets the current visibility of the scripting console window. More...
 
EDA_SEARCH_DATAGetFindReplaceData ()
 
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...
 
VECTOR2I GetNearestGridPosition (const VECTOR2I &aPosition) const
 Return the nearest aGridSize location to aPosition. More...
 
VECTOR2I GetNearestHalfGridPosition (const VECTOR2I &aPosition) const
 Return the nearest aGridSize / 2 location to aPosition. More...
 
virtual COLOR4D GetDrawBgColor () const
 
virtual void SetDrawBgColor (const COLOR4D &aColor)
 
virtual COLOR_SETTINGSGetColorSettings (bool aForceRefresh=false) const
 Returns a pointer to the active color theme settings. More...
 
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_SCREENGetScreen () 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 (const COLOR4D &aColor)
 
void OnSelectGrid (wxCommandEvent &event)
 Command event handler for selecting grid sizes. More...
 
void OnGridSettings (wxCommandEvent &event)
 
void UpdateGridSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.). More...
 
void OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
 Update the checked item in the grid wxchoice. More...
 
void OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
 Update the checked item in the zoom wxchoice. More...
 
void UpdateZoomSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) 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 VECTOR2I &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, const std::map< wxString, wxString > *aProperties, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
 Prints the drawing-sheet (frame and title block). More...
 
void DisplayToolMsg (const wxString &msg) override
 
void DisplayConstraintsMsg (const wxString &msg)
 
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_ITEMGetItem (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_OPTIONSGetGalDisplayOptions ()
 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...
 
void ShowChangedLanguage () override
 Redraw the menus and what not in current language. 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...
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
virtual ORIGIN_TRANSFORMSGetOriginTransforms ()
 Return a reference to the default ORIGIN_TRANSFORMS object. More...
 
SETTINGS_MANAGERGetSettingsManager () 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)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
FRAME_T GetFrameType () const
 
virtual const SEARCH_STACKsys_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_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...
 
void ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...
 
virtual APP_SETTINGS_BASEconfig () 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_SETTINGSGetWindowSettings (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_HISTORYGetFileHistory ()
 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, bool aVerbose=true)
 Checks if aFileName can be written. More...
 
virtual void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. 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_LISTPopCommandFromUndoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 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_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual void PushTool (const TOOL_EVENT &aEvent)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const TOOL_EVENT &aEvent)
 Pops a tool from the stack. More...
 
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
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
bool HasKiway () const
 Safety check before asking for the Kiway reference. More...
 
PROJECTPrj () 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...
 
EDA_UNITS GetUserUnits () const
 
void SetUserUnits (EDA_UNITS aUnits)
 
const EDA_IU_SCALEGetIuScale () const
 
wxString StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
 Converts aValue in internal units into a united string. More...
 
wxString StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false)
 
wxString MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
 A lower-precision version of StringFromValue(). More...
 
wxString MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true)
 
int ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
 Converts aTextValue in aUnits to internal units used by the frame. More...
 
EDA_ANGLE AngleValueFromString (const wxString &aTextValue)
 

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)
 
std::vector< wxWindow * > findDialogs ()
 
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 void handleIconizeEvent (wxIconizeEvent &aEvent)
 Handle a window iconize event. More...
 
void onIconize (wxIconizeEvent &aEvent)
 
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 ()
 
virtual void OnDropFiles (wxDropFilesEvent &aEvent)
 Handles event fired when a file is dropped to the window. More...
 

Static Protected Member Functions

static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

PROPERTIES_FRAMEm_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
 
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_TOOLBARm_mainToolBar
 
ACTION_TOOLBARm_auxiliaryToolBar
 
ACTION_TOOLBARm_drawToolBar
 
ACTION_TOOLBARm_optionsToolBar
 
std::unique_ptr< EDA_SEARCH_DATAm_findReplaceData
 
wxArrayString m_findStringHistoryList
 
wxArrayString m_replaceStringHistoryList
 
EDA_MSG_PANELm_messagePanel
 
int m_msgFrameHeight
 
COLOR_SETTINGSm_colorSettings
 
SEARCH_PANEm_searchPane
 The current canvas type. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
 
bool m_modal
 
WX_EVENT_LOOPm_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
 
std::vector< wxFileName > m_AcceptedFiles
 
FRAME_T m_ident
 
wxPoint m_framePos
 
wxSize m_frameSize
 
bool m_maximizeByDefault
 
int m_displayIndex
 
wxPoint m_normalFramePos
 
wxSize m_normalFrameSize
 
wxString m_aboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_supportsAutoSave
 
bool m_autoSavePending
 
bool m_autoSaveRequired
 
wxTimer * m_autoSaveTimer
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
ORIGIN_TRANSFORMS m_originTransforms
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 < Map containing the UI update handlers registered with wx for each action. More...
 
bool m_isClosing
 Set by NonUserClose() to indicate that the user did not request the current close. More...
 
bool m_isNonUserClose
 
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
 Associates files extensions with action to execute. More...
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_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 Member Functions

void DoWithAcceptedFiles () override
 Execute action on accepted dropped file. More...
 
void windowClosing (wxCloseEvent &event)
 (with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings(). More...
 
void commonInit (FRAME_T aFrameType)
 Collect common initialization functions used in all CTORs. More...
 
wxWindow * findQuasiModalDialog ()
 

Private Attributes

PL_EDITOR_LAYOUT m_pageLayout
 
int m_propertiesFrameWidth
 
wxChoice * m_originSelectBox
 
int m_originSelectChoice
 
wxChoice * m_pageSelectBox
 
wxString m_mruImagePath
 
VECTOR2I m_grid_origin
 
BASE_SCREENm_currentScreen
 current used SCREEN More...
 
EDA_DRAW_PANEL_GALm_canvas
 This the frame's interface to setting GAL display options. More...
 
KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions
 
KIWAYm_kiway
 
HOLDER_TYPE m_type
 
const EDA_IU_SCALEm_iuScale
 
EDA_UNITS m_userUnits
 

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.

◆ UNDO_REDO_LIST

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

Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 111 of file eda_base_frame.h.

112 {
113 UNDO_LIST,
115 };

Constructor & Destructor Documentation

◆ PL_EDITOR_FRAME()

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

Definition at line 82 of file pl_editor_frame.cpp.

82 :
83 EDA_DRAW_FRAME( aKiway, aParent, FRAME_PL_EDITOR, wxT( "PlEditorFrame" ),
84 wxDefaultPosition, wxDefaultSize,
86 m_propertiesPagelayout( nullptr ),
88 m_originSelectBox( nullptr ),
90 m_pageSelectBox( nullptr ),
91 m_mruImagePath( wxEmptyString )
92{
95
96 m_showBorderAndTitleBlock = true; // true for reference drawings.
98 m_aboutTitle = _( "KiCad Drawing Sheet Editor" );
99
100 // Give an icon
101 wxIcon icon;
102 wxIconBundle icon_bundle;
103
104 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pagelayout_editor ) );
105 icon_bundle.AddIcon( icon );
106 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pagelayout_editor_32 ) );
107 icon_bundle.AddIcon( icon );
108 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pagelayout_editor_16 ) );
109 icon_bundle.AddIcon( icon );
110
111 SetIcons( icon_bundle );
112
113 // Create GAL canvas
114 auto* drawPanel = new PL_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
117 SetCanvas( drawPanel );
118
119 LoadSettings( config() );
120
121 m_acceptedExts.emplace( DrawingSheetFileExtension, nullptr );
122 DragAcceptFiles( true );
123
125 SetScreen( new BASE_SCREEN( pageSizeIU ) );
126
127 setupTools();
133
134 wxWindow* stsbar = GetStatusBar();
135 int spacer = KIUI::GetTextSize( wxT( "M" ), stsbar ).x * 2;
136
137 int dims[] = {
138
139 // balance of status bar on far left is set to a default or whatever is left over.
140 -1,
141
142 // When using GetTextSize() remember the width of '1' is not the same
143 // as the width of '0' unless the font is fixed width, and it usually won't be.
144
145 // zoom:
146 KIUI::GetTextSize( wxT( "Z 762000" ), stsbar ).x + spacer,
147
148 // cursor coords
149 KIUI::GetTextSize( wxT( "X 0234.567 Y 0234.567" ), stsbar ).x + spacer,
150
151 // delta distances
152 KIUI::GetTextSize( wxT( "dx 0234.567 dx 0234.567" ), stsbar ).x + spacer,
153
154 // grid size
155 KIUI::GetTextSize( wxT( "grid 0234.567" ), stsbar ).x + spacer,
156
157 // Coord origin (use the bigger message)
158 KIUI::GetTextSize( _( "coord origin: Right Bottom page corner" ), stsbar ).x + spacer,
159
160 // units display, Inches is bigger than mm
161 KIUI::GetTextSize( _( "Inches" ), stsbar ).x + spacer,
162
163 // constraint mode
164 KIUI::GetTextSize( _( "Constrain to H, V, 45" ), stsbar ).x + spacer
165 };
166
167 SetStatusWidths( arrayDim( dims ), dims );
168
169 m_auimgr.SetManagedWindow( this );
170
173
174 // Rows; layers 4 - 6
175 m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" )
176 .Top().Layer( 6 ) );
177 m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" )
178 .Left().Layer( 3 ) );
179 m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" )
180 .Bottom().Layer( 6 ) );
181
182 // Columns; layers 1 - 3
183 m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" )
184 .Right().Layer( 2 ) );
185
186 m_auimgr.AddPane( m_propertiesPagelayout, EDA_PANE().Palette().Name( "Props" )
187 .Right().Layer( 3 )
188 .Caption( _( "Properties" ) )
190 .BestSize( m_propertiesFrameWidth, -1 ) );
191
192 // Center
193 m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" )
194 .Center() );
195
197
200
201 // Add the exit key handler
202 setupUnits( config() );
203
204 VECTOR2I originCoord = ReturnCoordOriginCorner();
205 SetGridOrigin( originCoord );
206
207 // Initialize the current drawing sheet
208#if 0 //start with empty layout
211#else // start with the default KiCad layout
213#endif
215
216 // Ensure the window is on top
217 Raise();
218
219 // Register a call to update the toolbar sizes. It can't be done immediately because
220 // it seems to require some sizes calculated that aren't yet (at least on GTK).
221 CallAfter( [&]()
222 {
223 // Ensure the controls on the toolbars all are correctly sized
225 } );
226}
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
constexpr EDA_IU_SCALE drawSheetIUScale
Definition: base_units.h:110
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
@ icon_pagelayout_editor
@ icon_pagelayout_editor_16
@ icon_pagelayout_editor_32
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:41
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
void AllowVoidList(bool Allow)
In KiCad applications, a drawing sheet is needed So if the list is empty, a default drawing sheet is ...
Definition: ds_data_model.h:83
void ClearList()
Erase the list of items.
bool LoadDrawingSheet(const wxString &aFullFileName=wxEmptyString, bool Append=false)
Populates the list with a custom layout or the default layout if no custom layout is available.
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
void FinishAUIInitialization()
wxAuiManager m_auimgr
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
Associates files extensions with action to execute.
wxString m_aboutTitle
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
void setupUnits(APP_SETTINGS_BASE *aCfg)
ACTION_TOOLBAR * m_optionsToolBar
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Changes the current rendering backend.
void resolveCanvasType()
Determines the Canvas type to load (with prompt if required) and initializes m_canvasType.
EDA_MSG_PANEL * m_messagePanel
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
virtual void SetScreen(BASE_SCREEN *aScreen)
EDA_DRAW_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName, const EDA_IU_SCALE &aIuScale)
ACTION_TOOLBAR * m_mainToolBar
ACTION_TOOLBAR * m_drawToolBar
bool m_showBorderAndTitleBlock
@ GAL_TYPE_NONE
GAL not used (the legacy wxDC engine is used)
Specialization of the wxAuiPaneInfo class for KiCad panels.
const wxSize GetSizeIU(double aIUScale) const
Gets the page size in internal units.
Definition: page_info.h:162
void OnNewDrawingSheet()
Must be called to initialize parameters when a new drawing sheet is loaded.
void ReCreateMenuBar() override
Recreates the menu bar.
void ReCreateOptToolbar() override
Create or update the left vertical toolbar.
wxString m_mruImagePath
VECTOR2I ReturnCoordOriginCorner() const
Calculate the position (in page, in iu) of the corner used as coordinate origin of items.
void SetGridOrigin(const VECTOR2I &aPoint) override
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void ReCreateHToolbar() override
void UpdateToolbarControlSizes() override
Update the sizes of any controls in the toolbars of the frame.
wxChoice * m_originSelectBox
const PL_EDITOR_LAYOUT & GetPageLayout() const
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
PROPERTIES_FRAME * m_propertiesPagelayout
The last filename chosen to be proposed to the user.
wxChoice * m_pageSelectBox
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void ReCreateVToolbar() override
Create or update the right vertical toolbar.
PAGE_INFO & GetPageSettings()
PROPERTIES_FRAME display properties of the current item.
wxSize GetMinSize() const override
void SetUserUnits(EDA_UNITS aUnits)
#define _(s)
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define PL_EDITOR_FRAME_NAME
@ FRAME_PL_EDITOR
Definition: frame_type.h:55
const std::string DrawingSheetFileExtension
wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
Definition: ui_common.cpp:70
const double IU_PER_MILS
Definition: base_units.h:78

References _, DS_DATA_MODEL::AllowVoidList(), arrayDim(), PCAD2KICAD::Center, DS_DATA_MODEL::ClearList(), config, DrawingSheetFileExtension, drawSheetIUScale, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, KIUI::GetTextSize(), DS_DATA_MODEL::GetTheInstance(), icon_pagelayout_editor, icon_pagelayout_editor_16, icon_pagelayout_editor_32, EDA_IU_SCALE::IU_PER_MILS, 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 229 of file pl_editor_frame.cpp.

230{
231 // Ensure m_canvasType is up to date, to save it in config
233
234 // Shutdown all running tools
235 if( m_toolManager )
237}
GAL_TYPE GetBackend() const
Return the type of backend currently used by GAL canvas.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:170
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...

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

Member Function Documentation

◆ ActivateGalCanvas()

void EDA_DRAW_FRAME::ActivateGalCanvas ( )
virtualinherited

Use to start up the GAL drawing canvas.

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

Definition at line 773 of file eda_draw_frame.cpp.

774{
775 GetCanvas()->SetEvtHandlerEnabled( true );
777}
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void StartDrawing()
Begin drawing if it was stopped previously.

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

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

◆ AddDrawingSheetItem()

DS_DATA_ITEM * PL_EDITOR_FRAME::AddDrawingSheetItem ( int  aType)

Add a new item to the drawing sheet item list.

Parameters
aTypeis the type of item: DS_TEXT, DS_SEGMENT, DS_RECT, DS_POLYPOLYGON
aIdxis the position in list to insert the new item.
Returns
a reference to the new item.

Definition at line 818 of file pl_editor_frame.cpp.

819{
820 DS_DATA_ITEM * item = nullptr;
821
822 switch( aType )
823 {
825 item = new DS_DATA_ITEM_TEXT( wxT( "Text") );
826 break;
827
830 break;
831
834 break;
835
837 item = new DS_DATA_ITEM_POLYGONS();
838 break;
839
841 {
842 wxFileDialog fileDlg( this, _( "Choose Image" ), m_mruImagePath, wxEmptyString,
843 _( "Image Files" ) + wxS( " " ) + wxImage::GetImageExtWildcard(),
844 wxFD_OPEN );
845
846 if( fileDlg.ShowModal() != wxID_OK )
847 return nullptr;
848
849 wxString fullFilename = fileDlg.GetPath();
850 m_mruImagePath = wxPathOnly( fullFilename );
851
852 if( !wxFileExists( fullFilename ) )
853 {
854 wxMessageBox( _( "Could not load image from '%s'." ), fullFilename );
855 break;
856 }
857
859
860 if( !image->ReadImageFile( fullFilename ) )
861 {
862 wxMessageBox( _( "Could not load image from '%s'." ), fullFilename );
863 delete image;
864 break;
865 }
866
867 // Set the scale factor for pl_editor (it is set for Eeschema by default)
868 image->SetPixelSizeIu( drawSheetIUScale.IU_PER_MILS * 1000.0 / image->GetPPI() );
869 item = new DS_DATA_ITEM_BITMAP( image );
870 }
871 break;
872 }
873
874 if( item == nullptr )
875 return nullptr;
876
878 item->SyncDrawItems( nullptr, GetCanvas()->GetView() );
879
880 return item;
881}
This class handle bitmap images in KiCad.
Definition: bitmap_base.h:51
Drawing sheet structure type definitions.
Definition: ds_data_item.h:96
virtual void SyncDrawItems(DS_DRAW_ITEM_LIST *aCollector, KIGFX::VIEW *aView)
void Append(DS_DATA_ITEM *aItem)

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

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

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 451 of file eda_base_frame.cpp.

452{
454 ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
455
456 helpMenu->Add( ACTIONS::help );
457 helpMenu->Add( ACTIONS::gettingStarted );
458 helpMenu->Add( ACTIONS::listHotKeys );
459 helpMenu->Add( ACTIONS::getInvolved );
460 helpMenu->Add( ACTIONS::donate );
461 helpMenu->Add( ACTIONS::reportBug );
462
463 helpMenu->AppendSeparator();
464 helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
465
466 // Trailing space keeps OSX from hijacking our menu (and disabling everything in it).
467 aMenuBar->Append( helpMenu, _( "&Help" ) + wxS( " " ) );
468}
static TOOL_ACTION reportBug
Cursor control event types.
Definition: actions.h:187
static TOOL_ACTION donate
Definition: actions.h:185
static TOOL_ACTION listHotKeys
Definition: actions.h:184
static TOOL_ACTION getInvolved
Definition: actions.h:186
static TOOL_ACTION gettingStarted
Definition: actions.h:182
static TOOL_ACTION help
Definition: actions.h:183
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:49
Handle actions that are shared between different applications.

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(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_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 556 of file eda_draw_frame.cpp.

557{
559 CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
560
561 aMenu.AddSeparator( 1000 );
562
563 std::shared_ptr<ZOOM_MENU> zoomMenu = std::make_shared<ZOOM_MENU>( this );
564 zoomMenu->SetTool( commonTools );
565 aToolMenu.RegisterSubMenu( zoomMenu );
566
567 std::shared_ptr<GRID_MENU> gridMenu = std::make_shared<GRID_MENU>( this );
568 gridMenu->SetTool( commonTools );
569 aToolMenu.RegisterSubMenu( gridMenu );
570
571 aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
572 aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
573}
Handles action that are shared between different applications.
Definition: common_tools.h:38
void AddSeparator(int aOrder=ANY_ORDER)
Add a separator to the menu.
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:44

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

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

◆ AngleValueFromString()

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

Definition at line 104 of file units_provider.h.

105 {
107 aTextValue );
108
109 return EDA_ANGLE( angle, DEGREES_T );
110 }
const EDA_IU_SCALE & GetIuScale() const
@ DEGREES_T
Definition: eda_angle.h:31
double DoubleValueFromString(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
Function DoubleValueFromString converts aTextValue to a double.
Definition: eda_units.cpp:449
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)

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

Referenced by FP_TEXT_GRID_TABLE::SetValue().

◆ AppendMsgPanel()

void EDA_DRAW_FRAME::AppendMsgPanel ( const wxString &  aTextUpper,
const wxString &  aTextLower,
int  aPadding = 6 
)
inherited

Append a message to the message panel.

This helper method checks to make sure the message panel exists in the frame and appends a message to it using the message panel AppendMessage() method.

Parameters
aTextUpperThe message upper text.
aTextLowerThe message lower text.
aPaddingNumber of spaces to pad between messages.

Definition at line 718 of file eda_draw_frame.cpp.

720{
721 if( m_messagePanel )
722 m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
723}
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, int aPadding=6)
Append a message to the message panel.
Definition: msgpanel.cpp:93

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

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

◆ canCloseWindow()

bool PL_EDITOR_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 368 of file pl_editor_frame.cpp.

369{
370 // Shutdown blocks must be determined and vetoed as early as possible
372 && aEvent.GetId() == wxEVT_QUERY_END_SESSION
373 && IsContentModified() )
374 {
375 return false;
376 }
377
378 if( IsContentModified() )
379 {
380 wxFileName filename = GetCurrentFileName();
381 wxString msg = _( "Save changes to '%s' before closing?" );
382
383 if( !HandleUnsavedChanges( this, wxString::Format( msg, filename.GetFullName() ),
384 [&]() -> bool
385 {
386 return saveCurrentPageLayout();
387 } ) )
388 {
389 return false;
390 }
391 }
392
393 return true;
394}
bool IsContentModified() const override
Get if the drawing sheet has been modified but not saved.
wxString GetCurrentFileName() const override
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:240
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: gtk/app.cpp:72
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

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

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 1320 of file eda_base_frame.cpp.

1321{
1322 SetUserUnits( aUnits );
1324
1325 wxCommandEvent e( UNITS_CHANGED );
1326 ProcessEventLocally( e );
1327}
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...

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

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

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName &  aFileName)
virtualinherited

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

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

Parameters
aFileNameA wxFileName object containing the file name to check.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1202 of file eda_base_frame.cpp.

1203{
1204 wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
1205
1206 wxFileName autoSaveFileName = aFileName;
1207
1208 // Check for auto save file.
1209 autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
1210
1211 wxLogTrace( traceAutoSave,
1212 wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
1213
1214 if( !autoSaveFileName.FileExists() )
1215 return;
1216
1217 wxString msg = wxString::Format( _( "Well this is potentially embarrassing!\n"
1218 "It appears that the last time you were editing\n"
1219 "%s\n"
1220 "KiCad exited before saving.\n"
1221 "\n"
1222 "Do you wish to open the auto-saved file instead?" ),
1223 aFileName.GetFullName() );
1224
1225 int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
1226 this );
1227
1228 // Make a backup of the current file, delete the file, and rename the auto save file to
1229 // the file name.
1230 if( response == wxYES )
1231 {
1232 if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1233 {
1234 wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1235 Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1236 }
1237 }
1238 else
1239 {
1240 wxLogTrace( traceAutoSave,
1241 wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1242
1243 // Remove the auto save file when using the previous file as is.
1244 wxRemoveFile( autoSaveFileName.GetFullPath() );
1245 }
1246}
static wxString GetAutoSaveFilePrefix()
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:111

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ ClearFileHistory()

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

Removes all files from the file history.

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

Definition at line 956 of file eda_base_frame.cpp.

957{
958 if( !aFileHistory )
959 aFileHistory = m_fileHistory;
960
961 wxASSERT( aFileHistory );
962
963 aFileHistory->ClearFileHistory();
964
965 // Update the menubar to update the file history menu
966 if( GetMenuBar() )
967 {
969 GetMenuBar()->Refresh();
970 }
971}
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.
void ClearFileHistory()
Clear all entries from the file history.

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

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

◆ ClearMsgPanel()

◆ 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.
aItemCountnumber 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 909 of file pl_editor_frame.cpp.

910{
911 if( aItemCount == 0 )
912 return;
913
914 UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
915 unsigned icnt = list.m_CommandsList.size();
916
917 if( aItemCount > 0 )
918 icnt = aItemCount;
919
920 for( unsigned ii = 0; ii < icnt; ii++ )
921 {
922 if( list.m_CommandsList.size() == 0 )
923 break;
924
925 PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
926 list.m_CommandsList.erase( list.m_CommandsList.begin() );
927
928 curr_cmd->ClearListAndDeleteItems();
929 delete curr_cmd; // Delete command
930 }
931}
UNDO_REDO_CONTAINER m_undoList
UNDO_REDO_CONTAINER m_redoList
A holder to handle information on schematic or board items.
void ClearListAndDeleteItems()
Delete the list of pickers AND the data pointed by #m_PickedItem or #m_PickedItemLink according to th...
A holder to handle a list of undo (or redo) commands.
std::vector< PICKED_ITEMS_LIST * > m_CommandsList

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

◆ commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T  aFrameType)
privateinherited

Collect common initialization functions used in all CTORs.

Definition at line 117 of file eda_base_frame.cpp.

118{
119 m_ident = aFrameType;
120 m_maximizeByDefault = false;
121 m_infoBar = nullptr;
122 m_settingsManager = nullptr;
123 m_fileHistory = nullptr;
124 m_supportsAutoSave = false;
125 m_autoSavePending = false;
127 m_isClosing = false;
128 m_isNonUserClose = false;
129 m_autoSaveTimer = new wxTimer( this, ID_AUTO_SAVE_TIMER );
130 m_autoSaveRequired = false;
132 m_frameSize = defaultSize( aFrameType );
133 m_displayIndex = -1;
134
135 m_auimgr.SetArtProvider( new WX_AUI_DOCK_ART() );
136
137 m_settingsManager = &Pgm().GetSettingsManager();
138
139 // Set a reasonable minimal size for the frame
140 SetSizeHints( minSize( aFrameType ).x, minSize( aFrameType ).y, -1, -1, -1, -1 );
141
142 // Store dimensions of the user area of the main window.
143 GetClientSize( &m_frameSize.x, &m_frameSize.y );
144
145 Connect( ID_AUTO_SAVE_TIMER, wxEVT_TIMER,
146 wxTimerEventHandler( EDA_BASE_FRAME::onAutoSaveTimer ) );
147
148 // hook wxEVT_CLOSE_WINDOW so we can call SaveSettings(). This function seems
149 // to be called before any other hook for wxCloseEvent, which is necessary.
150 Connect( wxEVT_CLOSE_WINDOW, wxCloseEventHandler( EDA_BASE_FRAME::windowClosing ) );
151
152 initExitKey();
153}
void windowClosing(wxCloseEvent &event)
(with its unexpected name so it does not collide with the real OnWindowClose() function provided in d...
void initExitKey()
Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
WX_INFOBAR * m_infoBar
void onAutoSaveTimer(wxTimerEvent &aEvent)
Handle the auto save timer event.
wxTimer * m_autoSaveTimer
SETTINGS_MANAGER * m_settingsManager
bool m_isClosing
Set by NonUserClose() to indicate that the user did not request the current close.
wxString m_mruPath
static wxString GetDefaultUserProjectsPath()
Gets the default path we point users to create projects.
Definition: paths.cpp:139
static const wxSize minSize(FRAME_T aFrameType)
static const wxSize defaultSize(FRAME_T aFrameType)
#define DEFAULT_MAX_UNDO_ITEMS
@ ID_AUTO_SAVE_TIMER
Definition: id.h:79

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

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ CommonSettingsChanged()

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

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

Update menus, toolbars, local variables, etc.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 604 of file pl_editor_frame.cpp.

605{
606 EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
607
608 SETTINGS_MANAGER& settingsManager = Pgm().GetSettingsManager();
609 PL_EDITOR_SETTINGS* cfg = settingsManager.GetAppSettings<PL_EDITOR_SETTINGS>();
610 COLOR_SETTINGS* colors = settingsManager.GetColorSettings( cfg->m_ColorTheme );
611
612 GetCanvas()->GetView()->GetPainter()->GetSettings()->LoadColors( colors );
613
616
618 Layout();
619 SendSizeEvent();
620}
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:187
Color settings are a bit different than most of the settings objects in that there can be more than o...
void RecreateToolbars()
Rebuild all toolbars, and update the checked state of check tools.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
void ForceRefresh()
Force a redraw.
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
virtual void LoadColors(const COLOR_SETTINGS *aSettings)
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
Definition: view.cpp:1478
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:213
T * GetAppSettings(bool aLoadNow=true)
Returns a handle to the a given settings by type If the settings have already been loaded,...
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
@ COLOR
Color has changed.
Definition: view_item.h:48

References KIGFX::COLOR, EDA_DRAW_FRAME::CommonSettingsChanged(), EDA_DRAW_PANEL_GAL::ForceRefresh(), 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(), 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 796 of file eda_base_frame.cpp.

797{
798 // KICAD_MANAGER_FRAME overrides this
799 return Kiface().KifaceSettings();
800}
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:93

References Kiface(), and KIFACE_BASE::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(), SIM_PLOT_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_EDIT_FRAME::GetRotationAngle(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), GERBVIEW_FRAME::gvconfig(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), setupTools(), PCB_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), GRID_MENU::update(), ZOOM_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), 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 341 of file eda_base_frame.h.

342 {
343 wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
344 return baseCfgName;
345 }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

Definition at line 821 of file eda_base_frame.cpp.

822{
823#if defined( __WXOSX_MAC__ )
825#else
826 m_infoBar = new WX_INFOBAR( this, &m_auimgr );
827
828 m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
829#endif
830}
virtual wxWindow * GetToolCanvas() const =0
Canvas access.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:75

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

Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ CreateServer()

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

Definition at line 43 of file eda_dde.cpp.

44{
45 wxIPV4address addr;
46
47 // Set the port number
48 addr.Service( service );
49
50 // Listen on localhost only if requested
51 if( local )
52 addr.Hostname( HOSTNAME );
53
54 if( m_socketServer )
55 {
56 // this helps prevent any events that could come in during deletion
57 m_socketServer->Notify( false );
58 delete m_socketServer;
59 }
60
61 m_socketServer = new wxSocketServer( addr );
62
63 m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
64 m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
65 m_socketServer->Notify( true );
66}
wxSocketServer * m_socketServer
Definition: kiway_player.h:204
static const wxString HOSTNAME(wxT("localhost"))
@ ID_EDA_SOCKET_EVENT_SERV
Definition: id.h:163

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

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

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const
inherited

Definition at line 110 of file tools_holder.cpp.

111{
112 if( m_toolStack.empty() )
114 else
115 return m_toolStack.back();
116}
static TOOL_ACTION selectionTool
Definition: actions.h:156
std::vector< std::string > m_toolStack
Definition: tools_holder.h:176
const std::string & GetName() const
Return name of the action.
Definition: tool_action.h:101

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

Referenced by TOOLS_HOLDER::ShowChangedLanguage().

◆ DECLARE_EVENT_TABLE()

PL_EDITOR_FRAME::DECLARE_EVENT_TABLE ( )
protected

◆ Destroy()

◆ DismissModal()

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

Definition at line 182 of file kiway_player.cpp.

183{
184 m_modal_ret_val = aRetVal;
185 m_modal_string = aResult;
186
187 if( m_modal_loop )
188 {
189 m_modal_loop->Exit();
190 m_modal_loop = nullptr; // this marks it as dismissed.
191 }
192
193 Show( false );
194}
wxString m_modal_string
Definition: kiway_player.h:201
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:199
bool m_modal_ret_val
Definition: kiway_player.h:202

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

◆ DisplayConstraintsMsg()

void EDA_DRAW_FRAME::DisplayConstraintsMsg ( const wxString &  msg)
inherited

Definition at line 582 of file eda_draw_frame.cpp.

583{
584 SetStatusText( msg, 7 );
585}

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

◆ DisplayGridMsg()

void PL_EDITOR_FRAME::DisplayGridMsg ( )
overridevirtual

Display current grid size in the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 663 of file pl_editor_frame.cpp.

664{
665 wxString line;
666 wxString gridformatter;
667
668 switch( GetUserUnits() )
669 {
670 case EDA_UNITS::INCHES: gridformatter = "grid %.3f"; break;
671 case EDA_UNITS::MILLIMETRES: gridformatter = "grid %.4f"; break;
672 default: gridformatter = "grid %f"; break;
673 }
674
676 GetCanvas()->GetGAL()->GetGridSize().x );
677 line.Printf( gridformatter, grid );
678
679 SetStatusText( line, 4 );
680}
EDA_UNITS GetUserUnits() const
double ToUserUnit(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnit, double aValue)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: eda_units.cpp:194

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

Referenced by UpdateStatusBar().

◆ DisplayToolMsg()

void EDA_DRAW_FRAME::DisplayToolMsg ( const wxString &  msg)
overridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 576 of file eda_draw_frame.cpp.

577{
578 SetStatusText( msg, 6 );
579}

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

599{
600 wxString msg;
601
602 switch( GetUserUnits() )
603 {
604 case EDA_UNITS::INCHES: msg = _( "inches" ); break;
605 case EDA_UNITS::MILS: msg = _( "mils" ); break;
606 case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
607 default: msg = _( "Units" ); break;
608 }
609
610 SetStatusText( msg, 5 );
611}

References _, UNITS_PROVIDER::GetUserUnits(), INCHES, 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 318 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void PL_EDITOR_FRAME::doCloseWindow ( )
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 397 of file pl_editor_frame.cpp.

398{
399 // do not show the window because we do not want any paint event
400 Show( false );
401
402 // clean up the data before the view is destroyed
404
405 // On Linux, m_propertiesPagelayout must be destroyed
406 // before deleting the main frame to avoid a crash when closing
407 m_propertiesPagelayout->Destroy();
408 Destroy();
409}
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.

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

◆ DoWithAcceptedFiles()

void PL_EDITOR_FRAME::DoWithAcceptedFiles ( )
overrideprivatevirtual

Execute action on accepted dropped file.

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

Reimplemented from EDA_BASE_FRAME.

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

324{
325 for( const wxFileName& file : m_AcceptedFiles )
326 OpenProjectFiles( { file.GetFullPath() }, KICTL_CREATE );
327}
std::vector< wxFileName > m_AcceptedFiles
bool OpenProjectFiles(const std::vector< wxString > &aFileSet, int aCtl) override
Open a project or set of files given by aFileList.
#define KICTL_CREATE
caller thinks requested project files may not exist.
Definition: kiway_player.h:82

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

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )
protectedinherited

Definition at line 648 of file eda_base_frame.cpp.

649{
650 wxDisplay display( wxDisplay::GetFromWindow( this ) );
651 wxRect clientSize = display.GetClientArea();
652 wxPoint pos = GetPosition();
653 wxSize size = GetWindowSize();
654
655 wxLogTrace( traceDisplayLocation,
656 "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d", clientSize.x, clientSize.y,
657 clientSize.width, clientSize.height );
658
659 if( pos.y < clientSize.y )
660 {
661 wxLogTrace( traceDisplayLocation,
662 "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d", pos.y,
663 clientSize.y );
664 pos.y = clientSize.y;
665 }
666
667 if( pos.x < clientSize.x )
668 {
669 wxLogTrace( traceDisplayLocation,
670 "ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d", pos.x,
671 clientSize.x );
672 pos.x = clientSize.x;
673 }
674
675 if( pos.x + size.x - clientSize.x > clientSize.width )
676 {
677 int newWidth = clientSize.width - ( pos.x - clientSize.x );
678 wxLogTrace( traceDisplayLocation,
679 "ensureWindowIsOnScreen: effective width %d above available %d, setting to %d",
680 pos.x + size.x, clientSize.width, newWidth );
681 size.x = newWidth;
682 }
683
684 if( pos.y + size.y - clientSize.y > clientSize.height )
685 {
686 int newHeight = clientSize.height - ( pos.y - clientSize.y );
687 wxLogTrace( traceDisplayLocation,
688 "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d",
689 pos.y + size.y, clientSize.height, newHeight );
690 size.y = newHeight;
691 }
692
693 wxLogTrace( traceDisplayLocation, "Updating window position (%d, %d) with size (%d, %d)",
694 pos.x, pos.y, size.x, size.y );
695
696 SetSize( pos.x, pos.y, size.x, size.y );
697}
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

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

182{}

Referenced by KIWAY_PLAYER::OnSockRequest().

◆ Files_io()

void PL_EDITOR_FRAME::Files_io ( wxCommandEvent &  event)

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

96{
97 wxString msg;
98 int id = event.GetId();
99 wxString filename = GetCurrentFileName();
101
102 if( filename.IsEmpty() && id == wxID_SAVE )
103 id = wxID_SAVEAS;
104
105 if( ( id == wxID_NEW || id == wxID_OPEN ) && IsContentModified() )
106 {
107 if( !HandleUnsavedChanges( this, _( "The current drawing sheet has been modified. "
108 "Save changes?" ),
109 [&]() -> bool
110 {
111 return saveCurrentPageLayout();
112 } ) )
113 {
114 return;
115 }
116 }
117
118 switch( id )
119 {
120 case wxID_NEW:
121 pglayout.AllowVoidList( true );
122 SetCurrentFileName( wxEmptyString );
123 pglayout.ClearList();
125 break;
126
128 {
129 wxFileDialog openFileDialog( this, _( "Append Existing Drawing Sheet" ),
130 wxEmptyString, wxEmptyString,
131 DrawingSheetFileWildcard(), wxFD_OPEN );
132
133 if( openFileDialog.ShowModal() == wxID_CANCEL )
134 return;
135
136 filename = openFileDialog.GetPath();
137
138 if( !InsertDrawingSheetFile( filename ) )
139 {
140 msg.Printf( _( "Unable to load %s file" ), filename );
141 DisplayErrorMessage( this, msg );
142 }
143 else
144 {
146 HardRedraw();
147 msg.Printf( _( "File \"%s\" inserted" ), filename );
148 SetStatusText( msg );
149 }
150 }
151 break;
152
153 case wxID_OPEN:
154 {
155 wxFileDialog openFileDialog( this, _( "Open" ), wxEmptyString, wxEmptyString,
156 DrawingSheetFileWildcard(), wxFD_OPEN );
157
158 if( openFileDialog.ShowModal() == wxID_CANCEL )
159 return;
160
161 filename = openFileDialog.GetPath();
162
163 if( !LoadDrawingSheetFile( filename ) )
164 {
165 msg.Printf( _( "Unable to load %s file" ), filename );
166 DisplayErrorMessage( this, msg );
167 }
168 else
169 {
171 msg.Printf( _( "File \"%s\" saved." ), filename );
172 SetStatusText( msg );
173 }
174 }
175 break;
176
177 case wxID_SAVE:
178 if( !SaveDrawingSheetFile( filename ) )
179 {
180 msg.Printf( _( "Unable to write '%s'." ), filename );
181 DisplayErrorMessage( this, msg );
182 }
183 else
184 {
185 msg.Printf( _("File '%s' saved."), filename );
186 SetStatusText( msg );
187 }
188 break;
189
190 case wxID_SAVEAS:
191 {
192 wxString dir = PATHS::GetUserTemplatesPath();
193 wxFileDialog openFileDialog( this, _( "Save As" ), dir, wxEmptyString,
195 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
196
197 if( openFileDialog.ShowModal() == wxID_CANCEL )
198 return;
199
200 filename = openFileDialog.GetPath();
201 // Ensure the file has the right extension:
202 // because a name like name.subname.subsubname is legal,
203 // add the right extension without replacing the wxFileName
204 // extension
205 wxFileName fn(filename);
206
207 if( fn.GetExt() != DrawingSheetFileExtension )
208 filename << wxT(".") << DrawingSheetFileExtension;
209
210 if( !SaveDrawingSheetFile( filename ) )
211 {
212 msg.Printf( _( "Failed to create file '%s'." ), filename );
213 DisplayErrorMessage( this, msg );
214 }
215
216 else
217 {
218 msg.Printf( _("File \"%s\" saved."), filename );
219 SetStatusText( msg );
220
221 if( GetCurrentFileName().IsEmpty() )
222 SetCurrentFileName( filename );
223 }
224 }
225 break;
226
227 default:
228 break;
229 }
230}
void SetContentModified(bool aModified=true)
Definition: base_screen.h:59
Handle the graphic items list to draw/plot the frame and title block.
Definition: ds_data_model.h:39
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
static wxString GetUserTemplatesPath()
Gets the user path for custom templates.
Definition: paths.cpp:86
void SetCurrentFileName(const wxString &aName)
Store the current layout description file filename.
bool SaveDrawingSheetFile(const wxString &aFullFileName)
Save the current layout in a .kicad_wks drawing sheet file.
bool InsertDrawingSheetFile(const wxString &aFullFileName)
Load a .kicad_wks drawing sheet file, and add items to the current layout list.
void HardRedraw() override
Refresh the library tree and redraw the window.
bool LoadDrawingSheetFile(const wxString &aFullFileName)
Load a .kicad_wks drawing sheet file.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:299
wxString DrawingSheetFileWildcard()
@ ID_APPEND_DESCR_FILE
Definition: pl_editor_id.h:41

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

◆ findDialogs()

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

Definition at line 908 of file eda_draw_frame.cpp.

909{
910 std::vector<wxWindow*> dialogs;
911
912 for( wxWindow* window : GetChildren() )
913 {
914 if( dynamic_cast<DIALOG_SHIM*>( window ) )
915 dialogs.push_back( window );
916 }
917
918 return dialogs;
919}
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition: dialog_shim.h:83

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

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )
privateinherited

Definition at line 169 of file eda_base_frame.cpp.

170{
171 for( wxWindow* iter : GetChildren() )
172 {
173 DIALOG_SHIM* dlg = dynamic_cast<DIALOG_SHIM*>( iter );
174
175 if( dlg && dlg->IsQuasiModal() )
176 return dlg;
177 }
178
179 // FIXME: CvPcb is currently implemented on top of KIWAY_PLAYER rather than DIALOG_SHIM,
180 // so we have to look for it separately.
181 if( m_ident == FRAME_SCH )
182 {
183 wxWindow* cvpcb = wxWindow::FindWindowByName( "CvpcbFrame" );
184
185 if( cvpcb )
186 return cvpcb;
187 }
188
189 return nullptr;
190}
bool IsQuasiModal() const
Definition: dialog_shim.h:106
@ FRAME_SCH
Definition: frame_type.h:34

References FRAME_SCH, DIALOG_SHIM::IsQuasiModal(), and EDA_BASE_FRAME::m_ident.

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

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 833 of file eda_base_frame.cpp.

834{
835#if defined( __WXOSX_MAC__ )
836 m_auimgr.Update();
837#else
838 // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
839 // hiding it.
840 m_auimgr.Update();
841
842 // We don't want the infobar displayed right away
843 m_auimgr.GetPane( "InfoBar" ).Hide();
844 m_auimgr.Update();
845#endif
846}

References EDA_BASE_FRAME::m_auimgr.

Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const VECTOR2I aPos)
inherited

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

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

Parameters
aPosis the point to go to.

Definition at line 922 of file eda_draw_frame.cpp.

923{
924 bool centerView = false;
926
927 // Center if we're off the current view, or within 10% of its edge
928 r.Inflate( - (int) r.GetWidth() / 10 );
929
930 if( !r.Contains( aPos ) )
931 centerView = true;
932
933 std::vector<BOX2D> dialogScreenRects;
934
935 for( wxWindow* dialog : findDialogs() )
936 {
937 dialogScreenRects.emplace_back( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
938 dialog->GetSize() );
939 }
940
941 // Center if we're behind an obscuring dialog, or within 10% of its edge
942 for( BOX2D rect : dialogScreenRects )
943 {
944 rect.Inflate( rect.GetWidth() / 10 );
945
946 if( rect.Contains( GetCanvas()->GetView()->ToScreen( aPos ) ) )
947 centerView = true;
948 }
949
950 if( centerView )
951 {
952 try
953 {
954 GetCanvas()->GetView()->SetCenter( aPos, dialogScreenRects );
955 }
956 catch( const ClipperLib::clipperException& exc )
957 {
958 wxLogError( wxT( "Clipper library error '%s' occurred centering object." ),
959 exc.what() );
960 }
961 }
962
964}
std::vector< wxWindow * > findDialogs()
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Move the graphic crosshair cursor to the requested position expressed in world coordinates.
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition: view.cpp:508
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:574
E_SERIE r
Definition: eserie.cpp:41

References EDA_DRAW_FRAME::findDialogs(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), KIGFX::VIEW::GetViewport(), r, KIGFX::VIEW::SetCenter(), and KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition().

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

◆ GetAboutTitle()

const wxString & EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )
inlinestaticprotectedinherited

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inherited

Definition at line 298 of file eda_base_frame.cpp.

299{
300 return Pgm().GetCommonSettings()->m_System.autosave_interval;
301}

References Pgm().

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

◆ GetCanvas()

◆ GetColorSettings()

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

Returns a pointer to the active color theme settings.

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

Definition at line 1120 of file eda_draw_frame.cpp.

1121{
1122 if( !m_colorSettings || aForceRefresh )
1123 {
1124 COLOR_SETTINGS* colorSettings = Pgm().GetSettingsManager().GetColorSettings();
1125
1126 const_cast<EDA_DRAW_FRAME*>( this )->m_colorSettings = colorSettings;
1127 }
1128
1129 return m_colorSettings;
1130}
The base class for create windows for drawing purpose.
COLOR_SETTINGS * m_colorSettings

References EDA_DRAW_FRAME::m_colorSettings, and Pgm().

Referenced by DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ GetCurrentFileName()

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 556 of file pl_editor_frame.cpp.

557{
559}
static wxString m_DrawingSheetFileName
the name of the drawing sheet file, or empty to use the default drawing sheet
Definition: base_screen.h:85

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

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

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

476{
478 return rv;
479}
const PAGE_INFO & GetPageSettings() const override
VECTOR2< int > VECTOR2I
Definition: vector2d.h:618

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

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

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

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

Definition at line 141 of file tools_holder.h.

141{ return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:183

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

147{ return m_dragAction; }
MOUSE_DRAG_ACTION m_dragAction
Definition: tools_holder.h:187

References TOOLS_HOLDER::m_dragAction.

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

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

◆ 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
cmdIdThe command ID associated with the aFileHistory object.
typePlease document me!
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used
Returns
a wxString containing the selected filename

Definition at line 916 of file eda_base_frame.cpp.

918{
919 if( !aFileHistory )
920 aFileHistory = m_fileHistory;
921
922 wxASSERT( aFileHistory );
923
924 int baseId = aFileHistory->GetBaseId();
925
926 wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
927
928 unsigned i = cmdId - baseId;
929
930 if( i < aFileHistory->GetCount() )
931 {
932 wxString fn = aFileHistory->GetHistoryFile( i );
933
934 if( wxFileName::FileExists( fn ) )
935 {
936 return fn;
937 }
938 else
939 {
940 DisplayErrorMessage( this, wxString::Format( _( "File '%s' was not found." ), fn ) );
941 aFileHistory->RemoveFileFromHistory( i );
942 }
943 }
944
945 // Update the menubar to update the file history menu
946 if( GetMenuBar() )
947 {
949 GetMenuBar()->Refresh();
950 }
951
952 return wxEmptyString;
953}

References _, DisplayErrorMessage(), 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 406 of file eda_base_frame.h.

407 {
408 return *m_fileHistory;
409 }

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString & EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

◆ GetFindReplaceData()

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const
inlineinherited

Definition at line 198 of file eda_base_frame.h.

198{ return m_ident; }

References EDA_BASE_FRAME::m_ident.

Referenced by PCB_BASE_FRAME::GetViewerSettingsBase(), and EDA_BASE_FRAME::OnPreferences().

◆ GetGalDisplayOptions()

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )
inlinevirtualinherited

◆ GetGridOrigin()

const VECTOR2I & PL_EDITOR_FRAME::GetGridOrigin ( ) const
inlineoverridevirtual

Return the absolute coordinates of the origin of the snap grid.

This is treated as a relative offset and snapping will occur at multiples of the grid size relative to this point.

Implements EDA_DRAW_FRAME.

Definition at line 110 of file pl_editor_frame.h.

110{ return m_grid_origin; }
VECTOR2I m_grid_origin

References m_grid_origin.

◆ GetInfoBar()

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

391{ return nullptr; }

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

◆ GetIuScale()

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

53{
55
56 if ( GetRedoCommandCount() <= 0 )
57 return;
58
60 DS_PROXY_UNDO_ITEM* redoItem = static_cast<DS_PROXY_UNDO_ITEM*>( redoWrapper.GetItem() );
61 bool pageSettingsAndTitleBlock = redoItem->Type() == WS_PROXY_UNDO_ITEM_PLUS_T;
62
63 PICKED_ITEMS_LIST* undoCmd = new PICKED_ITEMS_LIST();
64 DS_PROXY_UNDO_ITEM* undoItem = new DS_PROXY_UNDO_ITEM( pageSettingsAndTitleBlock ? this : nullptr );
65 ITEM_PICKER undoWrapper( GetScreen(), undoItem );
66
67 undoCmd->PushItem( undoWrapper );
68 PushCommandToUndoList( undoCmd );
69
70 selTool->ClearSelection();
71 redoItem->Restore( this, GetCanvas()->GetView() );
72 selTool->RebuildSelection();
73
74 delete redoItem;
75
76 if( pageSettingsAndTitleBlock )
77 HardRedraw(); // items based off of corners will need re-calculating
78 else
79 GetCanvas()->Refresh();
80
81 OnModify();
82}
void Restore(EDA_DRAW_FRAME *aFrame, KIGFX::VIEW *aView=nullptr)
virtual void PushCommandToUndoList(PICKED_ITEMS_LIST *aItem)
Add a command to undo in the undo list.
virtual int GetRedoCommandCount() const
virtual PICKED_ITEMS_LIST * PopCommandFromRedoList()
Return the last command to undo and remove it from list, nothing is deleted.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
EDA_ITEM * GetItem() const
void PushItem(const ITEM_PICKER &aItem)
Push aItem to the top of the list.
void OnModify() override
Must be called after a change in order to set the "modify" flag.
int ClearSelection(const TOOL_EVENT &aEvent)
void RebuildSelection()
Rebuild the selection from the flags in the view items.
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
@ WS_PROXY_UNDO_ITEM_PLUS_T
Definition: typeinfo.h:230

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.

90{
92
93 if ( GetUndoCommandCount() <= 0 )
94 return;
95
97 DS_PROXY_UNDO_ITEM* undoItem = static_cast<DS_PROXY_UNDO_ITEM*>( undoWrapper.GetItem() );
98 bool pageSettingsAndTitleBlock = undoItem->Type() == WS_PROXY_UNDO_ITEM_PLUS_T;
99
100 PICKED_ITEMS_LIST* redoCmd = new PICKED_ITEMS_LIST();
101 DS_PROXY_UNDO_ITEM* redoItem = new DS_PROXY_UNDO_ITEM( pageSettingsAndTitleBlock ? this : nullptr );
102 ITEM_PICKER redoWrapper( GetScreen(), redoItem );
103
104 redoCmd->PushItem( redoWrapper );
105 PushCommandToRedoList( redoCmd );
106
107 selTool->ClearSelection();
108 undoItem->Restore( this, GetCanvas()->GetView() );
109 selTool->RebuildSelection();
110
111 delete undoItem;
112
113 if( pageSettingsAndTitleBlock )
114 HardRedraw(); // items based off of corners will need re-calculating
115 else
116 GetCanvas()->Refresh();
117
118 OnModify();
119}
virtual PICKED_ITEMS_LIST * PopCommandFromUndoList()
Return the last command to undo and remove it from list, nothing is deleted.
virtual int GetUndoCommandCount() const
virtual void PushCommandToRedoList(PICKED_ITEMS_LIST *aItem)
Add a command to redo in the redo list.

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

565{ 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 153 of file tools_holder.h.

153{ return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:189

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

◆ GetNearestGridPosition()

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

Return the nearest aGridSize location to aPosition.

Parameters
aPositionThe position to check.
Returns
The nearest grid position.

Definition at line 861 of file eda_draw_frame.cpp.

862{
863 const VECTOR2I& gridOrigin = GetGridOrigin();
864 VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
865
866 double xOffset = fmod( gridOrigin.x, gridSize.x );
867 int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
868 double yOffset = fmod( gridOrigin.y, gridSize.y );
869 int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
870
871 return VECTOR2I( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
872}
virtual const VECTOR2I & GetGridOrigin() const =0
Return the absolute coordinates of the origin of the snap grid.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
const VECTOR2D & GetGridSize() const
Return the grid size.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:85

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

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

◆ GetNearestHalfGridPosition()

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

Return the nearest aGridSize / 2 location to aPosition.

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

Parameters
aPositionThe position to check.
Returns
The nearest half-grid position.

Definition at line 875 of file eda_draw_frame.cpp.

876{
877 const VECTOR2I& gridOrigin = GetGridOrigin();
878 VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize() / 2.0;
879
880 double xOffset = fmod( gridOrigin.x, gridSize.x );
881 int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
882 double yOffset = fmod( gridOrigin.y, gridSize.y );
883 int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
884
885 return VECTOR2I( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
886}

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

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

◆ GetOriginTransforms()

virtual ORIGIN_TRANSFORMS & EDA_BASE_FRAME::GetOriginTransforms ( )
inlinevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented in PCB_BASE_FRAME.

Definition at line 130 of file eda_base_frame.h.

130{ return m_originTransforms; }
ORIGIN_TRANSFORMS m_originTransforms

References EDA_BASE_FRAME::m_originTransforms.

Referenced by PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), EDA_SHAPE::ShapeGetMsgPanelInfo(), and PROPERTIES_PANEL::update().

◆ GetPageLayout() [1/2]

PL_EDITOR_LAYOUT & PL_EDITOR_FRAME::GetPageLayout ( )
inline

Definition at line 148 of file pl_editor_frame.h.

148{ return m_pageLayout; }
PL_EDITOR_LAYOUT m_pageLayout

References m_pageLayout.

◆ GetPageLayout() [2/2]

const PL_EDITOR_LAYOUT & PL_EDITOR_FRAME::GetPageLayout ( ) const
inline

Definition at line 147 of file pl_editor_frame.h.

147{ return m_pageLayout; }

References m_pageLayout.

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

◆ GetPageNumberOption()

bool PL_EDITOR_FRAME::GetPageNumberOption ( ) const

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

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

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

Definition at line 934 of file pl_editor_frame.cpp.

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

References m_pageSelectBox.

Referenced by PrintPage().

◆ GetPageSettings()

const PAGE_INFO & PL_EDITOR_FRAME::GetPageSettings ( ) const
overridevirtual

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

584{
585 // this function is only needed because EDA_DRAW_FRAME is not compiled
586 // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
587 // into an application specific source file.
589}

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

Referenced by DIALOG_INSPECTOR::ReCreateDesignList().

◆ GetPropertiesFrame()

PROPERTIES_FRAME * PL_EDITOR_FRAME::GetPropertiesFrame ( )
inline

◆ GetRedoCommandCount()

◆ GetScreen()

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1026 of file eda_draw_frame.cpp.

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

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

◆ GetSettingsManager()

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int  aErrorCode) const
inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 135 of file eda_base_frame.h.

135{ return RPT_SEVERITY_UNDEFINED; }
@ 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 120 of file eda_draw_frame.h.

120{ 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 592 of file pl_editor_frame.cpp.

593{
594 return GetPageLayout().GetTitleBlock();
595}
TITLE_BLOCK & GetTitleBlock()

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

◆ GetToolCanvas()

wxWindow * EDA_DRAW_FRAME::GetToolCanvas ( ) const
inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 418 of file eda_draw_frame.h.

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

54{ 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(), SCH_NAVIGATE_TOOL::Back(), BOARD_COMMIT::BOARD_COMMIT(), SCH_NAVIGATE_TOOL::changeSheet(), 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::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_NAVIGATE_TOOL::Forward(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineBreakTrack(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnDeleteOneClick(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), GERBER_LAYER_WIDGET::onPopupSelection(), SIM_PLOT_FRAME::onProbe(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_PANEL::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), PCB_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), PANEL_KICAD_LAUNCHER::PANEL_KICAD_LAUNCHER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), Refresh(), RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), DIALOG_FIND::search(), FOOTPRINT_SEARCH_HANDLER::SelectItems(), ZONE_SEARCH_HANDLER::SelectItems(), TEXT_SEARCH_HANDLER::SelectItems(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), PCB_PROPERTIES_PANEL::UpdateData(), DIALOG_DRC::updateDisplayedCounts(), CVPCB_MAINFRAME::updateFootprintViewerOnIdle(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), PCB_PROPERTIES_PANEL::valueChanged(), DIALOG_NETLIST_IMPORT::~DIALOG_NETLIST_IMPORT(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 46 of file kiway_holder.h.

46{ return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:85

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

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

1156{
1158
1159 aPrimaryUnit = GetUserUnits();
1160 aSecondaryUnits = EDA_UNITS::MILS;
1161
1162 if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
1163 {
1164 if( cmnTool )
1165 aSecondaryUnits = cmnTool->GetLastMetricUnits();
1166 else
1167 aSecondaryUnits = EDA_UNITS::MILLIMETRES;
1168 }
1169 else
1170 {
1171 if( cmnTool )
1172 aSecondaryUnits = cmnTool->GetLastImperialUnits();
1173 else
1174 aSecondaryUnits = EDA_UNITS::MILS;
1175 }
1176}
EDA_UNITS GetLastImperialUnits()
Definition: common_tools.h:77
EDA_UNITS GetLastMetricUnits()
Definition: common_tools.h:76
bool IsImperialUnit(EDA_UNITS aUnit)
Definition: eda_units.cpp:29

References COMMON_TOOLS::GetLastImperialUnits(), COMMON_TOOLS::GetLastMetricUnits(), TOOL_MANAGER::GetTool(), UNITS_PROVIDER::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 UNITS_PROVIDER::GetUserUnits ( ) const
inlineinherited

Definition at line 37 of file units_provider.h.

37{ return m_userUnits; }
EDA_UNITS m_userUnits

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), PCB_EDIT_FRAME::GenFootprintsReport(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), WX_GRID::GetUnitValue(), GetUserUnits(), UNIT_BINDER::init(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), SCH_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), WX_GRID::SetUnitsProvider(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), UNITS_PROVIDER::StringFromValue(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), PROPERTIES_PANEL::update(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and UNITS_PROVIDER::ValueFromString().

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
virtualinherited

Return a pointer to the window settings for this frame.

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

Parameters
aCfgis this frame's config object

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

Definition at line 790 of file eda_base_frame.cpp.

791{
792 return &aCfg->m_Window;
793}
WINDOW_SETTINGS m_Window
Definition: app_settings.h:184

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

1355{
1356#ifdef __WXGTK__
1357 wxSize winSize = GetSize();
1358
1359 // GTK includes the window decorations in the normal GetSize call,
1360 // so we have to use a GTK-specific sizing call that returns the
1361 // non-decorated window size.
1363 {
1364 int width = 0;
1365 int height = 0;
1366 GTKDoGetSize( &width, &height );
1367
1368 winSize.Set( width, height );
1369 }
1370#else
1371 wxSize winSize = GetSize();
1372#endif
1373
1374 return winSize;
1375}
@ KICAD_MAIN_FRAME_T
Definition: frame_type.h:64

References KICAD_MAIN_FRAME_T, and EDA_BASE_FRAME::m_ident.

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

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const
inherited

Return a human readable value for display in dialogs.

Definition at line 636 of file eda_draw_frame.cpp.

637{
638 // returns a human readable value which can be displayed as zoom
639 // level indicator in dialogs.
640 double zoom = m_canvas->GetGAL()->GetZoomFactor();
641 return wxString::Format( wxT( "Z %.2f" ), zoom );
642}
EDA_DRAW_PANEL_GAL * m_canvas
This the frame's interface to setting GAL display options.
double GetZoomFactor() const

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

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

◆ handleActivateEvent()

void EDA_DRAW_FRAME::handleActivateEvent ( wxActivateEvent &  aEvent)
protectedvirtualinherited

Handle a window activation event.

Reimplemented in SCH_BASE_FRAME, PCB_BASE_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 1207 of file eda_draw_frame.cpp.

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

References EDA_DRAW_FRAME::m_messagePanel.

Referenced by SCH_BASE_FRAME::handleActivateEvent(), PCB_BASE_FRAME::handleActivateEvent(), and EDA_DRAW_FRAME::onActivate().

◆ handleIconizeEvent()

virtual void EDA_BASE_FRAME::handleIconizeEvent ( wxIconizeEvent &  aEvent)
inlineprotectedvirtualinherited

Handle a window iconize event.

Parameters
aEventis the data for the event.

Reimplemented in EDA_3D_VIEWER_FRAME, SCH_BASE_FRAME, and PCB_BASE_FRAME.

Definition at line 607 of file eda_base_frame.h.

607{}

Referenced by EDA_3D_VIEWER_FRAME::handleIconizeEvent(), SCH_BASE_FRAME::handleIconizeEvent(), PCB_BASE_FRAME::handleIconizeEvent(), and EDA_BASE_FRAME::onIconize().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )
virtualinherited

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

Definition at line 1378 of file eda_base_frame.cpp.

1379{
1380 // Update the icon theme when the system theme changes and update the toolbars
1382 ThemeChanged();
1383
1384 // This isn't handled by ThemeChanged()
1385 if( GetMenuBar() )
1386 {
1387 // For icons in menus, icon scaling & hotkeys
1389 GetMenuBar()->Refresh();
1390 }
1391}
BITMAP_STORE * GetBitmapStore()
Definition: bitmap.cpp:93
void ThemeChanged()
Notifies the store that the icon theme has been changed by the user, so caches must be invalidated.
virtual void ThemeChanged()
Process light/dark theme change.

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

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

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

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

enabled, checked, etc.).

Parameters
aEventis the wxUpdateUIEvent to be processed.
aFrameis the frame to get the selection from
aCondare the #UI SELECTION_CONDITIONS used

Definition at line 367 of file eda_base_frame.cpp.

369{
370 bool checkRes = false;
371 bool enableRes = true;
372 bool showRes = true;
373 bool isCut = aEvent.GetId() == ACTIONS::cut.GetUIId();
374 bool isCopy = aEvent.GetId() == ACTIONS::copy.GetUIId();
375 bool isPaste = aEvent.GetId() == ACTIONS::paste.GetUIId();
376 SELECTION& selection = aFrame->GetCurrentSelection();
377
378 try
379 {
380 checkRes = aCond.checkCondition( selection );
381 enableRes = aCond.enableCondition( selection );
382 showRes = aCond.showCondition( selection );
383 }
384 catch( std::exception& )
385 {
386 // Something broke with the conditions, just skip the event.
387 aEvent.Skip();
388 return;
389 }
390
391 if( isCut || isCopy || isPaste )
392 {
393 wxWindow* focus = wxWindow::FindFocus();
394 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( focus );
395
396 if( textEntry && isCut && textEntry->CanCut() )
397 enableRes = true;
398 else if( textEntry && isCopy && textEntry->CanCopy() )
399 enableRes = true;
400 else if( textEntry && isPaste && textEntry->CanPaste() )
401 enableRes = true;
402 }
403
404 aEvent.Enable( enableRes );
405 aEvent.Show( showRes );
406
407 // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
408 // checked, since wxMenuItems don't want to be checked unless they actually are checkable
409#if wxCHECK_VERSION( 3, 1, 5 )
410 if( aEvent.IsCheckable() )
411 aEvent.Check( checkRes );
412#else
413 bool canCheck = true;
414
415 // wxMenuItems don't want to be checked unless they actually are checkable, so we have to
416 // check to see if they can be and can't just universally apply a check in this event.
417 if( wxMenu* menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
418 canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
419
420 if( canCheck )
421 aEvent.Check( checkRes );
422#endif
423}
static TOOL_ACTION paste
Definition: actions.h:69
static TOOL_ACTION copy
Definition: actions.h:68
static TOOL_ACTION cut
Definition: actions.h:67
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:101
int GetUIId() const
Definition: tool_action.h:130
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.

References ACTION_CONDITIONS::checkCondition, ACTIONS::copy, ACTIONS::cut, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), TOOL_ACTION::GetUIId(), ACTIONS::paste, 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 800 of file pl_editor_frame.cpp.

801{
803
805 PL_SELECTION& selection = selTool->GetSelection();
806 DS_DATA_ITEM* item = nullptr;
807
808 if( selection.GetSize() == 1 )
809 item = static_cast<DS_DRAW_ITEM_BASE*>( selection.Front() )->GetPeer();
810
814 GetCanvas()->Refresh();
815}
Base class to handle basic graphic items.
Definition: ds_draw_item.h:59
void DisplayDrawingSheet()
Build and update the list of WS_DRAW_ITEM_xxx showing the frame layout.
void UpdateMsgPanelInfo()
Display the size of the sheet to the message panel.
PL_SELECTION & GetSelection()
Return the set of currently selected items.
void CopyPrmsFromItemToPanel(DS_DATA_ITEM *aItem)

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

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

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const
inlineinherited

Safety check before asking for the Kiway reference.

Returns
true if kiway is non-null

Definition at line 63 of file kiway_holder.h.

64 {
65 return m_kiway != nullptr;
66 }
KIWAY * m_kiway
Definition: kiway_holder.h:84

References KIWAY_HOLDER::m_kiway.

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 809 of file eda_base_frame.cpp.

810{
811 return Kiface().GetHelpFileName();
812}
const wxString & GetHelpFileName() const
Return just the basename portion of the current help file.
Definition: kiface_base.h:110

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

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

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

Parameters
aActionMapcurrent hotkey map (over which the imported hotkeys will be applied).
aDefaultShortnamea 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 1256 of file eda_base_frame.cpp.

1257{
1258 wxAcceleratorEntry entries[1];
1259 entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
1260 wxAcceleratorTable accel( 1, entries );
1261 SetAcceleratorTable( accel );
1262}

◆ 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
aFullFileNameis the filename.

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

279{
280 if( wxFileExists( aFullFileName ) )
281 {
282 const bool append = true;
284 DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( aFullFileName, append );
285 return true;
286 }
287
288 return false;
289}
void SaveCopyInUndoList()
Save a copy of the description (in a S expr string) for Undo/redo commands.

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

Referenced by Files_io().

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const
inlineprotectedvirtualinherited

Return the auto save status of the application.

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

Definition at line 615 of file eda_base_frame.h.

615{ return m_autoSaveRequired; }

References EDA_BASE_FRAME::m_autoSaveRequired.

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool PL_EDITOR_FRAME::IsContentModified ( ) const
overridevirtual

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

Returns
true if the any changes have not been saved

Reimplemented from EDA_BASE_FRAME.

Definition at line 352 of file pl_editor_frame.cpp.

353{
354 return GetScreen() && GetScreen()->IsContentModified();
355}
bool IsContentModified() const
Definition: base_screen.h:60

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 119 of file tools_holder.cpp.

120{
121 if( m_toolStack.empty() )
122 return &aAction == &ACTIONS::selectionTool;
123 else
124 return m_toolStack.back() == aAction.GetName();
125}

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

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

177{
178 return !m_modal_loop;
179}

References KIWAY_PLAYER::m_modal_loop.

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

◆ IsGridVisible()

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

159{ 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(), KIWAY_PLAYER::ShowModal(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ IsScriptingConsoleVisible()

bool EDA_DRAW_FRAME::IsScriptingConsoleVisible ( )
inherited

Gets the current visibility of the scripting console window.

Definition at line 260 of file eda_draw_frame.cpp.

261{
262 KIWAY_PLAYER* frame = Kiway().Player( FRAME_PYTHON, false );
263 return frame && frame->IsVisible();
264}
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:66
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:394
@ FRAME_PYTHON
Definition: frame_type.h:51

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

Referenced by EDITOR_CONDITIONS::consoleVisibleFunc().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 197 of file eda_base_frame.h.

197{ 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(), CONVERT_TOOL::CreatePolys(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), SYMBOL_EDITOR_CONTROL::DdAddLibrary(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::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(), PCB_EDITOR_CONDITIONS::get45degModeFunc(), SCH_BASE_FRAME::GetColorSettings(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), DIALOG_FIELD_PROPERTIES::init(), SYMBOL_EDITOR_CONTROL::Init(), CONVERT_TOOL::Init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PCB_BASE_FRAME::loadFootprint(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), PCB_CONTROL::placeBoardItems(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), PCB_SELECTION_TOOL::Reset(), 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(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), and DRAWING_TOOL::UpdateStatusBar().

◆ IsWritable()

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

Checks if aFileName can be written.

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

Note
The file name path must be set or an assertion will be raised on debug builds and return false on release builds.
Parameters
aFileNameThe full path and/or file name of the file to test.
aVerboseIf true will show an error dialog if the file is not writable
Returns
False if aFileName cannot be written.

Definition at line 1159 of file eda_base_frame.cpp.

1160{
1161 wxString msg;
1162 wxFileName fn = aFileName;
1163
1164 // Check for absence of a file path with a file name. Unfortunately KiCad
1165 // uses paths relative to the current project path without the ./ part which
1166 // confuses wxFileName. Making the file name path absolute may be less than
1167 // elegant but it solves the problem.
1168 if( fn.GetPath().IsEmpty() && fn.HasName() )
1169 fn.MakeAbsolute();
1170
1171 wxCHECK_MSG( fn.IsOk(), false,
1172 wxT( "File name object is invalid. Bad programmer!" ) );
1173 wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
1174 wxT( "File name object path <" ) + fn.GetFullPath() +
1175 wxT( "> is not set. Bad programmer!" ) );
1176
1177 if( fn.IsDir() && !fn.IsDirWritable() )
1178 {
1179 msg.Printf( _( "Insufficient permissions to folder '%s'." ), fn.GetPath() );
1180 }
1181 else if( !fn.FileExists() && !fn.IsDirWritable() )
1182 {
1183 msg.Printf( _( "Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
1184 }
1185 else if( fn.FileExists() && !fn.IsFileWritable() )
1186 {
1187 msg.Printf( _( "Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
1188 }
1189
1190 if( !msg.IsEmpty() )
1191 {
1192 if( aVerbose )
1193 wxMessageBox( msg );
1194
1195 return false;
1196 }
1197
1198 return true;
1199}

References _.

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

◆ Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AskToSaveChanges(), IMPORT_PROJ_HELPER::AssociateFileWithProj(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), SCH_EDIT_FRAME::canCloseWindow(), PCB_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), SYMBOL_EDIT_FRAME::DdAddLibrary(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::FetchNetlistFromSchematic(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PGM_SINGLE_TOP::MacOpenFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), KIGFX::WX_VIEW_CONTROLS::onMotion(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), SIM_PLOT_FRAME::onProbe(), PCB_EDIT_FRAME::OnQuit(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), SIM_PLOT_FRAME::onTune(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SCH_EDITOR_CONTROL::rescueProject(), PCB_EDIT_FRAME::RunEeschema(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), SYMBOL_EDIT_FRAME::saveCurrentSymbol(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), PCB_BASE_FRAME::SelectFootprintFromLibBrowser(), PCB_BASE_FRAME::SelectLibrary(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), PCB_EDIT_FRAME::SendCrossProbeItem(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), PCB_EDIT_FRAME::SendSelectItemsToSch(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDIT_FRAME::TestStandalone(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS aEvent)
protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 197 of file kiway_player.cpp.

198{
199 // logging support
200 KiwayMailIn( aEvent ); // call the virtual, override in derived.
201}
virtual void KiwayMailIn(KIWAY_EXPRESS &aEvent)
Receive KIWAY_EXPRESS messages from other players.

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS aEvent)
virtualinherited

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

Reimplemented in CVPCB_MAINFRAME, SCH_EDIT_FRAME, PCB_EDIT_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 87 of file kiway_player.cpp.

88{
89 // override this in derived classes.
90}

Referenced by KIWAY_PLAYER::kiway_express(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), 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 204 of file kiway_player.cpp.

205{
206 int id = event.GetId();
207
208 // tell all the KIWAY_PLAYERs about the language change.
209 Kiway().SetLanguage( id );
210}
virtual void SetLanguage(int aLanguage)
Change the language and then calls ShowChangedLanguage() on all #KIWAY_PLAYERs.
Definition: kiway.cpp:504

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
doOpenif true runs an Open Library browser, otherwise New Library
aFilenamefor New may contain a default name; in both cases return the chosen filename.
wildcarda wildcard to filter the displayed files
extthe library file extension
isDirectoryindicates the library files are directories
Returns
true for OK; false for Cancel.

Definition at line 1033 of file eda_draw_frame.cpp.

1037{
1038 wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
1039 aFilename.SetExt( ext );
1040
1041 wxString projectDir = Prj().IsNullProject() ? aFilename.GetPath() : Prj().GetProjectPath();
1042 wxString defaultDir;
1043
1044 if( aIsGlobal )
1045 {
1046 if( !GetMruPath().IsEmpty() && !GetMruPath().StartsWith( projectDir ) )
1047 defaultDir = GetMruPath();
1048 else
1049 defaultDir = aGlobalPath;
1050 }
1051 else
1052 {
1053 if( !GetMruPath().IsEmpty() && GetMruPath().StartsWith( projectDir ) )
1054 defaultDir = GetMruPath();
1055 else
1056 defaultDir = projectDir;
1057 }
1058
1059 if( isDirectory && doOpen )
1060 {
1061 wxDirDialog dlg( this, prompt, defaultDir, wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
1062
1063 if( dlg.ShowModal() == wxID_CANCEL )
1064 return false;
1065
1066 aFilename = dlg.GetPath();
1067 aFilename.SetExt( ext );
1068 }
1069 else
1070 {
1071 // Ensure the file has a dummy name, otherwise GTK will display the regex from the filter
1072 if( aFilename.GetName().empty() )
1073 aFilename.SetName( "Library" );
1074
1075 wxFileDialog dlg( this, prompt, defaultDir, aFilename.GetFullName(),
1076 wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
1077 : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
1078
1079 if( dlg.ShowModal() == wxID_CANCEL )
1080 return false;
1081
1082 aFilename = dlg.GetPath();
1083 aFilename.SetExt( ext );
1084 }
1085
1086 SetMruPath( aFilename.GetPath() );
1087
1088 return true;
1089}
wxString GetMruPath() const
void SetMruPath(const wxString &aPath)
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:126
virtual bool IsNullProject() const
Check if this project is a null project (i.e.
Definition: project.cpp:138

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

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

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )
protectedinherited

Returns the canvas type stored in the application settings.

Definition at line 789 of file eda_draw_frame.cpp.

790{
791#ifdef __WXMAC__
792 // Cairo renderer doesn't handle Retina displays so there's really only one game
793 // in town for Mac
795#endif
796
799
800 if( cfg )
801 canvasType = static_cast<EDA_DRAW_PANEL_GAL::GAL_TYPE>( cfg->m_Graphics.canvas_type );
802
803 if( canvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
804 || canvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
805 {
806 wxASSERT( false );
808 }
809
810 // Legacy canvas no longer supported. Switch to OpenGL, falls back to Cairo on failure
811 if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
813
814 return canvasType;
815}
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:101
@ GAL_TYPE_LAST
Sentinel, do not use as a parameter.
@ GAL_TYPE_OPENGL
OpenGL implementation.

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

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

◆ LoadDrawingSheetFile()

bool PL_EDITOR_FRAME::LoadDrawingSheetFile ( const wxString &  aFullFileName)

Load a .kicad_wks drawing sheet file.

Parameters
aFullFileNameis the filename.

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

234{
235 if( wxFileExists( aFullFileName ) )
236 {
237 bool loaded = false;
238
239 loaded = DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( aFullFileName );
240
241 if( !loaded )
242 {
243 ShowInfoBarError( _( "Error reading drawing sheet" ), true );
244 return false;
245 }
246
247 SetCurrentFileName( aFullFileName );
248 UpdateFileHistory( aFullFileName );
249 GetScreen()->SetContentModified( false );
250
251 wxFileName fn = aFullFileName;
253
254 if( DS_DATA_MODEL::GetTheInstance().GetFileFormatVersionAtLoad() < SEXPR_WORKSHEET_FILE_VERSION )
255 {
258 m_infoBar->ShowMessage( _( "This file was created by an older version of KiCad. "
259 "It will be converted to the new format when saved." ),
261 }
262
263 if( fn.FileExists() && !fn.IsFileWritable() )
264 {
267 m_infoBar->ShowMessage( _( "Layout file is read only." ),
269 }
270
271 return true;
272 }
273
274 return false;
275}
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
void ShowInfoBarError(const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left o...
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:286
@ OUTDATED_SAVE
OUTDATED_SAVE Messages that should be cleared on save.
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
Definition: infobar.cpp:175
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
Definition: infobar.cpp:276
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: infobar.cpp:142
#define SEXPR_WORKSHEET_FILE_VERSION
This file contains the file format version information for the s-expression drawing sheet file format...

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(), 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 482 of file pl_editor_frame.cpp.

483{
485
486 if( aCfg->m_Window.grid.sizes.empty() )
487 {
488 aCfg->m_Window.grid.sizes = { "5.00 mm",
489 "2.50 mm",
490 "2.00 mm",
491 "1.00 mm",
492 "0.50 mm",
493 "0.25 mm",
494 "0.20 mm",
495 "0.10 mm" };
496 }
497
498 // Currently values read from config file are not used because the user cannot
499 // change this config
500 // if( aCfg->m_Window.zoom_factors.empty() )
501 {
503 }
504
505 PL_EDITOR_SETTINGS* cfg = dynamic_cast<PL_EDITOR_SETTINGS*>( aCfg );
506 wxCHECK( cfg, /*void*/ );
507
510
512
515
516 PAGE_INFO pageInfo = GetPageSettings();
517 pageInfo.SetType( cfg->m_LastPaperSize, cfg->m_LastWasPortrait );
518 SetPageSettings( pageInfo );
519}
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
virtual void SetDrawBgColor(const COLOR4D &aColor)
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:54
static void SetCustomWidthMils(int aWidthInMils)
Set the width of Custom page in mils for any custom page constructed or made via SetType() after maki...
Definition: page_info.cpp:232
static void SetCustomHeightMils(int aHeightInMils)
Set the height of Custom page in mils for any custom page constructed or made via SetType() after mak...
Definition: page_info.cpp:238
bool SetType(const wxString &aStandardPageDescriptionName, bool aIsPortrait=false)
Set the name of the page type and also the sizes and margins commonly associated with that type name.
Definition: page_info.cpp:120
void SetPageSettings(const PAGE_INFO &) override
@ WHITE
Definition: color4d.h:48
@ BLACK
Definition: color4d.h:44
std::vector< wxString > sizes
Definition: app_settings.h:53
std::vector< double > zoom_factors
Definition: app_settings.h:87
#define ZOOM_LIST_PL_EDITOR
Definition: zoom_defines.h:35

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, m_propertiesFrameWidth, PL_EDITOR_SETTINGS::m_PropertiesFrameWidth, APP_SETTINGS_BASE::m_Window, PAGE_INFO::SetCustomHeightMils(), PAGE_INFO::SetCustomWidthMils(), EDA_DRAW_FRAME::SetDrawBgColor(), SetPageSettings(), PAGE_INFO::SetType(), 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 700 of file eda_base_frame.cpp.

701{
702 LoadWindowState( aCfg->state );
703
705 m_mruPath = aCfg->mru_path;
706
708}
void LoadWindowState(const wxString &aFileName)
wxString m_perspective
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.
WINDOW_STATE state
Definition: app_settings.h:84
wxString mru_path
Definition: app_settings.h:85
wxString perspective
Definition: app_settings.h:86

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

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE aState)
virtualinherited

Load frame state info from a configuration file.

Definition at line 554 of file eda_base_frame.cpp.

555{
556 bool wasDefault = false;
557
558 m_framePos.x = aState.pos_x;
559 m_framePos.y = aState.pos_y;
560 m_frameSize.x = aState.size_x;
561 m_frameSize.y = aState.size_y;
562
563 wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
565
566 // Ensure minimum size is set if the stored config was zero-initialized
567 if( m_frameSize.x < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
568 {
570 wasDefault = true;
571
572 wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)",
574 }
575
576 wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
577
578 if( aState.display >= wxDisplay::GetCount() )
579 {
580 wxLogTrace( traceDisplayLocation, "Previous display not found" );
581
582 // If it isn't attached, use the first display
583 // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
584 const unsigned int index = 0;
585 wxDisplay display( index );
586 wxRect clientSize = display.GetGeometry();
587
588 m_framePos = wxDefaultPosition;
589
590 // Ensure the window fits on the display, since the other one could have been larger
591 if( m_frameSize.x > clientSize.width )
592 m_frameSize.x = clientSize.width;
593
594 if( m_frameSize.y > clientSize.height )
595 m_frameSize.y = clientSize.height;
596 }
597 else
598 {
599 wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
600 wxPoint upperLeft( m_framePos.x, m_framePos.y );
601
602 wxDisplay display( aState.display );
603 wxRect clientSize = display.GetClientArea();
604
605 int yLimTop = clientSize.y;
606 int yLimBottom = clientSize.y + clientSize.height;
607 int xLimLeft = clientSize.x;
608 int xLimRight = clientSize.x + clientSize.width;
609
610 if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
611 upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
612 upperLeft.y < yLimTop || // Upper corner too close to the bottom of the screen
613 upperLeft.y > yLimBottom )
614 {
615 m_framePos = wxDefaultPosition;
616 wxLogTrace( traceDisplayLocation, "Resetting to default position" );
617 }
618 }
619
620 wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
622
623 SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
624
625 // Center the window if we reset to default
626 if( m_framePos.x == -1 )
627 {
628 wxLogTrace( traceDisplayLocation, "Centering window" );
629 Center();
630 m_framePos = GetPosition();
631 }
632
633 // Record the frame sizes in an un-maximized state
636
637 // Maximize if we were maximized before
638 if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
639 {
640 wxLogTrace( traceDisplayLocation, "Maximizing window" );
641 Maximize();
642 }
643
644 m_displayIndex = wxDisplay::GetFromWindow( this );
645}
wxSize m_normalFrameSize
wxPoint m_normalFramePos
unsigned int display
Definition: app_settings.h:76

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.

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString &  aFileName)
inherited

Definition at line 540 of file eda_base_frame.cpp.

541{
542 if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
543 return;
544
545 const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
546
547 if( state != nullptr )
548 {
549 LoadWindowState( state->window );
550 }
551}
const PROJECT_FILE_STATE * GetFileState(const wxString &aFileName)
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:154
struct WINDOW_STATE window

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

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

◆ LockFile()

bool EDA_DRAW_FRAME::LockFile ( const wxString &  aFileName)
inherited

Mark a schematic file as being in use.

Use ReleaseFile() to undo this.

Parameters
aFileNamefull path to the file.
Returns
false if the file was already locked, true otherwise.

Definition at line 219 of file eda_draw_frame.cpp.

220{
221 m_file_checker = ::LockFile( aFileName );
222
223 return m_file_checker && !m_file_checker->IsAnotherRunning();
224}
bool LockFile(const wxString &aFileName)
Mark a schematic file as being in use.
std::unique_ptr< wxSingleInstanceChecker > m_file_checker

References EDA_DRAW_FRAME::LockFile(), and EDA_DRAW_FRAME::m_file_checker.

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

◆ MessageTextFromValue() [1/2]

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

Definition at line 82 of file units_provider.h.

83 {
85 aValue.AsDegrees(), aAddUnitLabel,
87 }
constexpr EDA_IU_SCALE unityScale
Definition: base_units.h:112
double AsDegrees() const
Definition: eda_angle.h:149
wxString MessageTextFromValue(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, double aValue, bool aAddUnitsText=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
A helper to convert the double length aValue to a string in inches, millimeters, or unscaled units.
Definition: eda_units.cpp:319

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

◆ MessageTextFromValue() [2/2]

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

A lower-precision version of StringFromValue().

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

Definition at line 75 of file units_provider.h.

77 {
79 aAddUnitLabel, aType );
80 }

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

Referenced by CheckLibSymbol(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DIALOG_BOARD_REANNOTATE::CoordTowxString(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBVIEW_FRAME::DisplayGridMsg(), PCB_BASE_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DRAWING_TOOL::DrawBoardCharacteristics(), DRC_ENGINE::EvalRules(), DIALOG_NET_INSPECTOR::formatLength(), DRC_TEST_PROVIDER::formatMsg(), LIB_FIELD::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_BITMAP::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), STROKE_PARAMS::GetMsgPanelInfo(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), TEXT_SEARCH_HANDLER::GetResultCell(), LIB_SHAPE::GetSelectMenuText(), SCH_LINE::GetSelectMenuText(), SCH_SHAPE::GetSelectMenuText(), DS_DRAW_ITEM_LINE::GetSelectMenuText(), DS_DRAW_ITEM_RECT::GetSelectMenuText(), PCB_TRACK::GetSelectMenuText(), DIALOG_BOARD_REANNOTATE::MakeSampleText(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_SHAPE::ShapeGetMsgPanelInfo(), showCoord(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), VIA_SIZE_MENU::update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), PCB_CONTROL::UpdateMessagePanel(), UpdateMsgPanelInfo(), SCH_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), and DIALOG_BOARD_STATISTICS::updateWidets().

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce)
inlineinherited

Definition at line 573 of file eda_base_frame.h.

574 {
575 m_isNonUserClose = true;
576 return Close( aForce );
577 }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onActivate()

void EDA_DRAW_FRAME::onActivate ( wxActivateEvent &  aEvent)
protectedinherited

Definition at line 1216 of file eda_draw_frame.cpp.

1217{
1218 handleActivateEvent( aEvent );
1219
1220 aEvent.Skip();
1221}
virtual void handleActivateEvent(wxActivateEvent &aEvent)
Handle a window activation event.

References EDA_DRAW_FRAME::handleActivateEvent().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 304 of file eda_base_frame.cpp.

305{
306 // Don't stomp on someone else's timer event.
307 if( aEvent.GetId() != ID_AUTO_SAVE_TIMER )
308 {
309 aEvent.Skip();
310 return;
311 }
312
313 if( !doAutoSave() )
314 m_autoSaveTimer->Start( GetAutoSaveInterval() * 1000, wxTIMER_ONE_SHOT );
315}
virtual bool doAutoSave()
This should be overridden by the derived class to handle the auto save feature.
int GetAutoSaveInterval() const

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

Referenced by EDA_BASE_FRAME::commonInit().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  aKeyEvent)
virtualinherited

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

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

Reimplemented in SYMBOL_VIEWER_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 324 of file eda_base_frame.cpp.

325{
326 wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( aKeyEvent ) );
327
328 // Key events can be filtered here.
329 // Currently no filtering is made.
330 aKeyEvent.Skip();
331}
const wxChar *const kicadTraceKeyEvent
Flag to enable wxKeyEvent debug tracing.
wxString dump(const wxArrayString &aArray)
Debug helper for printing wxArrayString contents.

References dump(), and kicadTraceKeyEvent.

◆ OnClearFileHistory()

void PL_EDITOR_FRAME::OnClearFileHistory ( wxCommandEvent &  aEvent)

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

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

References EDA_BASE_FRAME::ClearFileHistory().

◆ OnDropFiles()

void EDA_BASE_FRAME::OnDropFiles ( wxDropFilesEvent &  aEvent)
protectedvirtualinherited

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

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

Definition at line 1127 of file eda_base_frame.cpp.

1128{
1129 wxString* files = aEvent.GetFiles();
1130
1131 for( int nb = 0; nb < aEvent.GetNumberOfFiles(); nb++ )
1132 {
1133 const wxFileName fn = wxFileName( files[nb] );
1134 for( const auto& [ext, tool] : m_acceptedExts )
1135 {
1136 if( IsExtensionAccepted( fn.GetExt(), { ext.ToStdString() } ) )
1137 {
1138 m_AcceptedFiles.emplace( m_AcceptedFiles.end(), fn );
1139 break;
1140 }
1141 }
1142 }
1143
1145 m_AcceptedFiles.clear();
1146}
virtual void DoWithAcceptedFiles()
Execute action on accepted dropped file.
bool IsExtensionAccepted(const wxString &aExt, const std::vector< std::string > acceptedExts)
Checks if the file extension is in accepted extensions.

References EDA_BASE_FRAME::DoWithAcceptedFiles(), IsExtensionAccepted(), EDA_BASE_FRAME::m_acceptedExts, and EDA_BASE_FRAME::m_AcceptedFiles.

◆ OnExit()

void PL_EDITOR_FRAME::OnExit ( wxCommandEvent &  aEvent)

Event handler for the wxID_EXIT and wxID_CLOSE events.

Definition at line 358 of file pl_editor_frame.cpp.

359{
360 if( aEvent.GetId() == wxID_EXIT )
361 Kiway().OnKiCadExit();
362
363 if( aEvent.GetId() == wxID_CLOSE || Kiface().IsSingle() )
364 Close( false );
365}
void OnKiCadExit()
Definition: kiway.cpp:665

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

◆ OnFileHistory()

void PL_EDITOR_FRAME::OnFileHistory ( wxCommandEvent &  event)

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

54{
55 wxString filename;
56
57 filename = GetFileFromHistory( event.GetId(), _( "Drawing Sheet File" ) );
58
59 if( filename != wxEmptyString )
60 {
61 if( IsContentModified() )
62 {
63 if( !HandleUnsavedChanges( this, _( "The current drawing sheet has been modified. "
64 "Save changes?" ),
65 [&]() -> bool
66 {
67 return saveCurrentPageLayout();
68 } ) )
69 {
70 return;
71 }
72 }
73
74 ::wxSetWorkingDirectory( ::wxPathOnly( filename ) );
75
76 if( LoadDrawingSheetFile( filename ) )
77 {
78 wxString msg;
79 msg.Printf( _( "File \"%s\" loaded"), filename );
80 SetStatusText( msg );
81 }
82
84 }
85}
wxString GetFileFromHistory(int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
Fetches the file name from the file history list.

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

◆ OnGridSettings()

void EDA_DRAW_FRAME::OnGridSettings ( wxCommandEvent &  event)
inherited

Definition at line 460 of file eda_draw_frame.cpp.

461{
462 DIALOG_GRID_SETTINGS dlg( this );
463
464 if( dlg.ShowModal() == wxID_OK )
465 {
467 GetCanvas()->Refresh();
468 }
469}
void UpdateStatusBar() override
Update the status bar information.

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

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent &  aEvent)
protectedinherited

Definition at line 1404 of file eda_base_frame.cpp.

1405{
1406 // Call the handler
1407 handleIconizeEvent( aEvent );
1408
1409 // Skip the event.
1410 aEvent.Skip();
1411}
virtual void handleIconizeEvent(wxIconizeEvent &aEvent)
Handle a window iconize event.

References EDA_BASE_FRAME::handleIconizeEvent().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 974 of file eda_base_frame.cpp.

975{
976 void ShowAboutDialog( EDA_BASE_FRAME * aParent ); // See AboutDialog_main.cpp
977 ShowAboutDialog( this );
978}
void ShowAboutDialog(EDA_BASE_FRAME *aParent)
The base frame for deriving all KiCad main window classes.

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent &  aEvent)
inherited

Definition at line 1330 of file eda_base_frame.cpp.

1331{
1332 // When we maximize the window, we want to save the old information
1333 // so that we can add it to the settings on next window load.
1334 // Contrary to the documentation, this event seems to be generated
1335 // when the window is also being unmaximized on OSX, so we only
1336 // capture the size information when we maximize the window when on OSX.
1337#ifdef __WXOSX__
1338 if( !IsMaximized() )
1339#endif
1340 {
1342 m_normalFramePos = GetPosition();
1343 wxLogTrace( traceDisplayLocation,
1344 "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
1347 }
1348
1349 // Skip event to actually maximize the window
1350 aEvent.Skip();
1351}

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

335{
336 if( !m_toolDispatcher )
337 aEvent.Skip();
338 else
340}
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:172
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.

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

◆ OnModify()

void PL_EDITOR_FRAME::OnModify ( )
inlineoverridevirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 240 of file pl_editor_frame.h.

241 {
243
245 }
virtual void OnModify()
Must be called after a model change in order to set the "modify" flag and do other frame-specific pro...

References EDA_DRAW_FRAME::GetScreen(), EDA_BASE_FRAME::OnModify(), 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(), PL_EDITOR_CONTROL::PageSetup(), and PL_DRAWING_TOOLS::PlaceItem().

◆ OnMove()

void EDA_DRAW_FRAME::OnMove ( wxMoveEvent &  aEvent)
overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 539 of file eda_draw_frame.cpp.

540{
541 // If the window is moved to a different display, the scaling factor may change
542 double oldFactor = m_galDisplayOptions.m_scaleFactor;
544
545 if( oldFactor != m_galDisplayOptions.m_scaleFactor && m_canvas )
546 {
547 wxSize clientSize = GetClientSize();
548 GetCanvas()->GetGAL()->ResizeScreen( clientSize.x, clientSize.y );
550 }
551
552 aEvent.Skip();
553}
virtual void ResizeScreen(int aWidth, int aHeight)
Resize the canvas.
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:641

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

885{
887 GetScreen()->SetContentModified( false );
889
892
894
896
897 if( GetCurrentFileName().IsEmpty() )
898 {
899 // Default shutdown reason until a file is loaded
900 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "New drawing sheet file is unsaved" ) );
901 }
902 else
903 {
904 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Drawing sheet changes are unsaved" ) );
905 }
906}
static TOOL_ACTION zoomFitScreen
Definition: actions.h:98
virtual void ClearUndoRedoList()
Clear the undo and redo list using ClearUndoORRedoList()
void UpdateTitleAndInfo()
Display the short filename (if exists) loaded file on the caption of the main window.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:142
void SetShutdownBlockReason(wxWindow *aWindow, const wxString &aReason)
Sets the block reason why the window/application is preventing OS shutdown.
Definition: gtk/app.cpp:83

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

325{}

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

982{
983 PAGED_DIALOG dlg( this, _( "Preferences" ), true );
984 wxTreebook* book = dlg.GetTreebook();
985
986 PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
987 KIFACE* kiface = nullptr;
988 std::vector<int> expand;
989
990 Kiway().GetActions( hotkeysPanel->ActionsList() );
991
992 book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
993 book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
994 book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
995
996#ifdef KICAD_USE_SENTRY
997 book->AddPage( new PANEL_DATA_COLLECTION( &dlg, book ), _( "Data Collection" ) );
998#endif
999
1000#define CREATE_PANEL( key ) kiface->CreateKiWindow( book, key, &Kiway() )
1001
1002 // If a dll is not loaded, the loader will show an error message.
1003
1004 try
1005 {
1007
1008 kiface->GetActions( hotkeysPanel->ActionsList() );
1009
1011 expand.push_back( book->GetPageCount() );
1012
1013 book->AddPage( new wxPanel( book ), _( "Symbol Editor" ) );
1014 book->AddSubPage( CREATE_PANEL( PANEL_SYM_DISP_OPTIONS ), _( "Display Options" ) );
1015 book->AddSubPage( CREATE_PANEL( PANEL_SYM_EDIT_OPTIONS ), _( "Editing Options" ) );
1016 book->AddSubPage( CREATE_PANEL( PANEL_SYM_COLORS ), _( "Colors" ) );
1017
1018 if( GetFrameType() == FRAME_SCH )
1019 expand.push_back( book->GetPageCount() );
1020
1021 book->AddPage( new wxPanel( book ), _( "Schematic Editor" ) );
1022 book->AddSubPage( CREATE_PANEL( PANEL_SCH_DISP_OPTIONS ), _( "Display Options" ) );
1023 book->AddSubPage( CREATE_PANEL( PANEL_SCH_EDIT_OPTIONS ), _( "Editing Options" ) );
1024 book->AddSubPage( CREATE_PANEL( PANEL_SCH_ANNO_OPTIONS ), _( "Annotation Options" ) );
1025 book->AddSubPage( CREATE_PANEL( PANEL_SCH_COLORS ), _( "Colors" ) );
1026 book->AddSubPage( CREATE_PANEL( PANEL_SCH_FIELD_NAME_TEMPLATES ),
1027 _( "Field Name Templates" ) );
1028 }
1029 catch( ... )
1030 {
1031 }
1032
1033 try
1034 {
1036
1037 kiface->GetActions( hotkeysPanel->ActionsList() );
1038
1040 expand.push_back( book->GetPageCount() );
1041
1042 book->AddPage( new wxPanel( book ), _( "Footprint Editor" ) );
1043 book->AddSubPage( CREATE_PANEL( PANEL_FP_DISPLAY_OPTIONS ), _( "Display Options" ) );
1044 book->AddSubPage( CREATE_PANEL( PANEL_FP_EDIT_OPTIONS ), _( "Editing Options" ) );
1045 book->AddSubPage( CREATE_PANEL( PANEL_FP_COLORS ), _( "Colors" ) );
1046 book->AddSubPage( CREATE_PANEL( PANEL_FP_DEFAULT_VALUES ), _( "Default Values" ) );
1047
1049 expand.push_back( book->GetPageCount() );
1050
1051 book->AddPage( new wxPanel( book ), _( "PCB Editor" ) );
1052 book->AddSubPage( CREATE_PANEL( PANEL_PCB_DISPLAY_OPTIONS ), _( "Display Options" ) );
1053 book->AddSubPage( CREATE_PANEL( PANEL_PCB_EDIT_OPTIONS ), _( "Editing Options" ) );
1054 book->AddSubPage( CREATE_PANEL( PANEL_PCB_COLORS ), _( "Colors" ) );
1055 book->AddSubPage( CREATE_PANEL( PANEL_PCB_ACTION_PLUGINS ), _( "Action Plugins" ) );
1056 book->AddSubPage( CREATE_PANEL( PANEL_PCB_ORIGINS_AXES ), _( "Origins & Axes" ) );
1057
1059 expand.push_back( book->GetPageCount() );
1060
1061 book->AddPage( new wxPanel( book ), _( "3D Viewer" ) );
1062 book->AddSubPage( CREATE_PANEL( PANEL_3DV_DISPLAY_OPTIONS ), _( "General" ) );
1063 book->AddSubPage( CREATE_PANEL( PANEL_3DV_OPENGL ), _( "Realtime Renderer" ) );
1064 book->AddSubPage( CREATE_PANEL( PANEL_3DV_RAYTRACING ), _( "Raytracing Renderer" ) );
1065 book->AddSubPage( CREATE_PANEL( PANEL_3DV_COLORS ), _( "Colors" ) );
1066 }
1067 catch( ... )
1068 {
1069 }
1070
1071 try
1072 {
1074
1075 kiface->GetActions( hotkeysPanel->ActionsList() );
1076
1077 if( GetFrameType() == FRAME_GERBER )
1078 expand.push_back( book->GetPageCount() );
1079
1080 book->AddPage( new wxPanel( book ), _( "Gerber Viewer" ) );
1081 book->AddSubPage( CREATE_PANEL( PANEL_GBR_DISPLAY_OPTIONS ), _( "Display Options" ) );
1082 book->AddSubPage( CREATE_PANEL( PANEL_GBR_COLORS ), _( "Colors" ) );
1083 book->AddSubPage( CREATE_PANEL( PANEL_GBR_EXCELLON_OPTIONS ), _( "Excellon Options" ) );
1084 }
1085 catch( ... )
1086 {
1087 }
1088
1089 try
1090 {
1092 kiface->GetActions( hotkeysPanel->ActionsList() );
1093
1094 if( GetFrameType() == FRAME_PL_EDITOR )
1095 expand.push_back( book->GetPageCount() );
1096
1097 book->AddPage( new wxPanel( book ), _( "Drawing Sheet Editor" ) );
1098 book->AddSubPage( CREATE_PANEL( PANEL_DS_DISPLAY_OPTIONS ), _( "Display Options" ) );
1099 book->AddSubPage( CREATE_PANEL( PANEL_DS_COLORS ), _( "Colors" ) );
1100
1101 book->AddPage( new PANEL_PCM_SETTINGS( book ), _( "Plugin and Content Manager" ) );
1102 }
1103 catch( ... )
1104 {
1105 }
1106
1107 // Update all of the action hotkeys. The process of loading the actions through
1108 // the KiFACE will only get us the default hotkeys
1109 ReadHotKeyConfigIntoActions( wxEmptyString, hotkeysPanel->ActionsList() );
1110
1111 for( size_t i = 0; i < book->GetPageCount(); ++i )
1112 book->GetPage( i )->Layout();
1113
1114 for( int page : expand )
1115 book->ExpandNode( page );
1116
1117 if( dlg.ShowModal() == wxID_OK )
1118 {
1119 Pgm().GetSettingsManager().Save();
1120 dlg.Kiway().CommonSettingsChanged( false, false );
1121 }
1122
1123#undef CREATE_PANEL
1124}
FRAME_T GetFrameType() const
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
Definition: kiway.cpp:572
virtual KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Return the KIFACE* given a FACE_T.
Definition: kiway.cpp:198
@ FACE_SCH
eeschema DSO
Definition: kiway.h:280
@ FACE_PL_EDITOR
Definition: kiway.h:284
@ FACE_PCB
pcbnew DSO
Definition: kiway.h:281
@ FACE_GERBVIEW
Definition: kiway.h:283
virtual void GetActions(std::vector< TOOL_ACTION * > &aActions) const
Append all registered actions to the given list.
Definition: kiway.cpp:497
std::vector< TOOL_ACTION * > & ActionsList()
return & kiface
Definition: cvpcb.cpp:112
#define CREATE_PANEL(key)
@ FRAME_PCB_EDITOR
Definition: frame_type.h:40
@ FRAME_SCH_SYMBOL_EDITOR
Definition: frame_type.h:35
@ PANEL_SCH_FIELD_NAME_TEMPLATES
Definition: frame_type.h:76
@ PANEL_GBR_DISPLAY_OPTIONS
Definition: frame_type.h:94
@ PANEL_3DV_COLORS
Definition: frame_type.h:92
@ PANEL_3DV_OPENGL
Definition: frame_type.h:90
@ PANEL_PCB_ORIGINS_AXES
Definition: frame_type.h:87
@ PANEL_PCB_EDIT_OPTIONS
Definition: frame_type.h:84
@ PANEL_SCH_DISP_OPTIONS
Definition: frame_type.h:72
@ PANEL_FP_DISPLAY_OPTIONS
Definition: frame_type.h:78
@ PANEL_DS_COLORS
Definition: frame_type.h:100
@ PANEL_PCB_COLORS
Definition: frame_type.h:85
@ PANEL_3DV_RAYTRACING
Definition: frame_type.h:91
@ PANEL_SYM_EDIT_OPTIONS
Definition: frame_type.h:69
@ PANEL_SCH_EDIT_OPTIONS
Definition: frame_type.h:73
@ PANEL_SYM_DISP_OPTIONS
Definition: frame_type.h:68
@ PANEL_FP_COLORS
Definition: frame_type.h:80
@ PANEL_SYM_COLORS
Definition: frame_type.h:70
@ FRAME_FOOTPRINT_EDITOR
Definition: frame_type.h:41
@ FRAME_GERBER
Definition: frame_type.h:53
@ FRAME_PCB_DISPLAY3D
Definition: frame_type.h:45
@ PANEL_FP_EDIT_OPTIONS
Definition: frame_type.h:79
@ PANEL_SCH_ANNO_OPTIONS
Definition: frame_type.h:74
@ PANEL_PCB_ACTION_PLUGINS
Definition: frame_type.h:86
@ PANEL_FP_DEFAULT_VALUES
Definition: frame_type.h:81
@ PANEL_3DV_DISPLAY_OPTIONS
Definition: frame_type.h:89
@ PANEL_DS_DISPLAY_OPTIONS
Definition: frame_type.h:99
@ PANEL_PCB_DISPLAY_OPTIONS
Definition: frame_type.h:83
@ PANEL_SCH_COLORS
Definition: frame_type.h:75
@ PANEL_GBR_COLORS
Definition: frame_type.h:97
@ PANEL_GBR_EXCELLON_OPTIONS
Definition: frame_type.h:96
void ReadHotKeyConfigIntoActions(const wxString &aFileName, std::vector< TOOL_ACTION * > &aActions)
Reads a hotkey config file into a list of actions.
Implement a participant in the KIWAY alchemy.
Definition: kiway.h:151

References _, PANEL_HOTKEYS_EDITOR::ActionsList(), KIWAY::CommonSettingsChanged(), CREATE_PANEL, KIWAY::FACE_GERBVIEW, KIWAY::FACE_PCB, KIWAY::FACE_PL_EDITOR, KIWAY::FACE_SCH, FRAME_FOOTPRINT_EDITOR, FRAME_GERBER, FRAME_PCB_DISPLAY3D, FRAME_PCB_EDITOR, FRAME_PL_EDITOR, FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, KIWAY::GetActions(), EDA_BASE_FRAME::GetFrameType(), PAGED_DIALOG::GetTreebook(), kiface, KIWAY::KiFACE(), KIWAY_HOLDER::Kiway(), PANEL_3DV_COLORS, PANEL_3DV_DISPLAY_OPTIONS, PANEL_3DV_OPENGL, PANEL_3DV_RAYTRACING, PANEL_DS_COLORS, PANEL_DS_DISPLAY_OPTIONS, PANEL_FP_COLORS, PANEL_FP_DEFAULT_VALUES, PANEL_FP_DISPLAY_OPTIONS, PANEL_FP_EDIT_OPTIONS, PANEL_GBR_COLORS, PANEL_GBR_DISPLAY_OPTIONS, PANEL_GBR_EXCELLON_OPTIONS, PANEL_PCB_ACTION_PLUGINS, PANEL_PCB_COLORS, PANEL_PCB_DISPLAY_OPTIONS, PANEL_PCB_EDIT_OPTIONS, PANEL_PCB_ORIGINS_AXES, PANEL_SCH_ANNO_OPTIONS, PANEL_SCH_COLORS, PANEL_SCH_DISP_OPTIONS, PANEL_SCH_EDIT_OPTIONS, PANEL_SCH_FIELD_NAME_TEMPLATES, PANEL_SYM_COLORS, PANEL_SYM_DISP_OPTIONS, PANEL_SYM_EDIT_OPTIONS, Pgm(), and ReadHotKeyConfigIntoActions().

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

422{
423 m_originSelectChoice = m_originSelectBox->GetSelection();
424 UpdateStatusBar(); // Update grid origin
426 GetCanvas()->Refresh();
427}
void UpdateStatusBar() override
Update the status bar information.

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
eventCommand event from the grid size combobox on the toolbar.

Definition at line 421 of file eda_draw_frame.cpp.

422{
423 wxCHECK_RET( m_gridSelectBox, "m_gridSelectBox uninitialized" );
424
425 int idx = m_gridSelectBox->GetCurrentSelection();
426
427 if( idx == int( m_gridSelectBox->GetCount() ) - 2 )
428 {
429 // wxWidgets will check the separator, which we don't want.
430 // Re-check the current grid.
431 wxUpdateUIEvent dummy;
433 }
434 else if( idx == int( m_gridSelectBox->GetCount() ) - 1 )
435 {
436 // wxWidgets will check the Grid Settings... entry, which we don't want.
437 // Re-check the current grid.
438 wxUpdateUIEvent dummy;
440
441 // Give a time-slice to close the menu before opening the dialog.
442 // (Only matters on some versions of GTK.)
443 wxSafeYield();
444
446 }
447 else
448 {
449 m_toolManager->RunAction( ACTIONS::gridPreset, true, static_cast<intptr_t>( idx ) );
450 }
451
453 m_canvas->Refresh();
454 // Needed on Windows because clicking on m_gridSelectBox remove the focus from m_canvas
455 // (Windows specific
457}
static TOOL_ACTION gridProperties
Definition: actions.h:144
static TOOL_ACTION gridPreset
Definition: actions.h:142
wxChoice * m_gridSelectBox
void OnUpdateSelectGrid(wxUpdateUIEvent &aEvent)
Update the checked item in the grid wxchoice.
void SetFocus() override
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:74

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

◆ OnSelectPage()

void PL_EDITOR_FRAME::OnSelectPage ( wxCommandEvent &  event)

Definition at line 412 of file pl_editor_frame.cpp.

413{
414 KIGFX::VIEW* view = GetCanvas()->GetView();
415 view->SetLayerVisible( LAYER_DRAWINGSHEET_PAGE1, m_pageSelectBox->GetSelection() == 0 );
416 view->SetLayerVisible( LAYER_DRAWINGSHEET_PAGEn, m_pageSelectBox->GetSelection() == 1 );
417 GetCanvas()->Refresh();
418}
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:69
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition: view.h:393
@ LAYER_DRAWINGSHEET_PAGEn
for drawingsheetEditor previewing
Definition: layer_ids.h:247
@ LAYER_DRAWINGSHEET_PAGE1
for drawingsheetEditor previewing
Definition: layer_ids.h:246

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

522{
523 wxCHECK_RET( m_zoomSelectBox, "m_zoomSelectBox uninitialized" );
524
525 int id = m_zoomSelectBox->GetCurrentSelection();
526
527 if( id < 0 || !( id < (int)m_zoomSelectBox->GetCount() ) )
528 return;
529
530 m_toolManager->RunAction( ACTIONS::zoomPreset, true, static_cast<intptr_t>( id ) );
532 m_canvas->Refresh();
533 // Needed on Windows because clicking on m_zoomSelectBox remove the focus from m_canvas
534 // (Windows specific
536}
static TOOL_ACTION zoomPreset
Definition: actions.h:100
wxChoice * m_zoomSelectBox

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

◆ OnSize()

void EDA_DRAW_FRAME::OnSize ( wxSizeEvent &  event)
overridevirtualinherited

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

Reimplemented from EDA_BASE_FRAME.

Reimplemented in SYMBOL_VIEWER_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 614 of file eda_draw_frame.cpp.

615{
616 EDA_BASE_FRAME::OnSize( SizeEv );
617
618 m_frameSize = GetClientSize( );
619
620 SizeEv.Skip();
621}
virtual void OnSize(wxSizeEvent &aEvent)

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

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

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent &  evt)
inherited

Definition at line 69 of file eda_dde.cpp.

70{
71 size_t len;
72 wxSocketBase* sock = evt.GetSocket();
73
74 switch( evt.GetSocketEvent() )
75 {
76 case wxSOCKET_INPUT:
77 sock->Read( client_ipc_buffer, 1 );
78
79 if( sock->LastCount() == 0 )
80 break; // No data, occurs on opening connection
81
82 sock->Read( client_ipc_buffer + 1, IPC_BUF_SIZE - 2 );
83 len = 1 + sock->LastCount();
84 client_ipc_buffer[len] = 0;
86 break;
87
88 case wxSOCKET_LOST:
89 return;
90 break;
91
92 default:
93 wxPrintf( wxT( "EDA_DRAW_FRAME::OnSockRequest() error: Invalid event !" ) );
94 break;
95 }
96}
virtual void ExecuteRemoteCommand(const char *cmdline)
Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242).
Definition: kiway_player.h:182
#define IPC_BUF_SIZE
Definition: eda_dde.cpp:39
static char client_ipc_buffer[IPC_BUF_SIZE]
Definition: eda_dde.cpp:40

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

◆ OnSockRequestServer()

void KIWAY_PLAYER::OnSockRequestServer ( wxSocketEvent &  evt)
inherited

Definition at line 99 of file eda_dde.cpp.

100{
101 wxSocketBase* socket;
102 wxSocketServer* server = (wxSocketServer*) evt.GetSocket();
103
104 socket = server->Accept();
105
106 if( socket == nullptr )
107 return;
108
109 m_sockets.push_back( socket );
110
111 socket->Notify( true );
112 socket->SetEventHandler( *this, ID_EDA_SOCKET_EVENT );
113 socket->SetNotify( wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG );
114}
std::vector< wxSocketBase * > m_sockets
interprocess communication
Definition: kiway_player.h:205
@ ID_EDA_SOCKET_EVENT
Definition: id.h:164

References ID_EDA_SOCKET_EVENT, and KIWAY_PLAYER::m_sockets.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent &  aEvent)
protectedinherited

Definition at line 1394 of file eda_base_frame.cpp.

1395{
1396 // Call the handler to update the colors used in the frame
1398
1399 // Skip the change event to ensure the rest of the window controls get it
1400 aEvent.Skip();
1401}
virtual void HandleSystemColorChange()
Update the UI in response to a change in the system colors.

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent &  aEvent)
inherited

Update the checked item in the grid wxchoice.

Definition at line 369 of file eda_draw_frame.cpp.

370{
371 // No need to update the grid select box if it doesn't exist or the grid setting change
372 // was made using the select box.
373 if( m_gridSelectBox == nullptr )
374 return;
375
376 int idx = config()->m_Window.grid.last_size_idx;
377 idx = std::max( 0, std::min( idx, (int) m_gridSelectBox->GetCount() - 1 ) );
378
379 if( idx != m_gridSelectBox->GetSelection() )
380 m_gridSelectBox->SetSelection( idx );
381}

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

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

◆ OnUpdateSelectZoom()

void EDA_DRAW_FRAME::OnUpdateSelectZoom ( wxUpdateUIEvent &  aEvent)
inherited

Update the checked item in the zoom wxchoice.

Definition at line 385 of file eda_draw_frame.cpp.

386{
387 // No need to update the grid select box if it doesn't exist or the grid setting change
388 // was made using the select box.
389 if( m_zoomSelectBox == nullptr )
390 return;
391
392 double zoom = GetCanvas()->GetGAL()->GetZoomFactor();
393 const std::vector<double>& zoomList = config()->m_Window.zoom_factors;
394 int curr_selection = m_zoomSelectBox->