1 #ifndef __DALI_TOOLKIT_ITEM_VIEW_H__
2 #define __DALI_TOOLKIT_ITEM_VIEW_H__
5 * Copyright (c) 2015 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/scrollable.h>
25 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h>
33 namespace Internal DALI_INTERNAL
38 * @addtogroup dali_toolkit_controls_item_view
46 typedef IntrusivePtr<ItemLayout> ItemLayoutPtr;
49 * @brief ItemView is a scrollable layout container.
51 * Multiple ItemLayouts may be provided to determine the logical position of each item layout.
52 * Actors are provided from an external ItemFactory to display the currently visible items.
55 * | %Signal Name | Method |
56 * |---------------------------------|--------------------------------------------|
57 * | layoutActivated | @ref LayoutActivatedSignal() |
61 * | %Action Name | Attributes | Description |
62 * |---------------|-------------------------|-------------------------------------------------|
63 * | stopScrolling | Doesn't have attributes | Stops the scroll animation. See @ref DoAction() |
67 class DALI_IMPORT_API ItemView : public Scrollable
72 * @brief Enumeration for the start and end property ranges for this control.
77 PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.18
78 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices, @SINCE_1_1.18
80 ANIMATABLE_PROPERTY_START_INDEX = Toolkit::Scrollable::ANIMATABLE_PROPERTY_END_INDEX + 1,
81 ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_0.0
85 * @brief Enumeration for the instance of properties belonging to the ScrollView class.
91 * @brief Enumeration for the instance of properties belonging to the ScrollView class.
96 // Event side properties
97 MINIMUM_SWIPE_SPEED = PROPERTY_START_INDEX, ///< Property, name "minimumSwipeSpeed", @see SetMinimumSwipeSpeed(), type float, @SINCE_1_1.18
98 MINIMUM_SWIPE_DISTANCE, ///< Property, name "minimumSwipeDistance", @see SetMinimumSwipeDistance(), type float, @SINCE_1_1.18
99 WHEEL_SCROLL_DISTANCE_STEP, ///< Property, name "wheelScrollDistanceStep", @see SetWheelScrollDistanceStep(), type float, @SINCE_1_1.18
100 SNAP_TO_ITEM_ENABLED, ///< Property, name "snapToItemEnabled", @see SetAnchoring(), type bool, @SINCE_1_1.18
101 REFRESH_INTERVAL, ///< Property, name "refreshInterval", @see SetRefreshInterval(), type float, @SINCE_1_1.18
103 // Animatable properties
104 LAYOUT_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "layoutPosition", type float @SINCE_1_0.0
105 SCROLL_SPEED, ///< Property, name "scrollSpeed", type float @SINCE_1_0.0
106 OVERSHOOT, ///< Property, name "overshoot", type float @SINCE_1_0.0
107 SCROLL_DIRECTION, ///< Property, name "scrollDirection", type Vector2 @SINCE_1_0.0
108 LAYOUT_ORIENTATION, ///< Property, name "layoutOrientation", type integer @SINCE_1_0.0
109 SCROLL_CONTENT_SIZE ///< Property, name "scrollContentSize", type float @SINCE_1_0.0
115 typedef Signal< void () > LayoutActivatedSignalType;
120 * @brief Creates an uninitialized ItemView; this can be initialized with ItemView::New().
122 * Calling member functions with an uninitialized Dali::Object is not allowed.
128 * @brief Copy constructor.
130 * @param[in] itemView Handle to an object
132 ItemView( const ItemView& itemView );
135 * @brief Assignment operator.
137 * @param[in] itemView Handle to an object
138 * @return A reference to this
140 ItemView& operator=( const ItemView& itemView );
145 * This is non-virtual since derived Handle types must not contain data or virtual methods.
151 * @brief Creates an initialized ItemView.
154 * @param[in] factory The factory which provides ItemView with items
155 * @return A handle to a newly allocated Dali resource
157 static ItemView New(ItemFactory& factory);
160 * @brief Downcasts a handle to ItemView handle.
162 * If handle points to a ItemView, the downcast produces valid handle.
163 * If not, the returned handle is left uninitialized.
166 * @param[in] handle Handle to an object
167 * @return A handle to a ItemView or an uninitialized handle
169 static ItemView DownCast( BaseHandle handle );
172 * @brief Queries the number of layouts.
175 * @return The number of layouts
177 unsigned int GetLayoutCount() const;
180 * @brief Adds a layout.
183 * @param[in] layout The layout
185 void AddLayout(ItemLayout& layout);
188 * @brief Removes a layout.
191 * @param[in] layoutIndex The index of one of the ItemView layouts
192 * @pre layoutIndex is less than GetLayoutCount().
194 void RemoveLayout(unsigned int layoutIndex);
197 * @brief Retrieves a layout.
200 * @param[in] layoutIndex The index of the layout to retrieve
202 * @pre layoutIndex is less than GetLayoutCount().
204 ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
207 * @brief Retrieves the currently active layout, if any.
210 * @return The layout, or an uninitialized pointer if no layout is active
212 ItemLayoutPtr GetActiveLayout() const;
215 * @brief Retrieves the current layout-position of an item in the ItemView.
218 * @param[in] itemId The item identifier
219 * @return The current layout-position
221 float GetCurrentLayoutPosition(ItemId itemId) const;
224 * @brief Activates one of the layouts; this will resize the ItemView
225 * & relayout actors within the ItemView.
227 * This is done by applying constraints from the new layout, and
228 * removing constraints from the previous layout.
231 * @param[in] layoutIndex The index of one of the ItemView layouts
232 * @param[in] targetSize The target ItemView & layout size
233 * @param[in] durationSeconds The time taken to relayout in seconds (zero for immediate)
234 * @pre layoutIndex is less than GetLayoutCount().
235 * @pre durationSeconds is greater or equal to zero.
237 void ActivateLayout(unsigned int layoutIndex, Vector3 targetSize, float durationSeconds);
240 * @brief Deactivates the current layout, if any.
242 * The constraints applied by the layout will be removed.
245 void DeactivateCurrentLayout();
248 * @brief Sets the minimum swipe speed in pixels per second;
249 * A pan gesture must exceed this to trigger a swipe.
252 * @param[in] speed The minimum swipe speed
254 void SetMinimumSwipeSpeed(float speed);
257 * @brief Gets the minimum swipe speed in pixels per second.
260 * @return The minimum swipe speed
262 float GetMinimumSwipeSpeed() const;
265 * @brief Sets the minimum swipe distance in actor coordinates;
266 * A pan gesture must exceed this to trigger a swipe.
269 * @param[in] distance The minimum swipe distance
271 void SetMinimumSwipeDistance(float distance);
274 * @brief Gets the minimum swipe distance in actor coordinates.
277 * @return The minimum swipe distance
279 float GetMinimumSwipeDistance() const;
282 * @brief Set the step of scroll distance in actor coordinates for each wheel event received.
285 * @param[in] step The step of scroll distance(pixel).
287 void SetWheelScrollDistanceStep(float step);
290 * @brief Get the step of scroll distance in actor coordinates for each wheel event received.
293 * @return The step of scroll distance(pixel)
295 float GetWheelScrollDistanceStep() const;
298 * @brief Set whether to enable the animation for the layout to
299 * scroll to its anchor position after dragging or swiping.
301 * The anchor position is the position where all the items in the layout
302 * are aligned to their closest rounded layout positions in integer.
305 * @param[in] enabled Whether the anchor animation is enabled or not.
307 void SetAnchoring(bool enabled);
310 * @brief Get whether the anchor animation is enabled or not.
313 * @return Whether the anchor animation is enabled or not.
315 bool GetAnchoring() const;
318 * @brief Set the duration of the anchor animation in seconds.
320 * This is the time taken to reach the nearest anchor position after
321 * a drag or swipe gesture ends.
324 * @param[in] durationSeconds The duration of the anchor animation in seconds.
325 * @pre durationSeconds must be greater than zero.
327 void SetAnchoringDuration(float durationSeconds);
330 * @brief Get the duration of the anchor animation in seconds.
333 * @return The duration of the anchor animation
335 float GetAnchoringDuration() const;
338 * @brief Scroll the current layout to a particular item.
341 * @param[in] itemId The ID of an item in the layout.
342 * @param[in] durationSeconds How long the scrolling takes in seconds.
343 * @pre durationSeconds must be zero or greater; zero means the layout should scroll to the particular item instantly.
344 * If calling this with zero second of duration immediately after calling ActivateLayout, it might not work unless
345 * the duration of relayout animation for ActivateLayout is also set to be zero.
347 void ScrollToItem(ItemId itemId, float durationSeconds);
350 * @brief Set the interval between refreshes.
352 * When the layout-position of items is changed by this interval,
353 * new items are requested from ItemFactory.
356 * @param[in] intervalLayoutPositions The refresh interval in layout position.
358 void SetRefreshInterval(float intervalLayoutPositions);
361 * @brief Get the interval between refreshes in layout position.
364 * @return The refresh interval
366 float GetRefreshInterval() const;
369 * @brief Do a refresh of the item view.
375 * @brief Given the Item ID, this returns the accompanying actor.
378 * @param[in] itemId The Item ID of the actor required.
379 * @return The Actor corresponding to the Item ID.
381 Actor GetItem(ItemId itemId) const;
384 * @brief Returns the Item ID of the specified actor.
387 * @param[in] actor The actor whose Item ID is required.
388 * @return The Item ID of the item.
389 * @pre The actor should be an item of ItemView.
391 ItemId GetItemId(Actor actor) const;
394 * @brief Insert an item.
396 * A relayout will occur for the existing actors; for example if InsertItem(Item(2, ActorZ), 0) is called,
397 * the items with ID 2 or greater will be moved:
398 * Initial actors: After insert:
399 * ID 1 - ActorA ID 1 - ActorA
400 * ID 2 - ActorB ID 2 - ActorZ !
401 * ID 3 - ActorC ID 3 - ActorB
404 * @param[in] newItem The item to insert.
405 * @param[in] durationSeconds How long the relayout takes in seconds.
406 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
408 void InsertItem(Item newItem, float durationSeconds);
411 * @brief Insert a set of items; this is more efficient than calling InsertItem() repeatedly.
414 * @param[in] newItems The items to insert.
415 * @param[in] durationSeconds How long the relayout takes in seconds.
416 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
418 void InsertItems(const ItemContainer& newItems, float durationSeconds);
421 * @brief Removes an item with the given ID.
423 * A relayout will occur for the remaining actors; for example if RemoveItem(Item(2, ActorZ), 0) is called,
424 * the items with ID 3 or greater will be moved:
425 * | Initial actors: | After remove: |
426 * |:------------------ |:-------------- |
427 * | ID 1 - ActorA | ID 1 - ActorA |
428 * | ID 2 - ActorB | ID 2 - ActorC (previously ID 3) |
429 * | ID 3 - ActorC | ID 3 - ActorB (previously ID 4) |
430 * | ID 4 - ActorD | |
432 * @param[in] itemId The Item ID of the item to remove.
433 * @param[in] durationSeconds How long the relayout takes in seconds.
434 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
436 void RemoveItem(ItemId itemId, float durationSeconds);
439 * @brief Remove a set of items; this is more efficient than calling RemoveItem() repeatedly.
442 * @param[in] itemIds The IDs of the items to remove.
443 * @param[in] durationSeconds How long the relayout takes in seconds.
444 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
446 void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
449 * @brief Replace an item.
451 * A relayout will occur for the replacement item only.
453 * @param[in] replacementItem The replacement for an existing item.
454 * @param[in] durationSeconds How long the relayout takes in seconds.
455 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
457 void ReplaceItem(Item replacementItem, float durationSeconds);
460 * @brief Replace a set of items.
462 * A relayout will occur for the replacement items only.
464 * @param[in] replacementItems The replacements for a set of existing items.
465 * @param[in] durationSeconds How long the relayout takes in seconds.
466 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
468 void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
471 * @brief Set the parent origin of the items.
473 * A relayout will occur for all the items if the parent origin is different than the current one.
475 * @param[in] parentOrigin New parent origin position vector
477 void SetItemsParentOrigin( const Vector3& parentOrigin );
480 * @brief Get the parent origin of the items.
483 * @return The current parent origin of the items
485 Vector3 GetItemsParentOrigin() const;
488 * @brief Set the anchor point of the items.
490 * A relayout will occur for all the items if the anchor point is different than the current one.
492 * @param[in] anchorPoint New anchor point position vector
494 void SetItemsAnchorPoint( const Vector3& anchorPoint );
497 * @brief Get the anchor point of the items.
500 * @return The current anchor point of the items
502 Vector3 GetItemsAnchorPoint() const;
505 * @brief Get the range of items that are currently in ItemView.
508 * @param[out] range The range of items.
510 void GetItemsRange(ItemRange& range);
515 * @brief Signal emitted when layout activation is finished.
517 * A callback of the following type may be connected:
519 * void YourCallbackName();
522 * @return The signal to connect to.
523 * @pre The Object has been initialized.
525 ItemView::LayoutActivatedSignalType& LayoutActivatedSignal();
527 public: // Not intended for application developers
531 * @brief Creates a handle using the Toolkit::Internal implementation.
534 * @param[in] implementation The Control implementation.
536 DALI_INTERNAL ItemView(Internal::ItemView& implementation);
539 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
542 * @param[in] internal A pointer to the internal CustomActor.
544 explicit DALI_INTERNAL ItemView( Dali::Internal::CustomActor* internal );
551 } // namespace Toolkit
555 #endif // __DALI_TOOLKIT_ITEM_VIEW_H__