X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Fscrollable%2Fscrollable-impl.h;h=cbed9c1ccf93e606f65068f65daff642a2872d85;hp=799ed622af99ba5115a1bca42e44eff378aacde3;hb=9c1f4310db72879676b5aca2875fbf67b97a4b0a;hpb=c32e712ddb572650fe0766d7f10a9707db5b5c6b diff --git a/dali-toolkit/internal/controls/scrollable/scrollable-impl.h b/dali-toolkit/internal/controls/scrollable/scrollable-impl.h index 799ed62..cbed9c1 100644 --- a/dali-toolkit/internal/controls/scrollable/scrollable-impl.h +++ b/dali-toolkit/internal/controls/scrollable/scrollable-impl.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_INTERNAL_SCROLLABLE_H__ -#define __DALI_TOOLKIT_INTERNAL_SCROLLABLE_H__ +#ifndef DALI_TOOLKIT_INTERNAL_SCROLLABLE_H +#define DALI_TOOLKIT_INTERNAL_SCROLLABLE_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,22 +19,20 @@ */ // EXTERNAL INCLUDES -#include +#include // INTERNAL INCLUDES +#include +#include #include #include -#include namespace Dali { - namespace Toolkit { - namespace Internal { - class Scrollable; typedef IntrusivePtr ScrollablePtr; @@ -44,37 +42,15 @@ typedef IntrusivePtr ScrollablePtr; class Scrollable : public Control { public: - static const char* const SCROLLABLE_CAN_SCROLL_VERTICAL; - static const char* const SCROLLABLE_CAN_SCROLL_HORIZONTAL; - - /** - * Create a new Scrollable. - * @return A public handle to the newly allocated Scrollable. - */ -// static Dali::Toolkit::Scrollable New(); - -public: - - /** - * @copydoc Dali::Toolkit::Scrollable::IsScrollComponentEnabled(Scrollable::ScrollComponentType type) - */ - bool IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const; - - /** - * @copydoc Dali::Toolkit::Scrollable::EnableScrollComponent(Scrollable::ScrollComponentType type) - */ - void EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type); - /** - * @copydoc Dali::Toolkit::Scrollable::DisableScrollComponent(Scrollable::ScrollComponentType type) + * @copydoc Dali::Toolkit::Scrollable::IsOvershootEnabled */ - void DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type); + bool IsOvershootEnabled() const; /** - * Gets the size of the domain (minimum/maximum extents for each axis to scroll to) - * @return the domain size + * @copydoc Dali::Toolkit::Scrollable::SetOvershootEnabled */ - virtual Vector3 GetDomainSize() const = 0; + void SetOvershootEnabled(bool enable); /** * Adds actor as an Overlay to Scrollable @@ -96,7 +72,7 @@ public: * Retrieves current scroll position. * @returns The current scroll position. */ - virtual Vector3 GetCurrentScrollPosition() const = 0; + virtual Vector2 GetCurrentScrollPosition() const = 0; /** * Scrolls Scrollable to position specified (contents will scroll to this position) @@ -105,13 +81,13 @@ public: * @param[in] position The position to scroll to. * @param[in] duration The duration of the animation in seconds */ - virtual void ScrollTo(const Vector3 &position, float duration) = 0; + virtual void ScrollTo(const Vector2& position, float duration) = 0; /** * Set the color of the overshoot effect. * @parm[in] color The color of the overshoot effect */ - virtual void SetOvershootEffectColor( const Vector4& color ) = 0; + virtual void SetOvershootEffectColor(const Vector4& color) = 0; /** * Retrieve the color of the overshoot effect. @@ -122,24 +98,52 @@ public: /** * @copydoc Dali::Toolkit::Scrollable::SetOvershootAnimationSpeed(float pixelsPerSecond) */ - void SetOvershootAnimationSpeed( float pixelsPerSecond ); + void SetOvershootAnimationSpeed(float pixelsPerSecond); /** * @copydoc Dali::Toolkit::Scrollable::GetOvershootAnimationSpeed() */ float GetOvershootAnimationSpeed() const; -private: + /** + * @copydoc Dali::Toolkit::Scrollable::GetOvershootSize() + */ + const Vector2& GetOvershootSize() const; /** - * Temporary function to override EnableScrollComponent functionality for overshoot + * Set the size of the overshoot effect. + * @parm[in] size The size of the overshoot effect + */ + virtual void SetOvershootSize(const Vector2& size) = 0; + +protected: // From Control + class ScrollableAccessible : public DevelControl::ControlAccessible + { + public: + using DevelControl::ControlAccessible::ControlAccessible; + + /** + * @copydoc Dali::Accessibility::Component::IsScrollable() + */ + bool IsScrollable() const override; + }; + + /** + * @copydoc Control::OnInitialize + */ + virtual void OnInitialize() override; + +private: + /** + * Temporary function to override EnableScrollOvershoot functionality for overshoot * Only ScrollView needs to override this as HQ has not requested disable functionality in ItemView * @param[in] enable true to enable, false to disable overshoot indicator */ - virtual void SetOvershootEnabled(bool enable) {} + virtual void EnableScrollOvershoot(bool enable) + { + } public: //Signals - /** * @copydoc Dali::Toolkit::Scrollable::ScrollStartedSignal() */ @@ -164,7 +168,7 @@ public: //Signals * @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 @@ -174,7 +178,7 @@ public: //Signals * @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. @@ -182,75 +186,54 @@ public: //Signals * @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); protected: - /** - * Construct a new Scrollable. + * Removed default constructor. */ - Scrollable(); + Scrollable() = delete; /** - * A reference counted object may only be deleted by calling Unreference() + * @brief Construct a new Scrollable. + * + * @param[in] behaviourFlags Flags to enable */ - virtual ~Scrollable(); + Scrollable(ControlBehaviour behaviourFlags); /** - * Register common properties + * A reference counted object may only be deleted by calling Unreference() */ - void RegisterCommonProperties(); + virtual ~Scrollable(); private: - /** * Gets position property. * * @return The current position */ - Vector3 GetPropertyPosition() const; + Vector2 GetPropertyPosition() const; private: - // Undefined Scrollable(const Scrollable&); // Undefined Scrollable& operator=(const Scrollable& rhs); - /** - * Helper to create an initialized ScrollComponent - * @param[in] scrollable reference to ScrollView implementation - * @param[in] type the type of scroll component to create. - * @return A pointer to the created ScrollComponent. - */ - Toolkit::ScrollComponent NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type); - protected: + Vector4 mOvershootEffectColor; /// mComponent; ///< ScrollComponent (such as a scrollbar/page indicator/status) + Dali::AlphaFunction::BuiltinFunction mScrollToAlphaFunction; ///< The ScrollTo() animations use this - Toolkit::Scrollable::ScrollStartedSignalType mScrollStartedSignal; - Toolkit::Scrollable::ScrollUpdatedSignalType mScrollUpdatedSignal; + Toolkit::Scrollable::ScrollStartedSignalType mScrollStartedSignal; + Toolkit::Scrollable::ScrollUpdatedSignalType mScrollUpdatedSignal; Toolkit::Scrollable::ScrollCompletedSignalType mScrollCompletedSignal; private: - - typedef std::map ComponentContainer; - typedef ComponentContainer::iterator ComponentIter; - - ComponentContainer mComponents; ///< ScrollComponent (such as a scrollbar/page indicator/status) - bool mOvershootEnabled:1; + bool mOvershootEnabled : 1; }; } // namespace Internal @@ -279,4 +262,4 @@ inline const Toolkit::Internal::Scrollable& GetImpl(const Toolkit::Scrollable& s } // namespace Dali -#endif // __DALI_TOOLKIT_INTERNAL_SCROLLABLE_H__ +#endif // DALI_TOOLKIT_INTERNAL_SCROLLABLE_H