-#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.
*/
// EXTERNAL INCLUDES
-#include <dali/public-api/common/map-wrapper.h>
+#include <dali/public-api/animation/alpha-function.h>
// INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/controls/control-devel.h>
+#include <dali-toolkit/internal/controls/control/control-data-impl.h>
#include <dali-toolkit/public-api/controls/control-impl.h>
#include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
-#include <dali-toolkit/public-api/controls/scrollable/scroll-component-impl.h>
namespace Dali
{
-
namespace Toolkit
{
-
namespace Internal
{
-
class Scrollable;
typedef IntrusivePtr<Scrollable> ScrollablePtr;
class Scrollable : public Control
{
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
* 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)
* @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.
/**
* @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;
+
+ /**
+ * 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 EnableScrollComponent functionality for overshoot
+ * 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()
*/
* @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
* @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] 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;
/**
* @brief Construct a new Scrollable.
*
* @param[in] behaviourFlags Flags to enable
*/
- Scrollable( ControlBehaviour behaviourFlags );
+ Scrollable(ControlBehaviour behaviourFlags);
/**
* A reference counted object may only be deleted by calling Unreference()
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; ///<The color of the overshoot bouncing effect
+ float mOvershootAnimationSpeed; ///<The speed of the overshoot animation (pixels per second)
+ Vector2 mOvershootSize; ///<The size of the overshoot effect
- Vector4 mOvershootEffectColor; ///<The color of the overshoot bouncing effect
- float mOvershootAnimationSpeed; ///<The speed of the overshoot animation (pixels per second)
-
- std::map<Toolkit::Scrollable::ScrollComponentType, ScrollComponentPtr> 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<Toolkit::Scrollable::ScrollComponentType, ScrollComponentPtr> ComponentContainer;
- typedef ComponentContainer::iterator ComponentIter;
-
- ComponentContainer mComponents; ///< ScrollComponent (such as a scrollbar/page indicator/status)
- bool mOvershootEnabled:1;
+ bool mOvershootEnabled : 1;
};
} // namespace Internal
} // namespace Dali
-#endif // __DALI_TOOLKIT_INTERNAL_SCROLLABLE_H__
+#endif // DALI_TOOLKIT_INTERNAL_SCROLLABLE_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff