forked from enlightenment/efl
326 lines
10 KiB
Plaintext
326 lines
10 KiB
Plaintext
class Elm_Box (Elm_Widget)
|
|
{
|
|
eo_prefix: elm_obj_box;
|
|
properties {
|
|
homogeneous {
|
|
set {
|
|
/*@
|
|
Set the box to arrange its children homogeneously
|
|
|
|
If enabled, homogeneous layout makes all items the same size, according
|
|
to the size of the largest of its children.
|
|
|
|
@note This flag is ignored if a custom layout function is set.
|
|
|
|
@ingroup Box */
|
|
}
|
|
get {
|
|
/*@
|
|
Get whether the box is using homogeneous mode or not
|
|
|
|
@return @c EINA_TRUE if it's homogeneous, @c EINA_FALSE otherwise
|
|
|
|
@ingroup Box */
|
|
}
|
|
values {
|
|
bool homogeneous; /*@ The homogeneous flag */
|
|
}
|
|
}
|
|
align {
|
|
set {
|
|
/*@
|
|
Set the alignment of the whole bounding box of contents.
|
|
|
|
Sets how the bounding box containing all the elements of the box, after
|
|
their sizes and position has been calculated, will be aligned within
|
|
the space given for the whole box widget.
|
|
|
|
@ingroup Box */
|
|
}
|
|
get {
|
|
/*@
|
|
Get the alignment of the whole bounding box of contents.
|
|
|
|
@see elm_box_align_set()
|
|
|
|
@ingroup Box */
|
|
}
|
|
values {
|
|
double horizontal; /*@ The horizontal alignment of elements */
|
|
double vertical; /*@ The vertical alignment of elements */
|
|
}
|
|
}
|
|
horizontal {
|
|
set {
|
|
/*@
|
|
Set the horizontal orientation
|
|
|
|
By default, box object arranges their contents vertically from top to
|
|
bottom.
|
|
By calling this function with @p horizontal as @c EINA_TRUE, the box will
|
|
become horizontal, arranging contents from left to right.
|
|
|
|
@note This flag is ignored if a custom layout function is set.
|
|
|
|
@ingroup Box */
|
|
}
|
|
get {
|
|
/*@
|
|
Get the horizontal orientation
|
|
|
|
@return @c EINA_TRUE if the box is set to horizontal mode, @c EINA_FALSE otherwise */
|
|
}
|
|
values {
|
|
bool horizontal; /*@ The horizontal flag (@c EINA_TRUE = horizontal,
|
|
@c EINA_FALSE = vertical) */
|
|
}
|
|
}
|
|
padding {
|
|
set {
|
|
/*@
|
|
Set the space (padding) between the box's elements.
|
|
|
|
Extra space in pixels that will be added between a box child and its
|
|
neighbors after its containing cell has been calculated. This padding
|
|
is set for all elements in the box, besides any possible padding that
|
|
individual elements may have through their size hints.
|
|
|
|
@ingroup Box */
|
|
}
|
|
get {
|
|
/*@
|
|
Get the space (padding) between the box's elements.
|
|
|
|
@see elm_box_padding_set()
|
|
|
|
@ingroup Box */
|
|
}
|
|
values {
|
|
Evas_Coord horizontal; /*@ The horizontal space between elements */
|
|
Evas_Coord vertical; /*@ The vertical space between elements */
|
|
}
|
|
}
|
|
layout {
|
|
set {
|
|
/*@
|
|
Set the layout defining function to be used by the box
|
|
|
|
Whenever anything changes that requires the box in @p obj to recalculate
|
|
the size and position of its elements, the function @p cb will be called
|
|
to determine what the layout of the children will be.
|
|
|
|
Once a custom function is set, everything about the children layout
|
|
is defined by it. The flags set by elm_box_horizontal_set() and
|
|
elm_box_homogeneous_set() no longer have any meaning, and the values
|
|
given by elm_box_padding_set() and elm_box_align_set() are up to this
|
|
layout function to decide if they are used and how. These last two
|
|
will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
|
|
passed to @p cb. The @c Evas_Object the function receives is not the
|
|
Elementary widget, but the internal Evas Box it uses, so none of the
|
|
functions described here can be used on it.
|
|
|
|
Any of the layout functions in @c Evas can be used here, as well as the
|
|
special elm_box_layout_transition().
|
|
|
|
The final @p data argument received by @p cb is the same @p data passed
|
|
here, and the @p free_data function will be called to free it
|
|
whenever the box is destroyed or another layout function is set.
|
|
|
|
Setting @p cb to NULL will revert back to the default layout function.
|
|
|
|
@see elm_box_layout_transition()
|
|
|
|
@ingroup Box */
|
|
}
|
|
values {
|
|
Evas_Object_Box_Layout cb; /*@ The callback function used for layout */
|
|
const(void)* data; /*@ Data that will be passed to layout function */
|
|
Ecore_Cb free_data; /*@ Function called to free @p data */
|
|
}
|
|
}
|
|
children {
|
|
get {
|
|
/*@
|
|
Get a list of the objects packed into the box
|
|
|
|
Returns a new @c list with a pointer to @c Evas_Object in its nodes.
|
|
The order of the list corresponds to the packing order the box uses.
|
|
|
|
You must free this list with eina_list_free() once you are done with it.
|
|
|
|
@ingroup Box */
|
|
return: own(list<Evas_Object*>*);
|
|
}
|
|
}
|
|
}
|
|
methods {
|
|
pack_end {
|
|
/*@
|
|
Add an object at the end of the pack list
|
|
|
|
Pack @p subobj into the box @p obj, placing it last in the list of
|
|
children objects. The actual position the object will get on screen
|
|
depends on the layout used. If no custom layout is set, it will be at
|
|
the bottom or right, depending if the box is vertical or horizontal,
|
|
respectively.
|
|
|
|
@see elm_box_pack_start()
|
|
@see elm_box_pack_before()
|
|
@see elm_box_pack_after()
|
|
@see elm_box_unpack()
|
|
@see elm_box_unpack_all()
|
|
@see elm_box_clear()
|
|
|
|
@ingroup Box */
|
|
|
|
params {
|
|
@in Evas_Object *subobj; /*@ The object to add to the box */
|
|
}
|
|
}
|
|
unpack_all {
|
|
/*@
|
|
Remove all items from the box, without deleting them
|
|
|
|
Clear the box from all children, but don't delete the respective objects.
|
|
If no other references of the box children exist, the objects will never
|
|
be deleted, and thus the application will leak the memory. Make sure
|
|
when using this function that you hold a reference to all the objects
|
|
in the box @p obj.
|
|
|
|
@see elm_box_clear()
|
|
@see elm_box_unpack()
|
|
|
|
@ingroup Box */
|
|
|
|
}
|
|
unpack {
|
|
/*@
|
|
Unpack a box item
|
|
|
|
Remove the object given by @p subobj from the box @p obj without
|
|
deleting it.
|
|
|
|
@see elm_box_unpack_all()
|
|
@see elm_box_clear()
|
|
|
|
@ingroup Box */
|
|
|
|
params {
|
|
@in Evas_Object *subobj; /*@ The object to unpack */
|
|
}
|
|
}
|
|
pack_after {
|
|
/*@
|
|
Adds an object to the box after the indicated object
|
|
|
|
This will add the @p subobj to the box indicated after the object
|
|
indicated with @p after. If @p after is not already in the box, results
|
|
are undefined. After means either to the right of the indicated object or
|
|
below it depending on orientation.
|
|
|
|
@see elm_box_pack_start()
|
|
@see elm_box_pack_end()
|
|
@see elm_box_pack_before()
|
|
@see elm_box_unpack()
|
|
@see elm_box_unpack_all()
|
|
@see elm_box_clear()
|
|
|
|
@ingroup Box */
|
|
|
|
params {
|
|
@in Evas_Object *subobj; /*@ The object to add to the box */
|
|
@in Evas_Object *after; /*@ The object after which to add it */
|
|
}
|
|
}
|
|
pack_start {
|
|
/*@
|
|
Add an object to the beginning of the pack list
|
|
|
|
Pack @p subobj into the box @p obj, placing it first in the list of
|
|
children objects. The actual position the object will get on screen
|
|
depends on the layout used. If no custom layout is set, it will be at
|
|
the top or left, depending if the box is vertical or horizontal,
|
|
respectively.
|
|
|
|
@see elm_box_pack_end()
|
|
@see elm_box_pack_before()
|
|
@see elm_box_pack_after()
|
|
@see elm_box_unpack()
|
|
@see elm_box_unpack_all()
|
|
@see elm_box_clear()
|
|
|
|
@ingroup Box */
|
|
|
|
params {
|
|
@in Evas_Object *subobj; /*@ The object to add to the box */
|
|
}
|
|
}
|
|
recalculate {
|
|
/*@
|
|
Force the box to recalculate its children packing.
|
|
|
|
If any children was added or removed, box will not calculate the
|
|
values immediately rather leaving it to the next main loop
|
|
iteration. While this is great as it would save lots of
|
|
recalculation, whenever you need to get the position of a just
|
|
added item you must force recalculate before doing so.
|
|
|
|
@ingroup Box */
|
|
|
|
}
|
|
pack_before {
|
|
/*@
|
|
Adds an object to the box before the indicated object
|
|
|
|
This will add the @p subobj to the box indicated before the object
|
|
indicated with @p before. If @p before is not already in the box, results
|
|
are undefined. Before means either to the left of the indicated object or
|
|
above it depending on orientation.
|
|
|
|
@see elm_box_pack_start()
|
|
@see elm_box_pack_end()
|
|
@see elm_box_pack_after()
|
|
@see elm_box_unpack()
|
|
@see elm_box_unpack_all()
|
|
@see elm_box_clear()
|
|
|
|
@ingroup Box */
|
|
|
|
params {
|
|
@in Evas_Object *subobj; /*@ The object to add to the box */
|
|
@in Evas_Object *before; /*@ The object before which to add it */
|
|
}
|
|
}
|
|
clear {
|
|
/*@
|
|
Clear the box of all children
|
|
|
|
Remove all the elements contained by the box, deleting the respective
|
|
objects.
|
|
|
|
@see elm_box_unpack()
|
|
@see elm_box_unpack_all()
|
|
|
|
@ingroup Box */
|
|
|
|
}
|
|
}
|
|
implements {
|
|
class.constructor;
|
|
Eo.Base.constructor;
|
|
Evas.Object_Smart.add;
|
|
Evas.Object_Smart.del;
|
|
Elm_Widget.focus_direction;
|
|
Elm_Widget.focus_next_manager_is;
|
|
Elm_Widget.focus_direction_manager_is;
|
|
Elm_Widget.focus_next;
|
|
Elm_Widget.theme_apply;
|
|
Elm_Widget.sub_object_del;
|
|
}
|
|
events {
|
|
child,added;
|
|
child,removed;
|
|
}
|
|
|
|
}
|