ForgeSidePanel.h

Go to the documentation of this file.

#pragma once
 
#include "Components/PanelDescriptor.h"
#include "Components/SidePanel.h"
#include "Interfaces/ITab.h"
#include "Utils/CustomAuiNotebook.h"
#include <string>
#include <vector>
#include <wx/aui/aui.h>
#include <wx/aui/auibook.h>
#include <wx/aui/framemanager.h>
#include <wx/wx.h>
 
class MainFrame;
 
namespace EmberForge {
enum class TabType;
}
 
class SidePanel : public EmberUI::SidePanel {
  public:
    SidePanel(wxWindow *parent, MainFrame *mainFrame = nullptr, const wxString &panelName = "Side Panel",
              EmberForge::PanelType panelType = EmberForge::PanelType::LeftPanel,
              EmberForge::PanelDescriptor *parentDescriptor = nullptr);
    virtual ~SidePanel();
 
    void FinishSetup();
 
    wxString GetTitle() const override = 0;
    wxString GetPanelType() const override = 0;
 
    int AddTab(ITabPtr tab) override;
    ITabPtr RemoveTab(int index) override;
    bool SetActiveTab(int index) override;
    void ClearAllTabs() override;
 
    EmberForge::CustomAuiNotebook *GetCustomNotebook() const {
        return static_cast<EmberForge::CustomAuiNotebook *>(m_notebook);
    }
 
    void ResetToDefaultTab(EmberForge::TabType defaultTabType);
    void ResetToDefaultTabs(const std::vector<EmberForge::TabType> &defaultTabTypes);
 
    virtual void ApplyPreferences();
    virtual void SaveState();
    virtual void RestoreState();
 
    void SetTabBarButtonsEnabled(bool enabled);
    bool AreTabBarButtonsEnabled() const { return m_tabBarButtonsEnabled; }
    void ToggleTabBarButtons();
 
    void SetPanelName(const wxString &name) { m_panelName = name; }
 
    const EmberForge::PanelDescriptor &GetPanelDescriptor() const { return m_descriptor; }
    void SetPanelDescriptor(const EmberForge::PanelDescriptor &descriptor) {
        m_descriptor = descriptor;
        m_panelName = descriptor.GetDisplayName();
    }
 
  protected:
    void CreateLayout() override;
    void CreateNotebook() override;
    virtual void SetupEventHandlers();
 
    virtual void OnPanelSpecificSetup();
 
    virtual bool GetRememberLastTab() const = 0;
    virtual const std::vector<std::string> &GetLastOpenTabs() const = 0;
    virtual std::string GetLastActiveTab() const = 0;
    virtual std::string GetDefaultActiveTab() const = 0;
 
    void RestoreAndEnsureTabs();
 
    void DoCreateLayout();
    void DoCreateNotebook();
    void DoSetupEventHandlers();
 
    virtual void OnAddTabButtonClicked(wxCommandEvent &event) {}
    virtual std::vector<EmberForge::TabType> GetSupportedTabTypes() const { return {}; }
 
    void OnTabChanged(wxAuiNotebookEvent &event);
    void OnTabClosed(wxAuiNotebookEvent &event);
    void OnAddTabButtonClickedInternal(wxCommandEvent &event);
    virtual void OnMenuButtonClicked(wxCommandEvent &event);
 
    void OnHidePanelClicked(wxCommandEvent &event);
    void OnPanelPreferencesClicked(wxCommandEvent &event);
 
    void OnTabBarAddButtonClicked(wxCommandEvent &event);
    void OnTabBarMenuButtonClicked(wxCommandEvent &event);
 
    void CreateAndAddTab(EmberForge::TabType tabType);
    void ShowTabCreationMenu();
 
    MainFrame *m_mainFrame;
    wxString m_panelName;
    bool m_tabBarButtonsEnabled;
    bool m_isInitializing;
    EmberForge::PanelDescriptor m_descriptor;
 
    enum BaseEventIDs {
        ID_BASE_NOTEBOOK = wxID_HIGHEST + 1000,
        ID_BASE_HIDE_PANEL_MENU_ITEM,
        ID_BASE_PREFERENCES_MENU_ITEM,
        ID_BASE_ADD_TAB_BUTTON,
        ID_BASE_MENU_BUTTON,
        ID_BASE_LAST
    };
 
  private:
    wxDECLARE_EVENT_TABLE();
};