ScrollBar is a UI component that can be linked to the scrollable objects indicating the current scroll position of the scrollable object. More...

Inheritance diagram for Dali::Toolkit::ScrollBar:

Classes
struct	Property
	Enumeration for the instance of properties belonging to the ScrollBar class. More...
Public Types
enum	PropertyRange
	Enumeration for the start and end property ranges for this control. More...
enum	Direction
	Direction. More...
enum	IndicatorHeightPolicy
	Indicator height policy. More...
Public Member Functions
	ScrollBar ()
	Creates an uninitialized ScrollBar; this can be initialized with ScrollBar::New() Calling member functions with an uninitialized Dali::Object is not allowed.
	ScrollBar (const ScrollBar &scrollBar)
	Copy constructor.
ScrollBar &	operator= (const ScrollBar &scrollBar)
	Assignment operator.
	~ScrollBar ()
	Destructor.
void	SetScrollPropertySource (Handle handle, Dali::Property::Index propertyScrollPosition, Dali::Property::Index propertyMinScrollPosition, Dali::Property::Index propertyMaxScrollPosition, Dali::Property::Index propertyScrollContentSize)
	Sets the source of the scroll position properties.
void	SetScrollIndicator (Actor indicator)
	Sets the indicator of scroll bar.
Actor	GetScrollIndicator ()
	Gets the indicator of scroll bar.
void	SetScrollPositionIntervals (const Dali::Vector< float > &positions)
	Sets the list of values to get notification when the current scroll position of the scrollable object goes above or below any of these values.
Dali::Vector< float >	GetScrollPositionIntervals () const
	Gets the list of values to receive notifications when the current scroll position of the scrollable object goes above or below any of these values.
void	SetScrollDirection (Direction direction)
	Sets the direction of scroll bar to scroll either vertically or horizontally.
Direction	GetScrollDirection () const
	Gets the direction of scroll bar.
void	SetIndicatorHeightPolicy (IndicatorHeightPolicy policy)
	Sets the height policy of scroll indicator to have either variable or fixed height.
IndicatorHeightPolicy	GetIndicatorHeightPolicy () const
	Gets the height policy of scroll indicator.
void	SetIndicatorFixedHeight (float height)
	Sets the fixed height of scroll indicator.
float	GetIndicatorFixedHeight () const
	Gets the fix height of scroll indicator.
void	SetIndicatorShowDuration (float durationSeconds)
	Sets the duration in seconds for the scroll indicator to become fully visible.
float	GetIndicatorShowDuration () const
	Gets the duration in seconds for the scroll indicator to become fully visible.
void	SetIndicatorHideDuration (float durationSeconds)
	Sets the duration in seconds for the scroll indicator to become fully invisible.
float	GetIndicatorHideDuration () const
	Gets the duration in seconds for the scroll indicator to become fully invisible.
void	ShowIndicator ()
	Shows the scroll indicator.
void	HideIndicator ()
	Hides the scroll indicator.
ScrollBar::PanFinishedSignalType &	PanFinishedSignal ()
	Signal emitted when panning is finished on the scroll indicator.
ScrollBar::ScrollPositionIntervalReachedSignalType &	ScrollPositionIntervalReachedSignal ()
	Signal emitted when the current scroll position of the scrollable content goes above or below the values specified by SCROLL_POSITION_INTERVALS property.
Static Public Member Functions
static ScrollBar	New (Direction direction=Vertical)
	Creates an initialized ScrollBar.
static ScrollBar	DownCast (BaseHandle handle)
	Downcasts a handle to ScrollBar handle.

Detailed Description

ScrollBar is a UI component that can be linked to the scrollable objects indicating the current scroll position of the scrollable object.

Signals | Signal Name | Method | |-------------------------------|--------------------------------------------| | panFinished | PanFinishedSignal() | | scrollPositionIntervalReached | ScrollPositionIntervalReachedSignal() |

Since:: 3.0, DALi version 1.0.0

Member Enumeration Documentation

enum Dali::Toolkit::ScrollBar::Direction

Direction.

Since:: 3.0, DALi version 1.0.0

Enumerator:

Vertical

Scroll in the vertical direction.

Since:: 3.0, DALi version 1.0.0

Horizontal

Scroll in the horizontal direction.

Since:: 3.0, DALi version 1.0.0

enum Dali::Toolkit::ScrollBar::IndicatorHeightPolicy

Indicator height policy.

Since:: 3.0, DALi version 1.0.0

Enumerator:

Variable

Variable height changed dynamically according to the length of scroll content.

Since:: 3.0, DALi version 1.0.0

Fixed

Fixed height regardless of the length of scroll content.

Since:: 3.0, DALi version 1.0.0

enum Dali::Toolkit::ScrollBar::PropertyRange

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

Reimplemented from Dali::Toolkit::Control.

Constructor & Destructor Documentation

Dali::Toolkit::ScrollBar::ScrollBar ( )

Creates an uninitialized ScrollBar; this can be initialized with ScrollBar::New() Calling member functions with an uninitialized Dali::Object is not allowed.

Since:: 3.0, DALi version 1.0.0

Dali::Toolkit::ScrollBar::ScrollBar ( const ScrollBar & scrollBar )

Copy constructor.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] scrollBar Handle to an object

Dali::Toolkit::ScrollBar::~ScrollBar ( )

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

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

Downcasts a handle to ScrollBar handle.

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

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] handle Handle to an object

Returns:: Handle to a ScrollBar or an uninitialized handle

Reimplemented from Dali::Toolkit::Control.

float Dali::Toolkit::ScrollBar::GetIndicatorFixedHeight ( ) const

Gets the fix height of scroll indicator.

Since:: 3.0, DALi version 1.0.0

Returns:: The fixed height of the scroll indicator

IndicatorHeightPolicy Dali::Toolkit::ScrollBar::GetIndicatorHeightPolicy ( ) const

Gets the height policy of scroll indicator.

Since:: 3.0, DALi version 1.0.0

Returns:: The height policy of scroll indicator

float Dali::Toolkit::ScrollBar::GetIndicatorHideDuration ( ) const

Gets the duration in seconds for the scroll indicator to become fully invisible.

Since:: 3.0, DALi version 1.0.0

Returns:: The duration for the scroll indicator to become fully invisible

float Dali::Toolkit::ScrollBar::GetIndicatorShowDuration ( ) const

Gets the duration in seconds for the scroll indicator to become fully visible.

Since:: 3.0, DALi version 1.0.0

Returns:: The duration for the scroll indicator to become fully visible

Direction Dali::Toolkit::ScrollBar::GetScrollDirection ( ) const

Gets the direction of scroll bar.

Since:: 3.0, DALi version 1.0.0

Returns:: The direction of scroll bar

Actor Dali::Toolkit::ScrollBar::GetScrollIndicator ( )

Gets the indicator of scroll bar.

Since:: 3.0, DALi version 1.0.0

Returns:: The indicator indicates the current scroll position of the scrollable content

Precondition:: The scroll bar actor has been initialized.

Dali::Vector<float> Dali::Toolkit::ScrollBar::GetScrollPositionIntervals ( ) const

Gets the list of values to receive notifications when the current scroll position of the scrollable object goes above or below any of these values.

Since:: 3.0, DALi version 1.0.0

Returns:: The list of values to receive notifications for when the current scroll position crosses them

Precondition:: The scroll bar actor has been initialized.

void Dali::Toolkit::ScrollBar::HideIndicator ( )

Hides the scroll indicator.

Since:: 3.0, DALi version 1.0.0

static ScrollBar Dali::Toolkit::ScrollBar::New ( Direction direction = Vertical ) [static]

Creates an initialized ScrollBar.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] direction The direction of scroll bar (either vertically or horizontally)

Returns:: A pointer to the created ScrollBar

ScrollBar& Dali::Toolkit::ScrollBar::operator= ( const ScrollBar & scrollBar )

Assignment operator.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] scrollBar Handle to an object

Returns:: A reference to this

ScrollBar::PanFinishedSignalType& Dali::Toolkit::ScrollBar::PanFinishedSignal ( )

Signal emitted when panning is finished on the scroll indicator.

Signal only emitted when the source of the scroll position properties are set.

A callback of the following type may be connected:

   void YourCallbackName();

Since:: 3.0, DALi version 1.0.0

Returns:: The signal to connect to

Precondition:: The Object has been initialized.

ScrollBar::ScrollPositionIntervalReachedSignalType& Dali::Toolkit::ScrollBar::ScrollPositionIntervalReachedSignal ( )

Signal emitted when the current scroll position of the scrollable content goes above or below the values specified by SCROLL_POSITION_INTERVALS property.

Signal only emitted when the source of the scroll position properties are set.

A callback of the following type may be connected:

   void YourCallbackName(float currentScrollPosition);

Since:: 3.0, DALi version 1.0.0

Returns:: The signal to connect to

Precondition:: The Object has been initialized.

void Dali::Toolkit::ScrollBar::SetIndicatorFixedHeight ( float height )

Sets the fixed height of scroll indicator.

Normally the height of scroll indicator is changed dynamically according to the length of scroll content. However, when the height policy of scroll indicator is set to be fixed, the height will be kept fixed regardless of the length of scroll content.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] height The fixed height of the scroll indicator

Precondition:: The scroll bar actor has been initialized.

void Dali::Toolkit::ScrollBar::SetIndicatorHeightPolicy ( IndicatorHeightPolicy policy )

Sets the height policy of scroll indicator to have either variable or fixed height.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] policy The height policy of scroll indicator

Precondition:: The scroll bar actor has been initialized.

void Dali::Toolkit::ScrollBar::SetIndicatorHideDuration ( float durationSeconds )

Sets the duration in seconds for the scroll indicator to become fully invisible.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] durationSeconds The duration for the scroll indicator to become fully invisible

Precondition:: The scroll bar actor has been initialised; durationSeconds must be zero or greater; zero means the indicator will be hidden instantly.

void Dali::Toolkit::ScrollBar::SetIndicatorShowDuration ( float durationSeconds )

Sets the duration in seconds for the scroll indicator to become fully visible.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] durationSeconds The duration for the scroll indicator to become fully visible

Precondition:: The scroll bar actor has been initialised; durationSeconds must be zero or greater; zero means the indicator will be shown instantly.

void Dali::Toolkit::ScrollBar::SetScrollDirection ( Direction direction )

Sets the direction of scroll bar to scroll either vertically or horizontally.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] direction The direction of scroll bar (either vertically or horizontally)

Precondition:: The scroll bar actor has been initialized.

void Dali::Toolkit::ScrollBar::SetScrollIndicator ( Actor indicator )

Sets the indicator of scroll bar.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] indicator The indicator that moves to indicate the current scroll position

Precondition:: The scroll bar actor has been initialized.

void Dali::Toolkit::ScrollBar::SetScrollPositionIntervals ( const Dali::Vector< float > & positions )

Sets the list of values to get notification when the current scroll position of the scrollable object goes above or below any of these values.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in] positions List of values to receive notifications for when the current scroll position crosses them

Precondition:: The scroll bar actor has been initialized.

void Dali::Toolkit::ScrollBar::SetScrollPropertySource	(	Handle	handle,
		Dali::Property::Index	propertyScrollPosition,
		Dali::Property::Index	propertyMinScrollPosition,
		Dali::Property::Index	propertyMaxScrollPosition,
		Dali::Property::Index	propertyScrollContentSize
	)

Sets the source of the scroll position properties.

Since:: 3.0, DALi version 1.0.0

Parameters:

[in]	handle	The handle of the object owing the scroll properties
[in]	propertyScrollPosition	The index of the scroll position property (The scroll position, type float)
[in]	propertyMinScrollPosition	The index of the minimum scroll position property (The minimum scroll position, type float)
[in]	propertyMaxScrollPosition	The index of the maximum scroll position property (The maximum scroll position, type float)
[in]	propertyScrollContentSize	The index of the scroll content size property (The size of the scrollable content in actor coordinates, type float)

Precondition:: The handle to the object owing the scroll properties has been initialised and the property index must be valid.

void Dali::Toolkit::ScrollBar::ShowIndicator ( )

Shows the scroll indicator.

Since:: 3.0, DALi version 1.0.0

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation