elementary/win - fixed invalid sd memory access when delete window inlined image

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

diff --git a/src/lib/elm_hover.h b/src/lib/elm_hover.h
index 81b5a11..1413098 100644 (file)
--- a/src/lib/elm_hover.h
+++ b/src/lib/elm_hover.h
@@ -1,5 +1,6 @@
 /**
  * @defgroup Hover Hover
+ * @ingroup Elementary
  *
  * @image html img/widget/hover/preview-00.png
  * @image latex img/widget/hover/preview-00.eps
@@ -40,7 +41,7 @@
  * @li "smart,changed" - a content object placed under the "smart"
  *                   policy was replaced to a new slot direction.
  *
- * Default contents parts of the hover widget that you can use for are:
+ * Default content parts of the hover widget that you can use for are:
  * @li "left"
  * @li "top-left"
  * @li "top"
@@ -52,12 +53,12 @@
  * @li "middle"
  * @li "smart"
  *
- * @note These contents parts indicates the direction that the content will be
+ * @note These content parts indicates the direction that the content will be
  * displayed
  *
  * All directions may have contents at the same time, except for
  * "smart". This is a special placement hint and its use case
- * independs of the calculations coming from
+ * depends of the calculations coming from
  * elm_hover_best_content_location_get(). Its use is for cases when
  * one desires only one hover content, but with a dynamic special
  * placement within the hover area. The content's geometry, whenever
@@ -69,20 +70,26 @@
  * using it will be deleted, and vice-versa.
  *
  * 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_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_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
  *
  * See @ref tutorial_hover for more information.
  *
  * @{
  */
+
+/**
+ * @typedef Elm_Hover_Axis
+ *
+ * The orientation axis for the hover object
+ */
 typedef enum
 {
-   ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
+   ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no preferred orientation */
    ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
    ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
    ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
@@ -93,6 +100,8 @@ typedef enum
  *
  * @param parent The parent object
  * @return The hover object or NULL if one could not be created
+ *
+ * @ingroup Hover
  */
 EAPI Evas_Object *elm_hover_add(Evas_Object *parent);
 
@@ -103,6 +112,8 @@ EAPI Evas_Object *elm_hover_add(Evas_Object *parent);
  * @param target The object to center the hover onto.
  *
  * This function will cause the hover to be centered on the target object.
+ *
+ * @ingroup Hover
  */
 EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target);
 
@@ -113,6 +124,8 @@ EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target);
  * @return The target object for the hover.
  *
  * @see elm_hover_target_set()
+ *
+ * @ingroup Hover
  */
 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj);
 
@@ -124,6 +137,8 @@ EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj);
  *
  * This function will cause the hover to take up the entire space that the
  * parent object fills.
+ *
+ * @ingroup Hover
  */
 EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent);
 
@@ -134,6 +149,8 @@ EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent);
  * @return The parent object to locate the hover over.
  *
  * @see elm_hover_parent_set()
+ *
+ * @ingroup Hover
  */
 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj);
 
@@ -149,19 +166,21 @@ EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj);
  * space.
  *
  * @p pref_axis may be one of
- * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
+ * - @c ELM_HOVER_AXIS_NONE -- no preferred orientation
  * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
  * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
  * - @c ELM_HOVER_AXIS_BOTH -- both
  *
- * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
- * nescessarily be along the horizontal axis("left" or "right"). If
- * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
- * be along the vertical axis("top" or "bottom"). Chossing
+ * If ELM_HOVER_AXIS_HORIZONTAL is chosen the returned position will
+ * necessarily be along the horizontal axis("left" or "right"). If
+ * ELM_HOVER_AXIS_VERTICAL is chosen the returned position will necessarily
+ * be along the vertical axis("top" or "bottom"). Choosing
  * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
  * returned position may be in either axis.
  *
  * @see elm_object_part_content_set()
+ *
+ * @ingroup Hover
  */
 EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis);
 
@@ -171,6 +190,8 @@ EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, El
  * @param obj The hover object
  * Use this function to simulate clicking outside the hover to dismiss it.
  * In this way, the hover will be hidden and the "clicked" signal will be emitted.
+ *
+ * @ingroup Hover
  */
 EAPI void elm_hover_dismiss(Evas_Object *obj);
 /**