editor_tabs_panel.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 EDITOR_TABS_PANEL_H
#define EDITOR_TABS_PANEL_H
 
#include <functional>
#include <vector>
 
#include <wx/panel.h>
#include <wx/string.h>
 
#include <widgets/kicad_tab_art.h>
 
class EDA_DRAW_PANEL_GAL;
class wxAuiNotebook;
class wxAuiNotebookEvent;
class wxBoxSizer;
class wxMouseEvent;
 

class EDITOR_TABS_MODEL
{
public:
    struct ENTRY
    {
        wxString key;
        bool     preview = false;
        bool     modified = false;
    };

    int OpenDocument( const wxString& aKey, bool aAsPreview );

    void CloseDocument( const wxString& aKey );

    void MarkModified( const wxString& aKey, bool aModified );

    void Promote( const wxString& aKey );

    void Rename( const wxString& aOldKey, const wxString& aNewKey );

    bool CanCloseWithoutPrompt( const wxString& aKey ) const;
 
    int FindIndex( const wxString& aKey ) const;

    int PreviewIndex() const;
 
    const std::vector<ENTRY>& Entries() const { return m_entries; }
 
private:
    std::vector<ENTRY> m_entries;
};
 

class EDITOR_TABS_PANEL : public wxPanel
{
public:
    EDITOR_TABS_PANEL( wxWindow* aParent, EDA_DRAW_PANEL_GAL* aSharedCanvas );
    ~EDITOR_TABS_PANEL() override;

    std::function<void( int )> onActivateTab;

    std::function<bool( int )> onCloseTabRequested;

    std::function<TAB_VISUAL_STATE( int )> onQueryVisualState;

    void ReleaseSharedCanvas();

    void SetSuppressActivateOnClose( bool aSuppress ) { m_suppressActivateOnClose = aSuppress; }
 
    int  AddTab( const wxString& aKey, const wxString& aLabel, bool aAsPreview );
    void CloseTab( int aIdx );
    void CloseOthers( int aKeepIdx );
    void CloseToRight( int aIdx );
    void CloseAll();

    void MarkModified( int aIdx, bool aModified );

    void PromoteTab( int aIdx );
 
    void SelectTab( int aIdx );
    void AdvanceTab( bool aForward );
    int  GetActiveTab() const;
    int  FindTab( const wxString& aKey ) const;
    void RefreshTabLabels();

    void RenameTab( const wxString& aOldKey, const wxString& aNewKey, const wxString& aNewLabel );
 
    const EDITOR_TABS_MODEL& Model() const { return m_model; }

    EDITOR_TABS_MODEL& MutableModel() { return m_model; }
 
private:
    void onPageChanged( wxAuiNotebookEvent& aEvent );
    void onPageClose( wxAuiNotebookEvent& aEvent );
    void onTabRightDown( wxAuiNotebookEvent& aEvent );
    void onTabDClick( wxMouseEvent& aEvent );
    void onContextMenu( wxCommandEvent& aEvent );

    void closeTabInternal( int aIdx );

    void activateTab( int aIdx );

    void touchMru( const wxString& aKey );

    void forgetMru( const wxString& aKey );

    int indexOfWindow( wxWindow* aWindow ) const;

    void updateTabStripHeight();

    void bindTabDClick();
 
    TAB_VISUAL_STATE visualStateForIndex( int aIdx ) const;
 
    wxAuiNotebook*        m_tabs = nullptr;
    EDA_DRAW_PANEL_GAL*   m_sharedCanvas = nullptr;

    wxWindow*            m_originalCanvasParent = nullptr;
 
    wxBoxSizer*           m_sizer = nullptr;
    EDITOR_TABS_MODEL     m_model;

    bool m_activating = false;

    bool m_suppressActivateOnClose = false;

    std::vector<wxWindow*> m_pageWindows;

    std::vector<wxString>  m_mru;
 
    int m_contextMenuIdx = -1;
};
 
#endif // EDITOR_TABS_PANEL_H