base/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h

   1 #ifndef __DALI_TOOLKIT_ITEM_VIEW_H__
   2 #define __DALI_TOOLKIT_ITEM_VIEW_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/dali.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
  26 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view-declarations.h>
  27
  28 namespace Dali DALI_IMPORT_API
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 namespace Internal DALI_INTERNAL
  35 {
  36 class ItemView;
  37 }
  38
  39 class ScrollConnector;
  40 class ItemFactory;
  41 class ItemLayout;
  42 struct ItemRange;
  43
  44 typedef IntrusivePtr<ItemLayout> ItemLayoutPtr;
  45
  46 /**
  47  * @brief ItemView is a scrollable layout container.
  48  *
  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.
  51  */
  52 class ItemView : public Scrollable
  53 {
  54 public:
  55
  56   /**
  57    * @brief Create an uninitialized ItemView; this can be initialized with ItemView::New().
  58    *
  59    * Calling member functions with an uninitialized Dali::Object is not allowed.
  60    */
  61   ItemView();
  62
  63   /**
  64    * @brief Copy constructor.
  65    */
  66   ItemView( const ItemView& itemView );
  67
  68   /**
  69    * @brief Assignment operator.
  70    */
  71   ItemView& operator=( const ItemView& itemView );
  72
  73   /**
  74    * @brief Destructor
  75    *
  76    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  77    */
  78   ~ItemView();
  79
  80   /**
  81    * @brief Create an initialized ItemView.
  82    *
  83    * @param[in] factory The factory which provides ItemView with items.
  84    * @return A handle to a newly allocated Dali resource.
  85    */
  86   static ItemView New(ItemFactory& factory);
  87
  88   /**
  89    * @brief Downcast an Object handle to ItemView.
  90    *
  91    * If handle points to a ItemView the downcast produces valid
  92    * handle. If not the returned handle is left uninitialized.
  93    *
  94    * @param[in] handle Handle to an object
  95    * @return handle to a ItemView or an uninitialized handle
  96    */
  97   static ItemView DownCast( BaseHandle handle );
  98
  99   /**
 100    * @brief Retrieve a scroll-connector; this can be used to connect scroll components e.g. scroll bars.
 101    *
 102    * @return The connector.
 103    */
 104   ScrollConnector GetScrollConnector() const;
 105
 106   /**
 107    * @brief Query the number of layouts.
 108    *
 109    * @return The number of layouts.
 110    */
 111   unsigned int GetLayoutCount() const;
 112
 113   /**
 114    * @brief Add a layout.
 115    *
 116    * @param[in] layout The layout.
 117    */
 118   void AddLayout(ItemLayout& layout);
 119
 120   /**
 121    * @brief Remove a layout.
 122    *
 123    * @pre layoutIndex is less than GetLayoutCount().
 124    * @param[in] layoutIndex The index of one of the ItemView layouts.
 125    */
 126   void RemoveLayout(unsigned int layoutIndex);
 127
 128   /**
 129    * @brief Retrieve a layout.
 130    *
 131    * @pre layoutIndex is less than GetLayoutCount().
 132    * @param[in] layoutIndex The index of the layout to retrieve.
 133    * @return The layout
 134    */
 135   ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
 136
 137   /**
 138    * @brief Retrieve the currently active layout, if any.
 139    *
 140    * @return The layout, or an uninitialized pointer if no layout is active.
 141    */
 142   ItemLayoutPtr GetActiveLayout() const;
 143
 144   /**
 145    * @brief Retrieve the current layout-position of an item in the ItemView.
 146    *
 147    * @param[in] itemId The item identifier.
 148    * @return The current layout-position.
 149    */
 150   float GetCurrentLayoutPosition(ItemId itemId) const;
 151
 152   /**
 153    * @brief Activate one of the layouts; this will resize the ItemView
 154    * & relayout actors within the ItemView.
 155    *
 156    * This is done by applying constraints from the new layout, and
 157    * removing constraints from the previous layout.
 158    *
 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).
 164    */
 165   void ActivateLayout(unsigned int layoutIndex, Vector3 targetSize, float durationSeconds);
 166
 167   /**
 168    * @brief Deactivate the current layout, if any.
 169    *
 170    * The constraints applied by the layout will be removed.
 171    */
 172   void DeactivateCurrentLayout();
 173
 174   /**
 175    * @brief Set the minimum swipe speed in pixels per second; A pan
 176    * gesture must exceed this to trigger a swipe.
 177    *
 178    * @param[in] speed The minimum swipe speed
 179    */
 180   void SetMinimumSwipeSpeed(float speed);
 181
 182   /**
 183    * @brief Get the minimum swipe speed in pixels per second.
 184    *
 185    * @return The minimum swipe speed
 186    */
 187   float GetMinimumSwipeSpeed() const;
 188
 189   /**
 190    * @brief Set the minimum swipe distance in actor coordinates; A pan
 191    * gesture must exceed this to trigger a swipe.
 192    *
 193    * @param[in] distance The minimum swipe distance.
 194    */
 195   void SetMinimumSwipeDistance(float distance);
 196
 197   /**
 198    * @brief Get the minimum swipe distance in actor coordinates.
 199    *
 200    * @return The minimum swipe distance
 201    */
 202   float GetMinimumSwipeDistance() const;
 203
 204   /**
 205    * @brief Set the step of scroll distance in actor coordinates for each mouse wheel event received.
 206    *
 207    * @param[in] step The step of scroll distance(pixel).
 208    */
 209   void SetMouseWheelScrollDistanceStep(float step);
 210
 211   /**
 212    * @brief Get the step of scroll distance in actor coordinates for each mouse wheel event received.
 213    *
 214    * @return The step of scroll distance(pixel)
 215    */
 216   float GetMouseWheelScrollDistanceStep() const;
 217
 218   /**
 219    * @brief Set whether to enable the animation for the layout to
 220    * scroll to its anchor position after dragging or swiping.
 221    *
 222    * The anchor position is the position where all the items in the layout
 223    * are aligned to their closest rounded layout positions in integer.
 224    *
 225    * @param[in] enabled Whether the anchor animation is enabled or not.
 226    */
 227   void SetAnchoring(bool enabled);
 228
 229   /**
 230    * @brief Get whether the anchor animation is enabled or not.
 231    *
 232    * @return Whether the anchor animation is enabled or not.
 233    */
 234   bool GetAnchoring() const;
 235
 236   /**
 237    * @brief Set the duration of the anchor animation in seconds.
 238    *
 239    * This is the time taken to reach the nearest anchor position after
 240    * a drag or swipe gesture ends.
 241    *
 242    * @pre durationSeconds must be greater than zero.
 243    * @param[in] durationSeconds The duration of the anchor animation in seconds.
 244    */
 245   void SetAnchoringDuration(float durationSeconds);
 246
 247   /**
 248    * @brief Get the duration of the anchor animation in seconds.
 249    *
 250    * @return The duration of the anchor animation
 251    */
 252   float GetAnchoringDuration() const;
 253
 254   /**
 255    * @brief Scroll the current layout to a particular item.
 256    *
 257    * @pre durationSeconds must be zero or greater; zero means the layout should scroll to the particular item instantly.
 258    * If calling this with zero second of duration immediately after calling ActivateLayout, it might not work unless
 259    * the duration of relayout animation for ActivateLayout is also set to be zero.
 260    * @param[in] itemId The ID of an item in the layout.
 261    * @param[in] durationSeconds How long the scrolling takes in seconds.
 262    */
 263   void ScrollToItem(ItemId itemId, float durationSeconds);
 264
 265   /**
 266    * @brief Set the interval between refreshes. When the layout-position of items is changed by this interval,
 267    * new items are requested from ItemFactory.
 268    *
 269    * @param[in] intervalLayoutPositions The refresh interval in layout position.
 270    */
 271   void SetRefreshInterval(float intervalLayoutPositions);
 272
 273   /**
 274    * @brief Get the interval between refreshes in layout position.
 275    *
 276    * @return  The refresh interval
 277    */
 278   float GetRefreshInterval() const;
 279
 280   /**
 281    * @brief Given the Item ID, this returns the accompanying actor.
 282    *
 283    * @param[in] itemId The Item ID of the actor required.
 284    * @return The Actor corresponding to the Item ID.
 285    */
 286   Actor GetItem(ItemId itemId) const;
 287
 288   /**
 289    * @brief Returns the Item ID of the specified actor.
 290    *
 291    * @param[in] actor The actor whose Item ID is required.
 292    * @return The Item ID of the item.
 293    * @pre The actor should be an item of ItemView.
 294    */
 295   ItemId GetItemId(Actor actor) const;
 296
 297   /**
 298    * @brief Insert an item.
 299    *
 300    * A relayout will occur for the existing actors; for example if InsertItem(Item(2, ActorZ), 0) is called,
 301    * the items with ID 2 or greater will be moved:
 302    *   Initial actors:     After insert:
 303    *     ID 1 - ActorA       ID 1 - ActorA
 304    *     ID 2 - ActorB       ID 2 - ActorZ !
 305    *     ID 3 - ActorC       ID 3 - ActorB
 306    *                         ID 4 - ActorC
 307    * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
 308    * @param[in] newItem The item to insert.
 309    * @param[in] durationSeconds How long the relayout takes in seconds.
 310    */
 311   void InsertItem(Item newItem, float durationSeconds);
 312
 313   /**
 314    * @brief Insert a set of items; this is more efficient than calling InsertItem() repeatedly.
 315    *
 316    * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
 317    * @param[in] newItems The items to insert.
 318    * @param[in] durationSeconds How long the relayout takes in seconds.
 319    */
 320   void InsertItems(const ItemContainer& newItems, float durationSeconds);
 321
 322   /**
 323    * @brief Removes an item with the given ID.
 324    *
 325    * A relayout will occur for the remaining actors; for example if RemoveItem(Item(2, ActorZ), 0) is called,
 326    * the items with ID 3 or greater will be moved:
 327    *   Initial actors:     After remove:
 328    *     ID 1 - ActorA       ID 1 - ActorA
 329    *     ID 2 - ActorB       ID 2 - ActorC (previously ID 3)
 330    *     ID 3 - ActorC       ID 3 - ActorB (previously ID 4)
 331    *     ID 4 - ActorD
 332    * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
 333    * @param[in] itemId The Item ID of the item to remove.
 334    * @param[in] durationSeconds How long the relayout takes in seconds.
 335    */
 336   void RemoveItem(ItemId itemId, float durationSeconds);
 337
 338   /**
 339    * @brief Remove a set of items; this is more efficient than calling RemoveItem() repeatedly.
 340    *
 341    * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
 342    * @param[in] itemIds The IDs of the items to remove.
 343    * @param[in] durationSeconds How long the relayout takes in seconds.
 344    */
 345   void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
 346
 347   /**
 348    * @brief Replace an item.
 349    *
 350    * A relayout will occur for the replacement item only.
 351    * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
 352    * @param[in] replacementItem The replacement for an existing item.
 353    * @param[in] durationSeconds How long the relayout takes in seconds.
 354    */
 355   void ReplaceItem(Item replacementItem, float durationSeconds);
 356
 357   /**
 358    * @brief Replace a set of items.
 359    *
 360    * A relayout will occur for the replacement items only.
 361    * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
 362    * @param[in] replacementItems The replacements for a set of existing items.
 363    * @param[in] durationSeconds How long the relayout takes in seconds.
 364    */
 365   void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
 366
 367   /**
 368    * @brief Set the parent origin of the items
 369    *
 370    * A relayout will occur for all the items if the parent origin is different than the current one.
 371    * @param[in] parentOrigin New parent origin position vector
 372    */
 373   void SetItemsParentOrigin( const Vector3& parentOrigin );
 374
 375   /**
 376    * @brief Get the parent origin of the items
 377    *
 378    * @return The current parent origin of the items
 379    */
 380   Vector3 GetItemsParentOrigin() const;
 381
 382   /**
 383    * @brief Set the anchor point of the items
 384    *
 385    * A relayout will occur for all the items if the anchor point is different than the current one.
 386    * @param[in] anchorPoint New anchor point position vector
 387    */
 388   void SetItemsAnchorPoint( const Vector3& anchorPoint );
 389
 390   /**
 391    * @brief Get the anchor point of the items
 392    *
 393    * @return The current anchor point of the items
 394    */
 395   Vector3 GetItemsAnchorPoint() const;
 396
 397   /**
 398    * @brief Get the range of items that are currently in ItemView.
 399    *
 400    * @param[out] range The range of items.
 401    */
 402   void GetItemsRange(ItemRange& range);
 403
 404 public: // Not intended for application developers
 405
 406   /**
 407    * @brief Creates a handle using the Toolkit::Internal implementation.
 408    *
 409    * @param[in]  implementation  The Control implementation.
 410    */
 411   ItemView(Internal::ItemView& implementation);
 412
 413   /**
 414    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 415    *
 416    * @param[in]  internal  A pointer to the internal CustomActor.
 417    */
 418   ItemView( Dali::Internal::CustomActor* internal );
 419 };
 420
 421 } // namespace Toolkit
 422
 423 } // namespace Dali
 424
 425 #endif // __DALI_TOOLKIT_ITEM_VIEW_H__