CTreeControl.h

/*
╔══════════════════════════════════════════════════════════════════════════════╗
║                       SIMPLY POWERFUL TOOLKIT (SPTK)                         ║
╟──────────────────────────────────────────────────────────────────────────────╢
║  copyright            © 1999-2022 Alexey Parshin. All rights reserved.       ║
║  email                alexeyp@gmail.com                                      ║
╚══════════════════════════════════════════════════════════════════════════════╝
┌──────────────────────────────────────────────────────────────────────────────┐
│   This library is free software; you can redistribute it and/or modify it    │
│   under the terms of the GNU Library General Public License as published by  │
│   the Free Software Foundation; either version 2 of the License, or (at your │
│   option) any later version.                                                 │
│                                                                              │
│   This library 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 Library   │
│   General Public License for more details.                                   │
│                                                                              │
│   You should have received a copy of the GNU Library General Public License  │
│   along with this library; if not, write to the Free Software Foundation,    │
│   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.               │
│                                                                              │
│   Please report all bugs and problems to alexeyp@gmail.com.                  │
└──────────────────────────────────────────────────────────────────────────────┘
*/
 
#pragma once
 
#include <FL/Fl_Pixmap.H>
#include <FL/Fl_Widget.H>
#include <sptk5/gui/CGroup.h>
#include <sptk5/gui/CLayoutClient.h>
#include <sptk5/gui/CScroll.h>
 
#include <string>
#include <vector>
 
namespace sptk {
 
class CTreeItem;
 
class CTreeControl;
 
using CTreeItemCreator = CLayoutClient* (*) (CTreeItem* item);
 
class SP_EXPORT CTreeItem
    : public CGroup
{
    int m_itemHeight {0};
 
    int m_indent {0};
 
    bool m_selected {false};
 
    Fl_Color m_itemColor[2] {};
 
    CLayoutClient* m_body {nullptr};
 
    const Fl_Image* m_openedImage {nullptr};
 
    const Fl_Image* m_closedImage {nullptr};
 
    bool m_opened {false};
 
    CTreeControl* m_tree {nullptr};
 
protected:
    CTreeItem* addPathOffset(const std::vector<String>& pathFolders, uint32_t offset, const Fl_Image* openedImage,
                             const Fl_Image* closedImage, const Fl_Image* itemImage = 0L, void* data = 0L);
 
    static const Fl_Image* treeOpened;
 
    static const Fl_Image* treeClosed;
 
    static const Fl_Image* folderOpened;
 
    static const Fl_Image* folderClosed;
 
    static const Fl_Image* document;
 
public:
    CTreeItem(const char* label, const Fl_Image* openedImage = nullptr, const Fl_Image* closedImage = nullptr,
              void* data = nullptr);
 
    CTreeItem* addItem(const char* label, const Fl_Image* openedImage = nullptr, const Fl_Image* closedImage = nullptr,
                       void* data = nullptr);
 
    CTreeItem* addPath(const std::vector<String>& path, const Fl_Image* openedImage, const Fl_Image* closedImage,
                       const Fl_Image* itemImage = 0L, void* data = 0L);
 
    CTreeItem* addPath(const std::vector<String>& path, const Fl_Image* itemImage = 0L, void* data = 0L);
 
    CLayoutClient* body()
    {
        return m_body;
    }
 
    void label(const String& lbl) override;
 
    const String& label() const override
    {
        return m_body->label();
    }
 
    void clear() override;
 
    CTreeItem* findItem(const char* label) const;
 
    CTreeItem* findData(const void* data) const;
 
    void removeItem(CTreeItem* item);
 
    CTreeItem* parentItem() const;
 
    CTreeControl* tree() const
    {
        return m_tree;
    }
 
    void moveItem(CTreeItem* item, CTreeItem* beforeItem = nullptr);
 
    void moveItem(CTreeItem* item, int direction);
 
    void visibleChildren(bool vc);
 
    void open()
    {
        visibleChildren(true);
    }
 
    void close()
    {
        visibleChildren(false);
    }
 
    bool opened() const
    {
        return m_opened;
    }
 
    uint32_t indent() const
    {
        return m_indent;
    }
 
    void setImage(const Fl_Image* openedImage, const Fl_Image* closedImage = nullptr)
    {
        m_openedImage = openedImage;
        m_closedImage = closedImage;
    }
 
    int handle(int event) override;
 
    void draw() override;
 
    bool preferredSize(int& w, int& h) override;
 
    void resize(int xx, int yy, int ww, int hh) override;
 
    virtual void select(bool flag);
 
    bool selected() const
    {
        return m_selected;
    }
 
    bool selectNext();
 
    bool selectPrior();
 
    CTreeItem* findFirst() const;
 
    CTreeItem* findLast(bool recursive) const;
 
    CTreeItem* findNext(bool recursive) const;
 
    CTreeItem* findPrior(bool recursive) const;
 
    String className() const override
    {
        return "treeitem";
    }
 
    static const Fl_Image* getTreeOpened();
 
    static void setTreeOpened(const Fl_Image* image);
 
    static const Fl_Image* getTreeClosed();
 
    static void setTreeClosed(const Fl_Image* image);
 
    static const Fl_Image* getFolderOpened();
 
    static void setFolderOpened(const Fl_Image* image);
 
    static const Fl_Image* getFolderClosed();
 
    static void setFolderClosed(const Fl_Image* image);
 
    static const Fl_Image* getDocument();
 
    static void setDocument(const Fl_Image* image);
};
 
using CTreeItemVector = std::vector<CTreeItem*>;
 
class SP_EXPORT CTreeControl
    : public CScroll
{
    friend class CTreeItem;
 
    CTreeItemVector m_selectedItems;
 
    CTreeItem* m_root;
 
    bool m_tabPressed;
 
    CTreeItemCreator m_itemCreator;
 
protected:
    static CLayoutClient* defaultItemCreator(CTreeItem* item);
 
public:
    CTreeControl(const char* label, int layoutSize = 50, CLayoutAlign align = CLayoutAlign::TOP);
 
    CTreeItem* addItem(const char* label, const Fl_Image* openedImage = nullptr, const Fl_Image* closedImage = nullptr,
                       void* data = nullptr);
 
    CTreeItem* addPath(const std::vector<String>& path, const Fl_Image* openedImage, const Fl_Image* closedImage,
                       const Fl_Image* itemImage = 0L, void* data = 0L);
 
    CTreeItem* addPath(const std::vector<String>& path, const Fl_Image* itemImage = 0L, void* data = 0L);
 
    CTreeItem* findItem(const char* item) const;
 
    CTreeItem* findData(const void* data) const;
 
    void clear() override
    {
        m_selectedItems.clear();
        m_root->clear();
    }
 
    static void moveItem(CTreeItem* item, CTreeItem* beforeItem = nullptr);
 
    void removeItem(CTreeItem* item);
 
    CTreeItem* root() const
    {
        return m_root;
    }
 
    CTreeItem* selected() const
    {
        if (m_selectedItems.empty())
        {
            return 0;
        }
 
        return m_selectedItems[0];
    }
 
    void selectOnly(CTreeItem* item, bool giveFocus = false);
 
    void makeVisible(CTreeItem* item);
 
    int handle(int event) override;
 
    void itemCreator(CTreeItemCreator ic)
    {
        m_itemCreator = ic;
    }
 
    void load(const xdoc::SNode& node, CLayoutXMLmode xmlMode) override;
 
    void save(const xdoc::SNode& node, CLayoutXMLmode xmlMode) const override;
 
    String className() const override
    {
        return "tree";
    }
};
} // namespace sptk