Tizen Native API
|
Functions | |
void | evas_object_box_smart_set (Evas_Object_Box_Api *api) |
Sets the default box api struct (Evas_Object_Box_Api) with the default values. This may be used to extend that API. | |
const Evas_Object_Box_Api * | evas_object_box_smart_class_get (void) |
Gets the Evas box smart class, for inheritance purposes. | |
void | evas_object_box_layout_set (Evas_Object *o, Evas_Object_Box_Layout cb, const void *data, void(*free_data)(void *data)) |
Sets a new layouting function to a given box object. | |
Evas_Object * | evas_object_box_add (Evas *evas) |
Adds a new box object on the provided canvas. | |
Evas_Object * | evas_object_box_add_to (Evas_Object *parent) |
Adds a new box as a child of a given smart object. | |
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. | |
void | evas_object_box_layout_vertical (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Sets the box o to a (basic) vertical box. | |
void | evas_object_box_layout_homogeneous_vertical (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Sets the box o to a homogeneous vertical box. | |
void | evas_object_box_layout_homogeneous_horizontal (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Sets the box o to a homogeneous horizontal box. | |
void | evas_object_box_layout_homogeneous_max_size_horizontal (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Sets the box o to a maximum size, homogeneous horizontal box. | |
void | evas_object_box_layout_homogeneous_max_size_vertical (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Sets the box o to a maximum size, homogeneous vertical box. | |
void | evas_object_box_layout_flow_horizontal (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Sets the box o to a flow horizontal box. | |
void | evas_object_box_layout_flow_vertical (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Sets the box o to a flow vertical box. | |
void | evas_object_box_layout_stack (Evas_Object *o, Evas_Object_Box_Data *priv, void *data) |
Sets the box o to a stacking box. | |
void | evas_object_box_align_set (Evas_Object *o, double horizontal, double vertical) |
Sets the alignment of the whole bounding box of contents, for a given box object. | |
void | evas_object_box_align_get (const Evas_Object *o, double *horizontal, double *vertical) |
Gets the alignment of the whole bounding box of contents, for a given box object. | |
void | evas_object_box_padding_set (Evas_Object *o, Evas_Coord horizontal, Evas_Coord vertical) |
Sets the (space) padding between cells set for a given box object. | |
void | evas_object_box_padding_get (const Evas_Object *o, Evas_Coord *horizontal, Evas_Coord *vertical) |
Gets the (space) padding between cells set for a given box object. | |
Evas_Object_Box_Option * | evas_object_box_append (Evas_Object *o, Evas_Object *child) |
Appends a new child object to the given box object o. | |
Evas_Object_Box_Option * | evas_object_box_prepend (Evas_Object *o, Evas_Object *child) |
Prepends a new child object to the given box object o. | |
Evas_Object_Box_Option * | evas_object_box_insert_before (Evas_Object *o, Evas_Object *child, const Evas_Object *reference) |
Inserts a new child object before another existing one, in a given box object o. | |
Evas_Object_Box_Option * | evas_object_box_insert_after (Evas_Object *o, Evas_Object *child, const Evas_Object *reference) |
Inserts a new child object after another existing one, in a given box object o. | |
Evas_Object_Box_Option * | evas_object_box_insert_at (Evas_Object *o, Evas_Object *child, unsigned int pos) |
Inserts a new child object at a given position, in a given box object o. | |
Eina_Bool | evas_object_box_remove (Evas_Object *o, Evas_Object *child) |
Removes a given object from a box object, unparenting it again. | |
Eina_Bool | evas_object_box_remove_at (Evas_Object *o, unsigned int pos) |
Removes an object, bound to a given position in a box object, unparenting it again. | |
Eina_Bool | evas_object_box_remove_all (Evas_Object *o, Eina_Bool clear) |
Removes all child objects from a box object, unparenting them again. | |
Eina_Iterator * | evas_object_box_iterator_new (const Evas_Object *o) |
Gets an iterator to walk the list of children of a given box object. | |
Eina_Accessor * | evas_object_box_accessor_new (const Evas_Object *o) |
Gets an accessor (a structure providing random items access) to the list of children of a given box object. | |
Eina_List * | evas_object_box_children_get (const Evas_Object *o) |
Gets the list of children objects in a given box object. | |
const char * | evas_object_box_option_property_name_get (const Evas_Object *o, int property) |
Gets the name of the property of the child elements of the box o which have id as identifier. | |
int | evas_object_box_option_property_id_get (const Evas_Object *o, const char *name) |
Gets the numerical identifier of the property of the child elements of the box o which have name as name string. | |
Eina_Bool | evas_object_box_option_property_set (Evas_Object *o, Evas_Object_Box_Option *opt, int property,...) |
Sets a property value (by its given numerical identifier), on a given box child element. | |
Eina_Bool | evas_object_box_option_property_vset (Evas_Object *o, Evas_Object_Box_Option *opt, int property, va_list args) |
Sets a property value (by its given numerical identifier), on a given box child element -- by a variable argument list. | |
Eina_Bool | evas_object_box_option_property_get (const Evas_Object *o, Evas_Object_Box_Option *opt, int property,...) |
Gets a property's value (by its given numerical identifier), on a given box child element. | |
Eina_Bool | evas_object_box_option_property_vget (const Evas_Object *o, Evas_Object_Box_Option *opt, int property, va_list args) |
Gets a property's value (by its given numerical identifier), on a given box child element -- by a variable argument list. | |
Typedefs | |
typedef struct _Evas_Object_Box_Api | Evas_Object_Box_Api |
The structure type containing the smart class extension, providing extra box object requirements. | |
typedef struct _Evas_Object_Box_Data | Evas_Object_Box_Data |
The structure type containing the smart object instance data, providing box object requirements. | |
typedef struct _Evas_Object_Box_Option | Evas_Object_Box_Option |
The structure type containing the base structure for a box option. Box options are a way of extending box items properties, which are taken into account for layouting decisions. The box layouting functions provided by Evas only relies on objects' canonical size hints to layout them, so the basic box option has no (custom) property set. | |
typedef void(* | Evas_Object_Box_Layout )(Evas_Object *o, Evas_Object_Box_Data *priv, void *user_data) |
Called for the function signature for an Evas box object layouting routine. o is the box object in question, priv is the box's internal data and, user_data is any custom data you could have set to a given box layouting function, with evas_object_box_layout_set(). | |
Defines | |
#define | EVAS_OBJECT_BOX_API_VERSION 1 |
Definition of the 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} |
Definition for initializing for a whole Evas_Object_Box_Api structure, with NULL values on its specific fields. | |
#define | EVAS_OBJECT_BOX_API_INIT_NULL EVAS_OBJECT_BOX_API_INIT(EVAS_SMART_CLASS_INIT_NULL) |
Definition for initializing 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) |
Definition for initializing to zero out a whole Evas_Object_Box_Api structure and set a specific version on it. | |
#define | EVAS_OBJECT_BOX_API_INIT_NAME_VERSION(name) EVAS_OBJECT_BOX_API_INIT(EVAS_SMART_CLASS_INIT_NAME_VERSION(name)) |
Definition for initializing to zero out a whole Evas_Object_Box_Api structure and set its name and version. |
This group provides functions for bos smart objects.
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.
#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} |
Definition for initializing for a whole Evas_Object_Box_Api structure, with NULL
values on its specific fields.
smart_class_init | The initializer to use for the "base" field (Evas_Smart_Class) |
#define EVAS_OBJECT_BOX_API_INIT_NAME_VERSION | ( | name | ) | EVAS_OBJECT_BOX_API_INIT(EVAS_SMART_CLASS_INIT_NAME_VERSION(name)) |
Definition for initializing to zero out a whole Evas_Object_Box_Api structure and set its name and version.
"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_OBJECT_BOX_API_INIT_NULL EVAS_OBJECT_BOX_API_INIT(EVAS_SMART_CLASS_INIT_NULL) |
Definition for initializing 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) |
Definition for initializing to zero out a whole Evas_Object_Box_Api structure and set a specific version on it.
The structure type containing the base structure for a box option. Box options are a way of extending box items properties, which are taken into account for layouting decisions. The box layouting functions provided by Evas only relies 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 or 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 or 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.
Eina_Accessor* evas_object_box_accessor_new | ( | const Evas_Object * | o | ) |
Gets an accessor (a structure providing random items access) to the list of children of a given box object.
[in] | o | The box to retrieve an items iterator from |
NULL
on errors Evas_Object* evas_object_box_add | ( | Evas * | evas | ) |
Adds a new box object on the provided canvas.
evas_object_box_{h,v}_{align,padding}_{get,set)()
.[in] | evas | The canvas to create the box object on |
NULL
on error Evas_Object* evas_object_box_add_to | ( | Evas_Object * | parent | ) |
Adds a new box as a child of a given smart object.
[in] | parent | The parent smart object to put the new box in |
NULL
on errorvoid evas_object_box_align_get | ( | const Evas_Object * | o, |
double * | horizontal, | ||
double * | vertical | ||
) |
Gets the alignment of the whole bounding box of contents, for a given box object.
[in] | o | The given box object to get alignment from |
[out] | horizontal | The pointer to a variable where to store the horizontal alignment |
[out] | vertical | The pointer to a variable where to store the vertical alignment |
void evas_object_box_align_set | ( | Evas_Object * | o, |
double | horizontal, | ||
double | vertical | ||
) |
Sets the alignment of the whole bounding box of contents, for a given box object.
This influences 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
.[in] | o | The given box object to set alignment from |
[in] | horizontal | The horizontal alignment, in pixels |
[in] | vertical | The vertical alignment, in pixels |
Evas_Object_Box_Option* evas_object_box_append | ( | Evas_Object * | o, |
Evas_Object * | child | ||
) |
Appends a new child object to the given box object o.
"child,added"
smart event takes place.[in] | o | The given box object |
[in] | child | A child Evas object to be made a member of o |
NULL
on errors Eina_List* evas_object_box_children_get | ( | const Evas_Object * | o | ) |
Gets the list of children objects in a given box object.
eina_list_free()
when you no longer need it.[in] | o | The box to retrieve an items list from |
NULL
on errors or if it has no child objects Evas_Object_Box_Option* evas_object_box_insert_after | ( | Evas_Object * | o, |
Evas_Object * | child, | ||
const Evas_Object * | reference | ||
) |
Inserts a new child object after another existing one, in a given box object o.
"child,added"
smart event takes place.[in] | o | The given box object |
[in] | child | A child Evas object to be made a member of o |
[in] | reference | The child object to place this new one after |
NULL
on errors Evas_Object_Box_Option* evas_object_box_insert_at | ( | Evas_Object * | o, |
Evas_Object * | child, | ||
unsigned int | pos | ||
) |
Inserts a new child object at a given position, in a given box object o.
"child,added"
smart event takes place.[in] | o | The given box object |
[in] | child | A child Evas object to be made a member of o |
[in] | pos | The numeric position (starting from 0 ) to place the new child object at |
NULL
on errors Evas_Object_Box_Option* evas_object_box_insert_before | ( | Evas_Object * | o, |
Evas_Object * | child, | ||
const Evas_Object * | reference | ||
) |
Inserts a new child object before another existing one, in a given box object o.
"child,added"
smart event takes place.[in] | o | The given box object |
[in] | child | A child Evas object to be made a member of o |
[in] | reference | The child object to place this new one before |
NULL
on errors Eina_Iterator* evas_object_box_iterator_new | ( | const Evas_Object * | o | ) |
Gets an iterator to walk the list of children of a given box object.
[in] | o | The box to retrieve an items iterator from |
NULL
on errors void evas_object_box_layout_flow_horizontal | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Sets the box o to a flow horizontal box.
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.[in] | o | The box object in question |
[in] | priv | The smart data of the o |
[in] | data | The data pointer passed on evas_object_box_layout_set(), if any |
void evas_object_box_layout_flow_vertical | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
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.
[in] | o | The box object in question |
[in] | priv | The smart data of the o |
[in] | data | The data pointer passed on evas_object_box_layout_set(), if any |
void evas_object_box_layout_homogeneous_horizontal | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Sets the box o to a homogeneous horizontal box.
In a homogeneous horizontal box, its width is divided equally between the contained objects. The box's overall behavior is controlled by its padding or 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 do not 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 or 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).[in] | o | The box object in question |
[in] | priv | The smart data of the o |
[in] | data | The data pointer passed on evas_object_box_layout_set(), if any |
void evas_object_box_layout_homogeneous_max_size_horizontal | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Sets the box o to a maximum size, homogeneous horizontal box.
In a maximum size, homogeneous horizontal box, besides having cells of equal size reserved for the child objects, this size is 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 do not 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).[in] | o | The box object in question |
[in] | priv | The smart data of the o |
[in] | data | The data pointer passed on evas_object_box_layout_set(), if any |
void evas_object_box_layout_homogeneous_max_size_vertical | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Sets the box o to a maximum size, homogeneous vertical box.
[in] | o | The box object in question |
[in] | priv | The smart data of the o |
[in] | data | The data pointer passed on evas_object_box_layout_set(), if any |
void evas_object_box_layout_homogeneous_vertical | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Sets the box o to a homogeneous vertical box.
This Layout function behaves analogously to evas_object_box_layout_homogeneous_horizontal(). The description of its behaviour can be derived from that function's documentation.
[in] | o | The box object in question |
[in] | priv | The smart data of the o |
[in] | data | The data pointer passed on evas_object_box_layout_set(), if any |
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.
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 are 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 do not 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 or 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 not 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 tries to distribute (or take off) widths accordingly to the normalized list of weights: most weighted children remain or get larger in this process than the least ones. weight_y
does not influence the layout.If you desire 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.
[in] | o | The box object in question |
[in] | priv | The smart data of the o |
[in] | data | The data pointer passed on evas_object_box_layout_set(), if any |
void evas_object_box_layout_set | ( | Evas_Object * | o, |
Evas_Object_Box_Layout | cb, | ||
const void * | data, | ||
void(*)(void *data) | free_data | ||
) |
Sets a new layouting function to a given box object.
'calculate'
smart callback of the box's smart class.[in] | o | The box object to operate on |
[in] | cb | The new layout function to set on o |
[in] | data | The data pointer to be passed to cb |
[in] | free_data | The function to free data, if need be |
void evas_object_box_layout_stack | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Sets the box o to a stacking box.
In a stacking box, all children are given the same size -- the box's own size -- and they are stacked one above the other, so that the first object in o's internal list of child elements are 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.[in] | o | The box object in question |
[in] | priv | The smart data of the o |
[in] | data | The data pointer passed on evas_object_box_layout_set(), if any |
void evas_object_box_layout_vertical | ( | Evas_Object * | o, |
Evas_Object_Box_Data * | priv, | ||
void * | data | ||
) |
Sets the box o to a (basic) vertical box.
This Layout function behaves analogously to evas_object_box_layout_horizontal(). The description of its behaviour can be derived from that function's documentation.
[in] | o | The box object in question |
[in] | priv | The smart data of the o |
[in] | data | The data pointer passed on evas_object_box_layout_set(), if any |
Eina_Bool evas_object_box_option_property_get | ( | const Evas_Object * | o, |
Evas_Object_Box_Option * | opt, | ||
int | property, | ||
... | |||
) |
Gets a property's value (by its given numerical identifier), on a given box child element.
NULL
.[in] | o | The box parenting the child element |
[in] | opt | The box option structure bound to the child box element to get a property from |
[in] | property | The numerical ID of the given property |
[in] | ... | (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). |
int evas_object_box_option_property_id_get | ( | const Evas_Object * | o, |
const char * | name | ||
) |
Gets the numerical identifier of the property of the child elements of the box o which have name as name string.
NULL
.[in] | o | The box to search child options from |
[in] | name | The name string of the option being searched, for its ID |
-1
on errors const char* evas_object_box_option_property_name_get | ( | const Evas_Object * | o, |
int | property | ||
) |
Gets the name of the property of the child elements of the box o which have id as identifier.
NULL
.[in] | o | The box to search child options from |
[in] | property | The numerical identifier of the option being searched, for its name |
NULL
on errors Eina_Bool evas_object_box_option_property_set | ( | Evas_Object * | o, |
Evas_Object_Box_Option * | opt, | ||
int | property, | ||
... | |||
) |
Sets a property value (by its given numerical identifier), on a given box child element.
NULL
.[in] | o | The box parenting the child element |
[in] | opt | The box option structure bound to the child box element to set a property on |
[in] | property | The numerical ID of the given property |
[in] | ... | (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_Bool evas_object_box_option_property_vget | ( | const Evas_Object * | o, |
Evas_Object_Box_Option * | opt, | ||
int | property, | ||
va_list | args | ||
) |
Gets a property's value (by its given numerical identifier), on a given box child element -- by a variable argument list.
[in] | o | The box parenting the child element |
[in] | opt | The box option structure bound to the child box element to get a property from |
[in] | property | The numerical ID of the given property |
[in] | 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_Bool evas_object_box_option_property_vset | ( | Evas_Object * | o, |
Evas_Object_Box_Option * | opt, | ||
int | property, | ||
va_list | args | ||
) |
Sets a property value (by its given numerical identifier), on a given box child element -- by a variable argument list.
[in] | o | The box parenting the child element |
[in] | opt | The box option structure bound to the child box element to set a property on |
[in] | property | The numerical ID of the given property |
[in] | 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. |
void evas_object_box_padding_get | ( | const Evas_Object * | o, |
Evas_Coord * | horizontal, | ||
Evas_Coord * | vertical | ||
) |
Gets the (space) padding between cells set for a given box object.
[in] | o | The given box object to get padding from |
[out] | horizontal | The pointer to a variable where to store the horizontal padding |
[out] | vertical | The pointer to a variable where to store the vertical padding |
void evas_object_box_padding_set | ( | Evas_Object * | o, |
Evas_Coord | horizontal, | ||
Evas_Coord | vertical | ||
) |
Sets the (space) padding between cells set for a given box object.
0
.[in] | o | The given box object to set padding from |
[in] | horizontal | The horizontal padding, in pixels |
[in] | vertical | The vertical padding, in pixels |
Evas_Object_Box_Option* evas_object_box_prepend | ( | Evas_Object * | o, |
Evas_Object * | child | ||
) |
Prepends a new child object to the given box object o.
"child,added"
smart event takes place.[in] | o | The given box object |
[in] | child | A child Evas object to be made a member of o |
NULL
on errors Eina_Bool evas_object_box_remove | ( | Evas_Object * | o, |
Evas_Object * | child | ||
) |
Removes a given object from a box object, unparenting it again.
"child,removed"
smart event takes place.[in] | o | The box object to remove a child object from |
[in] | child | The handle to the child object to be removed |
Eina_Bool evas_object_box_remove_all | ( | Evas_Object * | o, |
Eina_Bool | clear | ||
) |
Removes all child objects from a box object, unparenting them again.
[in] | o | The box object to remove a child object from |
[in] | clear | Set EINA_TRUE to delete the just removed children, otherwise set EINA_FALSE to not delete the children |
Eina_Bool evas_object_box_remove_at | ( | Evas_Object * | o, |
unsigned int | pos | ||
) |
Removes an object, bound to a given position in a box object, unparenting it again.
option_free()
box smart callback is called automatically for you and, also, the "child,removed"
smart event takes place.[in] | o | The box object to remove a child object from |
[in] | pos | The numeric position (starting from 0 ) of the child object to be removed |
const Evas_Object_Box_Api* evas_object_box_smart_class_get | ( | void | ) |
Gets the Evas box smart class, for inheritance purposes.
void evas_object_box_smart_set | ( | Evas_Object_Box_Api * | api | ) |
Sets the default box api struct (Evas_Object_Box_Api) with the default values. This may be used to extend that API.
api | The box API struct to set back, most probably with overridden fields (on class extensions scenarios) |