X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Fscroll-bar%2Fscroll-bar-impl.h;h=57def7f660119d13b91e258d72d17e119238baaf;hp=6979c52639cfa4d8e9ed6c11b987d05c7832ce9e;hb=36b6c48b03fa926529904947f222aadebbf0c1ff;hpb=6d762b4acd946b3d02e76c1805e7af9a1a5b1809 diff --git a/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h b/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h old mode 100755 new mode 100644 index 6979c52..57def7f --- a/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h +++ b/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H__ -#define __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H__ +#ifndef DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H +#define DALI_TOOLKIT_INTERNAL_SCROLL_BAR_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. @@ -19,26 +19,26 @@ */ // EXTERNAL INCLUDES +#include #include -#include -#include #include +#include +#include #include +#include // INTERNAL INCLUDES -#include -#include -#include +#include +#include +#include +#include namespace Dali { - namespace Toolkit { - namespace Internal { - class ScrollBar; typedef IntrusivePtr ScrollBarPtr; @@ -47,117 +47,126 @@ typedef IntrusivePtr ScrollBarPtr; * ScrollBar is a UI component that can be added to the scrollable controls * indicating the current scroll position of the scrollable content. */ -class ScrollBar : public ScrollComponentImpl +class ScrollBar : public Control { - public: - - // Properties - enum - { - SCROLLBAR_PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, - SCROLLBAR_PROPERTY_END_INDEX = SCROLLBAR_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices - }; - // Signals - typedef Toolkit::ScrollBar::ScrollPositionNotifiedSignalType ScrollPositionNotifiedSignalType; + typedef Toolkit::ScrollBar::PanFinishedSignalType PanFinishedSignalType; + typedef Toolkit::ScrollBar::ScrollPositionIntervalReachedSignalType ScrollPositionIntervalReachedSignalType; public: + /** + * @copydoc Toolkit::ScrollBar::New() + */ + static Toolkit::ScrollBar New(Toolkit::ScrollBar::Direction direction); /** - * @copydoc Toolkit::ScrollBar::ScrollBar() + * @copydoc Toolkit::ScrollBar::SetScrollPropertySource() */ - ScrollBar(); + void SetScrollPropertySource(Handle handle, Property::Index propertyScrollPosition, Property::Index propertyMinScrollPosition, Property::Index propertyMaxScrollPosition, Property::Index propertyScrollContentSize); /** - * @copydoc Toolkit::ScrollBar::~ScrollBar() + * @copydoc Toolkit::ScrollBar::SetScrollIndicator() */ - virtual ~ScrollBar(); + void SetScrollIndicator(Actor indicator); /** - * @copydoc Toolkit::ScrollBar::New() + * @copydoc Toolkit::ScrollBar::GetScrollIndicator() */ - static Toolkit::ScrollBar New(); + Actor GetScrollIndicator(); /** - * @copydoc Toolkit::ScrollComponentImpl::OnScrollConnectorSet() + * @copydoc Toolkit::ScrollBar::SetScrollPositionIntervals() */ - void OnScrollConnectorSet( Toolkit::ScrollConnector connector ); + void SetScrollPositionIntervals(const Dali::Vector& positions); /** - * @copydoc Toolkit::ScrollBar::SetIndicatorImage() + * @copydoc Toolkit::ScrollBar::GetScrollPositionIntervals() */ - void SetIndicatorImage( Image image ); + Dali::Vector GetScrollPositionIntervals() const; /** - * @copydoc Toolkit::ScrollBar::GetScrollIndicator() + * @copydoc Toolkit::ScrollBar::SetScrollDirection() */ - Actor GetScrollIndicator(); + void SetScrollDirection(Toolkit::ScrollBar::Direction direction); /** - * @copydoc Toolkit::ScrollBar::SetPositionNotifications() + * @copydoc Toolkit::ScrollBar::GetScrollDirection() */ - void SetPositionNotifications( const std::vector& positions ); + Toolkit::ScrollBar::Direction GetScrollDirection() const; /** * @copydoc Toolkit::ScrollBar::SetIndicatorHeightPolicy() */ - void SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy ); + void SetIndicatorHeightPolicy(Toolkit::ScrollBar::IndicatorHeightPolicy policy); /** * @copydoc Toolkit::ScrollBar::GetIndicatorHeightPolicy() */ - Toolkit::ScrollBar::IndicatorHeightPolicy GetIndicatorHeightPolicy(); + Toolkit::ScrollBar::IndicatorHeightPolicy GetIndicatorHeightPolicy() const; /** * @copydoc Toolkit::ScrollBar::SetIndicatorFixedHeight() */ - void SetIndicatorFixedHeight( float height ); + void SetIndicatorFixedHeight(float height); /** * @copydoc Toolkit::ScrollBar::GetIndicatorFixedHeight() */ - float GetIndicatorFixedHeight(); + float GetIndicatorFixedHeight() const; /** * @copydoc Toolkit::ScrollBar::SetIndicatorShowDuration() */ - void SetIndicatorShowDuration( float durationSeconds ); + void SetIndicatorShowDuration(float durationSeconds); /** * @copydoc Toolkit::ScrollBar::GetIndicatorShowDuration() */ - float GetIndicatorShowDuration(); + float GetIndicatorShowDuration() const; /** * @copydoc Toolkit::ScrollBar::SetIndicatorHideDuration() */ - void SetIndicatorHideDuration( float durationSeconds ); + void SetIndicatorHideDuration(float durationSeconds); /** * @copydoc Toolkit::ScrollBar::GetIndicatorHideDuration() */ - float GetIndicatorHideDuration(); + float GetIndicatorHideDuration() const; + + /** + * @copydoc Toolkit::ScrollBar::ShowIndicator() + */ + void ShowIndicator(); /** - * @copydoc Toolkit::ScrollBar::Show() + * @copydoc Toolkit::ScrollBar::HideIndicator() */ - void Show(); + void HideIndicator(); /** - * @copydoc Toolkit::ScrollBar::Hide() + * @brief Shows indicator until the transient duration has expired */ - void Hide(); + void ShowTransientIndicator(); - /** - * Signal emitted after the SetScrollDomain() method has been called. + /** + * @copydoc Toolkit::ScrollBar::PanFinishedSignal() */ - ScrollPositionNotifiedSignalType& ScrollPositionNotifiedSignal() - { - return mScrollPositionNotifiedSignal; - } + PanFinishedSignalType& PanFinishedSignal() + { + return mPanFinishedSignal; + } - /** + /** + * @copydoc Toolkit::ScrollBar::ScrollPositionIntervalReachedSignal() + */ + ScrollPositionIntervalReachedSignalType& ScrollPositionIntervalReachedSignal() + { + return mScrollPositionIntervalReachedSignal; + } + + /** * 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. @@ -166,44 +175,61 @@ 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 + // 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 ); + 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 ); + static Property::Value GetProperty(BaseObject* object, Property::Index index); -private: // from Control + /** + * 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); +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::OnPan */ - virtual void OnPan( PanGesture gesture ); + void OnPan(const PanGesture& gesture) override; /** - * @copydoc Toolkit::Control::OnControlSizeSet( const Vector3& size ) + * @copydoc CustomActorImpl::OnSizeSet( const Vector3& size ) */ - virtual void OnControlSizeSet( const Vector3& size ); + void OnSizeSet(const Vector3& size) override; private: + /** + * Create the default indicator actor. + */ + void CreateDefaultIndicatorActor(); /** * Apply constraints for background and indicator. @@ -212,19 +238,11 @@ private: void ApplyConstraints(); /** - * Callback when the start & end position and size of the scrollable content are changed. - * @param[in] minPosition The minimum position. - * @param[in] maxPosition The maximum position. - * @param[in] contentSize The size of scrollable content. - */ - void OnScrollDomainChanged(float minPosition, float maxPosition, float contentSize); - - /** * Callback when the current scroll position of the scrollable content goes above or - * below the values specified by SetPositionNotifications(). + * below the values specified by SetScrollPositionIntervals(). * @param[in] source the property notification that triggered this callback */ - void OnScrollPositionNotified(PropertyNotification& source); + void OnScrollPositionIntervalReached(PropertyNotification& source); /** * Process the pan gesture per predefined timeout until the gesture is finished. @@ -233,40 +251,105 @@ private: bool OnPanGestureProcessTick(); /** + * Handle SetProperty for scroll direction. + * @param[in] propertyValue The new property value. + */ + void OnScrollDirectionPropertySet(Property::Value propertyValue); + + /** * Handle SetProperty for scroll indicator height policy. * @param[in] propertyValue The new property value. */ void OnIndicatorHeightPolicyPropertySet(Property::Value propertyValue); private: + /** + * Constructor. + * It initializes ScrollBar members. + */ + ScrollBar(Toolkit::ScrollBar::Direction direction); + + /** + * A reference counted object may only be deleted by calling Unreference() + */ + virtual ~ScrollBar(); + +private: + Actor mIndicator; ///< Image of scroll indicator. + float mIndicatorShowAlpha; ///< The alpha value when the indicator is fully shown + Animation mAnimation; ///< Scroll indicator Show/Hide Animation. + + Toolkit::ScrollBar::Direction mDirection; ///< The direction of scroll bar (vertical or horizontal) - Handle mScrollPositionObject; ///< From mScrollConnector + WeakHandle mScrollableObject; ///< Object to be scrolled - ImageActor mIndicator; ///< Image of scroll indicator. - Animation mAnimation; ///< Scroll indicator Show/Hide Animation. + Property::Index mPropertyScrollPosition = 0; ///< Index of scroll position property owned by the object to be scrolled + Property::Index mPropertyMinScrollPosition = 0; ///< Index of minimum scroll position property owned by the object to be scrolled + Property::Index mPropertyMaxScrollPosition = 1; ///< Index of maximum scroll position property owned by the object to be scrolled + Property::Index mPropertyScrollContentSize; ///< Index of scroll content size property owned by the object to be scrolled - float mIndicatorShowDuration; ///< The duration of scroll indicator show animation - float mIndicatorHideDuration; ///< The duration of scroll indicator hide animation + float mIndicatorShowDuration; ///< The duration of scroll indicator show animation + float mIndicatorHideDuration; ///< The duration of scroll indicator hide animation + float mTransientIndicatorDuration; ///< The duration before hiding transient indicator - float mScrollStart; ///< Scroll Start position (start of drag) - Vector3 mGestureDisplacement; ///< Gesture Displacement. + float mScrollStart; ///< Scroll Start position (start of drag) + Vector2 mGestureDisplacement; ///< Gesture Displacement. - bool mIsPanning; ///< Whether the scroll bar is being panned. - float mCurrentScrollPosition; ///< The current scroll position updated by the pan gesture + float mCurrentScrollPosition; ///< The current scroll position updated by the pan gesture Toolkit::ScrollBar::IndicatorHeightPolicy mIndicatorHeightPolicy; ///< The height policy of scroll indicator (variable or fixed) - float mIndicatorFixedHeight; ///< The fixed height of scroll indicator + float mIndicatorFixedHeight; ///< The fixed height of scroll indicator + float mIndicatorMinimumHeight; ///< The minimum height for a variable size indicator + float mIndicatorStartPadding; ///< The padding at the start of the indicator + float mIndicatorEndPadding; ///< The padding at the end of the indicator - Timer mTimer; ///< The timer to process the pan gesture after the gesture is started. + Timer mContractDelayTimer; ///< Timer guarantee contract delay time. + Timer mPanProcessTimer; ///< The timer to process the pan gesture after the gesture is started. - Property::Index mPropertyIndicatorPosition; ///< Indicatore Position ("indicator-position") + Dali::Vector mScrollPositionIntervals; ///< List of values to receive notification for when the current scroll position goes above or below them + PropertyNotification mPositionNotification; ///< Stores the property notification used for scroll position changes - PropertyNotification mPositionNotification; ///< Stores the property notification used for scroll position changes + PanFinishedSignalType mPanFinishedSignal; + ScrollPositionIntervalReachedSignalType mScrollPositionIntervalReachedSignal; - ScrollPositionNotifiedSignalType mScrollPositionNotifiedSignal; + Constraint mIndicatorPositionConstraint; + Constraint mIndicatorSizeConstraint; - ActiveConstraint mIndicatorSizeConstraint; - ActiveConstraint mIndicatorPositionConstraint; + bool mIsPanning : 1; ///< Whether the scroll bar is being panned. + bool mIndicatorFirstShow : 1; ///< True if the indicator has never been shown + +protected: + class ScrollBarAccessible : public DevelControl::ControlAccessible, + public virtual Dali::Accessibility::Value + { + public: + using DevelControl::ControlAccessible::ControlAccessible; + + /** + * @copydoc Dali::Accessibility::Value::GetMinimum() + */ + double GetMinimum() const override; + + /** + * @copydoc Dali::Accessibility::Value::GetCurrent() + */ + double GetCurrent() const override; + + /** + * @copydoc Dali::Accessibility::Value::GetMaximum() + */ + double GetMaximum() const override; + + /** + * @copydoc Dali::Accessibility::Value::SetCurrent() + */ + bool SetCurrent(double) override; + + /** + * @copydoc Dali::Accessibility::Value::GetMinimumIncrement() + */ + double GetMinimumIncrement() const override; + }; }; } // namespace Internal @@ -295,4 +378,4 @@ inline const Toolkit::Internal::ScrollBar& GetImpl(const Toolkit::ScrollBar& scr } // namespace Dali -#endif // __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H__ +#endif // DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H