//
/**
- * @addtogroup CAPI_DALI_FRAMEWORK
+ * @addtogroup CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE
* @{
*/
class ItemLayout;
-typedef IntrusivePtr<ItemLayout> ItemLayoutPtr;
+typedef IntrusivePtr<ItemLayout> ItemLayoutPtr; ///< Pointer to a Dali::Toolkit::ItemLayout object
-typedef std::vector<ItemLayoutPtr> ItemLayoutContainer;
-typedef ItemLayoutContainer::iterator ItemLayoutIter;
-typedef ItemLayoutContainer::const_iterator ItemLayoutConstIter;
+typedef std::vector<ItemLayoutPtr> ItemLayoutContainer; ///< Container of Dali::Toolkit::ItemLayout objects
+typedef ItemLayoutContainer::iterator ItemLayoutIter; ///< Iterator for Dali::Toolkit::ItemLayoutContainer
+typedef ItemLayoutContainer::const_iterator ItemLayoutConstIter; ///< Const Iterator for Dali::Toolkit::ItemLayoutContainer
+
+/**
+ * @brief A support class for managing ranges of items.
+ */
struct ItemRange
{
/**
- * Create a range of item identifiers.
+ * @brief Create a range of item identifiers.
+ *
* @param[in] beginItem The first item within the range.
* @param[in] endItem The past-the-end item.
*/
}
/**
- * Copy Constructor.
+ * @brief Copy Constructor.
+ *
* @param[in] copy ItemRange we should copy from.
*/
ItemRange(const ItemRange& copy)
}
/**
- * Assignment operator.
+ * @brief Assignment operator.
+ *
* @param[in] range The Range to assign from.
* @return The updated range.
*/
}
/**
- * Test whether an item is within the range.
+ * @brief Test whether an item is within the range.
+ *
* @param[in] itemId The item identifier.
* @return True if the item is within the range.
*/
}
/**
- * Create the intersection of two ranges.
+ * @brief Create the intersection of two ranges.
+ *
* @param[in] second The second range.
* @return The intersection.
*/
return intersection;
}
- unsigned int begin;
- unsigned int end;
+ unsigned int begin; ///< The start of the range
+ unsigned int end; ///< The end of the range
};
/**
- * An ItemLayout describes the constraints, which are imposed on items in the layout.
+ * @brief An ItemLayout describes the constraints which are imposed on items in the layout.
+ *
* - Potentially visible items are represented by Actors, created for ItemView by the ItemFactory.
* - Constraints are applied after ItemView activates a layout.
*
{
public:
+ /// @brief Function signature of a boolean constraint
typedef boost::function<bool (const bool& current, const float& layoutPosition, const float& scrollSpeed, const Vector3& layoutSize)> BoolFunction;
+
+ /// @brief Function signature of a Vector3 constraint
typedef boost::function<Vector3 (const Vector3& current, const float& layoutPosition, const float& scrollSpeed, const Vector3& layoutSize)> Vector3Function;
+
+ /// @brief Function signature of a Vector4 constraint
typedef boost::function<Vector4 (const Vector4& current, const float& layoutPosition, const float& scrollSpeed, const Vector3& layoutSize)> Vector4Function;
+
+ /// @brief Function signature of a Quaternion constraint
typedef boost::function<Quaternion (const Quaternion& current, const float& layoutPosition, const float& scrollSpeed, const Vector3& layoutSize)> QuaternionFunction;
/**
- * Virtual destructor.
+ * @brief Virtual destructor.
*/
virtual ~ItemLayout();
/**
- * Set the orientation of the layout.
+ * @brief Set the orientation of the layout.
+ *
* @param[in] orientation The orientation of the layout.
*/
void SetOrientation(ControlOrientation::Type orientation);
/**
- * Query the orientation of the layout.
+ * @brief Query the orientation of the layout.
+ *
* @return the orientation of the layout.
*/
ControlOrientation::Type GetOrientation() const;
/**
- * Query the minimum valid layout position; this is a negative value.
+ * @brief Query the minimum valid layout position; this is a negative value.
+ *
* When scrolling, the first item will move within the range 0 to GetMinimumLayoutPosition().
* @param[in] numberOfItems The current number of items in the layout.
* @param[in] layoutSize The size of the layout area.
virtual float GetMinimumLayoutPosition(unsigned int numberOfItems, Vector3 layoutSize) const = 0;
/**
- * Query the closest anchor position for the given layout position.
+ * @brief Query the closest anchor position for the given layout position.
+ *
* This anchor position is the position where all the items in the layout are aligned to
* their rounded layout positions in integer.
* @param[in] layoutPosition The layout position.
virtual float GetClosestAnchorPosition(float layoutPosition) const = 0;
/**
- * Query the layout position for the first item in the layout to move to when the layout
+ * @brief Query the layout position for the first item in the layout to move to when the layout
* needs to scroll to a particular item.
+ *
* @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;
/**
- * Query the items within a given layout-area.
+ * @brief Query the items within a given layout-area.
+ *
* @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;
/**
- * Get the closest layout position to bring an item onto the screen. If the item is already fully on the screen
- * this function will return the current layout position.
+ * @brief Get the closest layout position to bring an item onto the screen.
*
- * This function is used by systems such as KeyboardFocusManager to bring the next focusable item into view and all
- * layout implementations should provide their own version of this function to ensure proper functionality of
- * internal toolkit systems.
+ * If the item is already fully on the screen this function will
+ * return the current layout position.
+ *
+ * This function is used by systems such as KeyboardFocusManager to
+ * bring the next focusable item into view and all layout
+ * implementations should provide their own version of this function
+ * to ensure proper functionality of internal toolkit systems.
*
* @param[in] itemID id of the item to bring within the viewable screen area
* @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 layout position
*/
virtual float GetClosestOnScreenLayoutPosition(int itemID, float currentLayoutPosition, const Vector3& layoutSize);
/**
- * Query the number of items that should be reserved, for scrolling purposes.
+ * @brief Query the number of items that should be reserved, for scrolling purposes.
+ *
* @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.
virtual unsigned int GetReserveItemCount(Vector3 layoutSize) const = 0;
/**
- * Retrieve the target size of an item in the layout.
+ * @brief Retrieve the target size of an item in the layout.
+ *
* @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.
* @param[in] itemId The ID of an item in the layout.
virtual bool GetItemSize(unsigned int itemId, Vector3 layoutSize, Vector3& itemSize) const = 0;
/**
- * Retrieve the resize animation in the layout.
+ * @brief Retrieve the resize animation in the layout.
+ *
* @note This allows the layout to provide its own resize animation.
* @param[in] animation The resize animation, not owned by the layout
* @param[in] actor The actor to animate
virtual void GetResizeAnimation(Animation& animation, Actor actor, Vector3 size, float durationSeconds) const = 0;
/**
- * Retrieve the position constraint function of an item in the layout.
+ * @brief Retrieve the position constraint function of an item in the layout.
+ *
* The constraint will be applied when the item is created or the layout is activated.
* @param[in] itemId The ID of an item in the layout.
* @param[out] constraint The position constraint function of an item, or an uninitialized function pointer.
virtual bool GetPositionConstraint(unsigned int itemId, Vector3Function& constraint) const = 0;
/**
- * Retrieve the rotation constraint function of an item in the layout.
+ * @brief Retrieve the rotation constraint function of an item in the layout.
+ *
* The constraint will be applied when the item is created or the layout is activated.
* @param[in] itemId The ID of an item in the layout.
* @param[out] constraint The rotation constraint function of an item, or an uninitialized function pointer.
virtual bool GetRotationConstraint(unsigned int itemId, QuaternionFunction& constraint) const = 0;
/**
- * Retrieve the scale constraint function of an item in the layout.
+ * @brief Retrieve the scale constraint function of an item in the layout.
+ *
* The constraint will be applied when the item is created or the layout is activated.
* @param[in] itemId The ID of an item in the layout.
* @param[out] constraint The scale constraint function of an item, or an uninitialized function pointer.
virtual bool GetScaleConstraint(unsigned int itemId, Vector3Function& constraint) const = 0;
/**
- * Retrieve the color constraint function of an item in the layout.
+ * @brief Retrieve the color constraint function of an item in the layout.
+ *
* The constraint will be applied when the item is created or the layout is activated.
* @param[in] itemId The ID of an item in the layout.
* @param[out] constraint The color constraint function of an item, or an uninitialized function pointer.
virtual bool GetColorConstraint(unsigned int itemId, Vector4Function& constraint) const = 0;
/**
- * Retrieve the visibility constraint function of an item in the layout.
+ * @brief Retrieve the visibility constraint function of an item in the layout.
+ *
* The constraint will be applied when the item is created or the layout is activated.
* @param[in] itemId The ID of an item in the layout.
* @param[out] constraint The visibility constraint function of an item, or an uninitialized function pointer.
virtual bool GetVisibilityConstraint(unsigned int itemId, BoolFunction& constraint) const = 0;
/**
- * Query the scroll direction of the layout.
+ * @brief Query the scroll direction of the layout.
+ *
* 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.
* @return The scroll direction in degrees.
virtual Degree GetScrollDirection() const = 0;
/**
- * Tells scroll components how to interpolate our logical scroll position as a screen x/y direction
+ * @brief Tells scroll components how to interpolate our logical scroll position as a screen x/y direction.
*
* Application developer wants to use -ve y, +ve x as up direction and +ve y, -ve x as down direction scroll values in a
* vertical scroll type effect (SpiralLayout). This means that scroll bar/overshoot indicator should be affected by y-axis.
virtual void GetXAxisScrollHint(Vector2& scrollHint) const;
/**
- * Tells scroll components how to interpolate our logical scroll position as a screen x/y direction
+ * @brief Tells scroll components how to interpolate our logical scroll position as a screen x/y direction.
*
* Application developer wants to use -ve y, +ve x as up direction and +ve y, -ve x as down direction scroll values in a
* vertical scroll type effect (SpiralLayout). This means that scroll bar/overshoot indicator should be affected by y-axis.
virtual void GetYAxisScrollHint(Vector2& scrollHint) const;
/**
- * Query the scroll speed factor of the layout.
+ * @brief Query the scroll speed factor of the layout.
+ *
* This factor is used by the layout to customise its scroll speed while dragging and swiping.
* The factor will be multiplied with the scroll distance of how many pixels in actor coordinate,
* and the layout position of the actors in ItemView will be moved by this result.
virtual float GetScrollSpeedFactor() const = 0;
/**
- * Query the maximum swipe speed in pixels per second.
+ * @brief Query the maximum swipe speed in pixels per second.
+ *
* Swipe gestures will be clamped when exceeding this speed limit.
* @return speed The maximum swipe speed.
*/
virtual float GetMaximumSwipeSpeed() const = 0;
/**
- * Get the duration of the flick animation in second. This is the time taken to animate each
+ * @brief Get the duration of the flick animation in second.
+ *
+ * This is the time taken to animate each
* item to its next layout position (e.g. from 1.0 to 2.0) when a flick animation is triggered
* by a swipe gesture.
* @return The duration of the flick animation.
virtual float GetItemFlickAnimationDuration() const = 0;
/**
- * Gets the id of the next item for KeyboardFocusManager to focus on depending on the inputted item ID
+ * @brief Gets the id of the next item for KeyboardFocusManager to focus on depending on the inputted item ID.
*
* @param[in] itemID The current focused item
* @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.
*/
virtual int GetNextFocusItemID(int itemID, int maxItems, Dali::Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
protected:
/**
- * Create a new ItemLayout; Only derived versions are instantiatable.
+ * @brief Create a new ItemLayout; Only derived versions are instantiatable.
*/
ItemLayout();
protected:
- ControlOrientation::Type mOrientation;
+ ControlOrientation::Type mOrientation; ///< the orientation of the layout.
};
} // namespace Toolkit
projects / platform / core / uifw / dali-toolkit.git / blobdiff