A box is a convenience smart object that packs children inside it in sequence, using a layouting function specified by the user. More...
Data Structures | |
struct | _Evas_Object_Box_Api |
This structure should be used by any smart class inheriting from the box's one, to provide custom box behavior which could not be achieved only by providing a layout function, with evas_object_box_layout_set(). More... | |
struct | _Evas_Object_Box_Data |
This structure augments clipped smart object's instance data, providing extra members required by generic box implementation. More... | |
struct | _Evas_Object_Box_Option |
Evas_Object_Box_Option struct fields More... | |
Macros | |
#define | EVAS_OBJECT_BOX_API_VERSION 1 |
Current version for Evas box object smart class, a value which goes to _Evas_Object_Box_Api::version. | |
#define | EVAS_OBJECT_BOX_API_INIT(smart_class_init) {smart_class_init, EVAS_OBJECT_BOX_API_VERSION, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL} |
Initializer for a whole Evas_Object_Box_Api structure, with NULL values on its specific fields. More... | |
#define | EVAS_OBJECT_BOX_API_INIT_NULL EVAS_OBJECT_BOX_API_INIT(EVAS_SMART_CLASS_INIT_NULL) |
Initializer to zero out a whole Evas_Object_Box_Api structure. More... | |
#define | EVAS_OBJECT_BOX_API_INIT_VERSION EVAS_OBJECT_BOX_API_INIT(EVAS_SMART_CLASS_INIT_VERSION) |
Initializer to zero out a whole Evas_Object_Box_Api structure and set a specific version on it. More... | |
#define | EVAS_OBJECT_BOX_API_INIT_NAME_VERSION(name) EVAS_OBJECT_BOX_API_INIT(EVAS_SMART_CLASS_INIT_NAME_VERSION(name)) |
Initializer to zero out a whole Evas_Object_Box_Api structure and set its name and version. More... | |
Typedefs | |
typedef struct _Evas_Object_Box_Api | Evas_Object_Box_Api |
Smart class extension, providing extra box object requirements. | |
typedef struct _Evas_Object_Box_Data | Evas_Object_Box_Data |
Smart object instance data, providing box object requirements. | |
typedef struct _Evas_Object_Box_Option | Evas_Object_Box_Option |
The base structure for a box option. More... | |
typedef void(* | Evas_Object_Box_Layout) (Evas_Object *o, Evas_Object_Box_Data *priv, void *user_data) |
Function signature for an Evas box object layouting routine. More... | |
Functions | |
void | evas_object_box_smart_set (Evas_Object_Box_Api *api) |
Set the default box api struct (Evas_Object_Box_Api) with the default values. More... | |
const Evas_Object_Box_Api * | evas_object_box_smart_class_get (void) |
Get the Evas box smart class, for inheritance purposes. More... | |
const Eo_Class * | evas_object_box_class_get (void) |
#define | EVAS_OBJ_BOX_CLASS evas_object_box_class_get() |
#define | EVAS_OBJ_BOX_ID(sub_id) (EVAS_OBJ_BOX_BASE_ID + sub_id) |
#define | evas_obj_box_internal_append(child, option) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_APPEND), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
#define | evas_obj_box_internal_prepend(child, option) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_PREPEND), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
#define | evas_obj_box_internal_insert_before(child, reference, option) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_INSERT_BEFORE), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(const Evas_Object *, reference), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
#define | evas_obj_box_internal_insert_after(child, reference, option) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_INSERT_AFTER), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(const Evas_Object *, reference), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
#define | evas_obj_box_internal_insert_at(child, pos, option) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_INSERT_AT), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(unsigned int, pos), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
#define | evas_obj_box_internal_remove(child, result) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_REMOVE), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object **, result) |
#define | evas_obj_box_internal_remove_at(pos, result) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_REMOVE_AT), EO_TYPECHECK(unsigned int, pos), EO_TYPECHECK(Evas_Object **, result) |
#define | evas_obj_box_internal_option_new(child, ret) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_OPTION_NEW), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object_Box_Option **, ret) |
#define | evas_obj_box_internal_option_free(opt) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_OPTION_FREE), EO_TYPECHECK(Evas_Object_Box_Option *, opt) |
#define | evas_obj_box_add_to(o) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_ADD_TO), EO_TYPECHECK(Evas_Object **, o) |
#define | evas_obj_box_layout_set(cb, data, free_data) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_SET), EO_TYPECHECK(Evas_Object_Box_Layout, cb), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Eina_Free_Cb, free_data) |
#define | evas_obj_box_layout_horizontal() EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_HORIZONTAL) |
#define | evas_obj_box_layout_vertical() EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_VERTICAL) |
#define | evas_obj_box_layout_homogeneous_horizontal() EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_HOMOGENEOUS_HORIZONTAL) |
#define | evas_obj_box_layout_homogeneous_vertical() EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_HOMOGENEOUS_VERTICAL) |
#define | evas_obj_box_layout_homogeneous_max_size_horizontal() EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_HOMOGENEOUS_MAX_SIZE_HORIZONTAL) |
#define | evas_obj_box_layout_homogeneous_max_size_vertical() EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_HOMOGENEOUS_MAX_SIZE_VERTICAL) |
#define | evas_obj_box_layout_flow_horizontal() EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_FLOW_HORIZONTAL) |
#define | evas_obj_box_layout_flow_vertical() EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_FLOW_VERTICAL) |
#define | evas_obj_box_layout_stack() EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_STACK) |
#define | evas_obj_box_align_set(horizontal, vertical) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_ALIGN_SET), EO_TYPECHECK(double, horizontal), EO_TYPECHECK(double, vertical) |
#define | evas_obj_box_align_get(horizontal, vertical) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_ALIGN_GET), EO_TYPECHECK(double *, horizontal), EO_TYPECHECK(double *, vertical) |
#define | evas_obj_box_padding_set(horizontal, vertical) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_PADDING_SET), EO_TYPECHECK(Evas_Coord, horizontal), EO_TYPECHECK(Evas_Coord, vertical) |
#define | evas_obj_box_padding_get(horizontal, vertical) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_PADDING_GET), EO_TYPECHECK(Evas_Coord *, horizontal), EO_TYPECHECK(Evas_Coord *, vertical) |
#define | evas_obj_box_append(child, option) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_APPEND), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
#define | evas_obj_box_prepend(child, option) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_PREPEND), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
#define | evas_obj_box_insert_before(child, reference, option) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INSERT_BEFORE), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(const Evas_Object *, reference), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
#define | evas_obj_box_insert_after(child, reference, option) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INSERT_AFTER), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(const Evas_Object *, reference), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
#define | evas_obj_box_insert_at(child, pos, option) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INSERT_AT), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(unsigned int, pos), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
#define | evas_obj_box_remove(child, result) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_REMOVE), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Eina_Bool *, result) |
#define | evas_obj_box_remove_at(pos, result) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_REMOVE_AT), EO_TYPECHECK(unsigned int, pos), EO_TYPECHECK(Eina_Bool *, result) |
#define | evas_obj_box_remove_all(clear, result) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_REMOVE_ALL), EO_TYPECHECK(Eina_Bool, clear), EO_TYPECHECK(Eina_Bool *, result) |
#define | evas_obj_box_iterator_new(itr) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_ITERATOR_NEW), EO_TYPECHECK(Eina_Iterator **, itr) |
#define | evas_obj_box_accessor_new(accessor) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_ACCESSOR_NEW), EO_TYPECHECK(Eina_Accessor **, accessor) |
#define | evas_obj_box_option_property_name_get(property, name) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_OPTION_PROPERTY_NAME_GET), EO_TYPECHECK(int, property), EO_TYPECHECK(const char **, name) |
#define | evas_obj_box_option_property_id_get(name, id) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_OPTION_PROPERTY_ID_GET), EO_TYPECHECK(const char *, name), EO_TYPECHECK(int *, id) |
#define | evas_obj_box_option_property_vset(opt, property, args, ret) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_OPTION_PROPERTY_VSET), EO_TYPECHECK(Evas_Object_Box_Option *, opt), EO_TYPECHECK(int, property), EO_TYPECHECK(va_list *, args), EO_TYPECHECK(Eina_Bool *, ret) |
#define | evas_obj_box_option_property_vget(opt, property, args, ret) EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_OPTION_PROPERTY_VGET), EO_TYPECHECK(Evas_Object_Box_Option *, opt), EO_TYPECHECK(int, property), EO_TYPECHECK(va_list *, args), EO_TYPECHECK(Eina_Bool *, ret) |
enum | { EVAS_OBJ_BOX_SUB_ID_INTERNAL_APPEND, EVAS_OBJ_BOX_SUB_ID_INTERNAL_PREPEND, EVAS_OBJ_BOX_SUB_ID_INTERNAL_INSERT_BEFORE, EVAS_OBJ_BOX_SUB_ID_INTERNAL_INSERT_AFTER, EVAS_OBJ_BOX_SUB_ID_INTERNAL_INSERT_AT, EVAS_OBJ_BOX_SUB_ID_INTERNAL_REMOVE, EVAS_OBJ_BOX_SUB_ID_INTERNAL_REMOVE_AT, EVAS_OBJ_BOX_SUB_ID_INTERNAL_OPTION_NEW, EVAS_OBJ_BOX_SUB_ID_INTERNAL_OPTION_FREE, EVAS_OBJ_BOX_SUB_ID_ADD_TO, EVAS_OBJ_BOX_SUB_ID_LAYOUT_SET, EVAS_OBJ_BOX_SUB_ID_LAYOUT_HORIZONTAL, EVAS_OBJ_BOX_SUB_ID_LAYOUT_VERTICAL, EVAS_OBJ_BOX_SUB_ID_LAYOUT_HOMOGENEOUS_HORIZONTAL, EVAS_OBJ_BOX_SUB_ID_LAYOUT_HOMOGENEOUS_VERTICAL, EVAS_OBJ_BOX_SUB_ID_LAYOUT_HOMOGENEOUS_MAX_SIZE_HORIZONTAL, EVAS_OBJ_BOX_SUB_ID_LAYOUT_HOMOGENEOUS_MAX_SIZE_VERTICAL, EVAS_OBJ_BOX_SUB_ID_LAYOUT_FLOW_HORIZONTAL, EVAS_OBJ_BOX_SUB_ID_LAYOUT_FLOW_VERTICAL, EVAS_OBJ_BOX_SUB_ID_LAYOUT_STACK, EVAS_OBJ_BOX_SUB_ID_ALIGN_SET, EVAS_OBJ_BOX_SUB_ID_ALIGN_GET, EVAS_OBJ_BOX_SUB_ID_PADDING_SET, EVAS_OBJ_BOX_SUB_ID_PADDING_GET, EVAS_OBJ_BOX_SUB_ID_APPEND, EVAS_OBJ_BOX_SUB_ID_PREPEND, EVAS_OBJ_BOX_SUB_ID_INSERT_BEFORE, EVAS_OBJ_BOX_SUB_ID_INSERT_AFTER, EVAS_OBJ_BOX_SUB_ID_INSERT_AT, EVAS_OBJ_BOX_SUB_ID_REMOVE, EVAS_OBJ_BOX_SUB_ID_REMOVE_AT, EVAS_OBJ_BOX_SUB_ID_REMOVE_ALL, EVAS_OBJ_BOX_SUB_ID_ITERATOR_NEW, EVAS_OBJ_BOX_SUB_ID_ACCESSOR_NEW, EVAS_OBJ_BOX_SUB_ID_OPTION_PROPERTY_NAME_GET, EVAS_OBJ_BOX_SUB_ID_OPTION_PROPERTY_ID_GET, EVAS_OBJ_BOX_SUB_ID_OPTION_PROPERTY_VSET, EVAS_OBJ_BOX_SUB_ID_OPTION_PROPERTY_VGET, EVAS_OBJ_BOX_SUB_ID_LAST } |
Eo_Op | EVAS_OBJ_BOX_BASE_ID |
void | evas_object_box_layout_set (Evas_Object *o, Evas_Object_Box_Layout cb, const void *data, void(*free_data)(void *data)) |
Set a new layouting function to a given box object. More... | |
Evas_Object * | evas_object_box_add (Evas *evas) |
Add a new box object on the provided canvas. More... | |
Evas_Object * | evas_object_box_add_to (Evas_Object *parent) |
Add a new box as a child of a given smart object. More... | |
void | evas_object_box_layout_horizontal (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Layout function which sets the box o to a (basic) horizontal box. More... | |
void | evas_object_box_layout_vertical (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Layout function which sets the box o to a (basic) vertical box. More... | |
void | evas_object_box_layout_homogeneous_vertical (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Layout function which sets the box o to a homogeneous vertical box. More... | |
void | evas_object_box_layout_homogeneous_horizontal (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Layout function which sets the box o to a homogeneous horizontal box. More... | |
void | evas_object_box_layout_homogeneous_max_size_horizontal (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Layout function which sets the box o to a maximum size, homogeneous horizontal box. More... | |
void | evas_object_box_layout_homogeneous_max_size_vertical (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Layout function which sets the box o to a maximum size, homogeneous vertical box. More... | |
void | evas_object_box_layout_flow_horizontal (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Layout function which sets the box o to a flow horizontal box. More... | |
void | evas_object_box_layout_flow_vertical (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Layout function which sets the box o to a flow vertical box. More... | |
void | evas_object_box_layout_stack (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Layout function which sets the box o to a stacking box. More... | |
void | evas_object_box_align_set (Evas_Object *o, double horizontal, double vertical) |
Set the alignment of the whole bounding box of contents, for a given box object. More... | |
void | evas_object_box_align_get (const Evas_Object *o, double *horizontal, double *vertical) |
Get the alignment of the whole bounding box of contents, for a given box object. More... | |
void | evas_object_box_padding_set (Evas_Object *o, Evas_Coord horizontal, Evas_Coord vertical) |
Set the (space) padding between cells set for a given box object. More... | |
void | evas_object_box_padding_get (const Evas_Object *o, Evas_Coord *horizontal, Evas_Coord *vertical) |
Get the (space) padding between cells set for a given box object. More... | |
Evas_Object_Box_Option * | evas_object_box_append (Evas_Object *o, Evas_Object *child) |
Append a new child object to the given box object o. More... | |
Evas_Object_Box_Option * | evas_object_box_prepend (Evas_Object *o, Evas_Object *child) |
Prepend a new child object to the given box object o. More... | |
Evas_Object_Box_Option * | evas_object_box_insert_before (Evas_Object *o, Evas_Object *child, const Evas_Object *reference) |
Insert a new child object before another existing one, in a given box object o. More... | |
Evas_Object_Box_Option * | evas_object_box_insert_after (Evas_Object *o, Evas_Object *child, const Evas_Object *reference) |
Insert a new child object after another existing one, in a given box object o. More... | |
Evas_Object_Box_Option * | evas_object_box_insert_at (Evas_Object *o, Evas_Object *child, unsigned int pos) |
Insert a new child object at a given position, in a given box object o. More... | |
Eina_Bool | evas_object_box_remove (Evas_Object *o, Evas_Object *child) |
Remove a given object from a box object, unparenting it again. More... | |
Eina_Bool | evas_object_box_remove_at (Evas_Object *o, unsigned int pos) |
Remove an object, bound to a given position in a box object, unparenting it again. More... | |
Eina_Bool | evas_object_box_remove_all (Evas_Object *o, Eina_Bool clear) |
Remove all child objects from a box object, unparenting them again. More... | |
Eina_Iterator * | evas_object_box_iterator_new (const Evas_Object *o) |
Get an iterator to walk the list of children of a given box object. More... | |
Eina_Accessor * | evas_object_box_accessor_new (const Evas_Object *o) |
Get an accessor (a structure providing random items access) to the list of children of a given box object. More... | |
Eina_List * | evas_object_box_children_get (const Evas_Object *o) |
Get the list of children objects in a given box object. More... | |
const char * | evas_object_box_option_property_name_get (const Evas_Object *o, int property) |
Get the name of the property of the child elements of the box o which have id as identifier. More... | |
int | evas_object_box_option_property_id_get (const Evas_Object *o, const char *name) |
Get the numerical identifier of the property of the child elements of the box o which have name as name string. More... | |
Eina_Bool | evas_object_box_option_property_set (Evas_Object *o, Evas_Object_Box_Option *opt, int property,...) |
Set a property value (by its given numerical identifier), on a given box child element. More... | |
Eina_Bool | evas_object_box_option_property_vset (Evas_Object *o, Evas_Object_Box_Option *opt, int property, va_list args) |
Set a property value (by its given numerical identifier), on a given box child element – by a variable argument list. More... | |
Eina_Bool | evas_object_box_option_property_get (const Evas_Object *o, Evas_Object_Box_Option *opt, int property,...) |
Get a property's value (by its given numerical identifier), on a given box child element. More... | |
Eina_Bool | evas_object_box_option_property_vget (const Evas_Object *o, Evas_Object_Box_Option *opt, int property, va_list args) |
Get a property's value (by its given numerical identifier), on a given box child element – by a variable argument list. More... | |
A box is a convenience smart object that packs children inside it in sequence, using a layouting function specified by the user.
There are a couple of pre-made layouting functions built-in in Evas, all of them using children size hints to define their size and alignment inside their cell space.
Examples on this smart object's usage:
#define EVAS_OBJECT_BOX_API_INIT | ( | smart_class_init | ) | {smart_class_init, EVAS_OBJECT_BOX_API_VERSION, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL} |
Initializer for a whole Evas_Object_Box_Api structure, with NULL
values on its specific fields.
smart_class_init | initializer to use for the "base" field (Evas_Smart_Class). |
#define EVAS_OBJECT_BOX_API_INIT_NULL EVAS_OBJECT_BOX_API_INIT(EVAS_SMART_CLASS_INIT_NULL) |
Initializer to zero out a whole Evas_Object_Box_Api structure.
#define EVAS_OBJECT_BOX_API_INIT_VERSION EVAS_OBJECT_BOX_API_INIT(EVAS_SMART_CLASS_INIT_VERSION) |
Initializer to zero out a whole Evas_Object_Box_Api structure and set a specific version on it.
This is similar to EVAS_OBJECT_BOX_API_INIT_NULL, but it will set the version field of Evas_Smart_Class (base field) to the latest EVAS_SMART_CLASS_VERSION.
#define EVAS_OBJECT_BOX_API_INIT_NAME_VERSION | ( | name | ) | EVAS_OBJECT_BOX_API_INIT(EVAS_SMART_CLASS_INIT_NAME_VERSION(name)) |
Initializer to zero out a whole Evas_Object_Box_Api structure and set its name and version.
This is similar to EVAS_OBJECT_BOX_API_INIT_NULL, but it will also set the version field of Evas_Smart_Class (base field) to the latest EVAS_SMART_CLASS_VERSION and name it to the specific value.
It will keep a reference to the name field as a "const char *"
, i.e., the name must be available while the structure is used (hint: static or global variable!) and must not be modified.
#define evas_obj_box_internal_append | ( | child, | |
option | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_APPEND), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
No description supplied by the EAPI.
[in] | child | |
[out] | option |
#define evas_obj_box_internal_prepend | ( | child, | |
option | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_PREPEND), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
No description supplied by the EAPI.
[in] | child | |
[out] | option |
#define evas_obj_box_internal_insert_before | ( | child, | |
reference, | |||
option | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_INSERT_BEFORE), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(const Evas_Object *, reference), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
No description supplied by the EAPI.
[in] | child | |
[in] | reference | |
[out] | option |
#define evas_obj_box_internal_insert_after | ( | child, | |
reference, | |||
option | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_INSERT_AFTER), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(const Evas_Object *, reference), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
No description supplied by the EAPI.
[in] | child | |
[in] | reference | |
[out] | option |
#define evas_obj_box_internal_insert_at | ( | child, | |
pos, | |||
option | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_INSERT_AT), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(unsigned int, pos), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
No description supplied by the EAPI.
[in] | child | |
[in] | pos | |
[out] | option |
#define evas_obj_box_internal_remove | ( | child, | |
result | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_REMOVE), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object **, result) |
No description supplied by the EAPI.
[in] | child | |
[out] | result |
#define evas_obj_box_internal_remove_at | ( | pos, | |
result | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_REMOVE_AT), EO_TYPECHECK(unsigned int, pos), EO_TYPECHECK(Evas_Object **, result) |
No description supplied by the EAPI.
[in] | pos | |
[out] | result |
#define evas_obj_box_internal_option_new | ( | child, | |
ret | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_OPTION_NEW), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object_Box_Option **, ret) |
No description supplied by the EAPI.
[in] | child | |
[out] | ret |
#define evas_obj_box_internal_option_free | ( | opt | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INTERNAL_OPTION_FREE), EO_TYPECHECK(Evas_Object_Box_Option *, opt) |
No description supplied by the EAPI.
[in] | opt |
#define evas_obj_box_add_to | ( | o | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_ADD_TO), EO_TYPECHECK(Evas_Object **, o) |
Add a new box as a child of a given smart object.
[in] | o |
Referenced by evas_object_box_add_to().
#define evas_obj_box_layout_set | ( | cb, | |
data, | |||
free_data | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_SET), EO_TYPECHECK(Evas_Object_Box_Layout, cb), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Eina_Free_Cb, free_data) |
Set a new layouting function to a given box object
[in] | cb | |
[in] | data | |
[in] | free_data |
Referenced by evas_object_box_layout_set().
#define evas_obj_box_layout_horizontal | ( | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_HORIZONTAL) |
Layout function which sets the box o to a (basic) horizontal box
Referenced by evas_object_box_layout_horizontal().
#define evas_obj_box_layout_vertical | ( | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_VERTICAL) |
Layout function which sets the box o to a (basic) vertical box
Referenced by evas_object_box_layout_vertical().
#define evas_obj_box_layout_homogeneous_horizontal | ( | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_HOMOGENEOUS_HORIZONTAL) |
Layout function which sets the box o to a homogeneous
Referenced by evas_object_box_layout_homogeneous_horizontal().
#define evas_obj_box_layout_homogeneous_vertical | ( | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_HOMOGENEOUS_VERTICAL) |
Layout function which sets the box o to a homogeneous
Referenced by evas_object_box_layout_homogeneous_vertical().
#define evas_obj_box_layout_homogeneous_max_size_horizontal | ( | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_HOMOGENEOUS_MAX_SIZE_HORIZONTAL) |
Layout function which sets the box o to a maximum size.
Referenced by evas_object_box_layout_homogeneous_max_size_horizontal().
#define evas_obj_box_layout_homogeneous_max_size_vertical | ( | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_HOMOGENEOUS_MAX_SIZE_VERTICAL) |
Layout function which sets the box o to a maximum size,
Referenced by evas_object_box_layout_homogeneous_max_size_vertical().
#define evas_obj_box_layout_flow_horizontal | ( | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_FLOW_HORIZONTAL) |
Layout function which sets the box o to a flow horizontal
Referenced by evas_object_box_layout_flow_horizontal().
#define evas_obj_box_layout_flow_vertical | ( | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_FLOW_VERTICAL) |
Layout function which sets the box o to a flow vertical box.
Referenced by evas_object_box_layout_flow_vertical().
#define evas_obj_box_layout_stack | ( | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_LAYOUT_STACK) |
Layout function which sets the box o to a stacking box
Referenced by evas_object_box_layout_stack().
#define evas_obj_box_align_set | ( | horizontal, | |
vertical | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_ALIGN_SET), EO_TYPECHECK(double, horizontal), EO_TYPECHECK(double, vertical) |
Set the alignment of the whole bounding box of contents, for a
[in] | horizontal | |
[in] | vertical |
Referenced by evas_object_box_align_set().
#define evas_obj_box_align_get | ( | horizontal, | |
vertical | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_ALIGN_GET), EO_TYPECHECK(double *, horizontal), EO_TYPECHECK(double *, vertical) |
Get the alignment of the whole bounding box of contents, for a
[out] | horizontal | |
[out] | vertical |
Referenced by evas_object_box_align_get().
#define evas_obj_box_padding_set | ( | horizontal, | |
vertical | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_PADDING_SET), EO_TYPECHECK(Evas_Coord, horizontal), EO_TYPECHECK(Evas_Coord, vertical) |
Set the (space) padding between cells set for a given box object.
[in] | horizontal | |
[in] | vertical |
Referenced by evas_object_box_padding_set().
#define evas_obj_box_padding_get | ( | horizontal, | |
vertical | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_PADDING_GET), EO_TYPECHECK(Evas_Coord *, horizontal), EO_TYPECHECK(Evas_Coord *, vertical) |
Get the (space) padding between cells set for a given box object.
[out] | horizontal | |
[out] | vertical |
Referenced by evas_object_box_padding_get().
#define evas_obj_box_append | ( | child, | |
option | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_APPEND), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
Append a new child object to the given box object o.
[in] | child | |
[in] | option |
Referenced by evas_object_box_append().
#define evas_obj_box_prepend | ( | child, | |
option | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_PREPEND), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
Prepend a new child object to the given box object o.
[in] | child | |
[in] | option |
Referenced by evas_object_box_prepend().
#define evas_obj_box_insert_before | ( | child, | |
reference, | |||
option | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INSERT_BEFORE), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(const Evas_Object *, reference), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
Insert a new child object before another existing one, in
[in] | child | |
[in] | reference | |
[in] | option |
Referenced by evas_object_box_insert_before().
#define evas_obj_box_insert_after | ( | child, | |
reference, | |||
option | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INSERT_AFTER), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(const Evas_Object *, reference), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
Insert a new child object after another existing one, in
[in] | child | |
[in] | reference | |
[in] | option |
Referenced by evas_object_box_insert_after().
#define evas_obj_box_insert_at | ( | child, | |
pos, | |||
option | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_INSERT_AT), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(unsigned int, pos), EO_TYPECHECK(Evas_Object_Box_Option **, option) |
Insert a new child object at a given position, in a given
[in] | child | |
[in] | pos | |
[in] | option |
Referenced by evas_object_box_insert_at().
#define evas_obj_box_remove | ( | child, | |
result | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_REMOVE), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Eina_Bool *, result) |
Remove a given object from a box object, unparenting it again.
[in] | child | |
[out] | result |
Referenced by evas_object_box_remove().
#define evas_obj_box_remove_at | ( | pos, | |
result | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_REMOVE_AT), EO_TYPECHECK(unsigned int, pos), EO_TYPECHECK(Eina_Bool *, result) |
Remove an object, bound to a given position in a box object,
[in] | pos | |
[out] | result |
Referenced by evas_object_box_remove_at().
#define evas_obj_box_remove_all | ( | clear, | |
result | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_REMOVE_ALL), EO_TYPECHECK(Eina_Bool, clear), EO_TYPECHECK(Eina_Bool *, result) |
Remove all child objects from a box object, unparenting them
[in] | clear | |
[out] | result |
Referenced by evas_object_box_remove_all().
#define evas_obj_box_iterator_new | ( | itr | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_ITERATOR_NEW), EO_TYPECHECK(Eina_Iterator **, itr) |
Get an iterator to walk the list of children of a given box object.
[in] | itr |
Referenced by evas_object_box_iterator_new().
#define evas_obj_box_accessor_new | ( | accessor | ) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_ACCESSOR_NEW), EO_TYPECHECK(Eina_Accessor **, accessor) |
Get an accessor (a structure providing random items access) to the
[in] | accessor |
Referenced by evas_object_box_accessor_new().
#define evas_obj_box_option_property_name_get | ( | property, | |
name | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_OPTION_PROPERTY_NAME_GET), EO_TYPECHECK(int, property), EO_TYPECHECK(const char **, name) |
Get the name of the property of the child elements of the box o
[in] | property | |
[in] | name |
Referenced by evas_object_box_option_property_name_get().
#define evas_obj_box_option_property_id_get | ( | name, | |
id | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_OPTION_PROPERTY_ID_GET), EO_TYPECHECK(const char *, name), EO_TYPECHECK(int *, id) |
Get the numerical identifier of the property of the child elements
[in] | name | |
[in] | id |
Referenced by evas_object_box_option_property_id_get().
#define evas_obj_box_option_property_vset | ( | opt, | |
property, | |||
args, | |||
ret | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_OPTION_PROPERTY_VSET), EO_TYPECHECK(Evas_Object_Box_Option *, opt), EO_TYPECHECK(int, property), EO_TYPECHECK(va_list *, args), EO_TYPECHECK(Eina_Bool *, ret) |
Set a property value (by its given numerical identifier), on a
[in] | opt | |
[in] | property | |
[in] | args | |
[out] | ret |
Referenced by evas_object_box_option_property_vset().
#define evas_obj_box_option_property_vget | ( | opt, | |
property, | |||
args, | |||
ret | |||
) | EVAS_OBJ_BOX_ID(EVAS_OBJ_BOX_SUB_ID_OPTION_PROPERTY_VGET), EO_TYPECHECK(Evas_Object_Box_Option *, opt), EO_TYPECHECK(int, property), EO_TYPECHECK(va_list *, args), EO_TYPECHECK(Eina_Bool *, ret) |
Get a property's value (by its given numerical identifier), on a
[in] | opt | |
[in] | property | |
[in] | args | |
[out] | ret |
Referenced by evas_object_box_option_property_vget().
The base structure for a box option.
Box options are a way of extending box items properties, which will be taken into account for layouting decisions. The box layouting functions provided by Evas will only rely on objects' canonical size hints to layout them, so the basic box option has no (custom) property set.
Users creating their own layouts, but not depending on extra child items' properties, would be fine just using evas_object_box_layout_set(). But if one desires a layout depending on extra child properties, he/she has to subclass the box smart object. Thus, by using evas_object_box_smart_class_get() and evas_object_box_smart_set(), the option_new()
and option_free()
smart class functions should be properly redefined/extended.
Object properties are bound to an integer identifier and must have a name string. Their values are open to any data. See the API on option properties for more details.
Evas_Object_Box_Layout |
Function signature for an Evas box object layouting routine.
By o it will be passed the box object in question, by priv it will be passed the box's internal data and, by user_data, it will be passed any custom data one could have set to a given box layouting function, with evas_object_box_layout_set().
void evas_object_box_smart_set | ( | Evas_Object_Box_Api * | api | ) |
Set the default box api struct (Evas_Object_Box_Api) with the default values.
May be used to extend that API.
api | The box API struct to set back, most probably with overridden fields (on class extensions scenarios) |
const Evas_Object_Box_Api* evas_object_box_smart_class_get | ( | void | ) |
Get the Evas box smart class, for inheritance purposes.
The returned value is not to be modified, just use it as your parent class.
void evas_object_box_layout_set | ( | Evas_Object * | o, |
Evas_Object_Box_Layout | cb, | ||
const void * | data, | ||
void(*)(void *data) | free_data | ||
) |
Set a new layouting function to a given box object.
o | The box object to operate on. |
cb | The new layout function to set on o . |
data | Data pointer to be passed to cb . |
free_data | Function to free data , if need be. |
A box layout function affects how a box object displays child elements within its area. The list of pre-defined box layouts available in Evas is:
Refer to each of their documentation texts for details on them.
'calculate'
smart callback of the box's smart class. References evas_obj_box_layout_set.
Evas_Object* evas_object_box_add | ( | Evas * | evas | ) |
Add a new box object on the provided canvas.
evas | The canvas to create the box object on. |
NULL
on error, a pointer to a new box object on success.After instantiation, if a box object hasn't its layout function set, via evas_object_box_layout_set(), it will have it by default set to evas_object_box_layout_horizontal(). The remaining properties of the box must be set/retrieved via evas_object_box_{h,v}_{align,padding}_{get,set)()
.
Evas_Object* evas_object_box_add_to | ( | Evas_Object * | parent | ) |
Add a new box as a child of a given smart object.
parent | The parent smart object to put the new box in. |
NULL
on error, a pointer to a new box object on success.This is a helper function that has the same effect of putting a new box object into parent
by use of evas_object_smart_member_add().
References evas_obj_box_add_to.
void evas_object_box_layout_horizontal | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Layout function which sets the box o to a (basic) horizontal box.
o | The box object in question |
priv | The smart data of the o |
data | The data pointer passed on evas_object_box_layout_set(), if any |
In this layout, the box object's overall behavior is controlled by its padding/alignment properties, which are set by the evas_object_box_{h,v}_{align,padding}_set()
family of functions. The size hints of the elements in the box – set by the evas_object_size_hint_{align,padding,weight}_set()
functions – also control the way this function works.
align_h
controls the horizontal alignment of the child objects relative to the containing box. When set to 0.0
, children are aligned to the left. A value of 1.0
makes them aligned to the right border. Values in between align them proportionally. Note that if the size required by the children, which is given by their widths and the padding_h
property of the box, is bigger than the their container's width, the children will be displayed out of the box's bounds. A negative value of align_h
makes the box to justify its children. The padding between them, in this case, is corrected so that the leftmost one touches the left border and the rightmost one touches the right border (even if they must overlap). The align_v
and padding_v
properties of the box don't contribute to its behaviour when this layout is chosen.align_x
does not influence the box's behavior. padding_l
and padding_r
sum up to the container's horizontal padding between elements. The child's padding_t
, padding_b
and align_y
properties apply for padding/alignment relative to the overall height of the box. Finally, there is the weight_x
property, which, if set to a non-zero value, tells the container that the child width is not pre-defined. If the container can't accommodate all its children, it sets the widths of the ones with weights to sizes as small as they can all fit into it. If the size required by the children is less than the available, the box increases its childrens' (which have weights) widths as to fit the remaining space. The weight_x
property, besides telling the element is resizable, gives a weight for the resizing process. The parent box will try to distribute (or take off) widths accordingly to the normalized list of weights: most weighted children remain/get larger in this process than the least ones. weight_y
does not influence the layout.If one desires that, besides having weights, child elements must be resized bounded to a minimum or maximum size, those size hints must be set, by the evas_object_size_hint_{min,max}_set()
functions.
References evas_obj_box_layout_horizontal.
void evas_object_box_layout_vertical | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Layout function which sets the box o to a (basic) vertical box.
This function behaves analogously to evas_object_box_layout_horizontal(). The description of its behaviour can be derived from that function's documentation.
References evas_obj_box_layout_vertical.
void evas_object_box_layout_homogeneous_vertical | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Layout function which sets the box o to a homogeneous vertical box.
This function behaves analogously to evas_object_box_layout_homogeneous_horizontal(). The description of its behaviour can be derived from that function's documentation.
References evas_obj_box_layout_homogeneous_vertical.
void evas_object_box_layout_homogeneous_horizontal | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Layout function which sets the box o to a homogeneous horizontal box.
o | The box object in question |
priv | The smart data of the o |
data | The data pointer passed on evas_object_box_layout_set(), if any |
In a homogeneous horizontal box, its width is divided equally between the contained objects. The box's overall behavior is controlled by its padding/alignment properties, which are set by the evas_object_box_{h,v}_{align,padding}_set()
family of functions. The size hints the elements in the box – set by the evas_object_size_hint_{align,padding,weight}_set()
functions – also control the way this function works.
align_h
has no influence on the box for this layout. padding_h
tells the box to draw empty spaces of that size, in pixels, between the (equal) child objects' cells. The align_v
and padding_v
properties of the box don't contribute to its behaviour when this layout is chosen.padding_l
and padding_r
sum up to the required width of the child element. The align_x
property tells the relative position of this overall child width in its allocated cell (0.0
to extreme left, 1.0
to extreme right). A value of -1.0
to align_x
makes the box try to resize this child element to the exact width of its cell (respecting the minimum and maximum size hints on the child's width and accounting for its horizontal padding hints). The child's padding_t
, padding_b
and align_y
properties apply for padding/alignment relative to the overall height of the box. A value of -1.0
to align_y
makes the box try to resize this child element to the exact height of its parent (respecting the maximum size hint on the child's height). References evas_obj_box_layout_homogeneous_horizontal.
void evas_object_box_layout_homogeneous_max_size_horizontal | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Layout function which sets the box o to a maximum size, homogeneous horizontal box.
o | The box object in question |
priv | The smart data of the o |
data | The data pointer passed on evas_object_box_layout_set(), if any |
In a maximum size, homogeneous horizontal box, besides having cells of equal size reserved for the child objects, this size will be defined by the size of the largest child in the box (in width). The box's overall behavior is controlled by its properties, which are set by the evas_object_box_{h,v}_{align,padding}_set()
family of functions. The size hints of the elements in the box – set by the evas_object_size_hint_{align,padding,weight}_set()
functions – also control the way this function works.
padding_h
tells the box to draw empty spaces of that size, in pixels, between the child objects' cells. align_h
controls the horizontal alignment of the child objects, relative to the containing box. When set to 0.0
, children are aligned to the left. A value of 1.0
lets them aligned to the right border. Values in between align them proportionally. A negative value of align_h
makes the box to justify its children cells. The padding between them, in this case, is corrected so that the leftmost one touches the left border and the rightmost one touches the right border (even if they must overlap). The align_v
and padding_v
properties of the box don't contribute to its behaviour when this layout is chosen.padding_l
and padding_r
sum up to the required width of the child element. The align_x
property tells the relative position of this overall child width in its allocated cell (0.0
to extreme left, 1.0
to extreme right). A value of -1.0
to align_x
makes the box try to resize this child element to the exact width of its cell (respecting the minimum and maximum size hints on the child's width and accounting for its horizontal padding hints). The child's padding_t
, padding_b
and align_y
properties apply for padding/alignment relative to the overall height of the box. A value of -1.0
to align_y
makes the box try to resize this child element to the exact height of its parent (respecting the max hint on the child's height). References evas_obj_box_layout_homogeneous_max_size_horizontal.
void evas_object_box_layout_homogeneous_max_size_vertical | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Layout function which sets the box o to a maximum size, homogeneous vertical box.
This function behaves analogously to evas_object_box_layout_homogeneous_max_size_horizontal(). The description of its behaviour can be derived from that function's documentation.
References evas_obj_box_layout_homogeneous_max_size_vertical.
void evas_object_box_layout_flow_horizontal | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Layout function which sets the box o to a flow horizontal box.
o | The box object in question |
priv | The smart data of the o |
data | The data pointer passed on evas_object_box_layout_set(), if any |
In a flow horizontal box, the box's child elements are placed in rows (think of text as an analogy). A row has as much elements as can fit into the box's width. The box's overall behavior is controlled by its properties, which are set by the evas_object_box_{h,v}_{align,padding}_set()
family of functions. The size hints of the elements in the box – set by the evas_object_size_hint_{align,padding,weight}_set()
functions – also control the way this function works.
padding_h
tells the box to draw empty spaces of that size, in pixels, between the child objects' cells. align_h
dictates the horizontal alignment of the rows (0.0
to left align them, 1.0
to right align). A value of -1.0
to align_h
lets the rows justified horizontally. align_v
controls the vertical alignment of the entire set of rows (0.0
to top, 1.0
to bottom). A value of -1.0
to align_v
makes the box to justify the rows vertically. The padding between them, in this case, is corrected so that the first row touches the top border and the last one touches the bottom border (even if they must overlap). padding_v
has no influence on the layout.padding_l
and padding_r
sum up to the required width of the child element. The align_x
property has no influence on the layout. The child's padding_t
and padding_b
sum up to the required height of the child element and is the only means (besides row justifying) of setting space between rows. Note, however, that align_y
dictates positioning relative to the largest height required by a child object in the actual row. References evas_obj_box_layout_flow_horizontal.
void evas_object_box_layout_flow_vertical | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Layout function which sets the box o to a flow vertical box.
This function behaves analogously to evas_object_box_layout_flow_horizontal(). The description of its behaviour can be derived from that function's documentation.
References evas_obj_box_layout_flow_vertical.
void evas_object_box_layout_stack | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Layout function which sets the box o to a stacking box.
o | The box object in question |
priv | The smart data of the o |
data | The data pointer passed on evas_object_box_layout_set(), if any |
In a stacking box, all children will be given the same size – the box's own size – and they will be stacked one above the other, so that the first object in o's
internal list of child elements will be the bottommost in the stack.
padding_l
and padding_r
sum up to the required width of the child element. The align_x
property tells the relative position of this overall child width in its allocated cell (0.0
to extreme left, 1.0
to extreme right). A value of -1.0
to align_x
makes the box try to resize this child element to the exact width of its cell (respecting the min and max hints on the child's width and accounting for its horizontal padding properties). The same applies to the vertical axis. References evas_obj_box_layout_stack.
void evas_object_box_align_set | ( | Evas_Object * | o, |
double | horizontal, | ||
double | vertical | ||
) |
Set the alignment of the whole bounding box of contents, for a given box object.
o | The given box object to set alignment from |
horizontal | The horizontal alignment, in pixels |
vertical | the vertical alignment, in pixels |
This will influence how a box object is to align its bounding box of contents within its own area. The values must be in the range 0.0
- 1.0
, or undefined behavior is expected. For horizontal alignment, 0.0
means to the left, with 1.0
meaning to the right. For vertical alignment, 0.0
means to the top, with 1.0
meaning to the bottom.
0.5
.References evas_obj_box_align_set.
void evas_object_box_align_get | ( | const Evas_Object * | o, |
double * | horizontal, | ||
double * | vertical | ||
) |
Get the alignment of the whole bounding box of contents, for a given box object.
o | The given box object to get alignment from |
horizontal | Pointer to a variable where to store the horizontal alignment |
vertical | Pointer to a variable where to store the vertical alignment |
References evas_obj_box_align_get.
void evas_object_box_padding_set | ( | Evas_Object * | o, |
Evas_Coord | horizontal, | ||
Evas_Coord | vertical | ||
) |
Set the (space) padding between cells set for a given box object.
o | The given box object to set padding from |
horizontal | The horizontal padding, in pixels |
vertical | the vertical padding, in pixels |
0
.References evas_obj_box_padding_set.
void evas_object_box_padding_get | ( | const Evas_Object * | o, |
Evas_Coord * | horizontal, | ||
Evas_Coord * | vertical | ||
) |
Get the (space) padding between cells set for a given box object.
o | The given box object to get padding from |
horizontal | Pointer to a variable where to store the horizontal padding |
vertical | Pointer to a variable where to store the vertical padding |
References evas_obj_box_padding_get.
Evas_Object_Box_Option* evas_object_box_append | ( | Evas_Object * | o, |
Evas_Object * | child | ||
) |
Append a new child object to the given box object o.
o | The given box object |
child | A child Evas object to be made a member of o |
NULL
, on errorsOn success, the "child,added"
smart event will take place.
o's
area will depend on the layout set to it. For example, on horizontal layouts an item in the end of the box's list of children will appear on its right.References evas_obj_box_append.
Evas_Object_Box_Option* evas_object_box_prepend | ( | Evas_Object * | o, |
Evas_Object * | child | ||
) |
Prepend a new child object to the given box object o.
o | The given box object |
child | A child Evas object to be made a member of o |
NULL
, on errorsOn success, the "child,added"
smart event will take place.
o's
area will depend on the layout set to it. For example, on horizontal layouts an item in the beginning of the box's list of children will appear on its left.References evas_obj_box_prepend.
Evas_Object_Box_Option* evas_object_box_insert_before | ( | Evas_Object * | o, |
Evas_Object * | child, | ||
const Evas_Object * | reference | ||
) |
Insert a new child object before another existing one, in a given box object o.
o | The given box object |
child | A child Evas object to be made a member of o |
reference | The child object to place this new one before |
NULL
, on errorsOn success, the "child,added"
smart event will take place.
reference
is not a member of o
.o's
area will depend on the layout set to it.References evas_obj_box_insert_before.
Evas_Object_Box_Option* evas_object_box_insert_after | ( | Evas_Object * | o, |
Evas_Object * | child, | ||
const Evas_Object * | reference | ||
) |
Insert a new child object after another existing one, in a given box object o.
o | The given box object |
child | A child Evas object to be made a member of o |
reference | The child object to place this new one after |
NULL
, on errorsOn success, the "child,added"
smart event will take place.
reference
is not a member of o
.o's
area will depend on the layout set to it.References evas_obj_box_insert_after.
Evas_Object_Box_Option* evas_object_box_insert_at | ( | Evas_Object * | o, |
Evas_Object * | child, | ||
unsigned int | pos | ||
) |
Insert a new child object at a given position, in a given box object o.
o | The given box object |
child | A child Evas object to be made a member of o |
pos | The numeric position (starting from 0 ) to place the new child object at |
NULL
, on errorsOn success, the "child,added"
smart event will take place.
o's
internal list of elements.o's
area will depend on the layout set to it.References evas_obj_box_insert_at.
Eina_Bool evas_object_box_remove | ( | Evas_Object * | o, |
Evas_Object * | child | ||
) |
Remove a given object from a box object, unparenting it again.
o | The box object to remove a child object from |
child | The handle to the child object to be removed |
EINA_TRUE
, on success, EINA_FALSE
otherwiseOn removal, you'll get an unparented object again, just as it was before you inserted it in the box. The _Evas_Object_Box_Api::option_free box smart callback will be called automatically for you and, also, the "child,removed"
smart event will take place.
References EINA_FALSE, and evas_obj_box_remove.
Eina_Bool evas_object_box_remove_at | ( | Evas_Object * | o, |
unsigned int | pos | ||
) |
Remove an object, bound to a given position in a box object, unparenting it again.
o | The box object to remove a child object from |
pos | The numeric position (starting from 0 ) of the child object to be removed |
EINA_TRUE
, on success, EINA_FALSE
otherwiseOn removal, you'll get an unparented object again, just as it was before you inserted it in the box. The option_free()
box smart callback will be called automatically for you and, also, the "child,removed"
smart event will take place.
o's
internal list of elements.References EINA_FALSE, and evas_obj_box_remove_at.
Eina_Bool evas_object_box_remove_all | ( | Evas_Object * | o, |
Eina_Bool | clear | ||
) |
Remove all child objects from a box object, unparenting them again.
o | The box object to remove a child object from |
clear | if true, it will delete just removed children. |
EINA_TRUE
, on success, EINA_FALSE
otherwiseThis has the same effect of calling evas_object_box_remove() on each of o's
child objects, in sequence. If, and only if, all those calls succeed, so does this one.
References EINA_FALSE, and evas_obj_box_remove_all.
Eina_Iterator* evas_object_box_iterator_new | ( | const Evas_Object * | o | ) |
Get an iterator to walk the list of children of a given box object.
o | The box to retrieve an items iterator from |
o's
child objects, on success, or NULL
, on errorsReferences evas_obj_box_iterator_new.
Eina_Accessor* evas_object_box_accessor_new | ( | const Evas_Object * | o | ) |
Get an accessor (a structure providing random items access) to the list of children of a given box object.
o | The box to retrieve an items iterator from |
o's
child objects, on success, or NULL
, on errorsReferences evas_obj_box_accessor_new.
Eina_List* evas_object_box_children_get | ( | const Evas_Object * | o | ) |
Get the list of children objects in a given box object.
o | The box to retrieve an items list from |
o's
child objects, on success, or NULL
, on errors (or if it has no child objects)The returned list should be freed with eina_list_free()
when you no longer need it.
References eina_list_append(), EINA_LIST_FOREACH, and _Evas_Object_Box_Option::obj.
const char* evas_object_box_option_property_name_get | ( | const Evas_Object * | o, |
int | property | ||
) |
Get the name of the property of the child elements of the box o which have id as identifier.
o | The box to search child options from |
property | The numerical identifier of the option being searched, for its name |
NULL
, on errors.NULL
. References evas_obj_box_option_property_name_get.
int evas_object_box_option_property_id_get | ( | const Evas_Object * | o, |
const char * | name | ||
) |
Get the numerical identifier of the property of the child elements of the box o which have name as name string.
o | The box to search child options from |
name | The name string of the option being searched, for its ID |
-1
, on errors.NULL
. References evas_obj_box_option_property_id_get.
Eina_Bool evas_object_box_option_property_set | ( | Evas_Object * | o, |
Evas_Object_Box_Option * | opt, | ||
int | property, | ||
... | |||
) |
Set a property value (by its given numerical identifier), on a given box child element.
o | The box parenting the child element |
opt | The box option structure bound to the child box element to set a property on |
property | The numerical ID of the given property |
... | (List of) actual value(s) to be set for this property. It (they) must be of the same type the user has defined for it (them). |
EINA_TRUE
on success, EINA_FALSE
on failure.NULL
.property
, and call evas_object_box_option_property_vset() with this list and the same previous arguments. References evas_object_box_option_property_vset().
Eina_Bool evas_object_box_option_property_vset | ( | Evas_Object * | o, |
Evas_Object_Box_Option * | opt, | ||
int | property, | ||
va_list | args | ||
) |
Set a property value (by its given numerical identifier), on a given box child element – by a variable argument list.
o | The box parenting the child element |
opt | The box option structure bound to the child box element to set a property on |
property | The numerical ID of the given property |
args | The variable argument list implementing the value to be set for this property. It must be of the same type the user has defined for it. |
EINA_TRUE
on success, EINA_FALSE
on failure.This is a variable argument list variant of the evas_object_box_option_property_set(). See its documentation for more details.
References EINA_FALSE, and evas_obj_box_option_property_vset.
Referenced by evas_object_box_option_property_set().
Eina_Bool evas_object_box_option_property_get | ( | const Evas_Object * | o, |
Evas_Object_Box_Option * | opt, | ||
int | property, | ||
... | |||
) |
Get a property's value (by its given numerical identifier), on a given box child element.
o | The box parenting the child element |
opt | The box option structure bound to the child box element to get a property from |
property | The numerical ID of the given property |
... | (List of) pointer(s) where to store the value(s) set for this property. It (they) must point to variable(s) of the same type the user has defined for it (them). |
EINA_TRUE
on success, EINA_FALSE
on failure.NULL
.property
, and call evas_object_box_option_property_vget() with this list and the same previous arguments. References evas_object_box_option_property_vget().
Eina_Bool evas_object_box_option_property_vget | ( | const Evas_Object * | o, |
Evas_Object_Box_Option * | opt, | ||
int | property, | ||
va_list | args | ||
) |
Get a property's value (by its given numerical identifier), on a given box child element – by a variable argument list.
o | The box parenting the child element |
opt | The box option structure bound to the child box element to get a property from |
property | The numerical ID of the given property |
args | The variable argument list with pointers to where to store the values of this property. They must point to variables of the same type the user has defined for them. |
EINA_TRUE
on success, EINA_FALSE
on failure.This is a variable argument list variant of the evas_object_box_option_property_get(). See its documentation for more details.
References EINA_FALSE, and evas_obj_box_option_property_vget.
Referenced by evas_object_box_option_property_get().