/**
* @defgroup Layout Layout
+ * @ingroup Elementary
*
* @image html img/widget/layout/preview-00.png
* @image latex img/widget/layout/preview-00.eps width=\textwidth
* sent to the Layout theme (with elm_object_signal_emit()) and the theme
* handled the signal by changing the box padding, or align, or both. Using
* the Elementary @ref Box widget is not necessarily harder or easier, it
- * just depends on the circunstances and requirements.
+ * just depends on the circumstances and requirements.
*
* The Layout Box can be used through the @c elm_layout_box_* set of
* functions.
* table
*
* Supported elm_object common APIs.
- * @li elm_object_signal_emit
- * @li elm_object_signal_callback_add
- * @li elm_object_signal_callback_del
- * @li elm_object_part_text_set
- * @li elm_object_part_text_get
- * @li elm_object_part_content_set
- * @li elm_object_part_content_get
- * @li elm_object_part_content_unset
+ * @li @ref elm_object_signal_emit
+ * @li @ref elm_object_signal_callback_add
+ * @li @ref elm_object_signal_callback_del
+ * @li @ref elm_object_part_text_set
+ * @li @ref elm_object_part_text_get
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
*
* @section secExamples Examples
*
* Set the edje group from the elementary theme that will be used as layout
*
* @param obj The layout object
- * @param clas the clas of the group
+ * @param clas the class of the group
* @param group the group
* @param style the style to used
*
* @param obj the layout object
* @param part the box part to which the object will be appended.
* @param child the child object to append to box.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* Once the object is appended, it will become child of the layout. Its
* lifetime will be bound to the layout, whenever the layout dies the child
*
* @ingroup Layout
*/
-EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child);
+EAPI Eina_Bool elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child);
/**
* Prepend child to layout box part.
* @param obj the layout object
* @param part the box part to prepend.
* @param child the child object to prepend to box.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* Once the object is prepended, it will become child of the layout. Its
* lifetime will be bound to the layout, whenever the layout dies the child
*
* @ingroup Layout
*/
-EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child);
+EAPI Eina_Bool elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child);
/**
* Insert child to layout box part before a reference object.
* @param part the box part to insert.
* @param child the child object to insert into box.
* @param reference another reference object to insert before in box.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* Once the object is inserted, it will become child of the layout. Its
* lifetime will be bound to the layout, whenever the layout dies the child
*
* @ingroup Layout
*/
-EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference);
+EAPI Eina_Bool elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference);
/**
* Insert child to layout box part at a given position.
* @param part the box part to insert.
* @param child the child object to insert into box.
* @param pos the numeric position >=0 to insert the child.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* Once the object is inserted, it will become child of the layout. Its
* lifetime will be bound to the layout, whenever the layout dies the child
*
* @ingroup Layout
*/
-EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos);
+EAPI Eina_Bool elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos);
/**
* Remove a child of the given part box.
* @param clear If EINA_TRUE, then all objects will be deleted as
* well, otherwise they will just be removed and will be
* dangling on the canvas.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* The objects will be removed from the box part and their lifetime will
* not be handled by the layout anymore. This is equivalent to
*
* @ingroup Layout
*/
-EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear);
+EAPI Eina_Bool elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear);
/**
* Insert child to layout table part.
* @param colspan how many columns should be used to store this object. (>=
* 1)
* @param rowspan how many rows should be used to store this object. (>= 1)
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* Once the object is inserted, it will become child of the table. Its
* lifetime will be bound to the layout, and whenever the layout dies the
*
* @ingroup Layout
*/
-EAPI void elm_layout_table_pack(Evas_Object *obj, const char *part, Evas_Object *child_obj, unsigned short col, unsigned short row, unsigned short colspan, unsigned short rowspan);
+EAPI Eina_Bool elm_layout_table_pack(Evas_Object *obj, const char *part, Evas_Object *child_obj, unsigned short col, unsigned short row, unsigned short colspan, unsigned short rowspan);
/**
* Unpack (remove) a child of the given part table.
* @param clear If EINA_TRUE, then all objects will be deleted as
* well, otherwise they will just be removed and will be
* dangling on the canvas.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* The objects will be removed from the table part and their lifetime will
* not be handled by the layout anymore. This is equivalent to
*
* @ingroup Layout
*/
-EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear);
+EAPI Eina_Bool elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear);
/**
* Get the edje layout
* @param obj The layout object.
* @param part_name a part from loaded edje group, that had a cursor set
* with elm_layout_part_cursor_set().
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* @ingroup Layout
*/
-EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name);
+EAPI Eina_Bool elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name);
/**
* Sets a specific cursor style for an edje part.
/**
* @def elm_layout_icon_get
- * Convienience macro to get the icon object from a layout that follows the
+ * Convenience macro to get the icon object from a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout
/**
* @def elm_layout_end_set
- * Convienience macro to set the end object in a layout that follows the
+ * Convenience macro to set the end object in a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout
/**
* @def elm_layout_end_get
- * Convienience macro to get the end object in a layout that follows the
+ * Convenience macro to get the end object in a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout
projects / framework / uifw / elementary.git / blobdiff