KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eda_base_frame.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2009-2015 Jean-Pierre Charras, jp.charras wanadoo.fr
5 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
6 * Copyright (C) 2023 CERN (www.cern.ch)
7 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <https://www.gnu.org/licenses/>.
21 */
22
27
28#ifndef EDA_BASE_FRAME_H_
29#define EDA_BASE_FRAME_H_
30
31
32#include <functional>
33#include <map>
34#include <optional>
35#include <string>
36#include <vector>
37
38#include <memory>
39#include <nlohmann/json_fwd.hpp>
40
41#include <wx/aui/aui.h>
42#include <wx/datetime.h>
43#include <layer_ids.h>
44#include <frame_type.h>
45#include <hotkeys_basic.h>
46#include <kiway_holder.h>
47#include <tool/tools_holder.h>
48#include <widgets/ui_common.h>
50#include <undo_redo_container.h>
51#include <units_provider.h>
52#include <origin_transforms.h>
53#include <scoped_set_reset.h>
54#include <ui_events.h>
55
56// Option for main frames
57#define KICAD_DEFAULT_DRAWFRAME_STYLE wxDEFAULT_FRAME_STYLE | wxWANTS_CHARS
58
59
60#define VIEWER3D_FRAMENAME wxT( "Viewer3DFrameName" )
61#define QUALIFIED_VIEWER3D_FRAMENAME( parent ) \
62 ( wxString( VIEWER3D_FRAMENAME ) + wxT( ":" ) + parent->GetName() )
63
64#define KICAD_MANAGER_FRAME_NAME wxT( "KicadFrame" )
65
66
67class wxChoice;
68class wxEvent;
69class wxFileName;
70class EDA_ITEM;
72class EDA_MSG_PANEL;
73class BASE_SCREEN;
74class PAGE_INFO;
75class PLOTTER;
76class TITLE_BLOCK;
77class MSG_PANEL_ITEM;
78class TOOL_MANAGER;
79class TOOL_DISPATCHER;
80class ACTIONS;
81class PAGED_DIALOG;
84class FILE_HISTORY;
86class SEARCH_STACK;
89struct WINDOW_SETTINGS;
90struct WINDOW_STATE;
91class ACTION_MENU;
92class ACTION_TOOLBAR;
96class WX_INFOBAR;
97
98using ACTION_TOOLBAR_CONTROL_FACTORY = std::function<void( ACTION_TOOLBAR* )>;
99
100#define DEFAULT_MAX_UNDO_ITEMS 0
101#define ABS_MAX_UNDO_ITEMS (INT_MAX / 2)
102
104typedef std::function< void( wxUpdateUIEvent& ) > UIUpdateHandler;
105
106
116class EDA_BASE_FRAME : public wxFrame, public TOOLS_HOLDER, public KIWAY_HOLDER,
117 public UNITS_PROVIDER
118{
119public:
128
129 EDA_BASE_FRAME( wxWindow* aParent, FRAME_T aFrameType, const wxString& aTitle,
130 const wxPoint& aPos, const wxSize& aSize, long aStyle,
131 const wxString& aFrameName, KIWAY* aKiway, const EDA_IU_SCALE& aIuScale );
132
134
137 static const wxString GitCommitPaneName() { return wxS( "GitCommitPane" ); }
138
139 void ChangeUserUnits( EDA_UNITS aUnits );
140
141 virtual void ToggleUserUnits() { }
142
147 {
148 return m_originTransforms;
149 }
150
151
153
154 virtual SEVERITY GetSeverity( int aErrorCode ) const { return RPT_SEVERITY_UNDEFINED; }
155
162 bool ProcessEvent( wxEvent& aEvent ) override;
163
171 virtual void OnCharHook( wxKeyEvent& aKeyEvent );
172
177 void OnMenuEvent( wxMenuEvent& event );
178
185 virtual void RegisterUIUpdateHandler( int aID, const ACTION_CONDITIONS& aConditions ) override;
186
192 virtual void UnregisterUIUpdateHandler( int aID ) override;
193
202 static void HandleUpdateUIEvent( wxUpdateUIEvent& aEvent, EDA_BASE_FRAME* aFrame,
203 ACTION_CONDITIONS& aCond );
204
205 virtual void OnMove( wxMoveEvent& aEvent )
206 {
207 aEvent.Skip();
208 }
209
210 virtual void OnSize( wxSizeEvent& aEvent );
211
216 void SelectToolbarAction( const TOOL_ACTION& aAction ) override;
217
218 void OnMaximize( wxMaximizeEvent& aEvent );
219
220 int GetAutoSaveInterval() const;
221
222 bool IsType( FRAME_T aType ) const { return m_ident == aType; }
223 FRAME_T GetFrameType() const { return m_ident; }
224
230 virtual const SEARCH_STACK& sys_search();
231
232 virtual wxString help_name();
233
234 // Event handlers for menu events generated by the macOS application menu
235 void OnKicadAbout( wxCommandEvent& event );
236 void OnPreferences( wxCommandEvent& event );
237
242 void ShowPreferences( const wxString& aStartPage, const wxString& aStartParentPage );
243
244 void PrintMsg( const wxString& text );
245
246 void CreateInfoBar();
247
248 void RestoreAuiLayout();
249
251
256
267 void ShowInfoBarError( const wxString& aErrorMsg, bool aShowCloseButton = false,
269
284 void ShowInfoBarError( const wxString& aErrorMsg, bool aShowCloseButton,
285 std::function<void(void)> aCallback );
286
296 void ShowInfoBarWarning( const wxString& aWarningMsg, bool aShowCloseButton = false );
297
307 void ShowInfoBarMsg( const wxString& aMsg, bool aShowCloseButton = false );
308
313 virtual APP_SETTINGS_BASE* config() const;
314
315 void LoadWindowState( const wxString& aFileName );
316
323 void LoadWindowSettings( const WINDOW_SETTINGS* aCfg );
324
332
339 virtual void LoadSettings( APP_SETTINGS_BASE* aCfg );
340
347 virtual void SaveSettings( APP_SETTINGS_BASE* aCfg );
348
357
361 virtual void LoadWindowState( const WINDOW_STATE& aState );
362
373 wxString ConfigBaseName() override
374 {
375 wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
376 return baseCfgName;
377 }
378
390 virtual void SaveProjectLocalSettings() {};
391
399 void ImportHotkeyConfigFromFile( std::map<std::string, TOOL_ACTION*> aActionMap,
400 const wxString& aDefaultShortname );
401
414 wxString GetFileFromHistory( int cmdId, const wxString& type,
415 FILE_HISTORY* aFileHistory = nullptr );
416
420 virtual void ClearFileHistory();
421
431 void UpdateFileHistory( const wxString& FullFileName, FILE_HISTORY* aFileHistory = nullptr );
432
439 {
440 return *m_fileHistory;
441 }
442
443 void SetMruPath( const wxString& aPath ) { m_mruPath = aPath; }
444
445 wxString GetMruPath() const { return m_mruPath; }
446
454 virtual wxString GetCurrentFileName() const { return wxEmptyString; }
455
456 virtual void RecreateToolbars();
457
462
466 virtual void UpdateToolbarControlSizes();
467
478 const ACTION_TOOLBAR_CONTROL_FACTORY& aControlFactory );
479
484
490 void ReCreateMenuBar();
491
495 void AddStandardHelpMenu( wxMenuBar* aMenuBar );
496
497 wxString GetRunMenuCommandDescription( const TOOL_ACTION& aAction );
498
514 bool IsWritable( const wxFileName& aFileName, bool aVerbose = true );
515
523 virtual void UpdateStatusBar() { }
524
528 void ShowChangedLanguage() override;
529
534 void CommonSettingsChanged( int aFlags ) override;
535
539 virtual void ThemeChanged();
540
544 virtual void ProjectChanged() {}
545
546 wxString GetAboutTitle() const { return wxGetTranslation( m_aboutTitle ); }
547
548 const wxString& GetUntranslatedAboutTitle() const { return m_aboutTitle; }
549
555 virtual bool IsContentModified() const;
556
565 wxSize GetWindowSize();
566
579 virtual void ClearUndoORRedoList( UNDO_REDO_LIST aList, int aItemCount = -1 )
580 { }
581
587 virtual void ClearUndoRedoList();
588
594 virtual void PushCommandToUndoList( PICKED_ITEMS_LIST* aItem );
595
601 virtual void PushCommandToRedoList( PICKED_ITEMS_LIST* aItem );
602
607
612
613 virtual int GetUndoCommandCount() const { return m_undoList.m_CommandsList.size(); }
614 virtual int GetRedoCommandCount() const { return m_redoList.m_CommandsList.size(); }
615
616 virtual wxString GetUndoActionDescription() const;
617 virtual wxString GetRedoActionDescription() const;
618
619 int GetMaxUndoItems() const { return m_undoRedoCountMax; }
620
625 virtual void OnModify();
626
627 bool IsClosing() const { return m_isClosing; }
628
629 bool NonUserClose( bool aForce )
630 {
631 // Close() runs the whole close synchronously, so a vetoed or re-entrant close cannot leave the flag set
632 SCOPED_SET_RESET<bool> nonUserClose( m_isNonUserClose, true );
633
634 return Close( aForce );
635 }
636
637 virtual void ClearToolbarControl( int aId ) { }
638
642 virtual void HandleSystemColorChange();
643
650 virtual bool CanAcceptApiCommands() { return IsEnabled(); }
651
652protected:
654 static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND;
655
656 virtual void doReCreateMenuBar() {}
657
658 virtual void configureToolbars();
659
661 virtual void syncToolbarSelections() {}
662
666 void onAutoSaveTimer( wxTimerEvent& aEvent );
667
668
674 virtual void handleIconizeEvent( wxIconizeEvent& aEvent ) {}
675 void onIconize( wxIconizeEvent& aEvent );
676
682 virtual bool isAutoSaveRequired() const { return m_autoSaveRequired; }
683
689 virtual bool doAutoSave();
690
703 virtual bool canRunAutoSave() const { return true; }
704
721 void CheckForAutosaveFiles( const wxString& aProjectPath, const std::vector<wxString>& aExtensions );
722
723 virtual bool canCloseWindow( wxCloseEvent& aCloseEvent ) { return true; }
724 virtual void doCloseWindow() { }
725
731 bool isBlockableSessionEnd() const;
732
733 void onSystemColorChange( wxSysColourChangedEvent& aEvent );
734
742 virtual void unitsChangeRefresh() { }
743
747 virtual void setupUIConditions();
748
755 void initExitKey();
756
758
765 virtual void saveProjectSettings() {}
766
773 virtual void OnDropFiles( wxDropFilesEvent& aEvent );
774
781 void AddMenuLanguageList( ACTION_MENU* aMasterMenu, TOOL_INTERACTIVE* aControlTool );
782
786 void OnLanguageSelectionEvent( wxCommandEvent& aEvent );
787
794 virtual void DoWithAcceptedFiles();
795 std::vector<wxFileName> m_AcceptedFiles;
796
797 DECLARE_EVENT_TABLE()
798
799private:
800 void onUpdateUI( wxUpdateUIEvent& aEvent );
801
812 void windowClosing( wxCloseEvent& event );
813
817 void commonInit( FRAME_T aFrameType );
818
819 wxWindow* findQuasiModalDialog();
820
828 virtual bool IsModal() const { return false; }
829
830#ifdef __WXMSW__
834 WXLRESULT MSWWindowProc( WXUINT message, WXWPARAM wParam, WXLPARAM lParam ) override;
835#endif
836
837 protected:
838 FRAME_T m_ident; // Id Type (pcb, schematic, library..)
839 wxPoint m_framePos;
843
844 // These contain the frame size and position for when it is not maximized
847
848 wxString m_aboutTitle; // Name of program displayed in About.
849
850 wxAuiManager m_auimgr;
851 wxString m_perspective; // wxAuiManager perspective.
852 std::unique_ptr<nlohmann::json> m_auiLayoutState;
853 WX_INFOBAR* m_infoBar; // Infobar for the frame
855 wxString m_configName; // Prefix used to identify some params (frame
856 // size) and to name some config files (legacy
857 // hotkey files)
859
860 FILE_HISTORY* m_fileHistory; // The frame's recently opened file list
866
867 // Wall-clock of the first autosave deferred by canRunAutoSave(), or an invalid time when no
868 // deferral is outstanding. Used to bound how long an interactive operation may starve the
869 // snapshot so a long routing session can't leave the document unsnapshotted forever.
871
872 int m_undoRedoCountMax; // undo/Redo command Max depth
873
874 UNDO_REDO_CONTAINER m_undoList; // Objects list for the undo command (old data)
875 UNDO_REDO_CONTAINER m_redoList; // Objects list for the redo command (old data)
876
877 wxString m_mruPath; // Most recently used path.
878
879 ORIGIN_TRANSFORMS m_originTransforms; // Default display origin transforms object.
880
882 std::map<int, UIUpdateHandler> m_uiUpdateMap;
883
886
890
895
898
902 std::map<const wxString, TOOL_ACTION*> m_acceptedExts;
903
904 // Toolbar Settings - this is not owned by the frame
906
907 // Toolbar UI elements
909 ACTION_TOOLBAR* m_tbTopAux; // Additional tools under main toolbar
910 ACTION_TOOLBAR* m_tbRight; // Drawing tools (typically on right edge of window)
911 ACTION_TOOLBAR* m_tbLeft; // Options (typically on left edge of window)
912
913 std::map<std::string, ACTION_TOOLBAR_CONTROL_FACTORY> m_toolbarControlFactories;
914};
915
916
938class EDA_PANE : public wxAuiPaneInfo
939{
940public:
942 {
943 Gripper( false );
944 CloseButton( false );
945 PaneBorder( false );
946 }
947
952 {
953 SetFlag( optionToolbar, true );
954 CaptionVisible( false );
955 TopDockable().BottomDockable();
956 DockFixed( true );
957 Movable( false );
958 Resizable( true ); // expand to fit available space
959 return *this;
960 }
961
966 {
967 SetFlag( optionToolbar, true );
968 CaptionVisible( false );
969 LeftDockable().RightDockable();
970 DockFixed( true );
971 Movable( false );
972 Resizable( true ); // expand to fit available space
973 return *this;
974 }
975
980 {
981 CaptionVisible( true );
982 PaneBorder( true );
983 return *this;
984 }
985
990 {
991 CaptionVisible( false );
992 Layer( 0 );
993 PaneBorder( true );
994 Resizable( true ); // expand to fit available space
995 return *this;
996 }
997
1002 {
1003 CaptionVisible( false );
1004 BottomDockable( true );
1005 DockFixed( true );
1006 Movable( false );
1007 Resizable( true ); // expand to fit available space
1008 return *this;
1009 }
1010};
1011
1012#endif // EDA_BASE_FRAME_H_
Gather all the actions that are shared by tools.
Definition actions.h:44
Define the structure of a menu based on ACTIONs.
Definition action_menu.h:43
Class to hold basic information about controls that can be added to the toolbars.
Define the structure of a toolbar with buttons that invoke ACTIONs.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Handles how to draw a screen (a board, a schematic ...)
Definition base_screen.h:37
The base frame for deriving all KiCad main window classes.
void SelectToolbarAction(const TOOL_ACTION &aAction) override
Select the given action in the toolbar group which contains it, if any.
virtual wxString help_name()
virtual void saveProjectSettings()
Save any design-related project settings associated with this frame.
virtual bool doAutoSave()
This should be overridden by the derived class to handle the auto save feature.
void LoadWindowState(const wxString &aFileName)
FRAME_T GetFrameType() const
wxString ConfigBaseName() override
Get the configuration base name.
virtual void UnregisterUIUpdateHandler(int aID) override
Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler.
virtual bool isAutoSaveRequired() const
Return the auto save status of the application.
virtual APP_SETTINGS_BASE * config() const
Return the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
virtual void handleIconizeEvent(wxIconizeEvent &aEvent)
Handle a window iconize event.
virtual void PushCommandToUndoList(PICKED_ITEMS_LIST *aItem)
Add a command to undo in the undo list.
void ShowPreferences(const wxString &aStartPage, const wxString &aStartParentPage)
Display the preferences and settings of all opened editors paged dialog, starting with a particular p...
void windowClosing(wxCloseEvent &event)
(with its unexpected name so it does not collide with the real OnWindowClose() function provided in d...
APPEARANCE_CONTROLS_3D * m_appearancePanel
virtual void OnCharHook(wxKeyEvent &aKeyEvent)
Capture the key event before it is sent to the GUI.
virtual int GetRedoCommandCount() const
bool NonUserClose(bool aForce)
virtual void ProjectChanged()
Notification event that the project has changed.
void CommonSettingsChanged(int aFlags) override
Notification event that some of the common (suite-wide) settings have changed.
UNDO_REDO_CONTAINER m_undoList
virtual void OnMove(wxMoveEvent &aEvent)
virtual WINDOW_SETTINGS * GetWindowSettings(APP_SETTINGS_BASE *aCfg)
Return a pointer to the window settings for this frame.
virtual void doCloseWindow()
const wxString & GetUntranslatedAboutTitle() const
virtual void UpdateStatusBar()
Update the status bar information.
void OnToolbarSizeChanged()
Update toolbars if desired toolbar icon changed.
void OnMenuEvent(wxMenuEvent &event)
The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't ...
virtual bool IsModal() const
Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame...
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
virtual void HandleSystemColorChange()
Update the UI in response to a change in the system colors.
virtual void syncToolbarSelections()
Called after the toolbars are rebuilt so a frame can select the group entries that reflect its saved ...
static const wxString GitCommitPaneName()
Named here rather than beside the editors' other panes, because the project manager docks this one to...
virtual void setupUIConditions()
Setup the UI conditions for the various actions and their controls in this frame.
bool m_isNonUserClose
Set by NonUserClose() to indicate that the user did not request the current close.
void CheckForAutosaveFiles(const wxString &aProjectPath, const std::vector< wxString > &aExtensions)
Check for autosave files newer than their source files for the given project.
virtual void ClearToolbarControl(int aId)
void LoadWindowSettings(const WINDOW_SETTINGS *aCfg)
Load window settings from the given settings object.
std::vector< wxFileName > m_AcceptedFiles
virtual SEVERITY GetSeverity(int aErrorCode) const
bool m_uiUpdateHandlerBound
True once the single wxID_ANY UPDATE_UI handler has been bound.
bool m_autoSavePermissionError
void OnKicadAbout(wxCommandEvent &event)
virtual void UpdateToolbarControlSizes()
Update the sizes of any controls in the toolbars of the frame.
virtual void ClearUndoRedoList()
Clear the undo and redo list using ClearUndoORRedoList()
SETTINGS_MANAGER * GetSettingsManager() const
virtual void DoWithAcceptedFiles()
Execute action on accepted dropped file.
UNDO_REDO_LIST
Specify whether we are interacting with the undo or redo stacks.
virtual void OnModify()
Must be called after a model change in order to set the "modify" flag and do other frame-specific pro...
wxWindow * findQuasiModalDialog()
bool isBlockableSessionEnd() const
Return true when the session is ending on a platform that shows a shutdown block reason.
wxString m_perspective
wxDateTime m_autoSaveDeferredSince
bool IsClosing() const
virtual void ClearUndoORRedoList(UNDO_REDO_LIST aList, int aItemCount=-1)
Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if nee...
virtual void ThemeChanged()
Process light/dark theme change.
EDA_BASE_FRAME(wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName, KIWAY *aKiway, const EDA_IU_SCALE &aIuScale)
static constexpr int KICAD_AUI_TB_STYLE
Default style flags used for wxAUI toolbars.
bool m_closeInProgress
Set while windowClosing() is deciding whether the frame may close.
ACTION_TOOLBAR * m_tbRight
void initExitKey()
Set the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
void OnPreferences(wxCommandEvent &event)
virtual const SEARCH_STACK & sys_search()
Return a SEARCH_STACK pertaining to entire program.
WX_INFOBAR * m_infoBar
void onAutoSaveTimer(wxTimerEvent &aEvent)
Handle the auto save timer event.
void SaveWindowSettings(WINDOW_SETTINGS *aCfg)
Save window settings to the given settings object.
virtual void ToggleUserUnits()
virtual wxString GetRedoActionDescription() const
wxString GetAboutTitle() const
TOOLBAR_SETTINGS * m_toolbarSettings
virtual wxString GetCurrentFileName() const
Get the full filename + path of the currently opened file in the frame.
void ChangeUserUnits(EDA_UNITS aUnits)
wxString m_configName
void AddMenuLanguageList(ACTION_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
Create a menu list for language choice, and add it as submenu to MasterMenu.
virtual bool canRunAutoSave() const
Return true when it is safe to run an autosave snapshot right now.
void RegisterCustomToolbarControlFactory(const ACTION_TOOLBAR_CONTROL &aControlDesc, const ACTION_TOOLBAR_CONTROL_FACTORY &aControlFactory)
Register a creation factory for toolbar controls that are present in this frame.
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...
virtual void configureToolbars()
wxTimer * m_autoSaveTimer
void ShowInfoBarError(const wxString &aErrorMsg, bool aShowCloseButton=false, INFOBAR_MESSAGE_TYPE aType=INFOBAR_MESSAGE_TYPE::GENERIC)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left o...
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
wxAuiManager m_auimgr
void PrintMsg(const wxString &text)
void onUpdateUI(wxUpdateUIEvent &aEvent)
void commonInit(FRAME_T aFrameType)
Collect common initialization functions used in all CTORs.
virtual bool IsContentModified() const
Get if the contents of the frame have been modified since the last save.
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 ...
int GetMaxUndoItems() const
virtual PICKED_ITEMS_LIST * PopCommandFromRedoList()
Return the last command to undo and remove it from list, nothing is deleted.
virtual bool CanAcceptApiCommands()
Check if this frame is ready to accept API commands.
virtual void RecreateToolbars()
std::map< int, UIUpdateHandler > m_uiUpdateMap
Map containing the UI update handlers registered with wx for each action.
std::map< std::string, ACTION_TOOLBAR_CONTROL_FACTORY > m_toolbarControlFactories
ACTION_TOOLBAR_CONTROL_FACTORY * GetCustomToolbarControlFactory(const std::string &aName)
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 rela...
UNDO_REDO_CONTAINER m_redoList
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.
wxString GetMruPath() const
FILE_HISTORY * m_fileHistory
ACTION_TOOLBAR * m_tbLeft
SETTINGS_MANAGER * m_settingsManager
FILE_HISTORY & GetFileHistory()
Get the frame's main file history.
virtual void OnSize(wxSizeEvent &aEvent)
virtual wxString GetUndoActionDescription() const
void ImportHotkeyConfigFromFile(std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
Prompt the user for a hotkey file to read, and read it.
virtual PICKED_ITEMS_LIST * PopCommandFromUndoList()
Return the last command to undo and remove it from list, nothing is deleted.
void OnLanguageSelectionEvent(wxCommandEvent &aEvent)
An event handler called on a language menu selection.
wxString GetRunMenuCommandDescription(const TOOL_ACTION &aAction)
virtual bool canCloseWindow(wxCloseEvent &aCloseEvent)
bool ProcessEvent(wxEvent &aEvent) override
Override the default process event handler to implement the auto save feature.
bool IsWritable(const wxFileName &aFileName, bool aVerbose=true)
Check if aFileName can be written.
wxPoint m_normalFramePos
void OnMaximize(wxMaximizeEvent &aEvent)
std::unique_ptr< nlohmann::json > m_auiLayoutState
virtual void ClearFileHistory()
Remove all files from the file history.
ORIGIN_TRANSFORMS & GetOriginTransforms() override
Return a reference to the default ORIGIN_TRANSFORMS object.
ACTION_TOOLBAR * m_tbTopAux
virtual void OnDropFiles(wxDropFilesEvent &aEvent)
Handle event fired when a file is dropped to the window.
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
Associate file extensions with action to execute.
void onIconize(wxIconizeEvent &aEvent)
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
wxString GetFileFromHistory(int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
Fetch the file name from the file history list.
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.
int GetAutoSaveInterval() const
virtual void SaveSettings(APP_SETTINGS_BASE *aCfg)
Save common frame parameters to a configuration data file.
void SetMruPath(const wxString &aPath)
void onSystemColorChange(wxSysColourChangedEvent &aEvent)
virtual int GetUndoCommandCount() const
ORIGIN_TRANSFORMS m_originTransforms
virtual void RegisterUIUpdateHandler(int aID, const ACTION_CONDITIONS &aConditions) override
Register a UI update handler for the control with ID aID.
ACTION_TOOLBAR * m_tbTopMain
virtual void SaveProjectLocalSettings()
Save changes to the project local settings.
wxString m_aboutTitle
virtual void PushCommandToRedoList(PICKED_ITEMS_LIST *aItem)
Add a command to redo in the redo list.
bool m_isClosing
Set by the close window event handler after frames are asked if they can close.
bool IsType(FRAME_T aType) const
void AddStandardHelpMenu(wxMenuBar *aMenuBar)
Add the standard KiCad help menu to the menubar.
void ReCreateMenuBar()
Recreate the menu bar.
virtual void doReCreateMenuBar()
WX_INFOBAR * GetInfoBar()
A base class for most all the KiCad significant classes used in schematics and boards.
Definition eda_item.h:98
A panel to display various information messages.
Definition msgpanel.h:97
EDA_PANE & Canvas()
Turn *this into an undecorated pane suitable for a drawing canvas.
EDA_PANE & Messages()
Turn *this into a messages pane for KiCad.
EDA_PANE & HToolbar()
Turn *this to a horizontal toolbar for KiCad.
EDA_PANE & VToolbar()
Turn *this into a vertical toolbar for KiCad.
EDA_PANE & Palette()
Turn *this into a captioned palette suitable for a symbol tree, layers manager, etc.
This class implements a file history object to store a list of files, that can then be added to a men...
KIWAY_HOLDER(KIWAY *aKiway, HOLDER_TYPE aType)
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:348
EDA_MSG_PANEL items for displaying messages.
Definition msgpanel.h:50
A class to perform either relative or absolute display origin transforms for a single axis of a point...
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition page_info.h:75
A holder to handle information on schematic or board items.
Base plotter engine class.
Definition plotter.h:138
RAII class that sets an value at construction and resets it to the original value at destruction.
Look for files in a number of paths.
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition title_block.h:38
Represent a single user action.
Master controller class:
A holder to handle a list of undo (or redo) commands.
UNITS_PROVIDER(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits)
A modified version of the wxInfoBar class that allows us to:
Definition wx_infobar.h:77
std::function< void(ACTION_TOOLBAR *)> ACTION_TOOLBAR_CONTROL_FACTORY
std::function< void(wxUpdateUIEvent &) > UIUpdateHandler
This is the handler functor for the update UI events.
EDA_UNITS
Definition eda_units.h:45
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition frame_type.h:29
std::string message
SEVERITY
@ RPT_SEVERITY_UNDEFINED
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
Store the common settings that are saved and loaded for each window / frame.
Store the window positioning/state.
Functions to provide common constants and other functions to assist in making a consistent UI.
INFOBAR_MESSAGE_TYPE
Sets the type of message for special handling if needed.
@ GENERIC
GENERIC Are messages that do not have special handling.