281 lines
8.5 KiB
C
281 lines
8.5 KiB
C
#ifndef _ELM_BOX_EO_LEGACY_H_
|
|
#define _ELM_BOX_EO_LEGACY_H_
|
|
|
|
#ifndef _ELM_BOX_EO_CLASS_TYPE
|
|
#define _ELM_BOX_EO_CLASS_TYPE
|
|
|
|
typedef Eo Elm_Box;
|
|
|
|
#endif
|
|
|
|
#ifndef _ELM_BOX_EO_TYPES
|
|
#define _ELM_BOX_EO_TYPES
|
|
|
|
|
|
#endif
|
|
|
|
/**
|
|
* @brief 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.
|
|
*
|
|
* @param[in] obj The object.
|
|
* @param[in] homogeneous The homogeneous flag
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_homogeneous_set(Elm_Box *obj, Eina_Bool homogeneous);
|
|
|
|
/**
|
|
* @brief Get whether the box is using homogeneous mode or not ($true if it's
|
|
* homogeneous, @c false otherwise)
|
|
*
|
|
* @param[in] obj The object.
|
|
*
|
|
* @return The homogeneous flag
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI Eina_Bool elm_box_homogeneous_get(const Elm_Box *obj);
|
|
|
|
/**
|
|
* @brief 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.
|
|
*
|
|
* @param[in] obj The object.
|
|
* @param[in] horizontal The horizontal alignment of elements
|
|
* @param[in] vertical The vertical alignment of elements
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_align_set(Elm_Box *obj, double horizontal, double vertical);
|
|
|
|
/**
|
|
* @brief Get the alignment of the whole bounding box of contents.
|
|
*
|
|
* See also @ref elm_box_align_set.
|
|
*
|
|
* @param[in] obj The object.
|
|
* @param[out] horizontal The horizontal alignment of elements
|
|
* @param[out] vertical The vertical alignment of elements
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_align_get(const Elm_Box *obj, double *horizontal, double *vertical);
|
|
|
|
/**
|
|
* @brief Set the horizontal orientation
|
|
*
|
|
* By default, box object arranges their contents vertically from top to
|
|
* bottom. By calling this function with @c horizontal as @c true, the box will
|
|
* become horizontal, arranging contents from left to right.
|
|
*
|
|
* @note This flag is ignored if a custom layout function is set.
|
|
*
|
|
* @param[in] obj The object.
|
|
* @param[in] horizontal The horizontal flag
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_horizontal_set(Elm_Box *obj, Eina_Bool horizontal);
|
|
|
|
/**
|
|
* @brief Get the horizontal orientation ($true if the box is set to horizontal
|
|
* mode, @c false otherwise)
|
|
*
|
|
* @param[in] obj The object.
|
|
*
|
|
* @return The horizontal flag
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI Eina_Bool elm_box_horizontal_get(const Elm_Box *obj);
|
|
|
|
/**
|
|
* @brief 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.
|
|
*
|
|
* @param[in] obj The object.
|
|
* @param[in] horizontal The horizontal space between elements
|
|
* @param[in] vertical The vertical space between elements
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_padding_set(Elm_Box *obj, int horizontal, int vertical);
|
|
|
|
/**
|
|
* @brief Get the space (padding) between the box's elements.
|
|
*
|
|
* See also @ref elm_box_padding_set.
|
|
*
|
|
* @param[in] obj The object.
|
|
* @param[out] horizontal The horizontal space between elements
|
|
* @param[out] vertical The vertical space between elements
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_padding_get(const Elm_Box *obj, int *horizontal, int *vertical);
|
|
|
|
/**
|
|
* @brief 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.
|
|
*
|
|
* @param[in] obj The object.
|
|
*
|
|
* @return List of children
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI Eina_List *elm_box_children_get(const Elm_Box *obj) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Add an object at the end of the pack list
|
|
*
|
|
* Pack @c subobj into the box @c 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 also @ref elm_box_pack_start, @ref elm_box_pack_before,
|
|
* @ref elm_box_pack_after, @ref elm_box_unpack, @ref elm_box_unpack_all,
|
|
* @ref elm_box_clear.
|
|
*
|
|
* @param[in] obj The object.
|
|
* @param[in] subobj The object to add to the box
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_pack_end(Elm_Box *obj, Efl_Canvas_Object *subobj);
|
|
|
|
/**
|
|
* @brief 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
|
|
* @c obj.
|
|
*
|
|
* See also @ref elm_box_clear, @ref elm_box_unpack.
|
|
* @param[in] obj The object.
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_unpack_all(Elm_Box *obj);
|
|
|
|
/**
|
|
* @brief Unpack a box item
|
|
*
|
|
* Remove the object given by @c subobj from the box @c obj without deleting
|
|
* it.
|
|
*
|
|
* See also @ref elm_box_unpack_all, @ref elm_box_clear.
|
|
*
|
|
* @param[in] obj The object.
|
|
* @param[in] subobj The object to unpack
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_unpack(Elm_Box *obj, Efl_Canvas_Object *subobj);
|
|
|
|
/**
|
|
* @brief Adds an object to the box after the indicated object
|
|
*
|
|
* This will add the @c subobj to the box indicated after the object indicated
|
|
* with @c after. If @c 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 also @ref elm_box_pack_start, @ref elm_box_pack_end,
|
|
* @ref elm_box_pack_before, @ref elm_box_unpack, @ref elm_box_unpack_all,
|
|
* @ref elm_box_clear.
|
|
*
|
|
* @param[in] obj The object.
|
|
* @param[in] subobj The object to add to the box
|
|
* @param[in] after The object after which to add it
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_pack_after(Elm_Box *obj, Efl_Canvas_Object *subobj, Efl_Canvas_Object *after);
|
|
|
|
/**
|
|
* @brief Add an object to the beginning of the pack list
|
|
*
|
|
* Pack @c subobj into the box @c 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 also @ref elm_box_pack_end, @ref elm_box_pack_before,
|
|
* @ref elm_box_pack_after, @ref elm_box_unpack, @ref elm_box_unpack_all,
|
|
* @ref elm_box_clear.
|
|
*
|
|
* @param[in] obj The object.
|
|
* @param[in] subobj The object to add to the box
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_pack_start(Elm_Box *obj, Efl_Canvas_Object *subobj);
|
|
|
|
/**
|
|
* @brief 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.
|
|
* @param[in] obj The object.
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_recalculate(Elm_Box *obj);
|
|
|
|
/**
|
|
* @brief Adds an object to the box before the indicated object
|
|
*
|
|
* This will add the @c subobj to the box indicated before the object indicated
|
|
* with @c before. If @c 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 also @ref elm_box_pack_start, @ref elm_box_pack_end,
|
|
* @ref elm_box_pack_after, @ref elm_box_unpack, @ref elm_box_unpack_all,
|
|
* @ref elm_box_clear.
|
|
*
|
|
* @param[in] obj The object.
|
|
* @param[in] subobj The object to add to the box
|
|
* @param[in] before The object before which to add it
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_pack_before(Elm_Box *obj, Efl_Canvas_Object *subobj, Efl_Canvas_Object *before);
|
|
|
|
/**
|
|
* @brief Clear the box of all children
|
|
*
|
|
* Remove all the elements contained by the box, deleting the respective
|
|
* objects.
|
|
*
|
|
* See also @ref elm_box_unpack, @ref elm_box_unpack_all.
|
|
* @param[in] obj The object.
|
|
*
|
|
* @ingroup Elm_Box_Group
|
|
*/
|
|
EAPI void elm_box_clear(Elm_Box *obj);
|
|
|
|
#endif
|