Fix PLM issue P120724-6223, P120726-4241(duplicated)

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

diff --git a/src/lib/elm_box.h b/src/lib/elm_box.h
index bc45693..43011ab 100644 (file)
--- a/src/lib/elm_box.h
+++ b/src/lib/elm_box.h
@@ -1,5 +1,6 @@
 /**
  * @defgroup Box Box
+ * @ingroup Elementary
  *
  * @image html img/widget/box/preview-00.png
  * @image latex img/widget/box/preview-00.eps width=\textwidth
@@ -86,10 +87,10 @@ typedef struct _Elm_Box_Transition Elm_Box_Transition;
  *
  * @param parent The parent object
  * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Box
  */
-EAPI Evas_Object *
-                         elm_box_add(Evas_Object *parent)
-EINA_ARG_NONNULL(1);
+EAPI Evas_Object        *elm_box_add(Evas_Object *parent);
 
 /**
  * Set the horizontal orientation
@@ -104,8 +105,10 @@ EINA_ARG_NONNULL(1);
  * @param obj The box object
  * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
  * EINA_FALSE = vertical)
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
 
 /**
  * Get the horizontal orientation
@@ -113,7 +116,7 @@ EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool hori
  * @param obj The box object
  * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
  */
-EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj);
 
 /**
  * Set the box to arrange its children homogeneously
@@ -125,16 +128,20 @@ EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG
  *
  * @param obj The box object
  * @param homogeneous The homogeneous flag
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous);
 
 /**
  * Get whether the box is using homogeneous mode or not
  *
  * @param obj The box object
  * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
+ *
+ * @ingroup Box
  */
-EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj);
 
 /**
  * Add an object to the beginning of the pack list
@@ -154,8 +161,10 @@ EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_AR
  * @see elm_box_unpack()
  * @see elm_box_unpack_all()
  * @see elm_box_clear()
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj);
 
 /**
  * Add an object at the end of the pack list
@@ -175,8 +184,10 @@ EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subob
  * @see elm_box_unpack()
  * @see elm_box_unpack_all()
  * @see elm_box_clear()
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj);
 
 /**
  * Adds an object to the box before the indicated object
@@ -196,8 +207,10 @@ EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj)
  * @see elm_box_unpack()
  * @see elm_box_unpack_all()
  * @see elm_box_clear()
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before);
 
 /**
  * Adds an object to the box after the indicated object
@@ -217,8 +230,10 @@ EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subo
  * @see elm_box_unpack()
  * @see elm_box_unpack_all()
  * @see elm_box_clear()
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after);
 
 /**
  * Clear the box of all children
@@ -230,8 +245,10 @@ EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subob
  *
  * @see elm_box_unpack()
  * @see elm_box_unpack_all()
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_clear(Evas_Object *obj);
 
 /**
  * Unpack a box item
@@ -244,8 +261,10 @@ EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
  *
  * @see elm_box_unpack_all()
  * @see elm_box_clear()
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj);
 
 /**
  * Remove all items from the box, without deleting them
@@ -260,8 +279,10 @@ EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) E
  *
  * @see elm_box_clear()
  * @see elm_box_unpack()
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_unpack_all(Evas_Object *obj);
 
 /**
  * Retrieve a list of the objects packed into the box
@@ -272,8 +293,10 @@ EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1
  * You must free this list with eina_list_free() once you are done with it.
  *
  * @param obj The box object
+ *
+ * @ingroup Box
  */
-EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_List    *elm_box_children_get(const Evas_Object *obj);
 
 /**
  * Set the space (padding) between the box's elements.
@@ -286,8 +309,10 @@ EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_N
  * @param obj The box object
  * @param horizontal The horizontal space between elements
  * @param vertical The vertical space between elements
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical);
 
 /**
  * Get the space (padding) between the box's elements.
@@ -297,11 +322,13 @@ EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizo
  * @param vertical The vertical space between elements
  *
  * @see elm_box_padding_set()
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical);
 
 /**
- * Set the alignment of the whole bouding box of contents.
+ * 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
@@ -310,19 +337,23 @@ EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord
  * @param obj The box object
  * @param horizontal The horizontal alignment of elements
  * @param vertical The vertical alignment of elements
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical);
 
 /**
- * Get the alignment of the whole bouding box of contents.
+ * Get the alignment of the whole bounding box of contents.
  *
  * @param obj The box object
  * @param horizontal The horizontal alignment of elements
  * @param vertical The vertical alignment of elements
  *
  * @see elm_box_align_set()
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical);
 
 /**
  * Force the box to recalculate its children packing.
@@ -334,6 +365,8 @@ EAPI void                elm_box_align_get(const Evas_Object *obj, double *horiz
  * added item you must force recalculate before doing so.
  *
  * @param obj The box object.
+ *
+ * @ingroup Box
  */
 EAPI void                elm_box_recalculate(Evas_Object *obj);
 
@@ -369,8 +402,10 @@ EAPI void                elm_box_recalculate(Evas_Object *obj);
  * @param free_data Function called to free @p data
  *
  * @see elm_box_layout_transition()
+ *
+ * @ingroup Box
  */
-EAPI void                elm_box_layout_set(Evas_Object *obj, Evas_Object_Box_Layout cb, const void *data, void (*free_data)(void *data)) EINA_ARG_NONNULL(1);
+EAPI void                elm_box_layout_set(Evas_Object *obj, Evas_Object_Box_Layout cb, const void *data, Ecore_Cb free_data);
 
 /**
  * Special layout function that animates the transition from one layout to another
@@ -403,6 +438,8 @@ EAPI void                elm_box_layout_set(Evas_Object *obj, Evas_Object_Box_La
  * @see elm_box_transition_new
  * @see elm_box_transition_free
  * @see elm_box_layout_set
+ *
+ * @ingroup Box
  */
 EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
 
@@ -436,8 +473,10 @@ EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object
  *
  * @see elm_box_transition_new
  * @see elm_box_layout_transition
+ *
+ * @ingroup Box
  */
-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) EINA_ARG_NONNULL(2, 5);
+EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, Ecore_Cb start_layout_free_data, Evas_Object_Box_Layout end_layout, void *end_layout_data, Ecore_Cb end_layout_free_data, Ecore_Cb transition_end_cb, void *transition_end_data);
 
 /**
  * Free a Elm_Box_Transition instance created with elm_box_transition_new().
@@ -449,6 +488,8 @@ EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Obje
  *
  * @see elm_box_transition_new
  * @see elm_box_layout_transition
+ *
+ * @ingroup Box
  */
 EAPI void                elm_box_transition_free(void *data);