[multibuttenentry] merged with opensource r75453.

[framework/uifw/elementary.git] / src / lib / elm_layout.h

diff --git a/src/lib/elm_layout.h b/src/lib/elm_layout.h
index c69b6fe..84ecbff 100644 (file)
--- a/src/lib/elm_layout.h
+++ b/src/lib/elm_layout.h
@@ -1,5 +1,6 @@
 /**
  * @defgroup Layout Layout
+ * @ingroup Elementary
  *
  * @image html img/widget/layout/preview-00.png
  * @image latex img/widget/layout/preview-00.eps width=\textwidth
@@ -72,11 +73,7 @@
  * 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
-<<<<<<< HEAD
- * just depends on the circunstances and requirements.
-=======
  * just depends on the circumstances and requirements.
->>>>>>> remotes/origin/upstream
  *
  * The Layout Box can be used through the @c elm_layout_box_* set of
  * functions.
@@ -136,14 +133,14 @@
  * 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
  *
@@ -185,11 +182,7 @@ EAPI Eina_Bool                    elm_layout_file_set(Evas_Object *obj, const ch
  * Set the edje group from the elementary theme that will be used as layout
  *
  * @param obj The layout object
-<<<<<<< HEAD
- * @param clas the clas of the group
-=======
  * @param clas the class of the group
->>>>>>> remotes/origin/upstream
  * @param group the group
  * @param style the style to used
  *
@@ -205,10 +198,7 @@ EAPI Eina_Bool                    elm_layout_theme_set(Evas_Object *obj, const c
  * @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.
-<<<<<<< HEAD
-=======
  * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
->>>>>>> remotes/origin/upstream
  *
  * 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
@@ -222,11 +212,7 @@ EAPI Eina_Bool                    elm_layout_theme_set(Evas_Object *obj, const c
  *
  * @ingroup Layout
  */
-<<<<<<< HEAD
-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);
->>>>>>> remotes/origin/upstream
 
 /**
  * Prepend child to layout box part.
@@ -234,10 +220,7 @@ EAPI Eina_Bool                    elm_layout_box_append(Evas_Object *obj, const
  * @param obj the layout object
  * @param part the box part to prepend.
  * @param child the child object to prepend to box.
-<<<<<<< HEAD
-=======
  * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
->>>>>>> remotes/origin/upstream
  *
  * 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
@@ -251,11 +234,7 @@ EAPI Eina_Bool                    elm_layout_box_append(Evas_Object *obj, const
  *
  * @ingroup Layout
  */
-<<<<<<< HEAD
-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);
->>>>>>> remotes/origin/upstream
 
 /**
  * Insert child to layout box part before a reference object.
@@ -264,10 +243,7 @@ EAPI Eina_Bool                    elm_layout_box_prepend(Evas_Object *obj, const
  * @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.
-<<<<<<< HEAD
-=======
  * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
->>>>>>> remotes/origin/upstream
  *
  * 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
@@ -281,11 +257,7 @@ EAPI Eina_Bool                    elm_layout_box_prepend(Evas_Object *obj, const
  *
  * @ingroup Layout
  */
-<<<<<<< HEAD
-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);
->>>>>>> remotes/origin/upstream
 
 /**
  * Insert child to layout box part at a given position.
@@ -294,10 +266,7 @@ EAPI Eina_Bool                    elm_layout_box_insert_before(Evas_Object *obj,
  * @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.
-<<<<<<< HEAD
-=======
  * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
->>>>>>> remotes/origin/upstream
  *
  * 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
@@ -311,11 +280,7 @@ EAPI Eina_Bool                    elm_layout_box_insert_before(Evas_Object *obj,
  *
  * @ingroup Layout
  */
-<<<<<<< HEAD
-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);
->>>>>>> remotes/origin/upstream
 
 /**
  * Remove a child of the given part box.
@@ -344,10 +309,7 @@ EAPI Evas_Object                 *elm_layout_box_remove(Evas_Object *obj, const
  * @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.
-<<<<<<< HEAD
-=======
  * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
->>>>>>> remotes/origin/upstream
  *
  * The objects will be removed from the box part and their lifetime will
  * not be handled by the layout anymore. This is equivalent to
@@ -358,11 +320,7 @@ EAPI Evas_Object                 *elm_layout_box_remove(Evas_Object *obj, const
  *
  * @ingroup Layout
  */
-<<<<<<< HEAD
-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);
->>>>>>> remotes/origin/upstream
 
 /**
  * Insert child to layout table part.
@@ -375,10 +333,7 @@ EAPI Eina_Bool                    elm_layout_box_remove_all(Evas_Object *obj, co
  * @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)
-<<<<<<< HEAD
-=======
  * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
->>>>>>> remotes/origin/upstream
  *
  * 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
@@ -401,11 +356,7 @@ EAPI Eina_Bool                    elm_layout_box_remove_all(Evas_Object *obj, co
  *
  * @ingroup Layout
  */
-<<<<<<< HEAD
-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);
->>>>>>> remotes/origin/upstream
 
 /**
  * Unpack (remove) a child of the given part table.
@@ -434,10 +385,7 @@ EAPI Evas_Object                 *elm_layout_table_unpack(Evas_Object *obj, cons
  * @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.
-<<<<<<< HEAD
-=======
  * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
->>>>>>> remotes/origin/upstream
  *
  * The objects will be removed from the table part and their lifetime will
  * not be handled by the layout anymore. This is equivalent to
@@ -448,11 +396,7 @@ EAPI Evas_Object                 *elm_layout_table_unpack(Evas_Object *obj, cons
  *
  * @ingroup Layout
  */
-<<<<<<< HEAD
-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);
->>>>>>> remotes/origin/upstream
 
 /**
  * Get the edje layout
@@ -568,18 +512,11 @@ EAPI const char                  *elm_layout_part_cursor_get(const Evas_Object *
  * @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().
-<<<<<<< HEAD
- *
- * @ingroup Layout
- */
-EAPI void                         elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name);
-=======
  * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @ingroup Layout
  */
 EAPI Eina_Bool                    elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name);
->>>>>>> remotes/origin/upstream
 
 /**
  * Sets a specific cursor style for an edje part.
@@ -658,11 +595,7 @@ EAPI Eina_Bool                    elm_layout_part_cursor_engine_only_get(const E
 
 /**
  * @def elm_layout_icon_get
-<<<<<<< HEAD
- * 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
->>>>>>> remotes/origin/upstream
  * Elementary naming convention for its parts.
  *
  * @ingroup Layout
@@ -672,11 +605,7 @@ EAPI Eina_Bool                    elm_layout_part_cursor_engine_only_get(const E
 
 /**
  * @def elm_layout_end_set
-<<<<<<< HEAD
- * 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
->>>>>>> remotes/origin/upstream
  * Elementary naming convention for its parts.
  *
  * @ingroup Layout
@@ -692,11 +621,7 @@ EAPI Eina_Bool                    elm_layout_part_cursor_engine_only_get(const E
 
 /**
  * @def elm_layout_end_get
-<<<<<<< HEAD
- * 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
->>>>>>> remotes/origin/upstream
  * Elementary naming convention for its parts.
  *
  * @ingroup Layout