X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Fscrollable%2Fitem-view%2Fitem-view-impl.h;h=b388e22e82c8b0a9b5db58f19bce3042a38a647d;hp=b6a2d963af107aca02683913fe0ce39eeeac53ee;hb=36b6c48b03fa926529904947f222aadebbf0c1ff;hpb=a7646628bf0d87a7f9e02d8f4db52dea881579c7 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 b6a2d96..b388e22 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,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__ -#define __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__ +#ifndef DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H +#define DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 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. @@ -21,25 +21,24 @@ // EXTERNAL INCLUDES #include #include +#include +#include #include -#include // INTERNAL INCLUDES +#include #include -#include +#include #include -#include +#include #include namespace Dali { - namespace Toolkit { - namespace Internal { - class ItemView; typedef IntrusivePtr ItemViewPtr; @@ -52,12 +51,10 @@ typedef IntrusivePtr ItemViewPtr; 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. @@ -216,11 +213,6 @@ public: void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds); /** - * @copydoc Toolkit::Scrollable::GetDomainSize - */ - Vector2 GetDomainSize() const; - - /** * @copydoc Toolkit::Scrollable::GetCurrentScrollPosition */ Vector2 GetCurrentScrollPosition() const; @@ -241,9 +233,14 @@ public: void ScrollTo(const Vector2& position, float duration); /** + * @copydoc Toolkit::Internal::Scrollable::SetOvershootSize + */ + void SetOvershootSize(const Vector2& size); + + /** * @copydoc Toolkit::Internal::Scrollable::SetOvershootEffectColor */ - void SetOvershootEffectColor( const Vector4& color ); + void SetOvershootEffectColor(const Vector4& color); /** * @brief Set whether to enable automatic refresh or not. When refresh is disabled, @@ -267,7 +264,7 @@ public: /** * @copydoc Toolkit::ItemView::SetItemsParentOrigin */ - void SetItemsParentOrigin( const Vector3& parentOrigin ); + void SetItemsParentOrigin(const Vector3& parentOrigin); /** * @copydoc Toolkit::ItemView::GetItemsParentOrigin @@ -277,7 +274,7 @@ public: /** * @copydoc Toolkit::ItemView::SetItemsAnchorPoint */ - void SetItemsAnchorPoint( const Vector3& anchorPoint ); + void SetItemsAnchorPoint(const Vector3& anchorPoint); /** * @copydoc Toolkit::ItemView::GetItemsAnchorPoint @@ -306,96 +303,152 @@ public: * @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 ); + static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor); + + //properties + + /** + * Called when a property of an object of this type is set. + * @param[in] object The object whose property is set. + * @param[in] index The property index. + * @param[in] value The new property value. + */ + static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value); + + /** + * Called to retrieve a property of an object of this type. + * @param[in] object The object whose property is to be retrieved. + * @param[in] index The property index. + * @return The current value of the property. + */ + static Property::Value GetProperty(BaseObject* object, Property::Index index); + + /** + * Performs actions as requested using the action name. + * @param[in] object The object on which to perform the action. + * @param[in] actionName The action to perform. + * @param[in] attributes The attributes with which to perfrom this action. + * @return true if action has been accepted by this control + */ + static bool DoAction(BaseObject* object, const std::string& actionName, const Property::Map& attributes); + + /** + * Helper for DoAction( ACTION_STOP_SCROLLING ). + */ + void DoStopScrolling(); + + /** + * Helper for DoAction( ACTION_ENABLE/DISABLE_REFRESH_NOTIFICATIONS ). + * @param[in] enabled Whether to disable refresh notifications or not. + */ + void SetRefreshNotificationEnabled(bool enabled); private: + /** + * Get all the layouts used in the ItemView. + * @return The layout array + */ + Property::Array GetLayoutArray(); + + /** + * Set all the layouts. that will be used in the ItemView. + * @param[in] layouts The layouts used in the itemView. + */ + void SetLayoutArray(const Property::Array& layouts); /** * Remove an Actor if found in the ItemPool. * @param[in] itemId The item to remove. * @return True if the remaining actors were reordered. */ - bool RemoveActor( unsigned int itemId ); + bool RemoveActor(unsigned int itemId); /** * Remove any Actors outside a given range. * @param[in] @param[in] range The range of required items. */ - void RemoveActorsOutsideRange( ItemRange range ); + void RemoveActorsOutsideRange(ItemRange range); /** * Add a range of Actors, if they are not already in the ItemPool. * @param[in] range The range of Item IDs to associate with the new actors. * @param[in] layoutSize The layout-size. */ - void AddActorsWithinRange( ItemRange range, const Vector3& layoutSize ); + 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, const Vector3& layoutSize ); + 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] layoutSize The layout-size. */ - void SetupActor( Item item, const Vector3& layoutSize ); + 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 ); + 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); + void OnChildAdd(Actor& child) override; /** - * 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. - */ - virtual bool OnTouchEvent(const TouchEvent& event); - - /** - * From CustomActorImpl; called after a wheel-event is received by the owning actor. + * Called after a wheel-event is received by the owning actor. + * @param[in] actor Actor associated with the wheel event. * @param[in] event The wheel event. * @return True if the event should be consumed. */ - virtual bool OnWheelEvent(const WheelEvent& event); + bool OnWheelEvent(Actor actor, const WheelEvent& event); private: // From Control - /** * @copydoc Toolkit::Control::OnInitialize() */ - virtual void OnInitialize(); + void OnInitialize() override; + + /** + * @copydoc Toolkit::Internal::Control::CreateAccessibleObject() + */ + DevelControl::ControlAccessible* CreateAccessibleObject() override; /** * @copydoc Toolkit::Control::OnAccessibilityPan() */ - virtual bool OnAccessibilityPan(PanGesture gesture); + bool OnAccessibilityPan(PanGesture gesture) override; /** * @copydoc Toolkit::Control::GetNextKeyboardFocusableActor() */ - virtual Actor GetNextKeyboardFocusableActor(Actor actor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled); + Actor GetNextKeyboardFocusableActor(Actor actor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled) override; /** * @copydoc Toolkit::Control::OnKeyboardFocusChangeCommitted() */ - virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor); + void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor) override; protected: + class ItemViewAccessible : public Scrollable::ScrollableAccessible + { + public: + using Scrollable::ScrollableAccessible::ScrollableAccessible; + + /** + * @copydoc Dali::Toolkit::DevelControl::ControlAccessible::ScrollToChild() + */ + bool ScrollToChild(Actor child) override; + }; /** * Construct a new ItemView. @@ -409,7 +462,6 @@ protected: virtual ~ItemView(); private: - // Undefined ItemView(const ItemView&); @@ -452,28 +504,29 @@ private: // Input Handling /** - * Helper to handle pressed (Down) events. - * @param[in] x The X coordinate of the touch event. - * @param[in] y The Y coordinate of the touch event. - * @param[in] timeMs The time-stamp of the touch event. - */ - void OnPressed(float x, float y, unsigned long timeMs); - - /** * Helper to clamp the first-item position when dragging/swiping. * @param[in] targetPosition The target position of the drag etc. * @param[in] targetSize The target ItemView & layout size. * @param[in] layout The current layout. + * @param[in] updateOvershoot False stops the current overshoot value from being clamped also. * @return The clamped first-item position. */ - float ClampFirstItemPosition(float targetPosition, const Vector3& targetSize, ItemLayout& layout); + float ClampFirstItemPosition(float targetPosition, const Vector3& targetSize, ItemLayout& layout, bool updateOvershoot = true); + + /** + * Called after a touch-signal is received by the owning actor. + * @param[in] actor The touched actor. + * @param[in] touch The touch information. + * @return True if the event should be consumed. + */ + bool OnTouch(Actor actor, const TouchEvent& touch); /** * Called upon pan gesture event. * * @param[in] gesture The gesture event. */ - void OnPan( const PanGesture& pan ); + void OnPan(const PanGesture& pan); /** * Helper to handle anchoring animations. @@ -515,7 +568,7 @@ private: /** * @copydoc Toolkit::Internal::Scrollable::EnableScrollOvershoot */ - virtual void EnableScrollOvershoot( bool enable ); + void EnableScrollOvershoot(bool enable) override; /** * Helper to calculate the scroll overshoot according to the pan gesture displacement. @@ -559,66 +612,44 @@ private: */ void OnRefreshNotification(PropertyNotification& source); - /** - * This is called when the change of scroll position is notified by ScrollBar. - * @param[in] position The new scroll position - */ - void OnScrollPositionChanged( float position ); - private: + Property::Array mlayoutArray; + + ItemContainer mItemPool; + ItemFactory& mItemFactory; + std::vector mLayouts; ///< Container of Dali::Toolkit::ItemLayout objects + Actor mOvershootOverlay; ///< The overlay actor for overshoot effect + Animation mResizeAnimation; + Animation mScrollAnimation; + Animation mScrollOvershootAnimation; + Timer mWheelEventFinishedTimer; ///< The timer to determine whether there is no wheel event received for a certain period of time. + PropertyNotification mRefreshNotification; ///< Stores the property notification used for item view refresh + LayoutActivatedSignalType mLayoutActivatedSignal; + Vector3 mActiveLayoutTargetSize; + Vector3 mItemsParentOrigin; + Vector3 mItemsAnchorPoint; + Vector2 mTotalPanDisplacement; + ItemLayout* mActiveLayout; - ItemFactory& mItemFactory; - - typedef std::map ItemPool; - typedef ItemPool::iterator ItemPoolIter; - typedef ItemPool::const_iterator ConstItemPoolIter; - - ItemPool mItemPool; - - std::vector< ItemLayoutPtr > mLayouts; ///< Container of Dali::Toolkit::ItemLayout objects - ItemLayout* mActiveLayout; - Vector3 mActiveLayoutTargetSize; - - Animation mResizeAnimation; - Animation mScrollAnimation; - 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) - - bool mAnchoringEnabled; float mAnchoringDuration; - - 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 mRefreshIntervalLayoutPositions; ///< Refresh item view when the layout position changes by this interval in both positive and negative directions. float mMinimumSwipeSpeed; float mMinimumSwipeDistance; float mWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates for each wheel event received. - float mScrollDistance; float mScrollSpeed; - Vector2 mTotalPanDisplacement; - float mScrollOvershoot; - bool mIsFlicking; - - Timer mWheelEventFinishedTimer; ///< The timer to determine whether there is no wheel event received for a certain period of time. - - Dali::Gesture::State mGestureState; - - Actor mOvershootOverlay; ///< The overlay actor for overshoot effect - - bool mAddingItems; - - bool mRefreshEnabled; ///< Whether to refresh the cache automatically - - Vector3 mItemsParentOrigin; - Vector3 mItemsAnchorPoint; - LayoutActivatedSignalType mLayoutActivatedSignal; + GestureState mGestureState : 8; + bool mAnimatingOvershootOn : 1; ///< Whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off) + bool mAnimateOvershootOff : 1; ///< Whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off) + bool mAnchoringEnabled : 1; + bool mRefreshOrderHint : 1; ///< True if scrolling towards the last item + bool mIsFlicking : 1; + bool mAddingItems : 1; + bool mRefreshEnabled : 1; ///< Whether to refresh the cache automatically + bool mRefreshNotificationEnabled : 1; ///< Whether to disable refresh notifications or not. + bool mInAnimation : 1; ///< Keeps track of whether an animation is controlling the overshoot property. }; } // namespace Internal @@ -647,4 +678,4 @@ inline const Toolkit::Internal::ItemView& GetImpl(const Toolkit::ItemView& itemV } // namespace Dali -#endif // __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__ +#endif // DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H