X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Fscroll-bar%2Fscroll-bar-impl.h;h=abb520086438cb05cd9510664b6daf44e184de80;hb=b8f550700dbe3304f217b3dc7a240854089b8b4e;hp=909e4fed921726e9cbd28e5ecac14b6a8484f2d5;hpb=75034433e28c31e99ce28a2013c3967a7e165bf1;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git 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 909e4fe..abb5200 --- a/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h +++ b/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h @@ -1,36 +1,43 @@ -#ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H__ -#define __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H__ - -// -// Copyright (c) 2014 Samsung Electronics Co., Ltd. -// -// Licensed under the Flora License, Version 1.0 (the License); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://floralicense.org/license/ -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an AS IS BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// +#ifndef DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H +#define DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H + +/* + * 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. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +// EXTERNAL INCLUDES +#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; @@ -39,86 +46,184 @@ 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::PanFinishedSignalType PanFinishedSignalType; + typedef Toolkit::ScrollBar::ScrollPositionIntervalReachedSignalType ScrollPositionIntervalReachedSignalType; public: + /** + * @copydoc Toolkit::ScrollBar::New() + */ + static Toolkit::ScrollBar New(Toolkit::ScrollBar::Direction direction); - typedef Toolkit::ScrollBar::ScrollPositionNotifiedSignalType ScrollPositionNotifiedSignalType; + /** + * @copydoc Toolkit::ScrollBar::SetScrollPropertySource() + */ + void SetScrollPropertySource(Handle handle, Property::Index propertyScrollPosition, Property::Index propertyMinScrollPosition, Property::Index propertyMaxScrollPosition, Property::Index propertyScrollContentSize); -public: + /** + * @copydoc Toolkit::ScrollBar::SetScrollIndicator() + */ + void SetScrollIndicator(Actor indicator); /** - * @copydoc Toolkit::ScrollBar::ScrollBar() + * @copydoc Toolkit::ScrollBar::GetScrollIndicator() */ - ScrollBar(); + Actor GetScrollIndicator(); /** - * @copydoc Toolkit::ScrollBar::~ScrollBar() + * @copydoc Toolkit::ScrollBar::SetScrollPositionIntervals() */ - virtual ~ScrollBar(); + void SetScrollPositionIntervals(const Dali::Vector& positions); /** - * @copydoc Toolkit::ScrollBar::New() + * @copydoc Toolkit::ScrollBar::GetScrollPositionIntervals() */ - static Toolkit::ScrollBar New(); + Dali::Vector GetScrollPositionIntervals() const; /** - * @copydoc Toolkit::ScrollComponentImpl::OnScrollConnectorSet() + * @copydoc Toolkit::ScrollBar::SetScrollDirection() */ - void OnScrollConnectorSet( Toolkit::ScrollConnector connector ); + void SetScrollDirection(Toolkit::ScrollBar::Direction direction); /** - * @copydoc Toolkit::ScrollBar::SetBackgroundImage() + * @copydoc Toolkit::ScrollBar::GetScrollDirection() */ - void SetBackgroundImage( Image image, const Vector4& border ); + Toolkit::ScrollBar::Direction GetScrollDirection() const; /** - * @copydoc Toolkit::ScrollBar::SetIndicatorImage() + * @copydoc Toolkit::ScrollBar::SetIndicatorHeightPolicy() */ - void SetIndicatorImage( Image image, const Vector4& border ); + void SetIndicatorHeightPolicy(Toolkit::ScrollBar::IndicatorHeightPolicy policy); /** - * @copydoc Toolkit::ScrollBar::GetScrollIndicator() + * @copydoc Toolkit::ScrollBar::GetIndicatorHeightPolicy() */ - Actor GetScrollIndicator(); + Toolkit::ScrollBar::IndicatorHeightPolicy GetIndicatorHeightPolicy() const; /** - * @copydoc Toolkit::ScrollBar::SetPositionNotifications() + * @copydoc Toolkit::ScrollBar::SetIndicatorFixedHeight() */ - void SetPositionNotifications( const std::vector& positions ); + void SetIndicatorFixedHeight(float height); /** - * @copydoc Toolkit::ScrollBar::Show() + * @copydoc Toolkit::ScrollBar::GetIndicatorFixedHeight() */ - void Show(); + float GetIndicatorFixedHeight() const; /** - * @copydoc Toolkit::ScrollBar::Hide() + * @copydoc Toolkit::ScrollBar::SetIndicatorShowDuration() */ - void Hide(); + void SetIndicatorShowDuration(float durationSeconds); - /** - * Signal emitted after the SetScrollDomain() method has been called. + /** + * @copydoc Toolkit::ScrollBar::GetIndicatorShowDuration() + */ + float GetIndicatorShowDuration() const; + + /** + * @copydoc Toolkit::ScrollBar::SetIndicatorHideDuration() + */ + void SetIndicatorHideDuration(float durationSeconds); + + /** + * @copydoc Toolkit::ScrollBar::GetIndicatorHideDuration() + */ + float GetIndicatorHideDuration() const; + + /** + * @copydoc Toolkit::ScrollBar::ShowIndicator() + */ + void ShowIndicator(); + + /** + * @copydoc Toolkit::ScrollBar::HideIndicator() + */ + void HideIndicator(); + + /** + * @brief Shows indicator until the transient duration has expired + */ + void ShowTransientIndicator(); + + /** + * @copydoc Toolkit::ScrollBar::PanFinishedSignal() */ - ScrollPositionNotifiedSignalType& ScrollPositionNotifiedSignal() - { - return mScrollPositionNotifiedSignal; - } + PanFinishedSignalType& PanFinishedSignal() + { + return mPanFinishedSignal; + } -private: // from ControlImpl + /** + * @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. + * @param[in] signalName The signal to connect to. + * @param[in] functor A newly allocated FunctorDelegate. + * @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); + + // 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); + +private: // from Control + /** * @copydoc Toolkit::Control::OnInitialize */ - virtual void OnInitialize(); + void OnInitialize() override; /** * @copydoc Toolkit::Control::OnPan */ - virtual void OnPan( PanGesture gesture ); + void OnPan(const PanGesture& gesture) override; + + /** + * @copydoc CustomActorImpl::OnSizeSet( const Vector3& size ) + */ + void OnSizeSet(const Vector3& size) override; private: + /** + * Create the default indicator actor. + */ + void CreateDefaultIndicatorActor(); /** * Apply constraints for background and indicator. @@ -127,19 +232,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. @@ -147,27 +244,85 @@ 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) + + WeakHandle mScrollableObject; ///< Object to be scrolled + + 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 mTransientIndicatorDuration; ///< The duration before hiding transient indicator + + float mScrollStart; ///< Scroll Start position (start of drag) + Vector2 mGestureDisplacement; ///< Gesture Displacement. - Constrainable mScrollPositionObject; ///< From mScrollConnector + float mCurrentScrollPosition; ///< The current scroll position updated by the pan gesture - ImageActor mBackground; ///< Background image of scroll bar. - ImageActor mIndicator; ///< Image of scroll indicator. - Animation mAnimation; ///< Scroll indicator Show/Hide Animation. + Toolkit::ScrollBar::IndicatorHeightPolicy mIndicatorHeightPolicy; ///< The height policy of scroll indicator (variable or fixed) + 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 - float mScrollStart; ///< Scroll Start position (start of drag) - Vector3 mGestureDisplacement; ///< Gesture Displacement. + Timer mContractDelayTimer; ///< Timer guarantee contract delay time. + Timer mPanProcessTimer; ///< The timer to process the pan gesture after the gesture is started. - bool mIsPanning; ///< Whether the scroll bar is being panned. - float mCurrentScrollPosition; ///< The current scroll position updated by the pan gesture + 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 - Timer mTimer; ///< The timer to process the pan gesture after the gesture is started. + PanFinishedSignalType mPanFinishedSignal; + ScrollPositionIntervalReachedSignalType mScrollPositionIntervalReachedSignal; - Property::Index mPropertyIndicatorPosition; ///< Indicatore Position ("indicator-position") + Constraint mIndicatorPositionConstraint; + Constraint mIndicatorSizeConstraint; - PropertyNotification mPositionNotification; ///< Stores the property notification used for scroll position changes + bool mIsPanning : 1; ///< Whether the scroll bar is being panned. + bool mIndicatorFirstShow : 1; ///< True if the indicator has never been shown - ScrollPositionNotifiedSignalType mScrollPositionNotifiedSignal; +protected: + struct AccessibleImpl : public DevelControl::AccessibleImpl, + public virtual Dali::Accessibility::Value + { + using DevelControl::AccessibleImpl::AccessibleImpl; + double GetMinimum() override; + double GetCurrent() override; + double GetMaximum() override; + bool SetCurrent(double) override; + double GetMinimumIncrement() override; + }; }; } // namespace Internal @@ -196,4 +351,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