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 a layout.
52 * Actors are provided from an external ItemFactory, to display the currently visible items.
55 * | %Signal Name | Method |
56 * |----------------------------------|--------------------------------------------|
57 * | layout-activated | @ref LayoutActivatedSignal() |
60 class DALI_IMPORT_API ItemView : public Scrollable
66 ANIMATABLE_PROPERTY_START_INDEX = Toolkit::Scrollable::ANIMATABLE_PROPERTY_END_INDEX + 1,
67 ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_START_INDEX + 1000 ///< Reserve animatable property indices
71 * @brief An enumeration of properties belonging to the ScrollView class.
77 LAYOUT_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "layout-position", type float
78 SCROLL_SPEED, ///< Property, name "scroll-speed", type float
79 OVERSHOOT, ///< Property, name "overshoot", type float
80 SCROLL_DIRECTION, ///< Property, name "scroll-direction", type Vector2
81 LAYOUT_ORIENTATION, ///< Property, name "layout-orientation", type integer
82 SCROLL_CONTENT_SIZE ///< Property, name "scroll-content-size", type float
88 typedef Signal< void () > LayoutActivatedSignalType;
93 * @brief Create an uninitialized ItemView; this can be initialized with ItemView::New().
95 * Calling member functions with an uninitialized Dali::Object is not allowed.
100 * @brief Copy constructor.
102 ItemView( const ItemView& itemView );
105 * @brief Assignment operator.
107 ItemView& operator=( const ItemView& itemView );
112 * This is non-virtual since derived Handle types must not contain data or virtual methods.
117 * @brief Create an initialized ItemView.
119 * @param[in] factory The factory which provides ItemView with items.
120 * @return A handle to a newly allocated Dali resource.
122 static ItemView New(ItemFactory& factory);
125 * @brief Downcast an Object handle to ItemView.
127 * If handle points to a ItemView the downcast produces valid
128 * handle. If not the returned handle is left uninitialized.
130 * @param[in] handle Handle to an object
131 * @return handle to a ItemView or an uninitialized handle
133 static ItemView DownCast( BaseHandle handle );
136 * @brief Query the number of layouts.
138 * @return The number of layouts.
140 unsigned int GetLayoutCount() const;
143 * @brief Add a layout.
145 * @param[in] layout The layout.
147 void AddLayout(ItemLayout& layout);
150 * @brief Remove a layout.
152 * @pre layoutIndex is less than GetLayoutCount().
153 * @param[in] layoutIndex The index of one of the ItemView layouts.
155 void RemoveLayout(unsigned int layoutIndex);
158 * @brief Retrieve a layout.
160 * @pre layoutIndex is less than GetLayoutCount().
161 * @param[in] layoutIndex The index of the layout to retrieve.
164 ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
167 * @brief Retrieve the currently active layout, if any.
169 * @return The layout, or an uninitialized pointer if no layout is active.
171 ItemLayoutPtr GetActiveLayout() const;
174 * @brief Retrieve the current layout-position of an item in the ItemView.
176 * @param[in] itemId The item identifier.
177 * @return The current layout-position.
179 float GetCurrentLayoutPosition(ItemId itemId) const;
182 * @brief Activate one of the layouts; this will resize the ItemView
183 * & relayout actors within the ItemView.
185 * This is done by applying constraints from the new layout, and
186 * removing constraints from the previous layout.
188 * @pre layoutIndex is less than GetLayoutCount().
189 * @pre durationSeconds is greater or equal to zero.
190 * @param[in] layoutIndex The index of one of the ItemView layouts.
191 * @param[in] targetSize The target ItemView & layout size.
192 * @param[in] durationSeconds The time taken to relayout in seconds (zero for immediate).
194 void ActivateLayout(unsigned int layoutIndex, Vector3 targetSize, float durationSeconds);
197 * @brief Deactivate the current layout, if any.
199 * The constraints applied by the layout will be removed.
201 void DeactivateCurrentLayout();
204 * @brief Set the minimum swipe speed in pixels per second; A pan
205 * gesture must exceed this to trigger a swipe.
207 * @param[in] speed The minimum swipe speed
209 void SetMinimumSwipeSpeed(float speed);
212 * @brief Get the minimum swipe speed in pixels per second.
214 * @return The minimum swipe speed
216 float GetMinimumSwipeSpeed() const;
219 * @brief Set the minimum swipe distance in actor coordinates; A pan
220 * gesture must exceed this to trigger a swipe.
222 * @param[in] distance The minimum swipe distance.
224 void SetMinimumSwipeDistance(float distance);
227 * @brief Get the minimum swipe distance in actor coordinates.
229 * @return The minimum swipe distance
231 float GetMinimumSwipeDistance() const;
234 * @brief Set the step of scroll distance in actor coordinates for each wheel event received.
236 * @param[in] step The step of scroll distance(pixel).
238 void SetWheelScrollDistanceStep(float step);
241 * @brief Get the step of scroll distance in actor coordinates for each wheel event received.
243 * @return The step of scroll distance(pixel)
245 float GetWheelScrollDistanceStep() const;
248 * @brief Set whether to enable the animation for the layout to
249 * scroll to its anchor position after dragging or swiping.
251 * The anchor position is the position where all the items in the layout
252 * are aligned to their closest rounded layout positions in integer.
254 * @param[in] enabled Whether the anchor animation is enabled or not.
256 void SetAnchoring(bool enabled);
259 * @brief Get whether the anchor animation is enabled or not.
261 * @return Whether the anchor animation is enabled or not.
263 bool GetAnchoring() const;
266 * @brief Set the duration of the anchor animation in seconds.
268 * This is the time taken to reach the nearest anchor position after
269 * a drag or swipe gesture ends.
271 * @pre durationSeconds must be greater than zero.
272 * @param[in] durationSeconds The duration of the anchor animation in seconds.
274 void SetAnchoringDuration(float durationSeconds);
277 * @brief Get the duration of the anchor animation in seconds.
279 * @return The duration of the anchor animation
281 float GetAnchoringDuration() const;
284 * @brief Scroll the current layout to a particular item.
286 * @pre durationSeconds must be zero or greater; zero means the layout should scroll to the particular item instantly.
287 * If calling this with zero second of duration immediately after calling ActivateLayout, it might not work unless
288 * the duration of relayout animation for ActivateLayout is also set to be zero.
289 * @param[in] itemId The ID of an item in the layout.
290 * @param[in] durationSeconds How long the scrolling takes in seconds.
292 void ScrollToItem(ItemId itemId, float durationSeconds);
295 * @brief Set the interval between refreshes. When the layout-position of items is changed by this interval,
296 * new items are requested from ItemFactory.
298 * @param[in] intervalLayoutPositions The refresh interval in layout position.
300 void SetRefreshInterval(float intervalLayoutPositions);
303 * @brief Get the interval between refreshes in layout position.
305 * @return The refresh interval
307 float GetRefreshInterval() const;
310 * @brief Do a refresh of the item view.
315 * @brief Given the Item ID, this returns the accompanying actor.
317 * @param[in] itemId The Item ID of the actor required.
318 * @return The Actor corresponding to the Item ID.
320 Actor GetItem(ItemId itemId) const;
323 * @brief Returns the Item ID of the specified actor.
325 * @param[in] actor The actor whose Item ID is required.
326 * @return The Item ID of the item.
327 * @pre The actor should be an item of ItemView.
329 ItemId GetItemId(Actor actor) const;
332 * @brief Insert an item.
334 * A relayout will occur for the existing actors; for example if InsertItem(Item(2, ActorZ), 0) is called,
335 * the items with ID 2 or greater will be moved:
336 * Initial actors: After insert:
337 * ID 1 - ActorA ID 1 - ActorA
338 * ID 2 - ActorB ID 2 - ActorZ !
339 * ID 3 - ActorC ID 3 - ActorB
341 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
342 * @param[in] newItem The item to insert.
343 * @param[in] durationSeconds How long the relayout takes in seconds.
345 void InsertItem(Item newItem, float durationSeconds);
348 * @brief Insert a set of items; this is more efficient than calling InsertItem() repeatedly.
350 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
351 * @param[in] newItems The items to insert.
352 * @param[in] durationSeconds How long the relayout takes in seconds.
354 void InsertItems(const ItemContainer& newItems, float durationSeconds);
357 * @brief Removes an item with the given ID.
359 * A relayout will occur for the remaining actors; for example if RemoveItem(Item(2, ActorZ), 0) is called,
360 * the items with ID 3 or greater will be moved:
361 * Initial actors: After remove:
362 * ID 1 - ActorA ID 1 - ActorA
363 * ID 2 - ActorB ID 2 - ActorC (previously ID 3)
364 * ID 3 - ActorC ID 3 - ActorB (previously ID 4)
366 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
367 * @param[in] itemId The Item ID of the item to remove.
368 * @param[in] durationSeconds How long the relayout takes in seconds.
370 void RemoveItem(ItemId itemId, float durationSeconds);
373 * @brief Remove a set of items; this is more efficient than calling RemoveItem() repeatedly.
375 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
376 * @param[in] itemIds The IDs of the items to remove.
377 * @param[in] durationSeconds How long the relayout takes in seconds.
379 void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
382 * @brief Replace an item.
384 * A relayout will occur for the replacement item only.
385 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
386 * @param[in] replacementItem The replacement for an existing item.
387 * @param[in] durationSeconds How long the relayout takes in seconds.
389 void ReplaceItem(Item replacementItem, float durationSeconds);
392 * @brief Replace a set of items.
394 * A relayout will occur for the replacement items only.
395 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
396 * @param[in] replacementItems The replacements for a set of existing items.
397 * @param[in] durationSeconds How long the relayout takes in seconds.
399 void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
402 * @brief Set the parent origin of the items
404 * A relayout will occur for all the items if the parent origin is different than the current one.
405 * @param[in] parentOrigin New parent origin position vector
407 void SetItemsParentOrigin( const Vector3& parentOrigin );
410 * @brief Get the parent origin of the items
412 * @return The current parent origin of the items
414 Vector3 GetItemsParentOrigin() const;
417 * @brief Set the anchor point of the items
419 * A relayout will occur for all the items if the anchor point is different than the current one.
420 * @param[in] anchorPoint New anchor point position vector
422 void SetItemsAnchorPoint( const Vector3& anchorPoint );
425 * @brief Get the anchor point of the items
427 * @return The current anchor point of the items
429 Vector3 GetItemsAnchorPoint() const;
432 * @brief Get the range of items that are currently in ItemView.
434 * @param[out] range The range of items.
436 void GetItemsRange(ItemRange& range);
441 * @brief Signal emitted when layout activation is finished.
443 * A callback of the following type may be connected:
445 * void YourCallbackName();
447 * @pre The Object has been initialized.
448 * @return The signal to connect to.
450 ItemView::LayoutActivatedSignalType& LayoutActivatedSignal();
452 public: // Not intended for application developers
455 * @brief Creates a handle using the Toolkit::Internal implementation.
457 * @param[in] implementation The Control implementation.
459 DALI_INTERNAL ItemView(Internal::ItemView& implementation);
462 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
464 * @param[in] internal A pointer to the internal CustomActor.
466 explicit DALI_INTERNAL ItemView( Dali::Internal::CustomActor* internal );
472 } // namespace Toolkit
476 #endif // __DALI_TOOLKIT_ITEM_VIEW_H__