Tizen Native API
Elementary Scrolling

Functions

Eina_Bool elm_config_scroll_bounce_enabled_get (void)
 Get whether scrollers should bounce when they reach their viewport's edge during a scroll.
void elm_config_scroll_bounce_enabled_set (Eina_Bool enabled)
 Set whether scrollers should bounce when they reach their viewport's edge during a scroll.
double elm_config_scroll_bounce_friction_get (void)
 Get the amount of inertia a scroller will impose at bounce animations.
void elm_config_scroll_bounce_friction_set (double friction)
 Set the amount of inertia a scroller will impose at bounce animations.
double elm_config_scroll_page_scroll_friction_get (void)
 Get the amount of inertia a paged scroller will impose at page fitting animations.
void elm_config_scroll_page_scroll_friction_set (double friction)
 Set the amount of inertia a paged scroller will impose at page fitting animations.
double elm_config_scroll_bring_in_scroll_friction_get (void)
 Get the amount of inertia a scroller will impose at region bring animations.
void elm_config_scroll_bring_in_scroll_friction_set (double friction)
 Set the amount of inertia a scroller will impose at region bring animations.
double elm_config_scroll_zoom_friction_get (void)
 Get the amount of inertia scrollers will impose at animations triggered by Elementary widgets' zooming API.
void elm_config_scroll_zoom_friction_set (double friction)
 Set the amount of inertia scrollers will impose at animations triggered by Elementary widgets' zooming API.
Eina_Bool elm_config_scroll_thumbscroll_enabled_get (void)
 Get whether scrollers should be draggable from any point in their views.
void elm_config_scroll_thumbscroll_enabled_set (Eina_Bool enabled)
 Set whether scrollers should be draggable from any point in their views.
unsigned int elm_config_scroll_thumbscroll_threshold_get (void)
 Get the number of pixels one should travel while dragging a scroller's view to actually trigger scrolling.
void elm_config_scroll_thumbscroll_threshold_set (unsigned int threshold)
 Set the number of pixels one should travel while dragging a scroller's view to actually trigger scrolling.
unsigned int elm_config_scroll_thumbscroll_hold_threshold_get (void)
 Get the number of pixels the range which can be scrolled, while the scroller is holded.
void elm_config_scroll_thumbscroll_hold_threshold_set (unsigned int threshold)
 Set the number of pixels the range which can be scrolled, while the scroller is holded.
double elm_config_scroll_thumbscroll_momentum_threshold_get (void)
 Get the minimum speed of mouse cursor movement which will trigger list self scrolling animation after a mouse up event (pixels/second).
void elm_config_scroll_thumbscroll_momentum_threshold_set (double threshold)
 Set the minimum speed of mouse cursor movement which will trigger list self scrolling animation after a mouse up event (pixels/second).
unsigned int elm_config_scroll_thumbscroll_flick_distance_tolerance_get (void)
 Get the number of pixels the maximum distance which can be flicked. If it is flicked more than this, the flick distance is same with maximum distance.
void elm_config_scroll_thumbscroll_flick_distance_tolerance_set (unsigned int distance)
 Set the number of pixels the maximum distance which can be flicked. If it is flicked more than this, the flick distance is same with maximum distance.
double elm_config_scroll_thumbscroll_friction_get (void)
 Get the amount of inertia a scroller will impose at self scrolling animations.
void elm_config_scroll_thumbscroll_friction_set (double friction)
 Set the amount of inertia a scroller will impose at self scrolling animations.
double elm_config_scroll_thumbscroll_min_friction_get (void)
 Get the min amount of inertia a scroller will impose at self scrolling animations.
void elm_config_scroll_thumbscroll_min_friction_set (double friction)
 Set the min amount of inertia a scroller will impose at self scrolling animations.
double elm_config_scroll_thumbscroll_friction_standard_get (void)
 Get the standard velocity of the scroller. The scroll animation time is same with thumbscroll friction, if the velocity is same with standard velocity.
void elm_config_scroll_thumbscroll_friction_standard_set (double standard)
 Set the standard velocity of the scroller. The scroll animation time is same with thumbscroll friction, if the velocity is same with standard velocity.
double elm_config_scroll_thumbscroll_border_friction_get (void)
 Get the amount of lag between your actual mouse cursor dragging movement and a scroller's view movement itself, while pushing it into bounce state manually.
void elm_config_scroll_thumbscroll_border_friction_set (double friction)
 Set the amount of lag between your actual mouse cursor dragging movement and a scroller's view movement itself, while pushing it into bounce state manually.
double elm_config_scroll_thumbscroll_sensitivity_friction_get (void)
 Get the sensitivity amount which is be multiplied by the length of mouse dragging.
void elm_config_scroll_thumbscroll_sensitivity_friction_set (double friction)
 Set the sensitivity amount which is be multiplied by the length of mouse dragging.
double elm_config_scroll_thumbscroll_acceleration_threshold_get (void)
 Get the minimum speed of mouse cursor movement which will accelerate scrolling velocity after a mouse up event (pixels/second).
void elm_config_scroll_thumbscroll_acceleration_threshold_set (double threshold)
 Set the minimum speed of mouse cursor movement which will accelerate scrolling velocity after a mouse up event (pixels/second).
double elm_config_scroll_thumbscroll_acceleration_time_limit_get (void)
 Get the time limit for accelerating velocity.
void elm_config_scroll_thumbscroll_acceleration_time_limit_set (double time_limit)
 Set the time limit for accelerating velocity.
double elm_config_scroll_thumbscroll_acceleration_weight_get (void)
 Get the weight for the acceleration.
void elm_config_scroll_thumbscroll_acceleration_weight_set (double weight)
 Set the weight for the acceleration.
void elm_config_scroll_item_align_enabled_set (Eina_Bool enable)
 Sets the scroll item align enable.
Eina_Bool elm_config_scroll_item_align_enabled_get (void)
 Sets the scroll item align enable.
void elm_config_scroll_item_valign_set (const char *scroll_item_valign)
 Sets the scroll item vertical align.
const char * elm_config_scroll_item_valign_get (void)
 Sets the scroll item vertical align.

These are functions setting how scrollable views in Elementary widgets should behave on user interaction.


Function Documentation

Get whether scrollers should bounce when they reach their viewport's edge during a scroll.

Since :
2.3
Returns:
the thumb scroll bouncing state
Remarks:
This is the default behavior for touch screens, in general.

Set whether scrollers should bounce when they reach their viewport's edge during a scroll.

Since :
2.3
Parameters:
[in]enabledthe thumb scroll bouncing state
See also:
elm_config_scroll_bounce_enabled_get()

Get the amount of inertia a scroller will impose at bounce animations.

Since :
2.3
Returns:
the thumb scroll bounce friction
void elm_config_scroll_bounce_friction_set ( double  friction)

Set the amount of inertia a scroller will impose at bounce animations.

Since :
2.3
Parameters:
[in]frictionthe thumb scroll bounce friction
See also:
elm_config_scroll_bounce_friction_get()

Get the amount of inertia a scroller will impose at region bring animations.

Since :
2.3
Returns:
the bring in scroll friction

Set the amount of inertia a scroller will impose at region bring animations.

Since :
2.3
Parameters:
[in]frictionthe bring in scroll friction
See also:
elm_config_scroll_bring_in_scroll_friction_get()

Sets the scroll item align enable.

Since :
2.3.1
Returns:
The scroll item align state.
See also:
elm_config_scroll_item_align_enabled_set()

Sets the scroll item align enable.

Since :
2.3.1
Parameters:
[in]enableThe scroll item align state
See also:
elm_config_scroll_item_align_enabled_get()
const char* elm_config_scroll_item_valign_get ( void  )

Sets the scroll item vertical align.

Since :
2.3.1
Returns:
The scroll item vertical align name.
See also:
elm_config_scroll_item_valign_set()
void elm_config_scroll_item_valign_set ( const char *  scroll_item_valign)

Sets the scroll item vertical align.

Since :
2.3.1
Parameters:
[in]scroll_item_valignThe position name.
See also:
elm_config_scroll_item_valign_get()

Get the amount of inertia a paged scroller will impose at page fitting animations.

Since :
2.3
Returns:
the page scroll friction
void elm_config_scroll_page_scroll_friction_set ( double  friction)

Set the amount of inertia a paged scroller will impose at page fitting animations.

Since :
2.3
Parameters:
[in]frictionthe page scroll friction
See also:
elm_config_scroll_page_scroll_friction_get()

Get the minimum speed of mouse cursor movement which will accelerate scrolling velocity after a mouse up event (pixels/second).

Since :
2.3
Returns:
the thumb scroll acceleration threshold

Set the minimum speed of mouse cursor movement which will accelerate scrolling velocity after a mouse up event (pixels/second).

Since :
2.3
Parameters:
[in]thresholdthe thumb scroll acceleration threshold
See also:
elm_config_thumbscroll_acceleration_threshold_get()

Get the time limit for accelerating velocity.

Since :
2.3
Returns:
the thumb scroll acceleration time limit

Set the time limit for accelerating velocity.

Since :
2.3
Parameters:
[in]time_limitthe thumb scroll acceleration time limit
See also:
elm_config_thumbscroll_acceleration_time_limit_get()

Get the weight for the acceleration.

Since :
2.3
Returns:
the thumb scroll acceleration weight

Set the weight for the acceleration.

Since :
2.3
Parameters:
[in]weightthe thumb scroll acceleration weight
See also:
elm_config_thumbscroll_acceleration_weight_get()

Get the amount of lag between your actual mouse cursor dragging movement and a scroller's view movement itself, while pushing it into bounce state manually.

Since :
2.3
Returns:
the thumb scroll border friction

Set the amount of lag between your actual mouse cursor dragging movement and a scroller's view movement itself, while pushing it into bounce state manually.

Since :
2.3
Parameters:
[in]frictionthe thumb scroll border friction. 0.0 for perfect synchrony between two movements, 1.0 for maximum lag.
See also:
elm_config_thumbscroll_border_friction_get()
Remarks:
parameter value will get bound to 0.0 - 1.0 interval, always

Get whether scrollers should be draggable from any point in their views.

Since :
2.3
Returns:
the thumb scroll state
Remarks:
This is the default behavior for touch screens, in general.
All other functions namespaced with "thumbscroll" will only have effect if this mode is enabled.

Set whether scrollers should be draggable from any point in their views.

Since :
2.3
Parameters:
[in]enabledthe thumb scroll state
See also:
elm_config_scroll_thumbscroll_enabled_get()

Get the number of pixels the maximum distance which can be flicked. If it is flicked more than this, the flick distance is same with maximum distance.

Since :
2.3
Returns:
the thumb scroll maximum flick distance

Set the number of pixels the maximum distance which can be flicked. If it is flicked more than this, the flick distance is same with maximum distance.

Since :
2.3
Parameters:
[in]distancethe thumb scroll maximum flick distance
See also:
elm_config_thumbscroll_flick_distance_tolerance_get()

Get the amount of inertia a scroller will impose at self scrolling animations.

Since :
2.3
Returns:
the thumb scroll friction
void elm_config_scroll_thumbscroll_friction_set ( double  friction)

Set the amount of inertia a scroller will impose at self scrolling animations.

Since :
2.3
Parameters:
[in]frictionthe thumb scroll friction
See also:
elm_config_thumbscroll_friction_get()

Get the standard velocity of the scroller. The scroll animation time is same with thumbscroll friction, if the velocity is same with standard velocity.

Since :
2.3
Returns:
the thumb scroll friction

Set the standard velocity of the scroller. The scroll animation time is same with thumbscroll friction, if the velocity is same with standard velocity.

Since :
2.3
Parameters:
[in]standardthe thumb scroll friction standard
See also:
elm_config_thumbscroll_friction_standard_get()

Get the number of pixels the range which can be scrolled, while the scroller is holded.

Since :
2.3
Returns:
the thumb scroll hold threshold
void elm_config_scroll_thumbscroll_hold_threshold_set ( unsigned int  threshold)

Set the number of pixels the range which can be scrolled, while the scroller is holded.

Since :
2.3
Parameters:
[in]thresholdthe thumb scroll hold threshold
See also:
elm_config_thumbscroll_hold_threshold_get()

Get the min amount of inertia a scroller will impose at self scrolling animations.

Since :
2.3
Returns:
the thumb scroll min friction

Set the min amount of inertia a scroller will impose at self scrolling animations.

Since :
2.3
Parameters:
[in]frictionthe thumb scroll min friction
See also:
elm_config_thumbscroll_min_friction_get()

Get the minimum speed of mouse cursor movement which will trigger list self scrolling animation after a mouse up event (pixels/second).

Since :
2.3
Returns:
the thumb scroll momentum threshold

Set the minimum speed of mouse cursor movement which will trigger list self scrolling animation after a mouse up event (pixels/second).

Since :
2.3
Parameters:
[in]thresholdthe thumb scroll momentum threshold
See also:
elm_config_thumbscroll_momentum_threshold_get()

Get the sensitivity amount which is be multiplied by the length of mouse dragging.

Since :
2.3
Returns:
the thumb scroll sensitivity friction

Set the sensitivity amount which is be multiplied by the length of mouse dragging.

Since :
2.3
Parameters:
[in]frictionthe thumb scroll sensitivity friction. 0.1 for minimum sensitivity, 1.0 for maximum sensitivity. 0.25 is proper.
See also:
elm_config_thumbscroll_sensitivity_friction_get()
Remarks:
parameter value will get bound to 0.1 - 1.0 interval, always

Get the number of pixels one should travel while dragging a scroller's view to actually trigger scrolling.

Since :
2.3
Returns:
the thumb scroll threshold
Remarks:
One would use higher values for touch screens, in general, because of their inherent imprecision.
void elm_config_scroll_thumbscroll_threshold_set ( unsigned int  threshold)

Set the number of pixels one should travel while dragging a scroller's view to actually trigger scrolling.

Since :
2.3
Parameters:
[in]thresholdthe thumb scroll threshold
See also:
elm_config_thumbscroll_threshold_get()

Get the amount of inertia scrollers will impose at animations triggered by Elementary widgets' zooming API.

Since :
2.3
Returns:
the zoom friction
void elm_config_scroll_zoom_friction_set ( double  friction)

Set the amount of inertia scrollers will impose at animations triggered by Elementary widgets' zooming API.

Since :
2.3
Parameters:
[in]frictionthe zoom friction
See also:
elm_config_scroll_zoom_friction_get()