This group provides functions to handle scroll behavior of Elementary Widgets.

Objects when inside a scroller can scroll, but this may not always be desirable in certain situations. This allows an object to hint to itself and its parents to "not scroll" in one of the following 2 ways. If any child object of a scroller has pushed a scroll freeze or hold then it affects all parent scrollers until all children have released them.

1. To hold on scrolling. This means just flicking and dragging may no longer scroll, but pressing/dragging near the edge of the scroller still scrolls. This is automatically used by the entry object when selecting text.

2. To totally freeze scrolling. This means it stops until popped/released.

Functions
void	elm_object_scroll_hold_push (Evas_Object *obj)
	Pushes the scroll hold by `1`.
void	elm_object_scroll_hold_pop (Evas_Object *obj)
	Pops the scroll hold by `1`.
int	elm_object_scroll_hold_get (const Evas_Object *obj)
	Gets the scroll hold by `1`.
void	elm_object_scroll_freeze_push (Evas_Object *obj)
	Pushes the scroll freeze by `1`.
void	elm_object_scroll_freeze_pop (Evas_Object *obj)
	Pops the scroll freeze by `1`.
int	elm_object_scroll_freeze_get (const Evas_Object *obj)
	Gets the scroll freeze by `1`.
void	elm_object_scroll_lock_x_set (Evas_Object *obj, Eina_Bool lock)
	Locks the scrolling of the given widget (and thus all the parents).
void	elm_object_scroll_lock_y_set (Evas_Object *obj, Eina_Bool lock)
	Locks the scrolling of the given widget (and thus all the parents).
Eina_Bool	elm_object_scroll_lock_x_get (const Evas_Object *obj)
	Gets the scrolling lock of the given widget.
Eina_Bool	elm_object_scroll_lock_y_get (const Evas_Object *obj)
	Gets the scrolling lock of the given widget.

Function Documentation

int elm_object_scroll_freeze_get ( const Evas_Object * obj )

Gets the scroll freeze by 1.

This gets the scroll freeze count by 1.

Since (EFL) :: 1.7

Since :: 2.3.1

Parameters:

[in] obj The object

Returns:: The scroll freeze count

void elm_object_scroll_freeze_pop ( Evas_Object * obj )

Pops the scroll freeze by 1.

This decrements the scroll freeze count by 1. If it is more than 0 it takes effect on the parents of the indicated object.

Since :: 2.3.1

Parameters:

[in] obj The object

void elm_object_scroll_freeze_push ( Evas_Object * obj )

Pushes the scroll freeze by 1.

This increments the scroll freeze count by 1. If it is more than 0 it takes effect on the parents of the indicated object.

Since :: 2.3.1

Parameters:

[in] obj The object

int elm_object_scroll_hold_get ( const Evas_Object * obj )

Gets the scroll hold by 1.

This gets the scroll hold count by 1.

Since (EFL) :: 1.7

Since :: 2.3.1

Parameters:

[in] obj The object

Returns:: The scroll hold count

void elm_object_scroll_hold_pop ( Evas_Object * obj )

Pops the scroll hold by 1.

This decrements the scroll hold count by one. If it is more than 0 it takes effect on the parents of the indicated object.

Since :: 2.3.1

Parameters:

[in] obj The object

void elm_object_scroll_hold_push ( Evas_Object * obj )

Pushes the scroll hold by 1.

This increments the scroll hold count by one. If it is more than 0 it takes effect on the parents of the indicated object.

Since :: 2.3.1

Parameters:

[in] obj The object

Eina_Bool elm_object_scroll_lock_x_get ( const Evas_Object * obj )

Gets the scrolling lock of the given widget.

This gets the lock for the X axis scrolling.

Since :: 2.3.1

Parameters:

[in] obj The object

Returns:: EINA_TRUE if it is locked, otherwise EINA_FALSE

void elm_object_scroll_lock_x_set	(	Evas_Object *	obj,
		Eina_Bool	lock
	)

Locks the scrolling of the given widget (and thus all the parents).

This locks the given object from scrolling in the X axis (and implicitly locks all the parent scrollers too from doing the same).

Since :: 2.3.1

Parameters:

obj	The object
lock	The lock state (`1` == locked, `0` == unlocked)

Eina_Bool elm_object_scroll_lock_y_get ( const Evas_Object * obj )

Gets the scrolling lock of the given widget.

This gets the lock for the Y axis scrolling.

Since :: 2.3.1

Parameters:

[in] obj The object

Returns:: EINA_TRUE if it is locked, otherwise EINA_FALSE

void elm_object_scroll_lock_y_set	(	Evas_Object *	obj,
		Eina_Bool	lock
	)

Locks the scrolling of the given widget (and thus all the parents).

This locks the given object from scrolling in the Y axis (and implicitly locks all the parent scrollers too from doing the same).

Since :: 2.3.1

Parameters:

[in]	obj	The object
[in]	lock	The lock state (`1` == locked, `0` == unlocked)

Functions

Function Documentation