ManagedGuiObject.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTCore/OTClassHelper.h"
#include "OTCore/BasicServiceInformation.h"
#include "OTGui/GuiTypes.h"
#include "OTWidgets/OTWidgetsAPIExport.h"
 
// std header
#include <map>
#include <string>
 
namespace ot {
    
    class OT_WIDGETS_API_EXPORT ManagedGuiObject {
        OT_DECL_NOCOPY(ManagedGuiObject)
    public:
        ManagedGuiObject();
        virtual ~ManagedGuiObject();
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // Setter / Getter
 
        void setGuiObjectOwner(const BasicServiceInformation& _owner) { m_owner = _owner; };
        const BasicServiceInformation& getGuiObjectOwner(void) const { return m_owner; };
 
        void setGuiObjectKey(const std::string& _key) { m_key = _key; };
        const std::string& getGuiObjectKey(void) const { return m_key; };
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // State management
 
        void setGuiObjectEnabled(bool _enabled, int _counter = 1);
 
        void resetGuiObjectDisabledCounter(void);
 
        void lockGuiObject(const LockTypeFlags& _flags, int _lockCount = 1);
 
        void unlockGuiObject(const LockTypeFlags& _flags, int _unlockCount = 1);
 
        void resetGuiObjectLockCounter(void);
 
    protected:
        virtual void updateGuiObjectEnabledState(bool _enabled) = 0;
 
    private:
        void lockGuiObjectFlag(LockTypeFlag _flag, int _lockCount);
        void unlockGuiObjectFlag(LockTypeFlag _flag, int _unlockCount);
 
        void evaluateEnabledState(void);
        int& getLockCounter(LockTypeFlag _flag);
 
        BasicServiceInformation m_owner;
        std::string m_key;
        bool m_isEnabled;
        int m_disabledCounter;
        std::map<LockTypeFlag, int> m_lockCounter;
    };
 
}