Elementary Scrolling

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

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.
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).
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_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.

Detailed Description

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


Function Documentation

Eina_Bool elm_config_scroll_bounce_enabled_get ( void  )

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

Returns:
the thumb scroll bouncing state

This is the default behavior for touch screens, in general.

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.

Parameters:
enabledthe thumb scroll bouncing state
See also:
elm_config_scroll_bounce_enabled_get()
double elm_config_scroll_bounce_friction_get ( void  )

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

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.

Parameters:
frictionthe thumb scroll bounce friction
See also:
elm_config_scroll_bounce_friction_get()
double elm_config_scroll_bring_in_scroll_friction_get ( void  )

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

Returns:
the bring in scroll friction
void elm_config_scroll_bring_in_scroll_friction_set ( double  friction)

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

Parameters:
frictionthe bring in scroll friction
See also:
elm_config_scroll_bring_in_scroll_friction_get()
double elm_config_scroll_page_scroll_friction_get ( void  )

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

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.

Parameters:
frictionthe page scroll friction
See also:
elm_config_scroll_page_scroll_friction_get()
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.

Returns:
the thumb scroll border friction
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.

Parameters:
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()
Note:
parameter value will get bound to 0.0 - 1.0 interval, always
Eina_Bool elm_config_scroll_thumbscroll_enabled_get ( void  )

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

Returns:
the thumb scroll state
Note:
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.
void elm_config_scroll_thumbscroll_enabled_set ( Eina_Bool  enabled)

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

Parameters:
enabledthe thumb scroll state
See also:
elm_config_scroll_thumbscroll_enabled_get()
double elm_config_scroll_thumbscroll_friction_get ( void  )

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

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.

Parameters:
frictionthe thumb scroll friction
See also:
elm_config_thumbscroll_friction_get()
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).

Returns:
the thumb scroll momentum threshold
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).

Parameters:
thresholdthe thumb scroll momentum threshold
See also:
elm_config_thumbscroll_momentum_threshold_get()
double elm_config_scroll_thumbscroll_sensitivity_friction_get ( void  )

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

Returns:
the thumb scroll sensitivity friction
void elm_config_scroll_thumbscroll_sensitivity_friction_set ( double  friction)

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

Parameters:
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()
Note:
parameter value will get bound to 0.1 - 1.0 interval, always
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.

Returns:
the thumb scroll threshold

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.

Parameters:
thresholdthe thumb scroll threshold
See also:
elm_config_thumbscroll_threshold_get()
double elm_config_scroll_zoom_friction_get ( void  )

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

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.

Parameters:
frictionthe zoom friction
See also:
elm_config_scroll_zoom_friction_get()