#define __DALI_PROPERTY_H__
/*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2016 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <utility>
// INTERNAL INCLUDES
-#include <dali/public-api/common/vector-wrapper.h>
#include <dali/public-api/common/dali-common.h>
#include <dali/public-api/common/dali-vector.h>
typedef int Index;
static const int INVALID_INDEX; ///< -1 is not a valid property index
+ static const int INVALID_KEY; ///< -1 is not a valid property key
static const int INVALID_COMPONENT_INDEX; ///< -1 is not a valid property index
typedef Dali::Vector< Index > IndexContainer; ///< A vector of property indices @SINCE_1_0.0
class Value;
/**
+ * @brief A Key used by Map
+ */
+ struct Key;
+
+ /**
* @brief A Map of property values.
*/
class Map;
class Array;
/**
- * @brief The property types supported.
+ * @brief Enumeration for the property types supported.
* @SINCE_1_0.0
*/
enum Type
ROTATION, ///< either a quaternion or an axis angle rotation @SINCE_1_0.0
STRING, ///< A string type @SINCE_1_0.0
ARRAY, ///< an array of Property::Value @SINCE_1_0.0
- MAP ///< a string key to Property:value mapping @SINCE_1_0.0
+ MAP, ///< a string key to Property:value mapping @SINCE_1_0.0
+ EXTENTS ///< a collection of 4 x uint16_t @SINCE_1_2.62
};
/**
- * @brief The access mode for custom properties
+ * @brief Enumeration for the access mode for custom properties.
* @SINCE_1_0.0
*/
enum AccessMode
/**
- * @brief Create a Property instance.
+ * @brief Creates a Property instance.
*
* @SINCE_1_0.0
- * @param [in] object A valid handle to the target object.
- * @param [in] propertyIndex The index of a property.
+ * @param[in] object A valid handle to the target object
+ * @param[in] propertyIndex The index of a property
*/
Property( Handle& object, Property::Index propertyIndex );
/**
- * @brief Create a Property instance.
+ * @brief Creates a Property instance.
*
* @SINCE_1_0.0
- * @param [in] object A valid handle to the target object.
- * @param [in] propertyIndex The index of a property.
- * @param [in] componentIndex Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)
+ * @param[in] object A valid handle to the target object.
+ * @param[in] propertyIndex The index of a property.
+ * @param[in] componentIndex Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)
*/
Property( Handle& object, Property::Index propertyIndex, int componentIndex );
/**
- * @brief Create a Property instance.
+ * @brief Creates a Property instance.
*
* @SINCE_1_0.0
- * @param [in] object A valid handle to the target object.
- * @param [in] propertyName The property name.
+ * @param[in] object A valid handle to the target object
+ * @param[in] propertyName The property name
* @note This performs a property index query and is therefore slower than
* constructing a Property directly with the index.
*/
Property( Handle& object, const std::string& propertyName );
/**
- * @brief Create a Property instance.
+ * @brief Creates a Property instance.
*
* @SINCE_1_0.0
- * @param [in] object A valid handle to the target object.
- * @param [in] propertyName The property name.
- * @param [in] componentIndex Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)
+ * @param[in] object A valid handle to the target object
+ * @param[in] propertyName The property name
+ * @param[in] componentIndex Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)
* @note This performs a property index query and is therefore slower than
* constructing a Property directly with the index.
*/