Tizen Native API  5.5
Elementary Scrolling

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

Functions

Eina_Bool elm_config_scroll_bounce_enabled_get (void)
void elm_config_scroll_bounce_enabled_set (Eina_Bool enabled)
double elm_config_scroll_bounce_friction_get (void)
void elm_config_scroll_bounce_friction_set (double friction)
double elm_config_scroll_page_scroll_friction_get (void)
void elm_config_scroll_page_scroll_friction_set (double friction)
double elm_config_scroll_bring_in_scroll_friction_get (void)
void elm_config_scroll_bring_in_scroll_friction_set (double friction)
double elm_config_scroll_zoom_friction_get (void)
void elm_config_scroll_zoom_friction_set (double friction)
Eina_Bool elm_config_scroll_thumbscroll_enabled_get (void)
void elm_config_scroll_thumbscroll_enabled_set (Eina_Bool enabled)
unsigned int elm_config_scroll_thumbscroll_threshold_get (void)
void elm_config_scroll_thumbscroll_threshold_set (unsigned int threshold)
unsigned int elm_config_scroll_thumbscroll_hold_threshold_get (void)
void elm_config_scroll_thumbscroll_hold_threshold_set (unsigned int threshold)
double elm_config_scroll_thumbscroll_momentum_threshold_get (void)
void elm_config_scroll_thumbscroll_momentum_threshold_set (double threshold)
double elm_config_scroll_thumbscroll_border_friction_get (void)
void elm_config_scroll_thumbscroll_border_friction_set (double friction)
double elm_config_scroll_thumbscroll_sensitivity_friction_get (void)
void elm_config_scroll_thumbscroll_sensitivity_friction_set (double friction)
Eina_Bool elm_config_scroll_thumbscroll_smooth_start_get (void)
void elm_config_scroll_thumbscroll_smooth_start_set (Eina_Bool enable)
double elm_config_scroll_thumbscroll_smooth_amount_get (void)
void elm_config_scroll_thumbscroll_smooth_amount_set (double amount)
double elm_config_scroll_thumbscroll_smooth_time_window_get (void)
void elm_config_scroll_thumbscroll_smooth_time_window_set (double amount)
double elm_config_scroll_thumbscroll_acceleration_threshold_get (void)
void elm_config_scroll_thumbscroll_acceleration_threshold_set (double threshold)
double elm_config_scroll_thumbscroll_acceleration_time_limit_get (void)
void elm_config_scroll_thumbscroll_acceleration_time_limit_set (double time_limit)
double elm_config_scroll_thumbscroll_acceleration_weight_get (void)
void elm_config_scroll_thumbscroll_acceleration_weight_set (double weight)
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.
double elm_config_scroll_thumbscroll_min_friction_get (void)
void elm_config_scroll_thumbscroll_min_friction_set (double friction)
double elm_config_scroll_thumbscroll_friction_standard_get (void)
void elm_config_scroll_thumbscroll_friction_standard_set (double standard)
unsigned int elm_config_scroll_thumbscroll_flick_distance_tolerance_get (void)
void elm_config_scroll_thumbscroll_flick_distance_tolerance_set (unsigned int distance)
double elm_config_scroll_thumbscroll_friction_get (void)
void elm_config_scroll_thumbscroll_friction_set (double friction)

Function Documentation

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.

Since :
2.3

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

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

Returns:
the thumb scroll bounce friction
Since :
2.3
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()
Since :
2.3

Get enable status of context menu disabled.

See also:
elm_config_context_menu_disabled_set()
Returns:
EINA_TRUE if context menu is disabled, otherwise EINA_FALSE.
Since (EFL) :
1.17 Enable or disable the context menu in entries.
Parameters:
disableddisable context menu if EINA_TRUE, enable otherwise
See also:
elm_config_context_menu_disabled_get()
Since (EFL) :
1.17 Get the amount of inertia a scroller will impose at region bring animations.
Returns:
the bring in scroll friction
Since :
2.3

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

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

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

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

Returns:
the page scroll friction
Since :
2.3
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()
Since :
2.3

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

Returns:
the thumb scroll acceleration threshold
Since :
2.3

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

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

Get the time limit for accelerating velocity.

Returns:
the thumb scroll acceleration time limit
Since :
2.3

Set the time limit for accelerating velocity.

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

Get the weight for the acceleration.

Returns:
the thumb scroll acceleration weight
Since :
2.3

Set the weight for the acceleration.

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

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.

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.
Parameters:
distancethe thumb scroll maximum flick distance
See also:
elm_config_thumbscroll_momentum_distance_max_get() Get the scale ratio of geometric sequence as a kind of inertia a scroller will impose at self scrolling animations.
Returns:
the thumb scroll friction Set the scale ratio of geometric sequence as a kind of inertia a scroller will impose at self scrolling animations.
Parameters:
frictionthe thumb scroll friction
See also:
elm_config_thumbscroll_momentum_friction_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.
Returns:
the thumb scroll border friction
Since :
2.3

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
Since :
2.3

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.
Since :
2.3

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

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.

Returns:
the thumb scroll maximum flick distance
Deprecated:
Since :
2.3

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.

Parameters:
distancethe thumb scroll maximum flick distance
Deprecated:
See also:
elm_config_thumbscroll_flick_distance_tolerance_get()
Since :
2.3

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

Returns:
the thumb scroll friction
Deprecated:
Since :
2.3
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
Deprecated:
See also:
elm_config_thumbscroll_friction_get()
Since :
2.3

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

Returns:
the thumb scroll friction
Deprecated:
Since :
2.3

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

Parameters:
standardthe thumb scroll friction standard
Deprecated:
See also:
elm_config_thumbscroll_friction_standard_get()
Since :
2.3

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

Returns:
the thumb scroll hold threshold
Since :
2.3
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.

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

Get the min limit for the momentum animation duration(unit:second)

Returns:
the thumb scroll momentum animation duration min limit Set the min limit for the momentum animation duration(unit:second)
Parameters:
thethumb scroll momentum animation duration min limit
See also:
elm_config_scroll_thumbscroll_acceleration_weight_set() Get the max limit for the momentum animation duration(unit:second)
Returns:
the thumb scroll momentum animation duration max limit Set the max limit for the momentum animation duration(unit:second)
Parameters:
thethumb scroll momentum animation duration max limit
See also:
elm_config_scroll_thumbscroll_momentum_animation_duration_max_limit_get() Get the min amount of inertia a scroller will impose at self scrolling animations.
Returns:
the thumb scroll min friction
Deprecated:
Since :
2.3

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

Parameters:
frictionthe thumb scroll min friction
Deprecated:
See also:
elm_config_thumbscroll_min_friction_get()
Since :
2.3

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
Since :
2.3

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

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

Returns:
the thumb scroll sensitivity friction
Since :
2.3

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
Since :
2.3

Get the value of this option

Returns:
State of this option
See also:
elm_config_scroll_animation_disabled_set()
Since (EFL) :
1.18 Set the value for this option

This option disables timed animations during scrolling and forces scroll actions to be performed immediately.

Parameters:
disableThe state of this option
See also:
elm_config_scroll_animation_disabled_get()
Since (EFL) :
1.18 Get the value of this option
Returns:
State of this option
See also:
elm_config_scroll_accel_factor_set()
Since (EFL) :
1.18 Set the value for this option

Using a mouse wheel or touchpad to scroll will result in events being processed. If events occur quickly, the scroll amount will be multiplied by this value to accelerate the scrolling.

Parameters:
factorThe value of this option from 0.0 to 10.0
See also:
elm_config_scroll_accel_factor_get()
Note:
Set 0.0 to disable acceleration
Since (EFL) :
1.18 Get the amount of smoothing to apply to scrolling
Returns:
the amount of smoothing to apply from 0.0 to 1.0
See also:
elm_config_scroll_thumbscroll_smooth_amount_set()
Since (EFL) :
1.16
Since :
3.0f(2.3.1)

Set the amount of smoothing to apply to scrolling

Scrolling with your finger can be smoothed out and the amount to smooth is determined by this parameter. 0.0 means to not smooth at all and 1.0 is to smooth as much as possible.

Parameters:
amountthe amount to smooth from 0.0 to 1.0 with 0.0 being none
See also:
elm_config_thumbscroll_acceleration_threshold_set()
Since (EFL) :
1.16
Since :
3.0f(2.3.1)

Get the smooth start mode for scrolling with your finger

Returns:
smooth scroll flag
See also:
elm_config_scroll_thumbscroll_smooth_start_set()
Since (EFL) :
1.16
Since :
3.0f(2.3.1)

Set the smooth start mode for scrolling with your finger

This enabled finger scrolling to scroll from the currunt point rather than jumping and playing catch-up to make start of scrolling look smoother once the finger or mouse goes past the threshold.

Parameters:
enableThe enabled state of the smooth scroller
See also:
elm_config_scroll_thumbscroll_smooth_start_get()
Since (EFL) :
1.16
Since :
3.0f(2.3.1)

Get the time window to look back at for events for smoothing

Returns:
the time window in seconds (between 0.0 and 1.0)
See also:
elm_config_scroll_thumbscroll_smooth_time_window_set()
Since (EFL) :
1.16
Since :
3.0f(2.3.1)

Set the time window to look back at for events for smoothing

Scrolling with your finger can be smoothed out and the window of time to look at is determined by this config. The value is in seconds and is from 0.0 to 1.0

Parameters:
amountthe time window in seconds (between 0.0 and 1.0)
See also:
elm_config_scroll_thumbscroll_smooth_time_window_get()
Since (EFL) :
1.16
Since :
3.0f(2.3.1)

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.

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

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

Returns:
the zoom friction
Since :
2.3
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()
Since :
2.3