Grid

Functions

Evas_Object * elm_grid_add (Evas_Object *parent)
 Add a new grid to the parent.
void elm_grid_size_set (Evas_Object *obj, Evas_Coord w, Evas_Coord h)
 Set the virtual size of the grid.
void elm_grid_size_get (const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h)
 Get the virtual size of the grid.
void elm_grid_pack (Evas_Object *obj, Evas_Object *subobj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
 Pack child at given position and size.
void elm_grid_unpack (Evas_Object *obj, Evas_Object *subobj)
 Unpack a child from a grid object.
void elm_grid_clear (Evas_Object *obj, Eina_Bool clear)
 Faster way to remove all child objects from a grid object.
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.
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.
Eina_List * elm_grid_children_get (const Evas_Object *obj)
 Get the list of the children for the grid.

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 Evas_Object *  obj)

Get the list of the children for the grid.

Parameters:
objThe grid object
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_WIDGET_DATA.

void elm_grid_clear ( Evas_Object *  obj,
Eina_Bool  clear 
)

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

Parameters:
objThe grid object
clearIf true, it will delete just removed children

References ELM_WIDGET_DATA.

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

Pack child at given position and size.

Parameters:
objThe grid object
subobjThe child to pack
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

References ELM_WIDGET_DATA.

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

References ELM_WIDGET_DATA.

void elm_grid_size_get ( const Evas_Object *  obj,
Evas_Coord *  w,
Evas_Coord *  h 
)

Get the virtual size of the grid.

Parameters:
objThe grid object
wPointer to integer to store the virtual width of the grid
hPointer to integer to store the virtual height of the grid

References ELM_WIDGET_DATA.

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

Set the virtual size of the grid.

Parameters:
objThe grid object
wThe virtual width of the grid
hThe virtual height of the grid

References ELM_WIDGET_DATA.

void elm_grid_unpack ( Evas_Object *  obj,
Evas_Object *  subobj 
)

Unpack a child from a grid object.

Parameters:
objThe grid object
subobjThe child to unpack

References ELM_WIDGET_DATA.