summaryrefslogtreecommitdiff
path: root/src/lib/elc_ctxpopup.h
diff options
context:
space:
mode:
authorCarsten Haitzler <raster@rasterman.com>2011-12-30 07:20:48 +0000
committerCarsten Haitzler <raster@rasterman.com>2011-12-30 07:20:48 +0000
commit18db69ac3ae219a6975d092e6449afa27287c818 (patch)
treeabd01e5dd85282dd4513826029eef90f0dfa1570 /src/lib/elc_ctxpopup.h
parent829f2773f155983501adeabaf66a4b5fad69280d (diff)
fomatting of headers -> fixup. and documentation fixing.
SVN revision: 66667
Diffstat (limited to '')
-rw-r--r--src/lib/elc_ctxpopup.h608
1 files changed, 302 insertions, 306 deletions
diff --git a/src/lib/elc_ctxpopup.h b/src/lib/elc_ctxpopup.h
index ba6cc82f2..1235a4e41 100644
--- a/src/lib/elc_ctxpopup.h
+++ b/src/lib/elc_ctxpopup.h
@@ -1,327 +1,323 @@
1 /** 1/**
2 * @defgroup Ctxpopup Ctxpopup 2 * @defgroup Ctxpopup Ctxpopup
3 * 3 *
4 * @image html img/widget/ctxpopup/preview-00.png 4 * @image html img/widget/ctxpopup/preview-00.png
5 * @image latex img/widget/ctxpopup/preview-00.eps 5 * @image latex img/widget/ctxpopup/preview-00.eps
6 * 6 *
7 * @brief Context popup widet. 7 * @brief Context popup widet.
8 * 8 *
9 * A ctxpopup is a widget that, when shown, pops up a list of items. 9 * A ctxpopup is a widget that, when shown, pops up a list of items.
10 * It automatically chooses an area inside its parent object's view 10 * It automatically chooses an area inside its parent object's view
11 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to 11 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
12 * optimally fit into it. In the default theme, it will also point an 12 * optimally fit into it. In the default theme, it will also point an
13 * arrow to it's top left position at the time one shows it. Ctxpopup 13 * arrow to it's top left position at the time one shows it. Ctxpopup
14 * items have a label and/or an icon. It is intended for a small 14 * items have a label and/or an icon. It is intended for a small
15 * number of items (hence the use of list, not genlist). 15 * number of items (hence the use of list, not genlist).
16 * 16 *
17 * @note Ctxpopup is a especialization of @ref Hover. 17 * @note Ctxpopup is a especialization of @ref Hover.
18 * 18 *
19 * Signals that you can add callbacks for are: 19 * Signals that you can add callbacks for are:
20 * "dismissed" - the ctxpopup was dismissed 20 * "dismissed" - the ctxpopup was dismissed
21 * 21 *
22 * Default contents parts of the ctxpopup widget that you can use for are: 22 * Default contents parts of the ctxpopup widget that you can use for are:
23 * @li "default" - A content of the ctxpopup 23 * @li "default" - A content of the ctxpopup
24 * 24 *
25 * Default contents parts of the ctxpopup items that you can use for are: 25 * Default contents parts of the ctxpopup items that you can use for are:
26 * @li "icon" - An icon in the title area 26 * @li "icon" - An icon in the title area
27 * 27 *
28 * Default text parts of the ctxpopup items that you can use for are: 28 * Default text parts of the ctxpopup items that you can use for are:
29 * @li "default" - Title label in the title area 29 * @li "default" - Title label in the title area
30 * 30 *
31 * @ref tutorial_ctxpopup shows the usage of a good deal of the API. 31 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
32 * @{ 32 * @{
33 */ 33 */
34 34
35 /** 35typedef enum _Elm_Ctxpopup_Direction
36 * @addtogroup Ctxpopup 36{
37 * @{ 37 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
38 */ 38 area */
39 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
40 the clicked area */
41 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
42 the clicked area */
43 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
44 area */
45 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
46} Elm_Ctxpopup_Direction; /**< Direction in which to show the popup */
39 47
40 typedef enum _Elm_Ctxpopup_Direction 48/**
41 { 49 * @brief Add a new Ctxpopup object to the parent.
42 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked 50 *
43 area */ 51 * @param parent Parent object
44 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of 52 * @return New object or @c NULL, if it cannot be created
45 the clicked area */ 53 *
46 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of 54 * @ingroup Ctxpopup
47 the clicked area */ 55 */
48 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked 56EAPI Evas_Object *
49 area */ 57 elm_ctxpopup_add(Evas_Object *parent)
50 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/ 58EINA_ARG_NONNULL(1);
51 } Elm_Ctxpopup_Direction;
52 59
53 /** 60/**
54 * @brief Add a new Ctxpopup object to the parent. 61 * @brief Set the Ctxpopup's parent
55 * 62 *
56 * @param parent Parent object 63 * @param obj The ctxpopup object
57 * @return New object or @c NULL, if it cannot be created 64 * @param area The parent to use
58 * 65 *
59 * @ingroup Ctxpopup 66 * Set the parent object.
60 */ 67 *
61 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1); 68 * @note elm_ctxpopup_add() will automatically call this function
69 * with its @c parent argument.
70 *
71 * @see elm_ctxpopup_add()
72 * @see elm_hover_parent_set()
73 *
74 * @ingroup Ctxpopup
75 */
76EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
62 77
63 /** 78/**
64 * @brief Set the Ctxpopup's parent 79 * @brief Get the Ctxpopup's parent
65 * 80 *
66 * @param obj The ctxpopup object 81 * @param obj The ctxpopup object
67 * @param area The parent to use 82 *
68 * 83 * @see elm_ctxpopup_hover_parent_set() for more information
69 * Set the parent object. 84 *
70 * 85 * @ingroup Ctxpopup
71 * @note elm_ctxpopup_add() will automatically call this function 86 */
72 * with its @c parent argument. 87EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
73 *
74 * @see elm_ctxpopup_add()
75 * @see elm_hover_parent_set()
76 *
77 * @ingroup Ctxpopup
78 */
79 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
80 88
81 /** 89/**
82 * @brief Get the Ctxpopup's parent 90 * @brief Clear all items in the given ctxpopup object.
83 * 91 *
84 * @param obj The ctxpopup object 92 * @param obj Ctxpopup object
85 * 93 *
86 * @see elm_ctxpopup_hover_parent_set() for more information 94 * @ingroup Ctxpopup
87 * 95 */
88 * @ingroup Ctxpopup 96EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
89 */
90 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
91 97
92 /** 98/**
93 * @brief Clear all items in the given ctxpopup object. 99 * @brief Change the ctxpopup's orientation to horizontal or vertical.
94 * 100 *
95 * @param obj Ctxpopup object 101 * @param obj Ctxpopup object
96 * 102 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
97 * @ingroup Ctxpopup 103 *
98 */ 104 * @ingroup Ctxpopup
99 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1); 105 */
106EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
100 107
101 /** 108/**
102 * @brief Change the ctxpopup's orientation to horizontal or vertical. 109 * @brief Get the value of current ctxpopup object's orientation.
103 * 110 *
104 * @param obj Ctxpopup object 111 * @param obj Ctxpopup object
105 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical 112 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
106 * 113 *
107 * @ingroup Ctxpopup 114 * @see elm_ctxpopup_horizontal_set()
108 */ 115 *
109 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1); 116 * @ingroup Ctxpopup
117 */
118EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
110 119
111 /** 120/**
112 * @brief Get the value of current ctxpopup object's orientation. 121 * @brief Add a new item to a ctxpopup object.
113 * 122 *
114 * @param obj Ctxpopup object 123 * @param obj Ctxpopup object
115 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors) 124 * @param icon Icon to be set on new item
116 * 125 * @param label The Label of the new item
117 * @see elm_ctxpopup_horizontal_set() 126 * @param func Convenience function called when item selected
118 * 127 * @param data Data passed to @p func
119 * @ingroup Ctxpopup 128 * @return A handle to the item added or @c NULL, on errors
120 */ 129 *
121 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); 130 * @warning Ctxpopup can't hold both an item list and a content at the same
131 * time. When an item is added, any previous content will be removed.
132 *
133 * @see elm_ctxpopup_content_set()
134 *
135 * @ingroup Ctxpopup
136 */
137Elm_Object_Item *elm_ctxpopup_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
122 138
123 /** 139/**
124 * @brief Add a new item to a ctxpopup object. 140 * @brief Delete the given item in a ctxpopup object.
125 * 141 *
126 * @param obj Ctxpopup object 142 * @param it Ctxpopup item to be deleted
127 * @param icon Icon to be set on new item 143 *
128 * @param label The Label of the new item 144 * @see elm_ctxpopup_item_append()
129 * @param func Convenience function called when item selected 145 *
130 * @param data Data passed to @p func 146 * @ingroup Ctxpopup
131 * @return A handle to the item added or @c NULL, on errors 147 */
132 * 148EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
133 * @warning Ctxpopup can't hold both an item list and a content at the same
134 * time. When an item is added, any previous content will be removed.
135 *
136 * @see elm_ctxpopup_content_set()
137 *
138 * @ingroup Ctxpopup
139 */
140 Elm_Object_Item *elm_ctxpopup_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
141 149
142 /** 150/**
143 * @brief Delete the given item in a ctxpopup object. 151 * @brief Set the ctxpopup item's state as disabled or enabled.
144 * 152 *
145 * @param it Ctxpopup item to be deleted 153 * @param it Ctxpopup item to be enabled/disabled
146 * 154 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
147 * @see elm_ctxpopup_item_append() 155 *
148 * 156 * When disabled the item is greyed out to indicate it's state.
149 * @ingroup Ctxpopup 157 * @deprecated use elm_object_item_disabled_set() instead
150 */ 158 *
151 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1); 159 * @ingroup Ctxpopup
160 */
161EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
152 162
153 /** 163/**
154 * @brief Set the ctxpopup item's state as disabled or enabled. 164 * @brief Get the ctxpopup item's disabled/enabled state.
155 * 165 *
156 * @param it Ctxpopup item to be enabled/disabled 166 * @param it Ctxpopup item to be enabled/disabled
157 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it 167 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
158 * 168 *
159 * When disabled the item is greyed out to indicate it's state. 169 * @see elm_ctxpopup_item_disabled_set()
160 * @deprecated use elm_object_item_disabled_set() instead 170 * @deprecated use elm_object_item_disabled_get() instead
161 * 171 *
162 * @ingroup Ctxpopup 172 * @ingroup Ctxpopup
163 */ 173 */
164 EINA_DEPRECATED EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1); 174EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
165 175
166 /** 176/**
167 * @brief Get the ctxpopup item's disabled/enabled state. 177 * @brief Get the icon object for the given ctxpopup item.
168 * 178 *
169 * @param it Ctxpopup item to be enabled/disabled 179 * @param it Ctxpopup item
170 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise 180 * @return icon object or @c NULL, if the item does not have icon or an error
171 * 181 * occurred
172 * @see elm_ctxpopup_item_disabled_set() 182 *
173 * @deprecated use elm_object_item_disabled_get() instead 183 * @see elm_ctxpopup_item_append()
174 * 184 * @see elm_ctxpopup_item_icon_set()
175 * @ingroup Ctxpopup 185 *
176 */ 186 * @deprecated use elm_object_item_part_content_get() instead
177 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1); 187 *
188 * @ingroup Ctxpopup
189 */
190EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
178 191
179 /** 192/**
180 * @brief Get the icon object for the given ctxpopup item. 193 * @brief Sets the side icon associated with the ctxpopup item
181 * 194 *
182 * @param it Ctxpopup item 195 * @param it Ctxpopup item
183 * @return icon object or @c NULL, if the item does not have icon or an error 196 * @param icon Icon object to be set
184 * occurred 197 *
185 * 198 * Once the icon object is set, a previously set one will be deleted.
186 * @see elm_ctxpopup_item_append() 199 * @warning Setting the same icon for two items will cause the icon to
187 * @see elm_ctxpopup_item_icon_set() 200 * dissapear from the first item.
188 * 201 *
189 * @deprecated use elm_object_item_part_content_get() instead 202 * @see elm_ctxpopup_item_append()
190 * 203 *
191 * @ingroup Ctxpopup 204 * @deprecated use elm_object_item_part_content_set() instead
192 */ 205 *
193 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1); 206 * @ingroup Ctxpopup
207 */
208EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
194 209
195 /** 210/**
196 * @brief Sets the side icon associated with the ctxpopup item 211 * @brief Get the label for the given ctxpopup item.
197 * 212 *
198 * @param it Ctxpopup item 213 * @param it Ctxpopup item
199 * @param icon Icon object to be set 214 * @return label string or @c NULL, if the item does not have label or an
200 * 215 * error occured
201 * Once the icon object is set, a previously set one will be deleted. 216 *
202 * @warning Setting the same icon for two items will cause the icon to 217 * @see elm_ctxpopup_item_append()
203 * dissapear from the first item. 218 * @see elm_ctxpopup_item_label_set()
204 * 219 *
205 * @see elm_ctxpopup_item_append() 220 * @deprecated use elm_object_item_text_get() instead
206 * 221 *
207 * @deprecated use elm_object_item_part_content_set() instead 222 * @ingroup Ctxpopup
208 * 223 */
209 * @ingroup Ctxpopup 224EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
210 */
211 EINA_DEPRECATED EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
212 225
213 /** 226/**
214 * @brief Get the label for the given ctxpopup item. 227 * @brief (Re)set the label on the given ctxpopup item.
215 * 228 *
216 * @param it Ctxpopup item 229 * @param it Ctxpopup item
217 * @return label string or @c NULL, if the item does not have label or an 230 * @param label String to set as label
218 * error occured 231 *
219 * 232 * @deprecated use elm_object_item_text_set() instead
220 * @see elm_ctxpopup_item_append() 233 *
221 * @see elm_ctxpopup_item_label_set() 234 * @ingroup Ctxpopup
222 * 235 */
223 * @deprecated use elm_object_item_text_get() instead 236EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
224 *
225 * @ingroup Ctxpopup
226 */
227 EINA_DEPRECATED EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
228 237
229 /** 238/**
230 * @brief (Re)set the label on the given ctxpopup item. 239 * @brief Set an elm widget as the content of the ctxpopup.
231 * 240 *
232 * @param it Ctxpopup item 241 * @param obj Ctxpopup object
233 * @param label String to set as label 242 * @param content Content to be swallowed
234 * 243 *
235 * @deprecated use elm_object_item_text_set() instead 244 * If the content object is already set, a previous one will bedeleted. If
236 * 245 * you want to keep that old content object, use the
237 * @ingroup Ctxpopup 246 * elm_ctxpopup_content_unset() function.
238 */ 247 *
239 EINA_DEPRECATED EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1); 248 * @warning Ctxpopup can't hold both a item list and a content at the same
249 * time. When a content is set, any previous items will be removed.
250 *
251 * @deprecated use elm_object_content_set() instead
252 *
253 * @ingroup Ctxpopup
254 */
255EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
240 256
241 /** 257/**
242 * @brief Set an elm widget as the content of the ctxpopup. 258 * @brief Unset the ctxpopup content
243 * 259 *
244 * @param obj Ctxpopup object 260 * @param obj Ctxpopup object
245 * @param content Content to be swallowed 261 * @return The content that was being used
246 * 262 *
247 * If the content object is already set, a previous one will bedeleted. If 263 * Unparent and return the content object which was set for this widget.
248 * you want to keep that old content object, use the 264 *
249 * elm_ctxpopup_content_unset() function. 265 * @deprecated use elm_object_content_unset()
250 * 266 *
251 * @warning Ctxpopup can't hold both a item list and a content at the same 267 * @see elm_ctxpopup_content_set()
252 * time. When a content is set, any previous items will be removed. 268 *
253 * 269 * @deprecated use elm_object_content_unset() instead
254 * @deprecated use elm_object_content_set() instead 270 *
255 * 271 * @ingroup Ctxpopup
256 * @ingroup Ctxpopup 272 */
257 */ 273EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
258 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
259 274
260 /** 275/**
261 * @brief Unset the ctxpopup content 276 * @brief Set the direction priority of a ctxpopup.
262 * 277 *
263 * @param obj Ctxpopup object 278 * @param obj Ctxpopup object
264 * @return The content that was being used 279 * @param first 1st priority of direction
265 * 280 * @param second 2nd priority of direction
266 * Unparent and return the content object which was set for this widget. 281 * @param third 3th priority of direction
267 * 282 * @param fourth 4th priority of direction
268 * @deprecated use elm_object_content_unset() 283 *
269 * 284 * This functions gives a chance to user to set the priority of ctxpopup
270 * @see elm_ctxpopup_content_set() 285 * showing direction. This doesn't guarantee the ctxpopup will appear in the
271 * 286 * requested direction.
272 * @deprecated use elm_object_content_unset() instead 287 *
273 * 288 * @see Elm_Ctxpopup_Direction
274 * @ingroup Ctxpopup 289 *
275 */ 290 * @ingroup Ctxpopup
276 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1); 291 */
292EAPI 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) EINA_ARG_NONNULL(1);
277 293
278 /** 294/**
279 * @brief Set the direction priority of a ctxpopup. 295 * @brief Get the direction priority of a ctxpopup.
280 * 296 *
281 * @param obj Ctxpopup object 297 * @param obj Ctxpopup object
282 * @param first 1st priority of direction 298 * @param first 1st priority of direction to be returned
283 * @param second 2nd priority of direction 299 * @param second 2nd priority of direction to be returned
284 * @param third 3th priority of direction 300 * @param third 3th priority of direction to be returned
285 * @param fourth 4th priority of direction 301 * @param fourth 4th priority of direction to be returned
286 * 302 *
287 * This functions gives a chance to user to set the priority of ctxpopup 303 * @see elm_ctxpopup_direction_priority_set() for more information.
288 * showing direction. This doesn't guarantee the ctxpopup will appear in the 304 *
289 * requested direction. 305 * @ingroup Ctxpopup
290 * 306 */
291 * @see Elm_Ctxpopup_Direction 307EAPI 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) EINA_ARG_NONNULL(1);
292 *
293 * @ingroup Ctxpopup
294 */
295 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) EINA_ARG_NONNULL(1);
296 308
297 /** 309/**
298 * @brief Get the direction priority of a ctxpopup. 310 * @brief Get the current direction of a ctxpopup.
299 * 311 *
300 * @param obj Ctxpopup object 312 * @param obj Ctxpopup object
301 * @param first 1st priority of direction to be returned 313 * @return current direction of a ctxpopup
302 * @param second 2nd priority of direction to be returned 314 *
303 * @param third 3th priority of direction to be returned 315 * @warning Once the ctxpopup showed up, the direction would be determined
304 * @param fourth 4th priority of direction to be returned 316 *
305 * 317 * @ingroup Ctxpopup
306 * @see elm_ctxpopup_direction_priority_set() for more information. 318 */
307 * 319EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
308 * @ingroup Ctxpopup
309 */
310 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) EINA_ARG_NONNULL(1);
311
312 /**
313 * @brief Get the current direction of a ctxpopup.
314 *
315 * @param obj Ctxpopup object
316 * @return current direction of a ctxpopup
317 *
318 * @warning Once the ctxpopup showed up, the direction would be determined
319 *
320 * @ingroup Ctxpopup
321 */
322 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
323
324 /**
325 * @}
326 */
327 320
321/**
322 * @}
323 */