kicad_manager_frame.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013 CERN (www.cern.ch)
 * Copyright (C) 2019-2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef KICAD_H
#define KICAD_H
 
#include <kiway_player.h>
 
class ACTION_TOOLBAR;
class BITMAP_BUTTON;
class EDA_BASE_FRAME;
class KICAD_SETTINGS;
class PANEL_KICAD_LAUNCHER;
class PLUGIN_CONTENT_MANAGER;
class PROJECT_TREE;
class PROJECT_TREE_PANE;
class UPDATE_MANAGER;
 
class KICAD_MANAGER_FRAME : public EDA_BASE_FRAME
{
public:
 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 ) override;
 
 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 );
 
 wxStatusBar* OnCreateStatusBar( int number, long style, wxWindowID id,
 const wxString& name ) override;
 
 void RecreateBaseLeftToolbar();
 
 wxString GetCurrentFileName() const override
 {
 return GetProjectFileName();
 }
 
 void ImportNonKiCadProject( const wxString& aWindowTitle, const wxString& aFilesWildcard,
 const std::vector<std::string>& aSchFileExtensions,
 const std::vector<std::string>& aPcbFileExtensions,
 int aSchFileType, int aPcbFileType );
 
 void OnImportCadstarArchiveFiles( wxCommandEvent& event );
 
 void OnImportEagleFiles( wxCommandEvent& event );
 
 void OnImportEasyEdaFiles( wxCommandEvent& event );
 
 void OnImportEasyEdaProFiles( wxCommandEvent& event );
 
 void PrintPrjInfo();
 
 void RefreshProjectTree();
 
 void CreateNewProject( const wxFileName& aProjectFileName, bool aCreateStubFiles = true );
 
 bool CloseProject( bool aSave );
 void LoadProject( const wxFileName& aProjectFileName );
 
 
 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 
 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
 void ShowChangedLanguage() override;
 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
 void ProjectChanged() override;
 
 void OnChangeWatchedPaths( wxCommandEvent& aEvent );
 
 const wxString GetProjectFileName() const;
 
 bool IsProjectActive();
 // read only accessors
 const wxString SchFileName();
 const wxString SchLegacyFileName();
 const wxString PcbFileName();
 const wxString PcbLegacyFileName();
 
 void ReCreateTreePrj();
 
 wxWindow* GetToolCanvas() const override;
 
 std::shared_ptr<PLUGIN_CONTENT_MANAGER> GetPcm() { return m_pcm; };
 
 void SetPcmButton( BITMAP_BUTTON* aButton );
 
 void CreatePCM(); // creates the PLUGIN_CONTENT_MANAGER
 
 // Used only on Windows: stores the info message about file watcher
 wxString m_FileWatcherInfo;
 
 DECLARE_EVENT_TABLE()
 
protected:
 virtual void setupUIConditions() override;
 
 void doReCreateMenuBar() override;
 
 void onToolbarSizeChanged();
 
private:
 void setupTools();
 void setupActions();
 
 void DoWithAcceptedFiles() override;
 
 APP_SETTINGS_BASE* config() const override;
 
 KICAD_SETTINGS* kicadSettings() const;
 
 const SEARCH_STACK& sys_search() override;
 
 wxString help_name() override;
 
 void language_change( wxCommandEvent& event );
 
 void updatePcmButtonBadge();
 
 bool m_openSavedWindows;
 int m_leftWinWidth;
 bool m_active_project;
 
 PROJECT_TREE_PANE* m_leftWin;
 PANEL_KICAD_LAUNCHER* m_launcher;
 ACTION_TOOLBAR* m_mainToolBar;
 int m_lastToolbarIconSize;
 
 std::shared_ptr<PLUGIN_CONTENT_MANAGER> m_pcm;
 BITMAP_BUTTON* m_pcmButton;
 int m_pcmUpdateCount;
 std::unique_ptr<UPDATE_MANAGER> m_updateManager;
};
 
 
// The C++ project manager includes a single PROJECT in its link image.
class PROJECT;
extern PROJECT& Prj();
 
#endif