Pager

The pager is an object that allows flipping (with animation) between 1 or more “pages” of objects, much like a stack of windows within the window. More...


Functions

EAPI Evas_Object * elm_pager_add (Evas_Object *parent)
 Add a new pager to the parent.
EAPI void elm_pager_content_push (Evas_Object *obj, Evas_Object *content)
 Push an object to the top of the pager stack (and show it).
EAPI void elm_pager_content_pop (Evas_Object *obj)
 Pop the object that is on top of the stack.
EAPI void elm_pager_content_promote (Evas_Object *obj, Evas_Object *content)
 Promote an object already in the pager stack to the top of the stack.
EAPI Evas_Object * elm_pager_content_bottom_get (Evas_Object *obj)
 Return the object at the bottom of the pager stack.
EAPI Evas_Object * elm_pager_content_top_get (Evas_Object *obj)
 Return the object at the top of the pager stack.

Detailed Description

The pager is an object that allows flipping (with animation) between 1 or more “pages” of objects, much like a stack of windows within the window.

Objects can be pushed or popped from he stack or deleted as normal. Pushes and pops will animate (and a pop will delete the object once the animation is finished). Any object in the pager can be promoted to the top (from its current stacking position) as well. Objects are pushed to the top with elm_pager_content_push() and when the top item is no longer wanted, simply pop it with elm_pager_content_pop() and it will also be deleted. Any object you wish to promote to the top that is already in the pager, simply use elm_pager_content_promote(). If an object is no longer needed and is not the top item, just delete it as normal. You can query which objects are the top and bottom with elm_pager_content_bottom_get() and elm_pager_content_top_get().

Function Documentation

EAPI Evas_Object* elm_pager_add ( Evas_Object *  parent  ) 

Add a new pager to the parent.

Parameters:
parent The parent object
Returns:
The new object or NULL if it cannot be created

EAPI Evas_Object* elm_pager_content_bottom_get ( Evas_Object *  obj  ) 

Return the object at the bottom of the pager stack.

Parameters:
obj The pager object
Returns:
The bottom object or NULL if none

EAPI void elm_pager_content_pop ( Evas_Object *  obj  ) 

Pop the object that is on top of the stack.

This pops the object that is on top (visible) in the pager, makes it disappear, then deletes the object. The object that was underneath it on the stack will become visible.

Parameters:
obj The pager object

References elm_pager_content_promote().

EAPI void elm_pager_content_promote ( Evas_Object *  obj,
Evas_Object *  content 
)

Promote an object already in the pager stack to the top of the stack.

This will take the indicated object and promote it to the top of the stack as if it had been pushed there. The object must already be inside the pager stack to work.

Parameters:
obj The pager object
content The object to promote

Referenced by elm_pager_content_pop().

EAPI void elm_pager_content_push ( Evas_Object *  obj,
Evas_Object *  content 
)

Push an object to the top of the pager stack (and show it).

The object pushed becomes a child of the pager and will be controlled it and deleted when the pager is deleted.

Parameters:
obj The pager object
content The object to push

EAPI Evas_Object* elm_pager_content_top_get ( Evas_Object *  obj  ) 

Return the object at the top of the pager stack.

Parameters:
obj The pager object
Returns:
The top object or NULL if none