#ifndef __DALI_TOOLKIT_INTERNAL_SCROLLABLE_H__
#define __DALI_TOOLKIT_INTERNAL_SCROLLABLE_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.
-//
+/*
+ * Copyright (c) 2014 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.
+ *
+ */
-// INTERNAL INCLUDES
-#include <dali/dali.h>
+// EXTERNAL INCLUDES
+#include <dali/public-api/animation/alpha-function.h>
+// INTERNAL INCLUDES
#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
{
/**
* @copydoc Toolkit::Scrollable
*/
-class Scrollable : public ControlImpl
+class Scrollable : public Control
{
public:
- static const std::string SCROLLABLE_CAN_SCROLL_VERTICAL;
- static const std::string 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
* 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;
+
+ /**
+ * Retrieve the color of the overshoot effect.
+ * @return The color of the overshoot effect.
+ */
+ Vector4 GetOvershootEffectColor() const;
+
+ /**
+ * @copydoc Dali::Toolkit::Scrollable::SetOvershootAnimationSpeed(float pixelsPerSecond)
+ */
+ void SetOvershootAnimationSpeed( float pixelsPerSecond );
+
+ /**
+ * @copydoc Dali::Toolkit::Scrollable::GetOvershootAnimationSpeed()
+ */
+ float GetOvershootAnimationSpeed() const;
+
+ /**
+ * @copydoc Dali::Toolkit::Scrollable::GetOvershootSize()
+ */
+ const Vector2& GetOvershootSize() const;
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()
*/
- Toolkit::Scrollable::ScrollStartedSignalV2& ScrollStartedSignal();
+ Toolkit::Scrollable::ScrollStartedSignalType& ScrollStartedSignal();
/**
* @copydoc Dali::Toolkit::Scrollable::ScrollUpdatedSignal()
*/
- Toolkit::Scrollable::ScrollUpdatedSignalV2& ScrollUpdatedSignal();
+ Toolkit::Scrollable::ScrollUpdatedSignalType& ScrollUpdatedSignal();
/**
* @copydoc Dali::Toolkit::Scrollable::ScrollCompletedSignal()
*/
- Toolkit::Scrollable::ScrollCompletedSignalV2& ScrollCompletedSignal();
-
- /**
- * @copydoc Dali::Toolkit::Scrollable::ScrollClampedSignal()
- */
- Toolkit::Scrollable::ScrollClampedSignalV2& ScrollClampedSignal();
+ Toolkit::Scrollable::ScrollCompletedSignalType& ScrollCompletedSignal();
/**
* Connects a callback function with the object's signals.
*/
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 );
+
protected:
/**
Scrollable();
/**
- * 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:
*
* @return The current position
*/
- Vector3 GetPropertyPosition() const;
+ Vector2 GetPropertyPosition() const;
private:
// 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:
- Property::Index mPropertyRelativePosition;///< Scroll Relative Position ("scroll-relative-position") [range from 0.0f - 1.0f in each axes]
- Property::Index mPropertyPositionMin; ///< Scroll Domain Minimum ("position-min")
- Property::Index mPropertyPositionMax; ///< Scroll Domain Maximum ("position-max")
- Property::Index mPropertyScrollDirection; ///< Scroll direction ("scroll-direction")
- Property::Index mPropertyCanScrollVertical; ///< Whether the current scroll domain is large enough to scroll vertically
- Property::Index mPropertyCanScrollHorizontal; ///< Whether the current scroll domain is large enough to scroll horizontally
+ 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
- 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::ScrollStartedSignalV2 mScrollStartedSignalV2;
- Toolkit::Scrollable::ScrollUpdatedSignalV2 mScrollUpdatedSignalV2;
- Toolkit::Scrollable::ScrollCompletedSignalV2 mScrollCompletedSignalV2;
- Toolkit::Scrollable::ScrollClampedSignalV2 mScrollClampedSignalV2;
+ 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;
+ bool mOvershootEnabled:1;
};
} // namespace Internal
projects / platform / core / uifw / dali-toolkit.git / blobdiff