elm genlist: Fixed a bug with decorate all mode + tree effect. Delete tree effect...

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

diff --git a/src/lib/elc_ctxpopup.h b/src/lib/elc_ctxpopup.h
index fef41e4..67a7b9f 100644 (file)
--- a/src/lib/elc_ctxpopup.h
+++ b/src/lib/elc_ctxpopup.h
@@ -1,10 +1,11 @@
 /**
  * @defgroup Ctxpopup Ctxpopup
+ * @ingroup Elementary
  *
  * @image html img/widget/ctxpopup/preview-00.png
  * @image latex img/widget/ctxpopup/preview-00.eps
  *
- * @brief Context popup widet.
+ * @brief Context popup widget.
  *
  * A ctxpopup is a widget that, when shown, pops up a list of items.
  * It automatically chooses an area inside its parent object's view
@@ -14,33 +15,38 @@
  * items have a label and/or an icon. It is intended for a small
  * number of items (hence the use of list, not genlist).
  *
- * @note Ctxpopup is a especialization of @ref Hover.
+ * @note Ctxpopup is a specialization of @ref Hover.
  *
  * Signals that you can add callbacks for are:
  * "dismissed" - the ctxpopup was dismissed
  *
- * Default contents parts of the ctxpopup widget that you can use for are:
+ * Default content parts of the ctxpopup widget that you can use for are:
  * @li "default" - A content of the ctxpopup
  *
- * Default contents parts of the ctxpopup items that you can use for are:
+ * Default content parts of the ctxpopup items that you can use for are:
  * @li "icon" - An icon in the title area
  *
  * Default text parts of the ctxpopup items that you can use for are:
  * @li "default" - Title label in the title area
  *
  * Supported elm_object common APIs.
- * @li elm_object_part_content_set
- * @li elm_object_part_content_get
- * @li elm_object_part_content_unset
+ * @li @ref elm_object_disabled_set
+ * @li @ref elm_object_disabled_get
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref 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
  *
  * Supported elm_object_item common APIs.
- * @li elm_object_item_disabled_set
- * @li elm_object_item_disabled_get
- * @li elm_object_item_part_text_set
- * @li elm_object_item_part_text_get
- * @li elm_object_item_part_content_set
- * @li elm_object_item_part_content_get
- * @li elm_object_item_signal_emit
+ * @li @ref elm_object_item_disabled_set
+ * @li @ref elm_object_item_disabled_get
+ * @li @ref elm_object_item_part_text_set
+ * @li @ref elm_object_item_part_text_get
+ * @li @ref elm_object_item_part_content_set
+ * @li @ref elm_object_item_part_content_get
+ * @li @ref elm_object_item_signal_emit
  *
  * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
  * @{
@@ -138,7 +144,7 @@ EAPI Eina_Bool                    elm_ctxpopup_horizontal_get(const Evas_Object
  * @warning Ctxpopup can't hold both an item list and a content at the same
  * time. When an item is added, any previous content will be removed.
  *
- * @see elm_ctxpopup_content_set()
+ * @see elm_object_content_set()
  *
  * @ingroup Ctxpopup
  */
@@ -191,5 +197,15 @@ EAPI void                         elm_ctxpopup_direction_priority_get(Evas_Objec
 EAPI Elm_Ctxpopup_Direction       elm_ctxpopup_direction_get(const Evas_Object *obj);
 
 /**
+ * @brief Dismiss a ctxpopup object
+ *
+ * @param obj The ctxpopup object
+ * Use this function to simulate clicking outside the ctxpopup to dismiss it.
+ * In this way, the ctxpopup will be hidden and the "clicked" signal will be
+ * emitted.
+ */
+EAPI void                         elm_ctxpopup_dismiss(Evas_Object *obj);
+
+/**
  * @}
  */