Tizen Native API
Elementary Scrolling

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

Functions

Eina_Bool elm_config_scroll_bounce_enabled_get (void)
 Gets whether scrollers should bounce when they reach their viewport's edge during a scroll.
void elm_config_scroll_bounce_enabled_set (Eina_Bool enabled)
 Sets whether scrollers should bounce when they reach their viewport's edge during a scroll.
double elm_config_scroll_bounce_friction_get (void)
 Gets the amount of inertia a scroller imposes during bounce animations.
void elm_config_scroll_bounce_friction_set (double friction)
 Sets the amount of inertia a scroller imposes during bounce animations.
double elm_config_scroll_page_scroll_friction_get (void)
 Gets the amount of inertia a paged scroller imposes during page fitting animations.
void elm_config_scroll_page_scroll_friction_set (double friction)
 Sets the amount of inertia a paged scroller imposes during page fitting animations.
double elm_config_scroll_bring_in_scroll_friction_get (void)
 Gets the amount of inertia a scroller imposes during region bring animations.
void elm_config_scroll_bring_in_scroll_friction_set (double friction)
 Sets the amount of inertia a scroller imposes during region bring animations.
double elm_config_scroll_zoom_friction_get (void)
 Gets the amount of inertia scrollers impose during animations triggered by Elementary widgets' zooming API.
void elm_config_scroll_zoom_friction_set (double friction)
 Sets the amount of inertia scrollers impose during animations triggered by Elementary widgets' zooming API.
Eina_Bool elm_config_scroll_thumbscroll_enabled_get (void)
 Gets whether scrollers should be draggable from any point in their views.
void elm_config_scroll_thumbscroll_enabled_set (Eina_Bool enabled)
 Sets whether scrollers should be draggable from any point in their views.
unsigned int elm_config_scroll_thumbscroll_threshold_get (void)
 Gets 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)
 Sets 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)
 Gets the number of pixels in the range that can be scrolled, while the scroller is held.
void elm_config_scroll_thumbscroll_hold_threshold_set (unsigned int threshold)
 Sets the number of pixels in the range that can be scrolled, while the scroller is held.
double elm_config_scroll_thumbscroll_momentum_threshold_get (void)
 Gets the minimum speed of the mouse cursor movement that triggers the list self scrolling animation after a mouse up event (pixels/second).
void elm_config_scroll_thumbscroll_momentum_threshold_set (double threshold)
 Sets the minimum speed of the mouse cursor movement that triggers the list self scrolling animation after a mouse up event (pixels/second).
unsigned int elm_config_scroll_thumbscroll_flick_distance_tolerance_get (void)
 Gets the number of pixels by which the maximum distance can be flicked. If it is flicked more than this, the flick distance is same as the maximum distance.
void elm_config_scroll_thumbscroll_flick_distance_tolerance_set (unsigned int distance)
 Sets the number of pixels by which the maximum distance can be flicked. If it is flicked more than this, the flick distance is same as the maximum distance.
double elm_config_scroll_thumbscroll_friction_get (void)
 Gets the amount of inertia a scroller imposes during self scrolling animations.
void elm_config_scroll_thumbscroll_friction_set (double friction)
 Sets the amount of inertia a scroller imposes during self scrolling animations.
double elm_config_scroll_thumbscroll_min_friction_get (void)
 Gets the minimum amount of inertia a scroller imposes durin self scrolling animations.
void elm_config_scroll_thumbscroll_min_friction_set (double friction)
 Sets the minimum amount of inertia a scroller imposes during self scrolling animations.
double elm_config_scroll_thumbscroll_friction_standard_get (void)
 Gets the standard velocity of the scroller. The scroll animation time is same as the thumbscroll friction, if the velocity is same as the standard velocity.
void elm_config_scroll_thumbscroll_friction_standard_set (double standard)
 Sets the standard velocity of the scroller. The scroll animation time is same as the thumbscroll friction, if the velocity is same as the standard velocity.
double elm_config_scroll_thumbscroll_border_friction_get (void)
 Gets the amount of lag between your actual mouse cursor dragging movement and a scroller's view movement itself, while pushing it into the bounce state manually.
void elm_config_scroll_thumbscroll_border_friction_set (double friction)
 Sets the amount of lag between your actual mouse cursor dragging movement and a scroller's view movement itself, while pushing it into the bounce state manually.
double elm_config_scroll_thumbscroll_sensitivity_friction_get (void)
 Gets the amount of sensitivity that is to be multiplied by the length of mouse dragging.
void elm_config_scroll_thumbscroll_sensitivity_friction_set (double friction)
 Sets the amount of sensitivity that is be multiplied by the length of mouse dragging.
double elm_config_scroll_thumbscroll_acceleration_threshold_get (void)
 Gets the minimum speed of the mouse cursor movement that accelerates scrolling velocity after a mouse up event (pixels/second).
void elm_config_scroll_thumbscroll_acceleration_threshold_set (double threshold)
 Sets the minimum speed of the mouse cursor movement that accelerates scrolling velocity after a mouse up event (pixels/second).
double elm_config_scroll_thumbscroll_acceleration_time_limit_get (void)
 Gets the time limit for accelerating velocity.
void elm_config_scroll_thumbscroll_acceleration_time_limit_set (double time_limit)
 Sets the time limit for accelerating velocity.
double elm_config_scroll_thumbscroll_acceleration_weight_get (void)
 Gets the weight for acceleration.
void elm_config_scroll_thumbscroll_acceleration_weight_set (double weight)
 Sets the weight for 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.

Function Documentation

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

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

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

Since :
2.3.1
Parameters:
[in]enabledThe thumb scroll bouncing state
See also:
elm_config_scroll_bounce_enabled_get()

Gets the amount of inertia a scroller imposes during bounce animations.

Since :
2.3.1
Returns:
The thumb scroll bounce friction
void elm_config_scroll_bounce_friction_set ( double  friction)

Sets the amount of inertia a scroller imposes during bounce animations.

Since :
2.3.1
Parameters:
[in]frictionThe thumb scroll bounce friction
See also:
elm_config_scroll_bounce_friction_get()

Gets the amount of inertia a scroller imposes during region bring animations.

Since :
2.3.1
Returns:
The bring in scroll friction

Sets the amount of inertia a scroller imposes during region bring animations.

Since :
2.3.1
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()

Gets the amount of inertia a paged scroller imposes during page fitting animations.

Since :
2.3.1
Returns:
The page scroll friction
void elm_config_scroll_page_scroll_friction_set ( double  friction)

Sets the amount of inertia a paged scroller imposes during page fitting animations.

Since :
2.3.1
Parameters:
[in]frictionThe page scroll friction
See also:
elm_config_scroll_page_scroll_friction_get()

Gets the minimum speed of the mouse cursor movement that accelerates scrolling velocity after a mouse up event (pixels/second).

Since :
2.3.1
Returns:
The thumb scroll acceleration threshold

Sets the minimum speed of the mouse cursor movement that accelerates scrolling velocity after a mouse up event (pixels/second).

Since :
2.3.1
Parameters:
[in]thresholdThe thumb scroll acceleration threshold
See also:
elm_config_thumbscroll_acceleration_threshold_get()

Gets the time limit for accelerating velocity.

Since :
2.3.1
Returns:
The thumb scroll acceleration time limit

Sets the time limit for accelerating velocity.

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

Gets the weight for acceleration.

Since :
2.3.1
Returns:
The thumb scroll acceleration weight

Sets the weight for acceleration.

Since :
2.3.1
Parameters:
[in]weightThe thumb scroll acceleration weight
See also:
elm_config_thumbscroll_acceleration_weight_get()

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

Since :
2.3.1
Returns:
The thumb scroll border friction

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

Since :
2.3.1
Remarks:
The parameter value gets bound to the 0.0 - 1.0 interval at all times.
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()

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

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

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

Since :
2.3.1
Parameters:
[in]enabledThe thumb scroll state
See also:
elm_config_scroll_thumbscroll_enabled_get()

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

Since :
2.3.1
Returns:
The maximum thumb scroll flick distance

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

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

Gets the amount of inertia a scroller imposes during self scrolling animations.

Since :
2.3.1
Returns:
The thumb scroll friction
void elm_config_scroll_thumbscroll_friction_set ( double  friction)

Sets the amount of inertia a scroller imposes during self scrolling animations.

Since :
2.3.1
Parameters:
[in]frictionThe thumb scroll friction
See also:
elm_config_thumbscroll_friction_get()

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

Since :
2.3.1
Returns:
The thumb scroll friction

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

Since :
2.3.1
Parameters:
[in]standardThe standard thumb scroll friction
See also:
elm_config_thumbscroll_friction_standard_get()

Gets the number of pixels in the range that can be scrolled, while the scroller is held.

Since :
2.3.1
Returns:
The thumb scroll hold threshold
void elm_config_scroll_thumbscroll_hold_threshold_set ( unsigned int  threshold)

Sets the number of pixels in the range that can be scrolled, while the scroller is held.

Since :
2.3.1
Parameters:
[in]thresholdThe thumb scroll hold threshold
See also:
elm_config_thumbscroll_hold_threshold_get()

Gets the minimum amount of inertia a scroller imposes durin self scrolling animations.

Since :
2.3.1
Returns:
The minimum thumb scroll friction

Sets the minimum amount of inertia a scroller imposes during self scrolling animations.

Since :
2.3.1
Parameters:
[in]frictionThe minimum thumb scroll friction
See also:
elm_config_thumbscroll_min_friction_get()

Gets the minimum speed of the mouse cursor movement that triggers the list self scrolling animation after a mouse up event (pixels/second).

Since :
2.3.1
Returns:
The thumb scroll momentum threshold

Sets the minimum speed of the mouse cursor movement that triggers the list self scrolling animation after a mouse up event (pixels/second).

Since :
2.3.1
Parameters:
[in]thresholdThe thumb scroll momentum threshold
See also:
elm_config_thumbscroll_momentum_threshold_get()

Gets the amount of sensitivity that is to be multiplied by the length of mouse dragging.

Since :
2.3.1
Returns:
The thumb scroll sensitivity friction

Sets the amount of sensitivity that is be multiplied by the length of mouse dragging.

Since :
2.3.1
Remarks:
The parameter value gets bound to the 0.1 - 1.0 interval at all times
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()

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

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

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

Since :
2.3.1
Parameters:
[in]thresholdThe thumb scroll threshold
See also:
elm_config_thumbscroll_threshold_get()

Gets the amount of inertia scrollers impose during animations triggered by Elementary widgets' zooming API.

Since :
2.3.1
Returns:
The zoom friction
void elm_config_scroll_zoom_friction_set ( double  friction)

Sets the amount of inertia scrollers impose during animations triggered by Elementary widgets' zooming API.

Since :
2.3.1
Parameters:
[in]frictionThe zoom friction
See also:
elm_config_scroll_zoom_friction_get()