* |---------------------------------|--------------------------------------------|
* | layoutActivated | @ref LayoutActivatedSignal() |
* @SINCE_1_0.0
+ *
+ * Actions
+ * | %Action Name | Attributes | Description |
+ * |---------------|-------------------------|-------------------------------------------------|
+ * | stopScrolling | Doesn't have attributes | Stops the scroll animation. See @ref DoAction() |
+ * @SINCE_1_1.33
*/
class DALI_IMPORT_API ItemView : public Scrollable
{
public:
+ /**
+ * @brief The start and end property ranges for this control.
+ * @SINCE_1_1.18
+ */
enum PropertyRange
{
PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.18
};
/**
- * @brief An enumeration of properties belonging to the ScrollView class.
+ * @brief Enumeration for the instance of properties belonging to the ScrollView class.
* @SINCE_1_0.0
*/
struct Property
{
+ /**
+ * @brief Enumeration for the instance of properties belonging to the ScrollView class.
+ * @SINCE_1_0.0
+ */
enum
{
// Event side properties
/**
* @brief Copy constructor.
* @SINCE_1_0.0
+ * @param[in] itemView Handle to an object
*/
ItemView( const ItemView& itemView );
/**
* @brief Assignment operator.
* @SINCE_1_0.0
+ * @param[in] itemView Handle to an object
+ * @return A reference to this
*/
ItemView& operator=( const ItemView& itemView );
static ItemView New(ItemFactory& factory);
/**
- * @brief Downcast an Object handle to ItemView.
+ * @brief Downcast a handle to ItemView handle.
*
* If handle points to a ItemView the downcast produces valid
* handle. If not the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle Handle to an object
- * @return handle to a ItemView or an uninitialized handle
+ * @return A handle to a ItemView or an uninitialized handle
*/
static ItemView DownCast( BaseHandle handle );
void ScrollToItem(ItemId itemId, float durationSeconds);
/**
- * @brief Set the interval between refreshes. When the layout-position of items is changed by this interval,
+ * @brief Set the interval between refreshes.
+ *
+ * When the layout-position of items is changed by this interval,
* new items are requested from ItemFactory.
*
* @SINCE_1_0.0
*
* A relayout will occur for the remaining actors; for example if RemoveItem(Item(2, ActorZ), 0) is called,
* the items with ID 3 or greater will be moved:
- * Initial actors: After remove:
- * ID 1 - ActorA ID 1 - ActorA
- * ID 2 - ActorB ID 2 - ActorC (previously ID 3)
- * ID 3 - ActorC ID 3 - ActorB (previously ID 4)
- * ID 4 - ActorD
+ * | Initial actors: | After remove: |
+ * |:------------------ |:-------------- |
+ * | ID 1 - ActorA | ID 1 - ActorA |
+ * | ID 2 - ActorB | ID 2 - ActorC (previously ID 3) |
+ * | ID 3 - ActorC | ID 3 - ActorB (previously ID 4) |
+ * | ID 4 - ActorD | |
* @SINCE_1_0.0
* @param[in] itemId The Item ID of the item to remove.
* @param[in] durationSeconds How long the relayout takes in seconds.
void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
/**
- * @brief Set the parent origin of the items
+ * @brief Set the parent origin of the items.
*
* A relayout will occur for all the items if the parent origin is different than the current one.
* @SINCE_1_0.0
void SetItemsParentOrigin( const Vector3& parentOrigin );
/**
- * @brief Get the parent origin of the items
+ * @brief Get the parent origin of the items.
*
* @SINCE_1_0.0
* @return The current parent origin of the items
Vector3 GetItemsParentOrigin() const;
/**
- * @brief Set the anchor point of the items
+ * @brief Set the anchor point of the items.
*
* A relayout will occur for all the items if the anchor point is different than the current one.
* @SINCE_1_0.0
void SetItemsAnchorPoint( const Vector3& anchorPoint );
/**
- * @brief Get the anchor point of the items
+ * @brief Get the anchor point of the items.
*
* @SINCE_1_0.0
* @return The current anchor point of the items
public: // Not intended for application developers
+ /// @cond internal
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @param[in] internal A pointer to the internal CustomActor.
*/
explicit DALI_INTERNAL ItemView( Dali::Internal::CustomActor* internal );
+ /// @endcond
};
/**