TreeHierarchyTab.h

Go to the documentation of this file.

#pragma once
 
#include "Interfaces/ITab.h"
#include "Interfaces/ITreeNode.h"
#include "Interfaces/ITreeStructure.h"
#include <functional>
#include <memory>
#include <wx/srchctrl.h>
#include <wx/treectrl.h>
#include <wx/wx.h>
 
namespace EmberUI {

struct TreeNodeItemData : public wxTreeItemData {
    EmberCore::ITreeNode *node;
    explicit TreeNodeItemData(EmberCore::ITreeNode *n) : node(n) {}
};

struct DummyTreeItemData : public wxTreeItemData {
    DummyTreeItemData() = default;
};

struct TreeHierarchyConfig {
    bool showSearchBar = true;                
    bool showNodeIcons = false;               
    bool showTreeLines = false;               
    int treeIndentationSize = 10;             
    int fontSize = 9;                         
    bool autoExpandOnLoad = true;             
    int autoExpandDepth = 3;                  
    bool liveSearch = true;                   
    bool syncSelectionWithCanvas = true;      
    wxColour backgroundColour{50, 50, 50};    
    wxColour foregroundColour{255, 255, 255}; 
    wxColour panelColour{60, 60, 60};         
};

class TreeHierarchyTab : public wxPanel, public ITab {
  public:
    using SelectionCallback = std::function<void(EmberCore::ITreeNode *)>;
    using LayoutInvalidationCallback = std::function<void()>;
 
    explicit TreeHierarchyTab(wxWindow *parent, const TreeHierarchyConfig &config = {});
    ~TreeHierarchyTab() override = default;
 
    // ITab
    wxWindow *GetWidget() override { return this; }
    wxString GetTitle() const override { return "Hierarchy"; }
    wxString GetTabType() const override { return "Hierarchy"; }

    void SetTree(std::shared_ptr<EmberCore::ITreeStructure> tree);
    void ClearTree();
    void RefreshTree();
    void ExpandAll();
    void CollapseAll();

    void SelectNodeById(size_t nodeId);
    EmberCore::ITreeNode *GetSelectedNode() const;

    void SetSelectionCallback(SelectionCallback cb) { m_selectionCallback = std::move(cb); }
    void SetLayoutInvalidationCallback(LayoutInvalidationCallback cb) { m_layoutInvalidationCb = std::move(cb); }

    const TreeHierarchyConfig &GetConfig() const { return m_config; }
    void ApplyConfig(const TreeHierarchyConfig &config);
 
  protected:
    virtual wxString GetNodeDisplayText(EmberCore::ITreeNode *node) const;
    virtual void OnPopulateContextMenu(EmberCore::ITreeNode *node, wxMenu &menu) {}
    virtual void OnContextMenuCommand(int id, EmberCore::ITreeNode *node) {}
    virtual void OnNodeActivated(EmberCore::ITreeNode *node) {}
    virtual void OnSelectionChanged(EmberCore::ITreeNode *node);
    virtual void OnNodeExpanding(EmberCore::ITreeNode *node);
    virtual void OnNodeCollapsing(EmberCore::ITreeNode *node);

    wxTreeCtrl *GetTreeCtrl() const { return m_treeCtrl; }
    wxSearchCtrl *GetSearchCtrl() const { return m_searchCtrl; }
    std::shared_ptr<EmberCore::ITreeStructure> GetTree() const { return m_tree; }
    EmberCore::ITreeNode *GetNodeFromItem(const wxTreeItemId &item) const;
    wxTreeItemId FindItemById(size_t nodeId, const wxTreeItemId &start = wxTreeItemId());
    wxTreeItemId ExpandPathToNode(EmberCore::ITreeNode *node);
    void ScrollToItemHorizontally(const wxTreeItemId &item);
    void SelectRange(const wxTreeItemId &from, const wxTreeItemId &to);
 
    TreeHierarchyConfig m_config;
    wxTreeItemId m_lastSelectedItem;
 
  private:
    void CreateLayout();
    void PopulateTree();
    void AddFilteredNodes(const wxTreeItemId &parentItem, EmberCore::ITreeNode *node);
    void AddChildrenToItem(const wxTreeItemId &parentItem, EmberCore::ITreeNode *node);
    void ExpandTreeToDepth(const wxTreeItemId &item, int remainingDepth);
    void ExpandTreeByVisibility(const wxTreeItemId &item);
 
    // Event handlers
    void OnTreeItemExpanding(wxTreeEvent &event);
    void OnTreeItemCollapsing(wxTreeEvent &event);
    void OnTreeSelectionChanged(wxTreeEvent &event);
    void OnTreeItemRightClick(wxTreeEvent &event);
    void OnTreeItemActivated(wxTreeEvent &event);
    void OnSearchTextChanged(wxCommandEvent &event);
    void OnSearchEnter(wxCommandEvent &event);
 
    wxSearchCtrl *m_searchCtrl = nullptr;
    wxTreeCtrl *m_treeCtrl = nullptr;
    wxBoxSizer *m_mainSizer = nullptr;
 
    std::shared_ptr<EmberCore::ITreeStructure> m_tree;
    wxString m_searchFilter;
 
    SelectionCallback m_selectionCallback;
    LayoutInvalidationCallback m_layoutInvalidationCb;
    bool m_isRefreshing = false;
 
    enum { ID_TREE_CTRL = wxID_HIGHEST + 200, ID_SEARCH_CTRL };
 
    wxDECLARE_EVENT_TABLE();
};
 
} // namespace EmberUI