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.
22 #include <dali/dali.h>
25 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
26 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h>
28 namespace Dali DALI_IMPORT_API
34 namespace Internal DALI_INTERNAL
39 class ScrollConnector;
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 a layout.
50 * Actors are provided from an external ItemFactory, to display the currently visible items.
52 class ItemView : public Scrollable
57 * @brief Create an uninitialized ItemView; this can be initialized with ItemView::New().
59 * Calling member functions with an uninitialized Dali::Object is not allowed.
64 * @brief Copy constructor.
66 ItemView( const ItemView& itemView );
69 * @brief Assignment operator.
71 ItemView& operator=( const ItemView& itemView );
76 * This is non-virtual since derived Handle types must not contain data or virtual methods.
81 * @brief Create an initialized ItemView.
83 * @param[in] factory The factory which provides ItemView with items.
84 * @return A handle to a newly allocated Dali resource.
86 static ItemView New(ItemFactory& factory);
89 * @brief Downcast an Object handle to ItemView.
91 * If handle points to a ItemView the downcast produces valid
92 * handle. If not the returned handle is left uninitialized.
94 * @param[in] handle Handle to an object
95 * @return handle to a ItemView or an uninitialized handle
97 static ItemView DownCast( BaseHandle handle );
100 * @brief Retrieve a scroll-connector; this can be used to connect scroll components e.g. scroll bars.
102 * @return The connector.
104 ScrollConnector GetScrollConnector() const;
107 * @brief Query the number of layouts.
109 * @return The number of layouts.
111 unsigned int GetLayoutCount() const;
114 * @brief Add a layout.
116 * @param[in] layout The layout.
118 void AddLayout(ItemLayout& layout);
121 * @brief Remove a layout.
123 * @pre layoutIndex is less than GetLayoutCount().
124 * @param[in] layoutIndex The index of one of the ItemView layouts.
126 void RemoveLayout(unsigned int layoutIndex);
129 * @brief Retrieve a layout.
131 * @pre layoutIndex is less than GetLayoutCount().
132 * @param[in] layoutIndex The index of the layout to retrieve.
135 ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
138 * @brief Retrieve the currently active layout, if any.
140 * @return The layout, or an uninitialized pointer if no layout is active.
142 ItemLayoutPtr GetActiveLayout() const;
145 * @brief Retrieve the current layout-position of an item in the ItemView.
147 * @param[in] itemId The item identifier.
148 * @return The current layout-position.
150 float GetCurrentLayoutPosition(ItemId itemId) const;
153 * @brief Activate one of the layouts; this will resize the ItemView
154 * & relayout actors within the ItemView.
156 * This is done by applying constraints from the new layout, and
157 * removing constraints from the previous layout.
159 * @pre layoutIndex is less than GetLayoutCount().
160 * @pre durationSeconds is greater or equal to zero.
161 * @param[in] layoutIndex The index of one of the ItemView layouts.
162 * @param[in] targetSize The target ItemView & layout size.
163 * @param[in] durationSeconds The time taken to relayout in seconds (zero for immediate).
165 void ActivateLayout(unsigned int layoutIndex, Vector3 targetSize, float durationSeconds);
168 * @brief Deactivate the current layout, if any.
170 * The constraints applied by the layout will be removed.
172 void DeactivateCurrentLayout();
175 * @brief Set default the alpha function used when applying constraints e.g. during ActivateLayout().
177 * @deprecated Use SetAlphaFunction() in the layout
178 * @param[in] func The default alpha function to use.
180 void SetDefaultAlphaFunction(AlphaFunction func);
183 * @brief Retrieve the default alpha function used when applying constraints
185 * @deprecated Use GetAlphaFunction() in the layout
186 * @return The default alpha function.
188 AlphaFunction GetDefaultAlphaFunction() const;
191 * @brief Set the minimum swipe speed in pixels per second; A pan
192 * gesture must exceed this to trigger a swipe.
194 * @param[in] speed The minimum swipe speed
196 void SetMinimumSwipeSpeed(float speed);
199 * @brief Get the minimum swipe speed in pixels per second.
201 * @return The minimum swipe speed
203 float GetMinimumSwipeSpeed() const;
206 * @brief Set the minimum swipe distance in actor coordinates; A pan
207 * gesture must exceed this to trigger a swipe.
209 * @param[in] distance The minimum swipe distance.
211 void SetMinimumSwipeDistance(float distance);
214 * @brief Get the minimum swipe distance in actor coordinates.
216 * @return The minimum swipe distance
218 float GetMinimumSwipeDistance() const;
221 * @brief Set the step of scroll distance in actor coordinates for each mouse wheel event received.
223 * @param[in] step The step of scroll distance(pixel).
225 void SetMouseWheelScrollDistanceStep(float step);
228 * @brief Get the step of scroll distance in actor coordinates for each mouse wheel event received.
230 * @return The step of scroll distance(pixel)
232 float GetMouseWheelScrollDistanceStep() const;
235 * @brief Set whether to enable the animation for the layout to
236 * scroll to its anchor position after dragging or swiping.
238 * The anchor position is the position where all the items in the layout
239 * are aligned to their closest rounded layout positions in integer.
241 * @param[in] enabled Whether the anchor animation is enabled or not.
243 void SetAnchoring(bool enabled);
246 * @brief Get whether the anchor animation is enabled or not.
248 * @return Whether the anchor animation is enabled or not.
250 bool GetAnchoring() const;
253 * @brief Set the duration of the anchor animation in seconds.
255 * This is the time taken to reach the nearest anchor position after
256 * a drag or swipe gesture ends.
258 * @pre durationSeconds must be greater than zero.
259 * @param[in] durationSeconds The duration of the anchor animation in seconds.
261 void SetAnchoringDuration(float durationSeconds);
264 * @brief Get the duration of the anchor animation in seconds.
266 * @return The duration of the anchor animation
268 float GetAnchoringDuration() const;
271 * @brief Scroll the current layout to a particular item.
273 * @pre durationSeconds must be zero or greater; zero means the layout should scroll to the particular item instantly.
274 * If calling this with zero second of duration immediately after calling ActivateLayout, it might not work unless
275 * the duration of relayout animation for ActivateLayout is also set to be zero.
276 * @param[in] itemId The ID of an item in the layout.
277 * @param[in] durationSeconds How long the scrolling takes in seconds.
279 void ScrollToItem(ItemId itemId, float durationSeconds);
282 * @brief Set the interval between refreshes. When the layout-position of items is changed by this interval,
283 * new items are requested from ItemFactory.
285 * @param[in] intervalLayoutPositions The refresh interval in layout position.
287 void SetRefreshInterval(float intervalLayoutPositions);
290 * @brief Get the interval between refreshes in layout position.
292 * @return The refresh interval
294 float GetRefreshInterval() const;
297 * @brief Given the Item ID, this returns the accompanying actor.
299 * @param[in] itemId The Item ID of the actor required.
300 * @return The Actor corresponding to the Item ID.
302 Actor GetItem(ItemId itemId) const;
305 * @brief Returns the Item ID of the specified actor.
307 * @param[in] actor The actor whose Item ID is required.
308 * @return The Item ID of the item.
309 * @pre The actor should be an item of ItemView.
311 ItemId GetItemId(Actor actor) const;
314 * @brief Insert an item.
316 * A relayout will occur for the existing actors; for example if InsertItem(Item(2, ActorZ), 0) is called,
317 * the items with ID 2 or greater will be moved:
318 * Initial actors: After insert:
319 * ID 1 - ActorA ID 1 - ActorA
320 * ID 2 - ActorB ID 2 - ActorZ !
321 * ID 3 - ActorC ID 3 - ActorB
323 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
324 * @param[in] newItem The item to insert.
325 * @param[in] durationSeconds How long the relayout takes in seconds.
327 void InsertItem(Item newItem, float durationSeconds);
330 * @brief Insert a set of items; this is more efficient than calling InsertItem() repeatedly.
332 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
333 * @param[in] newItems The items to insert.
334 * @param[in] durationSeconds How long the relayout takes in seconds.
336 void InsertItems(const ItemContainer& newItems, float durationSeconds);
339 * @brief Removes an item with the given ID.
341 * A relayout will occur for the remaining actors; for example if RemoveItem(Item(2, ActorZ), 0) is called,
342 * the items with ID 3 or greater will be moved:
343 * Initial actors: After remove:
344 * ID 1 - ActorA ID 1 - ActorA
345 * ID 2 - ActorB ID 2 - ActorC (previously ID 3)
346 * ID 3 - ActorC ID 3 - ActorB (previously ID 4)
348 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
349 * @param[in] itemId The Item ID of the item to remove.
350 * @param[in] durationSeconds How long the relayout takes in seconds.
352 void RemoveItem(ItemId itemId, float durationSeconds);
355 * @brief Remove a set of items; this is more efficient than calling RemoveItem() repeatedly.
357 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
358 * @param[in] itemIds The IDs of the items to remove.
359 * @param[in] durationSeconds How long the relayout takes in seconds.
361 void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
364 * @brief Replace an item.
366 * A relayout will occur for the replacement item only.
367 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
368 * @param[in] replacementItem The replacement for an existing item.
369 * @param[in] durationSeconds How long the relayout takes in seconds.
371 void ReplaceItem(Item replacementItem, float durationSeconds);
374 * @brief Replace a set of items.
376 * A relayout will occur for the replacement items only.
377 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
378 * @param[in] replacementItems The replacements for a set of existing items.
379 * @param[in] durationSeconds How long the relayout takes in seconds.
381 void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
384 * @brief Set the parent origin of the items
386 * A relayout will occur for all the items if the parent origin is different than the current one.
387 * @param[in] parentOrigin New parent origin position vector
389 void SetItemsParentOrigin( const Vector3& parentOrigin );
392 * @brief Get the parent origin of the items
394 * @return The current parent origin of the items
396 Vector3 GetItemsParentOrigin() const;
399 * @brief Set the anchor point of the items
401 * A relayout will occur for all the items if the anchor point is different than the current one.
402 * @param[in] anchorPoint New anchor point position vector
404 void SetItemsAnchorPoint( const Vector3& anchorPoint );
407 * @brief Get the anchor point of the items
409 * @return The current anchor point of the items
411 Vector3 GetItemsAnchorPoint() const;
414 * @brief Get the range of items that are currently in ItemView.
416 * @param[out] range The range of items.
418 void GetItemsRange(ItemRange& range);
420 public: // Not intended for application developers
423 * @brief Creates a handle using the Toolkit::Internal implementation.
425 * @param[in] implementation The Control implementation.
427 ItemView(Internal::ItemView& implementation);
430 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
432 * @param[in] internal A pointer to the internal CustomActor.
434 ItemView( Dali::Internal::CustomActor* internal );
437 } // namespace Toolkit
441 #endif // __DALI_TOOLKIT_ITEM_VIEW_H__