WidgetViewBase.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTCore/Flags.h"
#include "OTCore/OTClassHelper.h"
#include "OTCore/BasicEntityInformation.h"
#include "OTGui/OTGuiAPIExport.h"
 
// std header
#include <list>
#include <string>
 
#pragma warning(disable:4251)
 
namespace ot {
 
    class OT_GUI_API_EXPORT WidgetViewBase : public BasicEntityInformation {
        OT_DECL_NODEFAULT(WidgetViewBase)
    public:
        enum ViewFlag {
            NoViewFlags              = 0x00, 
            ViewIsCloseable          = 0x01, 
            ViewDefaultCloseHandling = 0x02, 
            ViewIsPinnable           = 0x04, 
            ViewIsCentral            = 0x10, 
            ViewIsSide               = 0x20, 
            ViewIsTool               = 0x40  
        };
        typedef Flags<ViewFlag> ViewFlags; 
 
        enum ViewDockLocation {
            Default, 
            Left, 
            Top, 
            Right, 
            Bottom 
        };
 
        enum ViewType {
            View3D, 
            View1D, 
            ViewText, 
            ViewTable, 
            ViewVersion, 
            ViewGraphics, 
            ViewGraphicsPicker, 
            ViewProperties, 
            ViewNavigation, 
            CustomView 
        };
 
        static std::string toString(ViewFlag _flag);
 
        static ViewFlag stringToViewFlag(const std::string& _flag);
 
        static std::list<std::string> toStringList(ViewFlags _flags);
 
        static ViewFlags stringListToViewFlags(const std::list<std::string>& _flags);
 
        static std::string toString(ViewDockLocation _dockLocation);
 
        static ViewDockLocation stringToDockLocation(const std::string& _dockLocation);
 
        static std::string toString(ViewType _type);
 
        static ViewType stringToViewType(const std::string& _type);
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        WidgetViewBase(ViewType _type, ViewFlags _flags = ViewFlags());
        WidgetViewBase(const std::string& _entityName, const std::string& _title, ViewType _type, ViewFlags _flags = ViewFlags());
        WidgetViewBase(const std::string& _entityName, const std::string& _title, ViewDockLocation _dockLocation, ViewType _type, ViewFlags _flags = ViewFlags());
        WidgetViewBase(const WidgetViewBase& _other);
        virtual ~WidgetViewBase();
 
        WidgetViewBase& operator = (const WidgetViewBase& _other);
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // Base class functions
 
        virtual void addToJsonObject(ot::JsonValue& _object, ot::JsonAllocator& _allocator) const override;
 
        virtual void setFromJsonObject(const ot::ConstJsonObject& _object) override;
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // Setter/Getter
 
        void setTitle(const std::string& _title) { m_title = _title; };
        const std::string& getTitle(void) const { return m_title; };
 
        void setViewFlag(ViewFlag _flag, bool _active = true) { m_flags.setFlag(_flag, _active); };
 
        void setViewFlags(ViewFlags _flags) { m_flags = _flags; };
 
        ViewFlags getViewFlags(void) const { return m_flags; };
 
        void setViewType(ViewType _type) { m_type = _type; };
        ViewType getViewType(void) const { return m_type; };
 
        void setDockLocation(ViewDockLocation _dockLocation) { m_dockLocation = _dockLocation; };
 
        ViewDockLocation getDockLocation(void) const { return m_dockLocation; };
 
        void setEntityInformation(const BasicEntityInformation& _info);
 
    private:
        std::string m_title; 
 
        ViewFlags m_flags; 
        ViewType m_type; 
        ViewDockLocation m_dockLocation; 
    };
 
}
 
OT_ADD_FLAG_FUNCTIONS(ot::WidgetViewBase::ViewFlag)