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 }
 Function ClearUndoORRedoList (virtual). 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...
 
void RecreateLauncher ()
 
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 PrintMsg (const wxString &aText)
 Displays aText in the text panel. More...
 
void PrintPrjInfo ()
 Prints the current working directory name and the project name on the text panel. More...
 
void ClearMsg ()
 Erase 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
 Saves 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
 Function InstallPreferences 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 int 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)
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg)
 
void ShowInfoBarWarning (const wxString &aWarningMsg)
 
void ShowInfoBarMsg (const wxString &aMsg)
 
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)
 Loads 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. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Saves 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. More...
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Returns a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 
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...
 
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 ()
 Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status. More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList) More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList) More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 PopCommandFromRedoList 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)
 
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
 Indicates that hotkeys should perform an immediate action even if another tool is currently active. More...
 
bool GetDragSelects () const
 Indicates that a drag should draw a selection rectangle, even when started over an item. More...
 
bool GetMoveWarpsCursor () const
 Indicates that a move operation should warp the mouse pointer to the origin of the move object. More...
 
virtual void RefreshCanvas ()
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

static void HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
 Handles 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...
 
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...
 

Static Protected Member Functions

static wxString GetBackupSuffix ()
 
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
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 
bool m_isClosing
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
bool m_dragSelects
 
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
 
TREE_PROJECT_FRAMEm_leftWin
 
ACTION_TOOLBARm_launcher
 
wxTextCtrl * m_messagesBox
 
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 41 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

Function ClearUndoORRedoList (virtual).

this function must remove the aItemCount 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

Parameters
aList= the UNDO_REDO_CONTAINER of commands
aItemCount= number of old commands to delete. -1 to remove all old commands this will empty the list of commands. Commands are deleted from the older to the last.
Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 588 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 166 of file kicad_manager_frame.cpp.

167 {
168  // Shutdown all running tools
169  if( m_toolManager )
171 
172  delete m_actions;
173  delete m_toolManager;
174  delete m_toolDispatcher;
175 
176  m_auimgr.UnInit();
177 }
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:49
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:50
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48

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 379 of file eda_base_frame.cpp.

380 {
381  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
382  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
383 
384  helpMenu->Add( ACTIONS::help );
385  helpMenu->Add( ACTIONS::gettingStarted );
386  helpMenu->Add( ACTIONS::listHotKeys );
387  helpMenu->Add( ACTIONS::getInvolved );
388  helpMenu->Add( ACTIONS::reportBug );
389 
390  helpMenu->AppendSeparator();
391  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
392 
393  aMenuBar->Append( helpMenu, _( "&Help" ) );
394 }
static TOOL_ACTION listHotKeys
Definition: actions.h:177
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:43
static TOOL_ACTION reportBug
Definition: actions.h:179
const BITMAP_OPAQUE about_xpm[1]
Definition: about.cpp:84
COMMON_CONTROL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:176
static TOOL_ACTION getInvolved
Definition: actions.h:178
static TOOL_ACTION gettingStarted
Definition: actions.h:175

References _, about_xpm, 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(), LIB_VIEW_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

◆ canCloseWindow()

bool KICAD_MANAGER_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 325 of file kicad_manager_frame.cpp.

326 {
327  KICAD_SETTINGS* settings = kicadSettings();
329 
330  // CloseProject will recursively ask all the open editors if they need to save changes.
331  // If any of them cancel then we need to cancel closing the KICAD_MANAGER_FRAME.
332  if( CloseProject( true ) )
333  {
334  return true;
335  }
336  else
337  {
338  if( aEvent.CanVeto() )
339  aEvent.Veto();
340 
341  return false;
342  }
343 }
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 961 of file eda_base_frame.cpp.

962 {
963  SetUserUnits( aUnits );
965 
966  wxCommandEvent e( UNITS_CHANGED );
967  ProcessEventLocally( e );
968 }
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 859 of file eda_base_frame.cpp.

860 {
861  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
862 
863  wxFileName autoSaveFileName = aFileName;
864 
865  // Check for auto save file.
866  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
867 
868  wxLogTrace( traceAutoSave,
869  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
870 
871  if( !autoSaveFileName.FileExists() )
872  return;
873 
874  wxString msg = wxString::Format( _(
875  "Well this is potentially embarrassing!\n"
876  "It appears that the last time you were editing the file\n"
877  "\"%s\"\n"
878  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
879  aFileName.GetFullName()
880  );
881 
882  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
883 
884  // Make a backup of the current file, delete the file, and rename the auto save file to
885  // the file name.
886  if( response == wxYES )
887  {
888  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
889  {
890  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
891  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
892  }
893  }
894  else
895  {
896  wxLogTrace( traceAutoSave,
897  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
898 
899  // Remove the auto save file when using the previous file as is.
900  wxRemoveFile( autoSaveFileName.GetFullPath() );
901  }
902 }
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:102
static wxString GetAutoSaveFilePrefix()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33

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

Referenced by SCH_EDIT_FRAME::OpenProjectFiles(), and PCB_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 756 of file eda_base_frame.cpp.

757 {
758  if( !aFileHistory )
759  aFileHistory = m_fileHistory;
760 
761  wxASSERT( aFileHistory );
762 
763  aFileHistory->ClearFileHistory();
764 
765  // Update the menubar to update the file history menu
766  if( GetMenuBar() )
767  {
768  ReCreateMenuBar();
769  GetMenuBar()->Refresh();
770  }
771 }
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().

◆ ClearMsg()

void KICAD_MANAGER_FRAME::ClearMsg ( )

Erase the text panel.

Definition at line 615 of file kicad_manager_frame.cpp.

616 {
617  m_messagesBox->Clear();
618 }

References m_messagesBox.

Referenced by CloseProject(), ImportNonKiCadProject(), and KICAD_MANAGER_CONTROL::NewFromTemplate().

◆ 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 380 of file kicad_manager_frame.cpp.

381 {
382  if( !Kiway().PlayersClose( false ) )
383  return false;
384 
385  // Save the project file for the currently loaded project.
386  if( m_active_project )
387  {
388  SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
389 
391 
392  if( aSave )
393  {
394  mgr.SaveProject();
395  }
396 
397  m_active_project = false;
398  mgr.UnloadProject( &Prj() );
399  }
400 
401  ClearMsg();
402 
404 
405  return true;
406 }
KIWAY & Kiway() const
Function Kiway returns 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:102
bool TriggerBackupIfNeeded(REPORTER &aReporter) const
Calls BackupProject if a new backup is needed according to the current backup policy.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
void EmptyTreePrj()
Delete all m_TreeProject entries.
bool UnloadProject(PROJECT *aProject, bool aSave=true)
Saves, unloads and unregisters the given PROJECT.
bool SaveProject(const wxString &aFullPath=wxEmptyString)
Saves a loaded project.
static REPORTER & GetInstance()
Definition: reporter.cpp:105
void ClearMsg()
Erase the text panel.
TREE_PROJECT_FRAME * m_leftWin

References ClearMsg(), TREE_PROJECT_FRAME::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 585 of file kicad_manager_frame.cpp.

586 {
587  EDA_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
588 }
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 234 of file kicad_manager_frame.cpp.

235 {
237  wxASSERT( ret );
238  return ret;
239 }
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:77
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
Returns
a base name prefix used in Load/Save settings to build the full name of keys used in config. 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 config can be used.

Reimplemented from TOOLS_HOLDER.

Definition at line 404 of file eda_base_frame.h.

405  {
406  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
407  return baseCfgName;
408  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ 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 447 of file kicad_manager_frame.cpp.

448 {
449  wxCHECK_RET( aProjectFileName.DirExists() && aProjectFileName.IsDirWritable(),
450  "Project folder must exist and be writable to create a new project." );
451 
452  // If the project is legacy, convert it
453  if( !aProjectFileName.FileExists() )
454  {
455  wxFileName legacyPro( aProjectFileName );
456  legacyPro.SetExt( LegacyProjectFileExtension );
457 
458  if( legacyPro.FileExists() )
459  {
460  GetSettingsManager()->LoadProject( legacyPro.GetFullPath() );
462 
463  wxRemoveFile( legacyPro.GetFullPath() );
464  }
465  else
466  {
467  // Copy template project file from template folder.
468  wxString srcFileName = sys_search().FindValidPath( "kicad.kicad_pro" );
469 
470  wxFileName destFileName( aProjectFileName );
471  destFileName.SetExt( ProjectFileExtension );
472 
473  // Create a minimal project file if the template project file could not be copied
474  if( !wxFileName::FileExists( srcFileName )
475  || !wxCopyFile( srcFileName, destFileName.GetFullPath() ) )
476  {
477  wxFile file( destFileName.GetFullPath(), wxFile::write );
478 
479  if( file.IsOpened() )
480  file.Write( wxT( "{\n}\n") );
481  // wxFile dtor will close the file
482  }
483  }
484  }
485 
486  // Create a "stub" for a schematic root sheet and a board if requested.
487  // It will avoid messages from the schematic editor or the board editor to create a new file
488  // And forces the user to create main files under the right name for the project manager
489  if( aCreateStubFiles )
490  {
491  wxFileName fn( aProjectFileName.GetFullPath() );
492  fn.SetExt( KiCadSchematicFileExtension );
493 
494  // If a <project>.kicad_sch file does not exist, create a "stub" file ( minimal schematic file )
495  if( !fn.FileExists() )
496  {
497  wxFile file( fn.GetFullPath(), wxFile::write );
498 
499  if( file.IsOpened() )
500  file.Write( wxT( "(kicad_sch (version 20200310) (host eeschema \"unknown\")\n"
501  "( page \"A4\")\n (lib_symbols)\n"
502  " (symbol_instances)\n)\n" ) );
503 
504 
505  // wxFile dtor will close the file
506  }
507 
508  // If a <project>.kicad_pcb or <project>.brd file does not exist,
509  // create a .kicad_pcb "stub" file
510  fn.SetExt( KiCadPcbFileExtension );
511  wxFileName leg_fn( fn );
512  leg_fn.SetExt( LegacyPcbFileExtension );
513 
514  if( !fn.FileExists() && !leg_fn.FileExists() )
515  {
516  wxFile file( fn.GetFullPath(), wxFile::write );
517 
518  if( file.IsOpened() )
519  file.Write( wxT( "(kicad_pcb (version 4) (host kicad \"dummy file\") )\n" ) );
520 
521  // wxFile dtor will close the file
522  }
523  }
524 
525  UpdateFileHistory( aProjectFileName.GetFullPath() );
526 
527  m_openSavedWindows = true;
528 }
wxString FindValidPath(const wxString &aFileName) const
Definition: search_stack.h:73
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
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Loads a project or sets up a new project with a specified path.
bool SaveProject(const wxString &aFullPath=wxEmptyString)
Saves a loaded project.
const std::string KiCadSchematicFileExtension
const SEARCH_STACK & sys_search() override
Return a SEARCH_STACK pertaining to entire program.

References SEARCH_STACK::FindValidPath(), EDA_BASE_FRAME::GetSettingsManager(), KiCadPcbFileExtension, KiCadSchematicFileExtension, LegacyPcbFileExtension, LegacyProjectFileExtension, SETTINGS_MANAGER::LoadProject(), m_openSavedWindows, ProjectFileExtension, SETTINGS_MANAGER::SaveProject(), 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:54
static TOOL_ACTION selectionTool
Definition: actions.h:151

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 141 of file tools_holder.h.

141 {};

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 PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 270 of file eda_base_frame.cpp.

271 {
272  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
273 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void KICAD_MANAGER_FRAME::doCloseWindow ( )
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 346 of file kicad_manager_frame.cpp.

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

References m_leftWin.

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

Definition at line 554 of file eda_base_frame.h.

554 { return m_AboutTitle; }
wxString m_AboutTitle

References EDA_BASE_FRAME::m_AboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), and COMMON_CONTROL::ReportBug().

◆ GetAutoSaveFilePrefix()

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

Definition at line 187 of file eda_base_frame.h.

188  {
189  return wxT( "_autosave-" );
190  }

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), SCH_EDIT_FRAME::doAutoSave(), PCB_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 315 of file eda_base_frame.h.

315 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetBackupSuffix()

static wxString EDA_BASE_FRAME::GetBackupSuffix ( )
inlinestaticprotectedinherited
Returns
the suffix to be appended to the file extension on backup

Definition at line 179 of file eda_base_frame.h.

180  {
181  return wxT( "-bak" );
182  }

◆ 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, SCH_EDIT_FRAME, LIB_EDIT_FRAME, LIB_VIEW_FRAME, DISPLAY_FOOTPRINTS_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 123 of file tools_holder.h.

124  {
125  return m_dummySelection;
126  }
SELECTION m_dummySelection
Definition: tools_holder.h:52

References TOOLS_HOLDER::m_dummySelection.

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

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

Indicates 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 147 of file tools_holder.h.

147 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:61

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragSelects()

bool TOOLS_HOLDER::GetDragSelects ( ) const
inlineinherited

Indicates that a drag should draw a selection rectangle, even when started over an item.

Definition at line 153 of file tools_holder.h.

153 { return m_dragSelects; }
bool m_dragSelects
Definition: tools_holder.h:65

References TOOLS_HOLDER::m_dragSelects.

Referenced by PL_SELECTION_TOOL::Main(), and EE_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 init 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 716 of file eda_base_frame.cpp.

718 {
719  if( !aFileHistory )
720  aFileHistory = m_fileHistory;
721 
722  wxASSERT( aFileHistory );
723 
724  int baseId = aFileHistory->GetBaseId();
725 
726  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
727 
728  unsigned i = cmdId - baseId;
729 
730  if( i < aFileHistory->GetCount() )
731  {
732  wxString fn = aFileHistory->GetHistoryFile( i );
733 
734  if( wxFileName::FileExists( fn ) )
735  return fn;
736  else
737  {
738  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
739  wxMessageBox( msg );
740 
741  aFileHistory->RemoveFileFromHistory( i );
742  }
743  }
744 
745  // Update the menubar to update the file history menu
746  if( GetMenuBar() )
747  {
748  ReCreateMenuBar();
749  GetMenuBar()->Refresh();
750  }
751 
752  return wxEmptyString;
753 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#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 470 of file eda_base_frame.h.

471  {
472  return *m_fileHistory;
473  }
FILE_HISTORY * m_fileHistory

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetInfoBar()

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 633 of file eda_base_frame.h.

633 { return m_UndoRedoCountMax; }

References EDA_BASE_FRAME::m_UndoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const
inlineinherited

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

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

Definition at line 159 of file tools_holder.h.

159 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:66

References TOOLS_HOLDER::m_moveWarpsCursor.

Referenced by EDIT_TOOL::doMoveSelection(), LIB_MOVE_TOOL::Main(), and SCH_MOVE_TOOL::Main().

◆ GetMruPath()

◆ GetProjectFileName()

const wxString KICAD_MANAGER_FRAME::GetProjectFileName ( ) const

Definition at line 250 of file kicad_manager_frame.cpp.

251 {
252  return Pgm().GetSettingsManager().IsProjectOpen() ? Prj().GetProjectFullName() : wxString( wxEmptyString );
253 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
VTBL_ENTRY const wxString GetProjectFullName() const
Function GetProjectFullName returns the full path and name of the project.
Definition: project.cpp:115

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

Referenced by TREE_PROJECT_FRAME::AddItemToTreeProject(), TREE_PROJECT_FRAME::FileWatcherReset(), TREE_PROJECT_FRAME::findSubdirTreeItem(), GetCurrentFileName(), OnArchiveFiles(), TREE_PROJECT_FRAME::OnCreateNewDirectory(), TREE_PROJECT_FRAME::OnOpenDirectory(), PcbFileName(), PcbLegacyFileName(), PrintPrjInfo(), ProjectChanged(), TREE_PROJECT_FRAME::ReCreateTreePrj(), SchFileName(), and SchLegacyFileName().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetSettingsManager()

◆ GetSeverity()

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

Reimplemented in PCB_BASE_FRAME.

Definition at line 255 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 228 of file kicad_manager_frame.cpp.

229 {
230  return m_leftWin;
231 }
TREE_PROJECT_FRAME * m_leftWin

References m_leftWin.

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 76 of file tools_holder.h.

76 { return m_toolManager; }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48

References TOOLS_HOLDER::m_toolManager.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), LIB_CONTROL::AddSymbolToSchematic(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), BOARD_COMMIT::BOARD_COMMIT(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), 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_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_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(), LIB_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LIB_EDIT_FRAME::LoadPart(), PCB_EDIT_FRAME::LoadProjectSettings(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), SYMBOL_TREE_PANE::onComponentSelected(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnERCItemSelected(), 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(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::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 ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

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 239 of file eda_base_frame.h.

240  {
241  return m_userUnits;
242  }
EDA_UNITS m_userUnits

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(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), 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(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_MODEDIT_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), MARKER_PCB::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), ZONE_CONTAINER::GetMsgPanelInfo(), WS_DRAW_ITEM_BASE::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), DIMENSION::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), RC_TREE_MODEL::GetValue(), PCB_INSPECTION_TOOL::InspectClearance(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_SELECT_NET_FROM_LIST::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::onUpdateThicknessValue(), 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_FEATURE_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(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and PANEL_SETUP_TRACKS_AND_VIAS::validateData().

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
virtualinherited

Returns 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, LIB_VIEW_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 646 of file eda_base_frame.cpp.

647 {
648  return &aCfg->m_Window;
649 }
WINDOW_SETTINGS m_Window
Definition: app_settings.h:173

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 993 of file eda_base_frame.cpp.

994 {
995 #ifdef __WXGTK__
996  // GTK includes the window decorations in the normal GetSize call,
997  // so we have to use a GTK-specific sizing call that returns the
998  // non-decorated window size.
999  int width = 0;
1000  int height = 0;
1001  GTKDoGetSize( &width, &height );
1002 
1003  wxSize winSize( width, height );
1004 #else
1005  wxSize winSize = GetSize();
1006 #endif
1007 
1008  return winSize;
1009 }

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

◆ HandleUpdateUIEvent()

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

Handles 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 318 of file eda_base_frame.cpp.

320 {
321  bool checkRes = false;
322  bool enableRes = true;
323  bool showRes = true;
324  SELECTION& selection = aFrame->GetCurrentSelection();
325 
326  try
327  {
328  checkRes = aCond.checkCondition( selection );
329  enableRes = aCond.enableCondition( selection );
330  showRes = aCond.showCondition( selection );
331  }
332  catch( std::exception& )
333  {
334  // Something broke with the conditions, just skip the event.
335  aEvent.Skip();
336  return;
337  }
338 
339  aEvent.Enable( enableRes );
340  aEvent.Show( showRes );
341 
342  bool canCheck = true;
343 
344  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
345  // see if they can be and can't just universally apply a check in this event.
346  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
347  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
348 
349  if( canCheck )
350  aEvent.Check( checkRes );
351 }
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:123

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 304 of file kicad_manager_frame.cpp.

305 {
306  return PgmTop().GetHelpFileName();
307 }
PGM_KICAD & PgmTop()
Definition: kicad.cpp:77
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
aActionMap= current hotkey map (over which the imported hotkeys will be applied)
aDefaultShortname= a default short name (extension not needed) like eechema, 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)

Definition at line 50 of file kicad/import_project.cpp.

52 {
53  int style = wxFD_OPEN | wxFD_FILE_MUST_EXIST;
54  wxString default_dir = GetMruPath();
55 
56  ClearMsg();
57 
58  wxFileDialog schdlg( this, aWindowTitle, default_dir, wxEmptyString, aFilesWildcard, style );
59 
60  if( schdlg.ShowModal() == wxID_CANCEL )
61  return;
62 
63 
64  wxFileName sch( schdlg.GetPath() );
65 
66  sch.SetExt( aSchFileExtension );
67 
68  wxFileName pro = sch;
69 
70  pro.SetExt( ProjectFileExtension );
71 
72  wxString protitle = _( "KiCad Project Destination" );
73 
74  // Don't use wxFileDialog here. On GTK builds, the default path is returned unless a
75  // file is actually selected.
76  wxDirDialog prodlg( this, protitle, pro.GetPath(), wxDD_DEFAULT_STYLE );
77 
78  if( prodlg.ShowModal() == wxID_CANCEL )
79  return;
80 
81  pro.SetPath( prodlg.GetPath() );
82 
83  // Check if the project directory is empty
84  wxDir directory( pro.GetPath() );
85 
86  if( directory.HasFiles() )
87  {
88  wxString msg =
89  _( "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  // and try to create it
100  pro.AppendDir( pro.GetName() );
101 
102  if( !wxMkdir( pro.GetPath() ) )
103  // There was a problem, undo
104  pro.RemoveLastDir();
105  }
106  }
107 
108  wxFileName pcb( sch );
109  std::string packet;
110 
111  pro.SetExt( ProjectFileExtension );
112  pcb.SetExt( aPcbFileExtension ); // enforce extension
113 
114  if( !pro.IsAbsolute() )
115  pro.MakeAbsolute();
116 
117  // Close the project and make the new one
118  CloseProject( true );
119  CreateNewProject( pro.GetFullPath(), false /* Don't create stub files */ );
120  LoadProject( pro );
121 
122  if( sch.FileExists() )
123  {
124  KIWAY_PLAYER* schframe = Kiway().Player( FRAME_SCH, true );
125 
126  packet = StrPrintf( "%d\n%s", aSchFileType, TO_UTF8( sch.GetFullPath() ) );
127  schframe->Kiway().ExpressMail( FRAME_SCH, MAIL_IMPORT_FILE, packet, this );
128 
129  if( !schframe->IsShown() )
130  schframe->Show( true );
131 
132  // On Windows, Raise() does not bring the window on screen, when iconized
133  if( schframe->IsIconized() )
134  schframe->Iconize( false );
135 
136  schframe->Raise();
137  }
138 
139  if( pcb.FileExists() )
140  {
141  KIWAY_PLAYER* pcbframe = Kiway().Player( FRAME_PCB_EDITOR, true );
142 
143  if( !pcbframe->IsVisible() )
144  pcbframe->Show( true );
145 
146  packet = StrPrintf( "%d\n%s", aPcbFileType, TO_UTF8( pcb.GetFullPath() ) );
147  pcbframe->Kiway().ExpressMail( FRAME_PCB_EDITOR, MAIL_IMPORT_FILE, packet, this );
148 
149  // On Windows, Raise() does not bring the window on screen, when iconized
150  if( pcbframe->IsIconized() )
151  pcbframe->Iconize( false );
152 
153  pcbframe->Raise();
154  }
155 
156  ReCreateTreePrj();
157  m_active_project = true;
158 }
KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of ...
Definition: kiway_player.h:61
KIWAY & Kiway() const
Function Kiway returns 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:44
const std::string ProjectFileExtension
int StrPrintf(std::string *result, const char *format,...)
Function StrPrintf is like sprintf() but the output is appended to a std::string instead of to a char...
Definition: richio.cpp:78
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:95
wxString GetMruPath() const
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:343
void CreateNewProject(const wxFileName &aProjectFileName, bool aCreateStubFiles=true)
Creates a new project by setting up and initial project, schematic, and board files.
bool CloseProject(bool aSave)
Closes the project, and saves it if aSave is true;.
VTBL_ENTRY void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=NULL)
Function ExpressMail send aPayload to aDestination from aSource.
Definition: kiway.cpp:437
#define _(s)
Definition: 3d_actions.cpp:33
void LoadProject(const wxFileName &aProjectFileName)
void ClearMsg()
Erase the text panel.

References _, ClearMsg(), CloseProject(), CreateNewProject(), KIDIALOG::DoNotShowCheckbox(), KIWAY::ExpressMail(), 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().

◆ InstallPreferences()

void KICAD_MANAGER_FRAME::InstallPreferences ( PAGED_DIALOG ,
PANEL_HOTKEYS_EDITOR  
)
overridevirtual

Function InstallPreferences 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 645 of file kicad_manager_frame.cpp.

647 {
648  aHotkeysPanel->AddHotKeys( GetToolManager() );
649 }
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:76

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 PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 202 of file eda_base_frame.h.

202 { 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 PCB_EDIT_FRAME, SCH_EDIT_FRAME, CVPCB_MAINFRAME, LIB_EDIT_FRAME, PL_EDITOR_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 905 of file eda_base_frame.cpp.

906 {
907  // This function should be overridden in child classes
908  return false;
909 }

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:54
static TOOL_ACTION selectionTool
Definition: actions.h:151
const std::string & GetName() const
Returns name of the action.
Definition: tool_action.h:75

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

Referenced by PCB_INSPECTION_TOOL::HighlightNetTool(), SCH_EDIT_TOOL::Init(), PCB_EDITOR_CONTROL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), EDIT_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().

◆ IsProjectActive()

bool KICAD_MANAGER_FRAME::IsProjectActive ( )

Definition at line 659 of file kicad_manager_frame.cpp.

660 {
661  return m_active_project;
662 }

References m_active_project.

Referenced by KICAD_MANAGER_CONTROL::Execute().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 317 of file eda_base_frame.h.

317 { return m_Ident == aType; }

References EDA_BASE_FRAME::m_Ident.

Referenced by LIB_CONTROL::AddLibrary(), PCBNEW_CONTROL::AddLibrary(), EDA_DRAW_FRAME::AddStandardSubMenus(), LIB_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(), LIB_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::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), COMMON_TOOLS::doZoomFit(), LIB_CONTROL::DuplicateSymbol(), LIB_CONTROL::EditSymbol(), LIB_CONTROL::ExportSymbol(), MODULE::GetMsgPanelInfo(), CONVERT_TOOL::Init(), LIB_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), CONVERT_TOOL::LinesToPoly(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), LIB_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCBNEW_CONTROL::Paste(), LIB_CONTROL::PinLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), LIB_CONTROL::Revert(), EE_INSPECTION_TOOL::RunERC(), LIB_CONTROL::Save(), LIB_CONTROL::ShowComponentTree(), EE_INSPECTION_TOOL::ShowDatasheet(), and LIB_CONTROL::UnpinLibrary().

◆ 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 815 of file eda_base_frame.cpp.

816 {
817  wxString msg;
818  wxFileName fn = aFileName;
819 
820  // Check for absence of a file path with a file name. Unfortunately KiCad
821  // uses paths relative to the current project path without the ./ part which
822  // confuses wxFileName. Making the file name path absolute may be less than
823  // elegant but it solves the problem.
824  if( fn.GetPath().IsEmpty() && fn.HasName() )
825  fn.MakeAbsolute();
826 
827  wxCHECK_MSG( fn.IsOk(), false,
828  wxT( "File name object is invalid. Bad programmer!" ) );
829  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
830  wxT( "File name object path <" ) + fn.GetFullPath() +
831  wxT( "> is not set. Bad programmer!" ) );
832 
833  if( fn.IsDir() && !fn.IsDirWritable() )
834  {
835  msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
836  fn.GetPath() );
837  }
838  else if( !fn.FileExists() && !fn.IsDirWritable() )
839  {
840  msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
841  fn.GetFullName(), fn.GetPath() );
842  }
843  else if( fn.FileExists() && !fn.IsFileWritable() )
844  {
845  msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
846  fn.GetFullPath() );
847  }
848 
849  if( !msg.IsEmpty() )
850  {
851  wxMessageBox( msg );
852  return false;
853  }
854 
855  return true;
856 }
#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 242 of file kicad_manager_frame.cpp.

243 {
244  KICAD_SETTINGS* ret = dynamic_cast<KICAD_SETTINGS*>( config() );
245  wxASSERT( ret );
246  return ret;
247 }
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

Function Kiway returns 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:81

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), LIB_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), 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(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), PCB_EDIT_FRAME::importFile(), 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(), LIB_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_COMPONENT::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::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), 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(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), LIB_CONTROL::UpdateSymbolInSchematic(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ language_change()

void KICAD_MANAGER_FRAME::language_change ( wxCommandEvent &  event)
private

Definition at line 565 of file kicad_manager_frame.cpp.

566 {
567  int id = event.GetId();
568  Kiway().SetLanguage( id );
569 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY void SetLanguage(int aLanguage)
Function SetLanguage changes the language and then calls ShowChangedLanguage() on all KIWAY_PLAYERs.
Definition: kiway.cpp:445

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

◆ LoadProject()

void KICAD_MANAGER_FRAME::LoadProject ( const wxFileName &  aProjectFileName)

Definition at line 409 of file kicad_manager_frame.cpp.

410 {
411  // The project file should be valid by the time we get here or something has gone wrong.
412  if( !aProjectFileName.Exists() )
413  return;
414 
415  // Any open KIFACE's must be closed if they are not part of the new project.
416  // (We never want a KIWAY_PLAYER open on a KIWAY that isn't in the same project.)
417  // User is prompted here to close those KIWAY_PLAYERs:
418  CloseProject( true );
419 
420  m_active_project = true;
421 
422  Pgm().GetSettingsManager().LoadProject( aProjectFileName.GetFullPath() );
423 
424  LoadWindowState( aProjectFileName.GetFullName() );
425 
426  if( aProjectFileName.IsDirWritable() )
427  SetMruPath( Prj().GetProjectPath() ); // Only set MRU path if we have write access. Why?
428 
429  UpdateFileHistory( Prj().GetProjectFullName() );
430 
432 
433  // Rebuild the list of watched paths.
434  // however this is possible only when the main loop event handler is running,
435  // so we use it to run the rebuild function.
436  wxCommandEvent cmd( wxEVT_COMMAND_MENU_SELECTED, ID_INIT_WATCHED_PATHS );
437 
438  wxPostEvent( this, cmd );
439 
440  PrintPrjInfo();
441 
442  KIPLATFORM::APP::RegisterApplicationRestart( aProjectFileName.GetFullPath() );
443  m_openSavedWindows = true;
444 }
void SetMruPath(const wxString &aPath)
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
void LoadWindowState(const wxString &aFileName)
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:121
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
void ReCreateTreePrj()
Create or modify the tree showing project file names.
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.
TREE_PROJECT_FRAME * m_leftWin
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:26

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

Referenced by TREEPROJECT_ITEM::Activate(), ImportNonKiCadProject(), PGM_KICAD::MacOpenFile(), KICAD_MANAGER_CONTROL::NewFromTemplate(), KICAD_MANAGER_CONTROL::NewProject(), OnFileHistory(), PGM_KICAD::OnPgmInit(), TREE_PROJECT_FRAME::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 621 of file kicad_manager_frame.cpp.

622 {
624 
625  auto settings = dynamic_cast<KICAD_SETTINGS*>( aCfg );
626 
627  wxCHECK( settings, /*void*/);
628 
629  m_leftWinWidth = settings->m_LeftWinWidth;
630 }
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

Loads 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 546 of file eda_base_frame.cpp.

547 {
548  LoadWindowState( aCfg->state );
549 
550  if( m_hasAutoSave )
551  m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
552 
553  m_perspective = aCfg->perspective;
554  m_mruPath = aCfg->mru_path;
555 
556  TOOLS_HOLDER::CommonSettingsChanged( false, false );
557 }
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:102
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 428 of file eda_base_frame.cpp.

429 {
430  if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
431  return;
432 
433  const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
434 
435  if( state != nullptr )
436  {
437  LoadWindowState( state->window );
438  }
439 }
VTBL_ENTRY PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:149
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
void LoadWindowState(const wxString &aFileName)
PROJECT & Prj() const
Function Prj returns 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 442 of file eda_base_frame.cpp.

443 {
444  bool wasDefault = false;
445 
446  m_FramePos.x = aState.pos_x;
447  m_FramePos.y = aState.pos_y;
448  m_FrameSize.x = aState.size_x;
449  m_FrameSize.y = aState.size_y;
450 
451  wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
453 
454  // Ensure minimum size is set if the stored config was zero-initialized
456  {
459  wasDefault = true;
460 
461  wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_FrameSize.x, m_FrameSize.y );
462  }
463 
464  wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
465 
466  if( aState.display >= wxDisplay::GetCount() )
467  {
468  wxLogTrace( traceDisplayLocation, "Previous display not found" );
469 
470  // If it isn't attached, use the first display
471  // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
472  const unsigned int index = 0;
473  wxDisplay display( index );
474  wxRect clientSize = display.GetGeometry();
475 
476  m_FramePos = wxDefaultPosition;
477 
478  // Ensure the window fits on the display, since the other one could have been larger
479  if( m_FrameSize.x > clientSize.width )
480  m_FrameSize.x = clientSize.width;
481 
482  if( m_FrameSize.y > clientSize.height )
483  m_FrameSize.y = clientSize.height;
484  }
485  else
486  {
487  wxPoint upperRight( m_FramePos.x + m_FrameSize.x, m_FramePos.y );
488  wxPoint upperLeft( m_FramePos.x, m_FramePos.y );
489 
490  wxDisplay display( aState.display );
491  wxRect clientSize = display.GetClientArea();
492 
493  // The percentage size (represented in decimal) of the region around the screen's border where
494  // an upper corner is not allowed
495 #define SCREEN_BORDER_REGION 0.10
496 
497  int yLim = clientSize.y + ( clientSize.height * ( 1.0 - SCREEN_BORDER_REGION ) );
498  int xLimLeft = clientSize.x + ( clientSize.width * SCREEN_BORDER_REGION );
499  int xLimRight = clientSize.x + ( clientSize.width * ( 1.0 - SCREEN_BORDER_REGION ) );
500 
501  if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
502  upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
503  upperRight.y > yLim ) // Upper corner too close to the bottom of the screen
504  {
505  m_FramePos = wxDefaultPosition;
506  wxLogTrace( traceDisplayLocation, "Resetting to default position" );
507  }
508  }
509 
510  // Ensure Window title bar is visible
511 #if defined( __WXOSX__ )
512  // for macOSX, the window must be below system (macOSX) toolbar
513  int Ypos_min = 20;
514 #else
515  int Ypos_min = 0;
516 #endif
517  if( m_FramePos.y < Ypos_min )
518  m_FramePos.y = Ypos_min;
519 
520  wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
522 
523  SetSize( m_FramePos.x, m_FramePos.y, m_FrameSize.x, m_FrameSize.y );
524 
525  // Center the window if we reset to default
526  if( m_FramePos.x == -1 )
527  {
528  wxLogTrace( traceDisplayLocation, "Centering window" );
529  Center();
530  m_FramePos = GetPosition();
531  }
532 
533  // Record the frame sizes in an un-maximized state
536 
537  // Maximize if we were maximized before
538  if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
539  {
540  wxLogTrace( traceDisplayLocation, "Maximizing window" );
541  Maximize();
542  }
543 }
static const int s_defaultSize_x
static const int s_defaultSize_y
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxSize m_NormalFrameSize
#define SCREEN_BORDER_REGION
static const int s_minsize_x
static const int s_minsize_y
unsigned int display
Definition: app_settings.h:75
wxPoint m_NormalFramePos

References PCAD2KICAD::Center, WINDOW_STATE::display, EDA_BASE_FRAME::m_FramePos, EDA_BASE_FRAME::m_FrameSize, EDA_BASE_FRAME::m_maximizeByDefault, EDA_BASE_FRAME::m_NormalFramePos, EDA_BASE_FRAME::m_NormalFrameSize, WINDOW_STATE::maximized, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, s_defaultSize_x, s_defaultSize_y, s_minsize_x, s_minsize_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 635 of file eda_base_frame.h.

636  {
637  m_isNonUserClose = true;
638  return Close( aForce );
639  }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ OnArchiveFiles()

void KICAD_MANAGER_FRAME::OnArchiveFiles ( wxCommandEvent &  event)

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

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

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

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 263 of file eda_base_frame.cpp.

264 {
265  if( !doAutoSave() )
266  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
267 }
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 552 of file kicad_manager_frame.cpp.

553 {
554  // open project directory in host OS's file explorer
555  LaunchExternal( Prj().GetProjectPath() );
556 }
PROJECT & Prj() const
Function Prj returns 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 1276 of file tree_project_frame.cpp.

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

References TREE_PROJECT_FRAME::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 276 of file eda_base_frame.cpp.

277 {
278  wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( event ) );
279  // Key events can be filtered here.
280  // Currently no filtering is made.
281  event.Skip();
282 }
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 50 of file kicad/files-io.cpp.

51 {
53 }
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 374 of file kicad_manager_frame.cpp.

375 {
376  Close( true );
377 }

◆ OnFileHistory()

void KICAD_MANAGER_FRAME::OnFileHistory ( wxCommandEvent &  event)

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

41 {
42  wxFileName projFileName = GetFileFromHistory( event.GetId(), _( "KiCad project file" ) );
43  if( !projFileName.FileExists() )
44  return;
45 
46  LoadProject( projFileName );
47 }
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 665 of file kicad_manager_frame.cpp.

666 {
672  if( !m_openSavedWindows )
673  return;
674 
675  m_openSavedWindows = false;
676 
677  if( Pgm().GetCommonSettings()->m_Session.remember_open_files )
678  {
679  int previousOpenCount =
680  std::count_if( Prj().GetLocalSettings().m_files.begin(),
681  Prj().GetLocalSettings().m_files.end(),
682  [&]( const PROJECT_FILE_STATE& f )
683  {
684  return !f.fileName.EndsWith( ProjectFileExtension ) && f.open;
685  } );
686 
687  if( previousOpenCount > 0 )
688  {
689  APP_PROGRESS_DIALOG progressReporter( _( "Restoring session" ), wxEmptyString,
690  previousOpenCount, this );
691 
692  int i = 0;
693 
694  for( const PROJECT_FILE_STATE& file : Prj().GetLocalSettings().m_files )
695  {
696  if( file.open )
697  {
698  progressReporter.Update( i++,
699  wxString::Format( _( "Restoring \"%s\"" ), file.fileName ) );
700 
701  wxFileName fn( file.fileName );
702 
703  if( fn.GetExt() == LegacySchematicFileExtension
704  || fn.GetExt() == KiCadSchematicFileExtension )
705  {
707  }
708  else if( fn.GetExt() == LegacyPcbFileExtension
709  || fn.GetExt() == KiCadPcbFileExtension )
710  {
712  }
713  }
714 
715  wxYield();
716  }
717  }
718  }
719 
720  // clear file states regardless if we opened windows or not due to setting
722 }
const std::string ProjectFileExtension
const std::string LegacyPcbFileExtension
VTBL_ENTRY PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:149
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs 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:102
static TOOL_ACTION editSchematic
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
const std::string LegacySchematicFileExtension
static TOOL_ACTION editPCB
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#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:76
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 161 of file kicad/import_project.cpp.

162 {
163  ImportNonKiCadProject( _( "Import CADSTAR Archive Project Files" ),
164  CadstarArchiveFilesWildcard(), "csa", "cpa", SCH_IO_MGR::SCH_CADSTAR_ARCHIVE,
166 }
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 169 of file kicad/import_project.cpp.

170 {
171  ImportNonKiCadProject( _( "Import Eagle Project Files" ), EagleFilesWildcard(),
173  SCH_IO_MGR::SCH_EAGLE, IO_MGR::EAGLE );
174 }
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 774 of file eda_base_frame.cpp.

775 {
776  void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
777  ShowAboutDialog( this );
778 }
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 971 of file eda_base_frame.cpp.

972 {
973  // When we maximize the window, we want to save the old information
974  // so that we can add it to the settings on next window load.
975  // Contrary to the documentation, this event seems to be generated
976  // when the window is also being unmaximized on OSX, so we only
977  // capture the size information when we maximize the window when on OSX.
978 #ifdef __WXOSX__
979  if( !IsMaximized() )
980 #endif
981  {
983  m_NormalFramePos = GetPosition();
984  wxLogTrace( traceDisplayLocation, "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
986  }
987 
988  // Skip event to actually maximize the window
989  aEvent.Skip();
990 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxSize m_NormalFrameSize
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.
wxPoint m_NormalFramePos

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 285 of file eda_base_frame.cpp.

286 {
287  if( !m_toolDispatcher )
288  aEvent.Skip();
289  else
291 }
virtual void DispatchWxEvent(wxEvent &aEvent)
Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs, and makes tools handle those.
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:50

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 306 of file eda_base_frame.h.

307  {
308  aEvent.Skip();
309  }

◆ OnOpenFileInTextEditor()

void KICAD_MANAGER_FRAME::OnOpenFileInTextEditor ( wxCommandEvent &  event)

Definition at line 531 of file kicad_manager_frame.cpp.

532 {
533  // show all files in file dialog (in Kicad all files are editable texts):
534  wxString wildcard = AllFilesWildcard();
535 
536  wxString default_dir = Prj().GetProjectPath();
537 
538  wxFileDialog dlg( this, _( "Load File to Edit" ), default_dir,
539  wxEmptyString, wildcard, wxFD_OPEN );
540 
541  if( dlg.ShowModal() == wxID_CANCEL )
542  return;
543 
544  wxString filename = wxT( "\"" );
545  filename += dlg.GetPath() + wxT( "\"" );
546 
547  if( !dlg.GetPath().IsEmpty() && !Pgm().GetEditorName().IsEmpty() )
549 }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:121
wxString AllFilesWildcard()
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
#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 781 of file eda_base_frame.cpp.

782 {
783  PAGED_DIALOG dlg( this, _( "Preferences" ), true );
784  wxTreebook* book = dlg.GetTreebook();
785 
786  book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
787 
788  book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
789 
790  PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
791  book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
792 
793  for( unsigned i = 0; i < KIWAY_PLAYER_COUNT; ++i )
794  {
795  KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
796 
797  if( frame )
798  frame->InstallPreferences( &dlg, hotkeysPanel );
799  }
800 
801  // The Kicad manager frame is not a player so we have to add it by hand
802  wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
803 
804  if( manager )
805  static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
806 
807  for( size_t i = 0; i < book->GetPageCount(); ++i )
808  book->GetPage( i )->Layout();
809 
810  if( dlg.ShowModal() == wxID_OK )
811  dlg.Kiway().CommonSettingsChanged( false, false );
812 }
KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of ...
Definition: kiway_player.h:61
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
FRAME_T
Enum FRAME_T is the set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:34
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:343
#define KICAD_MANAGER_FRAME_NAME
#define _(s)
Definition: 3d_actions.cpp:33
virtual void InstallPreferences(PAGED_DIALOG *, PANEL_HOTKEYS_EDITOR *)
Function InstallPreferences Allow a frame to load its preference panels (if any) into the preferences...

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 316 of file kicad_manager_frame.cpp.

317 {
318  if( m_auimgr.GetManagedWindow() )
319  m_auimgr.Update();
320 
321  event.Skip();
322 }
wxAuiManager m_auimgr

References EDA_BASE_FRAME::m_auimgr.

◆ OnUnarchiveFiles()

void KICAD_MANAGER_FRAME::OnUnarchiveFiles ( wxCommandEvent &  event)

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

57 {
58  wxFileName fn = Prj().GetProjectFullName();
59 
60  fn.SetExt( ArchiveFileExtension );
61 
62  wxFileDialog zipfiledlg( this, _( "Unzip Project" ), fn.GetPath(),
63  fn.GetFullName(), ZipFileWildcard(),
64  wxFD_OPEN | wxFD_FILE_MUST_EXIST );
65 
66  if( zipfiledlg.ShowModal() == wxID_CANCEL )
67  return;
68 
69  wxString msg = wxString::Format( _( "\nOpen \"%s\"\n" ), zipfiledlg.GetPath() );
70  PrintMsg( msg );
71 
72  wxDirDialog dirDlg( this, _( "Target Directory" ), fn.GetPath(), wxDD_DEFAULT_STYLE );
73 
74  if( dirDlg.ShowModal() == wxID_CANCEL )
75  return;
76 
77  wxString unzipDir = dirDlg.GetPath() + wxT( "/" );
78  msg.Printf( _( "Unzipping project in \"%s\"\n" ), unzipDir );
79  PrintMsg( msg );
80 
81  if( unzipDir == Prj().GetProjectPath() )
82  {
83  if( !Kiway().PlayersClose( false ) )
84  return;
85  }
86 
88 
89  PROJECT_ARCHIVER archiver;
90 
91  archiver.Unarchive( zipfiledlg.GetPath(), unzipDir, reporter );
92 
93  if( unzipDir == Prj().GetProjectPath() )
94  {
95  wxString prjPath = Prj().GetProjectFullName();
96 
97  SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
98 
99  mgr.UnloadProject( &Prj(), false );
100  mgr.LoadProject( prjPath );
101 
103  }
104 }
KIWAY & Kiway() const
Function Kiway returns 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:102
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:121
WX_TEXT_CTRL_REPORTER is wrapper for reporting to a wxTextCtrl object.
Definition: reporter.h:136
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 ...
void PrintMsg(const wxString &aText)
Displays aText in the text panel.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
VTBL_ENTRY const wxString GetProjectFullName() const
Function GetProjectFullName returns the full path and name of the project.
Definition: project.cpp:115
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Loads a project or sets up a new project with a specified path.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#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(), m_messagesBox, Pgm(), PrintMsg(), KIWAY_HOLDER::Prj(), RefreshProjectTree(), PROJECT_ARCHIVER::Unarchive(), SETTINGS_MANAGER::UnloadProject(), and ZipFileWildcard().

◆ PcbFileName()

const wxString KICAD_MANAGER_FRAME::PcbFileName ( )

Definition at line 274 of file kicad_manager_frame.cpp.

275 {
276  wxFileName fn( GetProjectFileName() );
277 
278  fn.SetExt( PcbFileExtension );
279  return fn.GetFullPath();
280 }
const wxString GetProjectFileName() const
#define PcbFileExtension

References GetProjectFileName(), and PcbFileExtension.

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

◆ PcbLegacyFileName()

const wxString KICAD_MANAGER_FRAME::PcbLegacyFileName ( )

Definition at line 283 of file kicad_manager_frame.cpp.

284 {
285  wxFileName fn( GetProjectFileName() );
286 
287  fn.SetExt( LegacyPcbFileExtension );
288  return fn.GetFullPath();
289 }
const wxString GetProjectFileName() const
const std::string LegacyPcbFileExtension

References GetProjectFileName(), and LegacyPcbFileExtension.

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

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )
virtualinherited

PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted.

Definition at line 955 of file eda_base_frame.cpp.

956 {
957  return m_redoList.PopCommand();
958 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_redoList

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

Referenced by LIB_EDIT_FRAME::GetComponentFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), and SCH_EDITOR_CONTROL::Redo().

◆ PopCommandFromUndoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromUndoList ( )
virtualinherited

◆ PopTool()

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

Definition at line 61 of file tools_holder.cpp.

62 {
63  // Push/pop events can get out of order (such as when they're generated by the Simulator
64  // frame but not processed until the mouse is back in the Schematic frame), so make sure
65  // we're popping the right stack frame.
66 
67  for( int i = (int) m_toolStack.size() - 1; i >= 0; --i )
68  {
69  if( m_toolStack[ i ] == actionName )
70  {
71  m_toolStack.erase( m_toolStack.begin() + i );
72 
73  // If there's something underneath us, and it's now the top of the stack, then
74  // re-activate it
75  if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
76  {
77  std::string back = m_toolStack[ i ];
79 
80  if( action )
81  {
82  // Pop the action as running it will push it back onto the stack
83  m_toolStack.pop_back();
84 
85  TOOL_EVENT evt = action->MakeEvent();
86  evt.SetHasPosition( false );
87  GetToolManager()->PostEvent( evt );
88  }
89  }
90  else
92 
93  return;
94  }
95  }
96 }
virtual void DisplayToolMsg(const wxString &msg)
Definition: tools_holder.h:141
TOOL_ACTION * FindAction(const std::string &aActionName) const
Finds an action with a given name (if there is one available).
TOOL_EVENT.
Definition: tool_event.h:171
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
std::vector< std::string > m_toolStack
Definition: tools_holder.h:54
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:200
Represents a single user action.
Definition: tool_action.h:44
TOOL_EVENT MakeEvent() const
Returns the event associated with the action (i.e.
Definition: tool_action.h:113
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:76
void PostEvent(const TOOL_EVENT &aEvent)
Puts an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:274
static TOOL_ACTION selectionTool
Definition: actions.h:151
void SetHasPosition(bool aHasPosition)
Definition: tool_event.h:261

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, and TOOL_EVENT::SetHasPosition().

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(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintMsg()

void KICAD_MANAGER_FRAME::PrintMsg ( const wxString &  aText)

Displays aText in the text panel.

Parameters
aTextThe text to display.

Definition at line 310 of file kicad_manager_frame.cpp.

311 {
312  m_messagesBox->AppendText( aText );
313 }

References m_messagesBox.

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

◆ PrintPrjInfo()

void KICAD_MANAGER_FRAME::PrintPrjInfo ( )

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

Definition at line 652 of file kicad_manager_frame.cpp.

653 {
654  wxString msg = wxString::Format( _( "Project name:\n%s\n" ), GetProjectFileName() );
655  PrintMsg( msg );
656 }
const wxString GetProjectFileName() const
void PrintMsg(const wxString &aText)
Displays aText in the text panel.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33

References _, Format(), GetProjectFileName(), and PrintMsg().

Referenced by LoadProject(), and ShowChangedLanguage().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Function Prj returns 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
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:173

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_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::DeleteModuleFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), PCB_BASE_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(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_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(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::HarvestFootprintsToLibrary(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_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_COMPONENT::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_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_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_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_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), 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 205 of file eda_base_frame.cpp.

206 {
207 #ifdef __WXMAC__
208  // Apple in its infinite wisdom will raise a disabled window before even passing
209  // us the event, so we have no way to stop it. Instead, we have to catch an
210  // improperly ordered disabled window and quasi-modal dialog here and reorder
211  // them.
212  if( !IsEnabled() && IsActive() )
213  {
214  wxWindow* dlg = findQuasiModalDialog();
215  if( dlg )
216  dlg->Raise();
217  }
218 #endif
219 
220  if( !wxFrame::ProcessEvent( aEvent ) )
221  return false;
222 
223  if( IsShown() && m_hasAutoSave && IsActive() &&
225  {
226  if( !m_autoSaveState )
227  {
228  wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
229  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
230  m_autoSaveState = true;
231  }
232  else if( m_autoSaveTimer->IsRunning() )
233  {
234  wxLogTrace( traceAutoSave, wxT( "Stopping auto save timer." ) );
235  m_autoSaveTimer->Stop();
236  m_autoSaveState = false;
237  }
238  }
239 
240  return true;
241 }
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(), LIB_VIEW_FRAME::onSelectNextSymbol(), LIB_VIEW_FRAME::onSelectPreviousSymbol(), KIWAY::ProcessEvent(), and LIB_VIEW_FRAME::ReCreateListCmp().

◆ ProjectChanged()

void KICAD_MANAGER_FRAME::ProjectChanged ( )
overridevirtual

Notification event that the project has changed.

Reimplemented from EDA_BASE_FRAME.

Definition at line 591 of file kicad_manager_frame.cpp.

592 {
593  wxString app = wxS( "KiCad " ) + GetMajorMinorVersion();
594  wxString file = GetProjectFileName();
595  wxString title;
596 
597  if( !file.IsEmpty() )
598  {
599  wxFileName fn( file );
600 
601  title += fn.GetName();
602 
603  if( !fn.IsDirWritable() )
604  title += wxS( " " ) + _( "[Read Only]" );
605 
606  title += wxS(" \u2014 ");
607  }
608 
609  title += app;
610 
611  SetTitle( title );
612 }
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

Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList)

Definition at line 934 of file eda_base_frame.cpp.

935 {
936  m_redoList.PushCommand( aNewitem );
937 
938  // Delete the extra items, if count max reached
939  if( m_UndoRedoCountMax > 0 )
940  {
941  int extraitems = GetRedoCommandCount() - m_UndoRedoCountMax;
942 
943  if( extraitems > 0 )
944  ClearUndoORRedoList( REDO_LIST, extraitems );
945  }
946 }
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 LIB_EDIT_FRAME::GetComponentFromUndoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList)

Definition at line 919 of file eda_base_frame.cpp.

920 {
921  m_undoList.PushCommand( aNewitem );
922 
923  // Delete the extra items, if count max reached
924  if( m_UndoRedoCountMax > 0 )
925  {
926  int extraitems = GetUndoCommandCount() - m_UndoRedoCountMax;
927 
928  if( extraitems > 0 )
929  ClearUndoORRedoList( UNDO_LIST, extraitems );
930  }
931 }
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 LIB_EDIT_FRAME::GetComponentFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), SCH_EDITOR_CONTROL::Redo(), PL_EDITOR_FRAME::SaveCopyInUndoList(), LIB_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ 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 44 of file tools_holder.cpp.

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

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(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_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 190 of file kicad/menubar.cpp.

191 {
192  if( m_mainToolBar )
193  {
195  }
196  else
197  {
198  m_mainToolBar = new ACTION_TOOLBAR( this, ID_H_TOOLBAR, wxDefaultPosition, wxDefaultSize,
199  KICAD_AUI_TB_STYLE | wxAUI_TB_HORZ_LAYOUT );
201  }
202 
203  // New
207 
209  m_mainToolBar->AddTool( ID_SAVE_AND_ZIP_FILES, wxEmptyString,
210  KiScaledBitmap( zip_xpm, this ),
211  _( "Archive all project files" ) );
212 
213  m_mainToolBar->AddTool( ID_READ_ZIP_ARCHIVE, wxEmptyString,
214  KiScaledBitmap( unzip_xpm, this ),
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
ACTION_TOOLBAR.
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)
Adds a TOOL_ACTION-based button to the toolbar.
const BITMAP_OPAQUE directory_browser_xpm[1]
const BITMAP_OPAQUE zip_xpm[1]
Definition: zip.cpp:60
static TOOL_ACTION newFromTemplate
void SetAuiManager(wxAuiManager *aManager)
Set the AUI manager that this toolbar belongs to.
wxAuiManager m_auimgr
wxBitmap KiScaledBitmap(BITMAP_DEF aBitmap, wxWindow *aWindow)
Construct a wxBitmap from a memory record, scaling it if device DPI demands it.
Definition: bitmap.cpp:118
static TOOL_ACTION openProject
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION zoomRedraw
Definition: actions.h:88
static constexpr int KICAD_AUI_TB_STYLE
Default style flags used for wxAUI toolbars
ACTION_TOOLBAR * m_mainToolBar
const BITMAP_OPAQUE unzip_xpm[1]
Definition: unzip.cpp:61
void ClearToolbar()
Clear the toolbar and remove all associated menus.

References _, ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddScaledSeparator(), ACTION_TOOLBAR::ClearToolbar(), directory_browser_xpm, 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::newFromTemplate, KICAD_MANAGER_ACTIONS::newProject, KICAD_MANAGER_ACTIONS::openProject, ACTION_TOOLBAR::SetAuiManager(), unzip_xpm, zip_xpm, and ACTIONS::zoomRedraw.

Referenced by ShowChangedLanguage().

◆ RecreateLauncher()

void KICAD_MANAGER_FRAME::RecreateLauncher ( )

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

235 {
236  if( m_launcher )
237  {
238  m_launcher->Clear();
239  }
240  else
241  {
242  m_launcher = new ACTION_TOOLBAR( this, ID_H_TOOLBAR, wxDefaultPosition, wxDefaultSize,
243  KICAD_AUI_TB_STYLE | wxAUI_TB_HORZ_LAYOUT );
245  }
246 
247  // Add tools. Note these KICAD_MANAGER_ACTIONS are defined with a bitmap
248  // suitable for menus. The icans will be changed later.
251 
255 
261 
262  // Now set big icons for these tools:
266  KiScaledBitmap( icon_libedit_xpm, this ) );
268  KiScaledBitmap( icon_pcbnew_xpm, this ) );
270  KiScaledBitmap( icon_modedit_xpm, this ) );
279 
280  // Create mlauncher
281  m_launcher->Realize();
282 }
ACTION_TOOLBAR.
void AddScaledSeparator(wxWindow *aWindow)
Add a separator that introduces space on either side to not squash the tools when scaled.
static TOOL_ACTION showCalculator
void Add(const TOOL_ACTION &aAction, bool aIsToggleEntry=false, bool aIsCancellable=false)
Adds a TOOL_ACTION-based button to the toolbar.
static TOOL_ACTION viewGerbers
const BITMAP_OPAQUE icon_pcbcalculator_xpm[1]
const BITMAP_OPAQUE icon_bitmap2component_xpm[1]
void SetAuiManager(wxAuiManager *aManager)
Set the AUI manager that this toolbar belongs to.
wxAuiManager m_auimgr
wxBitmap KiScaledBitmap(BITMAP_DEF aBitmap, wxWindow *aWindow)
Construct a wxBitmap from a memory record, scaling it if device DPI demands it.
Definition: bitmap.cpp:118
static TOOL_ACTION convertImage
const BITMAP_OPAQUE icon_eeschema_xpm[1]
static TOOL_ACTION editSchematic
const BITMAP_OPAQUE icon_pagelayout_editor_xpm[1]
static TOOL_ACTION editFootprints
static TOOL_ACTION editWorksheet
const BITMAP_OPAQUE icon_gerbview_xpm[1]
const BITMAP_OPAQUE icon_modedit_xpm[1]
const BITMAP_OPAQUE icon_libedit_xpm[1]
static TOOL_ACTION editPCB
ACTION_TOOLBAR * m_launcher
void SetToolBitmap(const TOOL_ACTION &aAction, const wxBitmap &aBitmap)
Updates the bitmap of a particular tool.
static constexpr int KICAD_AUI_TB_STYLE
Default style flags used for wxAUI toolbars
const BITMAP_OPAQUE icon_pcbnew_xpm[1]
Definition: icon_pcbnew.cpp:49
static TOOL_ACTION editSymbols

References ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddScaledSeparator(), KICAD_MANAGER_ACTIONS::convertImage, KICAD_MANAGER_ACTIONS::editFootprints, KICAD_MANAGER_ACTIONS::editPCB, KICAD_MANAGER_ACTIONS::editSchematic, KICAD_MANAGER_ACTIONS::editSymbols, KICAD_MANAGER_ACTIONS::editWorksheet, icon_bitmap2component_xpm, icon_eeschema_xpm, icon_gerbview_xpm, icon_libedit_xpm, icon_modedit_xpm, icon_pagelayout_editor_xpm, icon_pcbcalculator_xpm, icon_pcbnew_xpm, ID_H_TOOLBAR, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, KiScaledBitmap(), EDA_BASE_FRAME::m_auimgr, m_launcher, ACTION_TOOLBAR::SetAuiManager(), ACTION_TOOLBAR::SetToolBitmap(), KICAD_MANAGER_ACTIONS::showCalculator, and KICAD_MANAGER_ACTIONS::viewGerbers.

Referenced by ShowChangedLanguage().

◆ ReCreateMenuBar()

void KICAD_MANAGER_FRAME::ReCreateMenuBar ( )
overridevirtual

Recreates the menu bar.

Needed when the language is 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( recent_xpm );
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 
82 
83  fileMenu->AppendSeparator();
84  fileMenu->Add( ACTIONS::saveAs );
85 
86  fileMenu->AppendSeparator();
87 
88  //Import Sub-menu
89  ACTION_MENU* importMenu = new ACTION_MENU( false, controlTool );
90  importMenu->SetTitle( _( "Import Non-KiCad Project..." ) );
91  importMenu->SetIcon( import_project_xpm );
92 
93  importMenu->Add( _( "Import CADSTAR Project..." ),
94  _( "Import CADSTAR Archive Schematic and PCB (*.csa, *.cpa)" ),
97 
98  importMenu->Add( _( "Import EAGLE Project..." ),
99  _( "Import EAGLE CAD XML schematic and board" ),
102 
103  fileMenu->Add( importMenu );
104 
105  fileMenu->AppendSeparator();
106  fileMenu->Add( _( "&Archive Project..." ),
107  _( "Archive all needed project files into zip archive" ),
109  zip_xpm );
110 
111  fileMenu->Add( _( "&Unarchive Project..." ),
112  _( "Unarchive project files from zip archive" ),
114  unzip_xpm );
115 
116  fileMenu->AppendSeparator();
117  fileMenu->AddQuitOrClose( nullptr, "KiCad" );
118 
119  //-- View menu -----------------------------------------------------------
120  //
121  ACTION_MENU* viewMenu = new ACTION_MENU( false, controlTool );
122 
123  viewMenu->Add( ACTIONS::zoomRedraw );
124 
125  viewMenu->AppendSeparator();
127  viewMenu->Add( _( "Browse Project Files" ),
128  _( "Open project directory in file browser" ),
131 
132 #ifdef __APPLE__
133  // Add a separator only on macOS because the OS adds menu items to the view menu after ours
134  viewMenu->AppendSeparator();
135 #endif
136 
137  //-- Tools menu -----------------------------------------------
138  //
139  ACTION_MENU* toolsMenu = new ACTION_MENU( false, controlTool );
140 
143  toolsMenu->Add( KICAD_MANAGER_ACTIONS::editPCB );
145 
146  toolsMenu->AppendSeparator();
151 
152  toolsMenu->AppendSeparator();
153  toolsMenu->Add( _( "Edit Local File..." ),
154  _( "Edit local file in text editor" ),
157 
158  //-- Preferences menu -----------------------------------------------
159  //
160  ACTION_MENU* prefsMenu = new ACTION_MENU( false, controlTool );
161 
162  prefsMenu->Add( ACTIONS::configurePaths );
163  prefsMenu->Add( ACTIONS::showSymbolLibTable );
164  prefsMenu->Add( ACTIONS::showFootprintLibTable );
165  prefsMenu->Add( _( "Preferences...\tCTRL+," ),
166  _( "Show preferences for all open tools" ),
167  wxID_PREFERENCES,
168  preference_xpm );
169 
170  prefsMenu->AppendSeparator();
171  AddMenuLanguageList( prefsMenu, controlTool );
172 
173 
174  //-- Menubar -------------------------------------------------------------
175  //
176  menuBar->Append( fileMenu, _( "&File" ) );
177  menuBar->Append( viewMenu, _( "&View" ) );
178  menuBar->Append( toolsMenu, _( "&Tools" ) );
179  menuBar->Append( prefsMenu, _( "&Preferences" ) );
180  AddStandardHelpMenu( menuBar );
181 
182  SetMenuBar( menuBar );
183  delete oldMenuBar;
184 }
const BITMAP_OPAQUE browse_files_xpm[1]
void AddFilesToMenu() override
Add the files to all registered menus.
Definition: filehistory.h:98
static TOOL_ACTION newProject
wxMenuItem * Add(const wxString &aLabel, int aId, const BITMAP_OPAQUE *aIcon)
Adds a wxWidgets-style entry to the menu.
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:43
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
const BITMAP_OPAQUE directory_browser_xpm[1]
const BITMAP_OPAQUE zip_xpm[1]
Definition: zip.cpp:60
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:173
static TOOL_ACTION newFromTemplate
KICAD_MANAGER_CONTROL.
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
const BITMAP_OPAQUE recent_xpm[1]
Definition: recent.cpp:68
static TOOL_ACTION closeProject
ACTION_CONDITIONS & Enable(const SELECTION_CONDITION &aCondition)
static TOOL_ACTION editSchematic
static TOOL_ACTION showFootprintLibTable
Definition: actions.h:174
void SetIcon(const BITMAP_OPAQUE *aIcon)
Assigns an icon for the entry.
Definition: action_menu.cpp:71
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 editWorksheet
const BITMAP_OPAQUE import_project_xpm[1]
static TOOL_ACTION editPCB
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
void SetTitle(const wxString &aTitle) override
Sets title for the menu.
Definition: action_menu.cpp:89
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="")
Adds either a standard Quit or Close item to the menu.
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION zoomRedraw
Definition: actions.h:88
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
const BITMAP_OPAQUE preference_xpm[1]
Definition: preference.cpp:53
static TOOL_ACTION editSymbols
static TOOL_ACTION configurePaths
Definition: actions.h:172
static TOOL_ACTION openTextEditor
const BITMAP_OPAQUE unzip_xpm[1]
Definition: unzip.cpp:61

References _, ACTION_MENU::Add(), FILE_HISTORY::AddFilesToMenu(), AddMenuLanguageList(), ACTION_MENU::AddQuitOrClose(), EDA_BASE_FRAME::AddStandardHelpMenu(), browse_files_xpm, KICAD_MANAGER_ACTIONS::closeProject, ACTIONS::configurePaths, KICAD_MANAGER_ACTIONS::convertImage, directory_browser_xpm, KICAD_MANAGER_ACTIONS::editFootprints, KICAD_MANAGER_ACTIONS::editPCB, KICAD_MANAGER_ACTIONS::editSchematic, KICAD_MANAGER_ACTIONS::editSymbols, KICAD_MANAGER_ACTIONS::editWorksheet, 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_xpm, TOOLS_HOLDER::m_toolManager, KICAD_MANAGER_ACTIONS::newFromTemplate, KICAD_MANAGER_ACTIONS::newProject, KICAD_MANAGER_ACTIONS::openProject, KICAD_MANAGER_ACTIONS::openTextEditor, preference_xpm, recent_xpm, EDA_BASE_FRAME::RegisterUIUpdateHandler(), ACTIONS::saveAs, FILE_HISTORY::SetClearText(), ACTION_MENU::SetIcon(), ACTION_MENU::SetTitle(), KICAD_MANAGER_ACTIONS::showCalculator, ACTIONS::showFootprintLibTable, ACTIONS::showSymbolLibTable, unzip_xpm, KICAD_MANAGER_ACTIONS::viewGerbers, zip_xpm, and ACTIONS::zoomRedraw.

◆ ReCreateTreePrj()

void KICAD_MANAGER_FRAME::ReCreateTreePrj ( )

Definition at line 292 of file kicad_manager_frame.cpp.

293 {
295 }
void ReCreateTreePrj()
Create or modify the tree showing project file names.
TREE_PROJECT_FRAME * m_leftWin

References m_leftWin, and TREE_PROJECT_FRAME::ReCreateTreePrj().

Referenced by ImportNonKiCadProject().

◆ RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 171 of file tools_holder.h.

171 { }

Referenced by TOOL_MANAGER::ProcessEvent().

◆ RefreshProjectTree()

void KICAD_MANAGER_FRAME::RefreshProjectTree ( )

Definition at line 559 of file kicad_manager_frame.cpp.

560 {
562 }
void ReCreateTreePrj()
Create or modify the tree showing project file names.
TREE_PROJECT_FRAME * m_leftWin

References m_leftWin, and TREE_PROJECT_FRAME::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 85 of file tools_holder.h.

87  {
88  RegisterUIUpdateHandler( aAction.GetUIId(), aConditions );
89  }
int GetUIId() const
Definition: tool_action.h:102
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:85

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 294 of file eda_base_frame.cpp.

295 {
297  std::placeholders::_1,
298  this,
299  aConditions );
300 
301  m_uiUpdateMap[aID] = evtFunc;
302 
303  Bind( wxEVT_UPDATE_UI, evtFunc, aID );
304 }
static void HandleUpdateUIEvent(wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
Handles events generated when the UI is trying to figure out the current state of the UI controls rel...
std::function< void(wxUpdateUIEvent &) > UIUpdateHandler
This is the handler functor for the update UI events.
std::map< int, UIUpdateHandler > m_uiUpdateMap

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

Referenced by ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), EDA_3D_VIEWER::setupUIConditions(), setupUIConditions(), EDA_BASE_FRAME::setupUIConditions(), and LIB_EDIT_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 do nothing

Parameters
aAskForSave= true to open a dialog before saving the settings

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 417 of file eda_base_frame.h.

417 {};

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick().

◆ SaveSettings()

void KICAD_MANAGER_FRAME::SaveSettings ( APP_SETTINGS_BASE aCfg)
overridevirtual

Saves 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 633 of file kicad_manager_frame.cpp.

634 {
636 
637  auto settings = dynamic_cast<KICAD_SETTINGS*>( aCfg );
638 
639  wxCHECK( settings, /*void*/);
640 
641  settings->m_LeftWinWidth = m_leftWin->GetSize().x;
642 }
virtual void SaveSettings(APP_SETTINGS_BASE *aCfg)
Saves common frame parameters to a configuration data file.
TREE_PROJECT_FRAME * m_leftWin

References m_leftWin, and EDA_BASE_FRAME::SaveSettings().

◆ SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings ( WINDOW_SETTINGS aCfg)
inherited

Saves 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 560 of file eda_base_frame.cpp.

561 {
562  wxString text;
563 
564  if( IsIconized() )
565  return;
566 
567  wxString baseCfgName = ConfigBaseName();
568 
569  // If the window is maximized, we use the saved window size from before it was maximized
570  if( IsMaximized() )
571  {
574  }
575  else
576  {
578  m_FramePos = GetPosition();
579  }
580 
581  aCfg->state.pos_x = m_FramePos.x;
582  aCfg->state.pos_y = m_FramePos.y;
583  aCfg->state.size_x = m_FrameSize.x;
584  aCfg->state.size_y = m_FrameSize.y;
585  aCfg->state.maximized = IsMaximized();
586  aCfg->state.display = wxDisplay::GetFromWindow( this );
587 
588  wxLogTrace( traceDisplayLocation, "Saving window maximized: %s", IsMaximized() ? "true" : "false" );
589  wxLogTrace( traceDisplayLocation, "Saving config position (%d, %d) with size (%d, %d)",
591 
592  // TODO(JE) should auto-save in common settings be overwritten by every app?
593  if( m_hasAutoSave )
594  Pgm().GetCommonSettings()->m_System.autosave_interval = m_autoSaveInterval;
595 
596  // Once this is fully implemented, wxAuiManager will be used to maintain
597  // the persistance of the main frame and all it's managed windows and
598  // all of the legacy frame persistence position code can be removed.
599  aCfg->perspective = m_auimgr.SavePerspective().ToStdString();
600 
601  aCfg->mru_path = m_mruPath;
602 }
wxString mru_path
Definition: app_settings.h:84
wxString m_mruPath
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxAuiManager m_auimgr
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
wxSize m_NormalFrameSize
wxString perspective
Definition: app_settings.h:85
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.
wxString ConfigBaseName() override
WINDOW_STATE state
Definition: app_settings.h:83
unsigned int display
Definition: app_settings.h:75
wxPoint m_NormalFramePos

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, and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ SchFileName()

const wxString KICAD_MANAGER_FRAME::SchFileName ( )

Definition at line 256 of file kicad_manager_frame.cpp.

257 {
258  wxFileName fn( GetProjectFileName() );
259 
260  fn.SetExt( KiCadSchematicFileExtension );
261  return fn.GetFullPath();
262 }
const wxString GetProjectFileName() const
const std::string KiCadSchematicFileExtension

References GetProjectFileName(), and KiCadSchematicFileExtension.

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

◆ SchLegacyFileName()

const wxString KICAD_MANAGER_FRAME::SchLegacyFileName ( )

Definition at line 265 of file kicad_manager_frame.cpp.

266 {
267  wxFileName fn( GetProjectFileName() );
268 
269  fn.SetExt( LegacySchematicFileExtension );
270  return fn.GetFullPath();
271 }
const wxString GetProjectFileName() const
const std::string LegacySchematicFileExtension

References GetProjectFileName(), and LegacySchematicFileExtension.

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

◆ SetAutoSaveInterval()

void EDA_BASE_FRAME::SetAutoSaveInterval ( int  aInterval)
inherited

Definition at line 244 of file eda_base_frame.cpp.

245 {
246  m_autoSaveInterval = aInterval;
247 
248  if( m_autoSaveTimer->IsRunning() )
249  {
250  if( m_autoSaveInterval > 0 )
251  {
252  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
253  }
254  else
255  {
256  m_autoSaveTimer->Stop();
257  m_autoSaveState = false;
258  }
259  }
260 }
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

Function SetKiway.

Parameters
aDestis the recipient of aKiway pointer. It is only used for debugging, since "this" is not a wxWindow*. "this" is a KIWAY_HOLDER mix-in.
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:81
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(), 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 180 of file kicad_manager_frame.cpp.

181 {
182  // Create the manager
184  m_toolManager->SetEnvironment( nullptr, nullptr, nullptr, config(), this );
186 
188 
189  // Attach the events to the tool dispatcher
192  Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
193 
194  // Register tools
198 }
KICAD_MANAGER_CONTROL.
TOOL_MANAGER.
Definition: tool_manager.h:51
virtual void DispatchWxEvent(wxEvent &aEvent)
Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs, and makes tools handle those.
ACTIONS * m_actions
Definition: tools_holder.h:49
COMMON_CONTROL.
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:50
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, APP_SETTINGS_BASE *aSettings, TOOLS_HOLDER *aFrame)
Sets the work environment (model, view, view controls and the parent window).
virtual void DispatchWxCommand(wxCommandEvent &aEvent)
Processes wxCommands (mostly menu related events) and runs appropriate actions (eg.
KICAD_MANAGER_ACTIONS.
void InitTools()
Function 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)
Function RegisterTool() Adds a tool to the manager set and sets it up.

References config(), TOOL_DISPATCHER::DispatchWxCommand(), 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 201 of file kicad_manager_frame.cpp.

202 {
204 
206 
207  wxASSERT( manager );
208 
209  auto activeProject =
210  [this] ( const SELECTION& )
211  {
212  return m_active_project;
213  };
214 
215  ACTION_CONDITIONS activeProjectCond;
216  activeProjectCond.Enable( activeProject );
217 
218  manager->SetConditions( KICAD_MANAGER_ACTIONS::editSchematic, activeProjectCond );
219  manager->SetConditions( KICAD_MANAGER_ACTIONS::editPCB, activeProjectCond );
220  manager->SetConditions( ACTIONS::saveAs, activeProjectCond );
221  manager->SetConditions( KICAD_MANAGER_ACTIONS::closeProject, activeProjectCond );
222 
223  // TODO: Switch this to an action
224  RegisterUIUpdateHandler( ID_SAVE_AND_ZIP_FILES, activeProjectCond );
225 }
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.
ACTION_MANAGER.
static TOOL_ACTION closeProject
ACTION_CONDITIONS & Enable(const SELECTION_CONDITION &aCondition)
static TOOL_ACTION editSchematic
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...
static TOOL_ACTION editPCB
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
static TOOL_ACTION saveAs
Definition: actions.h:55
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:200
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...

References KICAD_MANAGER_ACTIONS::closeProject, KICAD_MANAGER_ACTIONS::editPCB, KICAD_MANAGER_ACTIONS::editSchematic, 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 244 of file eda_base_frame.h.

245  {
246  m_userUnits = aUnits;
247  }
EDA_UNITS m_userUnits

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 572 of file kicad_manager_frame.cpp.

573 {
574  // call my base class
576 
577  // tooltips in toolbars
580 
581  PrintPrjInfo();
582 }
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 PrintPrjInfo(), RecreateBaseHToolbar(), RecreateLauncher(), and EDA_BASE_FRAME::ShowChangedLanguage().

◆ ShowInfoBarError()

void EDA_BASE_FRAME::ShowInfoBarError ( const wxString &  aErrorMsg)
inherited

◆ ShowInfoBarMsg()

void EDA_BASE_FRAME::ShowInfoBarMsg ( const wxString &  aMsg)
inherited

Definition at line 691 of file eda_base_frame.cpp.

692 {
694  GetInfoBar()->ShowMessageFor( aMsg, 10000, wxICON_INFORMATION );
695 }
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:109
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:226
WX_INFOBAR * m_infoBar
WX_INFOBAR * GetInfoBar()

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

Referenced by DIALOG_FIND::search().

◆ ShowInfoBarWarning()

void EDA_BASE_FRAME::ShowInfoBarWarning ( const wxString &  aWarningMsg)
inherited

Definition at line 684 of file eda_base_frame.cpp.

685 {
687  GetInfoBar()->ShowMessageFor( aWarningMsg, 5000, wxICON_WARNING );
688 }
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:109
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: infobar.cpp:226
WX_INFOBAR * m_infoBar
WX_INFOBAR * GetInfoBar()

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

◆ 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 298 of file kicad_manager_frame.cpp.

299 {
300  return PgmTop().SysSearch();
301 }
SEARCH_STACK & SysSearch()
Definition: pgm_kicad.h:57
PGM_KICAD & PgmTop()
Definition: kicad.cpp:77

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

Referenced by CreateNewProject().

◆ ToggleUserUnits()

virtual void EDA_BASE_FRAME::ToggleUserUnits ( )
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 251 of file eda_base_frame.h.

251 { }

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 PCB_BASE_EDIT_FRAME, GERBVIEW_FRAME, EDA_DRAW_FRAME, and PCB_BASE_FRAME.

Definition at line 220 of file eda_base_frame.h.

220 { }

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 105 of file tools_holder.h.

106  {
107  UnregisterUIUpdateHandler( aAction.GetUIId() );
108  }
int GetUIId() const
Definition: tool_action.h:102
virtual void UnregisterUIUpdateHandler(const TOOL_ACTION &aAction)
Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.
Definition: tools_holder.h:105

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 307 of file eda_base_frame.cpp.

308 {
309  const auto it = m_uiUpdateMap.find( aID );
310 
311  if( it == m_uiUpdateMap.end() )
312  return;
313 
314  Unbind( wxEVT_UPDATE_UI, it->second, aID );
315 }
std::map< int, UIUpdateHandler > m_uiUpdateMap

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 698 of file eda_base_frame.cpp.

699 {
700  if( !aFileHistory )
701  aFileHistory = m_fileHistory;
702 
703  wxASSERT( aFileHistory );
704 
705  aFileHistory->AddFileToHistory( FullFileName );
706 
707  // Update the menubar to update the file history menu
708  if( !m_isClosing && GetMenuBar() )
709  {
710  ReCreateMenuBar();
711  GetMenuBar()->Refresh();
712  }
713 }
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(), SCH_EDIT_FRAME::importFile(), GERBVIEW_FRAME::LoadExcellonFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), PL_EDITOR_FRAME::LoadPageLayoutDescrFile(), LoadProject(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), 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, GERBVIEW_FRAME, SCH_BASE_FRAME, and PL_EDITOR_FRAME.

Definition at line 536 of file eda_base_frame.h.

536 { }

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 141 of file eda_base_frame.h.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FOOTPRINT_EDIT_FRAME::IsSearchTreeShown(), LIB_EDIT_FRAME::IsSearchTreeShown(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), OnSize(), LIB_VIEW_FRAME::OnSize(), FOOTPRINT_WIZARD_FRAME::OnSize(), FOOTPRINT_VIEWER_FRAME::OnSize(), LIB_EDIT_FRAME::OnToggleSearchTree(), GERBVIEW_FRAME::ReCreateAuxiliaryToolbar(), PCB_EDIT_FRAME::ReCreateAuxiliaryToolbar(), RecreateBaseHToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar(), LIB_VIEW_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), PL_EDITOR_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateHToolbar(), FOOTPRINT_WIZARD_FRAME::ReCreateHToolbar(), CVPCB_MAINFRAME::ReCreateHToolbar(), SCH_EDIT_FRAME::ReCreateHToolbar(), GERBVIEW_FRAME::ReCreateHToolbar(), LIB_EDIT_FRAME::ReCreateHToolbar(), PCB_EDIT_FRAME::ReCreateHToolbar(), RecreateLauncher(), FOOTPRINT_EDIT_FRAME::ReCreateLayerBox(), PCB_EDIT_FRAME::ReCreateLayerBox(), EDA_3D_VIEWER::ReCreateMainToolbar(), DISPLAY_FOOTPRINTS_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), LIB_EDIT_FRAME::ReCreateOptToolbar(), GERBVIEW_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateVToolbar(), PL_EDITOR_FRAME::ReCreateVToolbar(), SCH_EDIT_FRAME::ReCreateVToolbar(), LIB_EDIT_FRAME::ReCreateVToolbar(), PCB_EDIT_FRAME::ReCreateVToolbar(), GERBVIEW_FRAME::ReFillLayerWidget(), CVPCB_MAINFRAME::refreshAfterComponentSearch(), FOOTPRINT_WIZARD_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveWindowSettings(), PCB_BASE_FRAME::SetDrawBgColor(), FOOTPRINT_EDIT_FRAME::ShowChangedLanguage(), GERBVIEW_FRAME::ShowChangedLanguage(), 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_dragSelects

bool TOOLS_HOLDER::m_dragSelects
protectedinherited

◆ m_dummySelection

SELECTION TOOLS_HOLDER::m_dummySelection
protectedinherited

Definition at line 52 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

FRAME_T EDA_BASE_FRAME::m_Ident
protectedinherited

◆ m_immediateActions

bool TOOLS_HOLDER::m_immediateActions
protectedinherited

◆ m_infoBar

◆ m_isClosing

bool EDA_BASE_FRAME::m_isClosing
protectedinherited

◆ m_isNonUserClose

bool EDA_BASE_FRAME::m_isNonUserClose
protectedinherited

◆ m_launcher

ACTION_TOOLBAR* KICAD_MANAGER_FRAME::m_launcher
private

Definition at line 189 of file kicad_manager_frame.h.

Referenced by RecreateLauncher().

◆ m_leftWin

◆ m_leftWinWidth

int KICAD_MANAGER_FRAME::m_leftWinWidth
private

Definition at line 193 of file kicad_manager_frame.h.

Referenced by LoadSettings().

◆ m_mainToolBar

ACTION_TOOLBAR* KICAD_MANAGER_FRAME::m_mainToolBar
private

Definition at line 191 of file kicad_manager_frame.h.

Referenced by RecreateBaseHToolbar().

◆ m_maximizeByDefault

bool EDA_BASE_FRAME::m_maximizeByDefault
protectedinherited

◆ m_messagesBox

wxTextCtrl* KICAD_MANAGER_FRAME::m_messagesBox
private

Definition at line 190 of file kicad_manager_frame.h.

Referenced by ClearMsg(), OnArchiveFiles(), OnUnarchiveFiles(), and PrintMsg().

◆ 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 185 of file kicad_manager_frame.h.

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

◆ m_perspective

wxString EDA_BASE_FRAME::m_perspective
protectedinherited

Definition at line 142 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 149 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 48 of file tools_holder.h.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), SCH_EDIT_FRAME::AddJunction(), EDA_BASE_FRAME::AddStandardHelpMenu(), EDA_DRAW_FRAME::AddStandardSubMenus(), SCH_EDIT_FRAME::AppendSchematic(), GERBVIEW_FRAME::Clear_DrawLayers(), SCH_EDIT_FRAME::ConvertPart(), EDA_3D_VIEWER::CreateMenuBar(), LIB_EDIT_FRAME::CreateNewPart(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), LIB_VIEW_FRAME::DClickOnCmpList(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_FRAME::DisplayCurrentSheet(), GERBVIEW_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), LIB_EDIT_FRAME::emptyScreen(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), FOOTPRINT_VIEWER_FRAME::GetCurrentSelection(), FOOTPRINT_EDIT_FRAME::GetCurrentSelection(), PL_EDITOR_FRAME::GetCurrentSelection(), DISPLAY_FOOTPRINTS_FRAME::GetCurrentSelection(), LIB_VIEW_FRAME::GetCurrentSelection(), LIB_EDIT_FRAME::GetCurrentSelection(), SCH_EDIT_FRAME::GetCurrentSelection(), GERBVIEW_FRAME::GetCurrentSelection(), TOOLS_HOLDER::GetToolManager(), EDA_DRAW_FRAME::GetUnitPair(), PL_EDITOR_FRAME::HardRedraw(), LIB_EDIT_FRAME::HardRedraw(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), LIB_EDIT_FRAME::LoadOneLibraryPartAux(), LIB_EDIT_FRAME::LoadOneSymbol(), LIB_EDIT_FRAME::LoadSymbolFromSchematic(), PCB_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnExportBody(), SCH_EDIT_FRAME::OnFindDialogClose(), LIB_EDIT_FRAME::OnImportBody(), PL_EDITOR_FRAME::OnNewPageLayout(), OnOpenFileInTextEditor(), EDA_DRAW_FRAME::OnSelectGrid(), LIB_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(), LIB_VIEW_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), LIB_EDIT_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateVToolbar(), CVPCB_MAINFRAME::refreshAfterComponentSearch(), SCH_BASE_FRAME::RefreshSelection(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), LIB_EDIT_FRAME::RollbackPartFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_EDIT_FRAME::saveLibrary(), EDA_DRAW_FRAME::SaveSettings(), SCH_EDIT_FRAME::SchematicCleanUp(), GERBVIEW_FRAME::SetActiveLayer(), PCB_BASE_EDIT_FRAME::SetBoard(), LIB_EDIT_FRAME::SetCurPart(), LIB_VIEW_FRAME::SetSelectedComponent(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), LIB_VIEW_FRAME::setupTools(), setupTools(), GERBVIEW_FRAME::setupTools(), LIB_EDIT_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), FOOTPRINT_VIEWER_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), CVPCB_MAINFRAME::setupUIConditions(), DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), LIB_VIEW_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), EDA_3D_VIEWER::setupUIConditions(), setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), LIB_EDIT_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), EDA_DRAW_FRAME::unitsChangeRefresh(), SCH_EDIT_FRAME::UpdateSymbolFromEditor(), 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(), LIB_EDIT_FRAME::~LIB_EDIT_FRAME(), LIB_VIEW_FRAME::~LIB_VIEW_FRAME(), PL_EDITOR_FRAME::~PL_EDITOR_FRAME(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ m_toolStack

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

◆ m_uiUpdateMap

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

◆ m_undoList

◆ m_UndoRedoCountMax

int EDA_BASE_FRAME::m_UndoRedoCountMax
protectedinherited

◆ m_userUnits


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