[dali_1.1.28] Merge branch 'devel/master'

[platform/core/uifw/dali-core.git] / dali / public-api / object / property-map.h

diff --git a/dali/public-api/object/property-map.h b/dali/public-api/object/property-map.h
index 8c1be41..902947d 100644 (file)
--- a/dali/public-api/object/property-map.h
+++ b/dali/public-api/object/property-map.h
@@ -28,10 +28,16 @@
 
 namespace Dali
 {
+/**
+ * @addtogroup dali_core_object
+ * @{
+ */
+
 typedef std::pair<std::string, Property::Value> StringValuePair;
 
 /**
  * @brief A Map of property values.
+ * @SINCE_1_0.0
  */
 class DALI_IMPORT_API Property::Map
 {
@@ -41,24 +47,28 @@ public:
 
   /**
    * @brief Default constructor.
+   * @SINCE_1_0.0
    */
   Map();
 
   /**
    * @brief Copy Constructor.
    *
+   * @SINCE_1_0.0
    * @param[in] other The Map to copy from.
    */
   Map( const Map& other );
 
   /**
    * @brief Non-virtual destructor.
+   * @SINCE_1_0.0
    */
   ~Map();
 
   /**
    * @brief Retrieve the number of elements in the map.
    *
+   * @SINCE_1_0.0
    * @return The number of elements in the map.
    */
   SizeType Count() const;
@@ -66,6 +76,7 @@ public:
   /**
    * @brief Returns whether the map is empty.
    *
+   * @SINCE_1_0.0
    * @return true if empty, false otherwise
    */
   bool Empty() const;
@@ -74,6 +85,7 @@ public:
    * @brief Inserts the key-value pair in the Map.
    *
    * Does not check for duplicates
+   * @SINCE_1_0.0
    * @param key to insert
    * @param value to insert
    */
@@ -83,6 +95,7 @@ public:
    * @brief Inserts the key-value pair in the Map.
    *
    * Does not check for duplicates
+   * @SINCE_1_0.0
    * @param key to insert
    * @param value to insert
    */
@@ -91,6 +104,7 @@ public:
   /**
    * @brief Retrieve the value at the specified position.
    *
+   * @SINCE_1_0.0
    * @return A reference to the value at the specified position.
    *
    * @note Will assert if position >= Count()
@@ -100,6 +114,7 @@ public:
   /**
    * @brief Retrieve the key at the specified position.
    *
+   * @SINCE_1_0.0
    * @return A const reference to the key at the specified position.
    *
    * @note Will assert if position >= Count()
@@ -109,6 +124,7 @@ public:
   /**
    * @brief Retrieve the key & the value at the specified position.
    *
+   * @SINCE_1_0.0
    * @return A reference to the pair of key and value at the specified position.
    *
    * @note Will assert if position >= Count()
@@ -118,6 +134,7 @@ public:
   /**
    * @brief Finds the value for the specified key if it exists.
    *
+   * @SINCE_1_0.0
    * @param[in]  key   The key to find.
    *
    * @return A const pointer to the value if it exists, NULL otherwise
@@ -127,6 +144,7 @@ public:
   /**
    * @brief Finds the value for the specified key if it exists.
    *
+   * @SINCE_1_0.0
    * @param[in]  key   The key to find.
    *
    * @return A const pointer to the value if it exists, NULL otherwise
@@ -136,6 +154,7 @@ public:
   /**
    * @brief Finds the value for the specified key if it exists and its type is type
    *
+   * @SINCE_1_0.0
    * @param[in]  key   The key to find.
    * @param[in]  type  The type to check.
    *
@@ -145,6 +164,7 @@ public:
 
   /**
    * @brief Clears the map.
+   * @SINCE_1_0.0
    */
   void Clear();
 
@@ -153,6 +173,7 @@ public:
    *
    * Any values in 'from' will overwrite the values in the current map.
    *
+   * @SINCE_1_0.0
    * @param[in]  from  The map to merge from.
    */
   void Merge( const Map& from );
@@ -160,6 +181,7 @@ public:
   /**
    * @brief Const operator to access element with the specified key.
    *
+   * @SINCE_1_0.0
    * @param[in] key The key whose value to access.
    *
    * @return The value for the element with the specified key, if key doesn't exist, then Property::NONE is returned.
@@ -171,6 +193,7 @@ public:
   /**
    * @brief Operator to access the element with the specified key.
    *
+   * @SINCE_1_0.0
    * @param[in] key The key whose value to access.
    *
    * @return A reference to the value for the element with the specified key.
@@ -182,17 +205,38 @@ public:
   /**
    * @brief Assignment Operator
    *
+   * @SINCE_1_0.0
    * @param[in] other The map to copy from.
    *
    * @return The copied map.
    */
   Map& operator=( const Map& other );
 
+  /**
+   * @brief output to stream
+   * @SINCE_1_1.28
+   */
+  friend std::ostream& operator<<( std::ostream& stream, const Property::Map& map );
+
 private:
   struct DALI_INTERNAL Impl; ///< Private data
   Impl* mImpl; ///< Pointer to private data
 };
 
+/**
+ * @brief Convert the key/value pairs of the property map into a string and append to an output stream.
+ *
+ * @SINCE_1_1.28
+ * @param [in] stream The output stream operator.
+ * @param [in] map The map to insert
+ * @return The output stream operator.
+ */
+DALI_IMPORT_API std::ostream& operator<<( std::ostream& stream, const Property::Map& map );
+
+
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_MAP_H__