Tizen Native API
3.0
|
Base class for derived Scrollables that contains actors that can be scrolled manually (via touch) or automatically. More...
![](classDali_1_1Toolkit_1_1Scrollable.png)
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. | |
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) |
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. | |
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) |
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:
- 2.4, DALi version 1.0.0
Member Typedef Documentation
typedef Signal< void ( const Vector2& ) > Dali::Toolkit::Scrollable::ScrollCompletedSignalType |
ScrollCompleted signal type.
- Since:
- 2.4, DALi version 1.0.0
typedef Signal< void ( const Vector2& ) > Dali::Toolkit::Scrollable::ScrollStartedSignalType |
ScrollStarted signal type.
- Since:
- 2.4, DALi version 1.0.0
typedef Signal< void ( const Vector2& ) > Dali::Toolkit::Scrollable::ScrollUpdatedSignalType |
Scroll updated signal type.
- Since:
- 2.4, DALi version 1.0.0
Member Enumeration Documentation
Enumeration for the start and end property ranges for this control.
- Since:
- 2.4, DALi version 1.0.0
- Enumerator:
Reimplemented from Dali::Toolkit::Control.
Reimplemented in Dali::Toolkit::ScrollView, and Dali::Toolkit::ItemView.
Constructor & Destructor Documentation
Creates an uninitialized Scrollable handle.
- Since:
- 2.4, DALi version 1.0.0
Dali::Toolkit::Scrollable::Scrollable | ( | const Scrollable & | handle | ) |
Copy constructor.
Creates another handle that points to the same real object.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
handle to copy from
Destructor.
This is non-virtual since derived Handle types must not contain data or virtual methods.
- Since:
- 2.4, DALi version 1.0.0
Member Function Documentation
static Scrollable Dali::Toolkit::Scrollable::DownCast | ( | BaseHandle | handle | ) | [static] |
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:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] handle Handle 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 |
Gets the speed of overshoot animation in pixels per second.
- Since:
- 2.4, DALi version 1.0.0
- Returns:
- The speed of the overshoot animation
Gets the color of the overshoot effect.
- Since:
- 2.4, DALi version 1.0.0
- 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, 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:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] handle Handle 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:
- 2.4, 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:
- 2.4, 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:
- 2.4, DALi version 1.0.0
- Returns:
- The signal to connect to
- Precondition:
- The Object has been initialized.
void Dali::Toolkit::Scrollable::SetOvershootAnimationSpeed | ( | float | pixelsPerSecond | ) |
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:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] pixelsPerSecond The speed of the overshoot animation
void Dali::Toolkit::Scrollable::SetOvershootEffectColor | ( | const Vector4 & | color | ) |
Sets the color of the overshoot effect.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] color The color of the overshoot effect
void Dali::Toolkit::Scrollable::SetOvershootEnabled | ( | bool | enable | ) |
Sets whether to enables or disable scroll overshoot.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] enable Whether to enable the scroll overshoot or not