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 * @addtogroup CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE
27 #include <dali/dali.h>
30 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
31 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h>
33 namespace Dali DALI_IMPORT_API
39 namespace Internal DALI_INTERNAL
44 class ScrollConnector;
48 typedef IntrusivePtr<ItemLayout> ItemLayoutPtr;
51 * @brief ItemView is a scrollable layout container.
53 * Multiple ItemLayouts may be provided, to determine the logical position of each item a layout.
54 * Actors are provided from an external ItemFactory, to display the currently visible items.
56 class ItemView : public Scrollable
61 * @brief Create an uninitialized ItemView; this can be initialized with ItemView::New().
63 * Calling member functions with an uninitialized Dali::Object is not allowed.
68 * @brief Copy constructor.
70 ItemView( const ItemView& itemView );
73 * @brief Assignment operator.
75 ItemView& operator=( const ItemView& itemView );
78 * @brief Virtual destructor.
80 * Dali::Object derived classes typically do not contain member data.
85 * @brief Create an initialized ItemView.
87 * @param[in] factory The factory which provides ItemView with items.
88 * @return A handle to a newly allocated Dali resource.
90 static ItemView New(ItemFactory& factory);
93 * @brief Downcast an Object handle to ItemView.
95 * If handle points to a ItemView the downcast produces valid
96 * handle. If not the returned handle is left uninitialized.
98 * @param[in] handle Handle to an object
99 * @return handle to a ItemView or an uninitialized handle
101 static ItemView DownCast( BaseHandle handle );
104 * @brief Retrieve a scroll-connector; this can be used to connect scroll components e.g. scroll bars.
106 * @return The connector.
108 ScrollConnector GetScrollConnector() const;
111 * @brief Query the number of layouts.
113 * @return The number of layouts.
115 unsigned int GetLayoutCount() const;
118 * @brief Add a layout.
120 * @param[in] layout The layout.
122 void AddLayout(ItemLayout& layout);
125 * @brief Remove a layout.
127 * @pre layoutIndex is less than GetLayoutCount().
128 * @param[in] layoutIndex The index of one of the ItemView layouts.
130 void RemoveLayout(unsigned int layoutIndex);
133 * @brief Retrieve a layout.
135 * @pre layoutIndex is less than GetLayoutCount().
136 * @param[in] layoutIndex The index of the layout to retrieve.
139 ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
142 * @brief Retrieve the currently active layout, if any.
144 * @return The layout, or an uninitialized pointer if no layout is active.
146 ItemLayoutPtr GetActiveLayout() const;
149 * @brief Retrieve the current layout-position of an item in the ItemView.
151 * @param[in] itemId The item identifier.
152 * @return The current layout-position.
154 float GetCurrentLayoutPosition(ItemId itemId) const;
157 * @brief Activate one of the layouts; this will resize the ItemView
158 * & relayout actors within the ItemView.
160 * This is done by applying constraints from the new layout, and
161 * removing constraints from the previous layout.
163 * @pre layoutIndex is less than GetLayoutCount().
164 * @pre durationSeconds is greater or equal to zero.
165 * @param[in] layoutIndex The index of one of the ItemView layouts.
166 * @param[in] targetSize The target ItemView & layout size.
167 * @param[in] durationSeconds The time taken to relayout in seconds (zero for immediate).
169 void ActivateLayout(unsigned int layoutIndex, Vector3 targetSize, float durationSeconds);
172 * @brief Deactivate the current layout, if any.
174 * The constraints applied by the layout will be removed.
176 void DeactivateCurrentLayout();
179 * @brief Set default the alpha function used when applying constraints e.g. during ActivateLayout().
181 * @param[in] func The default alpha function to use.
183 void SetDefaultAlphaFunction(AlphaFunction func);
186 * @brief Retrieve the default alpha function for an animation.
188 * @return The default alpha function.
190 AlphaFunction GetDefaultAlphaFunction() const;
193 * @brief Set the minimum swipe speed in pixels per second; A pan
194 * gesture must exceed this to trigger a swipe.
196 * @param[in] speed The minimum swipe speed
198 void SetMinimumSwipeSpeed(float speed);
201 * @brief Get the minimum swipe speed in pixels per second.
203 * @return The minimum swipe speed
205 float GetMinimumSwipeSpeed() const;
208 * @brief Set the minimum swipe distance in actor coordinates; A pan
209 * gesture must exceed this to trigger a swipe.
211 * @param[in] distance The minimum swipe distance.
213 void SetMinimumSwipeDistance(float distance);
216 * @brief Get the minimum swipe distance in actor coordinates.
218 * @return The minimum swipe distance
220 float GetMinimumSwipeDistance() const;
223 * @brief Set the step of scroll distance in actor coordinates for each mouse wheel event received.
225 * @param[in] step The step of scroll distance(pixel).
227 void SetMouseWheelScrollDistanceStep(float step);
230 * @brief Get the step of scroll distance in actor coordinates for each mouse wheel event received.
232 * @return The step of scroll distance(pixel)
234 float GetMouseWheelScrollDistanceStep() const;
237 * @brief Set whether to enable the animation for the layout to
238 * scroll to its anchor position after dragging or swiping.
240 * The anchor position is the position where all the items in the layout
241 * are aligned to their closest rounded layout positions in integer.
243 * @param[in] enabled Whether the anchor animation is enabled or not.
245 void SetAnchoring(bool enabled);
248 * @brief Get whether the anchor animation is enabled or not.
250 * @return Whether the anchor animation is enabled or not.
252 bool GetAnchoring() const;
255 * @brief Set the duration of the anchor animation in seconds.
257 * This is the time taken to reach the nearest anchor position after
258 * a drag or swipe gesture ends.
260 * @pre durationSeconds must be greater than zero.
261 * @param[in] durationSeconds The duration of the anchor animation in seconds.
263 void SetAnchoringDuration(float durationSeconds);
266 * @brief Get the duration of the anchor animation in seconds.
268 * @return The duration of the anchor animation
270 float GetAnchoringDuration() const;
273 * @brief Scroll the current layout to a particular item.
275 * @pre durationSeconds must be zero or greater; zero means the layout should scroll to the particular item instantly.
276 * If calling this with zero second of duration immediately after calling ActivateLayout, it might not work unless
277 * the duration of relayout animation for ActivateLayout is also set to be zero.
278 * @param[in] itemId The ID of an item in the layout.
279 * @param[in] durationSeconds How long the scrolling takes in seconds.
281 void ScrollToItem(ItemId itemId, float durationSeconds);
284 * @brief Set the interval between refreshes. When the layout-position of items is changed by this interval,
285 * new items are requested from ItemFactory.
287 * @param[in] intervalLayoutPositions The refresh interval in layout position.
289 void SetRefreshInterval(float intervalLayoutPositions);
292 * @brief Get the interval between refreshes in layout position.
294 * @return The refresh interval
296 float GetRefreshInterval() const;
299 * @brief Given the Item ID, this returns the accompanying actor.
301 * @param[in] itemId The Item ID of the actor required.
302 * @return The Actor corresponding to the Item ID.
304 Actor GetItem(ItemId itemId) const;
307 * @brief Returns the Item ID of the specified actor.
309 * @param[in] actor The actor whose Item ID is required.
310 * @return The Item ID of the item.
311 * @pre The actor should be an item of ItemView.
313 ItemId GetItemId(Actor actor) const;
316 * @brief Insert an item.
318 * A relayout will occur for the existing actors; for example if InsertItem(Item(2, ActorZ), 0) is called,
319 * the items with ID 2 or greater will be moved:
320 * Initial actors: After insert:
321 * ID 1 - ActorA ID 1 - ActorA
322 * ID 2 - ActorB ID 2 - ActorZ !
323 * ID 3 - ActorC ID 3 - ActorB
325 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
326 * @param[in] newItem The item to insert.
327 * @param[in] durationSeconds How long the relayout takes in seconds.
329 void InsertItem(Item newItem, float durationSeconds);
332 * @brief Insert a set of items; this is more efficient than calling InsertItem() repeatedly.
334 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
335 * @param[in] newItems The items to insert.
336 * @param[in] durationSeconds How long the relayout takes in seconds.
338 void InsertItems(const ItemContainer& newItems, float durationSeconds);
341 * @brief Removes an item with the given ID.
343 * A relayout will occur for the remaining actors; for example if RemoveItem(Item(2, ActorZ), 0) is called,
344 * the items with ID 3 or greater will be moved:
345 * Initial actors: After remove:
346 * ID 1 - ActorA ID 1 - ActorA
347 * ID 2 - ActorB ID 2 - ActorC (previously ID 3)
348 * ID 3 - ActorC ID 3 - ActorB (previously ID 4)
350 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
351 * @param[in] itemId The Item ID of the item to remove.
352 * @param[in] durationSeconds How long the relayout takes in seconds.
354 void RemoveItem(ItemId itemId, float durationSeconds);
357 * @brief Remove a set of items; this is more efficient than calling RemoveItem() repeatedly.
359 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
360 * @param[in] itemIds The IDs of the items to remove.
361 * @param[in] durationSeconds How long the relayout takes in seconds.
363 void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
366 * @brief Replace an item.
368 * A relayout will occur for the replacement item only.
369 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
370 * @param[in] replacementItem The replacement for an existing item.
371 * @param[in] durationSeconds How long the relayout takes in seconds.
373 void ReplaceItem(Item replacementItem, float durationSeconds);
376 * @brief Replace a set of items.
378 * A relayout will occur for the replacement items only.
379 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
380 * @param[in] replacementItems The replacements for a set of existing items.
381 * @param[in] durationSeconds How long the relayout takes in seconds.
383 void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
386 * @brief Set the parent origin of the items
388 * A relayout will occur for all the items if the parent origin is different than the current one.
389 * @param[in] parentOrigin New parent origin position vector
391 void SetItemsParentOrigin( const Vector3& parentOrigin );
394 * @brief Get the parent origin of the items
396 * @return The current parent origin of the items
398 Vector3 GetItemsParentOrigin() const;
401 * @brief Set the anchor point of the items
403 * A relayout will occur for all the items if the anchor point is different than the current one.
404 * @param[in] anchorPoint New anchor point position vector
406 void SetItemsAnchorPoint( const Vector3& anchorPoint );
409 * @brief Get the anchor point of the items
411 * @return The current anchor point of the items
413 Vector3 GetItemsAnchorPoint() const;
415 public: // Not intended for application developers
418 * @brief Creates a handle using the Toolkit::Internal implementation.
420 * @param[in] implementation The Control implementation.
422 ItemView(Internal::ItemView& implementation);
425 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
427 * @param[in] internal A pointer to the internal CustomActor.
429 ItemView( Dali::Internal::CustomActor* internal );
432 } // namespace Toolkit
439 #endif // __DALI_TOOLKIT_ITEM_VIEW_H__