4 * @image html img/widget/box/preview-00.png
5 * @image latex img/widget/box/preview-00.eps width=\textwidth
7 * @image html img/box.png
8 * @image latex img/box.eps width=\textwidth
10 * A box arranges objects in a linear fashion, governed by a layout function
11 * that defines the details of this arrangement.
13 * By default, the box will use an internal function to set the layout to
14 * a single row, either vertical or horizontal. This layout is affected
15 * by a number of parameters, such as the homogeneous flag set by
16 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
17 * elm_box_align_set() and the hints set to each object in the box.
19 * For this default layout, it's possible to change the orientation with
20 * elm_box_horizontal_set(). The box will start in the vertical orientation,
21 * placing its elements ordered from top to bottom. When horizontal is set,
22 * the order will go from left to right. If the box is set to be
23 * homogeneous, every object in it will be assigned the same space, that
24 * of the largest object. Padding can be used to set some spacing between
25 * the cell given to each object. The alignment of the box, set with
26 * elm_box_align_set(), determines how the bounding box of all the elements
27 * will be placed within the space given to the box widget itself.
29 * The size hints of each object also affect how they are placed and sized
30 * within the box. evas_object_size_hint_min_set() will give the minimum
31 * size the object can have, and the box will use it as the basis for all
32 * latter calculations. Elementary widgets set their own minimum size as
33 * needed, so there's rarely any need to use it manually.
35 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
36 * used to tell whether the object will be allocated the minimum size it
37 * needs or if the space given to it should be expanded. It's important
38 * to realize that expanding the size given to the object is not the same
39 * thing as resizing the object. It could very well end being a small
40 * widget floating in a much larger empty space. If not set, the weight
41 * for objects will normally be 0.0 for both axis, meaning the widget will
42 * not be expanded. To take as much space possible, set the weight to
43 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
45 * Besides how much space each object is allocated, it's possible to control
46 * how the widget will be placed within that space using
47 * evas_object_size_hint_align_set(). By default, this value will be 0.5
48 * for both axis, meaning the object will be centered, but any value from
49 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
50 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
51 * is -1.0, means the object will be resized to fill the entire space it
54 * In addition, customized functions to define the layout can be set, which
55 * allow the application developer to organize the objects within the box
56 * in any number of ways.
58 * The special elm_box_layout_transition() function can be used
59 * to switch from one layout to another, animating the motion of the
60 * children of the box.
62 * @note Objects should not be added to box objects using _add() calls.
64 * Some examples on how to use boxes follow:
65 * @li @ref box_example_01
66 * @li @ref box_example_02
71 * @typedef Elm_Box_Transition
73 * Opaque handler containing the parameters to perform an animated
74 * transition of the layout the box uses.
76 * @see elm_box_transition_new()
77 * @see elm_box_layout_set()
78 * @see elm_box_layout_transition()
80 typedef struct _Elm_Box_Transition Elm_Box_Transition;
83 * Add a new box to the parent
85 * By default, the box will be in vertical mode and non-homogeneous.
87 * @param parent The parent object
88 * @return The new object or NULL if it cannot be created
90 EAPI Evas_Object *elm_box_add(Evas_Object *parent);
93 * Set the horizontal orientation
95 * By default, box object arranges their contents vertically from top to
97 * By calling this function with @p horizontal as EINA_TRUE, the box will
98 * become horizontal, arranging contents from left to right.
100 * @note This flag is ignored if a custom layout function is set.
102 * @param obj The box object
103 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
104 * EINA_FALSE = vertical)
106 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
109 * Get the horizontal orientation
111 * @param obj The box object
112 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
114 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj);
117 * Set the box to arrange its children homogeneously
119 * If enabled, homogeneous layout makes all items the same size, according
120 * to the size of the largest of its children.
122 * @note This flag is ignored if a custom layout function is set.
124 * @param obj The box object
125 * @param homogeneous The homogeneous flag
127 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous);
130 * Get whether the box is using homogeneous mode or not
132 * @param obj The box object
133 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
135 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj);
138 * Add an object to the beginning of the pack list
140 * Pack @p subobj into the box @p obj, placing it first in the list of
141 * children objects. The actual position the object will get on screen
142 * depends on the layout used. If no custom layout is set, it will be at
143 * the top or left, depending if the box is vertical or horizontal,
146 * @param obj The box object
147 * @param subobj The object to add to the box
149 * @see elm_box_pack_end()
150 * @see elm_box_pack_before()
151 * @see elm_box_pack_after()
152 * @see elm_box_unpack()
153 * @see elm_box_unpack_all()
154 * @see elm_box_clear()
156 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj);
159 * Add an object at the end of the pack list
161 * Pack @p subobj into the box @p obj, placing it last in the list of
162 * children objects. The actual position the object will get on screen
163 * depends on the layout used. If no custom layout is set, it will be at
164 * the bottom or right, depending if the box is vertical or horizontal,
167 * @param obj The box object
168 * @param subobj The object to add to the box
170 * @see elm_box_pack_start()
171 * @see elm_box_pack_before()
172 * @see elm_box_pack_after()
173 * @see elm_box_unpack()
174 * @see elm_box_unpack_all()
175 * @see elm_box_clear()
177 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj);
180 * Adds an object to the box before the indicated object
182 * This will add the @p subobj to the box indicated before the object
183 * indicated with @p before. If @p before is not already in the box, results
184 * are undefined. Before means either to the left of the indicated object or
185 * above it depending on orientation.
187 * @param obj The box object
188 * @param subobj The object to add to the box
189 * @param before The object before which to add it
191 * @see elm_box_pack_start()
192 * @see elm_box_pack_end()
193 * @see elm_box_pack_after()
194 * @see elm_box_unpack()
195 * @see elm_box_unpack_all()
196 * @see elm_box_clear()
198 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before);
201 * Adds an object to the box after the indicated object
203 * This will add the @p subobj to the box indicated after the object
204 * indicated with @p after. If @p after is not already in the box, results
205 * are undefined. After means either to the right of the indicated object or
206 * below it depending on orientation.
208 * @param obj The box object
209 * @param subobj The object to add to the box
210 * @param after The object after which to add it
212 * @see elm_box_pack_start()
213 * @see elm_box_pack_end()
214 * @see elm_box_pack_before()
215 * @see elm_box_unpack()
216 * @see elm_box_unpack_all()
217 * @see elm_box_clear()
219 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after);
222 * Clear the box of all children
224 * Remove all the elements contained by the box, deleting the respective
227 * @param obj The box object
229 * @see elm_box_unpack()
230 * @see elm_box_unpack_all()
232 EAPI void elm_box_clear(Evas_Object *obj);
237 * Remove the object given by @p subobj from the box @p obj without
240 * @param obj The box object
241 * @param subobj The object to unpack
243 * @see elm_box_unpack_all()
244 * @see elm_box_clear()
246 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj);
249 * Remove all items from the box, without deleting them
251 * Clear the box from all children, but don't delete the respective objects.
252 * If no other references of the box children exist, the objects will never
253 * be deleted, and thus the application will leak the memory. Make sure
254 * when using this function that you hold a reference to all the objects
257 * @param obj The box object
259 * @see elm_box_clear()
260 * @see elm_box_unpack()
262 EAPI void elm_box_unpack_all(Evas_Object *obj);
265 * Retrieve a list of the objects packed into the box
267 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
268 * The order of the list corresponds to the packing order the box uses.
270 * You must free this list with eina_list_free() once you are done with it.
272 * @param obj The box object
274 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj);
277 * Set the space (padding) between the box's elements.
279 * Extra space in pixels that will be added between a box child and its
280 * neighbors after its containing cell has been calculated. This padding
281 * is set for all elements in the box, besides any possible padding that
282 * individual elements may have through their size hints.
284 * @param obj The box object
285 * @param horizontal The horizontal space between elements
286 * @param vertical The vertical space between elements
288 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical);
291 * Get the space (padding) between the box's elements.
293 * @param obj The box object
294 * @param horizontal The horizontal space between elements
295 * @param vertical The vertical space between elements
297 * @see elm_box_padding_set()
299 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical);
302 * Set the alignment of the whole bouding box of contents.
304 * Sets how the bounding box containing all the elements of the box, after
305 * their sizes and position has been calculated, will be aligned within
306 * the space given for the whole box widget.
308 * @param obj The box object
309 * @param horizontal The horizontal alignment of elements
310 * @param vertical The vertical alignment of elements
312 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical);
315 * Get the alignment of the whole bouding box of contents.
317 * @param obj The box object
318 * @param horizontal The horizontal alignment of elements
319 * @param vertical The vertical alignment of elements
321 * @see elm_box_align_set()
323 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical);
326 * Force the box to recalculate its children packing.
328 * If any children was added or removed, box will not calculate the
329 * values immediately rather leaving it to the next main loop
330 * iteration. While this is great as it would save lots of
331 * recalculation, whenever you need to get the position of a just
332 * added item you must force recalculate before doing so.
334 * @param obj The box object.
336 EAPI void elm_box_recalculate(Evas_Object *obj);
339 * Set the layout defining function to be used by the box
341 * Whenever anything changes that requires the box in @p obj to recalculate
342 * the size and position of its elements, the function @p cb will be called
343 * to determine what the layout of the children will be.
345 * Once a custom function is set, everything about the children layout
346 * is defined by it. The flags set by elm_box_horizontal_set() and
347 * elm_box_homogeneous_set() no longer have any meaning, and the values
348 * given by elm_box_padding_set() and elm_box_align_set() are up to this
349 * layout function to decide if they are used and how. These last two
350 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
351 * passed to @p cb. The @c Evas_Object the function receives is not the
352 * Elementary widget, but the internal Evas Box it uses, so none of the
353 * functions described here can be used on it.
355 * Any of the layout functions in @c Evas can be used here, as well as the
356 * special elm_box_layout_transition().
358 * The final @p data argument received by @p cb is the same @p data passed
359 * here, and the @p free_data function will be called to free it
360 * whenever the box is destroyed or another layout function is set.
362 * Setting @p cb to NULL will revert back to the default layout function.
364 * @param obj The box object
365 * @param cb The callback function used for layout
366 * @param data Data that will be passed to layout function
367 * @param free_data Function called to free @p data
369 * @see elm_box_layout_transition()
371 EAPI void elm_box_layout_set(Evas_Object *obj, Evas_Object_Box_Layout cb, const void *data, void (*free_data)(void *data));
374 * Special layout function that animates the transition from one layout to another
376 * Normally, when switching the layout function for a box, this will be
377 * reflected immediately on screen on the next render, but it's also
378 * possible to do this through an animated transition.
380 * This is done by creating an ::Elm_Box_Transition and setting the box
381 * layout to this function.
385 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
386 * evas_object_box_layout_vertical, // start
387 * NULL, // data for initial layout
388 * NULL, // free function for initial data
389 * evas_object_box_layout_horizontal, // end
390 * NULL, // data for final layout
391 * NULL, // free function for final data
392 * anim_end, // will be called when animation ends
393 * NULL); // data for anim_end function\
394 * elm_box_layout_set(box, elm_box_layout_transition, t,
395 * elm_box_transition_free);
398 * @note This function can only be used with elm_box_layout_set(). Calling
399 * it directly will not have the expected results.
401 * @see elm_box_transition_new
402 * @see elm_box_transition_free
403 * @see elm_box_layout_set
405 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
408 * Create a new ::Elm_Box_Transition to animate the switch of layouts
410 * If you want to animate the change from one layout to another, you need
411 * to set the layout function of the box to elm_box_layout_transition(),
412 * passing as user data to it an instance of ::Elm_Box_Transition with the
413 * necessary information to perform this animation. The free function to
414 * set for the layout is elm_box_transition_free().
416 * The parameters to create an ::Elm_Box_Transition sum up to how long
417 * will it be, in seconds, a layout function to describe the initial point,
418 * another for the final position of the children and one function to be
419 * called when the whole animation ends. This last function is useful to
420 * set the definitive layout for the box, usually the same as the end
421 * layout for the animation, but could be used to start another transition.
423 * @param duration The duration of the transition in seconds
424 * @param start_layout The layout function that will be used to start the animation
425 * @param start_layout_data The data to be passed the @p start_layout function
426 * @param start_layout_free_data Function to free @p start_layout_data
427 * @param end_layout The layout function that will be used to end the animation
428 * @param end_layout_data Data param passed to @p end_layout
429 * @param end_layout_free_data The data to be passed the @p end_layout function
430 * @param end_layout_free_data Function to free @p end_layout_data
431 * @param transition_end_cb Callback function called when animation ends
432 * @param transition_end_data Data to be passed to @p transition_end_cb
433 * @return An instance of ::Elm_Box_Transition
435 * @see elm_box_transition_new
436 * @see elm_box_layout_transition
438 EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, void (*start_layout_free_data)(void *data), Evas_Object_Box_Layout end_layout, void *end_layout_data, void (*end_layout_free_data)(void *data), void (*transition_end_cb)(void *data), void *transition_end_data);
441 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
443 * This function is mostly useful as the @c free_data parameter in
444 * elm_box_layout_set() when elm_box_layout_transition().
446 * @param data The Elm_Box_Transition instance to be freed.
448 * @see elm_box_transition_new
449 * @see elm_box_layout_transition
451 EAPI void elm_box_transition_free(void *data);