Dali 3D User Interface Engine
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions
Dali::Toolkit::ScrollView Class Reference

ScrollView contains actors that can be scrolled manually (via touch) or automatically. More...

#include <scroll-view.h>

Inheritance diagram for Dali::Toolkit::ScrollView:
Inheritance graph
[legend]
Collaboration diagram for Dali::Toolkit::ScrollView:
Collaboration graph
[legend]

Classes

struct  ClampEvent
 Clamp signal event's data .0. More...
 
struct  Property
 An enumeration of properties belonging to the ScrollView class. More...
 
struct  SnapEvent
 Snap signal event's data. More...
 

Public Types

enum  PropertyRange { PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1, PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ANIMATABLE_PROPERTY_START_INDEX = Toolkit::Scrollable::ANIMATABLE_PROPERTY_END_INDEX + 1, ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_START_INDEX + 1000 }
 The start and end property ranges for this control. More...
 
typedef Signal< void(const
SnapEvent &) > 
SnapStartedSignalType
 SnapStarted signal type .0. More...
 
- Public Types inherited from Dali::Toolkit::Scrollable
enum  PropertyRange { PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 }
 The start and end property ranges for this control. More...
 
typedef Signal< void(const
Vector2 &) > 
ScrollStartedSignalType
 ScrollStarted signal type .0. More...
 
typedef Signal< void(const
Vector2 &) > 
ScrollCompletedSignalType
 ScrollCompleted signal type .0. More...
 
typedef Signal< void(const
Vector2 &) > 
ScrollUpdatedSignalType
 Scroll updated signal type .0. More...
 
- Public Types inherited from Dali::Toolkit::Control
enum  PropertyRange { PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX, CONTROL_PROPERTY_START_INDEX = PROPERTY_START_INDEX, CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 }
 The start and end property ranges for control. More...
 
typedef Signal< bool(Control,
const KeyEvent &) > 
KeyEventSignalType
 Key Event signal type;. More...
 
typedef Signal< void(Control) > KeyInputFocusSignalType
 Key InputFocusType signal type;. More...
 

Public Member Functions

 ScrollView ()
 Creates an empty ScrollView handle. More...
 
 ScrollView (const ScrollView &handle)
 Copy constructor. More...
 
ScrollViewoperator= (const ScrollView &handle)
 Assignment operator. More...
 
 ~ScrollView ()
 Destructor. More...
 
AlphaFunction GetScrollSnapAlphaFunction () const
 Get snap-animation's AlphaFunction. More...
 
void SetScrollSnapAlphaFunction (AlphaFunction alpha)
 Set snap-animation's AlphaFunction. More...
 
AlphaFunction GetScrollFlickAlphaFunction () const
 Get flick-animation's AlphaFunction. More...
 
void SetScrollFlickAlphaFunction (AlphaFunction alpha)
 Set flick-animation's AlphaFunction. More...
 
float GetScrollSnapDuration () const
 Gets the time for the scroll snap-animation. More...
 
void SetScrollSnapDuration (float time)
 Sets the time for the scroll snap-animation. More...
 
float GetScrollFlickDuration () const
 Gets the time for the scroll flick-animation. More...
 
void SetScrollFlickDuration (float time)
 Sets the time for the scroll flick-animation. More...
 
void SetRulerX (RulerPtr ruler)
 Set X axis ruler. More...
 
void SetRulerY (RulerPtr ruler)
 Set Y axis ruler. More...
 
void SetScrollSensitive (bool sensitive)
 Set scroll sensibility of pan gesture. More...
 
void SetMaxOvershoot (float overshootX, float overshootY)
 Set maximum overshoot amount. More...
 
void SetSnapOvershootAlphaFunction (AlphaFunction alpha)
 Set Snap Overshoot animation's AlphaFunction. More...
 
void SetSnapOvershootDuration (float duration)
 Set Snap Overshoot animation's Duration. More...
 
void SetActorAutoSnap (bool enable)
 Enables or Disables Actor Auto-Snap mode. More...
 
void SetWrapMode (bool enable)
 Enables or Disables Wrap mode for ScrollView contents. More...
 
int GetScrollUpdateDistance () const
 Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted. More...
 
void SetScrollUpdateDistance (int distance)
 Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted. More...
 
bool GetAxisAutoLock () const
 Returns state of Axis Auto Lock mode. More...
 
void SetAxisAutoLock (bool enable)
 Enables or Disables Axis Auto Lock mode for panning within the ScrollView. More...
 
float GetAxisAutoLockGradient () const
 Gets the gradient threshold at which a panning gesture should be locked to the Horizontal or Vertical axis. More...
 
void SetAxisAutoLockGradient (float gradient)
 Sets the gradient threshold at which a panning gesture should be locked to the Horizontal or Vertical axis. More...
 
float GetFrictionCoefficient () const
 Gets the friction coefficient setting for ScrollView when flicking in free panning mode. More...
 
void SetFrictionCoefficient (float friction)
 Sets the friction coefficient for ScrollView when flicking in free panning mode. More...
 
float GetFlickSpeedCoefficient () const
 Gets the flick speed coefficient for ScrollView when flicking in free panning mode. More...
 
void SetFlickSpeedCoefficient (float speed)
 Sets the flick speed coefficient for ScrollView when flicking in free panning mode. More...
 
Vector2 GetMinimumDistanceForFlick () const
 Returns the minimum pan distance required for a flick gesture in pixels. More...
 
void SetMinimumDistanceForFlick (const Vector2 &distance)
 Sets the minimum pan distance required for a flick in pixels. More...
 
float GetMinimumSpeedForFlick () const
 Returns the minimum pan speed required for a flick gesture in pixels per second. More...
 
void SetMinimumSpeedForFlick (float speed)
 Sets the minimum pan speed required for a flick in pixels per second. More...
 
float GetMaxFlickSpeed () const
 Gets the maximum flick speed setting for ScrollView when flicking in free panning mode. More...
 
void SetMaxFlickSpeed (float speed)
 Sets the maximum flick speed for the ScrollView when flicking in free panning mode. More...
 
Vector2 GetWheelScrollDistanceStep () const
 Gets the step of scroll distance in actor coordinates for each wheel event received in free panning mode. More...
 
void SetWheelScrollDistanceStep (Vector2 step)
 Sets the step of scroll distance in actor coordinates for each wheel event received in free panning mode. More...
 
Vector2 GetCurrentScrollPosition () const
 Retrieves current scroll position. More...
 
unsigned int GetCurrentPage () const
 Retrieves current scroll page based on ScrollView dimensions being the size of one page, and all pages laid out in a grid fashion, increasing from left to right until the end of the X-domain. More...
 
void ScrollTo (const Vector2 &position)
 Scrolls View to position specified (contents will scroll to this position). More...
 
void ScrollTo (const Vector2 &position, float duration)
 Scrolls View to position specified (contents will scroll to this position). More...
 
void ScrollTo (const Vector2 &position, float duration, AlphaFunction alpha)
 Scrolls View to position specified (contents will scroll to this position). More...
 
void ScrollTo (const Vector2 &position, float duration, DirectionBias horizontalBias, DirectionBias verticalBias)
 Scrolls View to position specified (contents will scroll to this position). More...
 
void ScrollTo (const Vector2 &position, float duration, AlphaFunction alpha, DirectionBias horizontalBias, DirectionBias verticalBias)
 Scrolls View to position specified (contents will scroll to this position). More...
 
void ScrollTo (unsigned int page)
 Scrolls View to page currently based on assumption that each page is "(page) * ScrollViewSize.width, 0". More...
 
void ScrollTo (unsigned int page, float duration)
 Scrolls View to page currently based on assumption that each page is "(page) * ScrollViewSize.width, 0". More...
 
void ScrollTo (unsigned int page, float duration, DirectionBias bias)
 Scrolls View to page currently based on assumption that each page is "(page) * ScrollViewSize.width, 0". More...
 
void ScrollTo (Actor &actor)
 Scrolls View such that actor appears in the center of the ScrollView. More...
 
void ScrollTo (Actor &actor, float duration)
 Scrolls View such that actor appears in the center of the ScrollView. More...
 
bool ScrollToSnapPoint ()
 Scrolls View to the nearest snap points as specified by the Rulers. More...
 
void ApplyConstraintToChildren (Constraint constraint)
 Applies a constraint that will affect the children of ScrollView. More...
 
void RemoveConstraintsFromChildren ()
 Removes all constraints that will affect the children of ScrollView. More...
 
void ApplyEffect (ScrollViewEffect effect)
 Apply Effect to ScrollView. More...
 
void RemoveEffect (ScrollViewEffect effect)
 Remove Effect from ScrollView. More...
 
void RemoveAllEffects ()
 Remove All Effects from ScrollView. More...
 
void BindActor (Actor child)
 Binds actor to this ScrollView. More...
 
void UnbindActor (Actor child)
 Unbind Actor from this ScrollView. More...
 
void SetScrollingDirection (Radian direction, Radian threshold=PanGestureDetector::DEFAULT_THRESHOLD)
 Allows the user to constrain the scroll view in a particular direction. More...
 
void RemoveScrollingDirection (Radian direction)
 Remove a direction constraint from the scroll view. More...
 
SnapStartedSignalTypeSnapStartedSignal ()
 Signal emitted when the ScrollView has started to snap or flick (it tells the target position, scale, rotation for the snap or flick). More...
 
DALI_INTERNAL ScrollView (Internal::ScrollView &implementation)
 Creates a handle using the Toolkit::Internal implementation. More...
 
DALI_INTERNAL ScrollView (Dali::Internal::CustomActor *internal)
 Allows the creation of this Control from an Internal::CustomActor pointer. More...
 
- Public Member Functions inherited from Dali::Toolkit::Scrollable
 Scrollable ()
 Creates an uninitialized Scrollable handle. More...
 
 Scrollable (const Scrollable &handle)
 Copy constructor. More...
 
Scrollableoperator= (const Scrollable &handle)
 Assignment operator. More...
 
 ~Scrollable ()
 Destructor. More...
 
bool IsOvershootEnabled () const
 Checks if scroll overshoot has been enabled or not. More...
 
void SetOvershootEnabled (bool enable)
 Sets whether to enables or disable scroll overshoot. More...
 
void SetOvershootEffectColor (const Vector4 &color)
 Set the color of the overshoot effect. More...
 
Vector4 GetOvershootEffectColor () const
 Get the color of the overshoot effect. More...
 
void SetOvershootAnimationSpeed (float pixelsPerSecond)
 Set the speed of overshoot animation in pixels per second. More...
 
float GetOvershootAnimationSpeed () const
 Get the speed of overshoot animation in pixels per second. More...
 
ScrollStartedSignalTypeScrollStartedSignal ()
 Signal emitted when the Scrollable has moved (whether by touch or animation). More...
 
ScrollUpdatedSignalTypeScrollUpdatedSignal ()
 Signal emitted when the Scrollable has moved (whether by touch or animation). More...
 
ScrollCompletedSignalTypeScrollCompletedSignal ()
 Signal emitted when the Scrollable has completed movement (whether by touch or animation). More...
 
DALI_INTERNAL Scrollable (Internal::Scrollable &implementation)
 Creates a handle using the Toolkit::Internal implementation. More...
 
DALI_INTERNAL Scrollable (Dali::Internal::CustomActor *internal)
 Allows the creation of this Control from an Internal::CustomActor pointer. More...
 
- Public Member Functions inherited from Dali::Toolkit::Control
 Control ()
 Create an uninitialized Control handle. More...
 
 Control (const Control &uiControl)
 Copy constructor. More...
 
 ~Control ()
 Dali::Control is intended as a base class. More...
 
Controloperator= (const Control &handle)
 Assignment operator. More...
 
void SetKeyInputFocus ()
 This sets the control to receive key events. More...
 
bool HasKeyInputFocus ()
 Quries whether the control has key input focus. More...
 
void ClearKeyInputFocus ()
 Once an actor is Set to receive key input focus this function is called to stop it receiving key events. More...
 
PinchGestureDetector GetPinchGestureDetector () const
 Retrieves the pinch gesture detector of the control. More...
 
PanGestureDetector GetPanGestureDetector () const
 Retrieves the pan gesture detector of the control. More...
 
TapGestureDetector GetTapGestureDetector () const
 Retrieves the tap gesture detector of the control. More...
 
LongPressGestureDetector GetLongPressGestureDetector () const
 Retrieves the long press gesture detector of the control. More...
 
void SetStyleName (const std::string &styleName)
 Sets the name of the style to be applied to the control. More...
 
const std::string & GetStyleName () const
 Retrieves the name of the style to be applied to the control (if any). More...
 
void SetBackgroundColor (const Vector4 &color)
 Sets the background color of the control. More...
 
Vector4 GetBackgroundColor () const
 .3 More...
 
void SetBackgroundImage (Image image)
 Sets an image as the background of the control. More...
 
void ClearBackground ()
 Clears the background. More...
 
KeyEventSignalTypeKeyEventSignal ()
 This signal is emitted when key event is received. More...
 
KeyInputFocusSignalTypeKeyInputFocusGainedSignal ()
 This signal is emitted when the control gets Key Input Focus. More...
 
KeyInputFocusSignalTypeKeyInputFocusLostSignal ()
 This signal is emitted when the control loses Key Input Focus which could be due to it being gained by another Control or Actor or just cleared from this control as no longer required. More...
 
 Control (Internal::Control &implementation)
 Create an initialised Control. More...
 
 Control (Dali::Internal::CustomActor *internal)
 This constructor is used by CustomActor within Dali core to create additional Control handles using an Internal CustomActor pointer. More...
 
template<typename I >
DALI_INTERNAL void VerifyCustomActorPointer (Dali::Internal::CustomActor *internal)
 Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an implementation of their class. More...
 
- Public Member Functions inherited from Dali::CustomActor
 CustomActor ()
 Create an uninitialized CustomActor handle. More...
 
 ~CustomActor ()
 Destructor. More...
 
CustomActorImplGetImplementation ()
 Retrieve the custom actor implementation. More...
 
const CustomActorImplGetImplementation () const
 Retrieve the custom actor implementation. More...
 
 CustomActor (CustomActorImpl &implementation)
 Create an initialised CustomActor. More...
 
 CustomActor (const CustomActor &copy)
 Copy constructor. More...
 
CustomActoroperator= (const CustomActor &rhs)
 Assignment operator. More...
 
 CustomActor (Internal::CustomActor *actor)
 This constructor is used internally to create additional CustomActor handles. More...
 
- Public Member Functions inherited from Dali::Actor
 Actor ()
 Create an uninitialized Actor; this can be initialized with Actor::New(). More...
 
 ~Actor ()
 Dali::Actor is intended as a base class. More...
 
 Actor (const Actor &copy)
 Copy constructor. More...
 
Actoroperator= (const Actor &rhs)
 Assignment operator. More...
 
const std::string & GetName () const
 Retrieve the Actor's name. More...
 
void SetName (const std::string &name)
 Sets the Actor's name. More...
 
unsigned int GetId () const
 Retrieve the unique ID of the actor. More...
 
bool IsRoot () const
 Query whether an actor is the root actor, which is owned by the Stage. More...
 
bool OnStage () const
 Query whether the actor is connected to the Stage. More...
 
bool IsLayer () const
 Query whether the actor is of class Dali::Layer. More...
 
Layer GetLayer ()
 Gets the layer in which the actor is present. More...
 
void Add (Actor child)
 Adds a child Actor to this Actor. More...
 
void Remove (Actor child)
 Removes a child Actor from this Actor. More...
 
void Unparent ()
 Removes an actor from its parent. More...
 
unsigned int GetChildCount () const
 Retrieve the number of children held by the actor. More...
 
Actor GetChildAt (unsigned int index) const
 Retrieve and child actor by index. More...
 
Actor FindChildByName (const std::string &actorName)
 Search through this actor's hierarchy for an actor with the given name. More...
 
Actor FindChildById (const unsigned int id)
 Search through this actor's hierarchy for an actor with the given unique ID. More...
 
Actor GetParent () const
 Retrieve the actor's parent. More...
 
void SetParentOrigin (const Vector3 &origin)
 Set the origin of an actor, within its parent's area. More...
 
Vector3 GetCurrentParentOrigin () const
 Retrieve the parent-origin of an actor. More...
 
void SetAnchorPoint (const Vector3 &anchorPoint)
 Set the anchor-point of an actor. More...
 
Vector3 GetCurrentAnchorPoint () const
 Retrieve the anchor-point of an actor. More...
 
void SetSize (float width, float height)
 Sets the size of an actor. More...
 
void SetSize (float width, float height, float depth)
 Sets the size of an actor. More...
 
void SetSize (const Vector2 &size)
 Sets the size of an actor. More...
 
void SetSize (const Vector3 &size)
 Sets the size of an actor. More...
 
Vector3 GetTargetSize () const
 Retrieve the actor's size. More...
 
Vector3 GetCurrentSize () const
 Retrieve the actor's size. More...
 
Vector3 GetNaturalSize () const
 Return the natural size of the actor. More...
 
void SetPosition (float x, float y)
 Sets the position of the actor. More...
 
void SetPosition (float x, float y, float z)
 Sets the position of the Actor. More...
 
void SetPosition (const Vector3 &position)
 Sets the position of the Actor. More...
 
void SetX (float x)
 Set the position of an actor along the X-axis. More...
 
void SetY (float y)
 Set the position of an actor along the Y-axis. More...
 
void SetZ (float z)
 Set the position of an actor along the Z-axis. More...
 
void TranslateBy (const Vector3 &distance)
 Translate an actor relative to its existing position. More...
 
Vector3 GetCurrentPosition () const
 Retrieve the position of the Actor. More...
 
Vector3 GetCurrentWorldPosition () const
 Retrieve the world-position of the Actor. More...
 
void SetPositionInheritanceMode (PositionInheritanceMode mode)
 Set the actors position inheritance mode. More...
 
PositionInheritanceMode GetPositionInheritanceMode () const
 Returns the actors position inheritance mode. More...
 
void SetOrientation (const Degree &angle, const Vector3 &axis)
 Sets the orientation of the Actor. More...
 
void SetOrientation (const Radian &angle, const Vector3 &axis)
 Sets the orientation of the Actor. More...
 
void SetOrientation (const Quaternion &orientation)
 Sets the orientation of the Actor. More...
 
void RotateBy (const Degree &angle, const Vector3 &axis)
 Apply a relative rotation to an actor. More...
 
void RotateBy (const Radian &angle, const Vector3 &axis)
 Apply a relative rotation to an actor. More...
 
void RotateBy (const Quaternion &relativeRotation)
 Apply a relative rotation to an actor. More...
 
Quaternion GetCurrentOrientation () const
 Retreive the Actor's orientation. More...
 
void SetInheritOrientation (bool inherit)
 Set whether a child actor inherits it's parent's orientation. More...
 
bool IsOrientationInherited () const
 Returns whether the actor inherits its parent's orientation. More...
 
Quaternion GetCurrentWorldOrientation () const
 Retrieve the world-orientation of the Actor. More...
 
void SetScale (float scale)
 Set the scale factor applied to an actor. More...
 
void SetScale (float scaleX, float scaleY, float scaleZ)
 Set the scale factor applied to an actor. More...
 
void SetScale (const Vector3 &scale)
 Set the scale factor applied to an actor. More...
 
void ScaleBy (const Vector3 &relativeScale)
 Apply a relative scale to an actor. More...
 
Vector3 GetCurrentScale () const
 Retrieve the scale factor applied to an actor. More...
 
Vector3 GetCurrentWorldScale () const
 Retrieve the world-scale of the Actor. More...
 
void SetInheritScale (bool inherit)
 Set whether a child actor inherits it's parent's scale. More...
 
bool IsScaleInherited () const
 Returns whether the actor inherits its parent's scale. More...
 
Matrix GetCurrentWorldMatrix () const
 Retrieves the world-matrix of the actor. More...
 
void SetVisible (bool visible)
 Sets the visibility flag of an actor. More...
 
bool IsVisible () const
 Retrieve the visibility flag of an actor. More...
 
void SetOpacity (float opacity)
 Sets the opacity of an actor. More...
 
float GetCurrentOpacity () const
 Retrieve the actor's opacity. More...
 
void SetColor (const Vector4 &color)
 Sets the actor's color; this is an RGBA value. More...
 
Vector4 GetCurrentColor () const
 Retrieve the actor's color. More...
 
void SetColorMode (ColorMode colorMode)
 Sets the actor's color mode. More...
 
ColorMode GetColorMode () const
 Returns the actor's color mode. More...
 
Vector4 GetCurrentWorldColor () const
 Retrieve the world-color of the Actor, where each component is clamped within the 0->1 range. More...
 
void SetDrawMode (DrawMode::Type drawMode)
 Set how the actor and its children should be drawn. More...
 
DrawMode::Type GetDrawMode () const
 Query how the actor and its children will be drawn. More...
 
void SetSensitive (bool sensitive)
 Sets whether an actor should emit touch or hover signals; see SignalTouch() and SignalHover(). More...
 
bool IsSensitive () const
 Query whether an actor emits touch or hover event signals. More...
 
bool ScreenToLocal (float &localX, float &localY, float screenX, float screenY) const
 Converts screen coordinates into the actor's coordinate system using the default camera. More...
 
void SetLeaveRequired (bool required)
 Sets whether the actor should receive a notification when touch or hover motion events leave the boundary of the actor. More...
 
bool GetLeaveRequired () const
 This returns whether the actor requires touch or hover events whenever touch or hover motion events leave the boundary of the actor. More...
 
void SetKeyboardFocusable (bool focusable)
 Sets whether the actor should be focusable by keyboard navigation. More...
 
bool IsKeyboardFocusable () const
 Returns whether the actor is focusable by keyboard navigation. More...
 
void SetResizePolicy (ResizePolicy::Type policy, Dimension::Type dimension)
 Set the resize policy to be used for the given dimension(s). More...
 
ResizePolicy::Type GetResizePolicy (Dimension::Type dimension) const
 Return the resize policy used for a single dimension. More...
 
void SetSizeScalePolicy (SizeScalePolicy::Type policy)
 Set the policy to use when setting size with size negotiation. More...
 
SizeScalePolicy::Type GetSizeScalePolicy () const
 Return the size scale policy in use. More...
 
void SetSizeModeFactor (const Vector3 &factor)
 Sets the relative to parent size factor of the actor. More...
 
Vector3 GetSizeModeFactor () const
 Retrieve the relative to parent size factor of the actor. More...
 
float GetHeightForWidth (float width)
 Calculate the height of the actor given a width. More...
 
float GetWidthForHeight (float height)
 Calculate the width of the actor given a height. More...
 
float GetRelayoutSize (Dimension::Type dimension) const
 Return the value of negotiated dimension for the given dimension. More...
 
void SetPadding (const Padding &padding)
 Set the padding for use in layout. More...
 
void GetPadding (Padding &paddingOut) const
 Return the value of the padding. More...
 
void SetMinimumSize (const Vector2 &size)
 Set the minimum size an actor can be assigned in size negotiation. More...
 
Vector2 GetMinimumSize ()
 Return the minimum relayout size. More...
 
void SetMaximumSize (const Vector2 &size)
 Set the maximum size an actor can be assigned in size negotiation. More...
 
Vector2 GetMaximumSize ()
 Return the maximum relayout size. More...
 
int GetHierarchyDepth ()
 Get depth in the hierarchy for the actor. More...
 
unsigned int AddRenderer (Renderer &renderer)
 Add a renderer to this actor. More...
 
unsigned int GetRendererCount () const
 Get the number of renderers on this actor. More...
 
Renderer GetRendererAt (unsigned int index)
 Get a Renderer by index. More...
 
void RemoveRenderer (Renderer &renderer)
 Remove an renderer from the actor. More...
 
void RemoveRenderer (unsigned int index)
 Remove an renderer from the actor by index. More...
 
TouchSignalTypeTouchedSignal ()
 This signal is emitted when touch input is received. More...
 
HoverSignalTypeHoveredSignal ()
 This signal is emitted when hover input is received. More...
 
WheelEventSignalTypeWheelEventSignal ()
 This signal is emitted when wheel event is received. More...
 
OnStageSignalTypeOnStageSignal ()
 This signal is emitted after the actor has been connected to the stage. More...
 
OffStageSignalTypeOffStageSignal ()
 This signal is emitted after the actor has been disconnected from the stage. More...
 
OnRelayoutSignalTypeOnRelayoutSignal ()
 This signal is emitted after the size has been set on the actor during relayout. More...
 
DALI_INTERNAL Actor (Internal::Actor *actor)
 This constructor is used by Actor::New() methods. More...
 
- Public Member Functions inherited from Dali::Handle
 Handle (Dali::Internal::Object *handle)
 This constructor is used by Dali New() methods. More...
 
 Handle ()
 This constructor provides an uninitialized Dali::Handle. More...
 
 ~Handle ()
 Dali::Handle is intended as a base class. More...
 
 Handle (const Handle &handle)
 This copy constructor is required for (smart) pointer semantics. More...
 
Handleoperator= (const Handle &rhs)
 This assignment operator is required for (smart) pointer semantics. More...
 
bool Supports (Capability capability) const
 Query whether an handle supports a given capability. More...
 
unsigned int GetPropertyCount () const
 Query how many properties are provided by an handle. More...
 
std::string GetPropertyName (Property::Index index) const
 Query the name of a property. More...
 
Property::Index GetPropertyIndex (const std::string &name) const
 Query the index of a property. More...
 
bool IsPropertyWritable (Property::Index index) const
 Query whether a property can be set using SetProperty(). More...
 
bool IsPropertyAnimatable (Property::Index index) const
 Query whether a writable property can be the target of an animation or constraint. More...
 
bool IsPropertyAConstraintInput (Property::Index index) const
 Query whether a property can be used as in input to a constraint. More...
 
Property::Type GetPropertyType (Property::Index index) const
 Query the type of a property. More...
 
void SetProperty (Property::Index index, const Property::Value &propertyValue)
 Set the value of an existing property. More...
 
Property::Index RegisterProperty (const std::string &name, const Property::Value &propertyValue)
 Register a new animatable property. More...
 
Property::Index RegisterProperty (const std::string &name, const Property::Value &propertyValue, Property::AccessMode accessMode)
 Register a new property. More...
 
Property::Value GetProperty (Property::Index index) const
 Retrieve a property value. More...
 
template<typename T >
GetProperty (Property::Index index) const
 Convenience function for obtaining a property of a known type. More...
 
void GetPropertyIndices (Property::IndexContainer &indices) const
 Retrieve all the property indices for this object (including custom properties). More...
 
PropertyNotification AddPropertyNotification (Property::Index index, const PropertyCondition &condition)
 Add a property notification to this object. More...
 
PropertyNotification AddPropertyNotification (Property::Index index, int componentIndex, const PropertyCondition &condition)
 Add a property notification to this object. More...
 
void RemovePropertyNotification (Dali::PropertyNotification propertyNotification)
 Remove a property notification from this object. More...
 
void RemovePropertyNotifications ()
 Remove all property notifications from this object. More...
 
void RemoveConstraints ()
 Remove all constraints from an Object. More...
 
void RemoveConstraints (unsigned int tag)
 Remove all the constraint from the Object with a matching tag. More...
 
- Public Member Functions inherited from Dali::BaseHandle
 BaseHandle (Dali::BaseObject *handle)
 This constructor is used by Dali New() methods. More...
 
 BaseHandle ()
 This constructor provides an uninitialized Dali::BaseHandle. More...
 
 ~BaseHandle ()
 Dali::BaseHandle is intended as a base class. More...
 
 BaseHandle (const BaseHandle &handle)
 This copy constructor is required for (smart) pointer semantics. More...
 
BaseHandleoperator= (const BaseHandle &rhs)
 This assignment operator is required for (smart) pointer semantics. More...
 
template<class T >
bool ConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, const T &functor)
 Connects a void() functor to a specified signal. More...
 
bool DoAction (const std::string &actionName, const Property::Map &attributes)
 Perform action on this object with the given action name and attributes. More...
 
const std::string & GetTypeName () const
 Returns the type name for the Handle. More...
 
bool GetTypeInfo (Dali::TypeInfo &info) const
 Returns the type info for the Handle. More...
 
BaseObjectGetBaseObject ()
 Retrieve the internal Dali resource. More...
 
const BaseObjectGetBaseObject () const
 Retrieve the internal Dali resource. More...
 
void Reset ()
 Resets the handle. More...
 
 operator BooleanType () const
 Converts an handle to a BooleanType. More...
 
bool operator== (const BaseHandle &rhs) const
 Equality operator overload. More...
 
bool operator!= (const BaseHandle &rhs) const
 Inequality operator overload. More...
 
Dali::RefObjectGetObjectPtr () const
 Get the reference counted object pointer. More...
 

Static Public Member Functions

static ScrollView New ()
 Create an initialized ScrollView. More...
 
static ScrollView DownCast (BaseHandle handle)
 Downcast a handle to ScrollView handle. More...
 
- Static Public Member Functions inherited from Dali::Toolkit::Scrollable
static Scrollable DownCast (BaseHandle handle)
 Downcast a handle to Scrollable handle. More...
 
- Static Public Member Functions inherited from Dali::Toolkit::Control
static Control New ()
 Create a new instance of a Control. More...
 
static Control DownCast (BaseHandle handle)
 Downcast a handle to Control handle. More...
 
template<typename T , typename I >
static DALI_INTERNALDownCast (BaseHandle handle)
 Template to allow deriving controls to DownCast handles to deriving handle classes. More...
 
- Static Public Member Functions inherited from Dali::CustomActor
static CustomActor DownCast (BaseHandle handle)
 Downcast a handle to CustomActor handle. More...
 
- Static Public Member Functions inherited from Dali::Actor
static Actor New ()
 Create an initialized Actor. More...
 
static Actor DownCast (BaseHandle handle)
 Downcast a handle to Actor handle. More...
 
- Static Public Member Functions inherited from Dali::Handle
static Handle New ()
 Create a new object. More...
 
static Handle DownCast (BaseHandle handle)
 Downcast to a handle. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dali::BaseHandle
void ThisIsSaferThanReturningVoidStar () const
 Used by the safe bool idiom. More...
 

Detailed Description

ScrollView contains actors that can be scrolled manually (via touch) or automatically.

Signals

Signal Name Method
snap-started SnapStartedSignal()

.0

Definition at line 454 of file scroll-view.h.

Member Typedef Documentation

SnapStarted signal type .0.

Definition at line 534 of file scroll-view.h.

Member Enumeration Documentation

The start and end property ranges for this control.

.0

Enumerator
PROPERTY_START_INDEX 

.18

PROPERTY_END_INDEX 

Reserve property indices, .18.

ANIMATABLE_PROPERTY_START_INDEX 
ANIMATABLE_PROPERTY_END_INDEX 

Reserve animatable property indices .0.

Definition at line 485 of file scroll-view.h.

Constructor & Destructor Documentation

Dali::Toolkit::ScrollView::ScrollView ( )

Creates an empty ScrollView handle.

.0

Definition at line 286 of file scroll-view.cpp.

Dali::Toolkit::ScrollView::ScrollView ( const ScrollView handle)

Copy constructor.

Creates another handle that points to the same real object.

.0

Parameters
[in]handleto copy from

Definition at line 301 of file scroll-view.cpp.

Dali::Toolkit::ScrollView::~ScrollView ( )

Destructor.

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

Definition at line 320 of file scroll-view.cpp.

Dali::Toolkit::ScrollView::ScrollView ( Internal::ScrollView implementation)

Creates a handle using the Toolkit::Internal implementation.

.0

Parameters
[in]implementationThe Control implementation.

Definition at line 290 of file scroll-view.cpp.

Dali::Toolkit::ScrollView::ScrollView ( Dali::Internal::CustomActor internal)
explicit

Allows the creation of this Control from an Internal::CustomActor pointer.

.0

Parameters
[in]internalA pointer to the internal CustomActor.

Definition at line 295 of file scroll-view.cpp.

Member Function Documentation

void Dali::Toolkit::ScrollView::ApplyConstraintToChildren ( Constraint  constraint)

Applies a constraint that will affect the children of ScrollView.

.0

Parameters
[in]constraintThe constraint to apply
Note
This affects all existing and future Actors that are added to scrollview.

Definition at line 566 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:

void Dali::Toolkit::ScrollView::ApplyEffect ( ScrollViewEffect  effect)

Apply Effect to ScrollView.

.0

Parameters
[in]effectThe effect to apply to scroll view

Definition at line 576 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliScrollViewPagePathEffectTest(), UtcDaliToolkitScrollViewApplyEffectN(), UtcDaliToolkitScrollViewApplyEffectP(), UtcDaliToolkitScrollViewRemoveAllEffectsP(), UtcDaliToolkitScrollViewRemoveEffectN(), and UtcDaliToolkitScrollViewRemoveEffectP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::BindActor ( Actor  child)

Binds actor to this ScrollView.

Once an actor is bound to a ScrollView, it will be subject to that ScrollView's properties.

.0

Parameters
[in]childThe actor to add to this ScrollView.

Definition at line 591 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:

ScrollView Dali::Toolkit::ScrollView::DownCast ( BaseHandle  handle)
static

Downcast a handle to ScrollView handle.

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

.0

Parameters
[in]handleHandle to an object
Returns
A handle to a ScrollView or an uninitialized handle

Definition at line 324 of file scroll-view.cpp.

Referenced by Dali::Toolkit::Internal::ScrollView::ApplyEffect(), Dali::Toolkit::Internal::ScrollView::DoConnectSignal(), Dali::Toolkit::Internal::ScrollView::GetProperty(), Dali::Toolkit::Internal::ScrollView::RemoveAllEffects(), Dali::Toolkit::Internal::ScrollView::RemoveEffect(), Dali::Toolkit::Internal::ScrollView::SetProperty(), and UtcDaliToolkitScrollViewDownCastP().

Here is the caller graph for this function:

bool Dali::Toolkit::ScrollView::GetAxisAutoLock ( ) const

Returns state of Axis Auto Lock mode.

.0

Returns
Whether Axis Auto Lock mode has been enabled or not.

Definition at line 419 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewAxisAutoLock().

Here is the call graph for this function:

Here is the caller graph for this function:

float Dali::Toolkit::ScrollView::GetAxisAutoLockGradient ( ) const

Gets the gradient threshold at which a panning gesture should be locked to the Horizontal or Vertical axis.

.0

Returns
The gradient, a value between 0.0 and 1.0f.

Definition at line 429 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewAxisAutoLockGradient().

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int Dali::Toolkit::ScrollView::GetCurrentPage ( ) const

Retrieves current scroll page based on ScrollView dimensions being the size of one page, and all pages laid out in a grid fashion, increasing from left to right until the end of the X-domain.

.0

Note
Pages start from 0 as the first page, not 1.
Returns
The Current page.

Definition at line 504 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewGetCurrentPageP(), UtcDaliToolkitScrollViewScrollToPageP(), UtcDaliToolkitScrollViewScrollToPageWithDirectionBiasP(), and UtcDaliToolkitScrollViewSetWrapModeP().

Here is the call graph for this function:

Here is the caller graph for this function:

Vector2 Dali::Toolkit::ScrollView::GetCurrentScrollPosition ( ) const
float Dali::Toolkit::ScrollView::GetFlickSpeedCoefficient ( ) const

Gets the flick speed coefficient for ScrollView when flicking in free panning mode.

This is a constant which multiplies the input touch flick velocity to determine the actual velocity at which to move the scrolling area. .0

Returns
The flick speed coefficient is returned.

Definition at line 449 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewGetSet().

Here is the call graph for this function:

Here is the caller graph for this function:

float Dali::Toolkit::ScrollView::GetFrictionCoefficient ( ) const

Gets the friction coefficient setting for ScrollView when flicking in free panning mode.

This is a value in stage-diagonals per second^2. stage-diagonal = Length( stage.width, stage.height ) .0

Returns
Friction coefficient is returned.

Definition at line 439 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewGetSet().

Here is the call graph for this function:

Here is the caller graph for this function:

float Dali::Toolkit::ScrollView::GetMaxFlickSpeed ( ) const

Gets the maximum flick speed setting for ScrollView when flicking in free panning mode.

This is a value in stage-diagonals per second. stage-diagonal = Length( stage.width, stage.height ) .0

Returns
Maximum flick speed is returned

Definition at line 479 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewGetSet().

Here is the call graph for this function:

Here is the caller graph for this function:

Vector2 Dali::Toolkit::ScrollView::GetMinimumDistanceForFlick ( ) const

Returns the minimum pan distance required for a flick gesture in pixels.

.0

Returns
Minimum pan distance vector with separate x and y distance

Definition at line 459 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSetMinimumDistanceForFlickP().

Here is the call graph for this function:

Here is the caller graph for this function:

float Dali::Toolkit::ScrollView::GetMinimumSpeedForFlick ( ) const

Returns the minimum pan speed required for a flick gesture in pixels per second.

.0

Returns
Minimum pan speed

Definition at line 469 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSetMinimumSpeedForFlickP().

Here is the call graph for this function:

Here is the caller graph for this function:

AlphaFunction Dali::Toolkit::ScrollView::GetScrollFlickAlphaFunction ( ) const

Get flick-animation's AlphaFunction.

.0

Returns
Current easing alpha function of the flick animation.

Definition at line 339 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSnapAlphaFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

float Dali::Toolkit::ScrollView::GetScrollFlickDuration ( ) const

Gets the time for the scroll flick-animation.

This animation occurs when the user flicks scroll view.

.0

Returns
The time in seconds for the animation to take.

Definition at line 359 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSnapDuration().

Here is the call graph for this function:

Here is the caller graph for this function:

AlphaFunction Dali::Toolkit::ScrollView::GetScrollSnapAlphaFunction ( ) const

Get snap-animation's AlphaFunction.

.0

Returns
Current easing alpha function of the snap animation.

Definition at line 329 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSnapAlphaFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

float Dali::Toolkit::ScrollView::GetScrollSnapDuration ( ) const

Gets the time for the scroll snap-animation.

This animation occurs when the user drags, and releases.

.0

Returns
The time in seconds for the animation to take.

Definition at line 349 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSnapDuration().

Here is the call graph for this function:

Here is the caller graph for this function:

int Dali::Toolkit::ScrollView::GetScrollUpdateDistance ( ) const

Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted.

.0

Returns
Current scroll update distance

Definition at line 409 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSetScrollUpdateDistanceP().

Here is the call graph for this function:

Here is the caller graph for this function:

Vector2 Dali::Toolkit::ScrollView::GetWheelScrollDistanceStep ( ) const

Gets the step of scroll distance in actor coordinates for each wheel event received in free panning mode.

.0

Returns
The step of scroll distance(pixel) in X and Y axes.

Definition at line 489 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSetWheelScrollDistanceStepP().

Here is the call graph for this function:

Here is the caller graph for this function:

ScrollView Dali::Toolkit::ScrollView::New ( void  )
static

Create an initialized ScrollView.

.0

Returns
A handle to a newly allocated Dali resource.

Definition at line 315 of file scroll-view.cpp.

References Dali::Toolkit::Internal::ScrollView::New().

Referenced by Dali::Toolkit::Internal::anonymous_namespace{scroll-view-impl.cpp}::Create(), Dali::Toolkit::Internal::TextSelectionToolbar::SetProperty(), Dali::Toolkit::Internal::TextSelectionToolbar::SetUp(), anonymous_namespace{utc-Dali-ScrollViewEffect.cpp}::SetupTestScrollView(), UtcDaliScrollViewSetGetProperty(), UtcDaliToolkitScrollViewActorAutoSnap(), UtcDaliToolkitScrollViewApplyEffectN(), UtcDaliToolkitScrollViewApplyEffectP(), UtcDaliToolkitScrollViewAssignmentOperatorP(), UtcDaliToolkitScrollViewAxisAutoLock(), UtcDaliToolkitScrollViewAxisAutoLockGradient(), UtcDaliToolkitScrollViewBind(), UtcDaliToolkitScrollViewConstraints(), UtcDaliToolkitScrollViewConstraintsMove(), UtcDaliToolkitScrollViewConstraintsWrap(), UtcDaliToolkitScrollViewCopyConstructorP(), UtcDaliToolkitScrollViewDownCastP(), UtcDaliToolkitScrollViewGesturePageLimit(), UtcDaliToolkitScrollViewGetCurrentPageP(), UtcDaliToolkitScrollViewGetSet(), UtcDaliToolkitScrollViewNewP(), UtcDaliToolkitScrollViewOvershoot(), UtcDaliToolkitScrollViewRemoveAllEffectsN(), UtcDaliToolkitScrollViewRemoveAllEffectsP(), UtcDaliToolkitScrollViewRemoveEffectN(), UtcDaliToolkitScrollViewRemoveEffectP(), UtcDaliToolkitScrollViewRemoveScrollingDirectionP(), UtcDaliToolkitScrollViewScrollSensitive(), UtcDaliToolkitScrollViewScrollToActorP(), UtcDaliToolkitScrollViewScrollToPageP(), UtcDaliToolkitScrollViewScrollToPageWithDirectionBiasP(), UtcDaliToolkitScrollViewScrollToPositionP(), UtcDaliToolkitScrollViewScrollToPositionWithAlphaFunctionAndDirectionBiasP(), UtcDaliToolkitScrollViewScrollToPositionWithAlphaFunctionP(), UtcDaliToolkitScrollViewScrollToPositionWithDirectionBiasP(), UtcDaliToolkitScrollViewScrollToSnapPointP(), UtcDaliToolkitScrollViewSetMaxOvershootP(), UtcDaliToolkitScrollViewSetMinimumDistanceForFlickP(), UtcDaliToolkitScrollViewSetMinimumSpeedForFlickP(), UtcDaliToolkitScrollViewSetOvershootAnimationSpeedP(), UtcDaliToolkitScrollViewSetOvershootEffectColorP(), UtcDaliToolkitScrollViewSetOvershootEnabledP(), UtcDaliToolkitScrollViewSetRulerXP(), UtcDaliToolkitScrollViewSetRulerYP(), UtcDaliToolkitScrollViewSetScrollingDirectionP(), UtcDaliToolkitScrollViewSetScrollUpdateDistanceP(), UtcDaliToolkitScrollViewSetWheelScrollDistanceStepP(), UtcDaliToolkitScrollViewSetWrapModeP(), UtcDaliToolkitScrollViewSignalsStartComplete(), UtcDaliToolkitScrollViewSignalsUpdate(), UtcDaliToolkitScrollViewSnapAlphaFunction(), UtcDaliToolkitScrollViewSnapDuration(), and UtcDaliToolkitScrollViewSnapStartedSignalP().

Here is the call graph for this function:

ScrollView & Dali::Toolkit::ScrollView::operator= ( const ScrollView handle)

Assignment operator.

Changes this handle to point to another real object. .0

Parameters
[in]handleThe handle to copy from
Returns
A reference to this

Definition at line 306 of file scroll-view.cpp.

References Dali::Toolkit::Control::operator=().

Here is the call graph for this function:

void Dali::Toolkit::ScrollView::RemoveAllEffects ( )

Remove All Effects from ScrollView.

.0

Definition at line 586 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewRemoveAllEffectsN(), and UtcDaliToolkitScrollViewRemoveAllEffectsP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::RemoveConstraintsFromChildren ( )

Removes all constraints that will affect the children of ScrollView.

.0

Note
This removes all constraints from actors that have been added to scrollview.

Definition at line 571 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:

void Dali::Toolkit::ScrollView::RemoveEffect ( ScrollViewEffect  effect)

Remove Effect from ScrollView.

.0

Parameters
[in]effectThe effect to remove.

Definition at line 581 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewRemoveEffectN(), and UtcDaliToolkitScrollViewRemoveEffectP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::RemoveScrollingDirection ( Radian  direction)

Remove a direction constraint from the scroll view.

.0

Parameters
[in]directionThe axis to stop constraining to. Usually will be PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).

Definition at line 611 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewRemoveScrollingDirectionP(), and UtcDaliToolkitScrollViewSetScrollingDirectionP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::ScrollTo ( const Vector2 position)

Scrolls View to position specified (contents will scroll to this position).

Position 0,0 is the origin. Increasing X scrolls contents left, while increasing Y scrolls contents up.

  • If Rulers have been applied to the axes, then the contents will scroll until reaching the domain boundary. .0
    Parameters
    [in]positionThe position to scroll to.
    Note
    Contents will not snap to ruler snap points.

Definition at line 509 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliScrollViewPagePathEffectTest(), UtcDaliToolkitScrollViewActorAutoSnap(), UtcDaliToolkitScrollViewAxisAutoLock(), UtcDaliToolkitScrollViewGesturePageLimit(), UtcDaliToolkitScrollViewGetCurrentPageP(), UtcDaliToolkitScrollViewOvershoot(), UtcDaliToolkitScrollViewRemoveScrollingDirectionP(), UtcDaliToolkitScrollViewScrollSensitive(), UtcDaliToolkitScrollViewScrollToActorP(), UtcDaliToolkitScrollViewScrollToPageP(), UtcDaliToolkitScrollViewScrollToPageWithDirectionBiasP(), UtcDaliToolkitScrollViewScrollToPositionP(), UtcDaliToolkitScrollViewScrollToPositionWithAlphaFunctionAndDirectionBiasP(), UtcDaliToolkitScrollViewScrollToPositionWithAlphaFunctionP(), UtcDaliToolkitScrollViewScrollToPositionWithDirectionBiasP(), UtcDaliToolkitScrollViewScrollToSnapPointP(), UtcDaliToolkitScrollViewSetMaxOvershootP(), UtcDaliToolkitScrollViewSetRulerXP(), UtcDaliToolkitScrollViewSetRulerYP(), UtcDaliToolkitScrollViewSetScrollingDirectionP(), UtcDaliToolkitScrollViewSetWrapModeP(), UtcDaliToolkitScrollViewSignalsStartComplete(), and UtcDaliToolkitScrollViewSnapStartedSignalP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::ScrollTo ( const Vector2 position,
float  duration 
)

Scrolls View to position specified (contents will scroll to this position).

Position 0,0 is the origin. Increasing X scrolls contents left, while increasing Y scrolls contents up.

  • If Rulers have been applied to the axes, then the contents will scroll until reaching the domain boundary. .0
    Parameters
    [in]positionThe position to scroll to.
    [in]durationThe duration of the animation in seconds
    Note
    Contents will not snap to ruler snap points.

Definition at line 514 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:

void Dali::Toolkit::ScrollView::ScrollTo ( const Vector2 position,
float  duration,
AlphaFunction  alpha 
)

Scrolls View to position specified (contents will scroll to this position).

Position 0,0 is the origin. Increasing X scrolls contents left, while increasing Y scrolls contents up.

  • If Rulers have been applied to the axes, then the contents will scroll until reaching the domain boundary. .0
    Parameters
    [in]positionThe position to scroll to.
    [in]durationThe duration of the animation in seconds
    [in]alphaThe alpha function to use
    Note
    Contents will not snap to ruler snap points.

Definition at line 519 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:

void Dali::Toolkit::ScrollView::ScrollTo ( const Vector2 position,
float  duration,
DirectionBias  horizontalBias,
DirectionBias  verticalBias 
)

Scrolls View to position specified (contents will scroll to this position).

Position 0,0 is the origin. Increasing X scrolls contents left, while increasing Y scrolls contents up.

  • If Rulers have been applied to the axes, then the contents will scroll until reaching the domain boundary. .0
    Parameters
    [in]positionThe position to scroll to.
    [in]durationThe duration of the animation in seconds
    [in]horizontalBiasWhether to bias scrolling to left or right.
    [in]verticalBiasWhether to bias scrolling to top or bottom.
    Note
    Contents will not snap to ruler snap points. Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in wrap mode, the application developer can decide whether to scroll left or right to get to the target page.

Definition at line 524 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:

void Dali::Toolkit::ScrollView::ScrollTo ( const Vector2 position,
float  duration,
AlphaFunction  alpha,
DirectionBias  horizontalBias,
DirectionBias  verticalBias 
)

Scrolls View to position specified (contents will scroll to this position).

Position 0,0 is the origin. Increasing X scrolls contents left, while increasing Y scrolls contents up.

  • If Rulers have been applied to the axes, then the contents will scroll until reaching the domain boundary. .0
    Parameters
    [in]positionThe position to scroll to.
    [in]durationThe duration of the animation in seconds
    [in]horizontalBiasWhether to bias scrolling to left or right.
    [in]verticalBiasWhether to bias scrolling to top or bottom.
    [in]alphaAlpha function to use
    Note
    Contents will not snap to ruler snap points. Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in wrap mode, the application developer can decide whether to scroll left or right to get to the target page.

Definition at line 530 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:

void Dali::Toolkit::ScrollView::ScrollTo ( unsigned int  page)

Scrolls View to page currently based on assumption that each page is "(page) * ScrollViewSize.width, 0".

.0

Parameters
[in]pageto scroll to
Note
Should probably be upgraded so that page is an abstract class, that can be a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be orchestrated in a 2D grid fashion, or variable width.

Definition at line 536 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:

void Dali::Toolkit::ScrollView::ScrollTo ( unsigned int  page,
float  duration 
)

Scrolls View to page currently based on assumption that each page is "(page) * ScrollViewSize.width, 0".

.0

Parameters
[in]pageto scroll to
[in]durationThe duration of the animation in seconds
Note
Should probably be upgraded so that page is an abstract class, that can be a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be orchestrated in a 2D grid fashion, or variable width.

Definition at line 541 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:

void Dali::Toolkit::ScrollView::ScrollTo ( unsigned int  page,
float  duration,
DirectionBias  bias 
)

Scrolls View to page currently based on assumption that each page is "(page) * ScrollViewSize.width, 0".

.0

Parameters
[in]pageto scroll to
[in]durationThe duration of the animation in seconds
[in]biasWhether to bias scrolling to left or right.
Note
Should probably be upgraded so that page is an abstract class, that can be a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be orchestrated in a 2D grid fashion, or variable width. A biasing parameter is provided such that in scenarios with 2 pages in wrap mode, the application developer can decide whether to scroll left or right to get to the target page.

Definition at line 546 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:

void Dali::Toolkit::ScrollView::ScrollTo ( Actor actor)

Scrolls View such that actor appears in the center of the ScrollView.

.0

Parameters
[in]actorThe actor to center in on (via Scrolling).
Note
Actor must be a direct child of ScrollView, otherwise will cause an assertion failure.

Definition at line 551 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:

void Dali::Toolkit::ScrollView::ScrollTo ( Actor actor,
float  duration 
)

Scrolls View such that actor appears in the center of the ScrollView.

.0

Parameters
[in]actorThe actor to center in on (via Scrolling).
[in]durationThe duration of the animation in seconds
Note
Actor must be a direct child of ScrollView, otherwise will cause an assertion failure.

Definition at line 556 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:

bool Dali::Toolkit::ScrollView::ScrollToSnapPoint ( )

Scrolls View to the nearest snap points as specified by the Rulers.

If already at snap points, then will return false, and not scroll.

.0

Returns
True if Snapping necessary.

Definition at line 561 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewActorAutoSnap(), and UtcDaliToolkitScrollViewScrollToSnapPointP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetActorAutoSnap ( bool  enable)

Enables or Disables Actor Auto-Snap mode.

When Actor Auto-Snap mode has been enabled, ScrollView will automatically snap to the closest actor (The closest actor will appear in the center of the ScrollView).

.0

Parameters
[in]enableEnables (true), or disables (false) Actor AutoSnap

Definition at line 399 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewActorAutoSnap().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetAxisAutoLock ( bool  enable)

Enables or Disables Axis Auto Lock mode for panning within the ScrollView.

When enabled, any pan gesture that appears mostly horizontal or mostly vertical, will be automatically restricted to horizontal only or vertical only panning, until the pan gesture has completed.

.0

Parameters
[in]enableEnables (true), or disables (false) AxisAutoLock mode.

Definition at line 424 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by Dali::Toolkit::Internal::TextSelectionToolbar::SetUpScrollView(), and UtcDaliToolkitScrollViewAxisAutoLock().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetAxisAutoLockGradient ( float  gradient)

Sets the gradient threshold at which a panning gesture should be locked to the Horizontal or Vertical axis.

By default this is 0.36 (0.36:1) which means angles less than 20 degrees to an axis will lock to that axis.

.0

Parameters
[in]gradientA value between 0.0 and 1.0 (auto-lock for all angles)
Note
Specifying a value of 1.0 (the maximum value accepted) indicates that all panning gestures will auto-lock. Either to the horizontal or vertical axis.

Definition at line 434 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewAxisAutoLockGradient().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetFlickSpeedCoefficient ( float  speed)

Sets the flick speed coefficient for ScrollView when flicking in free panning mode.

This is a constant which multiplies the input touch flick velocity to determine the actual velocity at which to move the scrolling area. .0

Parameters
[in]speedThe flick speed coefficient (default = 1.0).

Definition at line 454 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewGetSet().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetFrictionCoefficient ( float  friction)

Sets the friction coefficient for ScrollView when flicking in free panning mode.

This is a value in stage-diagonals per second^2. stage-diagonal = Length( stage.width, stage.height ). example: A stage 480x800 in size has a diagonal length of 933. Friction coefficient of 1.0 means the swipe velocity will reduce by 1.0 * 933 pixels/sec^2. .0

Parameters
[in]frictionFriction coefficient, must be greater than 0.0 (default = 1.0)

Definition at line 444 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewGetSet().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetMaxFlickSpeed ( float  speed)

Sets the maximum flick speed for the ScrollView when flicking in free panning mode.

This is a value in stage-diagonals per second. stage-diagonal = Length( stage.width, stage.height ) example: A stage 480x800 in size has a diagonal length of 933. Max Flick speed of 1.0 means the maximum velocity of a swipe can be 1.0 * 933 pixels/sec. .0

Parameters
[in]speedMaximum flick speed (default = 3.0)

Definition at line 484 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewGetSet().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetMaxOvershoot ( float  overshootX,
float  overshootY 
)

Set maximum overshoot amount.

The final overshoot value is within 0.0f to 1.0f, but the maximum overshoot is in pixels (e.g. if you scroll 75 pixels beyond the edge of a scrollable area and the maximum overshoot is 100 then the final overshoot value will be 0.75f).

.0

Parameters
[in]overshootXThe maximum number of horizontally scrolled pixels before overshoot X reaches 1.0f
[in]overshootYThe maximum number of vertically scrolled pixels before overshoot Y reaches 1.0f

Definition at line 384 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSetMaxOvershootP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetMinimumDistanceForFlick ( const Vector2 distance)

Sets the minimum pan distance required for a flick in pixels.

Takes a Vector2 containing separate x and y values. As long as the pan distance exceeds one of these axes a flick will be allowed.

.0

Parameters
[in]distanceThe minimum pan distance for a flick

Definition at line 464 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSetMinimumDistanceForFlickP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetMinimumSpeedForFlick ( float  speed)

Sets the minimum pan speed required for a flick in pixels per second.

.0

Parameters
[in]speedThe minimum pan speed for a flick

Definition at line 474 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSetMinimumSpeedForFlickP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetRulerX ( RulerPtr  ruler)
void Dali::Toolkit::ScrollView::SetRulerY ( RulerPtr  ruler)
void Dali::Toolkit::ScrollView::SetScrollFlickAlphaFunction ( AlphaFunction  alpha)

Set flick-animation's AlphaFunction.

.0

Parameters
[in]alphaEasing alpha function of the flick animation.

Definition at line 344 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSnapAlphaFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetScrollFlickDuration ( float  time)

Sets the time for the scroll flick-animation.

This animation occurs when the user flicks scroll view.

.0

Parameters
[in]timeThe time in seconds for the animation to take.

Definition at line 364 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSnapDuration().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetScrollingDirection ( Radian  direction,
Radian  threshold = PanGestureDetector::DEFAULT_THRESHOLD 
)

Allows the user to constrain the scroll view in a particular direction.

.0

Parameters
[in]directionThe axis to constrain the scroll-view to. Usually set to PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
[in]thresholdThe threshold to apply around the axis.
Note
If no threshold is specified, then the default threshold of PI * 0.25 radians (or 45 degrees) is used.

Definition at line 606 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by Dali::Toolkit::Internal::TextSelectionToolbar::SetUpScrollView(), UtcDaliToolkitScrollViewRemoveScrollingDirectionP(), and UtcDaliToolkitScrollViewSetScrollingDirectionP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetScrollSensitive ( bool  sensitive)

Set scroll sensibility of pan gesture.

.0

Parameters
[in]sensitivetrue to enable scroll, false to disable scrolling
Note
Unlike Actor::SetSensitive(), this determines whether this ScrollView should react (e.g. pan), without disrupting the sensitivity of it's children.

Definition at line 379 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewGesturePageLimit(), and UtcDaliToolkitScrollViewScrollSensitive().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetScrollSnapAlphaFunction ( AlphaFunction  alpha)

Set snap-animation's AlphaFunction.

.0

Parameters
[in]alphaEasing alpha function of the snap animation.

Definition at line 334 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSnapAlphaFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetScrollSnapDuration ( float  time)

Sets the time for the scroll snap-animation.

This animation occurs when the user drags, and releases.

.0

Parameters
[in]timeThe time in seconds for the animation to take.

Definition at line 354 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSnapDuration().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetScrollUpdateDistance ( int  distance)

Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted.

The scroll update distance tells ScrollView how far to move before ScrollUpdatedSignal the informs application. Each time the ScrollView crosses this distance the signal will be emitted.

.0

Parameters
[in]distanceThe distance for ScrollView to move before emitting update signal

Definition at line 414 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSetScrollUpdateDistanceP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetSnapOvershootAlphaFunction ( AlphaFunction  alpha)

Set Snap Overshoot animation's AlphaFunction.

.0

Parameters
[in]alphaEasing alpha function of the overshoot snap animation.

Definition at line 389 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewOvershoot().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetSnapOvershootDuration ( float  duration)

Set Snap Overshoot animation's Duration.

.0

Parameters
[in]durationThe duration of the overshoot snap animation.
Note
Set duration to 0 seconds, to disable Animation.

Definition at line 394 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewOvershoot().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetWheelScrollDistanceStep ( Vector2  step)

Sets the step of scroll distance in actor coordinates for each wheel event received in free panning mode.

.0

Parameters
[in]stepThe step of scroll distance(pixel) in X and Y axes.
Note
If snap points are defined in the rulers, it will always scroll to the next snap point towards the scroll direction while receiving the wheel events.

Definition at line 494 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by UtcDaliToolkitScrollViewSetWheelScrollDistanceStepP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::SetWrapMode ( bool  enable)

Enables or Disables Wrap mode for ScrollView contents.

When enabled, the ScrollView contents are wrapped over the X/Y Domain.

.0

Parameters
[in]enableEnables (true), or disables (false) Wrap Mode.
Note
You must apply a position constraint that causes Wrapping to all children.

Definition at line 404 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl(), and Dali::Toolkit::Internal::AccessibilityManager::SetWrapMode().

Referenced by UtcDaliToolkitScrollViewGesturePageLimit(), UtcDaliToolkitScrollViewScrollToPageWithDirectionBiasP(), UtcDaliToolkitScrollViewScrollToPositionWithAlphaFunctionAndDirectionBiasP(), UtcDaliToolkitScrollViewScrollToPositionWithDirectionBiasP(), and UtcDaliToolkitScrollViewSetWrapModeP().

Here is the call graph for this function:

Here is the caller graph for this function:

ScrollView::SnapStartedSignalType & Dali::Toolkit::ScrollView::SnapStartedSignal ( )

Signal emitted when the ScrollView has started to snap or flick (it tells the target position, scale, rotation for the snap or flick).

A callback of the following type may be connected:

void YourCallbackName(const SnapEvent& event);

.0

Returns
The signal to connect to.
Precondition
The Object has been initialized.

Definition at line 601 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Referenced by Dali::Toolkit::Internal::ScrollView::DoConnectSignal(), UtcDaliToolkitScrollViewScrollSensitive(), and UtcDaliToolkitScrollViewSnapStartedSignalP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::ScrollView::UnbindActor ( Actor  child)

Unbind Actor from this ScrollView.

Once Unbound, this ScrollView will not affect the actor. .0

Parameters
[in]childThe actor to be unbound.
Note
This does not remove the child from the ScrollView container

Definition at line 596 of file scroll-view.cpp.

References Dali::Toolkit::GetImpl().

Here is the call graph for this function:


The documentation for this class was generated from the following files:
Dali Docs Home
Read more about Dali