Tizen 2.4 SDK Rev6 Release

[framework/graphics/dali-toolkit.git] / dali-toolkit / public-api / controls / scrollable / item-view / item-layout.h

diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h b/dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h
index c93a61d..09197e1 100644 (file)
--- a/dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h
+++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h
@@ -40,7 +40,7 @@ class ItemLayout;
 typedef IntrusivePtr<ItemLayout> ItemLayoutPtr; ///< Pointer to ItemLayout object @since_tizen 2.4
 
 /**
- * @brief A support class for managing ranges of items.
+ * @brief A support class for managing ranges of items
  * @since_tizen 2.4
  */
 struct ItemRange
@@ -49,8 +49,8 @@ struct ItemRange
    * @brief Create a range of item identifiers.
    *
    * @since_tizen 2.4
-   * @param[in] beginItem The first item within the range.
-   * @param[in] endItem The past-the-end item.
+   * @param[in] beginItem The first item within the range
+   * @param[in] endItem The past-the-end item
    */
   ItemRange(unsigned int beginItem, unsigned int endItem)
   : begin(beginItem),
@@ -59,7 +59,7 @@ struct ItemRange
   }
 
   /**
-   * @brief Copy Constructor.
+   * @brief Copy Constructor
    *
    * @since_tizen 2.4
    * @param[in] copy ItemRange we should copy from.
@@ -71,11 +71,11 @@ struct ItemRange
   }
 
   /**
-   * @brief Assignment operator.
+   * @brief Assignment operator
    *
    * @since_tizen 2.4
-   * @param[in] range The Range to assign from.
-   * @return The updated range.
+   * @param[in] range The Range to assign from
+   * @return The updated range
    */
   ItemRange& operator=(const ItemRange& range)
   {
@@ -88,7 +88,7 @@ struct ItemRange
    * @brief Test whether an item is within the range.
    *
    * @since_tizen 2.4
-   * @param[in] itemId The item identifier.
+   * @param[in] itemId The item identifier
    * @return True if the item is within the range.
    */
   bool Within(unsigned int itemId)
@@ -101,8 +101,8 @@ struct ItemRange
    * @brief Create the intersection of two ranges.
    *
    * @since_tizen 2.4
-   * @param[in] second The second range.
-   * @return The intersection.
+   * @param[in] second The second range
+   * @return The intersection
    */
   ItemRange Intersection(const ItemRange& second)
   {
@@ -140,7 +140,7 @@ public:
   class Extension; ///< Forward declare future extension interface
 
   /**
-   * @brief Virtual destructor.
+   * @brief Virtual destructor
    * @since_tizen 2.4
    */
   DALI_IMPORT_API virtual ~ItemLayout();
@@ -149,7 +149,7 @@ public:
    * @brief Set the orientation of the layout.
    *
    * @since_tizen 2.4
-   * @param[in] orientation The orientation of the layout.
+   * @param[in] orientation The orientation of the layout
    */
   DALI_IMPORT_API void SetOrientation(ControlOrientation::Type orientation);
 
@@ -157,7 +157,7 @@ public:
    * @brief Query the orientation of the layout.
    *
    * @since_tizen 2.4
-   * @return the orientation of the layout.
+   * @return The orientation of the layout
    */
   DALI_IMPORT_API ControlOrientation::Type GetOrientation() const;
 
@@ -167,9 +167,9 @@ public:
    * This will return the default size for the layout unless overridden by calling SetItemSize().
    *
    * @since_tizen 2.4
-   * @param[in] itemId The ID of an item in the layout.
+   * @param[in] itemId The ID of an item in the layout
    * @param[in] layoutSize The layout size
-   * @param[out] itemSize The target size of an item.
+   * @param[out] itemSize The target size of an item
    * @note layout-position is not provided as a parameter, since applying size constraints is not recommended.
    * Animating to target-sizes is preferable, since this allows controls to perform layouting without constraints.
    */
@@ -179,7 +179,7 @@ public:
    * @brief Overrides the default size for the layout.
    *
    * @since_tizen 2.4
-   * @param[in] itemSize The size of each item.
+   * @param[in] itemSize The size of each item
    */
   DALI_IMPORT_API void SetItemSize( const Vector3& itemSize );
 
@@ -188,9 +188,9 @@ public:
    *
    * When scrolling, the first item will move within the range 0 to GetMinimumLayoutPosition().
    * @since_tizen 2.4
-   * @param[in] numberOfItems The current number of items in the layout.
-   * @param[in] layoutSize The size of the layout area.
-   * @return The minimum layout position.
+   * @param[in] numberOfItems The current number of items in the layout
+   * @param[in] layoutSize The size of the layout area
+   * @return The minimum layout position
    */
   virtual float GetMinimumLayoutPosition(unsigned int numberOfItems, Vector3 layoutSize) const = 0;
 
@@ -200,8 +200,8 @@ public:
    * This anchor position is the position where all the items in the layout are aligned to
    * their rounded layout positions in integer.
    * @since_tizen 2.4
-   * @param[in] layoutPosition The layout position.
-   * @return The closest anchor position for the given layout position.
+   * @param[in] layoutPosition The layout position
+   * @return The closest anchor position for the given layout position
    */
   virtual float GetClosestAnchorPosition(float layoutPosition) const = 0;
 
@@ -210,8 +210,8 @@ public:
    * needs to scroll to a particular item.
    *
    * @since_tizen 2.4
-   * @param[in] itemId The ID of an item in the layout.
-   * @return The layout position for the first item in the layout to move to.
+   * @param[in] itemId The ID of an item in the layout
+   * @return The layout position for the first item in the layout to move to
    */
   virtual float GetItemScrollToPosition(unsigned int itemId) const = 0;
 
@@ -219,9 +219,9 @@ public:
    * @brief Query the items within a given layout-area.
    *
    * @since_tizen 2.4
-   * @param[in] firstItemPosition The layout-position of the first item in the layout.
-   * @param[in] layoutSize The size of the layout area.
-   * @return The ID of the first & last visible item.
+   * @param[in] firstItemPosition The layout-position of the first item in the layout
+   * @param[in] layoutSize The size of the layout area
+   * @return The ID of the first & last visible item
    */
   virtual ItemRange GetItemsWithinArea(float firstItemPosition, Vector3 layoutSize) const = 0;
 
@@ -248,7 +248,7 @@ public:
    * @brief Query the number of items that should be reserved, for scrolling purposes.
    *
    * @since_tizen 2.4
-   * @param[in] layoutSize The size of the layout area.
+   * @param[in] layoutSize The size of the layout area
    * @return The number of extra items. ItemView will populate itself with actors within the layout-area
    * (see GetItemsWithinArea), plus this number of additional items on either-side.
    */
@@ -258,9 +258,9 @@ public:
    * @brief Retrieve the default size of an item in the layout.
    *
    * @since_tizen 2.4
-   * @param[in] itemId The ID of an item in the layout.
+   * @param[in] itemId The ID of an item in the layout
    * @param[in] layoutSize The layout size
-   * @param[out] itemSize The target size of an item.
+   * @param[out] itemSize The target size of an item
    * @note layout-position is not provided as a parameter, since applying size constraints is not recommended.
    * Animating to target-sizes is preferable, since this allows controls to perform layouting without constraints.
    */
@@ -272,7 +272,7 @@ public:
    * When an input gesture follows this direction, the layout-position of items will be increased.
    * If the input gesture points in the opposite direction, then the layout-positions will decrease.
    * @since_tizen 2.4
-   * @return The scroll direction in degrees.
+   * @return The scroll direction in degrees
    */
   virtual Degree GetScrollDirection() const = 0;
 
@@ -287,7 +287,7 @@ public:
    * Therefore, the bigger the factor is, the faster the scroll speed will be.
    *
    * @since_tizen 2.4
-   * @return The scroll speed factor of the layout.
+   * @return The scroll speed factor of the layout
    */
   virtual float GetScrollSpeedFactor() const = 0;
 
@@ -296,7 +296,7 @@ public:
    *
    * Swipe gestures will be clamped when exceeding this speed limit.
    * @since_tizen 2.4
-   * @return speed The maximum swipe speed.
+   * @return speed The maximum swipe speed
    */
   virtual float GetMaximumSwipeSpeed() const = 0;
 
@@ -307,7 +307,7 @@ public:
    * item to its next layout position (e.g. from 1.0 to 2.0) when a flick animation is triggered
    * by a swipe gesture.
    * @since_tizen 2.4
-   * @return The duration of the flick animation.
+   * @return The duration of the flick animation
    */
   virtual float GetItemFlickAnimationDuration() const = 0;
 
@@ -319,7 +319,7 @@ public:
    * @param[in] maxItems The maximum number of items in the list
    * @param[in] direction The directional key pressed on the keyboard
    * @param[in] loopEnabled Whether the KeyboardFocusManager is set to wrap around between first and last item
-   * @return The next item ID.
+   * @return The next item ID
    */
   DALI_IMPORT_API virtual int GetNextFocusItemID(int itemID, int maxItems, Dali::Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled);
 
@@ -334,16 +334,16 @@ public:
    * Therefore, the bigger the factor is, the faster the flick speed will be.
    *
    * @since_tizen 2.4
-   * @return The scroll speed factor of the layout.
+   * @return The scroll speed factor of the layout
    */
   DALI_IMPORT_API virtual float GetFlickSpeedFactor() const;
 
   /*
    * @brief Applies constraints defined by the layout to an actor.
    *
-   * @param[in] actor The actor to constrain.
-   * @param[in] itemId The ID of the item represented by the actor.
-   * @param[in] layoutSize the current size of the item view instance.
+   * @param[in] actor The actor to constrain
+   * @param[in] itemId The ID of the item represented by the actor
+   * @param[in] layoutSize The current size of the item view instance
    * @param[in] itemViewActor The item view instance which requests the application of constraints.
    */
   DALI_IMPORT_API virtual void ApplyConstraints( Actor& actor, const int itemId, const Vector3& layoutSize, const Actor& itemViewActor ) = 0;
@@ -352,9 +352,9 @@ public:
    * @brief Gets the position of a given item
    *
    * @since_tizen 2.4
-   * @param[in] itemID id of the item we want to get its position
-   * @param[in] currentLayoutPosition the current layout position of the item view instance
-   * @param[in] layoutSize the current size of the item view instance
+   * @param[in] itemID The id of the item we want to get its position
+   * @param[in] currentLayoutPosition The current layout position of the item view instance
+   * @param[in] layoutSize The current size of the item view instance
    * @return The item position (x,y,z)
    */
   DALI_IMPORT_API virtual Vector3 GetItemPosition(int itemID, float currentLayoutPosition, const Vector3& layoutSize) const = 0;
@@ -363,7 +363,7 @@ public:
    * @brief Retrieve the extension for this layout.
    *
    * @since_tizen 2.4
-   * @return The extension if available, NULL otherwise
+   * @return The extension if available, NULL otherwise.
    */
   virtual Extension* GetExtension()
   {