64#include <wx/display.h>
65#include <wx/stdpaths.h>
83 return wxSize( 406, 354 );
86 return wxSize( 500, 400 );
96 return wxSize( 850, 540 );
99 return wxSize( 1280, 720 );
124 m_ident = aFrameType;
125 m_maximizeByDefault =
false;
127 m_settingsManager =
nullptr;
128 m_fileHistory =
nullptr;
129 m_supportsAutoSave =
false;
130 m_autoSavePending =
false;
133 m_isNonUserClose =
false;
135 m_autoSaveRequired =
false;
142 m_settingsManager = &
Pgm().GetSettingsManager();
145 SetSizeHints(
minSize( aFrameType ).x,
minSize( aFrameType ).y, -1, -1, -1, -1 );
148 GetClientSize( &m_frameSize.x, &m_frameSize.y );
162 const wxPoint& aPos,
const wxSize& aSize,
long aStyle,
163 const wxString& aFrameName,
KIWAY* aKiway,
165 wxFrame( aParent, wxID_ANY, aTitle, aPos, aSize, aStyle, aFrameName ),
176 for( wxWindow* child : aParent->GetChildren() )
180 if( dlg->IsQuasiModal() )
201 wxWindow* cvpcb = wxWindow::FindWindowByName( wxS(
"CvpcbFrame" ) );
223 if( event.CanVeto() )
230 if( event.GetId() == wxEVT_QUERY_END_SESSION
231 || event.GetId() == wxEVT_END_SESSION )
258 if( event.CanVeto() )
284 if( !IsEnabled() && IsActive() )
292 if( !wxFrame::ProcessEvent( aEvent ) )
295 if(
Pgm().m_Quitting )
304 wxLogTrace(
traceAutoSave, wxT(
"Starting auto save timer." ) );
310 wxLogTrace(
traceAutoSave, wxT(
"Stopping auto save timer." ) );
322 return Pgm().GetCommonSettings()->m_System.autosave_interval;
342 wxCHECK_MSG(
false,
true, wxT(
"Auto save timer function not overridden. Bad programmer!" ) );
368 std::placeholders::_1,
374 Bind( wxEVT_UPDATE_UI, evtFunc, aID );
385 Unbind( wxEVT_UPDATE_UI, it->second, aID );
392 bool checkRes =
false;
393 bool enableRes =
true;
406 catch( std::exception& )
415 wxString msg =
_(
"Undo" );
420 aEvent.SetText( msg );
424 wxString msg =
_(
"Redo" );
429 aEvent.SetText( msg );
432 if( isCut || isCopy || isPaste )
434 wxWindow* focus = wxWindow::FindFocus();
435 wxTextEntry* textEntry =
dynamic_cast<wxTextEntry*
>( focus );
437 if( textEntry && isCut && textEntry->CanCut() )
439 else if( textEntry && isCopy && textEntry->CanCopy() )
441 else if( textEntry && isPaste && textEntry->CanPaste() )
443 else if(
dynamic_cast<WX_GRID*
>( focus ) )
447 aEvent.Enable( enableRes );
448 aEvent.Show( showRes );
450 if( aEvent.IsCheckable() )
451 aEvent.Check( checkRes );
459 [] (
const SELECTION& aSel,
int aLangIdentifier )
461 return Pgm().GetSelectedLanguageIdentifier() == aLangIdentifier;
467 cond.
Check( std::bind( isCurrentLang, std::placeholders::_1,
493 wxFrame::SetMenuBar( menu_bar );
497 int pos = GetMenuBar()->FindMenu(
_(
"&Help" ) + wxS(
" " ) );
499 if( pos != wxNOT_FOUND )
501 wxMenu* helpMenu = GetMenuBar()->Remove( pos );
502 GetMenuBar()->Append( helpMenu,
_(
"&Help" ) + wxS(
" " ) );
519 helpMenu->AppendSeparator();
523 aMenuBar->Append( helpMenu,
_(
"&Help" ) + wxS(
" " ) );
524 helpMenu->wxMenu::SetTitle(
_(
"&Help" ) + wxS(
" " ) );
535 GetMenuBar()->Refresh();
559 GetMenuBar()->Refresh();
569 wxAuiPaneInfoArray panes =
m_auimgr.GetAllPanes();
571 for(
size_t i = 0; i < panes.GetCount(); ++i )
574 toolbar->RefreshBitmaps();
582 int currentDisplay = wxDisplay::GetFromWindow(
this );
599 if( !
Pgm().GetCommonSettings()->m_Session.remember_open_files )
604 if( state !=
nullptr )
613 bool wasDefault =
false;
635 if( aState.
display >= wxDisplay::GetCount() )
641 const unsigned int index = 0;
642 wxDisplay display( index );
643 wxRect clientSize = display.GetGeometry();
659 wxDisplay display( aState.
display );
660 wxRect clientSize = display.GetClientArea();
662 int yLimTop = clientSize.y;
663 int yLimBottom = clientSize.y + clientSize.height;
664 int xLimLeft = clientSize.x;
665 int xLimRight = clientSize.x + clientSize.width;
667 if( upperLeft.x > xLimRight ||
668 upperRight.x < xLimLeft ||
669 upperLeft.y < yLimTop ||
670 upperLeft.y > yLimBottom )
707 wxDisplay display( wxDisplay::GetFromWindow(
this ) );
708 wxRect clientSize = display.GetClientArea();
709 wxPoint pos = GetPosition();
713 wxS(
"ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d" ),
714 clientSize.x, clientSize.y,
715 clientSize.width, clientSize.height );
717 if( pos.y < clientSize.y )
720 wxS(
"ensureWindowIsOnScreen: y pos %d below minimum, setting to %d" ), pos.y,
722 pos.y = clientSize.y;
725 if( pos.x < clientSize.x )
728 wxS(
"ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d" ),
729 pos.x, clientSize.x );
730 pos.x = clientSize.x;
733 if( pos.x + size.x - clientSize.x > clientSize.width )
735 int newWidth = clientSize.width - ( pos.x - clientSize.x );
737 wxS(
"ensureWindowIsOnScreen: effective width %d above available %d, setting "
738 "to %d" ), pos.x + size.x, clientSize.width, newWidth );
742 if( pos.y + size.y - clientSize.y > clientSize.height )
744 int newHeight = clientSize.height - ( pos.y - clientSize.y );
746 wxS(
"ensureWindowIsOnScreen: effective height %d above available %d, setting "
747 "to %d" ), pos.y + size.y, clientSize.height, newHeight );
751 wxLogTrace(
traceDisplayLocation, wxS(
"Updating window position (%d, %d) with size (%d, %d)" ),
752 pos.x, pos.y, size.x, size.y );
754 SetSize( pos.x, pos.y, size.x, size.y );
794 IsMaximized() ? wxS(
"true" ) : wxS(
"false" ) );
812 int fileHistorySize =
Pgm().GetCommonSettings()->m_System.file_history_size;
831 if(
Pgm().GetCommonSettings()->m_Session.remember_open_files && !currentlyOpenedFile.IsEmpty() )
833 wxFileName rfn( currentlyOpenedFile );
834 rfn.MakeRelativeTo(
Prj().GetProjectPath() );
842 if( !currentlyOpenedFile.IsEmpty() )
877 SetStatusText(
text );
883#if defined( __WXOSX_MAC__ )
895#if defined( __WXOSX_MAC__ )
903 m_auimgr.GetPane( wxS(
"InfoBar" ) ).Hide();
914 if( aShowCloseButton )
922 std::function<
void(
void)> aCallback )
926 if( aShowCloseButton )
940 if( aShowCloseButton )
951 if( aShowCloseButton )
963 wxASSERT( aFileHistory );
971 GetMenuBar()->Refresh();
982 wxASSERT( aFileHistory );
984 int baseId = aFileHistory->GetBaseId();
986 wxASSERT( cmdId >= baseId && cmdId < baseId + (
int) aFileHistory->GetCount() );
988 unsigned i = cmdId - baseId;
990 if( i < aFileHistory->GetCount() )
992 wxString fn = aFileHistory->GetHistoryFile( i );
994 if( wxFileName::FileExists( fn ) )
1001 aFileHistory->RemoveFileFromHistory( i );
1009 GetMenuBar()->Refresh();
1012 return wxEmptyString;
1021 wxASSERT( aFileHistory );
1029 GetMenuBar()->Refresh();
1049 wxBeginBusyCursor( wxHOURGLASS_CURSOR );
1051 PAGED_DIALOG dlg(
this,
_(
"Preferences" ),
true,
true, wxEmptyString, wxSize( 980, 560 ) );
1053 dlg.SetEvtHandlerEnabled(
false );
1058 std::vector<int> expand;
1063 []( wxWindow* aParent ) -> wxWindow*
1070 []( wxWindow* aParent ) -> wxWindow*
1073 },
_(
"Mouse and Touchpad" ) );
1075 book->AddPage( hotkeysPanel,
_(
"Hotkeys" ) );
1081 []( wxWindow* aParent ) -> wxWindow*
1084 },
_(
"Version Control" ) );
1086#ifdef KICAD_USE_SENTRY
1088 []( wxWindow* aParent ) -> wxWindow*
1091 },
_(
"Data Collection" ) );
1094#define LAZY_CTOR( key ) \
1095 [=]( wxWindow* aParent ) \
1097 return kiface->CreateKiWindow( aParent, key, &Kiway() ); \
1109 expand.push_back( (
int) book->GetPageCount() );
1111 book->AddPage(
new wxPanel( book ),
_(
"Symbol Editor" ) );
1118 expand.push_back( (
int) book->GetPageCount() );
1120 book->AddPage(
new wxPanel( book ),
_(
"Schematic Editor" ) );
1139 expand.push_back( (
int) book->GetPageCount() );
1141 book->AddPage(
new wxPanel( book ),
_(
"Footprint Editor" ) );
1150 expand.push_back( (
int) book->GetPageCount() );
1152 book->AddPage(
new wxPanel( book ),
_(
"PCB Editor" ) );
1161 expand.push_back( (
int) book->GetPageCount() );
1163 book->AddPage(
new wxPanel( book ),
_(
"3D Viewer" ) );
1179 expand.push_back( (
int) book->GetPageCount() );
1181 book->AddPage(
new wxPanel( book ),
_(
"Gerber Viewer" ) );
1196 expand.push_back( (
int) book->GetPageCount() );
1198 book->AddPage(
new wxPanel( book ),
_(
"Drawing Sheet Editor" ) );
1204 []( wxWindow* aParent ) -> wxWindow*
1207 },
_(
"Plugin and Content Manager" ) );
1217 for(
size_t i = 0; i < book->GetPageCount(); ++i )
1218 book->GetPage( i )->Layout();
1220 for(
int page : expand )
1221 book->ExpandNode( page );
1223 if( !aStartPage.IsEmpty() )
1226 dlg.SetEvtHandlerEnabled(
true );
1229 if( dlg.ShowModal() == wxID_OK )
1233 Pgm().GetSettingsManager().Save();
1243 wxString* files = aEvent.GetFiles();
1245 for(
int nb = 0; nb < aEvent.GetNumberOfFiles(); nb++ )
1247 const wxFileName fn = wxFileName( files[nb] );
1248 wxString ext = fn.GetExt();
1267 wxString fn = file.GetFullPath();
1276 wxFileName fn = aFileName;
1282 if( fn.GetPath().IsEmpty() && fn.HasName() )
1285 wxCHECK_MSG( fn.IsOk(),
false,
1286 wxT(
"File name object is invalid. Bad programmer!" ) );
1287 wxCHECK_MSG( !fn.GetPath().IsEmpty(),
false,
1288 wxT(
"File name object path <" ) + fn.GetFullPath() +
1289 wxT(
"> is not set. Bad programmer!" ) );
1291 if( fn.IsDir() && !fn.IsDirWritable() )
1293 msg.Printf(
_(
"Insufficient permissions to folder '%s'." ), fn.GetPath() );
1295 else if( !fn.FileExists() && !fn.IsDirWritable() )
1297 msg.Printf(
_(
"Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
1299 else if( fn.FileExists() && !fn.IsFileWritable() )
1301 msg.Printf(
_(
"Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
1304 if( !msg.IsEmpty() )
1318 if( !
Pgm().IsGUI() )
1321 wxCHECK_RET( aFileName.IsOk(), wxT(
"Invalid file name!" ) );
1323 wxFileName autoSaveFileName = aFileName;
1329 wxT(
"Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
1331 if( !autoSaveFileName.FileExists() )
1334 wxString msg = wxString::Format(
_(
"Well this is potentially embarrassing!\n"
1335 "It appears that the last time you were editing\n"
1337 "KiCad exited before saving.\n"
1339 "Do you wish to open the auto-saved file instead?" ),
1340 aFileName.GetFullName() );
1342 int response = wxMessageBox( msg,
Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
1347 if( response == wxYES )
1352 if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1354 wxMessageBox(
_(
"The auto save file could not be renamed to the board file name." ),
1355 Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION,
this );
1367 if( !
Pgm().IsGUI() )
1370 wxCHECK_RET( aFileName.IsOk(), wxT(
"Invalid file name!" ) );
1372 wxFileName autoSaveFn = aFileName;
1375 if( autoSaveFn.FileExists() )
1377 wxLogTrace(
traceAutoSave, wxT(
"Removing auto save file " ) + autoSaveFn.GetFullPath() );
1378 wxRemoveFile( autoSaveFn.GetFullPath() );
1392 wxAcceleratorEntry entries[1];
1393 entries[0].Set( wxACCEL_CTRL,
int(
'Q' ), wxID_EXIT );
1394 wxAcceleratorTable accel( 1, entries );
1395 SetAcceleratorTable( accel );
1415 if( extraitems > 0 )
1430 if( extraitems > 0 )
1453 return wxEmptyString;
1462 return wxEmptyString;
1477 wxCommandEvent e( EDA_EVT_UNITS_CHANGED );
1478 e.SetInt(
static_cast<int>( aUnits ) );
1479 e.SetClientData(
this );
1480 ProcessEventLocally( e );
1492 if( !IsMaximized() )
1498 "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
1511 wxSize winSize = GetSize();
1520 GTKDoGetSize( &width, &height );
1522 winSize.Set( width, height );
1525 wxSize winSize = GetSize();
1543 GetMenuBar()->Refresh();
1569WXLRESULT EDA_BASE_FRAME::MSWWindowProc( WXUINT message, WXWPARAM wParam, WXLPARAM lParam )
1573 if( message == WM_SYSCOMMAND )
1575 if( wParam == SC_KEYMENU && ( lParam >> 16 ) <= 0 )
1579 return wxFrame::MSWWindowProc( message, wParam, lParam );
1594 langsMenu->
SetTitle(
_(
"Set Language" ) );
1595 langsMenu->
SetIcon( BITMAPS::language );
1609 new wxMenuItem( langsMenu,
1611 label, tooltip, wxITEM_CHECK );
1613 langsMenu->Append( item );
1617 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
Cursor control event types.
static TOOL_ACTION donate
static TOOL_ACTION listHotKeys
static TOOL_ACTION getInvolved
static TOOL_ACTION gettingStarted
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
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...
virtual void OnCharHook(wxKeyEvent &aKeyEvent)
Capture the key event before it is sent to the GUI.
virtual int GetRedoCommandCount() const
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 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()
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...
void OnKicadAbout(wxCommandEvent &event)
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)
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.
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
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)
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.
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.
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.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
FILE_HISTORY * m_fileHistory
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)
Checks if aFileName can be written.
void OnMaximize(wxMaximizeEvent &aEvent)
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 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.
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.
void AddStandardHelpMenu(wxMenuBar *aMenuBar)
Adds the standard KiCad help menu to the menubar.
void ReCreateMenuBar()
Recreates 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.
void ClearFileHistory()
Clear all entries from the file history.
void Save(APP_SETTINGS_BASE &aSettings)
Saves history into a JSON settings object.
void SetMaxFiles(size_t aMaxFiles)
Update the number of files that will be contained inside the file history.
void Load(const APP_SETTINGS_BASE &aSettings)
Loads history from a JSON settings object.
SEARCH_STACK & KifaceSearch()
Only for DSO specific 'non-library' files.
APP_SETTINGS_BASE * KifaceSettings() const
void GetActions(std::vector< TOOL_ACTION * > &aActions) const override
Append this Kiface's registered actions to the given list.
const wxString & GetHelpFileName() const
Return just the basename portion of the current help file.
A mix in class which holds the location of a wxWindow's KIWAY.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
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(bool aEnvVarsChanged, bool aTextVarsChanged)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
virtual KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Return the KIFACE* given a FACE_T.
virtual void GetActions(std::vector< TOOL_ACTION * > &aActions) const
Append all registered actions to the given list.
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.
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.
void PushCommand(PICKED_ITEMS_LIST *aCommand)
PICKED_ITEMS_LIST * PopCommand()
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
void SetUserUnits(EDA_UNITS aUnits)
A modified version of the wxInfoBar class that allows us to:
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
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.
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
void SetCallback(std::function< void(void)> aCallback)
Provide a callback to be called when the infobar is dismissed (either by user action or timer).
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 defaultSize(FRAME_T aFrameType)
wxDEFINE_EVENT(EDA_EVT_UNITS_CHANGED, wxCommandEvent)
wxWindow * findQuasiModalDialog(wxWindow *aParent)
#define DEFAULT_MAX_UNDO_ITEMS
std::function< void(wxUpdateUIEvent &) > UIUpdateHandler
This is the handler functor for the update UI events.
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_DISPLAY_OPTIONS
@ PANEL_PCB_ACTION_PLUGINS
@ PANEL_FP_DEFAULT_VALUES
@ PANEL_3DV_DISPLAY_OPTIONS
@ PANEL_DS_DISPLAY_OPTIONS
@ PANEL_GBR_EXCELLON_OPTIONS
bool m_EnableGit
When true, enable git integration.
bool IsGerberFileExtension(const wxString &ext)
const std::string GerberFileExtension
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)
Reads a hotkey config file into a list of actions.
LANGUAGE_DESCR LanguagesList[]
An array containing all the languages that KiCad supports.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
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.
int m_KI_Lang_Identifier
KiCad identifier used in menu selection (See id.h)
wxString m_Lang_Label
Labels used in menus.
struct WINDOW_STATE window
Stores the common settings that are saved and loaded for each window / frame.
Stores 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.