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 Flora License, Version 1.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://floralicense.org/license/
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.
21 * @addtogroup CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE
26 #include <dali/dali.h>
29 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
30 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h>
32 namespace Dali DALI_IMPORT_API
38 namespace Internal DALI_INTERNAL
43 class ScrollConnector;
47 typedef IntrusivePtr<ItemLayout> ItemLayoutPtr;
50 * @brief ItemView is a scrollable layout container.
52 * Multiple ItemLayouts may be provided, to determine the logical position of each item a layout.
53 * Actors are provided from an external ItemFactory, to display the currently visible items.
55 class ItemView : public Scrollable
60 * @brief Create an uninitialized ItemView; this can be initialized with ItemView::New().
62 * Calling member functions with an uninitialized Dali::Object is not allowed.
67 * @brief Copy constructor.
69 ItemView( const ItemView& itemView );
72 * @brief Assignment operator.
74 ItemView& operator=( const ItemView& itemView );
77 * @brief Virtual destructor.
79 * Dali::Object derived classes typically do not contain member data.
84 * @brief Create an initialized ItemView.
86 * @param[in] factory The factory which provides ItemView with items.
87 * @return A handle to a newly allocated Dali resource.
89 static ItemView New(ItemFactory& factory);
92 * @brief Downcast an Object handle to ItemView.
94 * If handle points to a ItemView the downcast produces valid
95 * handle. If not the returned handle is left uninitialized.
97 * @param[in] handle Handle to an object
98 * @return handle to a ItemView or an uninitialized handle
100 static ItemView DownCast( BaseHandle handle );
103 * @brief Retrieve a scroll-connector; this can be used to connect scroll components e.g. scroll bars.
105 * @return The connector.
107 ScrollConnector GetScrollConnector() const;
110 * @brief Query the number of layouts.
112 * @return The number of layouts.
114 unsigned int GetLayoutCount() const;
117 * @brief Add a layout.
119 * @param[in] layout The layout.
121 void AddLayout(ItemLayout& layout);
124 * @brief Remove a layout.
126 * @pre layoutIndex is less than GetLayoutCount().
127 * @param[in] layoutIndex The index of one of the ItemView layouts.
129 void RemoveLayout(unsigned int layoutIndex);
132 * @brief Retrieve a layout.
134 * @pre layoutIndex is less than GetLayoutCount().
135 * @param[in] layoutIndex The index of the layout to retrieve.
138 ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
141 * @brief Retrieve the currently active layout, if any.
143 * @return The layout, or an uninitialized pointer if no layout is active.
145 ItemLayoutPtr GetActiveLayout() const;
148 * @brief Retrieve the current layout-position of an item in the ItemView.
150 * @param[in] itemId The item identifier.
151 * @return The current layout-position.
153 float GetCurrentLayoutPosition(ItemId itemId) const;
156 * @brief Activate one of the layouts; this will resize the ItemView
157 * & relayout actors within the ItemView.
159 * This is done by applying constraints from the new layout, and
160 * removing constraints from the previous layout.
162 * @pre layoutIndex is less than GetLayoutCount().
163 * @pre durationSeconds is greater or equal to zero.
164 * @param[in] layoutIndex The index of one of the ItemView layouts.
165 * @param[in] targetSize The target ItemView & layout size.
166 * @param[in] durationSeconds The time taken to relayout in seconds (zero for immediate).
168 void ActivateLayout(unsigned int layoutIndex, Vector3 targetSize, float durationSeconds);
171 * @brief Deactivate the current layout, if any.
173 * The constraints applied by the layout will be removed.
175 void DeactivateCurrentLayout();
178 * @brief Set default the alpha function used when applying constraints e.g. during ActivateLayout().
180 * @param[in] func The default alpha function to use.
182 void SetDefaultAlphaFunction(AlphaFunction func);
185 * @brief Retrieve the default alpha function for an animation.
187 * @return The default alpha function.
189 AlphaFunction GetDefaultAlphaFunction() const;
192 * @brief Set the minimum swipe speed in pixels per second; A pan
193 * gesture must exceed this to trigger a swipe.
195 * @param[in] speed The minimum swipe speed
197 void SetMinimumSwipeSpeed(float speed);
200 * @brief Get the minimum swipe speed in pixels per second.
202 * @return The minimum swipe speed
204 float GetMinimumSwipeSpeed() const;
207 * @brief Set the minimum swipe distance in actor coordinates; A pan
208 * gesture must exceed this to trigger a swipe.
210 * @param[in] distance The minimum swipe distance.
212 void SetMinimumSwipeDistance(float distance);
215 * @brief Get the minimum swipe distance in actor coordinates.
217 * @return The minimum swipe distance
219 float GetMinimumSwipeDistance() const;
222 * @brief Set the step of scroll distance in actor coordinates for each mouse wheel event received.
224 * @param[in] step The step of scroll distance(pixel).
226 void SetMouseWheelScrollDistanceStep(float step);
229 * @brief Get the step of scroll distance in actor coordinates for each mouse wheel event received.
231 * @return The step of scroll distance(pixel)
233 float GetMouseWheelScrollDistanceStep() const;
236 * @brief Set whether to enable the animation for the layout to
237 * scroll to its anchor position after dragging or swiping.
239 * The anchor position is the position where all the items in the layout
240 * are aligned to their closest rounded layout positions in integer.
242 * @param[in] enabled Whether the anchor animation is enabled or not.
244 void SetAnchoring(bool enabled);
247 * @brief Get whether the anchor animation is enabled or not.
249 * @return Whether the anchor animation is enabled or not.
251 bool GetAnchoring() const;
254 * @brief Set the duration of the anchor animation in seconds.
256 * This is the time taken to reach the nearest anchor position after
257 * a drag or swipe gesture ends.
259 * @pre durationSeconds must be greater than zero.
260 * @param[in] durationSeconds The duration of the anchor animation in seconds.
262 void SetAnchoringDuration(float durationSeconds);
265 * @brief Get the duration of the anchor animation in seconds.
267 * @return The duration of the anchor animation
269 float GetAnchoringDuration() const;
272 * @brief Scroll the current layout to a particular item.
274 * @pre durationSeconds must be zero or greater; zero means the layout should scroll to the particular item instantly.
275 * If calling this with zero second of duration immediately after calling ActivateLayout, it might not work unless
276 * the duration of relayout animation for ActivateLayout is also set to be zero.
277 * @param[in] itemId The ID of an item in the layout.
278 * @param[in] durationSeconds How long the scrolling takes in seconds.
280 void ScrollToItem(ItemId itemId, float durationSeconds);
283 * @brief Set the interval between refreshes. When the layout-position of items is changed by this interval,
284 * new items are requested from ItemFactory.
286 * @param[in] intervalLayoutPositions The refresh interval in layout position.
288 void SetRefreshInterval(float intervalLayoutPositions);
291 * @brief Get the interval between refreshes in layout position.
293 * @return The refresh interval
295 float GetRefreshInterval() const;
298 * @brief Given the Item ID, this returns the accompanying actor.
300 * @param[in] itemId The Item ID of the actor required.
301 * @return The Actor corresponding to the Item ID.
303 Actor GetItem(ItemId itemId) const;
306 * @brief Returns the Item ID of the specified actor.
308 * @param[in] actor The actor whose Item ID is required.
309 * @return The Item ID of the item.
310 * @pre The actor should be an item of ItemView.
312 ItemId GetItemId(Actor actor) const;
315 * @brief Insert an item.
317 * A relayout will occur for the existing actors; for example if InsertItem(Item(2, ActorZ), 0) is called,
318 * the items with ID 2 or greater will be moved:
319 * Initial actors: After insert:
320 * ID 1 - ActorA ID 1 - ActorA
321 * ID 2 - ActorB ID 2 - ActorZ !
322 * ID 3 - ActorC ID 3 - ActorB
324 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
325 * @param[in] newItem The item to insert.
326 * @param[in] durationSeconds How long the relayout takes in seconds.
328 void InsertItem(Item newItem, float durationSeconds);
331 * @brief Insert a set of items; this is more efficient than calling InsertItem() repeatedly.
333 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
334 * @param[in] newItems The items to insert.
335 * @param[in] durationSeconds How long the relayout takes in seconds.
337 void InsertItems(const ItemContainer& newItems, float durationSeconds);
340 * @brief Removes an item with the given ID.
342 * A relayout will occur for the remaining actors; for example if RemoveItem(Item(2, ActorZ), 0) is called,
343 * the items with ID 3 or greater will be moved:
344 * Initial actors: After remove:
345 * ID 1 - ActorA ID 1 - ActorA
346 * ID 2 - ActorB ID 2 - ActorC (previously ID 3)
347 * ID 3 - ActorC ID 3 - ActorB (previously ID 4)
349 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
350 * @param[in] itemId The Item ID of the item to remove.
351 * @param[in] durationSeconds How long the relayout takes in seconds.
353 void RemoveItem(ItemId itemId, float durationSeconds);
356 * @brief Remove a set of items; this is more efficient than calling RemoveItem() repeatedly.
358 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
359 * @param[in] itemIds The IDs of the items to remove.
360 * @param[in] durationSeconds How long the relayout takes in seconds.
362 void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
365 * @brief Replace an item.
367 * A relayout will occur for the replacement item only.
368 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
369 * @param[in] replacementItem The replacement for an existing item.
370 * @param[in] durationSeconds How long the relayout takes in seconds.
372 void ReplaceItem(Item replacementItem, float durationSeconds);
375 * @brief Replace a set of items.
377 * A relayout will occur for the replacement items only.
378 * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
379 * @param[in] replacementItems The replacements for a set of existing items.
380 * @param[in] durationSeconds How long the relayout takes in seconds.
382 void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
385 * @brief Set the parent origin of the items
387 * A relayout will occur for all the items if the parent origin is different than the current one.
388 * @param[in] parentOrigin New parent origin position vector
390 void SetItemsParentOrigin( const Vector3& parentOrigin );
393 * @brief Get the parent origin of the items
395 * @return The current parent origin of the items
397 Vector3 GetItemsParentOrigin() const;
400 * @brief Set the anchor point of the items
402 * A relayout will occur for all the items if the anchor point is different than the current one.
403 * @param[in] anchorPoint New anchor point position vector
405 void SetItemsAnchorPoint( const Vector3& anchorPoint );
408 * @brief Get the anchor point of the items
410 * @return The current anchor point of the items
412 Vector3 GetItemsAnchorPoint() const;
414 public: // Not intended for application developers
417 * @brief Creates a handle using the Toolkit::Internal implementation.
419 * @param[in] implementation The Control implementation.
421 ItemView(Internal::ItemView& implementation);
424 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
426 * @param[in] internal A pointer to the internal CustomActor.
428 ItemView( Dali::Internal::CustomActor* internal );
431 } // namespace Toolkit
438 #endif // __DALI_TOOLKIT_ITEM_VIEW_H__