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 (C) 1992-2023 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, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
32#ifndef EDA_BASE_FRAME_H_
33#define EDA_BASE_FRAME_H_
34
35
36#include <vector>
37#include <map>
38
39#include <wx/aui/aui.h>
40#include <layer_ids.h>
41#include <frame_type.h>
42#include <hotkeys_basic.h>
43#include <kiway_holder.h>
44#include <tool/tools_holder.h>
45#include <widgets/ui_common.h>
46#include <widgets/wx_infobar.h>
47#include <undo_redo_container.h>
48#include <units_provider.h>
49#include <origin_transforms.h>
50
51// Option for main frames
52#define KICAD_DEFAULT_DRAWFRAME_STYLE wxDEFAULT_FRAME_STYLE | wxWANTS_CHARS
53
54
55#define VIEWER3D_FRAMENAME wxT( "Viewer3DFrameName" )
56#define QUALIFIED_VIEWER3D_FRAMENAME( parent ) \
57 ( wxString( VIEWER3D_FRAMENAME ) + wxT( ":" ) + parent->GetName() )
58
59#define KICAD_MANAGER_FRAME_NAME wxT( "KicadFrame" )
60
61
62class wxChoice;
63class wxEvent;
64class wxFileName;
65class EDA_ITEM;
67class EDA_MSG_PANEL;
68class BASE_SCREEN;
69class PAGE_INFO;
70class PLOTTER;
71class TITLE_BLOCK;
72class MSG_PANEL_ITEM;
73class TOOL_MANAGER;
74class TOOL_DISPATCHER;
75class ACTIONS;
76class PAGED_DIALOG;
79class FILE_HISTORY;
81class SEARCH_STACK;
84struct WINDOW_SETTINGS;
85struct WINDOW_STATE;
86class ACTION_MENU;
88
89#define DEFAULT_MAX_UNDO_ITEMS 0
90#define ABS_MAX_UNDO_ITEMS (INT_MAX / 2)
91
93typedef std::function< void( wxUpdateUIEvent& ) > UIUpdateHandler;
94
95wxDECLARE_EVENT( EDA_EVT_UNITS_CHANGED, wxCommandEvent );
96
97
107class EDA_BASE_FRAME : public wxFrame, public TOOLS_HOLDER, public KIWAY_HOLDER,
108 public UNITS_PROVIDER
109{
110public:
115 {
118 };
119
120 EDA_BASE_FRAME( wxWindow* aParent, FRAME_T aFrameType, const wxString& aTitle,
121 const wxPoint& aPos, const wxSize& aSize, long aStyle,
122 const wxString& aFrameName, KIWAY* aKiway, const EDA_IU_SCALE& aIuScale );
123
125
126 void ChangeUserUnits( EDA_UNITS aUnits );
127
128 virtual void ToggleUserUnits() { }
129
134 {
135 return m_originTransforms;
136 }
137
138
140
141 virtual SEVERITY GetSeverity( int aErrorCode ) const { return RPT_SEVERITY_UNDEFINED; }
142
149 bool ProcessEvent( wxEvent& aEvent ) override;
150
158 virtual void OnCharHook( wxKeyEvent& aKeyEvent );
159
164 void OnMenuEvent( wxMenuEvent& event );
165
172 virtual void RegisterUIUpdateHandler( int aID, const ACTION_CONDITIONS& aConditions ) override;
173
179 virtual void UnregisterUIUpdateHandler( int aID ) override;
180
189 static void HandleUpdateUIEvent( wxUpdateUIEvent& aEvent, EDA_BASE_FRAME* aFrame,
190 ACTION_CONDITIONS aCond );
191
192 virtual void OnMove( wxMoveEvent& aEvent )
193 {
194 aEvent.Skip();
195 }
196
197 virtual void OnSize( wxSizeEvent& aEvent );
198
199 void OnMaximize( wxMaximizeEvent& aEvent );
200
201 int GetAutoSaveInterval() const;
202
203 bool IsType( FRAME_T aType ) const { return m_ident == aType; }
204 FRAME_T GetFrameType() const { return m_ident; }
205
211 virtual const SEARCH_STACK& sys_search();
212
213 virtual wxString help_name();
214
215 // Event handlers for menu events generated by the macOS application menu
216 void OnKicadAbout( wxCommandEvent& event );
217 void OnPreferences( wxCommandEvent& event );
218
223 void ShowPreferences( wxString aStartPage, wxString aStartParentPage );
224
225 void PrintMsg( const wxString& text );
226
227 void CreateInfoBar();
228
230
235
245 void ShowInfoBarError( const wxString& aErrorMsg, bool aShowCloseButton = false,
247
262 void ShowInfoBarError( const wxString& aErrorMsg, bool aShowCloseButton,
263 std::function<void(void)> aCallback );
264
274 void ShowInfoBarWarning( const wxString& aWarningMsg, bool aShowCloseButton = false );
275
285 void ShowInfoBarMsg( const wxString& aMsg, bool aShowCloseButton = false );
286
291 virtual APP_SETTINGS_BASE* config() const;
292
293 void LoadWindowState( const wxString& aFileName );
300 void LoadWindowSettings( const WINDOW_SETTINGS* aCfg );
301
309
316 virtual void LoadSettings( APP_SETTINGS_BASE* aCfg );
317
324 virtual void SaveSettings( APP_SETTINGS_BASE* aCfg );
325
334
338 virtual void LoadWindowState( const WINDOW_STATE& aState );
339
350 wxString ConfigBaseName() override
351 {
352 wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
353 return baseCfgName;
354 }
355
366 virtual void SaveProjectLocalSettings() {};
367
375 void ImportHotkeyConfigFromFile( std::map<std::string, TOOL_ACTION*> aActionMap,
376 const wxString& aDefaultShortname );
377
390 wxString GetFileFromHistory( int cmdId, const wxString& type,
391 FILE_HISTORY* aFileHistory = nullptr );
392
399 void ClearFileHistory( FILE_HISTORY* aFileHistory = nullptr );
400
410 void UpdateFileHistory( const wxString& FullFileName, FILE_HISTORY* aFileHistory = nullptr );
411
418 {
419 return *m_fileHistory;
420 }
421
422 void SetMruPath( const wxString& aPath ) { m_mruPath = aPath; }
423
424 wxString GetMruPath() const { return m_mruPath; }
425
433 virtual wxString GetCurrentFileName() const { return wxEmptyString; }
434
440 void ReCreateMenuBar();
441
442 void SetMenuBar( wxMenuBar *menu_bar ) override;
443
447 void AddStandardHelpMenu( wxMenuBar* aMenuBar );
448
464 bool IsWritable( const wxFileName& aFileName, bool aVerbose = true );
465
478 virtual void CheckForAutoSaveFile( const wxFileName& aFileName );
479
480 virtual void DeleteAutoSaveFile( const wxFileName& aFileName );
481
489 virtual void UpdateStatusBar() { }
490
494 void ShowChangedLanguage() override;
495
500 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
501
505 virtual void ThemeChanged();
506
510 virtual void ProjectChanged() {}
511
512 const wxString& GetAboutTitle() const { return wxGetTranslation( m_aboutTitle ); }
513
514 const wxString& GetUntranslatedAboutTitle() const { return m_aboutTitle; }
515
521 virtual bool IsContentModified() const;
522
531 wxSize GetWindowSize();
532
545 virtual void ClearUndoORRedoList( UNDO_REDO_LIST aList, int aItemCount = -1 )
546 { }
547
553 virtual void ClearUndoRedoList();
554
560 virtual void PushCommandToUndoList( PICKED_ITEMS_LIST* aItem );
561
567 virtual void PushCommandToRedoList( PICKED_ITEMS_LIST* aItem );
568
573
578
579 virtual int GetUndoCommandCount() const { return m_undoList.m_CommandsList.size(); }
580 virtual int GetRedoCommandCount() const { return m_redoList.m_CommandsList.size(); }
581
582 virtual wxString GetUndoActionDescription() const;
583 virtual wxString GetRedoActionDescription() const;
584
585 int GetMaxUndoItems() const { return m_undoRedoCountMax; }
586
591 virtual void OnModify();
592
593 bool NonUserClose( bool aForce )
594 {
595 m_isNonUserClose = true;
596 return Close( aForce );
597 }
598
602 virtual void HandleSystemColorChange();
603
604protected:
606 static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND;
607
611 static wxString GetAutoSaveFilePrefix()
612 {
613 return wxT( "_autosave-" );
614 }
615
616 virtual void doReCreateMenuBar() {}
617
621 void onAutoSaveTimer( wxTimerEvent& aEvent );
622
623
629 virtual void handleIconizeEvent( wxIconizeEvent& aEvent ) {}
630 void onIconize( wxIconizeEvent& aEvent );
631
637 virtual bool isAutoSaveRequired() const { return m_autoSaveRequired; }
638
644 virtual bool doAutoSave();
645
646 virtual bool canCloseWindow( wxCloseEvent& aCloseEvent ) { return true; }
647 virtual void doCloseWindow() { }
648
649 void onSystemColorChange( wxSysColourChangedEvent& aEvent );
650
658 virtual void unitsChangeRefresh() { }
659
663 virtual void setupUIConditions();
664
671 void initExitKey();
672
674
680 virtual void saveProjectSettings() {}
681
687 virtual void OnDropFiles( wxDropFilesEvent& aEvent );
688
689
690 void AddMenuLanguageList( ACTION_MENU* aMasterMenu, TOOL_INTERACTIVE* aControlTool );
691
697 virtual void DoWithAcceptedFiles();
698 std::vector<wxFileName> m_AcceptedFiles;
699
700 DECLARE_EVENT_TABLE()
701
702private:
713 void windowClosing( wxCloseEvent& event );
714
718 void commonInit( FRAME_T aFrameType );
719
720 wxWindow* findQuasiModalDialog();
721
729 virtual bool IsModal() const { return false; }
730
731#ifdef _WIN32
735 WXLRESULT MSWWindowProc( WXUINT message, WXWPARAM wParam, WXLPARAM lParam ) override;
736#endif
737
738 protected:
739 FRAME_T m_ident; // Id Type (pcb, schematic, library..)
740 wxPoint m_framePos;
744
745 // These contain the frame size and position for when it is not maximized
748
749 wxString m_aboutTitle; // Name of program displayed in About.
750
751 wxAuiManager m_auimgr;
752 wxString m_perspective; // wxAuiManager perspective.
753 WX_INFOBAR* m_infoBar; // Infobar for the frame
755 wxString m_configName; // Prefix used to identify some params (frame
756 // size) and to name some config files (legacy
757 // hotkey files)
759
760 FILE_HISTORY* m_fileHistory; // The frame's recently opened file list
765
766 int m_undoRedoCountMax; // undo/Redo command Max depth
767
768 UNDO_REDO_CONTAINER m_undoList; // Objects list for the undo command (old data)
769 UNDO_REDO_CONTAINER m_redoList; // Objects list for the redo command (old data)
770
771 wxString m_mruPath; // Most recently used path.
772
773 ORIGIN_TRANSFORMS m_originTransforms; // Default display origin transforms object.
774
776 std::map<int, UIUpdateHandler> m_uiUpdateMap;
777
781
784
788 std::map<const wxString, TOOL_ACTION*> m_acceptedExts;
789};
790
791
813class EDA_PANE : public wxAuiPaneInfo
814{
815public:
817 {
818 Gripper( false );
819 CloseButton( false );
820 PaneBorder( false );
821 }
822
827 {
828 SetFlag( optionToolbar, true );
829 CaptionVisible( false );
830 TopDockable().BottomDockable();
831 DockFixed( true );
832 Movable( false );
833 Resizable( true ); // expand to fit available space
834 return *this;
835 }
836
841 {
842 SetFlag( optionToolbar, true );
843 CaptionVisible( false );
844 LeftDockable().RightDockable();
845 DockFixed( true );
846 Movable( false );
847 Resizable( true ); // expand to fit available space
848 return *this;
849 }
850
855 {
856 CaptionVisible( true );
857 PaneBorder( true );
858 return *this;
859 }
860
865 {
866 CaptionVisible( false );
867 Layer( 0 );
868 PaneBorder( true );
869 Resizable( true ); // expand to fit available space
870 return *this;
871 }
872
877 {
878 CaptionVisible( false );
879 BottomDockable( true );
880 DockFixed( true );
881 Movable( false );
882 Resizable( true ); // expand to fit available space
883 return *this;
884 }
885
890 {
891 CaptionVisible( false );
892 Movable( false );
893 Resizable( true );
894 PaneBorder( false );
895 DockFixed( true );
896 return *this;
897 }
898};
899
900#endif // EDA_BASE_FRAME_H_
Gather all the actions that are shared by tools.
Definition: actions.h:41
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:49
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:41
The base frame for deriving all KiCad main window classes.
virtual wxString help_name()
virtual void saveProjectSettings()
Saves 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
Returns 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 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.
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 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 setupUIConditions()
Setup the UI conditions for the various actions and their controls in this frame.
void ensureWindowIsOnScreen()
const wxString & GetAboutTitle() const
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
virtual void CheckForAutoSaveFile(const wxFileName &aFileName)
Check if an auto save file exists for aFileName and takes the appropriate action depending on the use...
void OnKicadAbout(wxCommandEvent &event)
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
Specifies 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()
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...
wxString m_perspective
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.
wxSize m_normalFrameSize
static constexpr int KICAD_AUI_TB_STYLE
< Default style flags used for wxAUI toolbars.
void ShowPreferences(wxString aStartPage, wxString aStartParentPage)
Displays the preferences and settings of all opened editors paged dialog, starting with a particular ...
void initExitKey()
Sets 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
void FinishAUIInitialization()
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)
Function AddMenuLanguageList creates a menu list for language choice, and add it as submenu to Master...
void SetMenuBar(wxMenuBar *menu_bar) override
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...
wxTimer * m_autoSaveTimer
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 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.
void ClearFileHistory(FILE_HISTORY *aFileHistory=nullptr)
Removes all files from the file history.
std::map< int, UIUpdateHandler > m_uiUpdateMap
< Map containing the UI update handlers registered with wx for each action.
UNDO_REDO_CONTAINER m_redoList
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.
wxString GetMruPath() const
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
FILE_HISTORY * m_fileHistory
SETTINGS_MANAGER * m_settingsManager
FILE_HISTORY & GetFileHistory()
Get the frame's main file history.
virtual void DeleteAutoSaveFile(const wxFileName &aFileName)
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.
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)
Checks if aFileName can be written.
wxPoint m_normalFramePos
void OnMaximize(wxMaximizeEvent &aEvent)
ORIGIN_TRANSFORMS & GetOriginTransforms() override
Return a reference to the default ORIGIN_TRANSFORMS object.
virtual void OnDropFiles(wxDropFilesEvent &aEvent)
Handles event fired when a file is dropped to the window.
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
Associates files 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)
Fetches the file name from the file history list.
static wxString GetAutoSaveFilePrefix()
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.
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.
void ShowInfoBarError(const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left o...
bool m_isClosing
Set by NonUserClose() to indicate that the user did not request the current close.
bool IsType(FRAME_T aType) const
void AddStandardHelpMenu(wxMenuBar *aMenuBar)
Adds the standard KiCad help menu to the menubar.
wxString m_mruPath
void ReCreateMenuBar()
Recreates 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:85
A panel to display various information messages.
Definition: msgpanel.h:101
Specialization of the wxAuiPaneInfo class for KiCad panels.
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 & InfoBar()
Turn *this into a infobar 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...
Definition: file_history.h:43
A mix in class which holds the location of a wxWindow's KIWAY.
Definition: kiway_holder.h:37
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:279
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:54
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:58
A holder to handle information on schematic or board items.
Base plotter engine class.
Definition: plotter.h:104
Look for files in a number of paths.
Definition: search_stack.h:42
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition: title_block.h:41
Master controller class:
Definition: tool_manager.h:57
A holder to handle a list of undo (or redo) commands.
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
A modified version of the wxInfoBar class that allows us to:
Definition: wx_infobar.h:75
MESSAGE_TYPE
Sets the type of message for special handling if needed.
Definition: wx_infobar.h:93
@ GENERIC
GENERIC Are messages that do not have special handling.
wxDECLARE_EVENT(EDA_EVT_UNITS_CHANGED, wxCommandEvent)
std::function< void(wxUpdateUIEvent &) > UIUpdateHandler
This is the handler functor for the update UI events.
EDA_UNITS
Definition: eda_units.h:46
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:33
SEVERITY
@ RPT_SEVERITY_UNDEFINED
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
Stores the common settings that are saved and loaded for each window / frame.
Definition: app_settings.h:74
Stores the window positioning/state.
Definition: app_settings.h:61
Functions to provide common constants and other functions to assist in making a consistent UI.