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