X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fobject%2Fproperty-input.h;h=2d85d2d72ca4681cf8b0cb033e359b1e1423422f;hb=refs%2Fchanges%2F57%2F114957%2F2;hp=24ac833c934171fcd50d5b30ee5df5d0546e5d30;hpb=a86ae47738c5baf9707e366912e1f52dbba39129;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/object/property-input.h b/dali/public-api/object/property-input.h index 24ac833..2d85d2d 100644 --- a/dali/public-api/object/property-input.h +++ b/dali/public-api/object/property-input.h @@ -23,6 +23,10 @@ namespace Dali { +/** + * @addtogroup dali_core_object + * @{ + */ struct Vector2; struct Vector3; @@ -33,6 +37,7 @@ class Quaternion; /** * @brief An abstract interface for receiving property values. + * @SINCE_1_0.0 */ class DALI_IMPORT_API PropertyInput { @@ -42,99 +47,103 @@ public: /** * @brief Virtual destructor. + * @SINCE_1_0.0 */ virtual ~PropertyInput() = 0; /** - * @brief Query the type of property input. + * @brief Queries the type of property input. * - * @return The property type. + * @SINCE_1_0.0 + * @return The property type */ virtual Property::Type GetType() const = 0; /** - * @brief Retrieve a boolean value. + * @brief Retrieves a boolean value. * + * @SINCE_1_0.0 + * @return The boolean value * @pre GetType() returns Property::BOOLEAN. - * @return The boolean value. */ virtual const bool& GetBoolean() const = 0; /** - * @brief Retrieve a float value. + * @brief Retrieves a float value. * + * @SINCE_1_0.0 + * @return The float value * @pre GetType() returns Property::FLOAT. - * @return The float value. */ virtual const float& GetFloat() const = 0; /** - * @brief Retrieve an integer value. + * @brief Retrieves an integer value. * + * @SINCE_1_0.0 + * @return The integer value * @pre GetType() returns Property::INTEGER. - * @return The integer value. */ virtual const int& GetInteger() const = 0; /** - * @brief Retrieve an integer value. - * - * @pre GetType() returns Property::UNSIGNED_INTEGER. - * @return The integer value. - */ - virtual const unsigned int& GetUnsignedInteger() const = 0; - - /** - * @brief Retrieve a Vector2 value. + * @brief Retrieves a Vector2 value. * + * @SINCE_1_0.0 + * @return The Vector2 value * @pre GetType() returns Property::VECTOR2. - * @return The Vector2 value. */ virtual const Vector2& GetVector2() const = 0; /** - * @brief Retrieve a Vector3 value. + * @brief Retrieves a Vector3 value. * + * @SINCE_1_0.0 + * @return The Vector3 value * @pre GetType() returns Property::VECTOR3. - * @return The Vector3 value. */ virtual const Vector3& GetVector3() const = 0; /** - * @brief Retrieve a Vector4 value. + * @brief Retrieves a Vector4 value. * + * @SINCE_1_0.0 + * @return The Vector4 value * @pre GetType() returns Property::VECTOR4. - * @return The Vector4 value. */ virtual const Vector4& GetVector4() const = 0; /** - * @brief Retrieve a Matrix (3x3) value. + * @brief Retrieves a Matrix (3x3) value. * + * @SINCE_1_0.0 + * @return The Matrix value * @pre GetType() returns Property::Matrix3. - * @return The Matrix value. */ virtual const Matrix3& GetMatrix3() const = 0; /** - * @brief Retrieve a Matrix (4x4) value. + * @brief Retrieves a Matrix (4x4) value. * + * @SINCE_1_0.0 + * @return The Matrix value * @pre GetType() returns Property::Matrix4. - * @return The Matrix value. */ virtual const Matrix& GetMatrix() const = 0; /** - * @brief Retrieve a Quaternion value. + * @brief Retrieves a Quaternion value. * + * @SINCE_1_0.0 + * @return The Quaternion value * @pre GetType() returns Property::Quaternion. - * @return The Quaternion value. */ virtual const Quaternion& GetQuaternion() const = 0; /** - * Retrieve the extension for the PropertyInput + * @brief Retrieves the extension for the PropertyInput * + * @SINCE_1_0.0 * @return The extension if available, NULL otherwise */ virtual Extension* GetExtension() @@ -143,6 +152,9 @@ public: } }; +/** + * @} + */ } // namespace Dali #endif // __DALI_PROPERTY_INPUT_H__