1 #ifndef __DALI_TOOLKIT_ITEM_VIEW_H__
2 #define __DALI_TOOLKIT_ITEM_VIEW_H__
5 * Copyright (c) 2014 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 class ScrollConnector;
43 typedef IntrusivePtr<ItemLayout> ItemLayoutPtr;
46 * @brief ItemView is a scrollable layout container.
48 * Multiple ItemLayouts may be provided, to determine the logical position of each item a layout.
49 * Actors are provided from an external ItemFactory, to display the currently visible items.
51 class DALI_IMPORT_API ItemView : public Scrollable
56 * @brief Create an uninitialized ItemView; this can be initialized with ItemView::New().
58 * Calling member functions with an uninitialized Dali::Object is not allowed.
63 * @brief Copy constructor.
65 ItemView( const ItemView& itemView );
68 * @brief Assignment operator.
70 ItemView& operator=( const ItemView& itemView );
75 * This is non-virtual since derived Handle types must not contain data or virtual methods.
80 * @brief Create an initialized ItemView.
82 * @param[in] factory The factory which provides ItemView with items.
83 * @return A handle to a newly allocated Dali resource.
85 static ItemView New(ItemFactory& factory);
88 * @brief Downcast an Object handle to ItemView.
90 * If handle points to a ItemView the downcast produces valid
91 * handle. If not the returned handle is left uninitialized.
93 * @param[in] handle Handle to an object
94 * @return handle to a ItemView or an uninitialized handle
96 static ItemView DownCast( BaseHandle handle );
99 * @brief Retrieve a scroll-connector; this can be used to connect scroll components e.g. scroll bars.
101 * @return The connector.
103 ScrollConnector GetScrollConnector() const;
106 * @brief Query the number of layouts.
108 * @return The number of layouts.
110 unsigned int GetLayoutCount() const;
113 * @brief Add a layout.
115 * @param[in] layout The layout.
117 void AddLayout(ItemLayout& layout);
120 * @brief Remove a layout.
122 * @pre layoutIndex is less than GetLayoutCount().
123 * @param[in] layoutIndex The index of one of the ItemView layouts.
125 void RemoveLayout(unsigned int layoutIndex);
128 * @brief Retrieve a layout.
130 * @pre layoutIndex is less than GetLayoutCount().
131 * @param[in] layoutIndex The index of the layout to retrieve.
134 ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
137 * @brief Retrieve the currently active layout, if any.
139 * @return The layout, or an uninitialized pointer if no layout is active.
141 ItemLayoutPtr GetActiveLayout() const;
144 * @brief Retrieve the current layout-position of an item in the ItemView.
146 * @param[in] itemId The item identifier.
147 * @return The current layout-position.
149 float GetCurrentLayoutPosition(ItemId itemId) const;
152 * @brief Activate one of the layouts; this will resize the ItemView
153 * & relayout actors within the ItemView.
155 * This is done by applying constraints from the new layout, and
156 * removing constraints from the previous layout.
158 * @pre layoutIndex is less than GetLayoutCount().
159 * @pre durationSeconds is greater or equal to zero.
160 * @param[in] layoutIndex The index of one of the ItemView layouts.
161 * @param[in] targetSize The target ItemView & layout size.
162 * @param[in] durationSeconds The time taken to relayout in seconds (zero for immediate).
164 void ActivateLayout(unsigned int layoutIndex, Vector3 targetSize, float durationSeconds);
167 * @brief Deactivate the current layout, if any.
169 * The constraints applied by the layout will be removed.
171 void DeactivateCurrentLayout();
174 * @brief Set the minimum swipe speed in pixels per second; A pan
175 * gesture must exceed this to trigger a swipe.
177 * @param[in] speed The minimum swipe speed
179 void SetMinimumSwipeSpeed(float speed);
182 * @brief Get the minimum swipe speed in pixels per second.
184 * @return The minimum swipe speed
186 float GetMinimumSwipeSpeed() const;
189 * @brief Set the minimum swipe distance in actor coordinates; A pan
190 * gesture must exceed this to trigger a swipe.
192 * @param[in] distance The minimum swipe distance.
194 void SetMinimumSwipeDistance(float distance);
197 * @brief Get the minimum swipe distance in actor coordinates.
199 * @return The minimum swipe distance
201 float GetMinimumSwipeDistance() const;
204 * @brief Set the step of scroll distance in actor coordinates for each mouse wheel event received.
206 * @param[in] step The step of scroll distance(pixel).
208 void SetMouseWheelScrollDistanceStep(float step);
211 * @brief Get the step of scroll distance in actor coordinates for each mouse wheel event received.
213 * @return The step of scroll distance(pixel)
215 float GetMouseWheelScrollDistanceStep() const;
218 * @brief Set whether to enable the animation for the layout to
219 * scroll to its anchor position after dragging or swiping.
221 * The anchor position is the position where all the items in the layout
222 * are aligned to their closest rounded layout positions in integer.
224 * @param[in] enabled Whether the anchor animation is enabled or not.
226 void SetAnchoring(bool enabled);
229 * @brief Get whether the anchor animation is enabled or not.
231 * @return Whether the anchor animation is enabled or not.
233 bool GetAnchoring() const;
236 * @brief Set the duration of the anchor animation in seconds.
238 * This is the time taken to reach the nearest anchor position after
239 * a drag or swipe gesture ends.
241 * @pre durationSeconds must be greater than zero.
242 * @param[in] durationSeconds The duration of the anchor animation in seconds.
244 void SetAnchoringDuration(float durationSeconds);
247 * @brief Get the duration of the anchor animation in seconds.
249 * @return The duration of the anchor animation
251 float GetAnchoringDuration() const;
254 * @brief Scroll the current layout to a particular item.
256 * @pre durationSeconds must be zero or greater; zero means the layout should scroll to the particular item instantly.
257 * If calling this with zero second of duration immediately after calling ActivateLayout, it might not work unless
258 * the duration of relayout animation for ActivateLayout is also set to be zero.
259 * @param[in] itemId The ID of an item in the layout.
260 * @param[in] durationSeconds How long the scrolling takes in seconds.
262 void ScrollToItem(ItemId itemId, float durationSeconds);
265 * @brief Set the interval between refreshes. When the layout-position of items is changed by this interval,
266 * new items are requested from ItemFactory.
268 * @param[in] intervalLayoutPositions The refresh interval in layout position.
270 void SetRefreshInterval(float intervalLayoutPositions);
273 * @brief Get the interval between refreshes in layout position.
275 * @return The refresh interval
277 float GetRefreshInterval() const;
280 * @brief Do a refresh of the item view.
285 * @brief Given the Item ID, this returns the accompanying actor.
287 * @param[in] itemId The Item ID of the actor required.
288 * @return The Actor corresponding to the Item ID.
290 Actor GetItem(ItemId itemId) const;
293 * @brief Returns the Item ID of the specified actor.
295 * @param[in] actor The actor whose Item ID is required.
296 * @return The Item ID of the item.
297 * @pre The actor should be an item of ItemView.
299 ItemId GetItemId(Actor actor) const;
302 * @brief Insert an item.
304 * A relayout will occur for the existing actors; for example if InsertItem(Item(2, ActorZ), 0) is called,
305 * the items with ID 2 or greater will be moved:
306 * Initial actors: After insert:
307 * ID 1 - ActorA ID 1 - ActorA
308 * ID 2 - ActorB ID 2 - ActorZ !
309 * ID 3 - ActorC ID 3 - ActorB
311 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
312 * @param[in] newItem The item to insert.
313 * @param[in] durationSeconds How long the relayout takes in seconds.
315 void InsertItem(Item newItem, float durationSeconds);
318 * @brief Insert a set of items; this is more efficient than calling InsertItem() repeatedly.
320 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
321 * @param[in] newItems The items to insert.
322 * @param[in] durationSeconds How long the relayout takes in seconds.
324 void InsertItems(const ItemContainer& newItems, float durationSeconds);
327 * @brief Removes an item with the given ID.
329 * A relayout will occur for the remaining actors; for example if RemoveItem(Item(2, ActorZ), 0) is called,
330 * the items with ID 3 or greater will be moved:
331 * Initial actors: After remove:
332 * ID 1 - ActorA ID 1 - ActorA
333 * ID 2 - ActorB ID 2 - ActorC (previously ID 3)
334 * ID 3 - ActorC ID 3 - ActorB (previously ID 4)
336 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
337 * @param[in] itemId The Item ID of the item to remove.
338 * @param[in] durationSeconds How long the relayout takes in seconds.
340 void RemoveItem(ItemId itemId, float durationSeconds);
343 * @brief Remove a set of items; this is more efficient than calling RemoveItem() repeatedly.
345 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
346 * @param[in] itemIds The IDs of the items to remove.
347 * @param[in] durationSeconds How long the relayout takes in seconds.
349 void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
352 * @brief Replace an item.
354 * A relayout will occur for the replacement item only.
355 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
356 * @param[in] replacementItem The replacement for an existing item.
357 * @param[in] durationSeconds How long the relayout takes in seconds.
359 void ReplaceItem(Item replacementItem, float durationSeconds);
362 * @brief Replace a set of items.
364 * A relayout will occur for the replacement items only.
365 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
366 * @param[in] replacementItems The replacements for a set of existing items.
367 * @param[in] durationSeconds How long the relayout takes in seconds.
369 void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
372 * @brief Set the parent origin of the items
374 * A relayout will occur for all the items if the parent origin is different than the current one.
375 * @param[in] parentOrigin New parent origin position vector
377 void SetItemsParentOrigin( const Vector3& parentOrigin );
380 * @brief Get the parent origin of the items
382 * @return The current parent origin of the items
384 Vector3 GetItemsParentOrigin() const;
387 * @brief Set the anchor point of the items
389 * A relayout will occur for all the items if the anchor point is different than the current one.
390 * @param[in] anchorPoint New anchor point position vector
392 void SetItemsAnchorPoint( const Vector3& anchorPoint );
395 * @brief Get the anchor point of the items
397 * @return The current anchor point of the items
399 Vector3 GetItemsAnchorPoint() const;
402 * @brief Get the range of items that are currently in ItemView.
404 * @param[out] range The range of items.
406 void GetItemsRange(ItemRange& range);
408 public: // Not intended for application developers
411 * @brief Creates a handle using the Toolkit::Internal implementation.
413 * @param[in] implementation The Control implementation.
415 DALI_INTERNAL ItemView(Internal::ItemView& implementation);
418 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
420 * @param[in] internal A pointer to the internal CustomActor.
422 explicit DALI_INTERNAL ItemView( Dali::Internal::CustomActor* internal );
425 } // namespace Toolkit
429 #endif // __DALI_TOOLKIT_ITEM_VIEW_H__