revers logic in elm_web for inwin mode. fix!

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

diff --git a/src/lib/elm_bubble.h b/src/lib/elm_bubble.h
index 533a521..9f97ec1 100644 (file)
--- a/src/lib/elm_bubble.h
+++ b/src/lib/elm_bubble.h
@@ -1,5 +1,6 @@
 /**
  * @defgroup Bubble Bubble
+ * @ingroup Elementary
  *
  * @image html img/widget/bubble/preview-00.png
  * @image latex img/widget/bubble/preview-00.eps
@@ -18,7 +19,7 @@
  * corner is "top_left" or "bottom_left" and is right aligned to the frame
  * otherwise.
  * @li The @p info is a text which appears to the right of the label. Info's
- * font is of a ligther color than label.
+ * font is of a lighter color than label.
  * @li The @p content is an evas object that is shown inside the frame.
  *
  * The position of the arrow, icon, label and info depends on which corner is
@@ -31,7 +32,7 @@
  * Signals that you can add callbacks for are:
  * @li "clicked" - This is called when a user has clicked the bubble.
  *
- * Default contents parts of the bubble that you can use for are:
+ * Default content parts of the bubble that you can use for are:
  * @li "default" - A content of the bubble
  * @li "icon" - An icon of the bubble
  *
@@ -40,24 +41,41 @@
  * @li "info" - info of the bubble
  *
  * Supported elm_object common APIs.
- * @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_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
  *
- * For an example of using a buble see @ref bubble_01_example_page "this".
+ * For an example of using a bubble see @ref bubble_01_example_page "this".
  *
  * @{
  */
 
 /**
+ * Defines the corner values for a bubble.
+ *
+ * The corner will be used to determine where the arrow of the
+ * bubble points to.
+ */
+typedef enum
+{
+  ELM_BUBBLE_POS_INVALID = -1,
+  ELM_BUBBLE_POS_TOP_LEFT,
+  ELM_BUBBLE_POS_TOP_RIGHT,
+  ELM_BUBBLE_POS_BOTTOM_LEFT,
+  ELM_BUBBLE_POS_BOTTOM_RIGHT,
+} Elm_Bubble_Pos;
+
+/**
  * Add a new bubble to the parent
  *
  * @param parent The parent object
  * @return The new object or NULL if it cannot be created
  *
  * This function adds a text bubble to the given parent evas object.
+ *
+ * @ingroup Bubble
  */
 EAPI Evas_Object                 *elm_bubble_add(Evas_Object *parent);
 
@@ -65,19 +83,16 @@ EAPI Evas_Object                 *elm_bubble_add(Evas_Object *parent);
  * Set the corner of the bubble
  *
  * @param obj The bubble object.
- * @param corner The given corner for the bubble.
+ * @param pos The given corner for the bubble.
  *
  * This function sets the corner of the bubble. The corner will be used to
  * determine where the arrow in the frame points to and where label, icon and
  * info are shown.
  *
- * Possible values for corner are:
- * @li "top_left" - Default
- * @li "top_right"
- * @li "bottom_left"
- * @li "bottom_right"
+ *
+ * @ingroup Bubble
  */
-EAPI void                         elm_bubble_corner_set(Evas_Object *obj, const char *corner);
+EAPI void  elm_bubble_pos_set(Evas_Object *obj, Elm_Bubble_Pos pos);
 
 /**
  * Get the corner of the bubble
@@ -86,8 +101,10 @@ EAPI void                         elm_bubble_corner_set(Evas_Object *obj, const
  * @return The given corner for the bubble.
  *
  * This function gets the selected corner of the bubble.
+ *
+ * @ingroup Bubble
  */
-EAPI const char                  *elm_bubble_corner_get(const Evas_Object *obj);
+EAPI Elm_Bubble_Pos elm_bubble_pos_get(const Evas_Object *obj);
 
 /**
  * @}