Functions
Grid

Functions

EOAPI void elm_obj_grid_size_set (Evas_Coord w, Evas_Coord h)
 Set the virtual size of the grid. More...
 
EOAPI void elm_obj_grid_size_get (Evas_Coord *w, Evas_Coord *h)
 Get the virtual size of the grid. More...
 
EOAPI Eina_List * elm_obj_grid_children_get (void)
 Get the list of the children for the grid. More...
 
EOAPI void elm_obj_grid_clear (Eina_Bool clear)
 Faster way to remove all child objects from a grid object. More...
 
EOAPI void elm_obj_grid_unpack (Evas_Object *subobj)
 Unpack a child from a grid object. More...
 
EOAPI void elm_obj_grid_pack (Evas_Object *subobj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
 Pack child at given position and size. More...
 
void elm_grid_size_set (Elm_Grid *obj, Evas_Coord w, Evas_Coord h)
 Set the virtual size of the grid. More...
 
void elm_grid_size_get (const Elm_Grid *obj, Evas_Coord *w, Evas_Coord *h)
 Get the virtual size of the grid. More...
 
Eina_List * elm_grid_children_get (const Elm_Grid *obj)
 Get the list of the children for the grid. More...
 
void elm_grid_clear (Elm_Grid *obj, Eina_Bool clear)
 Faster way to remove all child objects from a grid object. More...
 
void elm_grid_unpack (Elm_Grid *obj, Evas_Object *subobj)
 Unpack a child from a grid object. More...
 
void elm_grid_pack (Elm_Grid *obj, Evas_Object *subobj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
 Pack child at given position and size. More...
 
Evas_Object * elm_grid_add (Evas_Object *parent)
 Add a new grid to the parent. More...
 
void elm_grid_pack_set (Evas_Object *subobj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
 Set packing of an existing child at to position and size. More...
 
void elm_grid_pack_get (Evas_Object *subobj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
 Get packing of a child. More...
 

Detailed Description

grid_inheritance_tree.png

The grid is a grid layout widget that lays out a series of children as a fixed "grid" of widgets using a given percentage of the grid width and height each using the child object.

The Grid uses a "Virtual resolution" that is stretched to fill the grid widgets size itself. The default is 100 x 100, so that means the position and sizes of children will effectively be percentages (0 to 100) of the width or height of the grid widget

Function Documentation

Evas_Object* elm_grid_add ( Evas_Object *  parent)

Add a new grid to the parent.

Parameters
parentThe parent object
Returns
The new object or NULL if it cannot be created
Eina_List* elm_grid_children_get ( const Elm_Grid *  obj)

Get the list of the children for the grid.

Note
This is a duplicate of the list kept by the grid internally. It's up to the user to destroy it when it no longer needs it. It's possible to remove objects from the grid when walking this list, but these removals won't be reflected on it.

References elm_obj_grid_children_get().

void elm_grid_clear ( Elm_Grid *  obj,
Eina_Bool  clear 
)

Faster way to remove all child objects from a grid object.

Parameters
[in]clearIf true, it will delete just removed children

References elm_obj_grid_clear().

void elm_grid_pack ( Elm_Grid *  obj,
Evas_Object *  subobj,
Evas_Coord  x,
Evas_Coord  y,
Evas_Coord  w,
Evas_Coord  h 
)

Pack child at given position and size.

Parameters
[in]xThe virtual x coord at which to pack it.
[in]yThe virtual y coord at which to pack it.
[in]wThe virtual width at which to pack it.
[in]hThe virtual height at which to pack it.

References elm_obj_grid_pack().

void elm_grid_pack_get ( Evas_Object *  subobj,
Evas_Coord *  x,
Evas_Coord *  y,
Evas_Coord *  w,
Evas_Coord *  h 
)

Get packing of a child.

Parameters
subobjThe child to query
xPointer to integer to store the virtual x coord
yPointer to integer to store the virtual y coord
wPointer to integer to store the virtual width
hPointer to integer to store the virtual height
void elm_grid_pack_set ( Evas_Object *  subobj,
Evas_Coord  x,
Evas_Coord  y,
Evas_Coord  w,
Evas_Coord  h 
)

Set packing of an existing child at to position and size.

Parameters
subobjThe child to set packing of
xThe virtual x coord at which to pack it
yThe virtual y coord at which to pack it
wThe virtual width at which to pack it
hThe virtual height at which to pack it
void elm_grid_size_get ( const Elm_Grid *  obj,
Evas_Coord *  w,
Evas_Coord *  h 
)

Get the virtual size of the grid.

Parameters
[out]wThe virtual width of the grid
[out]hThe virtual height of the grid

References elm_obj_grid_size_get().

void elm_grid_size_set ( Elm_Grid *  obj,
Evas_Coord  w,
Evas_Coord  h 
)

Set the virtual size of the grid.

Parameters
[in]wThe virtual width of the grid
[in]hThe virtual height of the grid

References elm_obj_grid_size_set().

void elm_grid_unpack ( Elm_Grid *  obj,
Evas_Object *  subobj 
)

Unpack a child from a grid object.

Parameters
[in]subobjThe child to unpack

References elm_obj_grid_unpack().

EOAPI Eina_List* elm_obj_grid_children_get ( void  )

Get the list of the children for the grid.

Note
This is a duplicate of the list kept by the grid internally. It's up to the user to destroy it when it no longer needs it. It's possible to remove objects from the grid when walking this list, but these removals won't be reflected on it.

Referenced by elm_grid_children_get().

EOAPI void elm_obj_grid_clear ( Eina_Bool  clear)

Faster way to remove all child objects from a grid object.

Parameters
[in]clearIf true, it will delete just removed children

Referenced by elm_grid_clear().

EOAPI void elm_obj_grid_pack ( Evas_Object *  subobj,
Evas_Coord  x,
Evas_Coord  y,
Evas_Coord  w,
Evas_Coord  h 
)

Pack child at given position and size.

Parameters
[in]xThe virtual x coord at which to pack it.
[in]yThe virtual y coord at which to pack it.
[in]wThe virtual width at which to pack it.
[in]hThe virtual height at which to pack it.

Referenced by elm_grid_pack().

EOAPI void elm_obj_grid_size_get ( Evas_Coord *  w,
Evas_Coord *  h 
)

Get the virtual size of the grid.

Parameters
[out]wThe virtual width of the grid
[out]hThe virtual height of the grid

Referenced by elm_grid_size_get().

EOAPI void elm_obj_grid_size_set ( Evas_Coord  w,
Evas_Coord  h 
)

Set the virtual size of the grid.

Parameters
[in]wThe virtual width of the grid
[in]hThe virtual height of the grid

Referenced by elm_grid_size_set().

EOAPI void elm_obj_grid_unpack ( Evas_Object *  subobj)

Unpack a child from a grid object.

Parameters
[in]subobjThe child to unpack

Referenced by elm_grid_unpack().