KiCad PCB EDA Suite
KICAD_MANAGER_FRAME Class Reference

The main KiCad project manager frame. More...

#include <kicad_manager_frame.h>

Inheritance diagram for KICAD_MANAGER_FRAME:
EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER

Public Types

enum  UNDO_REDO_LIST { UNDO_LIST, REDO_LIST }
 Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. More...
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 KICAD_MANAGER_FRAME (wxWindow *parent, const wxString &title, const wxPoint &pos, const wxSize &size)
 
 ~KICAD_MANAGER_FRAME ()
 
void OnIdle (wxIdleEvent &event)
 
bool canCloseWindow (wxCloseEvent &aCloseEvent) override
 
void doCloseWindow () override
 
void OnSize (wxSizeEvent &event)
 
void OnArchiveFiles (wxCommandEvent &event)
 
void OnUnarchiveFiles (wxCommandEvent &event)
 
void OnOpenFileInTextEditor (wxCommandEvent &event)
 
void OnBrowseInFileExplorer (wxCommandEvent &event)
 
void OnFileHistory (wxCommandEvent &event)
 
void OnClearFileHistory (wxCommandEvent &aEvent)
 
void OnExit (wxCommandEvent &event)
 
void ReCreateMenuBar () override
 Recreates the menu bar. More...
 
void RecreateBaseHToolbar ()
 (Re)Create the horizontal toolbar More...
 
wxString GetCurrentFileName () const override
 Get the full filename + path of the currently opened file in the frame. More...
 
void ImportNonKiCadProject (wxString aWindowTitle, wxString aFilesWildcard, wxString aSchFileExtension, wxString aPcbFileExtension, int aSchFileType, int aPcbFileType)
 Creates a project and imports a non-KiCad Schematic and PCB. More...
 
void OnImportCadstarArchiveFiles (wxCommandEvent &event)
 Open dialog to import CADSTAR Schematic and PCB Archive files. More...
 
void OnImportEagleFiles (wxCommandEvent &event)
 Open dialog to import Eagle schematic and board files. More...
 
void PrintPrjInfo ()
 Prints the current working directory name and the project name on the text panel. More...
 
void RefreshProjectTree ()
 
void CreateNewProject (const wxFileName &aProjectFileName, bool aCreateStubFiles=true)
 Creates a new project by setting up and initial project, schematic, and board files. More...
 
bool CloseProject (bool aSave)
 Closes the project, and saves it if aSave is true;. More...
 
void LoadProject (const wxFileName &aProjectFileName)
 
void LoadSettings (APP_SETTINGS_BASE *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (APP_SETTINGS_BASE *aCfg) override
 Save common frame parameters to a configuration data file. More...
 
void ShowChangedLanguage () override
 Redraw the menus and what not in current language. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
 Notification event that some of the common (suite-wide) settings have changed. More...
 
void ProjectChanged () override
 Notification event that the project has changed. More...
 
void OnChangeWatchedPaths (wxCommandEvent &aEvent)
 Called by sending a event with id = ID_INIT_WATCHED_PATHS rebuild the list of watched paths. More...
 
void InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
 Allow a frame to load its preference panels (if any) into the preferences dialog. More...
 
const wxString GetProjectFileName () const
 
bool IsProjectActive ()
 
const wxString SchFileName ()
 
const wxString SchLegacyFileName ()
 
const wxString PcbFileName ()
 
const wxString PcbLegacyFileName ()
 
void ReCreateTreePrj ()
 
wxWindow * GetToolCanvas () const override
 Canvas access. More...
 
EDA_UNITS GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS aUnits)
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
virtual void ToggleUserUnits ()
 
SETTINGS_MANAGERGetSettingsManager () const
 
virtual SEVERITY GetSeverity (int aErrorCode) const
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
virtual void OnCharHook (wxKeyEvent &event)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
virtual void RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
 Register a UI update handler for the control with ID aID. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
 Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...
 
virtual void UnregisterUIUpdateHandler (int aID) override
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
 
virtual void OnMove (wxMoveEvent &aEvent)
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 
void PrintMsg (const wxString &text)
 
void CreateInfoBar ()
 
void FinishAUIInitialization ()
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...
 
void ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...
 
void LoadWindowState (const wxString &aFileName)
 
virtual void LoadWindowState (const WINDOW_STATE &aState)
 Load frame state info from a configuration file. More...
 
void LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
 Load window settings from the given settings object. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Save window settings to the given settings object. More...
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Return a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 Get the configuration base name. More...
 
virtual void SaveProjectSettings ()
 Save changes to the project settings to the project (.pro) file. More...
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
 Fetches the file name from the file history list. More...
 
void ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
 Removes all files from the file history. More...
 
void UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
 Update the list of recently opened files. More...
 
FILE_HISTORYGetFileHistory ()
 Get the frame's main file history. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void UpdateStatusBar ()
 Update the status bar information. More...
 
virtual void ThemeChanged ()
 Process light/dark theme change. More...
 
const wxString & GetAboutTitle () const
 
virtual bool IsContentModified ()
 Get if the contents of the frame have been modified since the last save. More...
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
virtual void ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)
 
virtual void ClearUndoRedoList ()
 Clear the undo and redo list using ClearUndoORRedoList() More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Add a command to undo in the undo list. More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Add a command to redo in the redo list. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual int GetUndoCommandCount () const
 
virtual int GetRedoCommandCount () const
 
int GetMaxUndoItems () const
 
bool NonUserClose (bool aForce)
 
virtual void HandleSystemColorChange ()
 Update the UI in response to a change in the system colors. More...
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual SELECTIONGetCurrentSelection ()
 Get the current selection from the canvas area. More...
 
virtual void PushTool (const std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
virtual void DisplayToolMsg (const wxString &msg)
 
bool GetDoImmediateActions () const
 Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...
 
MOUSE_DRAG_ACTION GetDragAction () const
 Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...
 
bool GetMoveWarpsCursor () const
 Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...
 
virtual void RefreshCanvas ()
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

static void HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
 Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g. More...
 

Protected Member Functions

virtual void setupUIConditions () override
 Setup the UI conditions for the various actions and their controls in this frame. More...
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event. More...
 
virtual bool isAutoSaveRequired () const
 Return the auto save status of the application. More...
 
virtual bool doAutoSave ()
 This should be overridden by the derived class to handle the auto save feature. More...
 
void onSystemColorChange (wxSysColourChangedEvent &aEvent)
 
virtual void unitsChangeRefresh ()
 Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...
 
void initExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 

Static Protected Member Functions

static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

FRAME_T m_ident
 
wxPoint m_framePos
 
wxSize m_frameSize
 
bool m_maximizeByDefault
 
wxPoint m_normalFramePos
 
wxSize m_normalFrameSize
 
wxString m_aboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
int m_undoRedoCountMax
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 Map containing the UI update handlers registered with wx for each action. More...
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 Set by the close window event handler after frames are asked if they can close. More...
 
bool m_isClosing
 Set by NonUserClose() to indicate that the user did not request the current close. More...
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
MOUSE_DRAG_ACTION m_dragAction
 
bool m_moveWarpsCursor
 

Static Protected Attributes

static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 < Default style flags used for wxAUI toolbars. More...
 

Private Member Functions

void setupTools ()
 
void setupActions ()
 
APP_SETTINGS_BASEconfig () const override
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
KICAD_SETTINGSkicadSettings () const
 
const SEARCH_STACKsys_search () override
 Return a SEARCH_STACK pertaining to entire program. More...
 
wxString help_name () override
 
void language_change (wxCommandEvent &event)
 

Private Attributes

bool m_openSavedWindows
 
PROJECT_TREE_PANEm_leftWin
 
PANEL_KICAD_LAUNCHERm_launcher
 
ACTION_TOOLBARm_mainToolBar
 
int m_leftWinWidth
 
bool m_active_project
 

Detailed Description

The main KiCad project manager frame.

It is not a KIWAY_PLAYER.

Definition at line 42 of file kicad_manager_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

◆ UNDO_REDO_LIST

Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.

Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN. Commands are deleted from the older to the last.

Parameters
aList= the UNDO_REDO_CONTAINER of commands.
aItemCountnumber of old commands to delete. -1 to remove all old commands this will empty the list of commands.
Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 524 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ KICAD_MANAGER_FRAME()

KICAD_MANAGER_FRAME::KICAD_MANAGER_FRAME ( wxWindow *  parent,
const wxString &  title,
const wxPoint &  pos,
const wxSize &  size 
)

◆ ~KICAD_MANAGER_FRAME()

KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME ( )

Definition at line 183 of file kicad_manager_frame.cpp.

184 {
185  // Shutdown all running tools
186  if( m_toolManager )
188 
189  delete m_actions;
190  delete m_toolManager;
191  delete m_toolDispatcher;
192 
193  m_auimgr.UnInit();
194 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
wxAuiManager m_auimgr
ACTIONS * m_actions
Definition: tools_holder.h:158
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:159
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157

References TOOLS_HOLDER::m_actions, EDA_BASE_FRAME::m_auimgr, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, and TOOL_MANAGER::ShutdownAllTools().

Member Function Documentation

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 417 of file eda_base_frame.cpp.

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

References _, about, ACTIONS::donate, ACTIONS::getInvolved, ACTIONS::gettingStarted, TOOL_MANAGER::GetTool(), ACTIONS::help, ACTIONS::listHotKeys, TOOLS_HOLDER::m_toolManager, and ACTIONS::reportBug.

Referenced by EDA_3D_VIEWER::CreateMenuBar(), ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

◆ canCloseWindow()

bool KICAD_MANAGER_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 333 of file kicad_manager_frame.cpp.

334 {
335  KICAD_SETTINGS* settings = kicadSettings();
337 
338  // CloseProject will recursively ask all the open editors if they need to save changes.
339  // If any of them cancel then we need to cancel closing the KICAD_MANAGER_FRAME.
340  if( CloseProject( true ) )
341  {
342  return true;
343  }
344  else
345  {
346  if( aEvent.CanVeto() )
347  aEvent.Veto();
348 
349  return false;
350  }
351 }
SETTINGS_MANAGER * GetSettingsManager() const
KICAD_SETTINGS * kicadSettings() const
std::vector< wxString > m_OpenProjects
bool CloseProject(bool aSave)
Closes the project, and saves it if aSave is true;.
std::vector< wxString > GetOpenProjects() const

References CloseProject(), SETTINGS_MANAGER::GetOpenProjects(), EDA_BASE_FRAME::GetSettingsManager(), kicadSettings(), and KICAD_SETTINGS::m_OpenProjects.

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 1084 of file eda_base_frame.cpp.

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

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

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

◆ CheckForAutoSaveFile()

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

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

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

Parameters
aFileNameA wxFileName object containing the file name to check.

Definition at line 972 of file eda_base_frame.cpp.

973 {
974  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
975 
976  wxFileName autoSaveFileName = aFileName;
977 
978  // Check for auto save file.
979  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
980 
981  wxLogTrace( traceAutoSave,
982  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
983 
984  if( !autoSaveFileName.FileExists() )
985  return;
986 
987  wxString msg = wxString::Format( _(
988  "Well this is potentially embarrassing!\n"
989  "It appears that the last time you were editing the file\n"
990  "\"%s\"\n"
991  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
992  aFileName.GetFullName()
993  );
994 
995  int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
996  this );
997 
998  // Make a backup of the current file, delete the file, and rename the auto save file to
999  // the file name.
1000  if( response == wxYES )
1001  {
1002  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1003  {
1004  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1005  Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1006  }
1007  }
1008  else
1009  {
1010  wxLogTrace( traceAutoSave,
1011  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1012 
1013  // Remove the auto save file when using the previous file as is.
1014  wxRemoveFile( autoSaveFileName.GetFullPath() );
1015  }
1016 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static wxString GetAutoSaveFilePrefix()
#define _(s)
Definition: 3d_actions.cpp:33

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

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

◆ ClearFileHistory()

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

Removes all files from the file history.

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

Definition at line 869 of file eda_base_frame.cpp.

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

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

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

◆ ClearUndoORRedoList()

virtual void EDA_BASE_FRAME::ClearUndoORRedoList ( UNDO_REDO_LIST  aList,
int  aItemCount = -1 
)
inlinevirtualinherited

◆ ClearUndoRedoList()

◆ CloseProject()

bool KICAD_MANAGER_FRAME::CloseProject ( bool  aSave)

Closes the project, and saves it if aSave is true;.

Definition at line 388 of file kicad_manager_frame.cpp.

389 {
390  if( !Kiway().PlayersClose( false ) )
391  return false;
392 
393  // Save the project file for the currently loaded project.
394  if( m_active_project )
395  {
396  SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
397 
399 
400  if( aSave )
401  {
402  mgr.SaveProject();
403  }
404 
405  m_active_project = false;
406  mgr.UnloadProject( &Prj() );
407  }
408 
409  SetStatusText( "" );
410 
412 
413  return true;
414 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
PROJECT_TREE_PANE * m_leftWin
bool TriggerBackupIfNeeded(REPORTER &aReporter) const
Calls BackupProject if a new backup is needed according to the current backup policy.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool UnloadProject(PROJECT *aProject, bool aSave=true)
Saves, unloads and unregisters the given PROJECT.
void EmptyTreePrj()
Delete all m_TreeProject entries.
bool SaveProject(const wxString &aFullPath=wxEmptyString)
Saves a loaded project.
static REPORTER & GetInstance()
Definition: reporter.cpp:105

References PROJECT_TREE_PANE::EmptyTreePrj(), NULL_REPORTER::GetInstance(), KIWAY_HOLDER::Kiway(), m_active_project, m_leftWin, Pgm(), KIWAY_HOLDER::Prj(), SETTINGS_MANAGER::SaveProject(), SETTINGS_MANAGER::TriggerBackupIfNeeded(), and SETTINGS_MANAGER::UnloadProject().

Referenced by canCloseWindow(), KICAD_MANAGER_CONTROL::CloseProject(), ImportNonKiCadProject(), and LoadProject().

◆ CommonSettingsChanged()

void KICAD_MANAGER_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged,
bool  aTextVarsChanged 
)
overridevirtual

Notification event that some of the common (suite-wide) settings have changed.

Update menus, toolbars, local variables, etc.

Reimplemented from EDA_BASE_FRAME.

Definition at line 597 of file kicad_manager_frame.cpp.

598 {
599  EDA_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
600 }
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.

References EDA_BASE_FRAME::CommonSettingsChanged().

◆ config()

APP_SETTINGS_BASE * KICAD_MANAGER_FRAME::config ( ) const
overrideprivatevirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 248 of file kicad_manager_frame.cpp.

249 {
251  wxASSERT( ret );
252  return ret;
253 }
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:99
PGM_KICAD & PgmTop()
Definition: kicad.cpp:85
APP_SETTINGS_BASE * PgmSettings()
Definition: pgm_kicad.h:55

References PGM_KICAD::PgmSettings(), and PgmTop().

Referenced by kicadSettings(), and setupTools().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited

Get the configuration base name.

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

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

Reimplemented from TOOLS_HOLDER.

Definition at line 338 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

Definition at line 735 of file eda_base_frame.cpp.

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

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

◆ CreateNewProject()

void KICAD_MANAGER_FRAME::CreateNewProject ( const wxFileName &  aProjectFileName,
bool  aCreateStubFiles = true 
)

Creates a new project by setting up and initial project, schematic, and board files.

The project file is copied from the kicad.pro template file if possible. Otherwise, a minimal project file is created from an empty project. A minimal schematic and board file are created to prevent the schematic and board editors from complaining. If any of these files already exist, they are not overwritten.

Parameters
aProjectFileNameis the absolute path of the project file name.
aCreateStubFilesspecifies if an empty PCB and schematic should be created

Definition at line 456 of file kicad_manager_frame.cpp.

457 {
458  wxCHECK_RET( aProjectFileName.DirExists() && aProjectFileName.IsDirWritable(),
459  "Project folder must exist and be writable to create a new project." );
460 
461  // If the project is legacy, convert it
462  if( !aProjectFileName.FileExists() )
463  {
464  wxFileName legacyPro( aProjectFileName );
465  legacyPro.SetExt( LegacyProjectFileExtension );
466 
467  if( legacyPro.FileExists() )
468  {
469  GetSettingsManager()->LoadProject( legacyPro.GetFullPath() );
471 
472  wxRemoveFile( legacyPro.GetFullPath() );
473  }
474  else
475  {
476  // Copy template project file from template folder.
477  wxString srcFileName = sys_search().FindValidPath( "kicad.kicad_pro" );
478 
479  wxFileName destFileName( aProjectFileName );
480  destFileName.SetExt( ProjectFileExtension );
481 
482  // Create a minimal project file if the template project file could not be copied
483  if( !wxFileName::FileExists( srcFileName )
484  || !wxCopyFile( srcFileName, destFileName.GetFullPath() ) )
485  {
486  wxFFile file( destFileName.GetFullPath(), "wb" );
487 
488  if( file.IsOpened() )
489  file.Write( wxT( "{\n}\n") );
490  // wxFFile dtor will close the file
491  }
492  }
493  }
494 
495  // Create a "stub" for a schematic root sheet and a board if requested.
496  // It will avoid messages from the schematic editor or the board editor to create a new file
497  // And forces the user to create main files under the right name for the project manager
498  if( aCreateStubFiles )
499  {
500  wxFileName fn( aProjectFileName.GetFullPath() );
501  fn.SetExt( KiCadSchematicFileExtension );
502 
503  // If a <project>.kicad_sch file does not exist, create a "stub" file ( minimal schematic file )
504  if( !fn.FileExists() )
505  {
506  wxFFile file( fn.GetFullPath(), "wb" );
507 
508  if( file.IsOpened() )
509  file.Write( wxString::Format( "(kicad_sch (version %d) (generator eeschema)\n"
510  " (paper \"A4\")\n (lib_symbols)\n"
511  " (symbol_instances)\n)\n",
513 
514 
515  // wxFFile dtor will close the file
516  }
517 
518  // If a <project>.kicad_pcb or <project>.brd file does not exist,
519  // create a .kicad_pcb "stub" file
520  fn.SetExt( KiCadPcbFileExtension );
521  wxFileName leg_fn( fn );
522  leg_fn.SetExt( LegacyPcbFileExtension );
523 
524  if( !fn.FileExists() && !leg_fn.FileExists() )
525  {
526  wxFFile file( fn.GetFullPath(), "wb" );
527 
528  if( file.IsOpened() )
529  // Create a small dummy file as a stub for pcbnew:
530  file.Write( wxString::Format( "(kicad_pcb (version %d) (generator pcbnew)\n)",
532 
533  // wxFFile dtor will close the file
534  }
535  }
536 
537  UpdateFileHistory( aProjectFileName.GetFullPath() );
538 
539  m_openSavedWindows = true;
540 }
wxString FindValidPath(const wxString &aFileName) const
Definition: search_stack.h:70
SETTINGS_MANAGER * GetSettingsManager() const
const std::string ProjectFileExtension
const std::string LegacyPcbFileExtension
const std::string KiCadPcbFileExtension
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
const std::string LegacyProjectFileExtension
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Loads a project or sets up a new project with a specified path.
#define SEXPR_BOARD_FILE_VERSION
Current s-expression file format version. 2 was the last legacy format version.
bool SaveProject(const wxString &aFullPath=wxEmptyString)
Saves a loaded project.
const std::string KiCadSchematicFileExtension
#define SEXPR_SCHEMATIC_FILE_VERSION
Symbol library file version.
const SEARCH_STACK & sys_search() override
Return a SEARCH_STACK pertaining to entire program.

References SEARCH_STACK::FindValidPath(), Format(), EDA_BASE_FRAME::GetSettingsManager(), KiCadPcbFileExtension, KiCadSchematicFileExtension, LegacyPcbFileExtension, LegacyProjectFileExtension, SETTINGS_MANAGER::LoadProject(), m_openSavedWindows, ProjectFileExtension, SETTINGS_MANAGER::SaveProject(), SEXPR_BOARD_FILE_VERSION, SEXPR_SCHEMATIC_FILE_VERSION, sys_search(), and EDA_BASE_FRAME::UpdateFileHistory().

Referenced by ImportNonKiCadProject(), KICAD_MANAGER_CONTROL::NewFromTemplate(), KICAD_MANAGER_CONTROL::NewProject(), and KICAD_MANAGER_CONTROL::SaveProjectAs().

◆ CurrentToolName()

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

Definition at line 99 of file tools_holder.cpp.

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

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

Referenced by TOOL_MANAGER::processEvent().

◆ DisplayToolMsg()

virtual void TOOLS_HOLDER::DisplayToolMsg ( const wxString &  msg)
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 122 of file tools_holder.h.

122 {};

Referenced by TOOLS_HOLDER::PopTool(), and TOOLS_HOLDER::PushTool().

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

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

Returns
true if the auto save was successful otherwise false.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 301 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void KICAD_MANAGER_FRAME::doCloseWindow ( )
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 354 of file kicad_manager_frame.cpp.

355 {
356 #ifdef _WINDOWS_
357  // For some obscure reason, on Windows, when killing Kicad from the Windows task manager
358  // if a editor frame (schematic, library, board editor or fp editor) is open and has
359  // some edition to save, OnCloseWindow is run twice *at the same time*, creating race
360  // conditions between OnCloseWindow() code.
361  // Therefore I added (JPC) a ugly hack to discard the second call (unwanted) during
362  // execution of the first call (only one call is right).
363  // Note also if there is no change made in editors, this behavior does not happen.
364  static std::atomic<unsigned int> lock_close_event( 0 );
365 
366  if( ++lock_close_event > 1 ) // Skip extra calls
367  {
368  return;
369  }
370 #endif
371 
372  m_leftWin->Show( false );
373 
374  Destroy();
375 
376 #ifdef _WINDOWS_
377  lock_close_event = 0; // Reenable event management
378 #endif
379 }
PROJECT_TREE_PANE * m_leftWin

References m_leftWin.

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 747 of file eda_base_frame.cpp.

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

References EDA_BASE_FRAME::m_auimgr.

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetAutoSaveFilePrefix()

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

Definition at line 582 of file eda_base_frame.h.

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

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 190 of file eda_base_frame.h.

190 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetCurrentFileName()

wxString KICAD_MANAGER_FRAME::GetCurrentFileName ( ) const
inlineoverridevirtual

Get the full filename + path of the currently opened file in the frame.

If no file is open, an empty string is returned.

Returns
the filename and full path to the open file

Reimplemented from EDA_BASE_FRAME.

Definition at line 69 of file kicad_manager_frame.h.

70  {
71  return GetProjectFileName();
72  }
const wxString GetProjectFileName() const

References GetProjectFileName().

◆ GetCurrentSelection()

virtual SELECTION& TOOLS_HOLDER::GetCurrentSelection ( )
inlinevirtualinherited

Get the current selection from the canvas area.

Returns
the current selection.

Reimplemented in PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_VIEWER_FRAME, PL_EDITOR_FRAME, DISPLAY_FOOTPRINTS_FRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 102 of file tools_holder.h.

103  {
104  return m_dummySelection;
105  }
SELECTION m_dummySelection
Definition: tools_holder.h:161

References TOOLS_HOLDER::m_dummySelection.

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent(), and ACTION_MANAGER::RunHotKey().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

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

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

Definition at line 128 of file tools_holder.h.

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

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const
inlineinherited

Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.

Definition at line 134 of file tools_holder.h.

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

References TOOLS_HOLDER::m_dragAction.

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

◆ GetFileFromHistory()

wxString EDA_BASE_FRAME::GetFileFromHistory ( int  cmdId,
const wxString &  type,
FILE_HISTORY aFileHistory = nullptr 
)
inherited

Fetches the file name from the file history list.

This removes the selected file, if this file does not exist. The menu is also updated, if #FILE_HISTORY::UseMenu was called at initialization time.

Parameters
cmdIdThe command ID associated with the aFileHistory object.
typePlease document me!
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used
Returns
a wxString containing the selected filename

Definition at line 829 of file eda_base_frame.cpp.

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

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

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

◆ GetFileHistory()

FILE_HISTORY& EDA_BASE_FRAME::GetFileHistory ( )
inlineinherited

Get the frame's main file history.

Returns
the main file history

Definition at line 403 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetInfoBar()

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 562 of file eda_base_frame.h.

562 { return m_undoRedoCountMax; }

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const
inlineinherited

Indicate that a move operation should warp the mouse pointer to the origin of the move object.

This improves snapping, but some users are allergic to mouse warping.

Definition at line 140 of file tools_holder.h.

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

References TOOLS_HOLDER::m_moveWarpsCursor.

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

◆ GetMruPath()

◆ GetProjectFileName()

const wxString KICAD_MANAGER_FRAME::GetProjectFileName ( ) const

Definition at line 264 of file kicad_manager_frame.cpp.

265 {
266  return Pgm().GetSettingsManager().IsProjectOpen() ? Prj().GetProjectFullName() : wxString( wxEmptyString );
267 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.
Definition: project.cpp:117

References PROJECT::GetProjectFullName(), Pgm(), and KIWAY_HOLDER::Prj().

Referenced by PROJECT_TREE_PANE::addItemToProjectTree(), PROJECT_TREE_PANE::FileWatcherReset(), PROJECT_TREE_PANE::findSubdirTreeItem(), GetCurrentFileName(), OnArchiveFiles(), PROJECT_TREE_PANE::onCreateNewDirectory(), PROJECT_TREE_PANE::onOpenDirectory(), PcbFileName(), PcbLegacyFileName(), ProjectChanged(), PROJECT_TREE_PANE::ReCreateTreePrj(), SchFileName(), and SchLegacyFileName().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetSettingsManager()

◆ GetSeverity()

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

Reimplemented in PCB_BASE_FRAME.

Definition at line 130 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetToolCanvas()

wxWindow * KICAD_MANAGER_FRAME::GetToolCanvas ( ) const
overridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 242 of file kicad_manager_frame.cpp.

243 {
244  return m_leftWin;
245 }
PROJECT_TREE_PANE * m_leftWin

References m_leftWin.

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

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

References TOOLS_HOLDER::m_toolManager.

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const
inlinevirtualinherited

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 114 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_userUnits.

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

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
virtualinherited

Return a pointer to the window settings for this frame.

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

Parameters
aCfgis this frame's config object

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

Definition at line 704 of file eda_base_frame.cpp.

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

References APP_SETTINGS_BASE::m_Window.

Referenced by EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), EDA_BASE_FRAME::SaveSettings(), and EDA_DRAW_FRAME::SaveSettings().

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )
inherited

Get the undecorated window size that can be used for restoring the window size.

This is needed for GTK, since the normal wxWidgets GetSize() call will return a window size that includes the window decorations added by the window manager.

Returns
the undecorated window size

Definition at line 1116 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::OnMaximize(), and EDA_BASE_FRAME::SaveWindowSettings().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )
virtualinherited

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

Definition at line 1135 of file eda_base_frame.cpp.

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

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

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

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

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

enabled, checked, etc.).

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

Definition at line 349 of file eda_base_frame.cpp.

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

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

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ help_name()

wxString KICAD_MANAGER_FRAME::help_name ( )
overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 318 of file kicad_manager_frame.cpp.

319 {
320  return PgmTop().GetHelpFileName();
321 }
PGM_KICAD & PgmTop()
Definition: kicad.cpp:85
wxString GetHelpFileName()
Definition: pgm_kicad.h:59

References PGM_KICAD::GetHelpFileName(), and PgmTop().

◆ ImportHotkeyConfigFromFile()

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

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

Parameters
aActionMapcurrent hotkey map (over which the imported hotkeys will be applied).
aDefaultShortnamea default short name (extension not needed) like Eeschema, KiCad...

◆ ImportNonKiCadProject()

void KICAD_MANAGER_FRAME::ImportNonKiCadProject ( wxString  aWindowTitle,
wxString  aFilesWildcard,
wxString  aSchFileExtension,
wxString  aPcbFileExtension,
int  aSchFileType,
int  aPcbFileType 
)

Creates a project and imports a non-KiCad Schematic and PCB.

Parameters
aWindowTitleto display to the user when opening the files
aFilesWildcardthat includes both PCB and Schematic files (from wildcards_and_files_ext.h)
aSchFileExtensione.g. "sch" or "csa"
aPcbFileExtensione.g. "brd" or "cpa"
aSchFileTypeType of Schematic File to import (from SCH_IO_MGR::SCH_FILE_T)
aPcbFileTypeType of PCB File to import (from IO_MGR::PCB_FILE_T)

<

Todo:
Should we remove the newly created folder?

<

Todo:
Should we remove copied schematic file and the newly created folder?

Definition at line 52 of file import_project.cpp.

54 {
55  wxString msg;
56  wxString default_dir = GetMruPath();
57  int style = wxFD_OPEN | wxFD_FILE_MUST_EXIST;
58 
59  wxFileDialog schdlg( this, aWindowTitle, default_dir, wxEmptyString, aFilesWildcard, style );
60 
61  if( schdlg.ShowModal() == wxID_CANCEL )
62  return;
63 
64  wxFileName sch( schdlg.GetPath() );
65  sch.SetExt( aSchFileExtension );
66 
67  wxFileName pcb( sch );
68  pcb.SetExt( aPcbFileExtension );
69 
70  wxFileName pro( sch );
71  pro.SetExt( ProjectFileExtension );
72 
73  wxString protitle = _( "KiCad Project Destination" );
74 
75  // Don't use wxFileDialog here. On GTK builds, the default path is returned unless a
76  // file is actually selected.
77  wxDirDialog prodlg( this, protitle, pro.GetPath(), wxDD_DEFAULT_STYLE );
78 
79  if( prodlg.ShowModal() == wxID_CANCEL )
80  return;
81 
82  pro.SetPath( prodlg.GetPath() );
83 
84  // Check if the project directory is empty
85  wxDir directory( pro.GetPath() );
86 
87  if( directory.HasFiles() )
88  {
89  msg = _( "The selected directory is not empty. We recommend you "
90  "create projects in their own clean directory.\n\nDo you "
91  "want to create a new empty directory for the project?" );
92 
93  KIDIALOG dlg( this, msg, _( "Confirmation" ), wxYES_NO | wxICON_WARNING );
94  dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
95 
96  if( dlg.ShowModal() == wxID_YES )
97  {
98  // Append a new directory with the same name of the project file
99  // Keep iterating until we find an empty directory
100  wxString newDir = pro.GetName();
101  int attempt = 0;
102 
103  pro.AppendDir( newDir );
104 
105  while( pro.DirExists() )
106  {
107  pro.RemoveLastDir();
108  wxString suffix = wxString::Format( "_%d", ++attempt );
109  pro.AppendDir( newDir + suffix );
110  }
111 
112  if( !wxMkdir( pro.GetPath() ) )
113  {
114  msg = _( "Error creating new directory. Please try a different path. The "
115  "project cannot be imported." );
116 
117  wxMessageDialog dirErrorDlg( this, msg, _( "Error" ), wxOK_DEFAULT | wxICON_ERROR );
118  dirErrorDlg.ShowModal();
119  return;
120  }
121  }
122  }
123 
124  std::string packet;
125 
126  pro.SetExt( ProjectFileExtension );
127 
128  if( !pro.IsAbsolute() )
129  pro.MakeAbsolute();
130 
131  wxFileName schCopy( pro );
132  schCopy.SetExt( aSchFileExtension );
133 
134  if( sch.Exists() && !schCopy.SameAs( sch ) )
135  {
136  if( !wxCopyFile( sch.GetFullPath(), schCopy.GetFullPath(), true ) )
137  {
139  msg.Printf( _( "Cannot copy file '%s'\n"
140  "to '%s'\n"
141  "The project cannot be imported." ),
142  sch.GetFullPath(), schCopy.GetFullPath() );
143 
144  wxMessageDialog schCopyErrorDlg( this, msg, _( "Error" ), wxOK_DEFAULT | wxICON_ERROR );
145  schCopyErrorDlg.ShowModal();
146  return;
147  }
148  }
149 
150  wxFileName pcbCopy( pro );
151  pcbCopy.SetExt( aPcbFileExtension );
152 
153  if( pcb.Exists() && !pcbCopy.SameAs( pcb ) )
154  {
155  if( !wxCopyFile( pcb.GetFullPath(), pcbCopy.GetFullPath(), true ) )
156  {
158  msg.Printf( _( "Cannot copy file '%s'\n"
159  "to '%s'\n"
160  "The project cannot be imported." ),
161  pcb.GetFullPath(), pcbCopy.GetFullPath() );
162 
163  wxMessageDialog brdCopyErrorDlg( this, msg, _( "Error" ), wxOK_DEFAULT | wxICON_ERROR );
164  brdCopyErrorDlg.ShowModal();
165  return;
166  }
167  }
168 
169  // Close the project and make the new one
170  CloseProject( true );
171  CreateNewProject( pro.GetFullPath(), false /* Don't create stub files */ );
172  LoadProject( pro );
173 
174  if( schCopy.FileExists() )
175  {
176  KIWAY_PLAYER* schframe = Kiway().Player( FRAME_SCH, true );
177 
178  packet = StrPrintf( "%d\n%s", aSchFileType, TO_UTF8( schCopy.GetFullPath() ) );
179  schframe->Kiway().ExpressMail( FRAME_SCH, MAIL_IMPORT_FILE, packet, this );
180 
181  if( !schframe->IsShown() )
182  schframe->Show( true );
183 
184  // On Windows, Raise() does not bring the window on screen, when iconized
185  if( schframe->IsIconized() )
186  schframe->Iconize( false );
187 
188  schframe->Raise();
189 
190  if( !schCopy.SameAs( sch ) ) // Do not delete the original file!
191  wxRemoveFile( schCopy.GetFullPath() );
192  }
193 
194  if( pcbCopy.FileExists() )
195  {
196  KIWAY_PLAYER* pcbframe = Kiway().Player( FRAME_PCB_EDITOR, true );
197 
198  if( !pcbframe->IsVisible() )
199  pcbframe->Show( true );
200 
201  packet = StrPrintf( "%d\n%s", aPcbFileType, TO_UTF8( pcbCopy.GetFullPath() ) );
202  pcbframe->Kiway().ExpressMail( FRAME_PCB_EDITOR, MAIL_IMPORT_FILE, packet, this );
203 
204  // On Windows, Raise() does not bring the window on screen, when iconized
205  if( pcbframe->IsIconized() )
206  pcbframe->Iconize( false );
207 
208  pcbframe->Raise();
209 
210  if( !pcbCopy.SameAs( pcb ) ) // Do not delete the original file!
211  wxRemoveFile( pcbCopy.GetFullPath() );
212  }
213 
214  ReCreateTreePrj();
215  m_active_project = true;
216 }
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:61
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
Definition: confirm.h:45
const std::string ProjectFileExtension
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:357
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
Definition: kiway.cpp:451
int StrPrintf(std::string *result, const char *format,...)
This is like sprintf() but the output is appended to a std::string instead of to a character array.
Definition: richio.cpp:78
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
wxString GetMruPath() const
void CreateNewProject(const wxFileName &aProjectFileName, bool aCreateStubFiles=true)
Creates a new project by setting up and initial project, schematic, and board files.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
bool CloseProject(bool aSave)
Closes the project, and saves it if aSave is true;.
#define _(s)
Definition: 3d_actions.cpp:33
void LoadProject(const wxFileName &aProjectFileName)

References _, CloseProject(), CreateNewProject(), directory, KIDIALOG::DoNotShowCheckbox(), KIWAY::ExpressMail(), Format(), FRAME_PCB_EDITOR, FRAME_SCH, EDA_BASE_FRAME::GetMruPath(), KIWAY_HOLDER::Kiway(), LoadProject(), m_active_project, MAIL_IMPORT_FILE, KIWAY::Player(), ProjectFileExtension, ReCreateTreePrj(), KIDIALOG::ShowModal(), StrPrintf(), and TO_UTF8.

Referenced by OnImportCadstarArchiveFiles(), and OnImportEagleFiles().

◆ initExitKey()

void EDA_BASE_FRAME::initExitKey ( )
protectedinherited

Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.

This is useful in sub-applications to pass the event up to a non-owning window.

Definition at line 1026 of file eda_base_frame.cpp.

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

◆ InstallPreferences()

void KICAD_MANAGER_FRAME::InstallPreferences ( PAGED_DIALOG ,
PANEL_HOTKEYS_EDITOR  
)
overridevirtual

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

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 651 of file kicad_manager_frame.cpp.

653 {
654  aHotkeysPanel->AddHotKeys( GetToolManager() );
655 }
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55

References PANEL_HOTKEYS_EDITOR::AddHotKeys(), and TOOLS_HOLDER::GetToolManager().

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const
inlineprotectedvirtualinherited

Return the auto save status of the application.

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

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 597 of file eda_base_frame.h.

597 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( )
virtualinherited

Get if the contents of the frame have been modified since the last save.

Returns
true if the contents of the frame have not been saved

Reimplemented in SCH_EDIT_FRAME, CVPCB_MAINFRAME, PL_EDITOR_FRAME, PCB_EDIT_FRAME, SYMBOL_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 1019 of file eda_base_frame.cpp.

1020 {
1021  // This function should be overridden in child classes
1022  return false;
1023 }

Referenced by EDITOR_CONDITIONS::contentModifiedFunc().

◆ IsCurrentTool()

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

Definition at line 108 of file tools_holder.cpp.

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

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

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

◆ IsProjectActive()

bool KICAD_MANAGER_FRAME::IsProjectActive ( )

Definition at line 665 of file kicad_manager_frame.cpp.

666 {
667  return m_active_project;
668 }

References m_active_project.

Referenced by KICAD_MANAGER_CONTROL::Execute(), and KICAD_MANAGER_CONTROL::ShowPlayer().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 192 of file eda_base_frame.h.

192 { return m_ident == aType; }

References EDA_BASE_FRAME::m_ident.

Referenced by SYMBOL_EDITOR_CONTROL::AddLibrary(), PCB_CONTROL::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), EDA_3D_VIEWER::CreateMenuBar(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), COMMON_TOOLS::doZoomFit(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbol(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), CONVERT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), CONVERT_TOOL::LinesToPoly(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SYMBOL_EDITOR_CONTROL::Revert(), SYMBOL_EDITOR_CONTROL::Save(), APPEARANCE_CONTROLS::setVisibleObjects(), EE_INSPECTION_TOOL::ShowDatasheet(), EE_INSPECTION_TOOL::ShowERCDialog(), SYMBOL_EDITOR_CONTROL::ToggleSymbolTree(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), and DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample().

◆ IsWritable()

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

Checks if aFileName can be written.

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

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

Definition at line 928 of file eda_base_frame.cpp.

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

References _.

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

◆ kicadSettings()

KICAD_SETTINGS * KICAD_MANAGER_FRAME::kicadSettings ( ) const
private

Definition at line 256 of file kicad_manager_frame.cpp.

257 {
258  KICAD_SETTINGS* ret = dynamic_cast<KICAD_SETTINGS*>( config() );
259  wxASSERT( ret );
260  return ret;
261 }
APP_SETTINGS_BASE * config() const override
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.

References config().

Referenced by canCloseWindow().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

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

◆ language_change()

void KICAD_MANAGER_FRAME::language_change ( wxCommandEvent &  event)
private

Definition at line 577 of file kicad_manager_frame.cpp.

578 {
579  int id = event.GetId();
580  Kiway().SetLanguage( id );
581 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
virtual void SetLanguage(int aLanguage)
Change the language and then calls ShowChangedLanguage() on all #KIWAY_PLAYERs.
Definition: kiway.cpp:459

References KIWAY_HOLDER::Kiway(), and KIWAY::SetLanguage().

◆ LoadProject()

void KICAD_MANAGER_FRAME::LoadProject ( const wxFileName &  aProjectFileName)

Definition at line 417 of file kicad_manager_frame.cpp.

418 {
419  // The project file should be valid by the time we get here or something has gone wrong.
420  if( !aProjectFileName.Exists() )
421  return;
422 
423  // Any open KIFACE's must be closed if they are not part of the new project.
424  // (We never want a KIWAY_PLAYER open on a KIWAY that isn't in the same project.)
425  // User is prompted here to close those KIWAY_PLAYERs:
426  if( !CloseProject( true ) )
427  return;
428 
429  m_active_project = true;
430 
431  Pgm().GetSettingsManager().LoadProject( aProjectFileName.GetFullPath() );
432 
433  LoadWindowState( aProjectFileName.GetFullName() );
434 
435  if( aProjectFileName.IsDirWritable() )
436  SetMruPath( Prj().GetProjectPath() ); // Only set MRU path if we have write access. Why?
437 
438  UpdateFileHistory( Prj().GetProjectFullName() );
439 
441 
442  // Rebuild the list of watched paths.
443  // however this is possible only when the main loop event handler is running,
444  // so we use it to run the rebuild function.
445  wxCommandEvent cmd( wxEVT_COMMAND_MENU_SELECTED, ID_INIT_WATCHED_PATHS );
446 
447  wxPostEvent( this, cmd );
448 
449  PrintPrjInfo();
450 
451  KIPLATFORM::APP::RegisterApplicationRestart( aProjectFileName.GetFullPath() );
452  m_openSavedWindows = true;
453 }
void SetMruPath(const wxString &aPath)
void ReCreateTreePrj()
Create or modify the tree showing project file names.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void LoadWindowState(const wxString &aFileName)
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:123
PROJECT_TREE_PANE * m_leftWin
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool CloseProject(bool aSave)
Closes the project, and saves it if aSave is true;.
void PrintPrjInfo()
Prints the current working directory name and the project name on the text panel.
bool RegisterApplicationRestart(const wxString &aCommandLine)
Registers the application for restart with the OS with the given command line string to pass as args.
Definition: gtk/app.cpp:51

References CloseProject(), PROJECT::GetProjectPath(), ID_INIT_WATCHED_PATHS, EDA_BASE_FRAME::LoadWindowState(), m_active_project, m_leftWin, m_openSavedWindows, Pgm(), PrintPrjInfo(), KIWAY_HOLDER::Prj(), PROJECT_TREE_PANE::ReCreateTreePrj(), KIPLATFORM::APP::RegisterApplicationRestart(), EDA_BASE_FRAME::SetMruPath(), and EDA_BASE_FRAME::UpdateFileHistory().

Referenced by PROJECT_TREE_ITEM::Activate(), ImportNonKiCadProject(), PGM_KICAD::MacOpenFile(), KICAD_MANAGER_CONTROL::NewFromTemplate(), KICAD_MANAGER_CONTROL::NewProject(), OnFileHistory(), PGM_KICAD::OnPgmInit(), PROJECT_TREE_PANE::onSwitchToSelectedProject(), KICAD_MANAGER_CONTROL::OpenProject(), and KICAD_MANAGER_CONTROL::SaveProjectAs().

◆ LoadSettings()

void KICAD_MANAGER_FRAME::LoadSettings ( APP_SETTINGS_BASE aCfg)
overridevirtual

Load common frame parameters from a configuration file.

Don't forget to call the base method or your frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 627 of file kicad_manager_frame.cpp.

628 {
630 
631  auto settings = dynamic_cast<KICAD_SETTINGS*>( aCfg );
632 
633  wxCHECK( settings, /*void*/);
634 
635  m_leftWinWidth = settings->m_LeftWinWidth;
636 }
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.

References EDA_BASE_FRAME::LoadSettings(), and m_leftWinWidth.

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS aCfg)
inherited

Load window settings from the given settings object.

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

Definition at line 604 of file eda_base_frame.cpp.

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

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

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

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

Definition at line 487 of file eda_base_frame.cpp.

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

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

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

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE aState)
virtualinherited

Load frame state info from a configuration file.

Definition at line 501 of file eda_base_frame.cpp.

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

References PCAD2KICAD::Center, defaultSize(), WINDOW_STATE::display, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_ident, EDA_BASE_FRAME::m_maximizeByDefault, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, minSize(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, SCREEN_BORDER_REGION, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce)
inlineinherited

Definition at line 564 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ OnArchiveFiles()

void KICAD_MANAGER_FRAME::OnArchiveFiles ( wxCommandEvent &  event)

Definition at line 110 of file kicad/files-io.cpp.

111 {
112  wxFileName fileName = GetProjectFileName();
113 
114  fileName.SetExt( ArchiveFileExtension );
115 
116  wxFileDialog dlg( this, _( "Archive Project Files" ),
117  fileName.GetPath(), fileName.GetFullName(),
118  ZipFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
119 
120  if( dlg.ShowModal() == wxID_CANCEL )
121  return;
122 
123  wxFileName zipFile = dlg.GetPath();
124 
125  wxString currdirname = fileName.GetPathWithSep();
126  wxDir dir( currdirname );
127 
128  if( !dir.IsOpened() ) // wxWidgets display a error message on issue.
129  return;
130 
131  STATUSBAR_REPORTER reporter( GetStatusBar(), 1 );
132  PROJECT_ARCHIVER archiver;
133 
134  archiver.Archive( currdirname, zipFile.GetFullPath(), reporter, true, true );
135 }
A wrapper for reporting to a specific text location in a statusbar.
Definition: reporter.h:280
bool Archive(const wxString &aSrcDir, const wxString &aDestFile, REPORTER &aReporter, bool aVerbose=true, bool aIncludeExtraFiles=false)
Creates an archive of the project.
const wxString GetProjectFileName() const
wxString ZipFileWildcard()
#define _(s)
Definition: 3d_actions.cpp:33
const std::string ArchiveFileExtension

References _, PROJECT_ARCHIVER::Archive(), ArchiveFileExtension, GetProjectFileName(), and ZipFileWildcard().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 294 of file eda_base_frame.cpp.

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

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

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ OnBrowseInFileExplorer()

void KICAD_MANAGER_FRAME::OnBrowseInFileExplorer ( wxCommandEvent &  event)

Definition at line 564 of file kicad_manager_frame.cpp.

565 {
566  // open project directory in host OS's file explorer
567  LaunchExternal( Prj().GetProjectPath() );
568 }
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
void LaunchExternal(const wxString &aPath)
Launches the given file or folder in the host OS.
Definition: launch_ext.cpp:26

References LaunchExternal(), and KIWAY_HOLDER::Prj().

◆ OnChangeWatchedPaths()

void KICAD_MANAGER_FRAME::OnChangeWatchedPaths ( wxCommandEvent &  aEvent)

Called by sending a event with id = ID_INIT_WATCHED_PATHS rebuild the list of watched paths.

Definition at line 1300 of file project_tree_pane.cpp.

1301 {
1303 }
PROJECT_TREE_PANE * m_leftWin
void FileWatcherReset()
Reinit the watched paths Should be called after opening a new project to rebuild the list of watched ...

References PROJECT_TREE_PANE::FileWatcherReset(), and m_leftWin.

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  event)
virtualinherited

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

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

Reimplemented in FOOTPRINT_VIEWER_FRAME.

Definition at line 307 of file eda_base_frame.cpp.

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

References dump(), and kicadTraceKeyEvent.

◆ OnClearFileHistory()

void KICAD_MANAGER_FRAME::OnClearFileHistory ( wxCommandEvent &  aEvent)

Definition at line 53 of file kicad/files-io.cpp.

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

References EDA_BASE_FRAME::ClearFileHistory().

◆ OnExit()

void KICAD_MANAGER_FRAME::OnExit ( wxCommandEvent &  event)

Definition at line 382 of file kicad_manager_frame.cpp.

383 {
384  Close( true );
385 }

◆ OnFileHistory()

void KICAD_MANAGER_FRAME::OnFileHistory ( wxCommandEvent &  event)

Definition at line 43 of file kicad/files-io.cpp.

44 {
45  wxFileName projFileName = GetFileFromHistory( event.GetId(), _( "KiCad project file" ) );
46  if( !projFileName.FileExists() )
47  return;
48 
49  LoadProject( projFileName );
50 }
wxString GetFileFromHistory(int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
Fetches the file name from the file history list.
#define _(s)
Definition: 3d_actions.cpp:33
void LoadProject(const wxFileName &aProjectFileName)

References _, EDA_BASE_FRAME::GetFileFromHistory(), and LoadProject().

◆ OnIdle()

void KICAD_MANAGER_FRAME::OnIdle ( wxIdleEvent &  event)

We start loading the saved previously open windows on idle to avoid locking up the GUI earlier in project loading. This gives us the visual effect of a opened KiCad project but with a "busy" progress reporter

Definition at line 671 of file kicad_manager_frame.cpp.

672 {
678  if( !m_openSavedWindows )
679  return;
680 
681  m_openSavedWindows = false;
682 
683  if( Pgm().GetCommonSettings()->m_Session.remember_open_files )
684  {
685  int previousOpenCount =
686  std::count_if( Prj().GetLocalSettings().m_files.begin(),
687  Prj().GetLocalSettings().m_files.end(),
688  [&]( const PROJECT_FILE_STATE& f )
689  {
690  return !f.fileName.EndsWith( ProjectFileExtension ) && f.open;
691  } );
692 
693  if( previousOpenCount > 0 )
694  {
695  APP_PROGRESS_DIALOG progressReporter( _( "Restoring session" ), wxEmptyString,
696  previousOpenCount, this );
697 
698  int i = 0;
699 
700  for( const PROJECT_FILE_STATE& file : Prj().GetLocalSettings().m_files )
701  {
702  if( file.open )
703  {
704  progressReporter.Update( i++,
705  wxString::Format( _( "Restoring \"%s\"" ), file.fileName ) );
706 
707  wxFileName fn( file.fileName );
708 
709  if( fn.GetExt() == LegacySchematicFileExtension
710  || fn.GetExt() == KiCadSchematicFileExtension )
711  {
713  }
714  else if( fn.GetExt() == LegacyPcbFileExtension
715  || fn.GetExt() == KiCadPcbFileExtension )
716  {
718  }
719  }
720 
721  wxYield();
722  }
723  }
724  }
725 
726  // clear file states regardless if we opened windows or not due to setting
728 }
const std::string ProjectFileExtension
const std::string LegacyPcbFileExtension
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
const std::string KiCadPcbFileExtension
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:151
static TOOL_ACTION editSchematic
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
const std::string LegacySchematicFileExtension
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static TOOL_ACTION editPCB
#define _(s)
Definition: 3d_actions.cpp:33
const std::string KiCadSchematicFileExtension
wxProgressDialog with the option to also update the application progress on the taskbar
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
std::vector< PROJECT_FILE_STATE > m_files
Project scope.

References _, PROJECT_LOCAL_SETTINGS::ClearFileState(), KICAD_MANAGER_ACTIONS::editPCB, KICAD_MANAGER_ACTIONS::editSchematic, Format(), PROJECT::GetLocalSettings(), TOOLS_HOLDER::GetToolManager(), KiCadPcbFileExtension, KiCadSchematicFileExtension, LegacyPcbFileExtension, LegacySchematicFileExtension, PROJECT_LOCAL_SETTINGS::m_files, m_openSavedWindows, Pgm(), KIWAY_HOLDER::Prj(), ProjectFileExtension, TOOL_MANAGER::RunAction(), and APP_PROGRESS_DIALOG::Update().

◆ OnImportCadstarArchiveFiles()

void KICAD_MANAGER_FRAME::OnImportCadstarArchiveFiles ( wxCommandEvent &  event)

Open dialog to import CADSTAR Schematic and PCB Archive files.

Definition at line 219 of file import_project.cpp.

220 {
221  ImportNonKiCadProject( _( "Import CADSTAR Archive Project Files" ),
222  CadstarArchiveFilesWildcard(), "csa", "cpa", SCH_IO_MGR::SCH_CADSTAR_ARCHIVE,
224 }
void ImportNonKiCadProject(wxString aWindowTitle, wxString aFilesWildcard, wxString aSchFileExtension, wxString aPcbFileExtension, int aSchFileType, int aPcbFileType)
Creates a project and imports a non-KiCad Schematic and PCB.
#define _(s)
Definition: 3d_actions.cpp:33
wxString CadstarArchiveFilesWildcard()

References _, IO_MGR::CADSTAR_PCB_ARCHIVE, CadstarArchiveFilesWildcard(), and ImportNonKiCadProject().

◆ OnImportEagleFiles()

void KICAD_MANAGER_FRAME::OnImportEagleFiles ( wxCommandEvent &  event)

Open dialog to import Eagle schematic and board files.

Definition at line 227 of file import_project.cpp.

228 {
229  ImportNonKiCadProject( _( "Import Eagle Project Files" ), EagleFilesWildcard(),
231  SCH_IO_MGR::SCH_EAGLE, IO_MGR::EAGLE );
232 }
const std::string LegacyPcbFileExtension
void ImportNonKiCadProject(wxString aWindowTitle, wxString aFilesWildcard, wxString aSchFileExtension, wxString aPcbFileExtension, int aSchFileType, int aPcbFileType)
Creates a project and imports a non-KiCad Schematic and PCB.
const std::string LegacySchematicFileExtension
#define _(s)
Definition: 3d_actions.cpp:33
wxString EagleFilesWildcard()

References _, IO_MGR::EAGLE, EagleFilesWildcard(), ImportNonKiCadProject(), LegacyPcbFileExtension, and LegacySchematicFileExtension.

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 887 of file eda_base_frame.cpp.

888 {
889  void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
890  ShowAboutDialog( this );
891 }
void ShowAboutDialog(EDA_BASE_FRAME *aParent)
The base frame for deriving all KiCad main window classes.

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent &  aEvent)
inherited

Definition at line 1094 of file eda_base_frame.cpp.

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

References EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, and traceDisplayLocation.

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent &  event)
inherited

The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves.

Definition at line 316 of file eda_base_frame.cpp.

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

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

◆ OnMove()

virtual void EDA_BASE_FRAME::OnMove ( wxMoveEvent &  aEvent)
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 181 of file eda_base_frame.h.

182  {
183  aEvent.Skip();
184  }

◆ OnOpenFileInTextEditor()

void KICAD_MANAGER_FRAME::OnOpenFileInTextEditor ( wxCommandEvent &  event)

Definition at line 543 of file kicad_manager_frame.cpp.

544 {
545  // show all files in file dialog (in Kicad all files are editable texts):
546  wxString wildcard = AllFilesWildcard();
547 
548  wxString default_dir = Prj().GetProjectPath();
549 
550  wxFileDialog dlg( this, _( "Load File to Edit" ), default_dir,
551  wxEmptyString, wildcard, wxFD_OPEN );
552 
553  if( dlg.ShowModal() == wxID_CANCEL )
554  return;
555 
556  wxString filename = wxT( "\"" );
557  filename += dlg.GetPath() + wxT( "\"" );
558 
559  if( !dlg.GetPath().IsEmpty() && !Pgm().GetEditorName().IsEmpty() )
561 }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:123
wxString AllFilesWildcard()
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION openTextEditor

References _, AllFilesWildcard(), PROJECT::GetProjectPath(), TOOLS_HOLDER::m_toolManager, KICAD_MANAGER_ACTIONS::openTextEditor, Pgm(), KIWAY_HOLDER::Prj(), and TOOL_MANAGER::RunAction().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 894 of file eda_base_frame.cpp.

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

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

Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch().

◆ OnSize()

void KICAD_MANAGER_FRAME::OnSize ( wxSizeEvent &  event)

Definition at line 324 of file kicad_manager_frame.cpp.

325 {
326  if( m_auimgr.GetManagedWindow() )
327  m_auimgr.Update();
328 
329  event.Skip();
330 }
wxAuiManager m_auimgr

References EDA_BASE_FRAME::m_auimgr.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent &  aEvent)
protectedinherited

Definition at line 1151 of file eda_base_frame.cpp.

1152 {
1153  // Call the handler to update the colors used in the frame
1155 
1156  // Skip the change event to ensure the rest of the window controls get it
1157  aEvent.Skip();
1158 }
virtual void HandleSystemColorChange()
Update the UI in response to a change in the system colors.

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ OnUnarchiveFiles()

void KICAD_MANAGER_FRAME::OnUnarchiveFiles ( wxCommandEvent &  event)

Definition at line 59 of file kicad/files-io.cpp.

60 {
61  wxFileName fn = Prj().GetProjectFullName();
62 
63  fn.SetExt( ArchiveFileExtension );
64 
65  wxFileDialog zipfiledlg( this, _( "Unzip Project" ), fn.GetPath(),
66  fn.GetFullName(), ZipFileWildcard(),
67  wxFD_OPEN | wxFD_FILE_MUST_EXIST );
68 
69  if( zipfiledlg.ShowModal() == wxID_CANCEL )
70  return;
71 
72  wxString msg = wxString::Format( _( "\nOpen \"%s\"\n" ), zipfiledlg.GetPath() );
73  PrintMsg( msg );
74 
75  wxDirDialog dirDlg( this, _( "Target Directory" ), fn.GetPath(), wxDD_DEFAULT_STYLE );
76 
77  if( dirDlg.ShowModal() == wxID_CANCEL )
78  return;
79 
80  wxString unzipDir = dirDlg.GetPath() + wxT( "/" );
81  msg.Printf( _( "Unzipping project in \"%s\"\n" ), unzipDir );
82  PrintMsg( msg );
83 
84  if( unzipDir == Prj().GetProjectPath() )
85  {
86  if( !Kiway().PlayersClose( false ) )
87  return;
88  }
89 
90  STATUSBAR_REPORTER reporter( GetStatusBar(), 1 );
91 
92  PROJECT_ARCHIVER archiver;
93 
94  archiver.Unarchive( zipfiledlg.GetPath(), unzipDir, reporter );
95 
96  if( unzipDir == Prj().GetProjectPath() )
97  {
98  wxString prjPath = Prj().GetProjectFullName();
99 
100  SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
101 
102  mgr.UnloadProject( &Prj(), false );
103  mgr.LoadProject( prjPath );
104 
106  }
107 }
A wrapper for reporting to a specific text location in a statusbar.
Definition: reporter.h:280
void PrintMsg(const wxString &text)
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
wxString ZipFileWildcard()
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:123
bool Unarchive(const wxString &aSrcFile, const wxString &aDestDir, REPORTER &aReporter)
Extracts an archive of the current project over existing files Warning: this will overwrite files in ...
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.
Definition: project.cpp:117
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Loads a project or sets up a new project with a specified path.
#define _(s)
Definition: 3d_actions.cpp:33
bool UnloadProject(PROJECT *aProject, bool aSave=true)
Saves, unloads and unregisters the given PROJECT.
const std::string ArchiveFileExtension

References _, ArchiveFileExtension, Format(), PROJECT::GetProjectFullName(), PROJECT::GetProjectPath(), KIWAY_HOLDER::Kiway(), SETTINGS_MANAGER::LoadProject(), Pgm(), EDA_BASE_FRAME::PrintMsg(), KIWAY_HOLDER::Prj(), RefreshProjectTree(), PROJECT_ARCHIVER::Unarchive(), SETTINGS_MANAGER::UnloadProject(), and ZipFileWildcard().

◆ PcbFileName()

const wxString KICAD_MANAGER_FRAME::PcbFileName ( )

Definition at line 288 of file kicad_manager_frame.cpp.

289 {
290  wxFileName fn( GetProjectFileName() );
291 
292  fn.SetExt( PcbFileExtension );
293  return fn.GetFullPath();
294 }
const wxString GetProjectFileName() const
#define PcbFileExtension

References GetProjectFileName(), and PcbFileExtension.

Referenced by PROJECT_TREE_ITEM::Activate(), and KICAD_MANAGER_CONTROL::ShowPlayer().

◆ PcbLegacyFileName()

const wxString KICAD_MANAGER_FRAME::PcbLegacyFileName ( )

Definition at line 297 of file kicad_manager_frame.cpp.

298 {
299  wxFileName fn( GetProjectFileName() );
300 
301  fn.SetExt( LegacyPcbFileExtension );
302  return fn.GetFullPath();
303 }
const wxString GetProjectFileName() const
const std::string LegacyPcbFileExtension

References GetProjectFileName(), and LegacyPcbFileExtension.

Referenced by PROJECT_TREE_ITEM::Activate(), and KICAD_MANAGER_CONTROL::ShowPlayer().

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )
virtualinherited

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

Definition at line 1078 of file eda_base_frame.cpp.

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

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

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

◆ PopCommandFromUndoList()

◆ PopTool()

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

Definition at line 60 of file tools_holder.cpp.

61 {
62  // Push/pop events can get out of order (such as when they're generated by the Simulator
63  // frame but not processed until the mouse is back in the Schematic frame), so make sure
64  // we're popping the right stack frame.
65 
66  for( int i = (int) m_toolStack.size() - 1; i >= 0; --i )
67  {
68  if( m_toolStack[ i ] == actionName )
69  {
70  m_toolStack.erase( m_toolStack.begin() + i );
71 
72  // If there's something underneath us, and it's now the top of the stack, then
73  // re-activate it
74  if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
75  {
76  std::string back = m_toolStack[ i ];
78 
79  if( action )
80  {
81  // Pop the action as running it will push it back onto the stack
82  m_toolStack.pop_back();
83 
84  TOOL_EVENT evt = action->MakeEvent();
85  evt.SetHasPosition( false );
86  evt.SetReactivate( true );
87  GetToolManager()->PostEvent( evt );
88  }
89  }
90  else
92 
93  return;
94  }
95  }
96 }
virtual void DisplayToolMsg(const wxString &msg)
Definition: tools_holder.h:122
void SetReactivate(bool aReactivate=true)
Returns information about difference between current mouse cursor position and the place where draggi...
Definition: tool_event.h:274
TOOL_ACTION * FindAction(const std::string &aActionName) const
Find an action with a given name (if there is one available).
Generic, UI-independent tool event.
Definition: tool_event.h:173
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
std::vector< std::string > m_toolStack
Definition: tools_holder.h:163
Represent a single user action.
Definition: tool_action.h:49
TOOL_EVENT MakeEvent() const
Return the event associated with the action (i.e.
Definition: tool_action.h:123
ACTION_MANAGER * GetActionManager() const
Definition: tool_manager.h:197
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
void PostEvent(const TOOL_EVENT &aEvent)
Put an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:267
static TOOL_ACTION selectionTool
Definition: actions.h:156
void SetHasPosition(bool aHasPosition)
Returns if the action associated with this event should be treated as immediate regardless of the cur...
Definition: tool_event.h:262

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOLS_HOLDER::GetToolManager(), TOOLS_HOLDER::m_toolManager, TOOLS_HOLDER::m_toolStack, TOOL_ACTION::MakeEvent(), TOOL_MANAGER::PostEvent(), ACTIONS::selectionTool, TOOL_EVENT::SetHasPosition(), and TOOL_EVENT::SetReactivate().

Referenced by EDIT_TOOL::copyToClipboard(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), ZOOM_TOOL::Main(), PCB_PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString &  text)
inherited

Definition at line 729 of file eda_base_frame.cpp.

730 {
731  SetStatusText( text );
732 }

References text.

Referenced by KICAD_MANAGER_CONTROL::Execute(), TERMINATE_HANDLER::OnTerminate(), and OnUnarchiveFiles().

◆ PrintPrjInfo()

void KICAD_MANAGER_FRAME::PrintPrjInfo ( )

Prints the current working directory name and the project name on the text panel.

Definition at line 658 of file kicad_manager_frame.cpp.

659 {
660  SetStatusText( wxString::Format( _( "Project: %s" ), Prj().GetProjectFullName() ) );
661 
662 }
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33

References _, Format(), and KIWAY_HOLDER::Prj().

Referenced by LoadProject(), and ShowChangedLanguage().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:173

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), DIALOG_EXPORT_SVG::ExportSVGFile(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), GetProjectFileName(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), DIALOG_GENDRILL::OnGenReportFile(), OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), PrintPrjInfo(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent &  aEvent)
overrideinherited

Override the default process event handler to implement the auto save feature.

Warning
If you override this function in a derived class, make sure you call down to this or the auto save feature will be disabled.

Definition at line 236 of file eda_base_frame.cpp.

237 {
238 #ifdef __WXMAC__
239  // Apple in its infinite wisdom will raise a disabled window before even passing
240  // us the event, so we have no way to stop it. Instead, we have to catch an
241  // improperly ordered disabled window and quasi-modal dialog here and reorder
242  // them.
243  if( !IsEnabled() && IsActive() )
244  {
245  wxWindow* dlg = findQuasiModalDialog();
246  if( dlg )
247  dlg->Raise();
248  }
249 #endif
250 
251  if( !wxFrame::ProcessEvent( aEvent ) )
252  return false;
253 
254  if( IsShown() && m_hasAutoSave && IsActive() &&
256  {
257  if( !m_autoSaveState )
258  {
259  wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
260  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
261  m_autoSaveState = true;
262  }
263  else if( m_autoSaveTimer->IsRunning() )
264  {
265  wxLogTrace( traceAutoSave, wxT( "Stopping auto save timer." ) );
266  m_autoSaveTimer->Stop();
267  m_autoSaveState = false;
268  }
269  }
270 
271  return true;
272 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
virtual bool isAutoSaveRequired() const
Return the auto save status of the application.
wxTimer * m_autoSaveTimer
wxWindow * findQuasiModalDialog()

References EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::isAutoSaveRequired(), EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_autoSaveState, EDA_BASE_FRAME::m_autoSaveTimer, EDA_BASE_FRAME::m_hasAutoSave, and traceAutoSave.

Referenced by COMMON_TOOLS::GridProperties(), SYMBOL_VIEWER_FRAME::onSelectNextSymbol(), SYMBOL_VIEWER_FRAME::onSelectPreviousSymbol(), KIWAY::ProcessEvent(), and SYMBOL_VIEWER_FRAME::ReCreateSymbolList().

◆ ProjectChanged()

void KICAD_MANAGER_FRAME::ProjectChanged ( )
overridevirtual

Notification event that the project has changed.

Reimplemented from EDA_BASE_FRAME.

Definition at line 603 of file kicad_manager_frame.cpp.

604 {
605  wxString app = wxS( "KiCad " ) + GetMajorMinorVersion();
606  wxString file = GetProjectFileName();
607  wxString title;
608 
609  if( !file.IsEmpty() )
610  {
611  wxFileName fn( file );
612 
613  title += fn.GetName();
614 
615  if( !fn.IsDirWritable() )
616  title += wxS( " " ) + _( "[Read Only]" );
617 
618  title += wxS(" \u2014 ");
619  }
620 
621  title += app;
622 
623  SetTitle( title );
624 }
const wxString GetProjectFileName() const
wxString GetMajorMinorVersion()
Get only the major and minor version in a string major.minor.
#define _(s)
Definition: 3d_actions.cpp:33

References _, GetMajorMinorVersion(), and GetProjectFileName().

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

Add a command to redo in the redo list.

Delete the very old commands when the max count of redo commands is reached.

Definition at line 1057 of file eda_base_frame.cpp.

1058 {
1059  m_redoList.PushCommand( aNewitem );
1060 
1061  // Delete the extra items, if count max reached
1062  if( m_undoRedoCountMax > 0 )
1063  {
1064  int extraitems = GetRedoCommandCount() - m_undoRedoCountMax;
1065 
1066  if( extraitems > 0 )
1067  ClearUndoORRedoList( REDO_LIST, extraitems );
1068  }
1069 }
virtual int GetRedoCommandCount() const
virtual void ClearUndoORRedoList(UNDO_REDO_LIST aList, int aItemCount=-1)
void PushCommand(PICKED_ITEMS_LIST *aCommand)
UNDO_REDO_CONTAINER m_redoList

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetRedoCommandCount(), EDA_BASE_FRAME::m_redoList, EDA_BASE_FRAME::m_undoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and EDA_BASE_FRAME::REDO_LIST.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

Add a command to undo in the undo list.

Delete the very old commands when the max count of undo commands is reached.

Definition at line 1042 of file eda_base_frame.cpp.

1043 {
1044  m_undoList.PushCommand( aNewitem );
1045 
1046  // Delete the extra items, if count max reached
1047  if( m_undoRedoCountMax > 0 )
1048  {
1049  int extraitems = GetUndoCommandCount() - m_undoRedoCountMax;
1050 
1051  if( extraitems > 0 )
1052  ClearUndoORRedoList( UNDO_LIST, extraitems );
1053  }
1054 }
UNDO_REDO_CONTAINER m_undoList
virtual void ClearUndoORRedoList(UNDO_REDO_LIST aList, int aItemCount=-1)
void PushCommand(PICKED_ITEMS_LIST *aCommand)
virtual int GetUndoCommandCount() const

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetUndoCommandCount(), EDA_BASE_FRAME::m_undoList, EDA_BASE_FRAME::m_undoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and EDA_BASE_FRAME::UNDO_LIST.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SCH_EDITOR_CONTROL::Redo(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), PL_EDITOR_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::StartNewUndo().

◆ PushTool()

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

NB: the definition of "tool" is different at the user level.

The implementation uses a single TOOL_BASE derived class to implement several user "tools", such as rectangle and circle, or wire and bus. So each user-level tool is actually a TOOL_ACTION.

Definition at line 43 of file tools_holder.cpp.

44 {
45  m_toolStack.push_back( actionName );
46 
47  // Human cognitive stacking is very shallow; deeper tool stacks just get annoying
48  if( m_toolStack.size() > 3 )
49  m_toolStack.erase( m_toolStack.begin() );
50 
51  TOOL_ACTION* action = m_toolManager->GetActionManager()->FindAction( actionName );
52 
53  if( action )
54  DisplayToolMsg( action->GetLabel() );
55  else
56  DisplayToolMsg( actionName );
57 }
virtual void DisplayToolMsg(const wxString &msg)
Definition: tools_holder.h:122
TOOL_ACTION * FindAction(const std::string &aActionName) const
Find an action with a given name (if there is one available).
wxString GetLabel() const
Definition: tool_action.cpp:70
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
std::vector< std::string > m_toolStack
Definition: tools_holder.h:163
Represent a single user action.
Definition: tool_action.h:49
ACTION_MANAGER * GetActionManager() const
Definition: tool_manager.h:197

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_ACTION::GetLabel(), TOOLS_HOLDER::m_toolManager, and TOOLS_HOLDER::m_toolStack.

Referenced by EDIT_TOOL::copyToClipboard(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), ZOOM_TOOL::Main(), PCB_PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ RecreateBaseHToolbar()

void KICAD_MANAGER_FRAME::RecreateBaseHToolbar ( )

(Re)Create the horizontal toolbar

Definition at line 191 of file kicad/menubar.cpp.

192 {
193  if( m_mainToolBar )
194  {
196  }
197  else
198  {
199  m_mainToolBar = new ACTION_TOOLBAR( this, ID_H_TOOLBAR, wxDefaultPosition, wxDefaultSize,
200  KICAD_AUI_TB_STYLE | wxAUI_TB_HORZ_LAYOUT );
202  }
203 
204  // New
207 
209  m_mainToolBar->AddTool( ID_SAVE_AND_ZIP_FILES, wxEmptyString,
210  KiScaledBitmap( BITMAPS::zip, this ),
211  _( "Archive all project files" ) );
212 
213  m_mainToolBar->AddTool( ID_READ_ZIP_ARCHIVE, wxEmptyString,
215  _( "Unarchive project files from zip archive" ) );
216 
219 
221  m_mainToolBar->AddTool( ID_BROWSE_IN_FILE_EXPLORER, wxEmptyString,
223 #ifdef __APPLE__
224  _( "Reveal project folder in Finder" ) );
225 #else
226  _( "Open project directory in file explorer" ) );
227 #endif
228 
229  // Create m_mainToolBar
230  m_mainToolBar->Realize();
231 }
static TOOL_ACTION newProject
Define the structure of a toolbar with buttons that invoke ACTIONs.
void AddScaledSeparator(wxWindow *aWindow)
Add a separator that introduces space on either side to not squash the tools when scaled.
void Add(const TOOL_ACTION &aAction, bool aIsToggleEntry=false, bool aIsCancellable=false)
Add a TOOL_ACTION-based button to the toolbar.
void SetAuiManager(wxAuiManager *aManager)
Set the AUI manager that this toolbar belongs to.
wxAuiManager m_auimgr
static TOOL_ACTION openProject
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION zoomRedraw
Definition: actions.h:93
static constexpr int KICAD_AUI_TB_STYLE
< Default style flags used for wxAUI toolbars.
ACTION_TOOLBAR * m_mainToolBar
wxBitmap KiScaledBitmap(BITMAPS aBitmap, wxWindow *aWindow, int aHeight)
Construct a wxBitmap from a memory record, scaling it if device DPI demands it.
Definition: bitmap.cpp:147
void ClearToolbar()
Clear the toolbar and remove all associated menus.

References _, ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddScaledSeparator(), ACTION_TOOLBAR::ClearToolbar(), directory_browser, ID_BROWSE_IN_FILE_EXPLORER, ID_H_TOOLBAR, ID_READ_ZIP_ARCHIVE, ID_SAVE_AND_ZIP_FILES, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, KiScaledBitmap(), EDA_BASE_FRAME::m_auimgr, m_mainToolBar, KICAD_MANAGER_ACTIONS::newProject, KICAD_MANAGER_ACTIONS::openProject, ACTION_TOOLBAR::SetAuiManager(), unzip, zip, and ACTIONS::zoomRedraw.

Referenced by ShowChangedLanguage().

◆ ReCreateMenuBar()

void KICAD_MANAGER_FRAME::ReCreateMenuBar ( )
overridevirtual

Recreates the menu bar.

Needed when the language or icons are changed

Reimplemented from EDA_BASE_FRAME.

Definition at line 41 of file kicad/menubar.cpp.

42 {
44  // wxWidgets handles the Mac Application menu behind the scenes, but that means
45  // we always have to start from scratch with a new wxMenuBar.
46  wxMenuBar* oldMenuBar = GetMenuBar();
47  WX_MENUBAR* menuBar = new WX_MENUBAR();
48 
49  //-- File menu -----------------------------------------------------------
50  //
51  ACTION_MENU* fileMenu = new ACTION_MENU( false, controlTool );
52  FILE_HISTORY& fileHistory = GetFileHistory();
53 
54  fileHistory.SetClearText( _( "Clear Recent Projects" ) );
55 
56  static ACTION_MENU* openRecentMenu;
57 
58  // Create the menu if it does not exist. Adding a file to/from the history
59  // will automatically refresh the menu.
60  if( !openRecentMenu )
61  {
62  openRecentMenu = new ACTION_MENU( false, controlTool );
63  openRecentMenu->SetTitle( _( "Open Recent" ) );
64  openRecentMenu->SetIcon( BITMAPS::recent );
65 
66  fileHistory.UseMenu( openRecentMenu );
67  fileHistory.AddFilesToMenu();
68  }
69 
73 
74  wxMenuItem* item = fileMenu->Add( openRecentMenu );
75 
76  // Add the file menu condition here since it needs the item ID for the submenu
77  ACTION_CONDITIONS cond;
78  cond.Enable( FILE_HISTORY::FileHistoryNotEmpty( fileHistory ) );
79  RegisterUIUpdateHandler( item->GetId(), cond );
80 
81  fileMenu->AppendSeparator();
83 
84  fileMenu->AppendSeparator();
85  fileMenu->Add( ACTIONS::saveAs );
86 
87  fileMenu->AppendSeparator();
88 
89  //Import Sub-menu
90  ACTION_MENU* importMenu = new ACTION_MENU( false, controlTool );
91  importMenu->SetTitle( _( "Import Non-KiCad Project..." ) );
92  importMenu->SetIcon( BITMAPS::import_project );
93 
94  importMenu->Add( _( "CADSTAR Project..." ),
95  _( "Import CADSTAR Archive Schematic and PCB (*.csa, *.cpa)" ),
98 
99  importMenu->Add( _( "EAGLE Project..." ),
100  _( "Import EAGLE CAD XML schematic and board" ),
103 
104  fileMenu->Add( importMenu );
105 
106  fileMenu->AppendSeparator();
107  fileMenu->Add( _( "&Archive Project..." ),
108  _( "Archive all needed project files into zip archive" ),
110  BITMAPS::zip );
111 
112  fileMenu->Add( _( "&Unarchive Project..." ),
113  _( "Unarchive project files from zip archive" ),
115  BITMAPS::unzip );
116 
117  fileMenu->AppendSeparator();
118  fileMenu->AddQuitOrClose( nullptr, "KiCad" );
119 
120  //-- View menu -----------------------------------------------------------
121  //
122  ACTION_MENU* viewMenu = new ACTION_MENU( false, controlTool );
123 
124  viewMenu->Add( ACTIONS::zoomRedraw );
125 
126  viewMenu->AppendSeparator();
128  viewMenu->Add( _( "Browse Project Files" ),
129  _( "Open project directory in file browser" ),
132 
133 #ifdef __APPLE__
134  // Add a separator only on macOS because the OS adds menu items to the view menu after ours
135  viewMenu->AppendSeparator();
136 #endif
137 
138  //-- Tools menu -----------------------------------------------
139  //
140  ACTION_MENU* toolsMenu = new ACTION_MENU( false, controlTool );
141 
144  toolsMenu->Add( KICAD_MANAGER_ACTIONS::editPCB );
146 
147  toolsMenu->AppendSeparator();
152 
153  toolsMenu->AppendSeparator();
154  toolsMenu->Add( _( "Edit Local File..." ),
155  _( "Edit local file in text editor" ),
157  BITMAPS::editor );
158 
159  //-- Preferences menu -----------------------------------------------
160  //
161  ACTION_MENU* prefsMenu = new ACTION_MENU( false, controlTool );
162 
163  prefsMenu->Add( ACTIONS::configurePaths );
164  prefsMenu->Add( ACTIONS::showSymbolLibTable );
165  prefsMenu->Add( ACTIONS::showFootprintLibTable );
166  prefsMenu->Add( _( "Preferences..." ) + "\tCtrl+,",
167  _( "Show preferences for all open tools" ),
168  wxID_PREFERENCES,
170 
171  prefsMenu->AppendSeparator();
172  AddMenuLanguageList( prefsMenu, controlTool );
173 
174 
175  //-- Menubar -------------------------------------------------------------
176  //
177  menuBar->Append( fileMenu, _( "&File" ) );
178  menuBar->Append( viewMenu, _( "&View" ) );
179  menuBar->Append( toolsMenu, _( "&Tools" ) );
180  menuBar->Append( prefsMenu, _( "&Preferences" ) );
181  AddStandardHelpMenu( menuBar );
182 
183  SetMenuBar( menuBar );
184  delete oldMenuBar;
185 }
void AddFilesToMenu() override
Add the files to all registered menus.
Definition: filehistory.h:98
static TOOL_ACTION newProject
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:47
void SetIcon(BITMAPS aIcon)
Assign an icon for the entry.
Definition: action_menu.cpp:72
static TOOL_ACTION showCalculator
void SetClearText(wxString aClearText)
Set the text displayed on the menu item that clears the entire menu.
Definition: filehistory.h:123
static TOOL_ACTION viewGerbers
virtual void RegisterUIUpdateHandler(int aID, const ACTION_CONDITIONS &aConditions) override
Register a UI update handler for the control with ID aID.
static TOOL_ACTION showSymbolLibTable
Definition: actions.h:176
static TOOL_ACTION newFromTemplate
Handle actions in the kicad manager frame.
Wrapper around a wxMenuBar object that prevents the accelerator table from being used.
Definition: wx_menubar.h:45
This class implements a file history object to store a list of files, that can then be added to a men...
Definition: filehistory.h:42
static TOOL_ACTION convertImage
static TOOL_ACTION closeProject
ACTION_CONDITIONS & Enable(const SELECTION_CONDITION &aCondition)
static TOOL_ACTION editSchematic
static TOOL_ACTION showFootprintLibTable
Definition: actions.h:177
void AddStandardHelpMenu(wxMenuBar *aMenuBar)
Adds the standard KiCad help menu to the menubar.
static TOOL_ACTION editFootprints
void AddMenuLanguageList(ACTION_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
Function AddMenuLanguageList creates a menu list for language choice, and add it as submenu to Master...
static TOOL_ACTION editPCB
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
void SetTitle(const wxString &aTitle) override
Set title for the menu.
Definition: action_menu.cpp:90
FILE_HISTORY & GetFileHistory()
Get the frame's main file history.
static SELECTION_CONDITION FileHistoryNotEmpty(const FILE_HISTORY &aHistory)
Create a SELECTION_CONDITION that can be used to enable a menu item when the file history has items i...
static TOOL_ACTION openProject
static TOOL_ACTION saveAs
Definition: actions.h:55
void AddQuitOrClose(KIFACE_I *aKiface, wxString aAppname="")
Add either a standard Quit or Close item to the menu.
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION zoomRedraw
Definition: actions.h:93
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
wxMenuItem * Add(const wxString &aLabel, int aId, BITMAPS aIcon)
Add a wxWidgets-style entry to the menu.
static TOOL_ACTION editSymbols
static TOOL_ACTION configurePaths
Definition: actions.h:175
static TOOL_ACTION openTextEditor
static TOOL_ACTION editDrawingSheet

References _, ACTION_MENU::Add(), FILE_HISTORY::AddFilesToMenu(), AddMenuLanguageList(), ACTION_MENU::AddQuitOrClose(), EDA_BASE_FRAME::AddStandardHelpMenu(), KICAD_MANAGER_ACTIONS::closeProject, ACTIONS::configurePaths, KICAD_MANAGER_ACTIONS::convertImage, directory_browser, KICAD_MANAGER_ACTIONS::editDrawingSheet, KICAD_MANAGER_ACTIONS::editFootprints, editor, KICAD_MANAGER_ACTIONS::editPCB, KICAD_MANAGER_ACTIONS::editSchematic, KICAD_MANAGER_ACTIONS::editSymbols, ACTION_CONDITIONS::Enable(), FILE_HISTORY::FileHistoryNotEmpty(), EDA_BASE_FRAME::GetFileHistory(), TOOL_MANAGER::GetTool(), ID_BROWSE_IN_FILE_EXPLORER, ID_EDIT_LOCAL_FILE_IN_TEXT_EDITOR, ID_IMPORT_CADSTAR_ARCHIVE_PROJECT, ID_IMPORT_EAGLE_PROJECT, ID_READ_ZIP_ARCHIVE, ID_SAVE_AND_ZIP_FILES, import_project, TOOLS_HOLDER::m_toolManager, KICAD_MANAGER_ACTIONS::newFromTemplate, KICAD_MANAGER_ACTIONS::newProject, KICAD_MANAGER_ACTIONS::openProject, KICAD_MANAGER_ACTIONS::openTextEditor, preference, recent, EDA_BASE_FRAME::RegisterUIUpdateHandler(), ACTIONS::saveAs, FILE_HISTORY::SetClearText(), ACTION_MENU::SetIcon(), ACTION_MENU::SetTitle(), KICAD_MANAGER_ACTIONS::showCalculator, ACTIONS::showFootprintLibTable, ACTIONS::showSymbolLibTable, unzip, KICAD_MANAGER_ACTIONS::viewGerbers, zip, and ACTIONS::zoomRedraw.

◆ ReCreateTreePrj()

void KICAD_MANAGER_FRAME::ReCreateTreePrj ( )

Definition at line 306 of file kicad_manager_frame.cpp.

307 {
309 }
void ReCreateTreePrj()
Create or modify the tree showing project file names.
PROJECT_TREE_PANE * m_leftWin

References m_leftWin, and PROJECT_TREE_PANE::ReCreateTreePrj().

Referenced by ImportNonKiCadProject().

◆ RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 152 of file tools_holder.h.

152 { }

Referenced by TOOL_MANAGER::ProcessEvent().

◆ RefreshProjectTree()

void KICAD_MANAGER_FRAME::RefreshProjectTree ( )

Definition at line 571 of file kicad_manager_frame.cpp.

572 {
574 }
void ReCreateTreePrj()
Create or modify the tree showing project file names.
PROJECT_TREE_PANE * m_leftWin

References m_leftWin, and PROJECT_TREE_PANE::ReCreateTreePrj().

Referenced by OnUnarchiveFiles(), and KICAD_MANAGER_CONTROL::Refresh().

◆ RegisterUIUpdateHandler() [1/2]

virtual void TOOLS_HOLDER::RegisterUIUpdateHandler ( const TOOL_ACTION aAction,
const ACTION_CONDITIONS aConditions 
)
inlinevirtualinherited

Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls.

Parameters
aActionis the action to register.
aConditionsare the UI conditions to use for the control states.

Definition at line 64 of file tools_holder.h.

66  {
67  RegisterUIUpdateHandler( aAction.GetUIId(), aConditions );
68  }
int GetUIId() const
Definition: tool_action.h:112
virtual void RegisterUIUpdateHandler(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Register an action's update conditions with the UI layer to allow the UI to appropriately display the...
Definition: tools_holder.h:64

References TOOL_ACTION::GetUIId().

Referenced by ACTION_TOOLBAR::doSelectAction(), and ACTION_MANAGER::SetConditions().

◆ RegisterUIUpdateHandler() [2/2]

void EDA_BASE_FRAME::RegisterUIUpdateHandler ( int  aID,
const ACTION_CONDITIONS aConditions 
)
overridevirtualinherited

Register a UI update handler for the control with ID aID.

Parameters
aIDis the control ID to register the handler for
aConditionsare the UI conditions to use for the control states

Reimplemented from TOOLS_HOLDER.

Definition at line 325 of file eda_base_frame.cpp.

326 {
328  std::placeholders::_1,
329  this,
330  aConditions );
331 
332  m_uiUpdateMap[aID] = evtFunc;
333 
334  Bind( wxEVT_UPDATE_UI, evtFunc, aID );
335 }
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...
std::function< void(wxUpdateUIEvent &) > UIUpdateHandler
This is the handler functor for the update UI events.
std::map< int, UIUpdateHandler > m_uiUpdateMap
Set by the close window event handler after frames are asked if they can close.

References EDA_BASE_FRAME::HandleUpdateUIEvent(), and EDA_BASE_FRAME::m_uiUpdateMap.

Referenced by ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), setupUIConditions(), EDA_3D_VIEWER::setupUIConditions(), and EDA_BASE_FRAME::setupUIConditions().

◆ SaveProjectSettings()

virtual void EDA_BASE_FRAME::SaveProjectSettings ( )
inlinevirtualinherited

Save changes to the project settings to the project (.pro) file.

The method is virtual so you can override it to call the suitable save method. The base method does nothing.

Parameters
aAskForSavetrue to open a dialog before saving the settings.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 352 of file eda_base_frame.h.

352 {};

Referenced by DIALOG_PAGES_SETTINGS::TransferDataFromWindow().

◆ SaveSettings()

void KICAD_MANAGER_FRAME::SaveSettings ( APP_SETTINGS_BASE aCfg)
overridevirtual

Save common frame parameters to a configuration data file.

Don't forget to call the base class's SaveSettings() from your derived SaveSettings() otherwise the frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 639 of file kicad_manager_frame.cpp.

640 {
642 
643  auto settings = dynamic_cast<KICAD_SETTINGS*>( aCfg );
644 
645  wxCHECK( settings, /*void*/);
646 
647  settings->m_LeftWinWidth = m_leftWin->GetSize().x;
648 }
virtual void SaveSettings(APP_SETTINGS_BASE *aCfg)
Save common frame parameters to a configuration data file.
PROJECT_TREE_PANE * m_leftWin

References m_leftWin, and EDA_BASE_FRAME::SaveSettings().

◆ SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings ( WINDOW_SETTINGS aCfg)
inherited

Save window settings to the given settings object.

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

Definition at line 618 of file eda_base_frame.cpp.

619 {
620  wxString text;
621 
622  if( IsIconized() )
623  return;
624 
625  wxString baseCfgName = ConfigBaseName();
626 
627  // If the window is maximized, we use the saved window size from before it was maximized
628  if( IsMaximized() )
629  {
632  }
633  else
634  {
636  m_framePos = GetPosition();
637  }
638 
639  aCfg->state.pos_x = m_framePos.x;
640  aCfg->state.pos_y = m_framePos.y;
641  aCfg->state.size_x = m_frameSize.x;
642  aCfg->state.size_y = m_frameSize.y;
643  aCfg->state.maximized = IsMaximized();
644  aCfg->state.display = wxDisplay::GetFromWindow( this );
645 
646  wxLogTrace( traceDisplayLocation, "Saving window maximized: %s", IsMaximized() ? "true" : "false" );
647  wxLogTrace( traceDisplayLocation, "Saving config position (%d, %d) with size (%d, %d)",
649 
650  // TODO(JE) should auto-save in common settings be overwritten by every app?
651  if( m_hasAutoSave )
652  Pgm().GetCommonSettings()->m_System.autosave_interval = m_autoSaveInterval;
653 
654  // Once this is fully implemented, wxAuiManager will be used to maintain
655  // the persistence of the main frame and all it's managed windows and
656  // all of the legacy frame persistence position code can be removed.
657  aCfg->perspective = m_auimgr.SavePerspective().ToStdString();
658 
659  aCfg->mru_path = m_mruPath;
660 }
wxString mru_path
Definition: app_settings.h:84
wxString m_mruPath
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxPoint m_normalFramePos
wxAuiManager m_auimgr
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
wxString perspective
Definition: app_settings.h:85
wxSize m_normalFrameSize
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.
wxString ConfigBaseName() override
Get the configuration base name.
WINDOW_STATE state
Definition: app_settings.h:83
unsigned int display
Definition: app_settings.h:75

References EDA_BASE_FRAME::ConfigBaseName(), WINDOW_STATE::display, EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_auimgr, EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, WINDOW_SETTINGS::state, text, and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ SchFileName()

const wxString KICAD_MANAGER_FRAME::SchFileName ( )

Definition at line 270 of file kicad_manager_frame.cpp.

271 {
272  wxFileName fn( GetProjectFileName() );
273 
274  fn.SetExt( KiCadSchematicFileExtension );
275  return fn.GetFullPath();
276 }
const wxString GetProjectFileName() const
const std::string KiCadSchematicFileExtension

References GetProjectFileName(), and KiCadSchematicFileExtension.

Referenced by PROJECT_TREE_ITEM::Activate(), and KICAD_MANAGER_CONTROL::ShowPlayer().

◆ SchLegacyFileName()

const wxString KICAD_MANAGER_FRAME::SchLegacyFileName ( )

Definition at line 279 of file kicad_manager_frame.cpp.

280 {
281  wxFileName fn( GetProjectFileName() );
282 
283  fn.SetExt( LegacySchematicFileExtension );
284  return fn.GetFullPath();
285 }
const wxString GetProjectFileName() const
const std::string LegacySchematicFileExtension

References GetProjectFileName(), and LegacySchematicFileExtension.

Referenced by PROJECT_TREE_ITEM::Activate(), and KICAD_MANAGER_CONTROL::ShowPlayer().

◆ SetAutoSaveInterval()

void EDA_BASE_FRAME::SetAutoSaveInterval ( int  aInterval)
inherited

Definition at line 275 of file eda_base_frame.cpp.

276 {
277  m_autoSaveInterval = aInterval;
278 
279  if( m_autoSaveTimer->IsRunning() )
280  {
281  if( m_autoSaveInterval > 0 )
282  {
283  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
284  }
285  else
286  {
287  m_autoSaveTimer->Stop();
288  m_autoSaveState = false;
289  }
290  }
291 }
wxTimer * m_autoSaveTimer

References EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_autoSaveState, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged().

◆ SetKiway()

void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
aKiwayis often from a parent window or from KIFACE::CreateWindow().

Definition at line 42 of file kiway_holder.cpp.

43 {
44 #if defined(DEBUG)
45  // offer a trap point for debugging most any window
46  wxASSERT( aDest );
47  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
48  {
49  int breakhere=1;
50  (void) breakhere;
51  }
52 #endif
53 
54  (void) aDest;
55 
56  m_kiway = aKiway;
57 }
KIWAY * m_kiway
Definition: kiway_holder.h:78
const char * name
Definition: DXF_plotter.cpp:59

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString &  aPath)
inlineinherited

◆ setupActions()

void KICAD_MANAGER_FRAME::setupActions ( )
private

◆ setupTools()

void KICAD_MANAGER_FRAME::setupTools ( )
private

Definition at line 197 of file kicad_manager_frame.cpp.

198 {
199  // Create the manager
201  m_toolManager->SetEnvironment( nullptr, nullptr, nullptr, config(), this );
203 
205 
206  // Attach the events to the tool dispatcher
208  Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
209 
210  // Register tools
214 }
Handle actions in the kicad manager frame.
Master controller class:
Definition: tool_manager.h:52
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.
ACTIONS * m_actions
Definition: tools_holder.h:158
Handle actions that are shared between different applications.
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:159
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, APP_SETTINGS_BASE *aSettings, TOOLS_HOLDER *aFrame)
Set the work environment (model, view, view controls and the parent window).
void InitTools()
Initializes all registered tools.
APP_SETTINGS_BASE * config() const override
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
void RegisterTool(TOOL_BASE *aTool)
Add a tool to the manager set and sets it up.

References config(), TOOL_DISPATCHER::DispatchWxEvent(), TOOL_MANAGER::InitTools(), TOOLS_HOLDER::m_actions, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, TOOL_MANAGER::RegisterTool(), and TOOL_MANAGER::SetEnvironment().

◆ setupUIConditions()

void KICAD_MANAGER_FRAME::setupUIConditions ( )
overrideprotectedvirtual

Setup the UI conditions for the various actions and their controls in this frame.

Reimplemented from EDA_BASE_FRAME.

Definition at line 217 of file kicad_manager_frame.cpp.

218 {
220 
222 
223  wxASSERT( manager );
224 
225  auto activeProject =
226  [this] ( const SELECTION& )
227  {
228  return m_active_project;
229  };
230 
231  ACTION_CONDITIONS activeProjectCond;
232  activeProjectCond.Enable( activeProject );
233 
234  manager->SetConditions( ACTIONS::saveAs, activeProjectCond );
235  manager->SetConditions( KICAD_MANAGER_ACTIONS::closeProject, activeProjectCond );
236 
237  // TODO: Switch this to an action
238  RegisterUIUpdateHandler( ID_SAVE_AND_ZIP_FILES, activeProjectCond );
239 }
virtual void setupUIConditions()
Setup the UI conditions for the various actions and their controls in this frame.
virtual void RegisterUIUpdateHandler(int aID, const ACTION_CONDITIONS &aConditions) override
Register a UI update handler for the control with ID aID.
Manage TOOL_ACTION objects.
static TOOL_ACTION closeProject
ACTION_CONDITIONS & Enable(const SELECTION_CONDITION &aCondition)
void SetConditions(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Set the conditions the UI elements for activating a specific tool action should use for determining t...
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
static TOOL_ACTION saveAs
Definition: actions.h:55
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
ACTION_MANAGER * GetActionManager() const
Definition: tool_manager.h:197

References KICAD_MANAGER_ACTIONS::closeProject, ACTION_CONDITIONS::Enable(), TOOL_MANAGER::GetActionManager(), ID_SAVE_AND_ZIP_FILES, m_active_project, TOOLS_HOLDER::m_toolManager, EDA_BASE_FRAME::RegisterUIUpdateHandler(), ACTIONS::saveAs, ACTION_MANAGER::SetConditions(), and EDA_BASE_FRAME::setupUIConditions().

◆ SetUserUnits()

void EDA_BASE_FRAME::SetUserUnits ( EDA_UNITS  aUnits)
inlineinherited

Definition at line 119 of file eda_base_frame.h.

120  {
121  m_userUnits = aUnits;
122  }
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

References EDA_BASE_FRAME::m_userUnits.

Referenced by EDA_BASE_FRAME::ChangeUserUnits(), EDA_DRAW_FRAME::LoadSettings(), and EDA_DRAW_FRAME::ToggleUserUnits().

◆ ShowChangedLanguage()

void KICAD_MANAGER_FRAME::ShowChangedLanguage ( )
overridevirtual

Redraw the menus and what not in current language.

Reimplemented from EDA_BASE_FRAME.

Definition at line 584 of file kicad_manager_frame.cpp.

585 {
586  // call my base class
588 
589  // tooltips in toolbars
592 
593  PrintPrjInfo();
594 }
PANEL_KICAD_LAUNCHER * m_launcher
void RecreateBaseHToolbar()
(Re)Create the horizontal toolbar
virtual void ShowChangedLanguage()
Redraw the menus and what not in current language.
void PrintPrjInfo()
Prints the current working directory name and the project name on the text panel.

References PANEL_KICAD_LAUNCHER::CreateLaunchers(), m_launcher, PrintPrjInfo(), RecreateBaseHToolbar(), and EDA_BASE_FRAME::ShowChangedLanguage().

◆ ShowInfoBarError() [1/2]

void EDA_BASE_FRAME::ShowInfoBarError ( const wxString &  aErrorMsg,
bool  aShowCloseButton = false 
)
inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

The infobar will be closed after a timeout.

Parameters
aErrorMsgis the message to display.
aShowCloseButtontrue to show a close button on the right of the WX_INFOBAR.

Definition at line 763 of file eda_base_frame.cpp.

764 {
766 
767  if( aShowCloseButton )
769 
770  GetInfoBar()->ShowMessageFor( aErrorMsg, 8000, wxICON_ERROR );
771 }
void ShowMessageFor(const wxString &aMessage, int aTime, int aFlags=wxICON_INFORMATION)
Show the infobar with the provided message and icon for a specific period of time.
Definition: infobar.cpp:118
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:282
WX_INFOBAR * m_infoBar
WX_INFOBAR * GetInfoBar()
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
Definition: infobar.cpp:272

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), SCH_EDITOR_CONTROL::AssignNetclass(), MICROWAVE_TOOL::createInductorBetween(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), MICROWAVE_TOOL::createPolygonShape(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawVia(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDIT_FRAME::ExportPart(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), ROUTER_TOOL::prepareInteractive(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), SCH_DRAWING_TOOLS::SingleClickPlace(), and SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields().

◆ ShowInfoBarError() [2/2]

void EDA_BASE_FRAME::ShowInfoBarError ( const wxString &  aErrorMsg,
bool  aShowCloseButton,
std::function< void(void)>  aCallback 
)
inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

The infobar will be closed after a timeout.

This version accepts a callback which will be called when the infobar is dismissed (either as a result of user action or a timeout). This can be useful when the caller wants to make other decorations in the canvas to highlight the error.

Parameters
aErrorMsgis the message to display.
aShowCloseButtontrue to show a close button on the right of the WX_INFOBAR.
aCallbacka callback to be called when the infobar is dismissed.

Definition at line 774 of file eda_base_frame.cpp.

776 {
778 
779  if( aShowCloseButton )
781 
782  if( aCallback )
783  m_infoBar->SetCallback( aCallback );
784 
785  GetInfoBar()->ShowMessageFor( aErrorMsg, 8000, wxICON_ERROR );
786 }
void ShowMessageFor(const wxString &aMessage, int aTime, int aFlags=wxICON_INFORMATION)
Show the infobar with the provided message and icon for a specific period of time.
Definition: infobar.cpp:118
void SetCallback(std::function< void(void)> aCallback)
Provide a callback to be called when the infobar is dismissed (either by user action or timer).
Definition: infobar.h:150
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:282
WX_INFOBAR * m_infoBar
WX_INFOBAR * GetInfoBar()
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
Definition: infobar.cpp:272

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), WX_INFOBAR::SetCallback(), and WX_INFOBAR::ShowMessageFor().

◆ ShowInfoBarMsg()

void EDA_BASE_FRAME::ShowInfoBarMsg ( const wxString &  aMsg,
bool  aShowCloseButton = false 
)
inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters
aErrorMsgis the message to display.
aShowCloseButtontrue to show a close button on the right of the WX_INFOBAR.

Definition at line 800 of file eda_base_frame.cpp.

801 {
803 
804  if( aShowCloseButton )
806 
807  GetInfoBar()->ShowMessageFor( aMsg, 10000, wxICON_INFORMATION );
808 }
void ShowMessageFor(const wxString &aMessage, int aTime, int aFlags=wxICON_INFORMATION)
Show the infobar with the provided message and icon for a specific period of time.
Definition: infobar.cpp:118
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:282
WX_INFOBAR * m_infoBar
WX_INFOBAR * GetInfoBar()
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
Definition: infobar.cpp:272

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by EDIT_TOOL::FilletTracks(), LENGTH_TUNER_TOOL::performTuning(), and DIALOG_FIND::search().

◆ ShowInfoBarWarning()

void EDA_BASE_FRAME::ShowInfoBarWarning ( const wxString &  aWarningMsg,
bool  aShowCloseButton = false 
)
inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters
aErrorMsgis the message to display.
aShowCloseButtontrue to show a close button on the right of the WX_INFOBAR.

Definition at line 789 of file eda_base_frame.cpp.

790 {
792 
793  if( aShowCloseButton )
795 
796  GetInfoBar()->ShowMessageFor( aWarningMsg, 8000, wxICON_WARNING );
797 }
void ShowMessageFor(const wxString &aMessage, int aTime, int aFlags=wxICON_INFORMATION)
Show the infobar with the provided message and icon for a specific period of time.
Definition: infobar.cpp:118
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:282
WX_INFOBAR * m_infoBar
WX_INFOBAR * GetInfoBar()
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
Definition: infobar.cpp:272

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SCH_EDIT_TOOL::RepeatDrawItem().

◆ sys_search()

const SEARCH_STACK & KICAD_MANAGER_FRAME::sys_search ( )
overrideprivatevirtual

Return a SEARCH_STACK pertaining to entire program.

This is overloaded in KICAD_MANAGER_FRAME

Reimplemented from EDA_BASE_FRAME.

Definition at line 312 of file kicad_manager_frame.cpp.

313 {
314  return PgmTop().SysSearch();
315 }
SEARCH_STACK & SysSearch()
Definition: pgm_kicad.h:57
PGM_KICAD & PgmTop()
Definition: kicad.cpp:85

References PgmTop(), and PGM_KICAD::SysSearch().

Referenced by CreateNewProject().

◆ ThemeChanged()

void EDA_BASE_FRAME::ThemeChanged ( )
virtualinherited

Process light/dark theme change.

Reimplemented in PCB_EDIT_FRAME.

Definition at line 472 of file eda_base_frame.cpp.

473 {
475 
476  // Update all the toolbars to have new icons
477  wxAuiPaneInfoArray panes = m_auimgr.GetAllPanes();
478 
479  for( size_t i = 0; i < panes.GetCount(); ++i )
480  {
481  if( ACTION_TOOLBAR* toolbar = dynamic_cast<ACTION_TOOLBAR*>( panes[i].window ) )
482  toolbar->RefreshBitmaps();
483  }
484 }
Define the structure of a toolbar with buttons that invoke ACTIONs.
void ClearScaledBitmapCache()
Wipes out the scaled bitmap cache so that the icon theme can be changed.
Definition: bitmap.cpp:169
wxAuiManager m_auimgr

References ClearScaledBitmapCache(), and EDA_BASE_FRAME::m_auimgr.

Referenced by EDA_BASE_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::HandleSystemColorChange(), and PCB_EDIT_FRAME::ThemeChanged().

◆ ToggleUserUnits()

virtual void EDA_BASE_FRAME::ToggleUserUnits ( )
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 126 of file eda_base_frame.h.

126 { }

Referenced by DIALOG_SHIM::OnCharHook().

◆ ToolStackIsEmpty()

◆ unitsChangeRefresh()

virtual void EDA_BASE_FRAME::unitsChangeRefresh ( )
inlineprotectedvirtualinherited

Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them.

The default version only updates the status bar. Don't forget to call the default in your derived class or the status bar will not get updated properly.

Reimplemented in GERBVIEW_FRAME, EDA_DRAW_FRAME, PCB_BASE_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 618 of file eda_base_frame.h.

618 { }

Referenced by EDA_BASE_FRAME::ChangeUserUnits().

◆ UnregisterUIUpdateHandler() [1/2]

virtual void TOOLS_HOLDER::UnregisterUIUpdateHandler ( const TOOL_ACTION aAction)
inlinevirtualinherited

Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.

Parameters
aActionis the action to unregister the handler for.

Definition at line 84 of file tools_holder.h.

85  {
87  }
int GetUIId() const
Definition: tool_action.h:112
virtual void UnregisterUIUpdateHandler(const TOOL_ACTION &aAction)
Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.
Definition: tools_holder.h:84

References TOOL_ACTION::GetUIId().

Referenced by ACTION_TOOLBAR::doSelectAction(), and ACTION_MANAGER::SetConditions().

◆ UnregisterUIUpdateHandler() [2/2]

void EDA_BASE_FRAME::UnregisterUIUpdateHandler ( int  aID)
overridevirtualinherited

Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler.

Parameters
aIDis the control ID to unregister the handler for

Reimplemented from TOOLS_HOLDER.

Definition at line 338 of file eda_base_frame.cpp.

339 {
340  const auto it = m_uiUpdateMap.find( aID );
341 
342  if( it == m_uiUpdateMap.end() )
343  return;
344 
345  Unbind( wxEVT_UPDATE_UI, it->second, aID );
346 }
std::map< int, UIUpdateHandler > m_uiUpdateMap
Set by the close window event handler after frames are asked if they can close.

References EDA_BASE_FRAME::m_uiUpdateMap.

◆ UpdateFileHistory()

void EDA_BASE_FRAME::UpdateFileHistory ( const wxString &  FullFileName,
FILE_HISTORY aFileHistory = nullptr 
)
inherited

Update the list of recently opened files.

The menu is also updated, if FILE_HISTORY::UseMenu was called at init time.

Parameters
FullFileNameThe full file name including the path.
aFileHistoryThe FILE_HISTORY in use. If NULL, the main application file history is used.

Definition at line 811 of file eda_base_frame.cpp.

812 {
813  if( !aFileHistory )
814  aFileHistory = m_fileHistory;
815 
816  wxASSERT( aFileHistory );
817 
818  aFileHistory->AddFileToHistory( FullFileName );
819 
820  // Update the menubar to update the file history menu
821  if( !m_isClosing && GetMenuBar() )
822  {
823  ReCreateMenuBar();
824  GetMenuBar()->Refresh();
825  }
826 }
bool m_isClosing
Set by NonUserClose() to indicate that the user did not request the current close.
void AddFileToHistory(const wxString &aFile) override
Adds a file to the history.
Definition: filehistory.cpp:96
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

References FILE_HISTORY::AddFileToHistory(), EDA_BASE_FRAME::m_fileHistory, EDA_BASE_FRAME::m_isClosing, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by CreateNewProject(), SCH_EDIT_FRAME::doCloseWindow(), GERBVIEW_FRAME::LoadExcellonFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), PL_EDITOR_FRAME::LoadPageLayoutDescrFile(), LoadProject(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::SaveEEFile(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), EDA_BASE_FRAME::SaveSettings(), and GERBVIEW_FRAME::unarchiveFiles().

◆ UpdateStatusBar()

virtual void EDA_BASE_FRAME::UpdateStatusBar ( )
inlinevirtualinherited

Update the status bar information.

The status bar can draw itself. This is not a drawing function per se, but rather updates lines of text held by the components within the status bar which is owned by the wxFrame.

Reimplemented in EDA_DRAW_FRAME, PCB_BASE_FRAME, PL_EDITOR_FRAME, SCH_BASE_FRAME, and GERBVIEW_FRAME.

Definition at line 470 of file eda_base_frame.h.

470 { }

Referenced by TOOL_MANAGER::UpdateUI().

Member Data Documentation

◆ KICAD_AUI_TB_STYLE

◆ m_aboutTitle

◆ m_actions

◆ m_active_project

bool KICAD_MANAGER_FRAME::m_active_project
private

◆ m_auimgr

wxAuiManager EDA_BASE_FRAME::m_auimgr
protectedinherited

Definition at line 671 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::CreateInfoBar(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), EDA_BASE_FRAME::FinishAUIInitialization(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FOOTPRINT_EDIT_FRAME::IsSearchTreeShown(), SYMBOL_EDIT_FRAME::IsSymbolTreeShown(), OnSize(), SYMBOL_VIEWER_FRAME::OnSize(), FOOTPRINT_WIZARD_FRAME::OnSize(), FOOTPRINT_VIEWER_FRAME::OnSize(), SYMBOL_EDIT_FRAME::OnToggleSymbolTree(), GERBVIEW_FRAME::ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), RecreateBaseHToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), SYMBOL_VIEWER_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), SYMBOL_EDIT_FRAME::ReCreateHToolbar(), CVPCB_MAINFRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), EDA_3D_VIEWER::ReCreateMainToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateOptToolbar(), GERBVIEW_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), PL_EDITOR_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateVToolbar(), SCH_EDIT_FRAME::ReCreateVToolbar(), PL_EDITOR_FRAME::ReCreateVToolbar(), SYMBOL_EDIT_FRAME::ReCreateVToolbar(), PCB_EDIT_FRAME::ReCreateVToolbar(), GERBVIEW_FRAME::ReFillLayerWidget(), CVPCB_MAINFRAME::refreshAfterSymbolSearch(), FOOTPRINT_WIZARD_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveWindowSettings(), PCB_BASE_FRAME::SetDrawBgColor(), GERBVIEW_FRAME::ShowChangedLanguage(), FOOTPRINT_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), EDA_BASE_FRAME::ThemeChanged(), GERBVIEW_FRAME::ToggleLayerManager(), PCB_EDIT_FRAME::ToggleLayersManager(), FOOTPRINT_EDIT_FRAME::ToggleSearchTree(), GERBVIEW_FRAME::updateDCodeSelectBox(), GERBVIEW_FRAME::UpdateTitleAndInfo(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), EDA_3D_VIEWER::~EDA_3D_VIEWER(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), and ~KICAD_MANAGER_FRAME().

◆ m_autoSaveInterval

◆ m_autoSaveState

bool EDA_BASE_FRAME::m_autoSaveState
protectedinherited

◆ m_autoSaveTimer

wxTimer* EDA_BASE_FRAME::m_autoSaveTimer
protectedinherited

◆ m_configName

wxString EDA_BASE_FRAME::m_configName
protectedinherited

◆ m_dragAction

MOUSE_DRAG_ACTION TOOLS_HOLDER::m_dragAction
protectedinherited

◆ m_dummySelection

SELECTION TOOLS_HOLDER::m_dummySelection
protectedinherited

Definition at line 161 of file tools_holder.h.

Referenced by TOOLS_HOLDER::GetCurrentSelection().

◆ m_fileHistory

◆ m_framePos

wxPoint EDA_BASE_FRAME::m_framePos
protectedinherited

◆ m_frameSize

◆ m_hasAutoSave

bool EDA_BASE_FRAME::m_hasAutoSave
protectedinherited

◆ m_ident

◆ m_immediateActions

bool TOOLS_HOLDER::m_immediateActions
protectedinherited

◆ m_infoBar

◆ m_isClosing

bool EDA_BASE_FRAME::m_isClosing
protectedinherited

Set by NonUserClose() to indicate that the user did not request the current close.

Definition at line 702 of file eda_base_frame.h.

Referenced by GERBVIEW_FRAME::doCloseWindow(), EDA_BASE_FRAME::SaveSettings(), EDA_BASE_FRAME::UpdateFileHistory(), and EDA_BASE_FRAME::windowClosing().

◆ m_isNonUserClose

bool EDA_BASE_FRAME::m_isNonUserClose
protectedinherited

◆ m_launcher

PANEL_KICAD_LAUNCHER* KICAD_MANAGER_FRAME::m_launcher
private

Definition at line 177 of file kicad_manager_frame.h.

Referenced by ShowChangedLanguage().

◆ m_leftWin

◆ m_leftWinWidth

int KICAD_MANAGER_FRAME::m_leftWinWidth
private

Definition at line 180 of file kicad_manager_frame.h.

Referenced by LoadSettings().

◆ m_mainToolBar

ACTION_TOOLBAR* KICAD_MANAGER_FRAME::m_mainToolBar
private

Definition at line 178 of file kicad_manager_frame.h.

Referenced by RecreateBaseHToolbar().

◆ m_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault
protectedinherited

◆ m_moveWarpsCursor

bool TOOLS_HOLDER::m_moveWarpsCursor
protectedinherited

◆ m_mruPath

◆ m_normalFramePos

wxPoint EDA_BASE_FRAME::m_normalFramePos
protectedinherited

◆ m_normalFrameSize

wxSize EDA_BASE_FRAME::m_normalFrameSize
protectedinherited

◆ m_openSavedWindows

bool KICAD_MANAGER_FRAME::m_openSavedWindows
private

Definition at line 173 of file kicad_manager_frame.h.

Referenced by CreateNewProject(), LoadProject(), and OnIdle().

◆ m_perspective

wxString EDA_BASE_FRAME::m_perspective
protectedinherited

Definition at line 672 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::LoadWindowSettings().

◆ m_redoList

◆ m_settingsManager

SETTINGS_MANAGER* EDA_BASE_FRAME::m_settingsManager
protectedinherited

Definition at line 679 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::GetSettingsManager().

◆ m_toolDispatcher

◆ m_toolManager

TOOL_MANAGER* TOOLS_HOLDER::m_toolManager
protectedinherited

Definition at line 157 of file tools_holder.h.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), SCH_EDIT_FRAME::AddJunction(), EDA_BASE_FRAME::AddStandardHelpMenu(), EDA_DRAW_FRAME::AddStandardSubMenus(), SCH_EDIT_FRAME::canCloseWindow(), GERBVIEW_FRAME::Clear_DrawLayers(), SCH_EDIT_FRAME::ConvertPart(), EDA_3D_VIEWER::CreateMenuBar(), SYMBOL_EDIT_FRAME::CreateNewPart(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), SYMBOL_VIEWER_FRAME::DClickOnCmpList(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_FRAME::DisplayCurrentSheet(), GERBVIEW_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::emptyScreen(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_EDIT_FRAME::GetCurrentSelection(), FOOTPRINT_VIEWER_FRAME::GetCurrentSelection(), SYMBOL_EDIT_FRAME::GetCurrentSelection(), DISPLAY_FOOTPRINTS_FRAME::GetCurrentSelection(), SCH_EDIT_FRAME::GetCurrentSelection(), PL_EDITOR_FRAME::GetCurrentSelection(), SYMBOL_VIEWER_FRAME::GetCurrentSelection(), GERBVIEW_FRAME::GetCurrentSelection(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), TOOLS_HOLDER::GetToolManager(), EDA_DRAW_FRAME::GetUnitPair(), PL_EDITOR_FRAME::HardRedraw(), SYMBOL_EDIT_FRAME::HardRedraw(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::initScreenZoom(), PCB_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::LoadOneLibraryPartAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_EDIT_FRAME::OnFindDialogClose(), PL_EDITOR_FRAME::OnNewPageLayout(), OnOpenFileInTextEditor(), EDA_DRAW_FRAME::OnSelectGrid(), SYMBOL_EDIT_FRAME::OnSelectUnit(), EDA_DRAW_FRAME::OnSelectZoom(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateVToolbar(), CVPCB_MAINFRAME::refreshAfterSymbolSearch(), SCH_BASE_FRAME::RefreshSelection(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SYMBOL_EDIT_FRAME::saveLibrary(), EDA_DRAW_FRAME::SaveSettings(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_BASE_FRAME::SCH_BASE_FRAME(), SCH_EDIT_FRAME::SchematicCleanUp(), GERBVIEW_FRAME::SetActiveLayer(), PCB_BASE_EDIT_FRAME::SetBoard(), SYMBOL_EDIT_FRAME::SetCurPart(), SCH_EDIT_FRAME::SetScreen(), SYMBOL_VIEWER_FRAME::SetSelectedSymbol(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), setupTools(), SYMBOL_EDIT_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), PL_EDITOR_FRAME::setupUIConditions(), CVPCB_MAINFRAME::setupUIConditions(), FOOTPRINT_VIEWER_FRAME::setupUIConditions(), DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), setupUIConditions(), EDA_3D_VIEWER::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), EDA_DRAW_FRAME::unitsChangeRefresh(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_EDIT_FRAME::UpdateView(), EDA_DRAW_FRAME::Zoom_Automatique(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_FRAME::~EDA_DRAW_FRAME(), FOOTPRINT_EDIT_FRAME::~FOOTPRINT_EDIT_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), ~KICAD_MANAGER_FRAME(), PL_EDITOR_FRAME::~PL_EDITOR_FRAME(), SCH_EDIT_FRAME::~SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::~SYMBOL_VIEWER_FRAME().

◆ m_toolStack

std::vector<std::string> TOOLS_HOLDER::m_toolStack
protectedinherited

◆ m_uiUpdateMap

std::map<int, UIUpdateHandler> EDA_BASE_FRAME::m_uiUpdateMap
protectedinherited

Set by the close window event handler after frames are asked if they can close.

Allows other functions when called to know our state is cleanup.

Definition at line 698 of file eda_base_frame.h.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler(), and EDA_BASE_FRAME::UnregisterUIUpdateHandler().

◆ m_undoList

◆ m_undoRedoCountMax

int EDA_BASE_FRAME::m_undoRedoCountMax
protectedinherited

◆ m_userUnits


The documentation for this class was generated from the following files: