Tizen Native API  4.0

Base class for derived Scrollables that contains actors that can be scrolled manually (via touch) or automatically. More...

Inheritance diagram for Dali::Toolkit::Scrollable:
Dali::Toolkit::Control Dali::CustomActor Dali::Actor Dali::Handle Dali::BaseHandle Dali::Toolkit::ItemView Dali::Toolkit::ScrollView

Classes

struct  Property
 Enumeration for the instance of properties belonging to the Scrollable class. More...

Public Types

enum  PropertyRange
 Enumeration for the start and end property ranges for this control. More...
typedef Signal< void(const
Vector2 &) > 
ScrollStartedSignalType
 ScrollStarted signal type.
typedef Signal< void(const
Vector2 &) > 
ScrollCompletedSignalType
 ScrollCompleted signal type.
typedef Signal< void(const
Vector2 &) > 
ScrollUpdatedSignalType
 Scroll updated signal type.

Public Member Functions

 Scrollable ()
 Creates an uninitialized Scrollable handle.
 Scrollable (const Scrollable &handle)
 Copy constructor.
Scrollableoperator= (const Scrollable &handle)
 Assignment operator.
 ~Scrollable ()
 Destructor.
bool IsOvershootEnabled () const
 Checks if scroll overshoot has been enabled or not.
void SetOvershootEnabled (bool enable)
 Sets whether to enables or disable scroll overshoot.
void SetOvershootEffectColor (const Vector4 &color)
 Sets the color of the overshoot effect.
Vector4 GetOvershootEffectColor () const
 Gets the color of the overshoot effect.
void SetOvershootAnimationSpeed (float pixelsPerSecond)
 Sets the speed of overshoot animation in pixels per second.
float GetOvershootAnimationSpeed () const
 Gets the speed of overshoot animation in pixels per second.
ScrollStartedSignalTypeScrollStartedSignal ()
 Signal emitted when the Scrollable has moved (whether by touch or animation).
ScrollUpdatedSignalTypeScrollUpdatedSignal ()
 Signal emitted when the Scrollable has moved (whether by touch or animation).
ScrollCompletedSignalTypeScrollCompletedSignal ()
 Signal emitted when the Scrollable has completed movement (whether by touch or animation).

Static Public Member Functions

static Scrollable DownCast (BaseHandle handle)
 Downcasts a handle to Scrollable handle.

Detailed Description

Base class for derived Scrollables that contains actors that can be scrolled manually (via touch) or automatically.

Scrollables such as ScrollView and ItemView can be derived from this class.

Signals | Signal Name | Method | |------------------|------------------------------| | scrollStarted | ScrollStartedSignal() | | scrollCompleted | ScrollCompletedSignal() | | scrollUpdated | ScrollUpdatedSignal() |

Since:
3.0, DALi version 1.0.0

Member Typedef Documentation

ScrollCompleted signal type.

Since:
3.0, DALi version 1.0.0

ScrollStarted signal type.

Since:
3.0, DALi version 1.0.0

Scroll updated signal type.

Since:
3.0, DALi version 1.0.0

Member Enumeration Documentation

Enumeration for the start and end property ranges for this control.

Since:
3.0, DALi version 1.0.0
Enumerator:
PROPERTY_START_INDEX 
Since:
3.0, DALi version 1.0.0
PROPERTY_END_INDEX 

Reserve property indices.

Since:
3.0, DALi version 1.0.0
ANIMATABLE_PROPERTY_END_INDEX 

Reserve animatable property indices.

Since:
3.0, DALi version 1.0.0

Reimplemented from Dali::Toolkit::Control.

Reimplemented in Dali::Toolkit::ScrollView, and Dali::Toolkit::ItemView.


Constructor & Destructor Documentation

Creates an uninitialized Scrollable handle.

Since:
3.0, DALi version 1.0.0

Copy constructor.

Creates another handle that points to the same real object.

Since:
3.0, DALi version 1.0.0
Parameters:
handleto copy from

Destructor.

This is non-virtual since derived Handle types must not contain data or virtual methods.

Since:
3.0, DALi version 1.0.0

Member Function Documentation

Downcasts a handle to Scrollable handle.

If handle points to a Scrollable, the downcast produces valid handle. If not, the returned handle is left uninitialized.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]handleHandle to an object
Returns:
A handle to a Scrollable or an uninitialized handle

Reimplemented from Dali::Toolkit::Control.

Reimplemented in Dali::Toolkit::ScrollView, and Dali::Toolkit::ItemView.

Gets the speed of overshoot animation in pixels per second.

Since:
3.0, DALi version 1.0.0
Returns:
The speed of the overshoot animation

Gets the color of the overshoot effect.

Since:
3.0, DALi version 1.0.0
Returns:
The color of the overshoot effect

Checks if scroll overshoot has been enabled or not.

Since:
3.0, DALi version 1.0.0
Returns:
Whether the scroll overshoot is enabled
Scrollable& Dali::Toolkit::Scrollable::operator= ( const Scrollable handle)

Assignment operator.

Changes this handle to point to another real object.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]handleHandle to copy from
Returns:
A reference to this

Signal emitted when the Scrollable has completed movement (whether by touch or animation).

A callback of the following type may be connected:

   void YourCallbackName(const Vector2& currentScrollPosition);
Since:
3.0, DALi version 1.0.0
Returns:
The signal to connect to
Precondition:
The Object has been initialized.

Signal emitted when the Scrollable has moved (whether by touch or animation).

A callback of the following type may be connected:

   void YourCallbackName(const Vector2& currentScrollPosition);
Since:
3.0, DALi version 1.0.0
Returns:
The signal to connect to
Precondition:
The Object has been initialized.

Signal emitted when the Scrollable has moved (whether by touch or animation).

A callback of the following type may be connected:

   void YourCallbackName(const Vector2& currentScrollPosition);
Since:
3.0, DALi version 1.0.0
Returns:
The signal to connect to
Precondition:
The Object has been initialized.

Sets the speed of overshoot animation in pixels per second.

When the speed is not greater than 0, the overshoot is set instantly with no animation.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]pixelsPerSecondThe speed of the overshoot animation

Sets the color of the overshoot effect.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]colorThe color of the overshoot effect

Sets whether to enables or disable scroll overshoot.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]enableWhether to enable the scroll overshoot or not