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>
26 #include <dali/public-api/object/property-map.h>
27 #include <dali/public-api/object/property-array.h>
30 #include <dali-toolkit/public-api/controls/control-impl.h>
31 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view.h>
32 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h>
33 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
34 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
35 #include <dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h>
48 typedef IntrusivePtr<ItemView> ItemViewPtr;
51 * ItemView is a scrollable layout container.
52 * Multiple ItemLayouts may be provided, to determine the logical position of each item a layout.
53 * Actor-ID pairs are provided from a shared ItemFactory, to display the currently visible items.
55 class ItemView : public Scrollable
60 typedef Toolkit::ItemView::LayoutActivatedSignalType LayoutActivatedSignalType;
65 * Create a new ItemView.
66 * @param[in] factory The factory which provides ItemView with items.
67 * @return A public handle to the newly allocated ItemView.
69 static Dali::Toolkit::ItemView New(ItemFactory& factory);
72 * @copydoc Toolkit::ItemView::GetLayoutCount
74 unsigned int GetLayoutCount() const;
77 * @copydoc Toolkit::ItemView::AddLayout
79 void AddLayout(ItemLayout& layout);
82 * @copydoc Toolkit::ItemView::RemoveLayout
84 void RemoveLayout(unsigned int layoutIndex);
87 * @copydoc Toolkit::ItemView::GetLayout
89 ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
92 * @copydoc Toolkit::ItemView::GetActiveLayout
94 ItemLayoutPtr GetActiveLayout() const;
97 * @copydoc Toolkit::ItemView::GetCurrentLayoutPosition
99 float GetCurrentLayoutPosition(unsigned int itemId) const;
102 * @copydoc Toolkit::ItemView::ActivateLayout
104 void ActivateLayout(unsigned int layoutIndex, const Vector3& targetSize, float durationSeconds);
107 * @copydoc Toolkit::ItemView::DeactivateCurrentLayout
109 void DeactivateCurrentLayout();
112 * @copydoc Toolkit::ItemView::SetMinimumSwipeSpeed
114 void SetMinimumSwipeSpeed(float speed);
117 * @copydoc Toolkit::ItemView::GetMinimumSwipeSpeed
119 float GetMinimumSwipeSpeed() const;
122 * @copydoc Toolkit::ItemView::SetMinimumSwipeDistance
124 void SetMinimumSwipeDistance(float distance);
127 * @copydoc Toolkit::ItemView::GetMinimumSwipeDistance
129 float GetMinimumSwipeDistance() const;
132 * @copydoc Toolkit::ItemView::SetWheelScrollDistanceStep
134 void SetWheelScrollDistanceStep(float step);
137 * @copydoc Toolkit::ItemView::GetWheelScrollDistanceStep
139 float GetWheelScrollDistanceStep() const;
142 * @copydoc Toolkit::ItemView::SetAnchoring
144 void SetAnchoring(bool enabled);
147 * @copydoc Toolkit::ItemView::GetAnchoring
149 bool GetAnchoring() const;
152 * @copydoc Toolkit::ItemView::SetAnchoringDuration
154 void SetAnchoringDuration(float durationSeconds);
157 * @copydoc Toolkit::ItemView::GetAnchoringDuration
159 float GetAnchoringDuration() const;
162 * @copydoc Toolkit::ItemView::ScrollToItem
164 void ScrollToItem(unsigned int itemId, float durationSeconds);
167 * @copydoc Toolkit::ItemView::SetRefreshInterval
169 void SetRefreshInterval(float intervalLayoutPositions);
172 * @copydoc Toolkit::ItemView::GetRefreshInterval
174 float GetRefreshInterval() const;
177 * @copydoc Toolkit::ItemView::Refresh
182 * @copydoc Toolkit::ItemView::GetItem
184 Actor GetItem(unsigned int itemId) const;
187 * @copydoc Toolkit::ItemView::GetItemId
189 unsigned int GetItemId(Actor actor) const;
192 * @copydoc Toolkit::ItemView::InsertItem
194 void InsertItem(Item newItem, float durationSeconds);
197 * @copydoc Toolkit::ItemView::InsertItem
199 void InsertItems(const ItemContainer& newItems, float durationSeconds);
202 * @copydoc Toolkit::ItemView::RemoveItem
204 void RemoveItem(ItemId itemId, float durationSeconds);
207 * @copydoc Toolkit::ItemView::InsertItem
209 void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
212 * @copydoc Toolkit::ItemView::InsertItem
214 void ReplaceItem(Item replacementItem, float durationSeconds);
217 * @copydoc Toolkit::ItemView::InsertItem
219 void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
222 * @copydoc Toolkit::Scrollable::GetCurrentScrollPosition
224 Vector2 GetCurrentScrollPosition() const;
227 * @copydoc Toolkit::Scrollable::AddOverlay()
229 void AddOverlay(Actor actor);
232 * @copydoc Toolkit::Scrollable::RemoveOverlay()
234 void RemoveOverlay(Actor actor);
237 * @copydoc Toolkit::Scrollable::ScrollTo(const Vector2& position, float duration)
239 void ScrollTo(const Vector2& position, float duration);
242 * @copydoc Toolkit::Internal::Scrollable::SetOvershootEffectColor
244 void SetOvershootEffectColor( const Vector4& color );
247 * @brief Set whether to enable automatic refresh or not. When refresh is disabled,
248 * ItemView will not automatically refresh the cache in the given interval when the
249 * layout position is changed. This is useful in some cases, for example, automatic
250 * refresh is not needed during fast scrolling, otherwise it will cache unneeded
251 * items when the layout position changes quickly.
253 * @param[in] enabled True to enable automatic refresh or false to disable it.
255 void SetRefreshEnabled(bool enabled);
258 * @brief Helper to perform the refresh.
260 * @param[in] currentLayoutPosition The current layout position.
261 * @param[in] cacheExtra Whether to cache extra items during refresh.
263 void DoRefresh(float currentLayoutPosition, bool cacheExtra);
266 * @copydoc Toolkit::ItemView::SetItemsParentOrigin
268 void SetItemsParentOrigin( const Vector3& parentOrigin );
271 * @copydoc Toolkit::ItemView::GetItemsParentOrigin
273 Vector3 GetItemsParentOrigin() const;
276 * @copydoc Toolkit::ItemView::SetItemsAnchorPoint
278 void SetItemsAnchorPoint( const Vector3& anchorPoint );
281 * @copydoc Toolkit::ItemView::GetItemsAnchorPoint
283 Vector3 GetItemsAnchorPoint() const;
286 * @copydoc Toolkit::ItemView::GetItemsRange
288 void GetItemsRange(ItemRange& range);
291 * @copydoc Toolkit::ItemView::LayoutActivatedSignal()
293 LayoutActivatedSignalType& LayoutActivatedSignal()
295 return mLayoutActivatedSignal;
299 * Connects a callback function with the object's signals.
300 * @param[in] object The object providing the signal.
301 * @param[in] tracker Used to disconnect the signal.
302 * @param[in] signalName The signal to connect to.
303 * @param[in] functor A newly allocated FunctorDelegate.
304 * @return True if the signal was connected.
305 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
307 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
312 * Called when a property of an object of this type is set.
313 * @param[in] object The object whose property is set.
314 * @param[in] index The property index.
315 * @param[in] value The new property value.
317 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
320 * Called to retrieve a property of an object of this type.
321 * @param[in] object The object whose property is to be retrieved.
322 * @param[in] index The property index.
323 * @return The current value of the property.
325 static Property::Value GetProperty( BaseObject* object, Property::Index index );
328 * Performs actions as requested using the action name.
329 * @param[in] object The object on which to perform the action.
330 * @param[in] actionName The action to perform.
331 * @param[in] attributes The attributes with which to perfrom this action.
332 * @return true if action has been accepted by this control
334 static bool DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes );
337 * Helper for DoAction( ACTION_STOP_SCROLLING ).
339 void DoStopScrolling();
342 * Helper for DoAction( ACTION_ENABLE/DISABLE_REFRESH_NOTIFICATIONS ).
343 * @param[in] enabled Whether to disable refresh notifications or not.
345 void SetRefreshNotificationEnabled( bool enabled );
350 * Get all the layouts used in the ItemView.
351 * @return The layout array
353 Property::Array GetLayoutArray();
356 * Set all the layouts. that will be used in the ItemView.
357 * @param[in] layouts The layouts used in the itemView.
359 void SetLayoutArray( const Property::Array& layouts );
362 * Remove an Actor if found in the ItemPool.
363 * @param[in] itemId The item to remove.
364 * @return True if the remaining actors were reordered.
366 bool RemoveActor( unsigned int itemId );
369 * Remove any Actors outside a given range.
370 * @param[in] @param[in] range The range of required items.
372 void RemoveActorsOutsideRange( ItemRange range );
375 * Add a range of Actors, if they are not already in the ItemPool.
376 * @param[in] range The range of Item IDs to associate with the new actors.
377 * @param[in] layoutSize The layout-size.
379 void AddActorsWithinRange( ItemRange range, const Vector3& layoutSize );
382 * Add a new Actor, if not already in the ItemPool.
383 * @param[in] item The ID for the new item.
384 * @param[in] layoutSize The layout-size.
386 void AddNewActor( ItemId item, const Vector3& layoutSize );
389 * Apply the constraints etc. that are required for ItemView children.
390 * @param[in] item The item to setup.
391 * @param[in] layoutSize The layout-size.
393 void SetupActor( Item item, const Vector3& layoutSize );
396 * Remove the Actor from the ItemPool and notify the ItemFactory the actor has been released by ItemView.
397 * @param[in] item The ID for the item to be released.
398 * @param[in] actor The actor to be removed from ItemView.
400 void ReleaseActor( ItemId item, Actor actor );
402 private: // From CustomActorImpl
405 * From CustomActorImpl; called after a child has been added to the owning actor.
406 * @param[in] child The child which has been added.
408 virtual void OnChildAdd(Actor& child);
411 * From CustomActorImpl; called after a wheel-event is received by the owning actor.
412 * @param[in] event The wheel event.
413 * @return True if the event should be consumed.
415 virtual bool OnWheelEvent(const WheelEvent& event);
417 private: // From Control
420 * @copydoc Toolkit::Control::OnInitialize()
422 virtual void OnInitialize();
425 * @copydoc Toolkit::Control::OnAccessibilityPan()
427 virtual bool OnAccessibilityPan(PanGesture gesture);
430 * @copydoc Toolkit::Control::GetNextKeyboardFocusableActor()
432 virtual Actor GetNextKeyboardFocusableActor(Actor actor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled);
435 * @copydoc Toolkit::Control::OnKeyboardFocusChangeCommitted()
437 virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
442 * Construct a new ItemView.
443 * @param[in] factory The factory which provides ItemView with items.
445 ItemView(ItemFactory& factory);
448 * A reference counted object may only be deleted by calling Unreference()
455 ItemView(const ItemView&);
458 ItemView& operator=(const ItemView& rhs);
461 * Helper to re-apply all the constraints after items have been inserted, removed etc.
462 * @param[in] durationSeconds The time taken to fully constrain the actors.
464 void ReapplyAllConstraints();
467 * Helper to relayout after item(s) are removed.
469 void OnItemsRemoved();
472 * Helper to remove items outside a given range.
473 * @param[in] range The range of required items.
475 void RemoveItems(ItemRange range);
478 * Helper to add a range of items, if not already in the ItemPool.
479 * @param[in] layout The layout used to position the new items.
480 * @param[in] layoutSize The current size of the layout.
481 * @param[in] range The range of required items.
483 void AddItems(ItemLayout& layout, const Vector3& layoutSize, ItemRange range);
486 * Helper to find the range of items to populate with.
487 * @param[in] layout The current layout.
488 * @param[in] range The range of items.
489 * @param[in] reserveExtra True if reserve items should be included.
491 ItemRange GetItemRange(ItemLayout& layout, const Vector3& layoutSize, float layoutPosition, bool reserveExtra);
496 * Helper to clamp the first-item position when dragging/swiping.
497 * @param[in] targetPosition The target position of the drag etc.
498 * @param[in] targetSize The target ItemView & layout size.
499 * @param[in] layout The current layout.
500 * @param[in] updateOvershoot False stops the current overshoot value from being clamped also.
501 * @return The clamped first-item position.
503 float ClampFirstItemPosition(float targetPosition, const Vector3& targetSize, ItemLayout& layout, bool updateOvershoot = true);
506 * Called after a touch-signal is received by the owning actor.
507 * @param[in] actor The touched actor.
508 * @param[in] touch The touch information.
509 * @return True if the event should be consumed.
511 bool OnTouch( Actor actor, const TouchData& touch );
514 * Called upon pan gesture event.
516 * @param[in] gesture The gesture event.
518 void OnPan( const PanGesture& pan );
521 * Helper to handle anchoring animations.
522 * @return The animation, or an uninitialized handle if not necessary.
524 Animation DoAnchoring();
527 * Callback from scroll animations
528 * @param[in] animation The scroll-animation which has finished.
530 void OnScrollFinished(Animation& animation);
533 * Callback from layout activation scroll animations
534 * @param[in] animation The scroll-animation which has finished.
536 void OnLayoutActivationScrollFinished(Animation& animation);
539 * Called by animation system when overshoot has finished animating to maximum (either -1.0f or 1.0f)
541 * @param[in] animation the animation that has finished
543 void OnOvershootOnFinished(Animation& animation);
546 * This is called after a timeout when no new wheel event is received for a certain period of time.
547 * @return will return false; one-shot timer.
549 bool OnWheelEventFinished();
552 * Stops and removes animation if exists.
553 * @param[in,out] animation The animation handle to be removed.
555 void RemoveAnimation(Animation& animation);
558 * @copydoc Toolkit::Internal::Scrollable::EnableScrollOvershoot
560 virtual void EnableScrollOvershoot( bool enable );
563 * Helper to calculate the scroll overshoot according to the pan gesture displacement.
564 * @return The scroll overshoot.
566 float CalculateScrollOvershoot();
569 * Helper to calculate the scroll overshoot according to the pan gesture displacement.
571 * @param[in] overshootAmount amount to animate to
572 * @param[in] animateBack whether to animate back to zero immediately after
573 * @return The scroll overshoot.
575 void AnimateScrollOvershoot(float overshootAmount, bool animateBack = false);
578 * Gets the scroll position in pixels according to the logical layout position.
579 * @param[in] layoutSize The current size of the layout.
581 float GetScrollPosition(float layoutPosition, const Vector3& layoutSize) const;
584 * Calculates the minimum and maximum positions for each axis to scroll to.
585 * @param[in] layoutSize The current size of the layout.
587 void CalculateDomainSize(const Vector3& layoutSize);
590 * Calculates whether we want to allow current item view to scroll.
591 * @param[in] layoutSize The current size of the layout.
592 * @return true if itemview is scrollable
594 bool IsLayoutScrollable(const Vector3& layoutSize);
597 * Callback when the current layout position of ItemView changes in both positive
598 * and negative directions by the specified amount. Refresh the ItemView to create
599 * newly visible items.
600 * @param[in] source the property notification that triggered this callback
602 void OnRefreshNotification(PropertyNotification& source);
606 typedef std::map<unsigned int, Actor> ItemPool;
607 typedef ItemPool::iterator ItemPoolIter;
608 typedef ItemPool::const_iterator ConstItemPoolIter;
610 Property::Array mlayoutArray;
613 ItemFactory& mItemFactory;
614 std::vector< ItemLayoutPtr > mLayouts; ///< Container of Dali::Toolkit::ItemLayout objects
615 Actor mOvershootOverlay; ///< The overlay actor for overshoot effect
616 Animation mResizeAnimation;
617 Animation mScrollAnimation;
618 Animation mScrollOvershootAnimation;
619 Timer mWheelEventFinishedTimer; ///< The timer to determine whether there is no wheel event received for a certain period of time.
620 PropertyNotification mRefreshNotification; ///< Stores the property notification used for item view refresh
621 LayoutActivatedSignalType mLayoutActivatedSignal;
622 Vector3 mActiveLayoutTargetSize;
623 Vector3 mItemsParentOrigin;
624 Vector3 mItemsAnchorPoint;
625 Vector2 mTotalPanDisplacement;
626 ItemLayout* mActiveLayout;
628 float mAnchoringDuration;
629 float mRefreshIntervalLayoutPositions; ///< Refresh item view when the layout position changes by this interval in both positive and negative directions.
630 float mMinimumSwipeSpeed;
631 float mMinimumSwipeDistance;
632 float mWheelScrollDistanceStep; ///< The step of scroll distance in actor coordinates for each wheel event received.
633 float mScrollDistance;
635 float mScrollOvershoot;
637 Dali::Gesture::State mGestureState : 3;
638 bool mAnimatingOvershootOn : 1; ///< Whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
639 bool mAnimateOvershootOff : 1; ///< Whether we are currently animating overshoot to 1.0f/-1.0f (on) or to 0.0f (off)
640 bool mAnchoringEnabled : 1;
641 bool mRefreshOrderHint : 1; ///< True if scrolling towards the last item
642 bool mIsFlicking : 1;
643 bool mAddingItems : 1;
644 bool mRefreshEnabled : 1; ///< Whether to refresh the cache automatically
645 bool mRefreshNotificationEnabled : 1; ///< Whether to disable refresh notifications or not.
646 bool mInAnimation : 1; ///< Keeps track of whether an animation is controlling the overshoot property.
649 } // namespace Internal
651 // Helpers for public-api forwarding methods
653 inline Toolkit::Internal::ItemView& GetImpl(Toolkit::ItemView& itemView)
655 DALI_ASSERT_ALWAYS(itemView);
657 Dali::RefObject& handle = itemView.GetImplementation();
659 return static_cast<Toolkit::Internal::ItemView&>(handle);
662 inline const Toolkit::Internal::ItemView& GetImpl(const Toolkit::ItemView& itemView)
664 DALI_ASSERT_ALWAYS(itemView);
666 const Dali::RefObject& handle = itemView.GetImplementation();
668 return static_cast<const Toolkit::Internal::ItemView&>(handle);
671 } // namespace Toolkit
675 #endif // __DALI_TOOLKIT_INTERNAL_ITEM_VIEW_H__