NavigationTreeItem.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTCore/Serializable.h"
#include "OTGui/GuiTypes.h"
#include "OTGui/OTGuiAPIExport.h"
 
// std header
#include <list>
#include <string>
 
#pragma warning(disable:4251)
 
namespace ot {
 
    enum NavigationTreeItemFlag {
        NoNavigationTreeItemFlags = 0x00, 
        RemoveItemWhenEmpty       = 0x01, 
        ItemMayBeAdded            = 0x02, 
        ItemIsSelected            = 0x04, 
        ItemIsInvisible           = 0x08  
    };
    typedef Flags<NavigationTreeItemFlag> NavigationTreeItemFlags;
 
    OT_GUI_API_EXPORT std::string toString(NavigationTreeItemFlag _flag);
    OT_GUI_API_EXPORT std::list<std::string> toStringList(NavigationTreeItemFlags _flags);
    OT_GUI_API_EXPORT NavigationTreeItemFlag stringToNavigationItemFlag(const std::string& _flag);
    OT_GUI_API_EXPORT NavigationTreeItemFlags stringListToNavigationItemFlags(const std::list<std::string>& _flags);
 
    class OT_GUI_API_EXPORT NavigationTreeItem : public ot::Serializable {
    public:
        NavigationTreeItem();
        NavigationTreeItem(const std::string& _text, ot::NavigationTreeItemFlags _flags = ot::NoNavigationTreeItemFlags);
        NavigationTreeItem(const std::string& _text, const std::string& _iconPath, ot::NavigationTreeItemFlags _flags = ot::NoNavigationTreeItemFlags);
        NavigationTreeItem(const std::string& _text, const std::string& _iconPath, const std::list<NavigationTreeItem>& _childItems, ot::NavigationTreeItemFlags _flags = ot::NoNavigationTreeItemFlags);
        NavigationTreeItem(const NavigationTreeItem& _other);
        virtual ~NavigationTreeItem();
 
        NavigationTreeItem& operator = (const NavigationTreeItem& _other);
 
        virtual void addToJsonObject(ot::JsonValue& _object, ot::JsonAllocator& _allocator) const override;
 
        virtual void setFromJsonObject(const ot::ConstJsonObject& _object) override;
 
        void setText(const std::string& _text) { m_text = _text; };
        const std::string text(void) const { return m_text; };
 
        void setIconPath(const std::string& _iconPath) { m_iconPath = _iconPath; };
        const std::string& iconPath(void) const { return m_iconPath; };
 
        void addChildItem(const NavigationTreeItem& _item);
        void setChildItems(const std::list<NavigationTreeItem>& _items);
        const std::list<NavigationTreeItem>& childItems(void) const { return m_childs; };
 
        void setFlag(NavigationTreeItemFlag _flag, bool _active = true) { m_flags.setFlag(_flag, _active); };
        void setFlags(ot::NavigationTreeItemFlags _flags) { m_flags = _flags; };
        ot::NavigationTreeItemFlags flags(void) const { return m_flags; };
 
        void merge(const NavigationTreeItem& _other);
 
        std::string itemPath(char _delimiter = '/', const std::string& _suffix = std::string()) const;
 
        bool filter(NavigationTreeItemFlags _flags);
 
    protected:
        void setParentNavigationTreeItem(NavigationTreeItem* _parent) { m_parent = _parent; };
        NavigationTreeItem* parentNavigationTreeItem(void) const { return m_parent; };
 
    private:
        NavigationTreeItem* m_parent;
 
        std::string m_text;
        std::string m_iconPath;
        std::list<NavigationTreeItem> m_childs;
        ot::NavigationTreeItemFlags m_flags;
 
    };
 
}
 
OT_ADD_FLAG_FUNCTIONS(ot::NavigationTreeItemFlag)