PropertyFilePath.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTGui/Property.h"
 
// std header
#include <string>
 
namespace ot {
 
    class OT_GUI_API_EXPORT PropertyFilePath : public Property {
        OT_DECL_NOCOPY(PropertyFilePath)
    public:
        enum BrowseMode {
            ReadFile = 0,
            WriteFile = 1
        };
 
        struct FilterInfo {
            std::string extension;
            std::string text;
        };
 
        PropertyFilePath(const PropertyFilePath* _other);
        PropertyFilePath(const PropertyBase& _base);
        PropertyFilePath(BrowseMode _mode = ReadFile, PropertyFlags _flags = PropertyFlags(NoFlags));
        PropertyFilePath(const std::string& _path, BrowseMode _mode = ReadFile, PropertyFlags _flags = PropertyFlags(NoFlags));
        PropertyFilePath(const std::string& _name, const std::string& _path, BrowseMode _mode = ReadFile, PropertyFlags _flags = PropertyFlags(NoFlags));
        virtual ~PropertyFilePath() {};
 
        static std::string propertyTypeString(void) { return "FilePath"; };
        virtual std::string getPropertyType(void) const override { return PropertyFilePath::propertyTypeString(); };
 
        virtual Property* createCopy(void) const override;
 
        void setPath(const std::string& _path) { m_path = _path; };
        const std::string& getPath(void) const { return m_path; };
 
        void setBrowseMode(BrowseMode _mode) { m_browseMode = _mode; };
        BrowseMode getBrowseMode(void) const { return m_browseMode; };
 
        void setFilters(const std::list<FilterInfo>& _filters) { m_filters = _filters; };
        void addFilter(const std::string& _extension, const std::string& _text) { this->addFilter(FilterInfo{ _extension, _text }); };
        void addFilter(const FilterInfo& _info);
        const std::list<FilterInfo>& getFilters(void) const { return m_filters; }
 
    protected:
        virtual void getPropertyData(ot::JsonValue& _object, ot::JsonAllocator& _allocator) const override;
 
        virtual void setPropertyData(const ot::ConstJsonObject& _object) override;
 
    private:
        std::string m_path;
        BrowseMode m_browseMode;
        std::list<FilterInfo> m_filters;
    };
 
}