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=f56b9a0923aa022a68afb7a2c796d7e3ccbc4bbf;hp=f6e85dd66ccfdcf2bc0a54a0e893edb75d5b4ba4;hb=b2e0875240ab94aeafce0f5a7d05f84a562184b7;hpb=3bdbf66c314bb6036eb35ec0d2f1c9c32652f931 diff --git a/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h b/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h index f6e85dd..f56b9a0 100755 --- 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) 2020 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. @@ -20,15 +20,15 @@ // EXTERNAL INCLUDES #include -#include #include #include +#include #include +#include // INTERNAL INCLUDES -#include -#include -#include +#include +#include namespace Dali { @@ -47,50 +47,56 @@ 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: // Signals - typedef Toolkit::ScrollBar::ScrollPositionNotifiedSignalType ScrollPositionNotifiedSignalType; + typedef Toolkit::ScrollBar::PanFinishedSignalType PanFinishedSignalType; + typedef Toolkit::ScrollBar::ScrollPositionIntervalReachedSignalType ScrollPositionIntervalReachedSignalType; public: /** - * @copydoc Toolkit::ScrollBar::ScrollBar() + * @copydoc Toolkit::ScrollBar::New() */ - ScrollBar(); + static Toolkit::ScrollBar New(Toolkit::ScrollBar::Direction direction); /** - * @copydoc Toolkit::ScrollBar::~ScrollBar() + * @copydoc Toolkit::ScrollBar::SetScrollPropertySource() */ - virtual ~ScrollBar(); + void SetScrollPropertySource( Handle handle, Property::Index propertyScrollPosition, Property::Index propertyMinScrollPosition, Property::Index propertyMaxScrollPosition, Property::Index propertyScrollContentSize ); /** - * @copydoc Toolkit::ScrollBar::New() + * @copydoc Toolkit::ScrollBar::SetScrollIndicator() */ - static Toolkit::ScrollBar New(); + void SetScrollIndicator( Actor indicator ); /** - * @copydoc Toolkit::ScrollComponentImpl::OnScrollConnectorSet() + * @copydoc Toolkit::ScrollBar::GetScrollIndicator() */ - void OnScrollConnectorSet( Toolkit::ScrollConnector connector ); + Actor GetScrollIndicator(); /** - * @copydoc Toolkit::ScrollBar::SetIndicatorImage() + * @copydoc Toolkit::ScrollBar::SetScrollPositionIntervals() */ - void SetIndicatorImage( Image image ); + void SetScrollPositionIntervals( const Dali::Vector& positions ); /** - * @copydoc Toolkit::ScrollBar::GetScrollIndicator() + * @copydoc Toolkit::ScrollBar::GetScrollPositionIntervals() */ - Actor GetScrollIndicator(); + Dali::Vector GetScrollPositionIntervals() const; /** - * @copydoc Toolkit::ScrollBar::SetPositionNotifications() + * @copydoc Toolkit::ScrollBar::SetScrollDirection() */ - void SetPositionNotifications( const std::vector& positions ); + void SetScrollDirection( Toolkit::ScrollBar::Direction direction ); + + /** + * @copydoc Toolkit::ScrollBar::GetScrollDirection() + */ + Toolkit::ScrollBar::Direction GetScrollDirection() const; /** * @copydoc Toolkit::ScrollBar::SetIndicatorHeightPolicy() @@ -100,7 +106,7 @@ public: /** * @copydoc Toolkit::ScrollBar::GetIndicatorHeightPolicy() */ - Toolkit::ScrollBar::IndicatorHeightPolicy GetIndicatorHeightPolicy(); + Toolkit::ScrollBar::IndicatorHeightPolicy GetIndicatorHeightPolicy() const; /** * @copydoc Toolkit::ScrollBar::SetIndicatorFixedHeight() @@ -110,7 +116,7 @@ public: /** * @copydoc Toolkit::ScrollBar::GetIndicatorFixedHeight() */ - float GetIndicatorFixedHeight(); + float GetIndicatorFixedHeight() const; /** * @copydoc Toolkit::ScrollBar::SetIndicatorShowDuration() @@ -120,7 +126,7 @@ public: /** * @copydoc Toolkit::ScrollBar::GetIndicatorShowDuration() */ - float GetIndicatorShowDuration(); + float GetIndicatorShowDuration() const; /** * @copydoc Toolkit::ScrollBar::SetIndicatorHideDuration() @@ -130,24 +136,37 @@ public: /** * @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() + PanFinishedSignalType& PanFinishedSignal() { - return mScrollPositionNotifiedSignal; + return mPanFinishedSignal; + } + + /** + * @copydoc Toolkit::ScrollBar::ScrollPositionIntervalReachedSignal() + */ + ScrollPositionIntervalReachedSignalType& ScrollPositionIntervalReachedSignal() + { + return mScrollPositionIntervalReachedSignal; } /** @@ -179,6 +198,15 @@ public: */ 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 ); + private: // from Control /** @@ -189,35 +217,32 @@ private: // from Control /** * @copydoc Toolkit::Control::OnPan */ - virtual void OnPan( PanGesture gesture ); + virtual void OnPan( const PanGesture& gesture ); /** - * @copydoc Toolkit::Control::OnControlSizeSet( const Vector3& size ) + * @copydoc CustomActorImpl::OnSizeSet( const Vector3& size ) */ - virtual void OnControlSizeSet( const Vector3& size ); + virtual void OnSizeSet( const Vector3& size ); private: /** - * Apply constraints for background and indicator. - * These constraints are based on values from the scroll connector. + * Create the default indicator actor. */ - void ApplyConstraints(); + void CreateDefaultIndicatorActor(); /** - * 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. + * Apply constraints for background and indicator. + * These constraints are based on values from the scroll connector. */ - void OnScrollDomainChanged(float minPosition, float maxPosition, float contentSize); + void ApplyConstraints(); /** * 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. @@ -226,6 +251,12 @@ 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. */ @@ -233,32 +264,61 @@ private: private: - Handle mScrollPositionObject; ///< From mScrollConnector + /** + * Constructor. + * It initializes ScrollBar members. + */ + ScrollBar( Toolkit::ScrollBar::Direction direction ); + + /** + * A reference counted object may only be deleted by calling Unreference() + */ + virtual ~ScrollBar(); + +private: - ImageActor mIndicator; ///< Image of scroll indicator. + Actor mIndicator; ///< Image of scroll indicator. + float mIndicatorShowAlpha; ///< The alpha value when the indicator is fully shown Animation mAnimation; ///< Scroll indicator Show/Hide Animation. - float mIndicatorShowDuration; ///< The duration of scroll indicator show animation - float mIndicatorHideDuration; ///< The duration of scroll indicator hide animation + Toolkit::ScrollBar::Direction mDirection; ///< The direction of scroll bar (vertical or horizontal) - float mScrollStart; ///< Scroll Start position (start of drag) + WeakHandle mScrollableObject; ///< Object to be scrolled + + Property::Index mPropertyScrollPosition; ///< Index of scroll position property owned by the object to be scrolled + Property::Index mPropertyMinScrollPosition; ///< Index of minimum scroll position property owned by the object to be scrolled + Property::Index mPropertyMaxScrollPosition; ///< 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 mTransientIndicatorDuration; ///< The duration before hiding transient indicator + + float mScrollStart; ///< Scroll Start position (start of drag) Vector3 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. - - Property::Index mPropertyIndicatorPosition; ///< Indicatore Position ("indicator-position") + Timer mContractDelayTimer; ///< Timer guarantee contract delay time. + Timer mPanProcessTimer; ///< The timer to process the pan gesture after the gesture is started. + 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 - ScrollPositionNotifiedSignalType mScrollPositionNotifiedSignal; + PanFinishedSignalType mPanFinishedSignal; + ScrollPositionIntervalReachedSignalType mScrollPositionIntervalReachedSignal; Constraint mIndicatorPositionConstraint; + Constraint mIndicatorSizeConstraint; + + bool mIsPanning : 1; ///< Whether the scroll bar is being panned. + bool mIndicatorFirstShow : 1; ///< True if the indicator has never been shown }; } // namespace Internal @@ -287,4 +347,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