2 * @defgroup Ctxpopup Ctxpopup
5 * @image html ctxpopup_inheritance_tree.png
6 * @image latex ctxpopup_inheritance_tree.eps
8 * @image html img/widget/ctxpopup/preview-00.png
9 * @image latex img/widget/ctxpopup/preview-00.eps
11 * @brief Context popup widget.
13 * A ctxpopup is a widget that, when shown, pops up a list of items.
14 * It automatically chooses an area inside its parent object's view
15 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
16 * optimally fit into it. In the default theme, it will also point an
17 * arrow to it's top left position at the time one shows it. Ctxpopup
18 * items have a label and/or an icon. It is intended for a small
19 * number of items (hence the use of list, not genlist).
21 * This widget inherits from the @ref Layout one, so that all the
22 * functions acting on it also work for context popup objects
25 * This widget emits the following signals, besides the ones sent from
27 * - @c "dismissed" - the ctxpopup was dismissed
29 * Default content parts of the ctxpopup widget that you can use for are:
30 * @li "default" - A content of the ctxpopup
32 * Default content parts of the ctxpopup items that you can use for are:
33 * @li "icon" - An icon in the title area
35 * Default text parts of the ctxpopup items that you can use for are:
36 * @li "default" - Title label in the title area
38 * Supported elm_object common APIs.
39 * @li @ref elm_object_disabled_set
40 * @li @ref elm_object_disabled_get
42 * Supported elm_object_item common APIs.
43 * @li @ref elm_object_item_disabled_set
44 * @li @ref elm_object_item_disabled_get
45 * @li @ref elm_object_item_part_text_set
46 * @li @ref elm_object_item_part_text_get
47 * @li @ref elm_object_item_part_content_set
48 * @li @ref elm_object_item_part_content_get
49 * @li @ref elm_object_item_signal_emit
51 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
57 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked area */
58 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of the clicked area */
59 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of the clicked area */
60 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked area */
61 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
62 } Elm_Ctxpopup_Direction; /**< Direction in which to show the popup */
65 * @brief Add a new Ctxpopup object to the parent.
67 * @param parent Parent object
68 * @return New object or @c NULL, if it cannot be created
72 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent);
75 * @brief Set the Ctxpopup's parent
77 * @param obj The ctxpopup object
78 * @param parent The parent to use
80 * Set the parent object.
82 * @note elm_ctxpopup_add() will automatically call this function
83 * with its @c parent argument.
85 * @see elm_ctxpopup_add()
86 * @see elm_hover_parent_set()
90 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent);
93 * @brief Get the Ctxpopup's parent
95 * @param obj The ctxpopup object
97 * @see elm_ctxpopup_hover_parent_set() for more information
101 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj);
104 * @brief Clear all items in the given ctxpopup object.
106 * @param obj Ctxpopup object
110 EAPI void elm_ctxpopup_clear(Evas_Object *obj);
113 * @brief Change the ctxpopup's orientation to horizontal or vertical.
115 * @param obj Ctxpopup object
116 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
120 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
123 * @brief Get the value of current ctxpopup object's orientation.
125 * @param obj Ctxpopup object
126 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
128 * @see elm_ctxpopup_horizontal_set()
132 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj);
135 * @brief Add a new item to a ctxpopup object.
137 * @param obj Ctxpopup object
138 * @param icon Icon to be set on new item
139 * @param label The Label of the new item
140 * @param func Convenience function called when item selected
141 * @param data Data passed to @p func
142 * @return A handle to the item added or @c NULL, on errors
144 * @warning Ctxpopup can't hold both an item list and a content at the same
145 * time. When an item is added, any previous content will be removed.
147 * @see elm_object_content_set()
151 EAPI Elm_Object_Item *elm_ctxpopup_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data);
154 * @brief Set the direction priority of a ctxpopup.
156 * @param obj Ctxpopup object
157 * @param first 1st priority of direction
158 * @param second 2nd priority of direction
159 * @param third 3th priority of direction
160 * @param fourth 4th priority of direction
162 * This functions gives a chance to user to set the priority of ctxpopup
163 * showing direction. This doesn't guarantee the ctxpopup will appear in the
164 * requested direction.
166 * @see Elm_Ctxpopup_Direction
170 EAPI void elm_ctxpopup_direction_priority_set(Evas_Object *obj, Elm_Ctxpopup_Direction first, Elm_Ctxpopup_Direction second, Elm_Ctxpopup_Direction third, Elm_Ctxpopup_Direction fourth);
173 * @brief Get the direction priority of a ctxpopup.
175 * @param obj Ctxpopup object
176 * @param first 1st priority of direction to be returned
177 * @param second 2nd priority of direction to be returned
178 * @param third 3th priority of direction to be returned
179 * @param fourth 4th priority of direction to be returned
181 * @see elm_ctxpopup_direction_priority_set() for more information.
185 EAPI void elm_ctxpopup_direction_priority_get(Evas_Object *obj, Elm_Ctxpopup_Direction *first, Elm_Ctxpopup_Direction *second, Elm_Ctxpopup_Direction *third, Elm_Ctxpopup_Direction *fourth);
188 * @brief Get the current direction of a ctxpopup.
190 * @param obj Ctxpopup object
191 * @return current direction of a ctxpopup
193 * @warning Once the ctxpopup showed up, the direction would be determined
197 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj);
200 * @brief Dismiss a ctxpopup object
202 * @param obj The ctxpopup object
203 * Use this function to simulate clicking outside the ctxpopup to dismiss it.
204 * In this way, the ctxpopup will be hidden and the "clicked" signal will be
207 EAPI void elm_ctxpopup_dismiss(Evas_Object *obj);