1 #ifndef DALI_TOOLKIT_ITEM_VIEW_H
2 #define DALI_TOOLKIT_ITEM_VIEW_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
24 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h>
25 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
31 namespace Internal DALI_INTERNAL
36 * @addtogroup dali_toolkit_controls_item_view
44 typedef IntrusivePtr<ItemLayout> ItemLayoutPtr;
47 * @brief ItemView is a scrollable layout container.
49 * Multiple ItemLayouts may be provided to determine the logical position of each item layout.
50 * Actors are provided from an external ItemFactory to display the currently visible items.
53 * | %Signal Name | Method |
54 * |---------------------------------|--------------------------------------------|
55 * | layoutActivated | @ref LayoutActivatedSignal() |
59 * | %Action Name | Attributes | Description |
60 * |---------------|-------------------------|-------------------------------------------------|
61 * | stopScrolling | Doesn't have attributes | Stops the scroll animation. See @ref DoAction() |
65 class DALI_TOOLKIT_API ItemView : public Scrollable
69 * @brief Enumeration for the start and end property ranges for this control.
74 PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.18
75 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices, @SINCE_1_1.18
77 ANIMATABLE_PROPERTY_START_INDEX = Toolkit::Scrollable::ANIMATABLE_PROPERTY_END_INDEX + 1,
78 ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_0.0
82 * @brief Enumeration for the instance of properties belonging to the ScrollView class.
88 * @brief Enumeration for the instance of properties belonging to the ScrollView class.
93 ///////////////////////////////////////////////////////////////////////////////
94 // Event side (non-animatable) properties
95 ///////////////////////////////////////////////////////////////////////////////
98 * @brief The minimum swipe speed in pixels per second.
99 * @details Name "minimumSwipeSpeed", type Property::FLOAT.
101 * @see SetMinimumSwipeSpeed()
103 MINIMUM_SWIPE_SPEED = PROPERTY_START_INDEX,
106 * @brief The minimum swipe distance in actor coordinates.
107 * @details Name "minimumSwipeDistance", type Property::FLOAT.
109 * @see SetMinimumSwipeDistance()
111 MINIMUM_SWIPE_DISTANCE,
114 * @brief The step of scroll distance in actor coordinates for each wheel event received.
115 * @details Name "wheelScrollDistanceStep", type Property::FLOAT.
117 * @see SetWheelScrollDistanceStep()
119 WHEEL_SCROLL_DISTANCE_STEP,
122 * @brief Whether the animation for the layout to scroll to its anchor position after dragging or swiping is enabled.
123 * @details Name "snapToItemEnabled", type Property::BOOLEAN.
125 * @see SetAnchoring()
127 SNAP_TO_ITEM_ENABLED,
130 * @brief The interval between refreshes.
131 * @details Name "refreshInterval", type Property::FLOAT.
133 * @see SetRefreshInterval()
138 * @brief The layout used.
139 * @details Name "layout", type Property::ARRAY.
141 * @see Dali::Toolkit::DefaultItemLayoutProperty
145 ///////////////////////////////////////////////////////////////////////////////
146 // Animatable Properties
147 ///////////////////////////////////////////////////////////////////////////////
150 * @brief The current logical position within the layout.
151 * @details Name "layoutPosition", type Property::FLOAT.
154 LAYOUT_POSITION = ANIMATABLE_PROPERTY_START_INDEX,
157 * @brief The scrolling speed when playing the flick animation.
158 * @details Name "scrollSpeed", type Property::FLOAT.
164 * @brief The amount that we can scroll beyond the boundary.
165 * @details Name "overshoot", type Property::FLOAT.
171 * @brief The current scrolling direction.
172 * @details Name "scrollDirection", type Property::FLOAT.
178 * @brief The current orientation of the layout.
179 * @details Name "layoutOrientation", type Property::INTEGER.
185 * @brief The size of the content.
186 * @details Name "scrollContentSize", type Property::FLOAT.
195 typedef Signal<void()> LayoutActivatedSignalType;
199 * @brief Creates an uninitialized ItemView; this can be initialized with ItemView::New().
201 * Calling member functions with an uninitialized Dali::Object is not allowed.
207 * @brief Copy constructor.
209 * @param[in] itemView Handle to an object
211 ItemView(const ItemView& itemView);
214 * @brief Move constructor
217 * @param[in] rhs A reference to the moved handle
219 ItemView(ItemView&& rhs);
222 * @brief Assignment operator.
224 * @param[in] itemView Handle to an object
225 * @return A reference to this
227 ItemView& operator=(const ItemView& itemView);
230 * @brief Move assignment
233 * @param[in] rhs A reference to the moved handle
234 * @return A reference to this
236 ItemView& operator=(ItemView&& rhs);
241 * This is non-virtual since derived Handle types must not contain data or virtual methods.
247 * @brief Creates an initialized ItemView.
250 * @param[in] factory The factory which provides ItemView with items
251 * @return A handle to a newly allocated Dali resource
253 static ItemView New(ItemFactory& factory);
256 * @brief Downcasts a handle to ItemView handle.
258 * If handle points to a ItemView, the downcast produces valid handle.
259 * If not, the returned handle is left uninitialized.
262 * @param[in] handle Handle to an object
263 * @return A handle to a ItemView or an uninitialized handle
265 static ItemView DownCast(BaseHandle handle);
268 * @brief Queries the number of layouts.
271 * @return The number of layouts
273 unsigned int GetLayoutCount() const;
276 * @brief Adds a layout.
279 * @param[in] layout The layout
281 void AddLayout(ItemLayout& layout);
284 * @brief Removes a layout.
287 * @param[in] layoutIndex The index of one of the ItemView layouts
288 * @pre layoutIndex is less than GetLayoutCount().
290 void RemoveLayout(unsigned int layoutIndex);
293 * @brief Retrieves a layout.
296 * @param[in] layoutIndex The index of the layout to retrieve
298 * @pre layoutIndex is less than GetLayoutCount().
300 ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
303 * @brief Retrieves the currently active layout, if any.
306 * @return The layout, or an uninitialized pointer if no layout is active
308 ItemLayoutPtr GetActiveLayout() const;
311 * @brief Retrieves the current layout-position of an item in the ItemView.
314 * @param[in] itemId The item identifier
315 * @return The current layout-position
317 float GetCurrentLayoutPosition(ItemId itemId) const;
320 * @brief Activates one of the layouts; this will resize the ItemView
321 * & relayout actors within the ItemView.
323 * This is done by applying constraints from the new layout, and
324 * removing constraints from the previous layout.
327 * @param[in] layoutIndex The index of one of the ItemView layouts
328 * @param[in] targetSize The target ItemView & layout size
329 * @param[in] durationSeconds The time taken to relayout in seconds (zero for immediate)
330 * @pre layoutIndex is less than GetLayoutCount().
331 * @pre durationSeconds is greater or equal to zero.
333 void ActivateLayout(unsigned int layoutIndex, Vector3 targetSize, float durationSeconds);
336 * @brief Deactivates the current layout, if any.
338 * The constraints applied by the layout will be removed.
341 void DeactivateCurrentLayout();
344 * @brief Sets the minimum swipe speed in pixels per second;
345 * A pan gesture must exceed this to trigger a swipe.
348 * @param[in] speed The minimum swipe speed
350 void SetMinimumSwipeSpeed(float speed);
353 * @brief Gets the minimum swipe speed in pixels per second.
356 * @return The minimum swipe speed
358 float GetMinimumSwipeSpeed() const;
361 * @brief Sets the minimum swipe distance in actor coordinates;
362 * A pan gesture must exceed this to trigger a swipe.
365 * @param[in] distance The minimum swipe distance
367 void SetMinimumSwipeDistance(float distance);
370 * @brief Gets the minimum swipe distance in actor coordinates.
373 * @return The minimum swipe distance
375 float GetMinimumSwipeDistance() const;
378 * @brief Set the step of scroll distance in actor coordinates for each wheel event received.
381 * @param[in] step The step of scroll distance(pixel).
383 void SetWheelScrollDistanceStep(float step);
386 * @brief Get the step of scroll distance in actor coordinates for each wheel event received.
389 * @return The step of scroll distance(pixel)
391 float GetWheelScrollDistanceStep() const;
394 * @brief Set whether to enable the animation for the layout to
395 * scroll to its anchor position after dragging or swiping.
397 * The anchor position is the position where all the items in the layout
398 * are aligned to their closest rounded layout positions in integer.
401 * @param[in] enabled Whether the anchor animation is enabled or not.
403 void SetAnchoring(bool enabled);
406 * @brief Get whether the anchor animation is enabled or not.
409 * @return Whether the anchor animation is enabled or not.
411 bool GetAnchoring() const;
414 * @brief Set the duration of the anchor animation in seconds.
416 * This is the time taken to reach the nearest anchor position after
417 * a drag or swipe gesture ends.
420 * @param[in] durationSeconds The duration of the anchor animation in seconds.
421 * @pre durationSeconds must be greater than zero.
423 void SetAnchoringDuration(float durationSeconds);
426 * @brief Get the duration of the anchor animation in seconds.
429 * @return The duration of the anchor animation
431 float GetAnchoringDuration() const;
434 * @brief Scroll the current layout to a particular item.
437 * @param[in] itemId The ID of an item in the layout.
438 * @param[in] durationSeconds How long the scrolling takes in seconds.
439 * @pre durationSeconds must be zero or greater; zero means the layout should scroll to the particular item instantly.
440 * If calling this with zero second of duration immediately after calling ActivateLayout, it might not work unless
441 * the duration of relayout animation for ActivateLayout is also set to be zero.
443 void ScrollToItem(ItemId itemId, float durationSeconds);
446 * @brief Set the interval between refreshes.
448 * When the layout-position of items is changed by this interval,
449 * new items are requested from ItemFactory.
452 * @param[in] intervalLayoutPositions The refresh interval in layout position.
454 void SetRefreshInterval(float intervalLayoutPositions);
457 * @brief Get the interval between refreshes in layout position.
460 * @return The refresh interval
462 float GetRefreshInterval() const;
465 * @brief Do a refresh of the item view.
471 * @brief Given the Item ID, this returns the accompanying actor.
474 * @param[in] itemId The Item ID of the actor required.
475 * @return The Actor corresponding to the Item ID.
477 Actor GetItem(ItemId itemId) const;
480 * @brief Returns the Item ID of the specified actor.
483 * @param[in] actor The actor whose Item ID is required.
484 * @return The Item ID of the item.
485 * @pre The actor should be an item of ItemView.
487 ItemId GetItemId(Actor actor) const;
490 * @brief Insert an item.
492 * A relayout will occur for the existing actors; for example if InsertItem(Item(2, ActorZ), 0) is called,
493 * the items with ID 2 or greater will be moved:
494 * Initial actors: After insert:
495 * ID 1 - ActorA ID 1 - ActorA
496 * ID 2 - ActorB ID 2 - ActorZ !
497 * ID 3 - ActorC ID 3 - ActorB
500 * @param[in] newItem The item to insert.
501 * @param[in] durationSeconds How long the relayout takes in seconds.
502 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
504 void InsertItem(Item newItem, float durationSeconds);
507 * @brief Insert a set of items; this is more efficient than calling InsertItem() repeatedly.
510 * @param[in] newItems The items to insert.
511 * @param[in] durationSeconds How long the relayout takes in seconds.
512 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
514 void InsertItems(const ItemContainer& newItems, float durationSeconds);
517 * @brief Removes an item with the given ID.
519 * A relayout will occur for the remaining actors; for example if RemoveItem(Item(2, ActorZ), 0) is called,
520 * the items with ID 3 or greater will be moved:
521 * | Initial actors: | After remove: |
522 * |:------------------ |:-------------- |
523 * | ID 1 - ActorA | ID 1 - ActorA |
524 * | ID 2 - ActorB | ID 2 - ActorC (previously ID 3) |
525 * | ID 3 - ActorC | ID 3 - ActorB (previously ID 4) |
526 * | ID 4 - ActorD | |
528 * @param[in] itemId The Item ID of the item to remove.
529 * @param[in] durationSeconds How long the relayout takes in seconds.
530 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
532 void RemoveItem(ItemId itemId, float durationSeconds);
535 * @brief Remove a set of items; this is more efficient than calling RemoveItem() repeatedly.
538 * @param[in] itemIds The IDs of the items to remove.
539 * @param[in] durationSeconds How long the relayout takes in seconds.
540 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
542 void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
545 * @brief Replace an item.
547 * A relayout will occur for the replacement item only.
549 * @param[in] replacementItem The replacement for an existing item.
550 * @param[in] durationSeconds How long the relayout takes in seconds.
551 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
553 void ReplaceItem(Item replacementItem, float durationSeconds);
556 * @brief Replace a set of items.
558 * A relayout will occur for the replacement items only.
560 * @param[in] replacementItems The replacements for a set of existing items.
561 * @param[in] durationSeconds How long the relayout takes in seconds.
562 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
564 void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
567 * @brief Set the parent origin of the items.
569 * A relayout will occur for all the items if the parent origin is different than the current one.
571 * @param[in] parentOrigin New parent origin position vector
573 void SetItemsParentOrigin(const Vector3& parentOrigin);
576 * @brief Get the parent origin of the items.
579 * @return The current parent origin of the items
581 Vector3 GetItemsParentOrigin() const;
584 * @brief Set the anchor point of the items.
586 * A relayout will occur for all the items if the anchor point is different than the current one.
588 * @param[in] anchorPoint New anchor point position vector
590 void SetItemsAnchorPoint(const Vector3& anchorPoint);
593 * @brief Get the anchor point of the items.
596 * @return The current anchor point of the items
598 Vector3 GetItemsAnchorPoint() const;
601 * @brief Get the range of items that are currently in ItemView.
604 * @param[out] range The range of items.
606 void GetItemsRange(ItemRange& range);
610 * @brief Signal emitted when layout activation is finished.
612 * A callback of the following type may be connected:
614 * void YourCallbackName();
617 * @return The signal to connect to.
618 * @pre The Object has been initialized.
620 ItemView::LayoutActivatedSignalType& LayoutActivatedSignal();
622 public: // Not intended for application developers
625 * @brief Creates a handle using the Toolkit::Internal implementation.
628 * @param[in] implementation The Control implementation.
630 DALI_INTERNAL ItemView(Internal::ItemView& implementation);
633 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
636 * @param[in] internal A pointer to the internal CustomActor.
638 explicit DALI_INTERNAL ItemView(Dali::Internal::CustomActor* internal);
645 } // namespace Toolkit
649 #endif // DALI_TOOLKIT_ITEM_VIEW_H