Data Structures | |
| struct | address_const_of |
| struct | address_of |
Public Member Functions | |
| void | layout_horizontal (Evas_Object_Box_Data *priv_, void *data_) const |
| Layout function which sets the box o to a (basic) horizontal box. More... | |
| void | layout_vertical (Evas_Object_Box_Data *priv_, void *data_) const |
| Layout function which sets the box o to a (basic) vertical box. More... | |
| void | layout_homogeneous_max_size_horizontal (Evas_Object_Box_Data *priv_, void *data_) const |
| Layout function which sets the box o to a maximum size, homogeneous horizontal box. More... | |
| ::efl::eina::optional< ::evas::object > | internal_remove (::efl::eina::optional< ::evas::object > child_) const |
| No description supplied by the EAPI. More... | |
| void | layout_flow_vertical (Evas_Object_Box_Data *priv_, void *data_) const |
| Layout function which sets the box o to a flow vertical box. More... | |
| void | internal_option_free (Evas_Object_Box_Option *opt_) const |
| No description supplied by the EAPI. More... | |
| Evas_Object_Box_Option * | insert_after (::evas::object child_, const Evas_Object *reference_) const |
| Insert a new child object after another existing one, in a given box object o. More... | |
| bool | remove_all (bool clear_) const |
| Remove all child objects from a box object, unparenting them again. More... | |
| Eina_Iterator * | iterator_new () const |
| Get an iterator to walk the list of children of a given box object. More... | |
| ::efl::eina::optional< ::evas::object > | add_to () const |
| Add a new box as a child of a given smart object. More... | |
| Evas_Object_Box_Option * | append (::evas::object child_) const |
| Append a new child object to the given box object o. More... | |
| int | option_property_id_get (std::string name_) const |
| Get the numerical identifier of the property of the child elements of the box o which have name as name string. More... | |
| Evas_Object_Box_Option * | prepend (::evas::object child_) const |
| Prepend a new child object to the given box object o. More... | |
| Eina_Accessor * | accessor_new () const |
| Get an accessor (a structure providing random items access) to the list of children of a given box object. More... | |
| Evas_Object_Box_Option * | internal_append (::efl::eina::optional< ::evas::object > child_) const |
| No description supplied by the EAPI. More... | |
| bool | option_property_vset (Evas_Object_Box_Option *opt_, int property_, va_list *args_) const |
| Set a property value (by its given numerical identifier), on a given box child element – by a variable argument list. More... | |
| ::efl::eina::optional< ::evas::object > | internal_remove_at (unsigned int pos_) const |
| No description supplied by the EAPI. More... | |
| bool | remove_at (unsigned int pos_) const |
| Remove an object, bound to a given position in a box object, unparenting it again. More... | |
| bool | option_property_vget (Evas_Object_Box_Option *opt_, int property_, va_list *args_) const |
| Get a property's value (by its given numerical identifier), on a given box child element – by a variable argument list. More... | |
| Evas_Object_Box_Option * | internal_insert_at (::efl::eina::optional< ::evas::object > child_, unsigned int pos_) const |
| No description supplied by the EAPI. More... | |
| Evas_Object_Box_Option * | insert_before (::evas::object child_, const Evas_Object *reference_) const |
| Insert a new child object before another existing one, in a given box object o. More... | |
| ::efl::eina::optional< std::string > | option_property_name_get (int property_) const |
| Get the name of the property of the child elements of the box o which have id as identifier. More... | |
| Evas_Object_Box_Option * | internal_insert_before (::efl::eina::optional< ::evas::object > child_, const Evas_Object *reference_) const |
| No description supplied by the EAPI. More... | |
| void | layout_homogeneous_horizontal (Evas_Object_Box_Data *priv_, void *data_) const |
| Layout function which sets the box o to a homogeneous horizontal box. More... | |
| Evas_Object_Box_Option * | internal_option_new (::efl::eina::optional< ::evas::object > child_) const |
| No description supplied by the EAPI. More... | |
| void | layout_homogeneous_max_size_vertical (Evas_Object_Box_Data *priv_, void *data_) const |
| Layout function which sets the box o to a maximum size, homogeneous vertical box. More... | |
| Evas_Object_Box_Option * | internal_insert_after (::efl::eina::optional< ::evas::object > child_, const Evas_Object *reference_) const |
| No description supplied by the EAPI. More... | |
| Evas_Object_Box_Option * | insert_at (::evas::object child_, unsigned int pos_) const |
| Insert a new child object at a given position, in a given box object o. More... | |
| Evas_Object_Box_Option * | internal_prepend (::efl::eina::optional< ::evas::object > child_) const |
| No description supplied by the EAPI. More... | |
| bool | remove (::evas::object child_) const |
| Remove a given object from a box object, unparenting it again. More... | |
| void | layout_stack (Evas_Object_Box_Data *priv_, void *data_) const |
| Layout function which sets the box o to a stacking box. More... | |
| void | layout_homogeneous_vertical (Evas_Object_Box_Data *priv_, void *data_) const |
| Layout function which sets the box o to a homogeneous vertical box. More... | |
| void | layout_flow_horizontal (Evas_Object_Box_Data *priv_, void *data_) const |
| Layout function which sets the box o to a flow horizontal box. More... | |
| void | align_get (double *horizontal_, double *vertical_) const |
| Get the alignment of the whole bounding box of contents, for a given box object. More... | |
| void | align_set (double horizontal_, double vertical_) const |
| Set the alignment of the whole bounding box of contents, for a given box object. More... | |
| void | padding_get (Evas_Coord *horizontal_, Evas_Coord *vertical_) const |
| Get the (space) padding between cells set for a given box object. More... | |
| void | padding_set (Evas_Coord horizontal_, Evas_Coord vertical_) const |
| Set the (space) padding between cells set for a given box object. More... | |
| void | layout_set (Evas_Object_Box_Layout cb_, const void *data_, Eina_Free_Cb free_data_) const |
| Set a new layouting function to a given box object. More... | |
| template<typename F > | |
| ::efl::eo::signal_connection | callback_child_added_add (F &&callback_,::efl::eo::callback_priority priority_=::efl::eo::callback_priorities::default_) |
| template<typename T > | |
| void | callback_child_added_call (T *info) |
| template<typename F > | |
| ::efl::eo::signal_connection | callback_child_removed_add (F &&callback_,::efl::eo::callback_priority priority_=::efl::eo::callback_priorities::default_) |
| template<typename T > | |
| void | callback_child_removed_call (T *info) |
| operator::evas::box () const | |
| operator::evas::box & () | |
| operator::evas::box const & () const | |
Static Public Member Functions | |
| static Eo_Class const * | _eo_class () |
|
inline |
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 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.
| priv | |
| data |
|
inline |
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.
| priv | |
| data |
|
inline |
Layout function which 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 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).| priv | |
| data |
|
inline |
No description supplied by the EAPI.
| child |
|
inline |
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.
| priv | |
| data |
|
inline |
No description supplied by the EAPI.
| opt |
|
inline |
Insert a new child object after another existing one, in a given box object o.
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.| child | A child Evas object to be made a member of o |
| reference | The child object to place this new one after |
|
inline |
Remove all child objects from a box object, unparenting them again.
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.
| clear | if true, it will delete just removed children. |
|
inline |
Get an iterator to walk the list of children of a given box object.
o's child objects, on success, or NULL, on errors
|
inline |
Add a new box as a child of a given smart object.
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().
|
inline |
Append a new child object to the given box object 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.| child | A child Evas object to be made a member of o |
|
inline |
Get the numerical identifier of the property of the child elements of the box o which have name as name string.
-1, on errors.NULL.| name | The name string of the option being searched, for its ID |
|
inline |
Prepend a new child object to the given box object 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.| child | A child Evas object to be made a member of o |
|
inline |
Get an accessor (a structure providing random items access) to the list of children of a given box object.
o's child objects, on success, or NULL, on errors
|
inline |
No description supplied by the EAPI.
| child |
|
inline |
Set a property value (by its given numerical identifier), on a given box child element – by a variable argument list.
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.
| 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. |
|
inline |
No description supplied by the EAPI.
| pos |
|
inline |
Remove an object, bound to a given position in a box object, unparenting it again.
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.| pos | The numeric position (starting from 0) of the child object to be removed |
|
inline |
Get a property's value (by its given numerical identifier), on a given box child element – by a variable argument list.
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.
| 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. |
|
inline |
No description supplied by the EAPI.
| child | |
| pos |
|
inline |
Insert a new child object before another existing one, in a given box object o.
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.| child | A child Evas object to be made a member of o |
| reference | The child object to place this new one before |
|
inline |
Get the name of the property of the child elements of the box o which have id as identifier.
NULL, on errors.NULL.| property | The numerical identifier of the option being searched, for its name |
|
inline |
No description supplied by the EAPI.
| child | |
| reference |
|
inline |
Layout function which 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/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).| priv | |
| data |
|
inline |
No description supplied by the EAPI.
| child |
|
inline |
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.
| priv | |
| data |
|
inline |
No description supplied by the EAPI.
| child | |
| reference |
|
inline |
Insert a new child object at a given position, in a given box object o.
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.| 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 |
|
inline |
No description supplied by the EAPI.
| child |
|
inline |
Remove a given object from a box object, unparenting it again.
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.
| child | The handle to the child object to be removed |
|
inline |
Layout function which sets the box o to a stacking box.
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.| priv | |
| data |
|
inline |
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.
| priv | |
| data |
|
inline |
Layout function which 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.| priv | |
| data |
|
inline |
Get the alignment of the whole bounding box of contents, for a given box object.
| horizontal | The horizontal alignment, in pixels |
| vertical | the vertical alignment, in pixels |
|
inline |
Set the alignment of the whole bounding box of contents, for a given box object.
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.| horizontal | The horizontal alignment, in pixels |
| vertical | the vertical alignment, in pixels |
|
inline |
Get the (space) padding between cells set for a given box object.
| horizontal | The horizontal padding, in pixels |
| vertical | the vertical padding, in pixels |
|
inline |
Set the (space) padding between cells set for a given box object.
0.| horizontal | The horizontal padding, in pixels |
| vertical | the vertical padding, in pixels |
|
inline |
Set a new layouting function to a given box object.
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.| 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. |