Scroll View

---

ScrollView class provides scrollable view which contains actors and can be scrolled automatically or manually by panning.

Classes
class	Dali::Toolkit::ScrollViewEffect
	ScrollView Effect base class, used to apply custom effects to a ScrollView instance. More...
class	Dali::Toolkit::ScrollViewPagePathEffect
	ScrollView Page Path Effect. More...
struct	Dali::Toolkit::ClampState2D
	A 2 dimensional clamp. More...
class	Dali::Toolkit::RulerDomain
	Used for specifying minimum/maximum extents of a ruler. More...
class	Dali::Toolkit::Ruler
	Abstracts class to define scroll axes. More...
class	Dali::Toolkit::DefaultRuler
	Concrete implementation of Ruler that has no snapping and has one single page. More...
class	Dali::Toolkit::FixedRuler
	Concrete implementation of Ruler that has fixed snapping. More...
class	Dali::Toolkit::ScrollView
	ScrollView contains actors that can be scrolled manually (via touch) or automatically. More...
Functions
DALI_TOOLKIT_API void	Dali::Toolkit::MoveActorConstraint (Vector3 &current, const PropertyInputContainer &inputs)
	Moves an Actor in accordance with the scroll position.
DALI_TOOLKIT_API void	Dali::Toolkit::WrapActorConstraint (Vector3 &position, const PropertyInputContainer &inputs)
	Wraps an Actor's position in accordance with the min/max bounds of domain.
Namespaces
namespace	Dali::Toolkit::ScrollMode
	Properties to use in a Property::MAP when setting a ScrollView's scroll mode.
Enumerations
enum	Dali::Toolkit::ClampState
	Enumeration for how axes/rotation or scale are clamped. More...
enum	Dali::Toolkit::SnapType
	Enumeration for the snap type. More...
enum	Dali::Toolkit::DirectionBias
	Enumeration for DirectionBias types. More...
Typedefs
typedef IntrusivePtr< Ruler >	Dali::Toolkit::RulerPtr
	Pointer to Dali::Toolkit::Ruler object.

---

Typedef Documentation

typedef IntrusivePtr<Ruler> Dali::Toolkit::RulerPtr

Pointer to Dali::Toolkit::Ruler object.

Since:

2.4, DALi version 1.0.0

---

Enumeration Type Documentation

enum Dali::Toolkit::ClampState

Enumeration for how axes/rotation or scale are clamped.

Since:

2.4, DALi version 1.0.0

Enumerator:

NotClamped	The quantity isn't clamped. Since: 2.4, DALi version 1.0.0
ClampedToMin	The quantity is clamped to the min value. Since: 2.4, DALi version 1.0.0
ClampedToMax	The quantity is clamped to the max value. Since: 2.4, DALi version 1.0.0

enum Dali::Toolkit::DirectionBias

Enumeration for DirectionBias types.

Since:

2.4, DALi version 1.0.0

Enumerator:

DirectionBiasLeft	Bias scroll snap to Left. Since: 2.4, DALi version 1.0.0
DirectionBiasNone	Don't bias scroll snap. Since: 2.4, DALi version 1.0.0
DirectionBiasRight	Bias scroll snap to Right. Since: 2.4, DALi version 1.0.0

enum Dali::Toolkit::SnapType

Enumeration for the snap type.

Since:

2.4, DALi version 1.0.0

Enumerator:

Snap	Snap. Since: 2.4, DALi version 1.0.0
Flick	Flick. Since: 2.4, DALi version 1.0.0

---

Function Documentation

DALI_TOOLKIT_API void Dali::Toolkit::MoveActorConstraint	(	Vector3 &	current,
		const PropertyInputContainer &	inputs
	)

Moves an Actor in accordance with the scroll position.

Useful constraints to apply to a ScrollView.

Since:

2.4, DALi version 1.0.0

Parameters:

[in]	current	Current position
[in]	inputs	The position input that Actor will move

DALI_TOOLKIT_API void Dali::Toolkit::WrapActorConstraint	(	Vector3 &	position,
		const PropertyInputContainer &	inputs
	)

Wraps an Actor's position in accordance with the min/max bounds of domain.

Since:

2.4, DALi version 1.0.0

Parameters:

[in]	position	Position to be wrapped
[in]	inputs	The input that Actor's position will be wrapped