Add 'ExclusiveArch: armv7l' limit build to arm architecture
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / scrollable / item-view / item-view-impl.h
index a6972ca..5f42a61 100644 (file)
@@ -171,12 +171,12 @@ public:
   /**
    * @copydoc Toolkit::ItemView::SetRefreshInterval
    */
-  void SetRefreshInterval(unsigned int intervalMilliseconds);
+  void SetRefreshInterval(float intervalLayoutPositions);
 
   /**
    * @copydoc Toolkit::ItemView::GetRefreshInterval
    */
-  unsigned int GetRefreshInterval() const;
+  float GetRefreshInterval() const;
 
   /**
    * @copydoc Toolkit::ItemView::GetItem
@@ -243,6 +243,25 @@ public:
    */
   void ScrollTo(const Vector3& position, float duration);
 
+  /**
+   * @brief Set whether to enable automatic refresh or not. When refresh is disabled,
+   * ItemView will not automatically refresh the cache in the given interval when the
+   * layout position is changed. This is useful in some cases, for example, automatic
+   * refresh is not needed during fast scrolling, otherwise it will cache unneeded
+   * items when the layout position changes quickly.
+   *
+   * @param[in] enabled True to enable automatic refresh or false to disable it.
+   */
+  void SetRefreshEnabled(bool enabled);
+
+  /**
+   * @brief Helper to perform the refresh.
+   *
+   * @param[in] currentLayoutPosition The current layout position.
+   * @param[in] cacheExtra Whether to cache extra items during refresh.
+   */
+  void DoRefresh(float currentLayoutPosition, bool cacheExtra);
+
 private:
 
   /**
@@ -260,16 +279,17 @@ private:
 
   /**
    * Add a range of Actors, if they are not already in the ItemPool.
-   * @param[in] layout The active layout.
    * @param[in] range The range of Item IDs to associate with the new actors.
+   * @param[in] durationSeconds The time taken to fully constrain the newly added actor.
    */
-  void AddActorsWithinRange( ItemRange range );
+  void AddActorsWithinRange( ItemRange range, float durationSeconds );
 
   /**
    * Add a new Actor, if not already in the ItemPool.
    * @param[in] item The ID for the new item.
+   * @param[in] durationSeconds The time taken to fully constrain the new actor.
    */
-  void AddNewActor( ItemId item );
+  void AddNewActor( ItemId item, float durationSeconds );
 
   /**
    * Apply the constraints etc. that are required for ItemView children.
@@ -281,6 +301,12 @@ private:
 private: // From CustomActorImpl
 
   /**
+   * From CustomActorImpl; called after a child has been added to the owning actor.
+   * @param[in] child The child which has been added.
+   */
+  virtual void OnChildAdd(Actor& child);
+
+  /**
    * From CustomActorImpl; called after a touch-signal is received by the owning actor.
    * @param[in] event The touch event.
    * @return True if the event should be consumed.
@@ -372,7 +398,7 @@ private:
    * @param[in] range The range of items.
    * @param[in] reserveExtra True if reserve items should be included.
    */
-  ItemRange GetItemRange(ItemLayout& layout, const Vector3& layoutSize, bool reserveExtra);
+  ItemRange GetItemRange(ItemLayout& layout, const Vector3& layoutSize, float layoutPosition, bool reserveExtra);
 
   // Input Handling
 
@@ -420,23 +446,6 @@ private:
   void OnOvershootOnFinished(Animation& animation);
 
   /**
-   * Helper to start the refresh timer.
-   */
-  void StartRefreshTimer();
-
-  /**
-   * Helper to cancel the refresh timer.
-   */
-  void CancelRefreshTimer();
-
-  /**
-   * Refresh the ItemView; this is called after a timeout when scrolling.
-   * During a refresh, ItemFactory::NewItem() will be called to create newly visible items.
-   * @return True if the refresh timer should be kept running.
-   */
-  bool OnRefreshTick();
-
-  /**
    * This is called after a timeout when no new mouse wheel event is received for a certain period of time.
    * @return will return false; one-shot timer.
    */
@@ -487,6 +496,14 @@ private:
    */
   bool IsLayoutScrollable(const Vector3& layoutSize);
 
+  /**
+   * Callback when the current layout position of ItemView changes in both positive
+   * and negative directions by the specified amount. Refresh the ItemView to create
+   * newly visible items.
+   * @param[in] source the property notification that triggered this callback
+   */
+  void OnRefreshNotification(PropertyNotification& source);
+
 private:
 
   ItemFactory& mItemFactory;
@@ -513,8 +530,8 @@ private:
   bool mAnchoringEnabled;
   float mAnchoringDuration;
 
-  Timer mRefreshTimer;
-  int mRefreshIntervalMilliseconds;
+  float mRefreshIntervalLayoutPositions;  ///< Refresh item view when the layout position changes by this interval in both positive and negative directions.
+  PropertyNotification mRefreshNotification; // stores the property notification used for item view refresh
   bool mRefreshOrderHint; ///< True if scrolling towards the last item
 
   // Input handling
@@ -540,10 +557,13 @@ private:
   Dali::Toolkit::ScrollConnector mScrollConnector; ///< Connects ItemView with scrollable components e.g. scroll bars
   Constrainable   mScrollPositionObject;     ///< From mScrollConnector
 
+  bool mAddingItems;
+
   Property::Index mPropertyPosition; ///< The physical position of the first item within the layout
   Property::Index mPropertyMinimumLayoutPosition; ///< The minimum valid layout position in the layout.
   Property::Index mPropertyScrollSpeed; ///< The current scroll speed of item view
-  Property::Index mPropertyOvershoot; ///< The scroll overshoot (difference of the layout position before and after clamping)
+
+  bool mRefreshEnabled; ///< Whether to refresh the cache automatically
 };
 
 } // namespace Internal