X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=dali-toolkit%2Finternal%2Fcontrols%2Fscrollable%2Fitem-view%2Fitem-view-impl.h;h=9fc58aa3fb31ea7f1bc297252885592c6057f2ab;hb=445245be5ed13b969aaa0bd87647f3386f24d3eb;hp=f92894ede81ab7b0458333df8bbd4a8f0242041c;hpb=ae1982a116aae1d8e25837fa553ba2e37bc062a7;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h b/dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h index f92894e..9fc58aa 100644 --- a/dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h +++ b/dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h @@ -1,34 +1,35 @@ #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 -#include +#include +#include +#include +#include // INTERNAL INCLUDES #include #include #include -#include #include #include -#include namespace Dali { @@ -52,6 +53,11 @@ class ItemView : public Scrollable { public: + // Signals + typedef Toolkit::ItemView::LayoutActivatedSignalType LayoutActivatedSignalType; + +public: + /** * Create a new ItemView. * @param[in] factory The factory which provides ItemView with items. @@ -60,11 +66,6 @@ public: static Dali::Toolkit::ItemView New(ItemFactory& factory); /** - * @copydoc Toolkit::ItemView::GetScrollConnector - */ - Dali::Toolkit::ScrollConnector GetScrollConnector() const; - - /** * @copydoc Toolkit::ItemView::GetLayoutCount */ unsigned int GetLayoutCount() const; @@ -125,14 +126,14 @@ public: float GetMinimumSwipeDistance() const; /** - * @copydoc Toolkit::ItemView::SetMouseWheelScrollDistanceStep + * @copydoc Toolkit::ItemView::SetWheelScrollDistanceStep */ - void SetMouseWheelScrollDistanceStep(float step); + void SetWheelScrollDistanceStep(float step); /** - * @copydoc Toolkit::ItemView::GetMouseWheelScrollDistanceStep + * @copydoc Toolkit::ItemView::GetWheelScrollDistanceStep */ - float GetMouseWheelScrollDistanceStep() const; + float GetWheelScrollDistanceStep() const; /** * @copydoc Toolkit::ItemView::SetAnchoring @@ -162,12 +163,17 @@ 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::Refresh + */ + void Refresh(); /** * @copydoc Toolkit::ItemView::GetItem @@ -212,12 +218,12 @@ public: /** * @copydoc Toolkit::Scrollable::GetDomainSize */ - Vector3 GetDomainSize() const; + Vector2 GetDomainSize() const; /** * @copydoc Toolkit::Scrollable::GetCurrentScrollPosition */ - Vector3 GetCurrentScrollPosition() const; + Vector2 GetCurrentScrollPosition() const; /** * @copydoc Toolkit::Scrollable::AddOverlay() @@ -230,16 +236,84 @@ public: void RemoveOverlay(Actor actor); /** - * @copydoc Toolkit::Scrollable::ScrollTo(const Vector3& position, float duration) + * @copydoc Toolkit::Scrollable::ScrollTo(const Vector2& position, float duration) */ - void ScrollTo(const Vector3& position, float duration); + void ScrollTo(const Vector2& 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 + * 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); + + /** + * @copydoc Toolkit::ItemView::SetItemsParentOrigin + */ + void SetItemsParentOrigin( const Vector3& parentOrigin ); + + /** + * @copydoc Toolkit::ItemView::GetItemsParentOrigin + */ + Vector3 GetItemsParentOrigin() const; + + /** + * @copydoc Toolkit::ItemView::SetItemsAnchorPoint + */ + void SetItemsAnchorPoint( const Vector3& anchorPoint ); + + /** + * @copydoc Toolkit::ItemView::GetItemsAnchorPoint + */ + Vector3 GetItemsAnchorPoint() const; + + /** + * @copydoc Toolkit::ItemView::GetItemsRange + */ + void GetItemsRange(ItemRange& range); + + /** + * @copydoc Toolkit::ItemView::LayoutActivatedSignal() + */ + LayoutActivatedSignalType& LayoutActivatedSignal() + { + return mLayoutActivatedSignal; + } + + /** + * Connects a callback function with the object's signals. + * @param[in] object The object providing the signal. + * @param[in] tracker Used to disconnect the signal. + * @param[in] signalName The signal to connect to. + * @param[in] functor A newly allocated FunctorDelegate. + * @return True if the signal was connected. + * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor. + */ + static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor ); 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 ); @@ -251,27 +325,41 @@ 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] layoutSize The layout-size. */ - void AddActorsWithinRange( ItemRange range ); + void AddActorsWithinRange( ItemRange range, const Vector3& layoutSize ); /** * Add a new Actor, if not already in the ItemPool. * @param[in] item The ID for the new item. + * @param[in] layoutSize The layout-size. */ - void AddNewActor( ItemId item ); + void AddNewActor( ItemId item, const Vector3& layoutSize ); /** * Apply the constraints etc. that are required for ItemView children. * @param[in] item The item to setup. - * @param[in] durationSeconds The time taken to fully constrain the actor. + * @param[in] layoutSize The layout-size. */ - void SetupActor( Item item, float durationSeconds ); + void SetupActor( Item item, const Vector3& layoutSize ); + + /** + * 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 /** + * 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. @@ -279,13 +367,13 @@ private: // From CustomActorImpl virtual bool OnTouchEvent(const TouchEvent& event); /** - * From CustomActorImpl; called after a mouse-wheel-event is received by the owning actor. - * @param[in] event The mouse wheel event. + * From CustomActorImpl; called after a wheel-event is received by the owning actor. + * @param[in] event The wheel event. * @return True if the event should be consumed. */ - virtual bool OnMouseWheelEvent(const MouseWheelEvent& event); + virtual bool OnWheelEvent(const WheelEvent& event); -private: // From ControlImpl +private: // From Control /** * @copydoc Toolkit::Control::OnInitialize() @@ -300,7 +388,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::KeyboardFocus::Direction direction, bool loopEnabled); /** * @copydoc Toolkit::Control::OnKeyboardFocusChangeCommitted() @@ -329,19 +417,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(); /** - * 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. @@ -363,7 +447,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 @@ -389,7 +473,7 @@ private: * * @param[in] gesture The gesture event. */ - void OnPan(PanGesture pan); + void OnPan( const PanGesture& pan ); /** * Helper to handle anchoring animations. @@ -404,6 +488,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 @@ -411,27 +501,10 @@ 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. + * This is called after a timeout when no new wheel event is received for a certain period of time. * @return will return false; one-shot timer. */ - bool OnMouseWheelEventFinished(); + bool OnWheelEventFinished(); /** * Stops and removes animation if exists. @@ -440,9 +513,9 @@ private: void RemoveAnimation(Animation& animation); /** - * Helper to apply constraints to the overshoot overlay actor. + * @copydoc Toolkit::Internal::Scrollable::EnableScrollOvershoot */ - void ApplyOvershootOverlayConstraints(); + virtual void EnableScrollOvershoot( bool enable ); /** * Helper to calculate the scroll overshoot according to the pan gesture displacement. @@ -478,6 +551,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; @@ -488,13 +569,12 @@ private: ItemPool mItemPool; - ItemLayoutContainer mLayouts; + std::vector< ItemLayoutPtr > mLayouts; ///< Container of Dali::Toolkit::ItemLayout objects ItemLayout* mActiveLayout; Vector3 mActiveLayoutTargetSize; 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) @@ -502,15 +582,15 @@ 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 float mMinimumSwipeSpeed; float mMinimumSwipeDistance; - float mMouseWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates for each mouse wheel event received. + float mWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates for each wheel event received. float mScrollDistance; float mScrollSpeed; @@ -519,20 +599,20 @@ private: float mScrollOvershoot; bool mIsFlicking; - Timer mMouseWheelEventFinishedTimer; ///< The timer to determine whether there is no mouse wheel event received for a certain period of time. + Timer mWheelEventFinishedTimer; ///< The timer to determine whether there is no wheel event received for a certain period of time. Dali::Gesture::State mGestureState; - ImageActor mOvershootOverlay; ///< The overlay actor for overshoot effect - OvershootRippleEffect mOvershootEffect; ///< The vertex/fragment shader used to display the overshoot ripple effect + Actor mOvershootOverlay; ///< The overlay actor for overshoot effect + + bool mAddingItems; + + bool mRefreshEnabled; ///< Whether to refresh the cache automatically - Dali::Toolkit::ScrollConnector mScrollConnector; ///< Connects ItemView with scrollable components e.g. scroll bars - Constrainable mScrollPositionObject; ///< From mScrollConnector + Vector3 mItemsParentOrigin; + Vector3 mItemsAnchorPoint; - 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) + LayoutActivatedSignalType mLayoutActivatedSignal; }; } // namespace Internal