1 #ifndef __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__
2 #define __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/adaptor-framework/timer.h>
23 #include <dali/public-api/animation/animation.h>
24 #include <dali/public-api/object/property-notification.h>
25 #include <dali/devel-api/common/map-wrapper.h>
28 #include <dali-toolkit/public-api/controls/control-impl.h>
29 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view.h>
30 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h>
31 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
32 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
45 typedef IntrusivePtr<ItemView> ItemViewPtr;
48 * ItemView is a scrollable layout container.
49 * Multiple ItemLayouts may be provided, to determine the logical position of each item a layout.
50 * Actor-ID pairs are provided from a shared ItemFactory, to display the currently visible items.
52 class ItemView : public Scrollable
57 typedef Toolkit::ItemView::LayoutActivatedSignalType LayoutActivatedSignalType;
62 * Create a new ItemView.
63 * @param[in] factory The factory which provides ItemView with items.
64 * @return A public handle to the newly allocated ItemView.
66 static Dali::Toolkit::ItemView New(ItemFactory& factory);
69 * @copydoc Toolkit::ItemView::GetLayoutCount
71 unsigned int GetLayoutCount() const;
74 * @copydoc Toolkit::ItemView::AddLayout
76 void AddLayout(ItemLayout& layout);
79 * @copydoc Toolkit::ItemView::RemoveLayout
81 void RemoveLayout(unsigned int layoutIndex);
84 * @copydoc Toolkit::ItemView::GetLayout
86 ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
89 * @copydoc Toolkit::ItemView::GetActiveLayout
91 ItemLayoutPtr GetActiveLayout() const;
94 * @copydoc Toolkit::ItemView::GetCurrentLayoutPosition
96 float GetCurrentLayoutPosition(unsigned int itemId) const;
99 * @copydoc Toolkit::ItemView::ActivateLayout
101 void ActivateLayout(unsigned int layoutIndex, const Vector3& targetSize, float durationSeconds);
104 * @copydoc Toolkit::ItemView::DeactivateCurrentLayout
106 void DeactivateCurrentLayout();
109 * @copydoc Toolkit::ItemView::SetMinimumSwipeSpeed
111 void SetMinimumSwipeSpeed(float speed);
114 * @copydoc Toolkit::ItemView::GetMinimumSwipeSpeed
116 float GetMinimumSwipeSpeed() const;
119 * @copydoc Toolkit::ItemView::SetMinimumSwipeDistance
121 void SetMinimumSwipeDistance(float distance);
124 * @copydoc Toolkit::ItemView::GetMinimumSwipeDistance
126 float GetMinimumSwipeDistance() const;
129 * @copydoc Toolkit::ItemView::SetWheelScrollDistanceStep
131 void SetWheelScrollDistanceStep(float step);
134 * @copydoc Toolkit::ItemView::GetWheelScrollDistanceStep
136 float GetWheelScrollDistanceStep() const;
139 * @copydoc Toolkit::ItemView::SetAnchoring
141 void SetAnchoring(bool enabled);
144 * @copydoc Toolkit::ItemView::GetAnchoring
146 bool GetAnchoring() const;
149 * @copydoc Toolkit::ItemView::SetAnchoringDuration
151 void SetAnchoringDuration(float durationSeconds);
154 * @copydoc Toolkit::ItemView::GetAnchoringDuration
156 float GetAnchoringDuration() const;
159 * @copydoc Toolkit::ItemView::ScrollToItem
161 void ScrollToItem(unsigned int itemId, float durationSeconds);
164 * @copydoc Toolkit::ItemView::SetRefreshInterval
166 void SetRefreshInterval(float intervalLayoutPositions);
169 * @copydoc Toolkit::ItemView::GetRefreshInterval
171 float GetRefreshInterval() const;
174 * @copydoc Toolkit::ItemView::Refresh
179 * @copydoc Toolkit::ItemView::GetItem
181 Actor GetItem(unsigned int itemId) const;
184 * @copydoc Toolkit::ItemView::GetItemId
186 unsigned int GetItemId(Actor actor) const;
189 * @copydoc Toolkit::ItemView::InsertItem
191 void InsertItem(Item newItem, float durationSeconds);
194 * @copydoc Toolkit::ItemView::InsertItem
196 void InsertItems(const ItemContainer& newItems, float durationSeconds);
199 * @copydoc Toolkit::ItemView::RemoveItem
201 void RemoveItem(ItemId itemId, float durationSeconds);
204 * @copydoc Toolkit::ItemView::InsertItem
206 void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
209 * @copydoc Toolkit::ItemView::InsertItem
211 void ReplaceItem(Item replacementItem, float durationSeconds);
214 * @copydoc Toolkit::ItemView::InsertItem
216 void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
219 * @copydoc Toolkit::Scrollable::GetCurrentScrollPosition
221 Vector2 GetCurrentScrollPosition() const;
224 * @copydoc Toolkit::Scrollable::AddOverlay()
226 void AddOverlay(Actor actor);
229 * @copydoc Toolkit::Scrollable::RemoveOverlay()
231 void RemoveOverlay(Actor actor);
234 * @copydoc Toolkit::Scrollable::ScrollTo(const Vector2& position, float duration)
236 void ScrollTo(const Vector2& position, float duration);
239 * @copydoc Toolkit::Internal::Scrollable::SetOvershootEffectColor
241 void SetOvershootEffectColor( const Vector4& color );
244 * @brief Set whether to enable automatic refresh or not. When refresh is disabled,
245 * ItemView will not automatically refresh the cache in the given interval when the
246 * layout position is changed. This is useful in some cases, for example, automatic
247 * refresh is not needed during fast scrolling, otherwise it will cache unneeded
248 * items when the layout position changes quickly.
250 * @param[in] enabled True to enable automatic refresh or false to disable it.
252 void SetRefreshEnabled(bool enabled);
255 * @brief Helper to perform the refresh.
257 * @param[in] currentLayoutPosition The current layout position.
258 * @param[in] cacheExtra Whether to cache extra items during refresh.
260 void DoRefresh(float currentLayoutPosition, bool cacheExtra);
263 * @copydoc Toolkit::ItemView::SetItemsParentOrigin
265 void SetItemsParentOrigin( const Vector3& parentOrigin );
268 * @copydoc Toolkit::ItemView::GetItemsParentOrigin
270 Vector3 GetItemsParentOrigin() const;
273 * @copydoc Toolkit::ItemView::SetItemsAnchorPoint
275 void SetItemsAnchorPoint( const Vector3& anchorPoint );
278 * @copydoc Toolkit::ItemView::GetItemsAnchorPoint
280 Vector3 GetItemsAnchorPoint() const;
283 * @copydoc Toolkit::ItemView::GetItemsRange
285 void GetItemsRange(ItemRange& range);
288 * @copydoc Toolkit::ItemView::LayoutActivatedSignal()
290 LayoutActivatedSignalType& LayoutActivatedSignal()
292 return mLayoutActivatedSignal;
296 * Connects a callback function with the object's signals.
297 * @param[in] object The object providing the signal.
298 * @param[in] tracker Used to disconnect the signal.
299 * @param[in] signalName The signal to connect to.
300 * @param[in] functor A newly allocated FunctorDelegate.
301 * @return True if the signal was connected.
302 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
304 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
309 * Called when a property of an object of this type is set.
310 * @param[in] object The object whose property is set.
311 * @param[in] index The property index.
312 * @param[in] value The new property value.
314 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
317 * Called to retrieve a property of an object of this type.
318 * @param[in] object The object whose property is to be retrieved.
319 * @param[in] index The property index.
320 * @return The current value of the property.
322 static Property::Value GetProperty( BaseObject* object, Property::Index index );
325 * Performs actions as requested using the action name.
326 * @param[in] object The object on which to perform the action.
327 * @param[in] actionName The action to perform.
328 * @param[in] attributes The attributes with which to perfrom this action.
329 * @return true if action has been accepted by this control
331 static bool DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes );
334 * Helper for DoAction( ACTION_STOP_SCROLLING ).
336 void DoStopScrolling();
339 * Helper for DoAction( ACTION_ENABLE/DISABLE_REFRESH_NOTIFICATIONS ).
340 * @param[in] enabled Whether to disable refresh notifications or not.
342 void SetRefreshNotificationEnabled( bool enabled );
347 * Remove an Actor if found in the ItemPool.
348 * @param[in] itemId The item to remove.
349 * @return True if the remaining actors were reordered.
351 bool RemoveActor( unsigned int itemId );
354 * Remove any Actors outside a given range.
355 * @param[in] @param[in] range The range of required items.
357 void RemoveActorsOutsideRange( ItemRange range );
360 * Add a range of Actors, if they are not already in the ItemPool.
361 * @param[in] range The range of Item IDs to associate with the new actors.
362 * @param[in] layoutSize The layout-size.
364 void AddActorsWithinRange( ItemRange range, const Vector3& layoutSize );
367 * Add a new Actor, if not already in the ItemPool.
368 * @param[in] item The ID for the new item.
369 * @param[in] layoutSize The layout-size.
371 void AddNewActor( ItemId item, const Vector3& layoutSize );
374 * Apply the constraints etc. that are required for ItemView children.
375 * @param[in] item The item to setup.
376 * @param[in] layoutSize The layout-size.
378 void SetupActor( Item item, const Vector3& layoutSize );
381 * Remove the Actor from the ItemPool and notify the ItemFactory the actor has been released by ItemView.
382 * @param[in] item The ID for the item to be released.
383 * @param[in] actor The actor to be removed from ItemView.
385 void ReleaseActor( ItemId item, Actor actor );
387 private: // From CustomActorImpl
390 * From CustomActorImpl; called after a child has been added to the owning actor.
391 * @param[in] child The child which has been added.
393 virtual void OnChildAdd(Actor& child);
396 * From CustomActorImpl; called after a wheel-event is received by the owning actor.
397 * @param[in] event The wheel event.
398 * @return True if the event should be consumed.
400 virtual bool OnWheelEvent(const WheelEvent& event);
402 private: // From Control
405 * @copydoc Toolkit::Control::OnInitialize()
407 virtual void OnInitialize();
410 * @copydoc Toolkit::Control::OnAccessibilityPan()
412 virtual bool OnAccessibilityPan(PanGesture gesture);
415 * @copydoc Toolkit::Control::GetNextKeyboardFocusableActor()
417 virtual Actor GetNextKeyboardFocusableActor(Actor actor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled);
420 * @copydoc Toolkit::Control::OnKeyboardFocusChangeCommitted()
422 virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
427 * Construct a new ItemView.
428 * @param[in] factory The factory which provides ItemView with items.
430 ItemView(ItemFactory& factory);
433 * A reference counted object may only be deleted by calling Unreference()
440 ItemView(const ItemView&);
443 ItemView& operator=(const ItemView& rhs);
446 * Helper to re-apply all the constraints after items have been inserted, removed etc.
447 * @param[in] durationSeconds The time taken to fully constrain the actors.
449 void ReapplyAllConstraints();
452 * Helper to relayout after item(s) are removed.
454 void OnItemsRemoved();
457 * Helper to remove items outside a given range.
458 * @param[in] range The range of required items.
460 void RemoveItems(ItemRange range);
463 * Helper to add a range of items, if not already in the ItemPool.
464 * @param[in] layout The layout used to position the new items.
465 * @param[in] layoutSize The current size of the layout.
466 * @param[in] range The range of required items.
468 void AddItems(ItemLayout& layout, const Vector3& layoutSize, ItemRange range);
471 * Helper to find the range of items to populate with.
472 * @param[in] layout The current layout.
473 * @param[in] range The range of items.
474 * @param[in] reserveExtra True if reserve items should be included.
476 ItemRange GetItemRange(ItemLayout& layout, const Vector3& layoutSize, float layoutPosition, bool reserveExtra);
481 * Helper to clamp the first-item position when dragging/swiping.
482 * @param[in] targetPosition The target position of the drag etc.
483 * @param[in] targetSize The target ItemView & layout size.
484 * @param[in] layout The current layout.
485 * @param[in] updateOvershoot False stops the current overshoot value from being clamped also.
486 * @return The clamped first-item position.
488 float ClampFirstItemPosition(float targetPosition, const Vector3& targetSize, ItemLayout& layout, bool updateOvershoot = true);
491 * Called after a touch-signal is received by the owning actor.
492 * @param[in] actor The touched actor.
493 * @param[in] touch The touch information.
494 * @return True if the event should be consumed.
496 bool OnTouch( Actor actor, const TouchData& touch );
499 * Called upon pan gesture event.
501 * @param[in] gesture The gesture event.
503 void OnPan( const PanGesture& pan );
506 * Helper to handle anchoring animations.
507 * @return The animation, or an uninitialized handle if not necessary.
509 Animation DoAnchoring();
512 * Callback from scroll animations
513 * @param[in] animation The scroll-animation which has finished.
515 void OnScrollFinished(Animation& animation);
518 * Callback from layout activation scroll animations
519 * @param[in] animation The scroll-animation which has finished.
521 void OnLayoutActivationScrollFinished(Animation& animation);
524 * Called by animation system when overshoot has finished animating to maximum (either -1.0f or 1.0f)
526 * @param[in] animation the animation that has finished
528 void OnOvershootOnFinished(Animation& animation);
531 * This is called after a timeout when no new wheel event is received for a certain period of time.
532 * @return will return false; one-shot timer.
534 bool OnWheelEventFinished();
537 * Stops and removes animation if exists.
538 * @param[in,out] animation The animation handle to be removed.
540 void RemoveAnimation(Animation& animation);
543 * @copydoc Toolkit::Internal::Scrollable::EnableScrollOvershoot
545 virtual void EnableScrollOvershoot( bool enable );
548 * Helper to calculate the scroll overshoot according to the pan gesture displacement.
549 * @return The scroll overshoot.
551 float CalculateScrollOvershoot();
554 * Helper to calculate the scroll overshoot according to the pan gesture displacement.
556 * @param[in] overshootAmount amount to animate to
557 * @param[in] animateBack whether to animate back to zero immediately after
558 * @return The scroll overshoot.
560 void AnimateScrollOvershoot(float overshootAmount, bool animateBack = false);
563 * Gets the scroll position in pixels according to the logical layout position.
564 * @param[in] layoutSize The current size of the layout.
566 float GetScrollPosition(float layoutPosition, const Vector3& layoutSize) const;
569 * Calculates the minimum and maximum positions for each axis to scroll to.
570 * @param[in] layoutSize The current size of the layout.
572 void CalculateDomainSize(const Vector3& layoutSize);
575 * Calculates whether we want to allow current item view to scroll.
576 * @param[in] layoutSize The current size of the layout.
577 * @return true if itemview is scrollable
579 bool IsLayoutScrollable(const Vector3& layoutSize);
582 * Callback when the current layout position of ItemView changes in both positive
583 * and negative directions by the specified amount. Refresh the ItemView to create
584 * newly visible items.
585 * @param[in] source the property notification that triggered this callback
587 void OnRefreshNotification(PropertyNotification& source);
591 typedef std::map<unsigned int, Actor> ItemPool;
592 typedef ItemPool::iterator ItemPoolIter;
593 typedef ItemPool::const_iterator ConstItemPoolIter;
596 ItemFactory& mItemFactory;
597 std::vector< ItemLayoutPtr > mLayouts; ///< Container of Dali::Toolkit::ItemLayout objects
598 Actor mOvershootOverlay; ///< The overlay actor for overshoot effect
599 Animation mResizeAnimation;
600 Animation mScrollAnimation;
601 Animation mScrollOvershootAnimation;
602 Timer mWheelEventFinishedTimer; ///< The timer to determine whether there is no wheel event received for a certain period of time.
603 PropertyNotification mRefreshNotification; ///< Stores the property notification used for item view refresh
604 LayoutActivatedSignalType mLayoutActivatedSignal;
605 Vector3 mActiveLayoutTargetSize;
606 Vector3 mItemsParentOrigin;
607 Vector3 mItemsAnchorPoint;
608 Vector2 mTotalPanDisplacement;
609 ItemLayout* mActiveLayout;
611 float mAnchoringDuration;
612 float mRefreshIntervalLayoutPositions; ///< Refresh item view when the layout position changes by this interval in both positive and negative directions.
613 float mMinimumSwipeSpeed;
614 float mMinimumSwipeDistance;
615 float mWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates for each wheel event received.
616 float mScrollDistance;
618 float mScrollOvershoot;
620 Dali::Gesture::State mGestureState : 3;
621 bool mAnimatingOvershootOn : 1; ///< Whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
622 bool mAnimateOvershootOff : 1; ///< Whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
623 bool mAnchoringEnabled : 1;
624 bool mRefreshOrderHint : 1; ///< True if scrolling towards the last item
625 bool mIsFlicking : 1;
626 bool mAddingItems : 1;
627 bool mRefreshEnabled : 1; ///< Whether to refresh the cache automatically
628 bool mRefreshNotificationEnabled : 1; ///< Whether to disable refresh notifications or not.
629 bool mInAnimation : 1; ///< Keeps track of whether an animation is controlling the overshoot property.
632 } // namespace Internal
634 // Helpers for public-api forwarding methods
636 inline Toolkit::Internal::ItemView& GetImpl(Toolkit::ItemView& itemView)
638 DALI_ASSERT_ALWAYS(itemView);
640 Dali::RefObject& handle = itemView.GetImplementation();
642 return static_cast<Toolkit::Internal::ItemView&>(handle);
645 inline const Toolkit::Internal::ItemView& GetImpl(const Toolkit::ItemView& itemView)
647 DALI_ASSERT_ALWAYS(itemView);
649 const Dali::RefObject& handle = itemView.GetImplementation();
651 return static_cast<const Toolkit::Internal::ItemView&>(handle);
654 } // namespace Toolkit
658 #endif // __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__