1 enum Elm.Ctxpopup.Direction
3 [[Direction in which to show the popup.]]
4 down, [[Ctxpopup show appear below clicked area.]]
5 right, [[Ctxpopup show appear to the right of the clicked area.]]
6 left, [[Ctxpopup show appear to the left of the clicked area.]]
7 up, [[Ctxpopup show appear above the clicked area.]]
8 unknown [[Ctxpopup does not determine it's direction yet.]]
11 class Elm.Ctxpopup (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
13 eo_prefix: elm_obj_ctxpopup;
15 @property horizontal {
17 [[Change the ctxpopup's orientation to horizontal or vertical.
19 \@if MOBILE \@since_tizen 2.3
20 \@elseif WEARABLE \@since_tizen 2.3.1
25 [[Get the value of current ctxpopup object's orientation.
27 See also @.horizontal.set.
29 \@if MOBILE \@since_tizen 2.3
30 \@elseif WEARABLE \@since_tizen 2.3.1
35 horizontal: bool; [[$true for horizontal mode, $false for vertical.]]
38 @property auto_hide_disabled {
40 [[Set ctxpopup auto hide mode triggered by ctxpopup policy.
42 Use this function when user wants ctxpopup not to hide automatically.
43 By default, ctxpopup is dismissed whenever mouse clicked its background area, language is changed,
44 and its parent geometry is updated(changed).
45 Not to hide ctxpopup automatically, disable auto hide function by calling this API,
46 then ctxpopup won't be dismissed in those scenarios.
48 Default value of disabled is $false.
50 See also @.auto_hide_disabled.get.
52 \@if MOBILE \@since_tizen 2.3
53 \@elseif WEARABLE \@since_tizen 2.3.1
60 [[Get ctxpopup auto hide mode triggered by ctxpopup policy.
62 See also @.auto_hide_disabled.set for more information.
68 disabled: bool; [[auto hide enable/disable.]]
71 @property hover_parent {
73 [[Set the Ctxpopup's parent
75 Set the parent object.
77 Note: \@ref elm_ctxpopup_add will automatically call this function
78 with its $parent argument.
80 See also \@ref elm_ctxpopup_add,
81 \@ref elm_hover_parent_set.
83 \@if MOBILE \@since_tizen 2.3
84 \@elseif WEARABLE \@since_tizen 2.3.1
89 [[Get the Ctxpopup's parent
91 See also @.hover_parent.set for more information
93 \@if MOBILE \@since_tizen 2.3
94 \@elseif WEARABLE \@since_tizen 2.3.1
99 parent: Evas.Object *; [[The parent to use.]]
102 @property direction_priority {
104 [[Set the direction priority of a ctxpopup.
106 This functions gives a chance to user to set the priority of ctxpopup
107 showing direction. This doesn't guarantee the ctxpopup will appear in the
110 See also @.Direction.
112 \@if MOBILE \@since_tizen 2.3
113 \@elseif WEARABLE \@since_tizen 2.3.1
118 [[Get the direction priority of a ctxpopup.
120 See also @.direction_priority.set for more information.
122 \@if MOBILE \@since_tizen 2.3
123 \@elseif WEARABLE \@since_tizen 2.3.1
128 first: Elm.Ctxpopup.Direction; [[1st priority of direction]]
129 second: Elm.Ctxpopup.Direction; [[2nd priority of direction]]
130 third: Elm.Ctxpopup.Direction; [[3th priority of direction]]
131 fourth: Elm.Ctxpopup.Direction; [[4th priority of direction]]
134 @property direction {
136 [[Get the current direction of a ctxpopup.
138 Warning: Once the ctxpopup showed up, the direction would be determined
140 \@if MOBILE \@since_tizen 2.3
141 \@elseif WEARABLE \@since_tizen 2.3.1
144 return: Elm.Ctxpopup.Direction(Elm.Ctxpopup.Direction.unknown);
149 [[Get the internal list of items in a given ctxpopup widget.
151 This list is not to be modified in any way and must not be
152 freed. Use the list members with functions like
153 \@ref elm_object_item_text_set,
154 \@ref elm_object_item_text_get,
155 \@ref elm_object_item_del.
157 Warning: This list is only valid until $obj object's internal
158 items list is changed. It should be fetched again with another
159 call to this function when changes happen.
163 return: const(list<Elm.Object.Item*>)*; [[The list of items or
168 @property first_item {
170 [[Get the first item in the given ctxpopup widget's list of
173 See also @.item_append,
178 return: Elm.Widget_Item *; [[The first item or $null, if it has no items (and on
183 @property last_item {
185 [[Get the last item in the given ctxpopup widget's list of
188 See also @.item_prepend,
193 return: Elm.Widget_Item *; [[The last item or $null, if it has no items (and on
199 [[Dismiss a ctxpopup object
201 Use this function to simulate clicking outside of the ctxpopup to dismiss it.
202 In this way, the ctxpopup will be hidden and the "clicked" signal will be
205 \@if MOBILE \@since_tizen 2.3
206 \@elseif WEARABLE \@since_tizen 2.3.1
212 [[Clear all items in the given ctxpopup object.
214 \@if MOBILE \@since_tizen 2.3
215 \@elseif WEARABLE \@since_tizen 2.3.1
220 [[Add a new item to a ctxpopup object.
223 Warning:Ctxpopup can't hold both an item list and a content at the same
224 time. When an item is added, any previous content will be removed.
226 See also \@ref elm_object_content_set.
228 \@if MOBILE \@since_tizen 2.3
229 \@elseif WEARABLE \@since_tizen 2.3.1
232 return: Elm.Widget_Item *; [[A handle to the item added or $null, on errors.]]
235 @in label: const(char)*; [[The Label of the new item]]
236 @in icon: Evas.Object * @optional; [[Icon to be set on new item]]
237 @in func: Evas_Smart_Cb @optional; [[Convenience function called when item selected]]
238 @in data: const(void)* @optional; [[Data passed to $func]]
241 item_prepend @internal {
242 [[Prepend a new item to a ctxpopup object.
244 Warning: Ctxpopup can't hold both an item list and a content at the same
245 time. When an item is added, any previous content will be removed.
247 See also \@ref elm_object_content_set.
251 return: Elm.Widget_Item *; [[A handle to the item added or $null, on errors.]]
254 @in label: const(char)*; [[The Label of the new item]]
255 @in icon: Evas.Object * @optional; [[Icon to be set on new item]]
256 @in func: Evas_Smart_Cb @optional; [[Convenience function called when item selected]]
257 @in data: const(void)* @optional; [[Data passed to $func]]
264 Evas.Object_Smart.del;
265 Evas.Object_Smart.add;
266 Elm.Widget.parent.set;
267 Elm.Widget.focus_direction;
268 Elm.Widget.sub_object_add;
269 Elm.Widget.focus_direction_manager_is;
270 Elm.Widget.focus_next_manager_is;
271 Elm.Widget.focus_next;
273 Elm.Widget.translate;
274 Elm.Widget.theme_apply;
276 Elm.Container.content_get;
277 Elm.Container.content_set;
278 Elm.Container.content_unset;
279 Elm.Layout.sub_object_add_enable;
280 Elm.Layout.sizing_eval;
281 Elm_Interface_Atspi_Widget_Action.elm_actions.get;
282 Elm_Interface_Atspi_Accessible.state_set.get;
283 Elm_Interface_Atspi_Accessible.children.get;
284 //TIZEN ONLY(20160918): name interface added
285 Elm_Interface_Atspi_Accessible.name.get;
287 Elm_Interface_Atspi_Component.extents.get;
288 Elm_Interface_Atspi_Component.highlight_grab;
289 Elm_Interface_Atspi_Component.highlight_clear;