Tizen Native API
Classes | Public Types | Public Member Functions | Static Public Member Functions
Dali::Toolkit::Scrollable Class Reference
Scrollable

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
 An enumeration of properties belonging to the Scrollable class. More...

Public Types

enum  PropertyRange
 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.
Scrollable & operator= (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)
 Set the color of the overshoot effect.
Vector4 GetOvershootEffectColor () const
 Get the color of the overshoot effect.
void SetOvershootAnimationSpeed (float pixelsPerSecond)
 Set the speed of overshoot animation in pixels per second.
float GetOvershootAnimationSpeed () const
 Get the speed of overshoot animation in pixels per second.
ScrollStartedSignalType & ScrollStartedSignal ()
 Signal emitted when the Scrollable has moved (whether by touch or animation).
ScrollUpdatedSignalType & ScrollUpdatedSignal ()
 Signal emitted when the Scrollable has moved (whether by touch or animation).
ScrollCompletedSignalType & ScrollCompletedSignal ()
 Signal emitted when the Scrollable has completed movement (whether by touch or animation).

Static Public Member Functions

static Scrollable DownCast (BaseHandle handle)
 Downcast 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.

Since :
2.4

Member Typedef Documentation

typedef Signal< void ( const Vector2& ) > Dali::Toolkit::Scrollable::ScrollCompletedSignalType

ScrollCompleted signal type.

Since :
2.4
typedef Signal< void ( const Vector2& ) > Dali::Toolkit::Scrollable::ScrollStartedSignalType

ScrollStarted signal type.

Since :
2.4
typedef Signal< void ( const Vector2& ) > Dali::Toolkit::Scrollable::ScrollUpdatedSignalType

Scroll updated signal type.

Since :
2.4

Member Enumeration Documentation

enum Dali::Toolkit::Scrollable::PropertyRange

The start and end property ranges for this control.

Since :
2.4
Enumerator:
PROPERTY_END_INDEX 

Reserve property indices.

Since :
2.4
ANIMATABLE_PROPERTY_END_INDEX 

Reserve animatable property indices.

Since :
2.4

Reimplemented from Dali::Toolkit::Control.

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

Constructor & Destructor Documentation

Dali::Toolkit::Scrollable::Scrollable ( )

Creates an uninitialized Scrollable handle.

Since :
2.4
Dali::Toolkit::Scrollable::Scrollable ( const Scrollable &  handle)

Copy constructor.

Creates another handle that points to the same real object.

Since :
2.4
Parameters:
handleto copy from
Dali::Toolkit::Scrollable::~Scrollable ( )

Destructor.

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

Since :
2.4

Member Function Documentation

static Scrollable Dali::Toolkit::Scrollable::DownCast ( BaseHandle  handle) [static]

Downcast 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 :
2.4
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.

float Dali::Toolkit::Scrollable::GetOvershootAnimationSpeed ( ) const

Get the speed of overshoot animation in pixels per second.

Since :
2.4
Returns:
The speed of the overshoot animation
Vector4 Dali::Toolkit::Scrollable::GetOvershootEffectColor ( ) const

Get the color of the overshoot effect.

Since :
2.4
Returns:
The color of the overshoot effect
bool Dali::Toolkit::Scrollable::IsOvershootEnabled ( ) const

Checks if scroll overshoot has been enabled or not.

Since :
2.4
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 :
2.4
Parameters:
[in]handleto copy from
Returns:
A reference to this
ScrollCompletedSignalType& Dali::Toolkit::Scrollable::ScrollCompletedSignal ( )

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 :
2.4
Returns:
The signal to connect to
Precondition:
The Object has been initialized.
ScrollStartedSignalType& Dali::Toolkit::Scrollable::ScrollStartedSignal ( )

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 :
2.4
Returns:
The signal to connect to
Precondition:
The Object has been initialized.
ScrollUpdatedSignalType& Dali::Toolkit::Scrollable::ScrollUpdatedSignal ( )

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 :
2.4
Returns:
The signal to connect to
Precondition:
The Object has been initialized.
void Dali::Toolkit::Scrollable::SetOvershootAnimationSpeed ( float  pixelsPerSecond)

Set 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 :
2.4
Parameters:
[in]pixelsPerSecondThe speed of the overshoot animation
void Dali::Toolkit::Scrollable::SetOvershootEffectColor ( const Vector4 &  color)

Set the color of the overshoot effect.

Since :
2.4
Parameters:
[in]colorThe color of the overshoot effect
void Dali::Toolkit::Scrollable::SetOvershootEnabled ( bool  enable)

Sets whether to enables or disable scroll overshoot.

Since :
2.4
Parameters:
[in]enableWhether to enable the scroll overshoot or not