Fix ItemView insert/remove when outside the current visible range
[platform/core/uifw/dali-toolkit.git] / base / dali-toolkit / internal / controls / scrollable / item-view / item-view-impl.h
index 5bdc060..51bb3ae 100644 (file)
@@ -1,24 +1,27 @@
 #ifndef __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__
 #define __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__
 
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 
 // EXTERNAL INCLUDES
-#include <dali/dali.h>
+#include <dali/public-api/adaptor-framework/timer.h>
+#include <dali/public-api/animation/animation.h>
+#include <dali/public-api/object/property-notification.h>
 
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/control-impl.h>
@@ -27,7 +30,6 @@
 #include <dali-toolkit/public-api/controls/scrollable/scroll-connector.h>
 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
-#include <dali-toolkit/public-api/shader-effects/bouncing-effect.h>
 
 namespace Dali
 {
@@ -99,16 +101,6 @@ public:
   void ActivateLayout(unsigned int layoutIndex, const Vector3& targetSize, float durationSeconds);
 
   /**
-   * @copydoc Toolkit::ItemView::SetDefaultAlphaFunction
-   */
-  void SetDefaultAlphaFunction(AlphaFunction func);
-
-  /**
-   * @copydoc Toolkit::ItemView::GetDefaultAlphaFunction
-   */
-  AlphaFunction GetDefaultAlphaFunction() const;
-
-  /**
    * @copydoc Toolkit::ItemView::DeactivateCurrentLayout
    */
   void DeactivateCurrentLayout();
@@ -244,6 +236,11 @@ public:
   void ScrollTo(const Vector3& position, float duration);
 
   /**
+   * @copydoc Toolkit::Internal::Scrollable::SetOvershootEffectColor
+   */
+  void SetOvershootEffectColor( const Vector4& color );
+
+  /**
    * @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
@@ -262,7 +259,6 @@ public:
    */
   void DoRefresh(float currentLayoutPosition, bool cacheExtra);
 
-
   /**
    * @copydoc Toolkit::ItemView::SetItemsParentOrigin
    */
@@ -283,12 +279,17 @@ public:
    */
   Vector3 GetItemsAnchorPoint() const;
 
+  /**
+   * @copydoc Toolkit::ItemView::GetItemsRange
+   */
+  void GetItemsRange(ItemRange& range);
+
 private:
 
   /**
    * Remove an Actor if found in the ItemPool.
    * @param[in] itemId The item to remove.
-   * @return True if an actor was removed.
+   * @return True if the remaining actors were reordered.
    */
   bool RemoveActor( unsigned int itemId );
 
@@ -319,6 +320,13 @@ private:
    */
   void SetupActor( Item item, float durationSeconds );
 
+  /**
+   * Remove the Actor from the ItemPool and notify the ItemFactory the actor has been released by ItemView.
+   * @param[in] item The ID for the item to be released.
+   * @param[in] actor The actor to be removed from ItemView.
+   */
+  void ReleaseActor( ItemId item, Actor actor );
+
 private: // From CustomActorImpl
 
   /**
@@ -341,7 +349,7 @@ private: // From CustomActorImpl
    */
   virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
 
-private: // From ControlImpl
+private: // From Control
 
   /**
    * @copydoc Toolkit::Control::OnInitialize()
@@ -356,7 +364,7 @@ private: // From ControlImpl
   /**
    * @copydoc Toolkit::Control::GetNextKeyboardFocusableActor()
    */
-  virtual Actor GetNextKeyboardFocusableActor(Actor actor, Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
+  virtual Actor GetNextKeyboardFocusableActor(Actor actor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
 
   /**
    * @copydoc Toolkit::Control::OnKeyboardFocusChangeCommitted()
@@ -385,19 +393,15 @@ private:
   ItemView& operator=(const ItemView& rhs);
 
   /**
-   * Helper to apply constraints to an actor.
-   * @param[in] actor The actor to constrain.
-   * @param[in] layout The active layout.
-   * @param[in] itemId The ID of the item represented by the actor.
+   * Helper to re-apply all the constraints after items have been inserted, removed etc.
    * @param[in] durationSeconds The time taken to fully constrain the actors.
    */
-  void ApplyConstraints(Actor& actor, ItemLayout& layout, unsigned int itemId, float durationSeconds);
+  void ReapplyAllConstraints( float durationSeconds );
 
   /**
-   * Helper to re-apply all the constraints after items have been inserted, removed etc.
-   * @param[in] durationSeconds The time taken to fully constrain the actors.
+   * Helper to relayout after item(s) are removed.
    */
-  void ReapplyAllConstraints( float durationSeconds );
+  void OnItemsRemoved();
 
   /**
    * Helper to remove items outside a given range.
@@ -445,7 +449,7 @@ private:
    *
    * @param[in] gesture The gesture event.
    */
-  void OnPan(PanGesture pan);
+  void OnPan( const PanGesture& pan );
 
   /**
    * Helper to handle anchoring animations.
@@ -460,6 +464,12 @@ private:
   void OnScrollFinished(Animation& animation);
 
   /**
+   * Callback from layout activation scroll animations
+   * @param[in] animation The scroll-animation which has finished.
+   */
+  void OnLayoutActivationScrollFinished(Animation& animation);
+
+  /**
    * Called by animation system when overshoot has finished animating to maximum (either -1.0f or 1.0f)
    *
    * @param[in] animation the animation that has finished
@@ -525,6 +535,12 @@ private:
    */
   void OnRefreshNotification(PropertyNotification& source);
 
+  /**
+   * This is called when scroll position has been changed by ScrollConnector::SetScrollPosition.
+   * @param[in] position The new scroll position
+   */
+  void OnScrollPositionChanged( float position );
+
 private:
 
   ItemFactory& mItemFactory;
@@ -539,11 +555,8 @@ private:
   ItemLayout* mActiveLayout;
   Vector3 mActiveLayoutTargetSize;
 
-  AlphaFunction mDefaultAlphaFunction;
-
   Animation mResizeAnimation;
   Animation mScrollAnimation;
-  Animation mScrollSpeedAnimation;
   Animation mScrollOvershootAnimation;
   bool      mAnimatingOvershootOn;          ///< whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
   bool      mAnimateOvershootOff;         ///< whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
@@ -572,8 +585,7 @@ private:
 
   Dali::Gesture::State mGestureState;
 
-  ImageActor mOvershootOverlay;           ///< The overlay actor for overshoot effect
-  BouncingEffect mOvershootEffect; ///< The vertex/fragment shader used to display the overshoot ripple effect
+  Actor mOvershootOverlay;           ///< The overlay actor for overshoot effect
 
   Dali::Toolkit::ScrollConnector mScrollConnector; ///< Connects ItemView with scrollable components e.g. scroll bars
   Constrainable   mScrollPositionObject;     ///< From mScrollConnector