KiCad PCB EDA Suite
PL_EDITOR_FRAME Class Reference

PL_EDITOR_FRAME is 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

Public Types

enum  UNDO_REDO_LIST { UNDO_LIST, REDO_LIST }
 Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. 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 LoadPageLayoutDescrFile (const wxString &aFullFileName)
 Function LoadPageLayoutDescrFile Loads a .kicad_wks page layout descr file. More...
 
bool SavePageLayoutDescrFile (const wxString &aFullFileName)
 Function SavePageLayoutDescrFile Save the current layout in a .kicad_wks page layout descr file. More...
 
bool InsertPageLayoutDescrFile (const wxString &aFullFileName)
 Function InsertPageLayoutDescrFile Loads a .kicad_wks page layout descr file, and add items to the current layout list. More...
 
bool IsContentModified () override
 Get if the page layout has been modified but not saved. More...
 
void OnExit (wxCommandEvent &aEvent)
 
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 wxPoint & GetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
wxPoint ReturnCoordOriginCorner () const
 calculate the position (in page, in iu) of the corner used as coordinate origin of items More...
 
const TITLE_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 OnNewPageLayout ()
 Must be called to initialize parameters when a new page layout description is loaded. More...
 
void ReCreateVToolbar () override
 creates or updates the right vertical toolbar. More...
 
void ReCreateOptToolbar () override
 Create or update the left vertical toolbar (option 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 ()
 Displays the short filename (if exists) loaded file on the caption of the main window. More...
 
void InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
 Allow a frame to load its preference panels (if any) into the preferences dialog. More...
 
void LoadSettings (APP_SETTINGS_BASE *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (APP_SETTINGS_BASE *aCfg) override
 Save common frame parameters to a configuration data file. More...
 
void OnSelectPage (wxCommandEvent &event)
 
void OnSelectCoordOriginCorner (wxCommandEvent &event)
 called when the user select one of the 4 page corner as corner reference (or the left top paper corner) More...
 
void OnSelectTitleBlockDisplayMode (wxCommandEvent &event)
 Toggle the display mode between the normal mode and the editor mode: In normal mode, title block texts are shown like they will be shown in other kicad applications: the format symbols in texts are replaced by the actual text. More...
 
void ToPrinter (bool doPreview)
 Function ToPrinter Open a dialog frame to print layers. More...
 
void Files_io (wxCommandEvent &event)
 
virtual void PrintPage (const RENDER_SETTINGS *aSettings) override
 Virtual function PrintPage used to print a page. More...
 
void OnFileHistory (wxCommandEvent &event)
 
void OnClearFileHistory (wxCommandEvent &aEvent)
 
wxString GetCurrentFileName () const override
 
void SetCurrentFileName (const wxString &aName)
 Stores the current layout descr file filename. More...
 
void HardRedraw () override
 Refresh the library tree and redraw the window. More...
 
DS_DATA_ITEMAddPageLayoutItem (int aType)
 Function AddPageLayoutItem Add a new item to the page layout item list. More...
 
void OnModify ()
 Must be called after a change in order to set the "modify" flag. More...
 
void SaveCopyInUndoList ()
 Save a copy of the description (in a S expr string) for Undo/redo commands. More...
 
void GetLayoutFromRedoList ()
 Redo the last edit: More...
 
void GetLayoutFromUndoList ()
 Undo the last edit: More...
 
void RollbackFromUndo ()
 Apply the last command in Undo List without stacking a Redo. More...
 
void ClearUndoORRedoList (UNDO_REDO_LIST whichList, int aItemCount=-1) override
 Function ClearUndoORRedoList. 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...
 
wxFindReplaceData & GetFindReplaceData ()
 
wxArrayString & GetFindHistoryList ()
 
bool GetShowPolarCoords () const
 For those frames that support polar coordinates. More...
 
void SetShowPolarCoords (bool aShow)
 
void ToggleUserUnits () override
 
void GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
 Get the pair or units in current use. More...
 
wxPoint GetNearestGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize location to aPosition. More...
 
wxPoint GetNearestHalfGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize / 2 location to aPosition. More...
 
virtual ORIGIN_TRANSFORMSGetOriginTransforms ()
 Return a reference to the default ORIGIN_TRANSFORMS object. More...
 
virtual COLOR4D GetDrawBgColor () const
 
virtual void SetDrawBgColor (COLOR4D aColor)
 
virtual COLOR_SETTINGSGetColorSettings () const
 Returns a pointer to the active color theme settings. More...
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
 
virtual wxString GetScreenDesc () const
 
virtual BASE_SCREENGetScreen () const
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242). More...
 
void EraseMsgBox ()
 
virtual void ReCreateAuxiliaryToolbar ()
 
bool IsGridVisible () const
 
virtual void SetGridVisibility (bool aVisible)
 
virtual COLOR4D GetGridColor ()
 
virtual void SetGridColor (COLOR4D aColor)
 
void OnSelectGrid (wxCommandEvent &event)
 Command event handler for selecting grid sizes. More...
 
void OnGridSettings (wxCommandEvent &event)
 
void UpdateGridSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.). More...
 
void OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
 Update the checked item in the grid combobox. More...
 
void UpdateZoomSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
 
void OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
 Update the checked item in the zoom combobox. More...
 
const wxString GetZoomLevelIndicator () const
 Return a human readable value for display in dialogs. More...
 
virtual void OnSelectZoom (wxCommandEvent &event)
 Set the zoom factor when selected by the zoom list box in the main tool bar. More...
 
virtual void OnSize (wxSizeEvent &event)
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
void OnMove (wxMoveEvent &aEvent) override
 
virtual void Zoom_Automatique (bool aWarpPointer)
 Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...
 
void FocusOnLocation (const wxPoint &aPos)
 Useful to focus on a particular location, in find functions. More...
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g. More...
 
void PrintDrawingSheet (const RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
 Prints the drawing-sheet (frame and title block). More...
 
void DisplayToolMsg (const wxString &msg) override
 
virtual void OnPageSettingsChange ()
 Called when modifying the page settings. More...
 
void DisplayUnitsMsg ()
 Display current unit pane in the status bar. More...
 
void CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
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...
 
virtual void ParseArgs (wxCmdLineParser &aParser)
 Handle command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=nullptr, wxWindow *aResultantFocusWindow=nullptr)
 Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...
 
virtual void KiwayMailIn (KIWAY_EXPRESS &aEvent)
 Receive KIWAY_EXPRESS messages from other players. More...
 
bool Destroy () override
 Our version of Destroy() which is virtual from wxWidgets. More...
 
bool IsModal () const override
 Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame. More...
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
EDA_UNITS GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS aUnits)
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
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 &event)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
virtual void RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
 Register a UI update handler for the control with ID aID. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
 Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...
 
virtual void UnregisterUIUpdateHandler (int aID) override
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
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)
 
void PrintMsg (const wxString &text)
 
void CreateInfoBar ()
 
void FinishAUIInitialization ()
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...
 
void ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...
 
virtual APP_SETTINGS_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)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void ShowChangedLanguage ()
 Redraw the menus and what not in current language. More...
 
virtual void ThemeChanged ()
 Process light/dark theme change. More...
 
virtual void ProjectChanged ()
 Notification event that the project has changed. More...
 
const wxString & GetAboutTitle () const
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
virtual void ClearUndoRedoList ()
 Clear the undo and redo list using ClearUndoORRedoList() More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Add a command to undo in the undo list. More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Add a command to redo in the redo list. More...
 
virtual PICKED_ITEMS_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 std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
bool GetDoImmediateActions () const
 Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...
 
MOUSE_DRAG_ACTION GetDragAction () const
 Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...
 
bool GetMoveWarpsCursor () const
 Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. 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...
 

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

void setupUIConditions () override
 Setup the UI conditions for the various actions and their controls in this frame. More...
 
bool saveCurrentPageLayout ()
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void unitsChangeRefresh () override
 Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...
 
void setupUnits (APP_SETTINGS_BASE *aCfg)
 
void resolveCanvasType ()
 Determines the Canvas type to load (with prompt if required) and initializes m_canvasType. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
virtual void handleActivateEvent (wxActivateEvent &aEvent)
 Handle a window activation event. More...
 
void onActivate (wxActivateEvent &aEvent)
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 An event handler called on a language menu selection. More...
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event. More...
 
virtual bool isAutoSaveRequired () const
 Return the auto save status of the application. More...
 
virtual bool doAutoSave ()
 This should be overridden by the derived class to handle the auto save feature. More...
 
void onSystemColorChange (wxSysColourChangedEvent &aEvent)
 
void initExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 

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
 
bool m_showPageLimits
 
COLOR4D m_gridColor
 
COLOR4D m_drawBgColor
 
int m_undoRedoCountMax
 
bool m_polarCoords
 
bool m_showBorderAndTitleBlock
 
long m_firstRunDialogSetting
 
wxChoice * m_gridSelectBox
 
wxChoice * m_zoomSelectBox
 
ACTION_TOOLBARm_mainToolBar
 
ACTION_TOOLBARm_auxiliaryToolBar
 
ACTION_TOOLBARm_drawToolBar
 
ACTION_TOOLBARm_optionsToolBar
 
wxFindReplaceData * m_findReplaceData
 
wxArrayString m_findStringHistoryList
 
wxArrayString m_replaceStringHistoryList
 
EDA_MSG_PANELm_messagePanel
 
int m_msgFrameHeight
 
COLOR_SETTINGSm_colorSettings
 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
 
FRAME_T m_ident
 
wxPoint m_framePos
 
wxSize m_frameSize
 
bool m_maximizeByDefault
 
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_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 Map containing the UI update handlers registered with wx for each action. More...
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 Set by the close window event handler after frames are asked if they can close. More...
 
bool m_isClosing
 Set by NonUserClose() to indicate that the user did not request the current close. More...
 
bool m_isNonUserClose
 
TOOL_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 Attributes

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

Detailed Description

PL_EDITOR_FRAME is the main window used in the drawing sheet editor.

Definition at line 46 of file pl_editor_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

◆ UNDO_REDO_LIST

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.
Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 524 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ PL_EDITOR_FRAME()

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

Definition at line 80 of file pl_editor_frame.cpp.

80  :
81  EDA_DRAW_FRAME( aKiway, aParent, FRAME_PL_EDITOR, wxT( "PlEditorFrame" ),
82  wxDefaultPosition, wxDefaultSize,
85  m_originSelectBox( nullptr ),
87  m_pageSelectBox( nullptr ),
88  m_propertiesPagelayout( nullptr )
89 {
90  m_maximizeByDefault = true;
92 
93  m_showBorderAndTitleBlock = true; // true for reference drawings.
95  SetShowPageLimits( true );
96  m_aboutTitle = _( "KiCad Drawing Sheet Editor" );
97 
98  // Give an icon
99  wxIcon icon;
100  wxIconBundle icon_bundle;
101 
102  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pagelayout_editor ) );
103  icon_bundle.AddIcon( icon );
104  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pagelayout_editor_32 ) );
105  icon_bundle.AddIcon( icon );
106  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pagelayout_editor_16 ) );
107  icon_bundle.AddIcon( icon );
108 
109  SetIcons( icon_bundle );
110 
111  // Create GAL canvas
112  auto* drawPanel = new PL_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
115  SetCanvas( drawPanel );
116 
117  LoadSettings( config() );
118 
119  wxSize pageSizeIU = GetPageLayout().GetPageSettings().GetSizeIU();
120  SetScreen( new BASE_SCREEN( pageSizeIU ) );
121 
122  setupTools();
124  ReCreateMenuBar();
128 
129  wxWindow* stsbar = GetStatusBar();
130  int dims[] = {
131 
132  // balance of status bar on far left is set to a default or whatever is left over.
133  -1,
134 
135  // When using GetTextSize() remember the width of '1' is not the same
136  // as the width of '0' unless the font is fixed width, and it usually won't be.
137 
138  // zoom:
139  KIUI::GetTextSize( wxT( "Z 762000" ), stsbar ).x + 10,
140 
141  // cursor coords
142  KIUI::GetTextSize( wxT( "X 0234.567 Y 0234.567" ), stsbar ).x + 10,
143 
144  // delta distances
145  KIUI::GetTextSize( wxT( "dx 0234.567 dx 0234.567" ), stsbar ).x + 10,
146 
147  // grid size
148  KIUI::GetTextSize( wxT( "grid 0234.567" ), stsbar ).x + 10,
149 
150  // Coord origin (use the bigger message)
151  KIUI::GetTextSize( _( "coord origin: Right Bottom page corner" ), stsbar ).x + 10,
152 
153  // units display, Inches is bigger than mm
154  KIUI::GetTextSize( _( "Inches" ), stsbar ).x + 20
155  };
156 
157  SetStatusWidths( arrayDim( dims ), dims );
158 
159  m_auimgr.SetManagedWindow( this );
160 
161  CreateInfoBar();
163 
164  // Rows; layers 4 - 6
165  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" )
166  .Top().Layer( 6 ) );
167  m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" )
168  .Left().Layer( 3 ) );
169  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" )
170  .Bottom().Layer( 6 ) );
171 
172  // Columns; layers 1 - 3
173  m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" )
174  .Right().Layer( 2 ) );
175 
176  m_auimgr.AddPane( m_propertiesPagelayout, EDA_PANE().Palette().Name( "Props" )
177  .Right().Layer( 3 )
178  .Caption( _( "Properties" ) )
179  .MinSize( m_propertiesPagelayout->GetMinSize() )
180  .BestSize( m_propertiesFrameWidth, -1 ) );
181 
182  // Center
183  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" )
184  .Center() );
185 
187 
190 
191  // Add the exit key handler
192  setupUnits( config() );
193 
194  wxPoint originCoord = ReturnCoordOriginCorner();
195  SetGridOrigin( originCoord );
196 
197  // Initialize the current page layout
198 #if 0 //start with empty layout
201 #else // start with the default Kicad layout
203 #endif
204  OnNewPageLayout();
205 
206  // Ensure the window is on top
207  Raise();
208 
209  // Register a call to update the toolbar sizes. It can't be done immediately because
210  // it seems to require some sizes calculated that aren't yet (at least on GTK).
211  CallAfter( [&]()
212  {
213  // Ensure the controls on the toolbars all are correctly sized
215  } );
216 }
void ClearList()
Erase the list of items.
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void 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.
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
ACTION_TOOLBAR * m_optionsToolBar
virtual void SetScreen(BASE_SCREEN *aScreen)
void ReCreateVToolbar() override
creates or updates the right vertical toolbar.
wxPoint ReturnCoordOriginCorner() const
calculate the position (in page, in iu) of the corner used as coordinate origin of items
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
void ReCreateMenuBar() override
Recreates the menu bar.
PROPERTIES_FRAME display properties of the current item.
void resolveCanvasType()
Determines the Canvas type to load (with prompt if required) and initializes m_canvasType.
#define PL_EDITOR_FRAME_NAME
void UpdateToolbarControlSizes() override
Update the sizes of any controls in the toolbars of the frame.
wxAuiManager m_auimgr
ACTION_TOOLBAR * m_mainToolBar
PAGE_INFO & GetPageSettings()
EDA_DRAW_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
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 page layout description is needed So if the list is empty,...
Definition: ds_data_model.h:81
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:58
void FinishAUIInitialization()
EDA_MSG_PANEL * m_messagePanel
GAL not used (the legacy wxDC engine is used)
bool m_showBorderAndTitleBlock
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:40
void OnNewPageLayout()
Must be called to initialize parameters when a new page layout description is loaded.
wxSize GetMinSize() const override
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
#define KICAD_DEFAULT_DRAWFRAME_STYLE
Specialization of the wxAuiPaneInfo class for KiCad panels.
wxChoice * m_pageSelectBox
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void ReCreateOptToolbar() override
Create or update the left vertical toolbar (option toolbar.
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Changes the current rendering backend.
#define _(s)
Definition: 3d_actions.cpp:33
void setupUnits(APP_SETTINGS_BASE *aCfg)
PROPERTIES_FRAME * m_propertiesPagelayout
The last filename chosen to be proposed to the user.
void SetGridOrigin(const wxPoint &aPoint) override
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void SetShowPageLimits(bool aShow)
const PL_EDITOR_LAYOUT & GetPageLayout() const
void ReCreateHToolbar() override
wxChoice * m_originSelectBox
wxString m_aboutTitle
ACTION_TOOLBAR * m_drawToolBar
wxBitmap KiBitmap(BITMAPS aBitmap)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:104

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

◆ ~PL_EDITOR_FRAME()

PL_EDITOR_FRAME::~PL_EDITOR_FRAME ( )

Definition at line 219 of file pl_editor_frame.cpp.

220 {
221  // Shutdown all running tools
222  if( m_toolManager )
224 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157

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

Member Function Documentation

◆ ActivateGalCanvas()

void EDA_DRAW_FRAME::ActivateGalCanvas ( )
virtualinherited

Use to start up the GAL drawing canvas.

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

Definition at line 649 of file eda_draw_frame.cpp.

650 {
651  GetCanvas()->SetEvtHandlerEnabled( true );
652  GetCanvas()->StartDrawing();
653 }
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 GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), SCH_BASE_FRAME::createCanvas(), SCH_DRAW_PANEL::OnShow(), and EDA_DRAW_FRAME::SwitchCanvas().

◆ AddPageLayoutItem()

DS_DATA_ITEM * PL_EDITOR_FRAME::AddPageLayoutItem ( int  aType)

Function AddPageLayoutItem Add a new item to the page layout item list.

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

Definition at line 807 of file pl_editor_frame.cpp.

808 {
809  DS_DATA_ITEM * item = NULL;
810 
811  switch( aType )
812  {
814  item = new DS_DATA_ITEM_TEXT( wxT( "Text") );
815  break;
816 
819  break;
820 
822  item = new DS_DATA_ITEM( DS_DATA_ITEM::DS_RECT );
823  break;
824 
826  item = new DS_DATA_ITEM_POLYGONS();
827  break;
828 
830  {
831  wxFileDialog fileDlg( this, _( "Choose Image" ), wxEmptyString, wxEmptyString,
832  _( "Image Files" ) + wxS( " " ) + wxImage::GetImageExtWildcard(),
833  wxFD_OPEN );
834 
835  if( fileDlg.ShowModal() != wxID_OK )
836  return NULL;
837 
838  wxString fullFilename = fileDlg.GetPath();
839 
840  if( !wxFileExists( fullFilename ) )
841  {
842  wxMessageBox( _( "Couldn't load image from \"%s\"" ), fullFilename );
843  break;
844  }
845 
846  BITMAP_BASE* image = new BITMAP_BASE();
847 
848  if( !image->ReadImageFile( fullFilename ) )
849  {
850  wxMessageBox( _( "Couldn't load image from \"%s\"" ), fullFilename );
851  delete image;
852  break;
853  }
854 
855  // Set the scale factor for pl_editor (it is set for eeschema by default)
856  image->SetPixelSizeIu( IU_PER_MILS * 1000.0 / image->GetPPI() );
857  item = new DS_DATA_ITEM_BITMAP( image );
858  }
859  break;
860  }
861 
862  if( item == NULL )
863  return NULL;
864 
866  item->SyncDrawItems( nullptr, GetCanvas()->GetView() );
867 
868  return item;
869 }
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void SyncDrawItems(DS_DRAW_ITEM_LIST *aCollector, KIGFX::VIEW *aView)
This class handle bitmap images in KiCad.
Definition: bitmap_base.h:51
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
#define NULL
Drawing sheet structure type definitions.
Definition: ds_data_item.h:95
#define _(s)
Definition: 3d_actions.cpp:33
#define IU_PER_MILS
Definition: plotter.cpp:137
void Append(DS_DATA_ITEM *aItem)

References _, DS_DATA_MODEL::Append(), DS_DATA_ITEM::DS_BITMAP, DS_DATA_ITEM::DS_POLYPOLYGON, DS_DATA_ITEM::DS_RECT, DS_DATA_ITEM::DS_SEGMENT, DS_DATA_ITEM::DS_TEXT, GetCanvas(), DS_DATA_MODEL::GetTheInstance(), image, IU_PER_MILS, NULL, 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 417 of file eda_base_frame.cpp.

418 {
419  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
420  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
421 
422  helpMenu->Add( ACTIONS::help );
423  helpMenu->Add( ACTIONS::gettingStarted );
424  helpMenu->Add( ACTIONS::listHotKeys );
425  helpMenu->Add( ACTIONS::getInvolved );
426  helpMenu->Add( ACTIONS::donate );
427  helpMenu->Add( ACTIONS::reportBug );
428 
429  helpMenu->AppendSeparator();
430  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
431 
432  aMenuBar->Append( helpMenu, _( "&Help" ) );
433 }
static TOOL_ACTION listHotKeys
Definition: actions.h:180
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:47
static TOOL_ACTION reportBug
Cursor control event types.
Definition: actions.h:183
static TOOL_ACTION donate
Definition: actions.h:181
Handle actions that are shared between different applications.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:179
static TOOL_ACTION getInvolved
Definition: actions.h:182
static TOOL_ACTION gettingStarted
Definition: actions.h:178

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

444 {
445  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
446  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
447 
448  aMenu.AddSeparator( 1000 );
449 
450  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
451  zoomMenu->SetTool( commonTools );
452  aToolMenu.AddSubMenu( zoomMenu );
453 
454  auto gridMenu = std::make_shared<GRID_MENU>( this );
455  gridMenu->SetTool( commonTools );
456  aToolMenu.AddSubMenu( gridMenu );
457 
458  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
459  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
460 }
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:46
Handles action that are shared between different applications.
Definition: common_tools.h:37
void AddSeparator(int aOrder=ANY_ORDER)
Add a separator to the menu.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157

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

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

◆ AppendMsgPanel()

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

Append a message to the message panel.

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

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

Definition at line 594 of file eda_draw_frame.cpp.

596 {
597  if( m_messagePanel )
598  m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
599 }
EDA_MSG_PANEL * m_messagePanel
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, int aPadding=6)
Function AppendMessage appends a message to the message panel.
Definition: msgpanel.cpp:119

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

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

◆ canCloseWindow()

bool PL_EDITOR_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 347 of file pl_editor_frame.cpp.

348 {
349  // Shutdown blocks must be determined and vetoed as early as possible
351  && aEvent.GetId() == wxEVT_QUERY_END_SESSION
352  && IsContentModified() )
353  {
354  return false;
355  }
356 
357  if( IsContentModified() )
358  {
359  wxFileName filename = GetCurrentFileName();
360  wxString msg = _( "Save changes to \"%s\" before closing?" );
361 
362  if( !HandleUnsavedChanges( this, wxString::Format( msg, filename.GetFullName() ),
363  [&]() -> bool
364  {
365  return saveCurrentPageLayout();
366  } ) )
367  {
368  return false;
369  }
370  }
371 
372  return true;
373 }
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:207
bool IsContentModified() override
Get if the page layout has been modified but not saved.
wxString GetCurrentFileName() const override
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: gtk/app.cpp:65
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
#define _(s)
Definition: 3d_actions.cpp:33

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

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 1084 of file eda_base_frame.cpp.

1085 {
1086  SetUserUnits( aUnits );
1088 
1089  wxCommandEvent e( UNITS_CHANGED );
1090  ProcessEventLocally( e );
1091 }
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void SetUserUnits(EDA_UNITS aUnits)

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

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

◆ CheckForAutoSaveFile()

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

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

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

Parameters
aFileNameA wxFileName object containing the file name to check.

Definition at line 972 of file eda_base_frame.cpp.

973 {
974  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
975 
976  wxFileName autoSaveFileName = aFileName;
977 
978  // Check for auto save file.
979  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
980 
981  wxLogTrace( traceAutoSave,
982  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
983 
984  if( !autoSaveFileName.FileExists() )
985  return;
986 
987  wxString msg = wxString::Format( _(
988  "Well this is potentially embarrassing!\n"
989  "It appears that the last time you were editing the file\n"
990  "\"%s\"\n"
991  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
992  aFileName.GetFullName()
993  );
994 
995  int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
996  this );
997 
998  // Make a backup of the current file, delete the file, and rename the auto save file to
999  // the file name.
1000  if( response == wxYES )
1001  {
1002  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1003  {
1004  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1005  Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1006  }
1007  }
1008  else
1009  {
1010  wxLogTrace( traceAutoSave,
1011  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1012 
1013  // Remove the auto save file when using the previous file as is.
1014  wxRemoveFile( autoSaveFileName.GetFullPath() );
1015  }
1016 }
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:106
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
static wxString GetAutoSaveFilePrefix()
#define _(s)
Definition: 3d_actions.cpp:33

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

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

◆ ClearFileHistory()

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

Removes all files from the file history.

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

Definition at line 869 of file eda_base_frame.cpp.

870 {
871  if( !aFileHistory )
872  aFileHistory = m_fileHistory;
873 
874  wxASSERT( aFileHistory );
875 
876  aFileHistory->ClearFileHistory();
877 
878  // Update the menubar to update the file history menu
879  if( GetMenuBar() )
880  {
881  ReCreateMenuBar();
882  GetMenuBar()->Refresh();
883  }
884 }
void ClearFileHistory()
Clear all entries from the file history.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

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

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

void PL_EDITOR_FRAME::ClearUndoORRedoList ( UNDO_REDO_LIST  whichList,
int  aItemCount = -1 
)
overridevirtual

Function ClearUndoORRedoList.

Reimplemented from EDA_BASE_FRAME.

Definition at line 897 of file pl_editor_frame.cpp.

898 {
899  if( aItemCount == 0 )
900  return;
901 
902  UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
903  unsigned icnt = list.m_CommandsList.size();
904 
905  if( aItemCount > 0 )
906  icnt = aItemCount;
907 
908  for( unsigned ii = 0; ii < icnt; ii++ )
909  {
910  if( list.m_CommandsList.size() == 0 )
911  break;
912 
913  PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
914  list.m_CommandsList.erase( list.m_CommandsList.begin() );
915 
916  curr_cmd->ClearListAndDeleteItems();
917  delete curr_cmd; // Delete command
918  }
919 }
UNDO_REDO_CONTAINER m_undoList
A holder to handle a list of undo (or redo) commands.
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
A holder to handle information on schematic or board items.
UNDO_REDO_CONTAINER m_redoList
void ClearListAndDeleteItems()
Delete the list of pickers AND the data pointed by #m_PickedItem or #m_PickedItemLink according to th...

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

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

594 {
595  EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
596 
597  SETTINGS_MANAGER& settingsManager = Pgm().GetSettingsManager();
598  PL_EDITOR_SETTINGS* cfg = settingsManager.GetAppSettings<PL_EDITOR_SETTINGS>();
599  COLOR_SETTINGS* colors = settingsManager.GetColorSettings( cfg->m_ColorTheme );
600 
601  GetCanvas()->GetView()->GetPainter()->GetSettings()->LoadColors( colors );
602 
604  GetCanvas()->Refresh();
605 
607  Layout();
608  SendSizeEvent();
609 }
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
Definition: view.cpp:1415
void RecreateToolbars()
Rebuild all toolbars, and update the checked state of check tools.
Color has changed.
Definition: view_item.h:53
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:207
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.
AppSettings * GetAppSettings(bool aLoadNow=true)
Returns a handle to the a given settings by type If the settings have already been loaded,...
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
Color settings are a bit different than most of the settings objects in that there can be more than o...
virtual void LoadColors(const COLOR_SETTINGS *aSettings)
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:184

References KIGFX::COLOR, EDA_DRAW_FRAME::CommonSettingsChanged(), SETTINGS_MANAGER::GetAppSettings(), GetCanvas(), SETTINGS_MANAGER::GetColorSettings(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::GetView(), KIGFX::RENDER_SETTINGS::LoadColors(), APP_SETTINGS_BASE::m_ColorTheme, Pgm(), EDA_DRAW_FRAME::RecreateToolbars(), EDA_DRAW_PANEL_GAL::Refresh(), and KIGFX::VIEW::UpdateAllItems().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const
virtualinherited

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

Reimplemented in KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 710 of file eda_base_frame.cpp.

711 {
712  // KICAD_MANAGER_FRAME overrides this
713  return Kiface().KifaceSettings();
714 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:92
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

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

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited

Get the configuration base name.

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

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

Reimplemented from TOOLS_HOLDER.

Definition at line 338 of file eda_base_frame.h.

339  {
340  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
341  return baseCfgName;
342  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

Definition at line 735 of file eda_base_frame.cpp.

736 {
737 #if defined( __WXOSX_MAC__ )
739 #else
740  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
741 
742  m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
743 #endif
744 }
wxAuiManager m_auimgr
virtual wxWindow * GetToolCanvas() const =0
Canvas access.
Specialization of the wxAuiPaneInfo class for KiCad panels.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:71
WX_INFOBAR * m_infoBar

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

◆ CreateServer()

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

Definition at line 48 of file eda_dde.cpp.

49 {
50  wxIPV4address addr;
51 
52  // Set the port number
53  addr.Service( service );
54 
55  // Listen on localhost only if requested
56  if( local )
57  addr.Hostname( HOSTNAME );
58 
59  delete m_socketServer;
60  m_socketServer = new wxSocketServer( addr );
61 
62  m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
63  m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
64  m_socketServer->Notify( true );
65 }
static const wxString HOSTNAME(wxT("localhost"))
wxSocketServer * m_socketServer

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

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

◆ CurrentToolName()

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

Definition at line 99 of file tools_holder.cpp.

100 {
101  if( m_toolStack.empty() )
102  return ACTIONS::selectionTool.GetName();
103  else
104  return m_toolStack.back();
105 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:163
static TOOL_ACTION selectionTool
Definition: actions.h:156

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

Referenced by TOOL_MANAGER::processEvent().

◆ Destroy()

◆ DismissModal()

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

Definition at line 161 of file kiway_player.cpp.

162 {
163  m_modal_ret_val = aRetVal;
164  m_modal_string = aResult;
165 
166  if( m_modal_loop )
167  {
168  m_modal_loop->Exit();
169  m_modal_loop = 0; // this marks it as dismissed.
170  }
171 
172  Show( false );
173 }
bool m_modal_ret_val
Definition: kiway_player.h:199
wxString m_modal_string
Definition: kiway_player.h:198
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:196

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

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

◆ DisplayGridMsg()

void PL_EDITOR_FRAME::DisplayGridMsg ( )
overridevirtual

Display current grid size in the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 655 of file pl_editor_frame.cpp.

656 {
657  wxString line;
658  wxString gridformatter;
659 
660  switch( m_userUnits )
661  {
662  case EDA_UNITS::INCHES: gridformatter = "grid %.3f"; break;
663  case EDA_UNITS::MILLIMETRES: gridformatter = "grid %.4f"; break;
664  default: gridformatter = "grid %f"; break;
665  }
666 
667  double grid = To_User_Unit( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x );
668  line.Printf( gridformatter, grid );
669 
670  SetStatusText( line, 4 );
671 }
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
double To_User_Unit(EDA_UNITS aUnit, double aValue)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:91
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

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

Referenced by UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 463 of file eda_draw_frame.cpp.

464 {
465  SetStatusText( msg, 6 );
466 }

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

481 {
482  wxString msg;
483 
484  switch( m_userUnits )
485  {
486  case EDA_UNITS::INCHES: msg = _( "inches" ); break;
487  case EDA_UNITS::MILS: msg = _( "mils" ); break;
488  case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
489  default: msg = _( "Units" ); break;
490  }
491 
492  SetStatusText( msg, 5 );
493 }
#define _(s)
Definition: 3d_actions.cpp:33
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

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

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

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

Returns
true if the auto save was successful otherwise false.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 301 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void PL_EDITOR_FRAME::doCloseWindow ( )
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 376 of file pl_editor_frame.cpp.

377 {
378  // do not show the window because we do not want any paint event
379  Show( false );
380 
381  // clean up the data before the view is destroyed
383 
384  // On Linux, m_propertiesPagelayout must be destroyed
385  // before deleting the main frame to avoid a crash when closing
386  m_propertiesPagelayout->Destroy();
387  Destroy();
388 }
void ClearList()
Erase the list of items.
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
PROPERTIES_FRAME * m_propertiesPagelayout
The last filename chosen to be proposed to the user.
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.

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 232 of file eda_draw_frame.cpp.

233 {
234  if( m_messagePanel )
236 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:223

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

virtual void EDA_DRAW_FRAME::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 200 of file eda_draw_frame.h.

200 {}

Referenced by EDA_DRAW_FRAME::OnSockRequest().

◆ Files_io()

void PL_EDITOR_FRAME::Files_io ( wxCommandEvent &  event)

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

88 {
89  wxString msg;
90  int id = event.GetId();
91  wxString filename = GetCurrentFileName();
93 
94  if( filename.IsEmpty() && id == wxID_SAVE )
95  id = wxID_SAVEAS;
96 
97  if( ( id == wxID_NEW || id == wxID_OPEN ) && IsContentModified() )
98  {
99  if( !HandleUnsavedChanges( this, _( "The current page layout has been modified. "
100  "Save changes?" ),
101  [&]()->bool { return saveCurrentPageLayout(); } ) )
102  {
103  return;
104  }
105  }
106 
107  switch( id )
108  {
109  case wxID_NEW:
110  pglayout.AllowVoidList( true );
111  SetCurrentFileName( wxEmptyString );
112  pglayout.ClearList();
113  OnNewPageLayout();
114  break;
115 
117  {
118  wxFileDialog openFileDialog( this, _( "Append Existing Drawing Sheet" ),
119  wxEmptyString, wxEmptyString,
120  PageLayoutDescrFileWildcard(), wxFD_OPEN );
121 
122  if( openFileDialog.ShowModal() == wxID_CANCEL )
123  return;
124 
125  filename = openFileDialog.GetPath();
126 
127  if( ! InsertPageLayoutDescrFile( filename ) )
128  {
129  msg.Printf( _( "Unable to load %s file" ), filename );
130  DisplayErrorMessage( this, msg );
131  }
132  else
133  {
134  GetScreen()->SetModify();
135  HardRedraw();
136  msg.Printf( _( "File \"%s\" inserted" ), filename );
137  SetStatusText( msg );
138  }
139  }
140  break;
141 
142  case wxID_OPEN:
143  {
144  wxFileDialog openFileDialog( this, _( "Open" ), wxEmptyString, wxEmptyString,
145  PageLayoutDescrFileWildcard(), wxFD_OPEN );
146 
147  if( openFileDialog.ShowModal() == wxID_CANCEL )
148  return;
149 
150  filename = openFileDialog.GetPath();
151 
152  if( ! LoadPageLayoutDescrFile( filename ) )
153  {
154  msg.Printf( _( "Unable to load %s file" ), filename );
155  DisplayErrorMessage( this, msg );
156  }
157  else
158  {
159  OnNewPageLayout();
160  msg.Printf( _( "File \"%s\" saved." ), filename );
161  SetStatusText( msg );
162  }
163  }
164  break;
165 
166  case wxID_SAVE:
167  if( !SavePageLayoutDescrFile( filename ) )
168  {
169  msg.Printf( _( "Unable to write \"%s\"" ), filename );
170  DisplayErrorMessage( this, msg );
171  }
172  else
173  {
174  msg.Printf( _("File \"%s\" saved."), filename );
175  SetStatusText( msg );
176  }
177  break;
178 
179  case wxID_SAVEAS:
180  {
181  wxString dir = PATHS::GetUserTemplatesPath();
182  wxFileDialog openFileDialog( this, _( "Save As" ), dir, wxEmptyString,
184  wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
185 
186  if( openFileDialog.ShowModal() == wxID_CANCEL )
187  return;
188 
189  filename = openFileDialog.GetPath();
190  // Ensure the file has the right extension:
191  // because a name like name.subname.subsubname is legal,
192  // add the right extension without replacing the wxFileName
193  // extension
194  wxFileName fn(filename);
195 
196  if( fn.GetExt() != PageLayoutDescrFileExtension )
197  filename << wxT(".") << PageLayoutDescrFileExtension;
198 
199  if( !SavePageLayoutDescrFile( filename ) )
200  {
201  msg.Printf( _( "Unable to create \"%s\"" ), filename );
202  DisplayErrorMessage( this, msg );
203  }
204 
205  else
206  {
207  msg.Printf( _("File \"%s\" saved."), filename );
208  SetStatusText( msg );
209 
210  if( GetCurrentFileName().IsEmpty() )
211  SetCurrentFileName( filename );
212  }
213  }
214  break;
215 
216  default:
217  break;
218  }
219 }
void ClearList()
Erase the list of items.
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:207
bool IsContentModified() override
Get if the page layout has been modified but not saved.
wxString PageLayoutDescrFileWildcard()
Handle the graphic items list to draw/plot the frame and title block.
Definition: ds_data_model.h:38
void HardRedraw() override
Refresh the library tree and redraw the window.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:265
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
wxString GetCurrentFileName() const override
void AllowVoidList(bool Allow)
In KiCad applications, a page layout description is needed So if the list is empty,...
Definition: ds_data_model.h:81
void OnNewPageLayout()
Must be called to initialize parameters when a new page layout description is loaded.
static wxString GetUserTemplatesPath()
Gets the user path for custom templates.
Definition: paths.cpp:86
bool SavePageLayoutDescrFile(const wxString &aFullFileName)
Function SavePageLayoutDescrFile Save the current layout in a .kicad_wks page layout descr file.
const std::string PageLayoutDescrFileExtension
void SetCurrentFileName(const wxString &aName)
Stores the current layout descr file filename.
#define _(s)
Definition: 3d_actions.cpp:33
bool InsertPageLayoutDescrFile(const wxString &aFullFileName)
Function InsertPageLayoutDescrFile Loads a .kicad_wks page layout descr file, and add items to the cu...
bool LoadPageLayoutDescrFile(const wxString &aFullFileName)
Function LoadPageLayoutDescrFile Loads a .kicad_wks page layout descr file.
void SetModify()
Definition: base_screen.h:59
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.

References _, DS_DATA_MODEL::AllowVoidList(), DS_DATA_MODEL::ClearList(), DisplayErrorMessage(), GetCurrentFileName(), EDA_DRAW_FRAME::GetScreen(), DS_DATA_MODEL::GetTheInstance(), PATHS::GetUserTemplatesPath(), HandleUnsavedChanges(), HardRedraw(), ID_APPEND_DESCR_FILE, InsertPageLayoutDescrFile(), IsContentModified(), LoadPageLayoutDescrFile(), OnNewPageLayout(), PageLayoutDescrFileExtension, PageLayoutDescrFileWildcard(), saveCurrentPageLayout(), SavePageLayoutDescrFile(), SetCurrentFileName(), and BASE_SCREEN::SetModify().

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

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 747 of file eda_base_frame.cpp.

748 {
749 #if defined( __WXOSX_MAC__ )
750  m_auimgr.Update();
751 #else
752  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
753  // hiding it.
754  m_auimgr.Update();
755 
756  // We don't want the infobar displayed right away
757  m_auimgr.GetPane( "InfoBar" ).Hide();
758  m_auimgr.Update();
759 #endif
760 }
wxAuiManager m_auimgr

References EDA_BASE_FRAME::m_auimgr.

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const wxPoint &  aPos)
inherited

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

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

Parameters
aPosis the point to go to.

Definition at line 796 of file eda_draw_frame.cpp.

797 {
798  bool centerView = false;
799  BOX2D r = GetCanvas()->GetView()->GetViewport();
800 
801  // Center if we're off the current view, or within 10% of its edge
802  r.Inflate( - (int) r.GetWidth() / 10 );
803 
804  if( !r.Contains( aPos ) )
805  centerView = true;
806 
807  // Center if we're behind an obscuring dialog, or within 10% of its edge
808  wxWindow* dialog = findDialog( GetChildren() );
809 
810  if( dialog )
811  {
812  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
813  dialog->GetSize() );
814  dialogRect.Inflate( dialogRect.GetWidth() / 10 );
815 
816  if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
817  centerView = true;
818  }
819 
820  if( centerView )
821  {
822  // If a dialog partly obscures the window, then center on the uncovered area.
823  if( dialog )
824  {
825  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
826  dialog->GetSize() );
827  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
828  }
829  else
830  GetCanvas()->GetView()->SetCenter( aPos );
831  }
832 
834 }
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition: view.cpp:514
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:580
coord_type GetWidth() const
Definition: box2.h:197
bool Contains(const Vec &aPoint) const
Function Contains.
Definition: box2.h:151
wxWindow * findDialog(wxWindowList &aList)
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW 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.
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:302

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

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

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )
inlinestaticprotectedinherited
Returns
the string to prepend to a file name for automatic save.

Definition at line 582 of file eda_base_frame.h.

583  {
584  return wxT( "_autosave-" );
585  }

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 190 of file eda_base_frame.h.

190 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetCanvas()

◆ GetColorSettings()

COLOR_SETTINGS * EDA_DRAW_FRAME::GetColorSettings ( ) const
virtualinherited

Returns a pointer to the active color theme settings.

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

Definition at line 969 of file eda_draw_frame.cpp.

970 {
971  if( !m_colorSettings )
972  {
973  COLOR_SETTINGS* colorSettings = Pgm().GetSettingsManager().GetColorSettings();
974 
975  const_cast<EDA_DRAW_FRAME*>( this )->m_colorSettings = colorSettings;
976  }
977 
978  return m_colorSettings;
979 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
COLOR_SETTINGS * m_colorSettings
The current canvas type.
Color settings are a bit different than most of the settings objects in that there can be more than o...

References EDA_DRAW_FRAME::m_colorSettings, and Pgm().

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), GERBVIEW_CONTROL::Print(), and DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample().

◆ 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 emtpy name or a new design.

Reimplemented from EDA_BASE_FRAME.

Definition at line 545 of file pl_editor_frame.cpp.

546 {
548 }
static wxString m_PageLayoutDescrFileName
the name of the page layout descr file, or emty to used the default pagelayout
Definition: base_screen.h:89

References BASE_SCREEN::m_PageLayoutDescrFileName.

Referenced by canCloseWindow(), Files_io(), OnNewPageLayout(), 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 784 of file pl_editor_frame.cpp.

785 {
786  return m_toolManager->GetTool<PL_SELECTION_TOOL>()->GetSelection();
787 }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157

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 worksheet border. It's passed false by "Zoom To Objects" to ignore worksheet 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 459 of file pl_editor_frame.cpp.

460 {
461  BOX2I rv( VECTOR2I( 0, 0 ), GetPageLayout().GetPageSettings().GetSizeIU() );
462  return rv;
463 }
const PAGE_INFO & GetPageSettings() const override
VECTOR2< int > VECTOR2I
Definition: vector2d.h:623
const PL_EDITOR_LAYOUT & GetPageLayout() const

References GetPageLayout(), and GetPageSettings().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

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

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

Definition at line 128 of file tools_holder.h.

128 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:170

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

134 { return m_dragAction; }
MOUSE_DRAG_ACTION m_dragAction
Definition: tools_holder.h:174

References TOOLS_HOLDER::m_dragAction.

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

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

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

831 {
832  if( !aFileHistory )
833  aFileHistory = m_fileHistory;
834 
835  wxASSERT( aFileHistory );
836 
837  int baseId = aFileHistory->GetBaseId();
838 
839  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
840 
841  unsigned i = cmdId - baseId;
842 
843  if( i < aFileHistory->GetCount() )
844  {
845  wxString fn = aFileHistory->GetHistoryFile( i );
846 
847  if( wxFileName::FileExists( fn ) )
848  return fn;
849  else
850  {
851  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
852  wxMessageBox( msg );
853 
854  aFileHistory->RemoveFileFromHistory( i );
855  }
856  }
857 
858  // Update the menubar to update the file history menu
859  if( GetMenuBar() )
860  {
861  ReCreateMenuBar();
862  GetMenuBar()->Refresh();
863  }
864 
865  return wxEmptyString;
866 }
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
#define _(s)
Definition: 3d_actions.cpp:33
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

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

◆ GetFileHistory()

FILE_HISTORY& EDA_BASE_FRAME::GetFileHistory ( )
inlineinherited

Get the frame's main file history.

Returns
the main file history

Definition at line 403 of file eda_base_frame.h.

404  {
405  return *m_fileHistory;
406  }
FILE_HISTORY * m_fileHistory

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

Definition at line 94 of file eda_draw_frame.h.

94 { return m_findStringHistoryList; }
wxArrayString m_findStringHistoryList

References EDA_DRAW_FRAME::m_findStringHistoryList.

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

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )
inlineinherited

Definition at line 93 of file eda_draw_frame.h.

93 { return *m_findReplaceData; }
wxFindReplaceData * m_findReplaceData

References EDA_DRAW_FRAME::m_findReplaceData.

Referenced by DIALOG_FIND::search().

◆ GetGalDisplayOptions()

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )
inlinevirtualinherited

◆ GetGridOrigin()

const wxPoint& PL_EDITOR_FRAME::GetGridOrigin ( ) const
inlineoverridevirtual

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

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

Implements EDA_DRAW_FRAME.

Definition at line 129 of file pl_editor_frame.h.

129 { return 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 399 of file eda_draw_frame.h.

399 { return nullptr; }

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

◆ GetLayoutFromRedoList()

void PL_EDITOR_FRAME::GetLayoutFromRedoList ( )

Redo the last edit:

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

Definition at line 52 of file pl_editor_undo_redo.cpp.

53 {
55 
56  if ( GetRedoCommandCount() <= 0 )
57  return;
58 
59  ITEM_PICKER redoWrapper = PopCommandFromRedoList()->PopItem();
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 RebuildSelection()
Rebuild the selection from the flags in the view items.
void HardRedraw() override
Refresh the library tree and redraw the window.
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_ITEM * GetItem() const
int ClearSelection(const TOOL_EVENT &aEvent)
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
void PushItem(const ITEM_PICKER &aItem)
Push aItem to the top of the list.
virtual PICKED_ITEMS_LIST * PopCommandFromRedoList()
Return the last command to undo and remove it from list, nothing is deleted.
void OnModify()
Must be called after a change in order to set the "modify" flag.
A holder to handle information on schematic or board items.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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 
96  ITEM_PICKER undoWrapper = PopCommandFromUndoList()->PopItem();
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 }
void RebuildSelection()
Rebuild the selection from the flags in the view items.
void HardRedraw() override
Refresh the library tree and redraw the window.
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void PushCommandToRedoList(PICKED_ITEMS_LIST *aItem)
Add a command to redo in the redo list.
EDA_ITEM * GetItem() const
int ClearSelection(const TOOL_EVENT &aEvent)
void Restore(EDA_DRAW_FRAME *aFrame, KIGFX::VIEW *aView=nullptr)
void PushItem(const ITEM_PICKER &aItem)
Push aItem to the top of the list.
void OnModify()
Must be called after a change in order to set the "modify" flag.
virtual int GetUndoCommandCount() const
virtual PICKED_ITEMS_LIST * PopCommandFromUndoList()
Return the last command to undo and remove it from list, nothing is deleted.
A holder to handle information on schematic or board items.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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

562 { 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 140 of file tools_holder.h.

140 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:176

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

◆ GetNearestGridPosition()

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

Return the nearest aGridSize location to aPosition.

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

Definition at line 738 of file eda_draw_frame.cpp.

739 {
740  const wxPoint& gridOrigin = GetGridOrigin();
741  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
742 
743  double xOffset = fmod( gridOrigin.x, gridSize.x );
744  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
745  double yOffset = fmod( gridOrigin.y, gridSize.y );
746  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
747 
748  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
749 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
virtual const wxPoint & GetGridOrigin() const =0
Return the absolute coordinates of the origin of the snap grid.
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:68

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

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

◆ GetNearestHalfGridPosition()

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

Return the nearest aGridSize / 2 location to aPosition.

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

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

Definition at line 752 of file eda_draw_frame.cpp.

753 {
754  const wxPoint& gridOrigin = GetGridOrigin();
755  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize() / 2.0;
756 
757  double xOffset = fmod( gridOrigin.x, gridSize.x );
758  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
759  double yOffset = fmod( gridOrigin.y, gridSize.y );
760  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
761 
762  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
763 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
virtual const wxPoint & GetGridOrigin() const =0
Return the absolute coordinates of the origin of the snap grid.
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:68

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

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

◆ GetOriginTransforms()

virtual ORIGIN_TRANSFORMS& EDA_DRAW_FRAME::GetOriginTransforms ( )
inlinevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented in PCB_BASE_FRAME.

Definition at line 152 of file eda_draw_frame.h.

153  { return m_originTransforms; }
ORIGIN_TRANSFORMS m_originTransforms

References EDA_DRAW_FRAME::m_originTransforms.

Referenced by DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), and LEADER::GetMsgPanelInfo().

◆ GetPageLayout() [1/2]

const PL_EDITOR_LAYOUT& PL_EDITOR_FRAME::GetPageLayout ( ) const
inline

◆ GetPageLayout() [2/2]

PL_EDITOR_LAYOUT& PL_EDITOR_FRAME::GetPageLayout ( )
inline

Definition at line 166 of file pl_editor_frame.h.

166 { return m_pageLayout; }
PL_EDITOR_LAYOUT m_pageLayout

References m_pageLayout.

◆ GetPageNumberOption()

bool PL_EDITOR_FRAME::GetPageNumberOption ( ) const
inline

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

177  {
178  return m_pageSelectBox->GetSelection() == 0;
179  }
wxChoice * m_pageSelectBox

References m_pageSelectBox.

Referenced by PrintPage().

◆ GetPageSettings()

const PAGE_INFO & PL_EDITOR_FRAME::GetPageSettings ( ) const
overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 566 of file pl_editor_frame.cpp.

567 {
568  return m_pageLayout.GetPageSettings();
569 }
PAGE_INFO & GetPageSettings()
PL_EDITOR_LAYOUT m_pageLayout

References PL_EDITOR_LAYOUT::GetPageSettings(), and m_pageLayout.

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

◆ GetPageSizeIU()

const wxSize PL_EDITOR_FRAME::GetPageSizeIU ( ) const
overridevirtual

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

Implements EDA_DRAW_FRAME.

Definition at line 572 of file pl_editor_frame.cpp.

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

References PL_EDITOR_LAYOUT::GetPageSettings(), and m_pageLayout.

Referenced by DIALOG_INSPECTOR::ReCreateDesignList().

◆ GetPropertiesFrame()

PROPERTIES_FRAME* PL_EDITOR_FRAME::GetPropertiesFrame ( )
inline

Definition at line 69 of file pl_editor_frame.h.

69 { return m_propertiesPagelayout; }
PROPERTIES_FRAME * m_propertiesPagelayout
The last filename chosen to be proposed to the user.

References m_propertiesPagelayout.

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

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetScreen()

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 892 of file eda_draw_frame.cpp.

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

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

◆ GetSettingsManager()

◆ GetSeverity()

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

Reimplemented in PCB_BASE_FRAME.

Definition at line 130 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const
inlineinherited

For those frames that support polar coordinates.

Definition at line 108 of file eda_draw_frame.h.

108 { 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 581 of file pl_editor_frame.cpp.

582 {
583  return GetPageLayout().GetTitleBlock();
584 }
TITLE_BLOCK & GetTitleBlock()
const PL_EDITOR_LAYOUT & GetPageLayout() const

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

◆ GetToolCanvas()

wxWindow* EDA_DRAW_FRAME::GetToolCanvas ( ) const
inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 426 of file eda_draw_frame.h.

426 { return GetCanvas(); }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

55 { return m_toolManager; }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157

References TOOLS_HOLDER::m_toolManager.

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:79

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const
inlinevirtualinherited

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

1005 {
1007 
1008  aPrimaryUnit = GetUserUnits();
1009  aSecondaryUnits = EDA_UNITS::MILS;
1010 
1011  if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
1012  {
1013  if( cmnTool )
1014  aSecondaryUnits = cmnTool->GetLastMetricUnits();
1015  else
1016  aSecondaryUnits = EDA_UNITS::MILLIMETRES;
1017  }
1018  else
1019  {
1020  if( cmnTool )
1021  aSecondaryUnits = cmnTool->GetLastImperialUnits();
1022  else
1023  aSecondaryUnits = EDA_UNITS::MILS;
1024  }
1025 }
EDA_UNITS GetLastMetricUnits()
Definition: common_tools.h:74
bool IsImperialUnit(EDA_UNITS aUnit)
Definition: eda_units.cpp:26
EDA_UNITS GetLastImperialUnits()
Definition: common_tools.h:75
Handles action that are shared between different applications.
Definition: common_tools.h:37
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

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

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

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 114 of file eda_base_frame.h.

115  {
116  return m_userUnits;
117  }
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

References EDA_BASE_FRAME::m_userUnits.

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

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
virtualinherited

Return a pointer to the window settings for this frame.

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

Parameters
aCfgis this frame's config object

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

Definition at line 704 of file eda_base_frame.cpp.

705 {
706  return &aCfg->m_Window;
707 }
WINDOW_SETTINGS m_Window
Definition: app_settings.h:181

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

1117 {
1118 #ifdef __WXGTK__
1119  // GTK includes the window decorations in the normal GetSize call,
1120  // so we have to use a GTK-specific sizing call that returns the
1121  // non-decorated window size.
1122  int width = 0;
1123  int height = 0;
1124  GTKDoGetSize( &width, &height );
1125 
1126  wxSize winSize( width, height );
1127 #else
1128  wxSize winSize = GetSize();
1129 #endif
1130 
1131  return winSize;
1132 }

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

517 {
518  // returns a human readable value which can be displayed as zoom
519  // level indicator in dialogs.
520  double zoom = m_canvas->GetGAL()->GetZoomFactor();
521  return wxString::Format( wxT( "Z %.2f" ), zoom );
522 }
EDA_DRAW_PANEL_GAL * m_canvas
This the frame's interface to setting GAL display options.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
double GetZoomFactor() const
Get the zoom factor.
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(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetZoomFactor(), EDA_DRAW_FRAME::m_canvas, and zoom.

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

◆ handleActivateEvent()

void EDA_DRAW_FRAME::handleActivateEvent ( wxActivateEvent &  aEvent)
protectedvirtualinherited

Handle a window activation event.

Reimplemented in PCB_BASE_EDIT_FRAME.

Definition at line 1077 of file eda_draw_frame.cpp.

1078 {
1079  // Force a refresh of the message panel to ensure that the text is the right color
1080  // when the window activates
1081  if( !IsIconized() )
1082  m_messagePanel->Refresh();
1083 }
EDA_MSG_PANEL * m_messagePanel

References EDA_DRAW_FRAME::m_messagePanel.

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

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )
virtualinherited

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

Definition at line 1135 of file eda_base_frame.cpp.

1136 {
1137  // Update the icon theme when the system theme changes and update the toolbars
1138  if( GetBitmapStore()->ThemeChanged() )
1139  ThemeChanged();
1140 
1141  // This isn't handled by ThemeChanged()
1142  if( GetMenuBar() )
1143  {
1144  // For icons in menus, icon scaling & hotkeys
1145  ReCreateMenuBar();
1146  GetMenuBar()->Refresh();
1147  }
1148 }
virtual void ThemeChanged()
Process light/dark theme change.
virtual void ReCreateMenuBar()
Recreates the menu bar.
BITMAP_STORE * GetBitmapStore()
Definition: bitmap.cpp:92

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

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

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

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

enabled, checked, etc.).

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

Definition at line 349 of file eda_base_frame.cpp.

351 {
352  bool checkRes = false;
353  bool enableRes = true;
354  bool showRes = true;
355  SELECTION& selection = aFrame->GetCurrentSelection();
356 
357  try
358  {
359  checkRes = aCond.checkCondition( selection );
360  enableRes = aCond.enableCondition( selection );
361  showRes = aCond.showCondition( selection );
362  }
363  catch( std::exception& )
364  {
365  // Something broke with the conditions, just skip the event.
366  aEvent.Skip();
367  return;
368  }
369 
370  aEvent.Enable( enableRes );
371  aEvent.Show( showRes );
372 
373  // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
374  // checked, since wxMenuItems don't want to be checked unless they actually are checkable
375 #if wxCHECK_VERSION( 3, 1, 5 )
376  if( aEvent.IsCheckable() )
377  aEvent.Check( checkRes );
378 #else
379  bool canCheck = true;
380 
381  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
382  // see if they can be and can't just universally apply a check in this event.
383  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
384  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
385 
386  if( canCheck )
387  aEvent.Check( checkRes );
388 #endif
389 }
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:102

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

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

void PL_EDITOR_FRAME::HardRedraw ( )
overridevirtual

Refresh the library tree and redraw the window.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 790 of file pl_editor_frame.cpp.

791 {
793 
795  PL_SELECTION& selection = selTool->GetSelection();
796  DS_DATA_ITEM* item = nullptr;
797 
798  if( selection.GetSize() == 1 )
799  item = static_cast<DS_DRAW_ITEM_BASE*>( selection.Front() )->GetPeer();
800 
803  GetCanvas()->Refresh();
804 }
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void DisplayWorksheet()
Build and update the list of WS_DRAW_ITEM_xxx showing the frame layout.
PL_SELECTION & GetSelection()
Return the set of currently selected items.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
Drawing sheet structure type definitions.
Definition: ds_data_item.h:95
PROPERTIES_FRAME * m_propertiesPagelayout
The last filename chosen to be proposed to the user.
void CopyPrmsFromItemToPanel(DS_DATA_ITEM *aItem)

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

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

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 723 of file eda_base_frame.cpp.

724 {
725  return Kiface().GetHelpFileName();
726 }
const wxString & GetHelpFileName() const
Return just the basename portion of the current help file.
Definition: kiface_i.h:109
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

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

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

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

1027 {
1028  wxAcceleratorEntry entries[1];
1029  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
1030  wxAcceleratorTable accel( 1, entries );
1031  SetAcceleratorTable( accel );
1032 }

◆ InsertPageLayoutDescrFile()

bool PL_EDITOR_FRAME::InsertPageLayoutDescrFile ( const wxString &  aFullFileName)

Function InsertPageLayoutDescrFile Loads a .kicad_wks page layout descr file, and add items to the current layout list.

Parameters
aFullFileName= the filename.

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

249 {
250  if( wxFileExists( aFullFileName ) )
251  {
252  const bool append = true;
254  DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( aFullFileName, append );
255  return true;
256  }
257 
258  return false;
259 }
void 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.
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
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().

◆ InstallPreferences()

void PL_EDITOR_FRAME::InstallPreferences ( PAGED_DIALOG ,
PANEL_HOTKEYS_EDITOR  
)
overridevirtual

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

Parameters
aParenta paged dialog into which the preference panels should be installed.

Reimplemented from EDA_BASE_FRAME.

Definition at line 466 of file pl_editor_frame.cpp.

468 {
469  wxTreebook* book = aParent->GetTreebook();
470 
471  book->AddPage( new wxPanel( book ), _( "Drawing Sheet Editor" ) );
472  book->AddSubPage( new PANEL_GAL_DISPLAY_OPTIONS( this, aParent ), _( "Display Options" ) );
473  book->AddSubPage( new PANEL_PL_EDITOR_COLOR_SETTINGS( this, aParent->GetTreebook() ), _( "Colors" ) );
474 
475  aHotkeysPanel->AddHotKeys( GetToolManager() );
476 }
#define _(s)
Definition: 3d_actions.cpp:33
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55

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

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const
inlineprotectedvirtualinherited

Return the auto save status of the application.

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 597 of file eda_base_frame.h.

597 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool PL_EDITOR_FRAME::IsContentModified ( )
overridevirtual

Get if the page layout has been modified but not saved.

Returns
true if the any changes have not been saved

Reimplemented from EDA_BASE_FRAME.

Definition at line 331 of file pl_editor_frame.cpp.

332 {
333  return GetScreen() && GetScreen()->IsModify();
334 }
bool IsModify() const
Definition: base_screen.h:63
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.

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

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

◆ IsCurrentTool()

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

Definition at line 108 of file tools_holder.cpp.

109 {
110  if( m_toolStack.empty() )
111  return &aAction == &ACTIONS::selectionTool;
112  else
113  return m_toolStack.back() == aAction.GetName();
114 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:163
static TOOL_ACTION selectionTool
Definition: actions.h:156
const std::string & GetName() const
Return name of the action.
Definition: tool_action.h:83

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

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

◆ IsDismissed()

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

Definition at line 155 of file kiway_player.cpp.

156 {
157  return !m_modal_loop;
158 }
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:196

References KIWAY_PLAYER::m_modal_loop.

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

◆ IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( ) const
inherited

Definition at line 335 of file eda_draw_frame.cpp.

336 {
337  return config()->m_Window.grid.show;
338 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
GRID_SETTINGS grid
Definition: app_settings.h:89
WINDOW_SETTINGS m_Window
Definition: app_settings.h:181

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

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

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const
inlineoverridevirtualinherited

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

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 170 of file kiway_player.h.

170 { return m_modal; }

References KIWAY_PLAYER::m_modal.

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

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 192 of file eda_base_frame.h.

192 { 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(), EDA_3D_VIEWER::CreateMenuBar(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), COMMON_TOOLS::doZoomFit(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbol(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), CONVERT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), CONVERT_TOOL::LinesToPoly(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SYMBOL_EDITOR_CONTROL::Revert(), SYMBOL_EDITOR_CONTROL::Save(), APPEARANCE_CONTROLS::setVisibleObjects(), EE_INSPECTION_TOOL::ShowDatasheet(), EE_INSPECTION_TOOL::ShowERCDialog(), SYMBOL_EDITOR_CONTROL::ToggleSymbolTree(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), and DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample().

◆ IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName &  aFileName)
inherited

Checks if aFileName can be written.

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

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

Definition at line 928 of file eda_base_frame.cpp.

929 {
930  wxString msg;
931  wxFileName fn = aFileName;
932 
933  // Check for absence of a file path with a file name. Unfortunately KiCad
934  // uses paths relative to the current project path without the ./ part which
935  // confuses wxFileName. Making the file name path absolute may be less than
936  // elegant but it solves the problem.
937  if( fn.GetPath().IsEmpty() && fn.HasName() )
938  fn.MakeAbsolute();
939 
940  wxCHECK_MSG( fn.IsOk(), false,
941  wxT( "File name object is invalid. Bad programmer!" ) );
942  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
943  wxT( "File name object path <" ) + fn.GetFullPath() +
944  wxT( "> is not set. Bad programmer!" ) );
945 
946  if( fn.IsDir() && !fn.IsDirWritable() )
947  {
948  msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
949  fn.GetPath() );
950  }
951  else if( !fn.FileExists() && !fn.IsDirWritable() )
952  {
953  msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
954  fn.GetFullName(), fn.GetPath() );
955  }
956  else if( fn.FileExists() && !fn.IsFileWritable() )
957  {
958  msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
959  fn.GetFullPath() );
960  }
961 
962  if( !msg.IsEmpty() )
963  {
964  wxMessageBox( msg );
965  return false;
966  }
967 
968  return true;
969 }
#define _(s)
Definition: 3d_actions.cpp:33

References _.

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

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:78

References KIWAY_HOLDER::m_kiway.

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

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS aEvent)
protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 176 of file kiway_player.cpp.

177 {
178  // logging support
179  KiwayMailIn( aEvent ); // call the virtual, override in derived.
180 }
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 SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, SCH_EDIT_FRAME, PCB_EDIT_FRAME, and CVPCB_MAINFRAME.

Definition at line 70 of file kiway_player.cpp.

71 {
72  // override this in derived classes.
73 }

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

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

An event handler called on a language menu selection.

Definition at line 183 of file kiway_player.cpp.

184 {
185  int id = event.GetId();
186 
187  // tell all the KIWAY_PLAYERs about the language change.
188  Kiway().SetLanguage( id );
189 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
virtual void SetLanguage(int aLanguage)
Change the language and then calls ShowChangedLanguage() on all #KIWAY_PLAYERs.
Definition: kiway.cpp:459

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

903 {
904  wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
905  aFilename.SetExt( ext );
906 
907  wxString dir = aGlobalPath;
908 
909 
910  if( isDirectory && doOpen )
911  {
912  if( !aIsGlobal )
913  {
914  dir = Prj().GetProjectPath();
915  }
916 
917  wxDirDialog dlg( this, prompt, dir,
918  wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
919 
920  if( dlg.ShowModal() == wxID_CANCEL )
921  return false;
922 
923  aFilename = dlg.GetPath();
924  aFilename.SetExt( ext );
925  }
926  else
927  {
928  // Ensure the file has a dummy name, otherwise GTK will display the regex from the filter
929  if( aFilename.GetName().empty() )
930  aFilename.SetName( "Library" );
931 
932  if( !aIsGlobal )
933  {
934  dir = Prj().IsNullProject() ? aFilename.GetFullPath() : Prj().GetProjectPath();
935  }
936 
937  wxFileDialog dlg( this, prompt, dir, aFilename.GetFullName(),
938  wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
939  : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
940 
941  if( dlg.ShowModal() == wxID_CANCEL )
942  return false;
943 
944  aFilename = dlg.GetPath();
945  aFilename.SetExt( ext );
946  }
947 
948  return true;
949 }
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:123
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual bool IsNullProject() const
Check if this project is a null project (i.e.
Definition: project.cpp:135
#define _(s)
Definition: 3d_actions.cpp:33

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

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

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )
protectedinherited

Returns the canvas type stored in the application settings.

Definition at line 665 of file eda_draw_frame.cpp.

666 {
667 #ifdef __WXMAC__
668  // Cairo renderer doesn't handle Retina displays so there's really only one game
669  // in town for Mac
671 #endif
672 
675 
676  if( cfg )
677  canvasType = static_cast<EDA_DRAW_PANEL_GAL::GAL_TYPE>( cfg->m_Graphics.canvas_type );
678 
679  if( canvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
680  || canvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
681  {
682  wxASSERT( false );
684  }
685 
686  // Legacy canvas no longer supported. Switch to Cairo, and on the first instantiation
687  // the user will be prompted to switch to OpenGL
688  if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
690 
691  return canvasType;
692 }
static constexpr GAL_TYPE GAL_FALLBACK
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:92
Sentinel, do not use as a parameter.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:99
GAL not used (the legacy wxDC engine is used)
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

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

◆ LoadPageLayoutDescrFile()

bool PL_EDITOR_FRAME::LoadPageLayoutDescrFile ( const wxString &  aFullFileName)

Function LoadPageLayoutDescrFile Loads a .kicad_wks page layout descr file.

Parameters
aFullFileName= the filename.

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

223 {
224  if( wxFileExists( aFullFileName ) )
225  {
227  SetCurrentFileName( aFullFileName );
228  UpdateFileHistory( aFullFileName );
229  GetScreen()->ClrModify();
230 
231  wxFileName fn = aFullFileName;
232  m_infoBar->Dismiss();
233 
234  if( fn.FileExists() && !fn.IsFileWritable() )
235  {
238  m_infoBar->ShowMessage( _( "Layout file is read only." ), wxICON_WARNING );
239  }
240 
241  return true;
242  }
243 
244  return false;
245 }
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: infobar.cpp:129
void 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.
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
Definition: infobar.cpp:171
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:282
void SetCurrentFileName(const wxString &aName)
Stores the current layout descr file filename.
WX_INFOBAR * m_infoBar
#define _(s)
Definition: 3d_actions.cpp:33
void ClrModify()
Definition: base_screen.h:60
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
Definition: infobar.cpp:272

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

480 {
482 
483  if( aCfg->m_Window.grid.sizes.empty() )
484  {
485  aCfg->m_Window.grid.sizes = { "1.0 mm",
486  "0.50 mm",
487  "0.25 mm",
488  "0.20 mm",
489  "0.10 mm" };
490  }
491 
492  // Currently values read from config file are not used because the user cannot
493  // change this config
494  // if( aCfg->m_Window.zoom_factors.empty() )
495  {
497  }
498 
499  PL_EDITOR_SETTINGS* cfg = dynamic_cast<PL_EDITOR_SETTINGS*>( aCfg );
500  wxCHECK( cfg, /*void*/ );
501 
504 
506 
509 
510  PAGE_INFO pageInfo = GetPageSettings();
511  pageInfo.SetType( cfg->m_LastPaperSize, cfg->m_LastWasPortrait );
512  SetPageSettings( pageInfo );
513 }
const PAGE_INFO & GetPageSettings() const override
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:231
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:119
virtual void SetDrawBgColor(COLOR4D aColor)
Definition: color4d.h:44
std::vector< double > zoom_factors
Definition: app_settings.h:86
void SetPageSettings(const PAGE_INFO &) override
std::vector< wxString > sizes
Definition: app_settings.h:52
GRID_SETTINGS grid
Definition: app_settings.h:89
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:53
Definition: color4d.h:48
WINDOW_SETTINGS m_Window
Definition: app_settings.h:181
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
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:237
#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, PL_EDITOR_SETTINGS::m_PropertiesFrameWidth, m_propertiesFrameWidth, APP_SETTINGS_BASE::m_Window, PAGE_INFO::SetCustomHeightMils(), PAGE_INFO::SetCustomWidthMils(), EDA_DRAW_FRAME::SetDrawBgColor(), SetPageSettings(), PAGE_INFO::SetType(), GRID_SETTINGS::sizes, WHITE, WINDOW_SETTINGS::zoom_factors, and ZOOM_LIST_PL_EDITOR.

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS aCfg)
inherited

Load window settings from the given settings object.

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

Definition at line 604 of file eda_base_frame.cpp.

605 {
606  LoadWindowState( aCfg->state );
607 
608  if( m_hasAutoSave )
609  m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
610 
611  m_perspective = aCfg->perspective;
612  m_mruPath = aCfg->mru_path;
613 
614  TOOLS_HOLDER::CommonSettingsChanged( false, false );
615 }
wxString mru_path
Definition: app_settings.h:84
wxString m_mruPath
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void LoadWindowState(const wxString &aFileName)
wxString m_perspective
wxString perspective
Definition: app_settings.h:85
WINDOW_STATE state
Definition: app_settings.h:83
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.

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

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

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

Definition at line 487 of file eda_base_frame.cpp.

488 {
489  if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
490  return;
491 
492  const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
493 
494  if( state != nullptr )
495  {
496  LoadWindowState( state->window );
497  }
498 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void LoadWindowState(const wxString &aFileName)
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:151
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
struct WINDOW_STATE window
const PROJECT_FILE_STATE * GetFileState(const wxString &aFileName)

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

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

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE aState)
virtualinherited

Load frame state info from a configuration file.

Definition at line 501 of file eda_base_frame.cpp.

502 {
503  bool wasDefault = false;
504 
505  m_framePos.x = aState.pos_x;
506  m_framePos.y = aState.pos_y;
507  m_frameSize.x = aState.size_x;
508  m_frameSize.y = aState.size_y;
509 
510  wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
512 
513  // Ensure minimum size is set if the stored config was zero-initialized
514  if( m_frameSize.x < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
515  {
517  wasDefault = true;
518 
519  wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_frameSize.x, m_frameSize.y );
520  }
521 
522  wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
523 
524  if( aState.display >= wxDisplay::GetCount() )
525  {
526  wxLogTrace( traceDisplayLocation, "Previous display not found" );
527 
528  // If it isn't attached, use the first display
529  // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
530  const unsigned int index = 0;
531  wxDisplay display( index );
532  wxRect clientSize = display.GetGeometry();
533 
534  m_framePos = wxDefaultPosition;
535 
536  // Ensure the window fits on the display, since the other one could have been larger
537  if( m_frameSize.x > clientSize.width )
538  m_frameSize.x = clientSize.width;
539 
540  if( m_frameSize.y > clientSize.height )
541  m_frameSize.y = clientSize.height;
542  }
543  else
544  {
545  wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
546  wxPoint upperLeft( m_framePos.x, m_framePos.y );
547 
548  wxDisplay display( aState.display );
549  wxRect clientSize = display.GetClientArea();
550 
551  // The percentage size (represented in decimal) of the region around the screen's border where
552  // an upper corner is not allowed
553 #define SCREEN_BORDER_REGION 0.10
554 
555  int yLim = clientSize.y + ( clientSize.height * ( 1.0 - SCREEN_BORDER_REGION ) );
556  int xLimLeft = clientSize.x + ( clientSize.width * SCREEN_BORDER_REGION );
557  int xLimRight = clientSize.x + ( clientSize.width * ( 1.0 - SCREEN_BORDER_REGION ) );
558 
559  if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
560  upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
561  upperRight.y > yLim ) // Upper corner too close to the bottom of the screen
562  {
563  m_framePos = wxDefaultPosition;
564  wxLogTrace( traceDisplayLocation, "Resetting to default position" );
565  }
566  }
567 
568  // Ensure Window title bar is visible
569 #if defined( __WXOSX__ )
570  // for macOSX, the window must be below system (macOSX) toolbar
571  int Ypos_min = 20;
572 #else
573  int Ypos_min = 0;
574 #endif
575  if( m_framePos.y < Ypos_min )
576  m_framePos.y = Ypos_min;
577 
578  wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
580 
581  SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
582 
583  // Center the window if we reset to default
584  if( m_framePos.x == -1 )
585  {
586  wxLogTrace( traceDisplayLocation, "Centering window" );
587  Center();
588  m_framePos = GetPosition();
589  }
590 
591  // Record the frame sizes in an un-maximized state
594 
595  // Maximize if we were maximized before
596  if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
597  {
598  wxLogTrace( traceDisplayLocation, "Maximizing window" );
599  Maximize();
600  }
601 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxPoint m_normalFramePos
#define SCREEN_BORDER_REGION
wxSize m_normalFrameSize
static const wxSize defaultSize(FRAME_T aFrameType)
static const wxSize minSize(FRAME_T aFrameType)
unsigned int display
Definition: app_settings.h:75

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

◆ LockFile()

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

Mark a schematic file as being in use.

Use ReleaseFile() to undo this.

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

Definition at line 188 of file eda_draw_frame.cpp.

189 {
190  m_file_checker = ::LockFile( aFileName );
191 
192  return bool( m_file_checker );
193 }
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
bool LockFile(const wxString &aFileName)
Mark a schematic file as being in use.

References EDA_DRAW_FRAME::m_file_checker.

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

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce)
inlineinherited

Definition at line 564 of file eda_base_frame.h.

565  {
566  m_isNonUserClose = true;
567  return Close( aForce );
568  }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onActivate()

void EDA_DRAW_FRAME::onActivate ( wxActivateEvent &  aEvent)
protectedinherited

Definition at line 1086 of file eda_draw_frame.cpp.

1087 {
1088  handleActivateEvent( aEvent );
1089 
1090  aEvent.Skip();
1091 }
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 294 of file eda_base_frame.cpp.

295 {
296  if( !doAutoSave() )
297  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
298 }
virtual bool doAutoSave()
This should be overridden by the derived class to handle the auto save feature.
wxTimer * m_autoSaveTimer

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

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  event)
virtualinherited

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

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

Reimplemented in FOOTPRINT_VIEWER_FRAME.

Definition at line 307 of file eda_base_frame.cpp.

308 {
309  wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( event ) );
310  // Key events can be filtered here.
311  // Currently no filtering is made.
312  event.Skip();
313 }
wxString dump(const wxArrayString &aArray)
Debug helper for printing wxArrayString contents.
const wxChar *const kicadTraceKeyEvent
Flag to enable wxKeyEvent debug tracing.

References dump(), and kicadTraceKeyEvent.

◆ OnClearFileHistory()

void PL_EDITOR_FRAME::OnClearFileHistory ( wxCommandEvent &  aEvent)

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

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

References EDA_BASE_FRAME::ClearFileHistory().

◆ OnExit()

void PL_EDITOR_FRAME::OnExit ( wxCommandEvent &  aEvent)

Definition at line 337 of file pl_editor_frame.cpp.

338 {
339  if( aEvent.GetId() == wxID_EXIT )
340  Kiway().OnKiCadExit();
341 
342  if( aEvent.GetId() == wxID_CLOSE || Kiface().IsSingle() )
343  Close( false );
344 }
void OnKiCadExit()
Definition: kiway.cpp:599
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
bool IsSingle() const
Is this KIFACE_I running under single_top?
Definition: kiface_i.h:104
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

◆ OnFileHistory()

void PL_EDITOR_FRAME::OnFileHistory ( wxCommandEvent &  event)

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

49 {
50  wxString filename;
51 
52  filename = GetFileFromHistory( event.GetId(), _( "Page Layout Description File" ) );
53 
54  if( filename != wxEmptyString )
55  {
56  if( IsContentModified() )
57  {
58  if( !HandleUnsavedChanges( this, _( "The current page layout has been modified. "
59  "Save changes?" ),
60  [&]()->bool { return saveCurrentPageLayout(); } ) )
61  {
62  return;
63  }
64  }
65 
66  ::wxSetWorkingDirectory( ::wxPathOnly( filename ) );
67 
68  if( LoadPageLayoutDescrFile( filename ) )
69  {
70  wxString msg;
71  msg.Printf( _( "File \"%s\" loaded"), filename );
72  SetStatusText( msg );
73  }
74 
76  }
77 }
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:207
bool IsContentModified() override
Get if the page layout has been modified but not saved.
wxString GetFileFromHistory(int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
Fetches the file name from the file history list.
void OnNewPageLayout()
Must be called to initialize parameters when a new page layout description is loaded.
#define _(s)
Definition: 3d_actions.cpp:33
bool LoadPageLayoutDescrFile(const wxString &aFullFileName)
Function LoadPageLayoutDescrFile Loads a .kicad_wks page layout descr file.

References _, EDA_BASE_FRAME::GetFileFromHistory(), HandleUnsavedChanges(), IsContentModified(), LoadPageLayoutDescrFile(), OnNewPageLayout(), and saveCurrentPageLayout().

◆ OnGridSettings()

void EDA_DRAW_FRAME::OnGridSettings ( wxCommandEvent &  event)
inherited

Definition at line 323 of file eda_draw_frame.cpp.

324 {
325  DIALOG_GRID_SETTINGS dlg( this );
326 
327  if( dlg.ShowModal() == wxID_OK )
328  {
329  UpdateStatusBar();
330  GetCanvas()->Refresh();
331  }
332 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
void UpdateStatusBar() override
Update the status bar information.

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

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 887 of file eda_base_frame.cpp.

888 {
889  void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
890  ShowAboutDialog( this );
891 }
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 1094 of file eda_base_frame.cpp.

1095 {
1096  // When we maximize the window, we want to save the old information
1097  // so that we can add it to the settings on next window load.
1098  // Contrary to the documentation, this event seems to be generated
1099  // when the window is also being unmaximized on OSX, so we only
1100  // capture the size information when we maximize the window when on OSX.
1101 #ifdef __WXOSX__
1102  if( !IsMaximized() )
1103 #endif
1104  {
1106  m_normalFramePos = GetPosition();
1107  wxLogTrace( traceDisplayLocation, "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
1109  }
1110 
1111  // Skip event to actually maximize the window
1112  aEvent.Skip();
1113 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxPoint m_normalFramePos
wxSize m_normalFrameSize
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.

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

317 {
318  if( !m_toolDispatcher )
319  aEvent.Skip();
320  else
322 }
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:159

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

◆ OnModify()

void PL_EDITOR_FRAME::OnModify ( )
inline

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

Definition at line 256 of file pl_editor_frame.h.

257  {
258  GetScreen()->SetModify();
259  }
void SetModify()
Definition: base_screen.h:59
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.

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

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

◆ OnMove()

void EDA_DRAW_FRAME::OnMove ( wxMoveEvent &  aEvent)
overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 426 of file eda_draw_frame.cpp.

427 {
428  // If the window is moved to a different display, the scaling factor may change
429  double oldFactor = m_galDisplayOptions.m_scaleFactor;
431 
432  if( oldFactor != m_galDisplayOptions.m_scaleFactor && m_canvas )
433  {
434  wxSize clientSize = GetClientSize();
435  GetCanvas()->GetGAL()->ResizeScreen( clientSize.x, clientSize.y );
436  GetCanvas()->GetView()->MarkDirty();
437  }
438 
439  aEvent.Skip();
440 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_DRAW_PANEL_GAL * m_canvas
This the frame's interface to setting GAL display options.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
virtual void ResizeScreen(int aWidth, int aHeight)
Resize the canvas.
KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions
Default display origin transforms object.
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:598

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

◆ OnNewPageLayout()

void PL_EDITOR_FRAME::OnNewPageLayout ( )

Must be called to initialize parameters when a new page layout description is loaded.

Definition at line 872 of file pl_editor_frame.cpp.

873 {
875  GetScreen()->ClrModify();
877 
880 
882 
884 
885  if( GetCurrentFileName().IsEmpty() )
886  {
887  // Default shutdown reason until a file is loaded
888  KIPLATFORM::APP::SetShutdownBlockReason( this, _( "New page layout file is unsaved" ) );
889  }
890  else
891  {
892  KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Page layout changes are unsaved" ) );
893  }
894 }
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
static TOOL_ACTION zoomFitScreen
Definition: actions.h:99
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
void DisplayWorksheet()
Build and update the list of WS_DRAW_ITEM_xxx showing the frame layout.
void SetShutdownBlockReason(wxWindow *aWindow, const wxString &aReason)
Sets the block reason why the window/application is preventing OS shutdown.
Definition: gtk/app.cpp:76
wxString GetCurrentFileName() const override
void UpdateTitleAndInfo()
Displays the short filename (if exists) loaded file on the caption of the main window.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
#define _(s)
Definition: 3d_actions.cpp:33
PROPERTIES_FRAME * m_propertiesPagelayout
The last filename chosen to be proposed to the user.
void ClrModify()
Definition: base_screen.h:60
void CopyPrmsFromItemToPanel(DS_DATA_ITEM *aItem)
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
virtual void ClearUndoRedoList()
Clear the undo and redo list using ClearUndoORRedoList()

References _, EDA_BASE_FRAME::ClearUndoRedoList(), BASE_SCREEN::ClrModify(), PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), GetCanvas(), GetCurrentFileName(), EDA_DRAW_FRAME::GetScreen(), m_propertiesPagelayout, TOOLS_HOLDER::m_toolManager, TOOL_MANAGER::RunAction(), 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 328 of file eda_draw_frame.h.

328 {}

Referenced by DIALOG_PAGES_SETTINGS::TransferDataFromWindow().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 894 of file eda_base_frame.cpp.

895 {
896  PAGED_DIALOG dlg( this, _( "Preferences" ), true );
897  wxTreebook* book = dlg.GetTreebook();
898 
899  book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
900 
901  book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
902 
903  PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
904  book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
905 
906  for( unsigned i = 0; i < KIWAY_PLAYER_COUNT; ++i )
907  {
908  KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
909 
910  if( frame )
911  frame->InstallPreferences( &dlg, hotkeysPanel );
912  }
913 
914  // The Kicad manager frame is not a player so we have to add it by hand
915  wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
916 
917  if( manager )
918  static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
919 
920  for( size_t i = 0; i < book->GetPageCount(); ++i )
921  book->GetPage( i )->Layout();
922 
923  if( dlg.ShowModal() == wxID_OK )
924  dlg.Kiway().CommonSettingsChanged( false, false );
925 }
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:61
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:32
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:357
#define KICAD_MANAGER_FRAME_NAME
#define _(s)
Definition: 3d_actions.cpp:33
virtual void InstallPreferences(PAGED_DIALOG *, PANEL_HOTKEYS_EDITOR *)
Allow a frame to load its preference panels (if any) into the preferences dialog.

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

Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch().

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

406 {
407  m_originSelectChoice = m_originSelectBox->GetSelection();
408  UpdateStatusBar(); // Update grid origin
410  GetCanvas()->Refresh();
411 }
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void UpdateStatusBar() override
Update the status bar information.
void DisplayWorksheet()
Build and update the list of WS_DRAW_ITEM_xxx showing the frame layout.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
wxChoice * m_originSelectBox

References PL_DRAW_PANEL_GAL::DisplayWorksheet(), 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 287 of file eda_draw_frame.cpp.

288 {
289  wxCHECK_RET( m_gridSelectBox, "m_gridSelectBox uninitialized" );
290 
291  int idx = m_gridSelectBox->GetCurrentSelection();
292 
293  if( idx == int( m_gridSelectBox->GetCount() ) - 2 )
294  {
295  // wxWidgets will check the separator, which we don't want.
296  // Re-check the current grid.
297  wxUpdateUIEvent dummy;
299  }
300  else if( idx == int( m_gridSelectBox->GetCount() ) - 1 )
301  {
302  // wxWidgets will check the Grid Settings... entry, which we don't want.
303  // Re-check the current grid.
304  wxUpdateUIEvent dummy;
306 
307  // Give a time-slice to close the menu before opening the dialog.
308  // (Only matters on some versions of GTK.)
309  wxSafeYield();
310 
312  }
313  else
314  {
316  }
317 
318  UpdateStatusBar();
319  m_canvas->Refresh();
320 }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: sch_symbol.cpp:69
wxChoice * m_gridSelectBox
EDA_DRAW_PANEL_GAL * m_canvas
This the frame's interface to setting GAL display options.
static TOOL_ACTION gridPreset
Definition: actions.h:142
void OnUpdateSelectGrid(wxUpdateUIEvent &aEvent)
Update the checked item in the grid combobox.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
static TOOL_ACTION gridProperties
Definition: actions.h:144
void UpdateStatusBar() override
Update the status bar information.

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

◆ OnSelectPage()

void PL_EDITOR_FRAME::OnSelectPage ( wxCommandEvent &  event)

Definition at line 393 of file pl_editor_frame.cpp.

394 {
395  KIGFX::VIEW* view = GetCanvas()->GetView();
396  view->SetLayerVisible( LAYER_DRAWINGSHEET_PAGE1, m_pageSelectBox->GetSelection() == 0 );
397  view->SetLayerVisible( LAYER_DRAWINGSHEET_PAGEn, m_pageSelectBox->GetSelection() == 1 );
398  GetCanvas()->Refresh();
399 }
for drawingsheetEditor previewing
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
for drawingsheetEditor previewing
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition: view.h:387
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
wxChoice * m_pageSelectBox
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:67

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

412 {
413  wxCHECK_RET( m_zoomSelectBox, "m_zoomSelectBox uninitialized" );
414 
415  int id = m_zoomSelectBox->GetCurrentSelection();
416 
417  if( id < 0 || !( id < (int)m_zoomSelectBox->GetCount() ) )
418  return;
419 
420  m_toolManager->RunAction( "common.Control.zoomPreset", true, id );
421  UpdateStatusBar();
422  m_canvas->Refresh();
423 }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
EDA_DRAW_PANEL_GAL * m_canvas
This the frame's interface to setting GAL display options.
wxChoice * m_zoomSelectBox
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
void UpdateStatusBar() override
Update the status bar information.

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

◆ OnSize()

void EDA_DRAW_FRAME::OnSize ( wxSizeEvent &  event)
virtualinherited

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

Reimplemented in FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 496 of file eda_draw_frame.cpp.

497 {
498  m_frameSize = GetClientSize( );
499 
500  SizeEv.Skip();
501 }

References EDA_BASE_FRAME::m_frameSize.

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

◆ OnSockRequest()

void EDA_DRAW_FRAME::OnSockRequest ( wxSocketEvent &  evt)
inherited

Definition at line 70 of file eda_dde.cpp.

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

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

◆ OnSockRequestServer()

void EDA_DRAW_FRAME::OnSockRequestServer ( wxSocketEvent &  evt)
inherited

Definition at line 102 of file eda_dde.cpp.

103 {
104  wxSocketBase* socket;
105  wxSocketServer* server = (wxSocketServer*) evt.GetSocket();
106 
107  socket = server->Accept();
108 
109  if( socket == NULL )
110  return;
111 
112  m_sockets.push_back( socket );
113 
114  socket->Notify( true );
115  socket->SetEventHandler( *this, ID_EDA_SOCKET_EVENT );
116  socket->SetNotify( wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG );
117 }
std::vector< wxSocketBase * > m_sockets
interprocess communication
#define NULL

References ID_EDA_SOCKET_EVENT, EDA_DRAW_FRAME::m_sockets, and NULL.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent &  aEvent)
protectedinherited

Definition at line 1151 of file eda_base_frame.cpp.

1152 {
1153  // Call the handler to update the colors used in the frame
1155 
1156  // Skip the change event to ensure the rest of the window controls get it
1157  aEvent.Skip();
1158 }
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 combobox.

Definition at line 263 of file eda_draw_frame.cpp.

264 {
265  // No need to update the grid select box if it doesn't exist or the grid setting change
266  // was made using the select box.
267  if( m_gridSelectBox == NULL )
268  return;
269 
270  int idx = config()->m_Window.grid.last_size_idx;
271  idx = std::max( 0, std::min( idx, (int) m_gridSelectBox->GetCount() - 1 ) );
272 
273  if( idx != m_gridSelectBox->GetSelection() )
274  m_gridSelectBox->SetSelection( idx );
275 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
wxChoice * m_gridSelectBox
#define NULL
GRID_SETTINGS grid
Definition: app_settings.h:89
WINDOW_SETTINGS m_Window
Definition: app_settings.h:181

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

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

◆ OnUpdateSelectZoom()

void EDA_DRAW_FRAME::OnUpdateSelectZoom ( wxUpdateUIEvent &  aEvent)
inherited

Update the checked item in the zoom combobox.

Definition at line 384 of file eda_draw_frame.cpp.

385 {
386  if( m_zoomSelectBox == NULL || m_zoomSelectBox->GetParent() == NULL )
387  return;
388 
389  int current = 0; // display Auto if no match found
390 
391  // check for a match within 1%
392  double zoom = GetCanvas()->GetGAL()->GetZoomFactor();
393 
394  for( unsigned i = 0; i < config()->m_Window.zoom_factors.size(); i++ )
395  {
396  if( std::fabs( zoom - config()->m_Window.zoom_factors[i] ) < ( zoom / 100.0 ) )
397  {
398  current = i + 1;
399  break;
400  }
401  }
402 
403  if( current != m_zoomSelectBox->GetSelection() )
404  m_zoomSelectBox->SetSelection( current );
405 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
std::vector< double > zoom_factors
Definition: app_settings.h:86
#define NULL
wxChoice * m_zoomSelectBox
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
double GetZoomFactor() const
Get the zoom factor.
WINDOW_SETTINGS m_Window
Definition: app_settings.h:181

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

◆ OpenProjectFiles()

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

Open a project or set of files given by aFileList.

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

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

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

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

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

Parameters
aFileListincludes files that this frame should open according to the knowledge in the derived wxFrame. In almost every case, the list will have only a single file in it.
aCtlis a set of bit flags ORed together from the set of KICTL_* #defined above.
Returns
true if all requested files were opened OK, else false.

Reimplemented from KIWAY_PLAYER.

Definition at line 314 of file pl_editor_frame.cpp.

315 {
316  wxString fn = aFileSet[0];
317 
318  if( !LoadPageLayoutDescrFile( fn ) )
319  {
320  wxMessageBox( wxString::Format( _( "Error when loading file \"%s\"" ), fn ) );
321  return false;
322  }
323  else
324  {
325  OnNewPageLayout();
326  return true;
327  }
328 }
void OnNewPageLayout()
Must be called to initialize parameters when a new page layout description is loaded.
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
#define _(s)
Definition: 3d_actions.cpp:33
bool LoadPageLayoutDescrFile(const wxString &aFullFileName)
Function LoadPageLayoutDescrFile Loads a .kicad_wks page layout descr file.

References _, Format(), LoadPageLayoutDescrFile(), and OnNewPageLayout().

◆ ParseArgs()

virtual void KIWAY_PLAYER::ParseArgs ( wxCmdLineParser &  aParser)
inlinevirtualinherited

Handle command-line arguments in a frame-specific way.

The given argument parser has already been initialized with the command line and any options/switches that are handled by the top-level launcher before passing control to the child frame.

Parameters
aParseris the argument parser created by the top-level launcher.

Definition at line 136 of file kiway_player.h.

137  {
138  WXUNUSED( aParser );
139  }

Referenced by PGM_SINGLE_TOP::OnPgmInit().

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )
virtualinherited

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

Definition at line 1078 of file eda_base_frame.cpp.

1079 {
1080  return m_redoList.PopCommand();
1081 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_redoList

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

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

◆ PopCommandFromUndoList()

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const std::string &  actionName)
virtualinherited

Definition at line 60 of file tools_holder.cpp.

61 {
62  // Push/pop events can get out of order (such as when they're generated by the Simulator
63  // frame but not processed until the mouse is back in the Schematic frame), so make sure
64  // we're popping the right stack frame.
65 
66  for( int i = (int) m_toolStack.size() - 1; i >= 0; --i )
67  {
68  if( m_toolStack[ i ] == actionName )
69  {
70  m_toolStack.erase( m_toolStack.begin() + i );
71 
72  // If there's something underneath us, and it's now the top of the stack, then
73  // re-activate it