72#include <wx/display.h>
73#include <wx/stdpaths.h>
76#include <wx/wupdlock.h>
95 return wxWindow::FromDIP( wxSize( 406, 354 ), aWindow );
98 return wxWindow::FromDIP( wxSize( 500, 400 ), aWindow );
108 return wxWindow::FromDIP( wxSize( 850, 540 ), aWindow );
111 return wxWindow::FromDIP( wxSize( 1280, 720 ), aWindow );
176 const wxPoint& aPos,
const wxSize& aSize,
long aStyle,
177 const wxString& aFrameName,
KIWAY* aKiway,
179 wxFrame( aParent, wxID_ANY, aTitle, aPos, aSize, aStyle, aFrameName ),
195 for( wxWindow* child : aParent->GetChildren() )
199 if( dlg->IsQuasiModal() )
220 wxWindow* cvpcb = wxWindow::FindWindowByName( wxS(
"CvpcbFrame" ) );
242 if( event.CanVeto() )
249 if( event.GetId() == wxEVT_QUERY_END_SESSION
250 || event.GetId() == wxEVT_END_SESSION )
277 if( event.CanVeto() )
307 if( !IsEnabled() && IsActive() )
316 if( !wxFrame::ProcessEvent( aEvent ) )
319 if(
Pgm().m_Quitting )
328 wxLogTrace(
traceAutoSave, wxT(
"Starting auto save timer." ) );
334 wxLogTrace(
traceAutoSave, wxT(
"Stopping auto save timer." ) );
366 wxCHECK_MSG(
false,
true, wxT(
"Auto save timer function not overridden. Bad programmer!" ) );
392 std::placeholders::_1,
398 Bind( wxEVT_UPDATE_UI, evtFunc, aID );
409 Unbind( wxEVT_UPDATE_UI, it->second, aID );
416 bool checkRes =
false;
417 bool enableRes =
true;
430 catch( std::exception& )
439 wxString msg =
_(
"Undo" );
444 aEvent.SetText( msg );
446 else if( showRes && aEvent.GetId() ==
ACTIONS::redo.GetUIId() )
448 wxString msg =
_(
"Redo" );
453 aEvent.SetText( msg );
456 if( isCut || isCopy || isPaste )
458 wxWindow* focus = wxWindow::FindFocus();
459 wxTextEntry* textEntry =
dynamic_cast<wxTextEntry*
>( focus );
461 if( textEntry && isCut && textEntry->CanCut() )
463 else if( textEntry && isCopy && textEntry->CanCopy() )
465 else if( textEntry && isPaste && textEntry->CanPaste() )
467 else if(
dynamic_cast<WX_GRID*
>( focus ) )
471 aEvent.Enable( enableRes );
472 aEvent.Show( showRes );
474 if( aEvent.IsCheckable() )
475 aEvent.Check( checkRes );
483 [] (
const SELECTION& aSel,
int aLangIdentifier )
488 for(
unsigned ii = 0;
LanguagesList[ii].m_KI_Lang_Identifier != 0; ii++ )
491 cond.
Check( std::bind( isCurrentLang, std::placeholders::_1,
510 if( control.first == aName )
511 return &control.second;
525 wxWindowUpdateLocker
dummy(
this );
529 std::optional<TOOLBAR_CONFIGURATION> tbConfig;
534 if( tbConfig.has_value() )
543 m_tbRight->ApplyConfiguration( tbConfig.value() );
549 if( tbConfig.has_value() )
558 m_tbLeft->ApplyConfiguration( tbConfig.value() );
564 if( tbConfig.has_value() )
573 m_tbTopMain->ApplyConfiguration( tbConfig.value() );
579 if( tbConfig.has_value() )
588 m_tbTopAux->ApplyConfiguration( tbConfig.value() );
657 helpMenu->AppendSeparator();
660 aMenuBar->Append( helpMenu,
_(
"&Help" ) );
671 GetMenuBar()->Refresh();
683 bool running =
Pgm().GetApiServer().Running();
686 Pgm().GetApiServer().Stop();
688 Pgm().GetApiServer().Start();
694 m_fileHistory->SetMaxFiles( (
unsigned) std::max( 0, historySize ) );
704 GetMenuBar()->Refresh();
717 wxAuiPaneInfoArray panes =
m_auimgr.GetAllPanes();
719 for(
size_t i = 0; i < panes.GetCount(); ++i )
722 toolbar->RefreshBitmaps();
730 int currentDisplay = wxDisplay::GetFromWindow(
this );
747 if( !
Pgm().GetCommonSettings()->m_Session.remember_open_files )
752 if( state !=
nullptr )
761 bool wasDefault =
false;
785 if( aState.
display >= wxDisplay::GetCount() )
791 const unsigned int index = 0;
792 wxDisplay display( index );
793 wxRect clientSize = display.GetGeometry();
809 wxDisplay display( aState.
display );
810 wxRect clientSize = display.GetClientArea();
812 int yLimTop = clientSize.y;
813 int yLimBottom = clientSize.y + clientSize.height;
814 int xLimLeft = clientSize.x;
815 int xLimRight = clientSize.x + clientSize.width;
817 if( upperLeft.x > xLimRight ||
818 upperRight.x < xLimLeft ||
819 upperLeft.y < yLimTop ||
820 upperLeft.y > yLimBottom )
857 wxDisplay display( wxDisplay::GetFromWindow(
this ) );
858 wxRect clientSize = display.GetClientArea();
859 wxPoint pos = GetPosition();
863 wxS(
"ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d" ),
864 clientSize.x, clientSize.y,
865 clientSize.width, clientSize.height );
867 if( pos.y < clientSize.y )
870 wxS(
"ensureWindowIsOnScreen: y pos %d below minimum, setting to %d" ), pos.y,
872 pos.y = clientSize.y;
875 if( pos.x < clientSize.x )
878 wxS(
"ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d" ),
879 pos.x, clientSize.x );
880 pos.x = clientSize.x;
883 if( pos.x + size.x - clientSize.x > clientSize.width )
885 int newWidth = clientSize.width - ( pos.x - clientSize.x );
887 wxS(
"ensureWindowIsOnScreen: effective width %d above available %d, setting "
888 "to %d" ), pos.x + size.x, clientSize.width, newWidth );
892 if( pos.y + size.y - clientSize.y > clientSize.height )
894 int newHeight = clientSize.height - ( pos.y - clientSize.y );
896 wxS(
"ensureWindowIsOnScreen: effective height %d above available %d, setting "
897 "to %d" ), pos.y + size.y, clientSize.height, newHeight );
901 wxLogTrace(
traceDisplayLocation, wxS(
"Updating window position (%d, %d) with size (%d, %d)" ),
902 pos.x, pos.y, size.x, size.y );
904 SetSize( pos.x, pos.y, size.x, size.y );
944 IsMaximized() ? wxS(
"true" ) : wxS(
"false" ) );
981 if(
Pgm().GetCommonSettings()->m_Session.remember_open_files && !currentlyOpenedFile.IsEmpty() )
983 wxFileName rfn( currentlyOpenedFile );
984 rfn.MakeRelativeTo(
Prj().GetProjectPath() );
992 if( !currentlyOpenedFile.IsEmpty() )
1027 SetStatusText(
text );
1033#if defined( __WXOSX_MAC__ )
1045#if defined( __WXOSX_MAC__ )
1053 m_auimgr.GetPane( wxS(
"InfoBar" ) ).Hide();
1064 if( aShowCloseButton )
1072 std::function<
void(
void)> aCallback )
1076 if( aShowCloseButton )
1090 if( aShowCloseButton )
1101 if( aShowCloseButton )
1113 wxASSERT( aFileHistory );
1121 GetMenuBar()->Refresh();
1132 wxASSERT( aFileHistory );
1134 int baseId = aFileHistory->GetBaseId();
1136 wxASSERT( cmdId >= baseId && cmdId < baseId + (
int) aFileHistory->GetCount() );
1138 unsigned i = cmdId - baseId;
1140 if( i < aFileHistory->GetCount() )
1142 wxString fn = aFileHistory->GetHistoryFile( i );
1144 if( wxFileName::FileExists( fn ) )
1151 aFileHistory->RemoveFileFromHistory( i );
1159 GetMenuBar()->Refresh();
1162 return wxEmptyString;
1176 GetMenuBar()->Refresh();
1196 PAGED_DIALOG dlg(
this,
_(
"Preferences" ),
true,
true, wxEmptyString,
1197 wxWindow::FromDIP( wxSize( 980, 560 ),
nullptr ) );
1199 dlg.SetEvtHandlerEnabled(
false );
1206 std::vector<int> expand;
1212 ACTION_MANAGER* actionMgr = kicadMgr->GetToolManager()->GetActionManager();
1219 []( wxWindow* aParent ) -> wxWindow*
1226 []( wxWindow* aParent ) -> wxWindow*
1229 },
_(
"Mouse and Touchpad" ) );
1232 [] ( wxWindow* aParent ) -> wxWindow*
1235 },
_(
"SpaceMouse" ) );
1237 book->AddPage( hotkeysPanel,
_(
"Hotkeys" ) );
1240 []( wxWindow* aParent ) -> wxWindow*
1243 },
_(
"Version Control" ) );
1245#ifdef KICAD_USE_SENTRY
1247 []( wxWindow* aParent ) -> wxWindow*
1250 },
_(
"Data Collection" ) );
1253#define LAZY_CTOR( key ) \
1254 [this, kiface]( wxWindow* aParent ) \
1256 return kiface->CreateKiWindow( aParent, key, &Kiway() ); \
1268 expand.push_back( (
int) book->GetPageCount() );
1270 book->AddPage(
new wxPanel( book ),
_(
"Symbol Editor" ) );
1280 expand.push_back( (
int) book->GetPageCount() );
1282 book->AddPage(
new wxPanel( book ),
_(
"Schematic Editor" ) );
1306 expand.push_back( (
int) book->GetPageCount() );
1308 book->AddPage(
new wxPanel( book ),
_(
"Footprint Editor" ) );
1322 expand.push_back( (
int) book->GetPageCount() );
1324 book->AddPage(
new wxPanel( book ),
_(
"PCB Editor" ) );
1337 expand.push_back( (
int) book->GetPageCount() );
1339 book->AddPage(
new wxPanel( book ),
_(
"3D Viewer" ) );
1360 expand.push_back( (
int) book->GetPageCount() );
1362 book->AddPage(
new wxPanel( book ),
_(
"Gerber Viewer" ) );
1384 expand.push_back( (
int) book->GetPageCount() );
1386 book->AddPage(
new wxPanel( book ),
_(
"Drawing Sheet Editor" ) );
1395 []( wxWindow* aParent ) -> wxWindow*
1398 },
_(
"Packages and Updates" ) );
1415 for(
size_t i = 0; i < book->GetPageCount(); ++i )
1416 book->GetPage( i )->Layout();
1418 for(
int page : expand )
1419 book->ExpandNode( page );
1421 if( !aStartPage.IsEmpty() )
1424 dlg.SetEvtHandlerEnabled(
true );
1443 wxString* files = aEvent.GetFiles();
1445 for(
int nb = 0; nb < aEvent.GetNumberOfFiles(); nb++ )
1447 const wxFileName fn = wxFileName( files[nb] );
1448 wxString ext = fn.GetExt();
1467 wxString fn = file.GetFullPath();
1476 wxFileName fn = aFileName;
1482 if( fn.GetPath().IsEmpty() && fn.HasName() )
1485 wxCHECK_MSG( fn.IsOk(),
false,
1486 wxT(
"File name object is invalid. Bad programmer!" ) );
1487 wxCHECK_MSG( !fn.GetPath().IsEmpty(),
false,
1488 wxT(
"File name object path <" ) + fn.GetFullPath() +
1489 wxT(
"> is not set. Bad programmer!" ) );
1491 if( fn.IsDir() && !fn.IsDirWritable() )
1493 msg.Printf(
_(
"Insufficient permissions to folder '%s'." ), fn.GetPath() );
1495 else if( !fn.FileExists() && !fn.IsDirWritable() )
1497 msg.Printf(
_(
"Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
1499 else if( fn.FileExists() && !fn.IsFileWritable() )
1501 msg.Printf(
_(
"Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
1504 if( !msg.IsEmpty() )
1518 if( !
Pgm().IsGUI() )
1521 wxCHECK_RET( aFileName.IsOk(), wxT(
"Invalid file name!" ) );
1523 wxFileName autoSaveFileName = aFileName;
1529 wxT(
"Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
1531 if( !autoSaveFileName.FileExists() )
1534 wxString msg = wxString::Format(
_(
"Well this is potentially embarrassing!\n"
1535 "It appears that the last time you were editing\n"
1537 "KiCad exited before saving.\n"
1539 "Do you wish to open the auto-saved file instead?" ),
1540 aFileName.GetFullName() );
1542 int response = wxMessageBox( msg,
Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
1547 if( response == wxYES )
1551 autoSaveFileName.GetFullPath() );
1553 if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1555 wxMessageBox(
_(
"The auto save file could not be renamed to the board file name." ),
1556 Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION,
this );
1568 if( !
Pgm().IsGUI() )
1571 wxCHECK_RET( aFileName.IsOk(), wxT(
"Invalid file name!" ) );
1573 wxFileName autoSaveFn = aFileName;
1576 if( autoSaveFn.FileExists() )
1578 wxLogTrace(
traceAutoSave, wxT(
"Removing auto save file " ) + autoSaveFn.GetFullPath() );
1579 wxRemoveFile( autoSaveFn.GetFullPath() );
1593 wxAcceleratorEntry entries[1];
1594 entries[0].Set( wxACCEL_CTRL,
int(
'Q' ), wxID_EXIT );
1595 wxAcceleratorTable accel( 1, entries );
1596 SetAcceleratorTable( accel );
1616 if( extraitems > 0 )
1631 if( extraitems > 0 )
1652 return m_undoList.m_CommandsList.back()->GetDescription();
1654 return wxEmptyString;
1661 return m_redoList.m_CommandsList.back()->GetDescription();
1663 return wxEmptyString;
1678 wxCommandEvent e( EDA_EVT_UNITS_CHANGED );
1679 e.SetInt(
static_cast<int>( aUnits ) );
1680 e.SetClientData(
this );
1681 ProcessEventLocally( e );
1693 if( !IsMaximized() )
1699 "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
1712 wxSize winSize = GetSize();
1721 GTKDoGetSize( &width, &height );
1723 winSize.Set( width, height );
1726 wxSize winSize = GetSize();
1744 GetMenuBar()->Refresh();
1770WXLRESULT EDA_BASE_FRAME::MSWWindowProc( WXUINT message, WXWPARAM wParam, WXLPARAM lParam )
1774 if( message == WM_SYSCOMMAND )
1776 if( wParam == SC_KEYMENU && ( lParam >> 16 ) <= 0 )
1780 return wxFrame::MSWWindowProc( message, wParam, lParam );
1788 langsMenu->
SetTitle(
_(
"Set Language" ) );
1793 for(
unsigned ii = 0;
LanguagesList[ii].m_KI_Lang_Identifier != 0; ii++ )
1803 new wxMenuItem( langsMenu,
1805 label, tooltip, wxITEM_CHECK );
1807 langsMenu->Append( item );
1811 aMasterMenu->
Add( langsMenu );
void ShowAboutDialog(EDA_BASE_FRAME *aParent)
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
void ClearScaledBitmapCache()
Wipes out the scaled bitmap cache so that the icon theme can be changed.
BITMAP_STORE * GetBitmapStore()
static TOOL_ACTION reportBug
static TOOL_ACTION donate
static TOOL_ACTION listHotKeys
static TOOL_ACTION getInvolved
static TOOL_ACTION gettingStarted
Manage TOOL_ACTION objects.
const std::map< std::string, TOOL_ACTION * > & GetActions() const
Get a list of currently-registered actions mapped by their name.
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
void ThemeChanged()
Notifies the store that the icon theme has been changed by the user, so caches must be invalidated.
Handle actions that are shared between different applications.
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
The base frame for deriving all KiCad main window classes.
virtual wxString help_name()
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
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 windowClosing(wxCloseEvent &event)
(with its unexpected name so it does not collide with the real OnWindowClose() function provided in d...
virtual void OnCharHook(wxKeyEvent &aKeyEvent)
Capture the key event before it is sent to the GUI.
virtual int GetRedoCommandCount() const
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()
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 setupUIConditions()
Setup the UI conditions for the various actions and their controls in this frame.
void ensureWindowIsOnScreen()
bool m_isNonUserClose
Set by NonUserClose() to indicate that the user did not request the current close.
void LoadWindowSettings(const WINDOW_SETTINGS *aCfg)
Load window settings from the given settings object.
std::vector< wxFileName > m_AcceptedFiles
virtual void CheckForAutoSaveFile(const wxFileName &aFileName)
Check if an auto save file exists for aFileName and takes the appropriate action depending on the use...
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()
virtual void DoWithAcceptedFiles()
Execute action on accepted dropped file.
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...
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.
ACTION_TOOLBAR * m_tbRight
void ShowPreferences(wxString aStartPage, wxString aStartParentPage)
Display the preferences and settings of all opened editors paged dialog, starting with a particular p...
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.
void onAutoSaveTimer(wxTimerEvent &aEvent)
Handle the auto save timer event.
void SaveWindowSettings(WINDOW_SETTINGS *aCfg)
Save window settings to the given settings object.
virtual wxString GetRedoActionDescription() const
TOOLBAR_SETTINGS * m_toolbarSettings
void FinishAUIInitialization()
virtual wxString GetCurrentFileName() const
Get the full filename + path of the currently opened file in the frame.
void ChangeUserUnits(EDA_UNITS aUnits)
void AddMenuLanguageList(ACTION_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
Create a menu list for language choice, and add it as submenu to MasterMenu.
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 UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
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 ...
virtual PICKED_ITEMS_LIST * PopCommandFromRedoList()
Return the last command to undo and remove it from list, nothing is deleted.
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)
UNDO_REDO_CONTAINER m_redoList
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.
FILE_HISTORY * m_fileHistory
ACTION_TOOLBAR * m_tbLeft
SETTINGS_MANAGER * m_settingsManager
virtual void DeleteAutoSaveFile(const wxFileName &aFileName)
virtual void OnSize(wxSizeEvent &aEvent)
virtual wxString GetUndoActionDescription() const
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)
Check if aFileName can be written.
void OnMaximize(wxMaximizeEvent &aEvent)
virtual void ClearFileHistory()
Remove all files from the file history.
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 onSystemColorChange(wxSysColourChangedEvent &aEvent)
virtual int GetUndoCommandCount() const
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 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 the close window event handler after frames are asked if they can close.
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()
Specialization of the wxAuiPaneInfo class for KiCad panels.
This class implements a file history object to store a list of files, that can then be added to a men...
void AddFileToHistory(const wxString &aFile) override
Adds a file to the history.
The main KiCad project manager frame.
SEARCH_STACK & KifaceSearch()
Only for DSO specific 'non-library' files.
APP_SETTINGS_BASE * KifaceSettings() const
const wxString & GetHelpFileName() const
Return just the basename portion of the current help file.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
KIWAY_HOLDER(KIWAY *aKiway, HOLDER_TYPE aType)
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
virtual void CommonSettingsChanged(int aFlags=0)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
WX_TREEBOOK * GetTreebook()
void SetInitialPage(const wxString &aPage, const wxString &aParentPage=wxEmptyString)
std::vector< TOOL_ACTION * > & ActionsList()
static wxString GetDefaultUserProjectsPath()
Gets the default path we point users to create projects.
virtual COMMON_SETTINGS * GetCommonSettings() const
virtual int GetSelectedLanguageIdentifier() const
virtual SETTINGS_MANAGER & GetSettingsManager() const
A holder to handle information on schematic or board items.
void SaveFileState(const wxString &aFileName, const WINDOW_SETTINGS *aWindowCfg, bool aOpen)
const PROJECT_FILE_STATE * GetFileState(const wxString &aFileName)
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Look for files in a number of paths.
UNITS_PROVIDER(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits)
void SetUserUnits(EDA_UNITS aUnits)
Simple wrapper around wxBusyCursor for used with the generic BUSY_INDICATOR interface.
A modified version of the wxInfoBar class that allows us to:
void ShowMessageFor(const wxString &aMessage, int aTime, int aFlags=wxICON_INFORMATION, MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the infobar with the provided message and icon for a specific period of time.
MESSAGE_TYPE
Sets the type of message for special handling if needed.
bool AddLazyPage(std::function< wxWindow *(wxWindow *aParent)> aLazyCtor, const wxString &text, bool bSelect=false, int imageId=NO_IMAGE)
bool AddLazySubPage(std::function< wxWindow *(wxWindow *aParent)> aLazyCtor, const wxString &text, bool bSelect=false, int imageId=NO_IMAGE)
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
const int minSize
Push and Shove router track width and via size dialog.
static const wxSize minSizeLookup(FRAME_T aFrameType, wxWindow *aWindow)
static const wxSize defaultSize(FRAME_T aFrameType, wxWindow *aWindow)
wxWindow * findQuasiModalDialog(wxWindow *aParent)
Base window classes and related definitions.
#define KICAD_MANAGER_FRAME_NAME
#define DEFAULT_MAX_UNDO_ITEMS
std::function< void(wxUpdateUIEvent &) > UIUpdateHandler
This is the handler functor for the update UI events.
void SocketCleanup()
Must be called to clean up the socket thread used by SendCommand.
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
@ FRAME_SCH_SYMBOL_EDITOR
@ PANEL_SCH_FIELD_NAME_TEMPLATES
@ PANEL_GBR_DISPLAY_OPTIONS
@ PANEL_FP_DEFAULT_GRAPHICS_VALUES
@ PANEL_FP_DISPLAY_OPTIONS
@ PANEL_FP_DEFAULT_FIELDS
@ PANEL_PCB_ACTION_PLUGINS
@ PANEL_3DV_DISPLAY_OPTIONS
@ PANEL_DS_DISPLAY_OPTIONS
@ PANEL_GBR_EXCELLON_OPTIONS
static const std::string GerberFileExtension
static const std::string AutoSaveFilePrefix
static bool IsGerberFileExtension(const wxString &ext)
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
const wxChar *const kicadTraceKeyEvent
Flag to enable wxKeyEvent debug tracing.
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
void ReadHotKeyConfigIntoActions(const wxString &aFileName, std::vector< TOOL_ACTION * > &aActions)
Read a hotkey config file into a list of actions.
PGM_BASE & Pgm()
The global program "get" accessor.
LANGUAGE_DESCR LanguagesList[]
An array containing all the languages that KiCad supports.
std::vector< FAB_LAYER_COLOR > dummy
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
ACTION_CONDITIONS & Check(const SELECTION_CONDITION &aCondition)
Implement a participant in the KIWAY alchemy.
struct WINDOW_STATE window
Store the common settings that are saved and loaded for each window / frame.
Store the window positioning/state.
IFACE KIFACE_BASE kiface("pcb_test_frame", KIWAY::FACE_PCB)
wxString dump(const wxArrayString &aArray)
Debug helper for printing wxArrayString contents.
wxLogTrace helper definitions.