PropertyGroup.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTCore/Color.h"
#include "OTCore/Serializable.h"
#include "OTCore/OTClassHelper.h"
#include "OTGui/OTGuiAPIExport.h"
 
// std header
#include <list>
 
#pragma warning(disable:4251)
 
namespace ot {
 
    class Property;
 
    class OT_GUI_API_EXPORT PropertyGroup : public Serializable {
    public:
        PropertyGroup();
 
        PropertyGroup(const PropertyGroup& _other);
 
        PropertyGroup(const std::string& _name);
 
        PropertyGroup(const std::string& _name, const std::string& _title);
 
        virtual ~PropertyGroup();
 
        PropertyGroup& operator = (const PropertyGroup& _other);
 
        PropertyGroup* createCopy(bool _includeChilds) const;
 
        virtual void addToJsonObject(ot::JsonValue& _object, ot::JsonAllocator& _allocator) const override;
 
        virtual void setFromJsonObject(const ot::ConstJsonObject& _object) override;
 
        virtual void mergeWith(const PropertyGroup& _other, bool _replaceExistingProperties);
 
        void setParentGroup(PropertyGroup* _group) { m_parentGroup = _group; };
        PropertyGroup* getParentGroup(void) const { return m_parentGroup; };
 
        PropertyGroup* getRootGroup(void);
 
        void setName(const std::string& _name) { m_name = _name; };
        std::string& getName(void) { return m_name; };
        const std::string& getName(void) const { return m_name; };
 
        void setTitle(const std::string& _title) { m_title = _title; };
        std::string& getTitle(void) { return m_title; };
        const std::string& getTitle(void) const { return m_title; };
 
        void setProperties(const std::list<Property*>& _properties);
 
        void addProperty(Property* _property);
 
        void removeProperty(const std::string& _propertyName);
 
        void forgetProperty(Property* _property);
 
        const std::list<Property*>& getProperties(void) const { return m_properties; };
 
        std::list<Property*> getAllProperties(void) const;
 
        Property* findPropertyByPath(std::list<std::string> _path) const;
 
        void setChildGroups(const std::list<PropertyGroup*>& _groups);
 
        const std::list<PropertyGroup*>& getChildGroups(void) const { return m_childGroups; };
 
        void addChildGroup(PropertyGroup* _group);
 
        PropertyGroup* findGroup(const std::string& _name) const;
 
        void forgetChildGroup(PropertyGroup* _propertyGroup);
 
        void findPropertiesBySpecialType(const std::string& _specialType, std::list<Property*>& _list) const;
 
        void clear(bool _keepGroups = false);
 
        bool isEmpty(void) const;
 
        std::string getGroupPath(char _delimiter = '/') const;
 
    private:
        PropertyGroup* m_parentGroup;
 
        std::string m_name;
        std::string m_title;
        std::list<Property*> m_properties;
        std::list<PropertyGroup*> m_childGroups;
    };
 
}