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 The 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, see <https://www.gnu.org/licenses/>.
 */
 
#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 LOCAL_HISTORY_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 UnarchiveFiles();
    void RestoreLocalHistory();
    void RestoreCommitFromHistory( const wxString& aHash );
    void ToggleLocalHistory();
    bool HistoryPanelShown();
 
    void OnOpenFileInTextEditor( wxCommandEvent& event );
    void OnEditAdvancedCfg( wxCommandEvent& event );

    void OnCompareProjectBranches( 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 HideTabsIfNeeded();
 
    wxString GetCurrentFileName() const override;

    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 OnImportAltiumProjectFiles( wxCommandEvent& event );

    void OnImportCadstarArchiveFiles( wxCommandEvent& event );

    void OnImportEagleFiles( wxCommandEvent& event );

    void OnImportEasyEdaFiles( wxCommandEvent& event );

    void OnImportEasyEdaProFiles( wxCommandEvent& event );

    void OnImportPadsProjectFiles( wxCommandEvent& event );
    void OnImportPcadProjectFiles( wxCommandEvent& event );

    void OnImportGedaFiles( wxCommandEvent& event );

    void OnImportDipTraceFiles( wxCommandEvent& event );

    void OnImportOrcadFiles( wxCommandEvent& event );

    void PrintPrjInfo();
 
    void RefreshProjectTree();

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

    bool CloseProject( bool aSave );

    bool LoadProject( const wxFileName& aProjectFileName );
 
    void OpenJobsFile( const wxFileName& aFileName, bool aCreate = false,
                       bool aResaveProjectPreferences = true );
 
 
    void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    void ShowChangedLanguage() override;
    void CommonSettingsChanged( int aFlags ) override;
    void ProjectChanged() override;
 
    void PreloadAllLibraries();

    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();

    void SaveOpenJobSetsToLocalSettings( bool aIsExplicitUserSave = false );
 
    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();
 
    void onNotebookPageCloseRequest( wxAuiNotebookEvent& evt );
 
    void onNotebookPageCountChanged( wxAuiNotebookEvent& evt );
 
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 updatePcmButtonBadge();
 
private:
    bool                  m_openSavedWindows;
    bool                  m_restoredFromHistory;  
    int                   m_leftWinWidth;
    bool                  m_active_project;
    bool                  m_showHistoryPanel;
 
    PROJECT_TREE_PANE*    m_projectTreePane;
    LOCAL_HISTORY_PANE*   m_historyPane;
    wxAuiNotebook*        m_notebook;
    PANEL_KICAD_LAUNCHER* m_launcher;
    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