summaryrefslogtreecommitdiff
path: root/legacy/elementary/src/lib/elm_ctxpopup.eo
blob: 8986f62c0c87472c3a8fc43d68614b6227448c71 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
class Elm.Ctxpopup (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
{
   eo_prefix: elm_obj_ctxpopup;
   methods {
      @property horizontal {
         set {
            /*@
            @brief Change the ctxpopup's orientation to horizontal or vertical.

            @ingroup Ctxpopup */
         }
         get {
            /*@
            @brief Get the value of current ctxpopup object's orientation.

            @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)

            @see elm_ctxpopup_horizontal_set()

            @ingroup Ctxpopup */
         }
         values {
            horizontal: bool; /*@ @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical */
         }
      }
      @property auto_hide_disabled {
         set {
            /*@
            @brief Set ctxpopup auto hide mode triggered by ctxpopup policy.
            @since 1.9

            Use this function when user wants ctxpopup not to hide automatically.
            By default, ctxpopup is dismissed whenever mouse clicked its background area, language is changed,
            and its parent geometry is updated(changed).
            Not to hide ctxpopup automatically, disable auto hide function by calling this API,
            then ctxpopup won't be dismissed in those scenarios.

            Default value of disabled is @c EINA_FALSE.

            @see elm_ctxpopup_auto_hide_disabled_get()

            @ingroup Ctxpopup */
         }
         get {
            /*@
            @brief Get ctxpopup auto hide mode triggered by ctxpopup policy.
            @since 1.9

            @return auto hide mode's state of a ctxpopup

            @see elm_ctxpopup_auto_hide_disabled_set() for more information.

            @ingroup Ctxpopup */
         }
         values {
            disabled: bool; /*@ auto hide enable/disable. */
         }
      }
      @property hover_parent {
         set {
            /*@
            @brief Set the Ctxpopup's parent

            Set the parent object.

            @note elm_ctxpopup_add() will automatically call this function
            with its @c parent argument.

            @see elm_ctxpopup_add()
            @see elm_hover_parent_set()

            @ingroup Ctxpopup */
         }
         get {
            /*@
            @brief Get the Ctxpopup's parent

            @see elm_ctxpopup_hover_parent_set() for more information

            @ingroup Ctxpopup */
         }
         values {
            parent: Evas_Object *; /*@ The parent to use */
         }
      }
      @property direction_priority {
         set {
            /*@
            @brief Set the direction priority of a ctxpopup.

            This functions gives a chance to user to set the priority of ctxpopup
            showing direction. This doesn't guarantee the ctxpopup will appear in the
            requested direction.

            @see Elm_Ctxpopup_Direction

            @ingroup Ctxpopup */
         }
         get {
            /*@
            @brief Get the direction priority of a ctxpopup.

            @see elm_ctxpopup_direction_priority_set() for more information.

            @ingroup Ctxpopup */
         }
         values {
            first: Elm_Ctxpopup_Direction; /*@ 1st priority of direction */
            second: Elm_Ctxpopup_Direction; /*@ 2nd priority of direction */
            third: Elm_Ctxpopup_Direction; /*@ 3th priority of direction */
            fourth: Elm_Ctxpopup_Direction; /*@ 4th priority of direction */
         }
      }
      @property direction {
         get {
            /*@
            @brief Get the current direction of a ctxpopup.

            @return current direction of a ctxpopup
            (If getting the current direction is failed, it returns #ELM_CTXPOPUP_DIRECTION_UNKNOWN)

            @warning Once the ctxpopup showed up, the direction would be determined

            @ingroup Ctxpopup */
            return: Elm_Ctxpopup_Direction(4);
         }
      }
      @property items {
         get {
            /*@
            @brief Get the internal list of items in a given ctxpopup widget.
            @since 1.11

            @return The list of items (#Elm_Object_Item as data) or
            @c NULL on errors.

            This list is @b not to be modified in any way and must not be
            freed. Use the list members with functions like
            elm_object_item_text_set(),
            elm_object_item_text_get(),
            elm_object_item_del().

            @warning This list is only valid until @p obj object's internal
            items list is changed. It should be fetched again with another
            call to this function when changes happen.

            @ingroup Ctxpopup */
            return: const(list<Elm.Object.Item*>)*;
         }
      }
      @property first_item {
         get {
            /*@
            Get the first item in the given ctxpopup widget's list of
            items.
            @since 1.11

            @return The first item or @c NULL, if it has no items (and on
            errors)

            @see elm_ctxpopup_item_append()
            @see elm_ctxpopup_last_item_get()

            @ingroup Ctxpopup */
            return: Elm_Object_Item *;
         }
      }
      @property last_item {
         get {
            /*@
            Get the last item in the given ctxpopup widget's list of
            items.
            @since 1.11

            @return The last item or @c NULL, if it has no items (and on
            errors)

            @see elm_ctxpopup_item_prepend()
            @see elm_ctxpopup_first_item_get()

            @ingroup Ctxpopup */
            return: Elm_Object_Item *;
         }
      }
      dismiss {
         /*@
         @brief Dismiss a ctxpopup object

         Use this function to simulate clicking outside of the ctxpopup to dismiss it.
         In this way, the ctxpopup will be hidden and the "clicked" signal will be
         emitted. */

      }
      clear {
         /*@
         @brief Clear all items in the given ctxpopup object.

         @ingroup Ctxpopup */

      }
      item_append {
         /*@
         @brief Add a new item to a ctxpopup object.

         @return A handle to the item added or @c NULL, on errors

         @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_object_content_set()

         @ingroup Ctxpopup */

         return: Elm_Object_Item *;
         params {
            @in label: const(char)*; /*@ The Label of the new item */
            @in icon: Evas_Object * @optional; /*@ Icon to be set on new item */
            @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when item selected */
            @in data: const(void)* @optional; /*@ Data passed to @p func */
         }
      }
      item_prepend {
         /*@
         @brief Prepend a new item to a ctxpopup object.
         @since 1.11

         @return A handle to the item added or @c NULL, on errors

         @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_object_content_set()

         @ingroup Ctxpopup */

         return: Elm_Object_Item *;
         params {
            @in label: const(char)*; /*@ The Label of the new item */
            @in icon: Evas_Object * @optional; /*@ Icon to be set on new item */
            @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when item selected */
            @in data: const(void)* @optional; /*@ Data passed to @p func */
         }
      }
   }
   implements {
      class.constructor;
      Eo.Base.constructor;
      Evas.Object_Smart.del;
      Evas.Object_Smart.add;
      Elm.Widget.parent.set;
      Elm.Widget.focus_direction;
      Elm.Widget.sub_object_add;
      Elm.Widget.focus_direction_manager_is;
      Elm.Widget.focus_next_manager_is;
      Elm.Widget.focus_next;
      Elm.Widget.disable;
      Elm.Widget.translate;
      Elm.Widget.theme_apply;
      Elm.Widget.event;
      Elm.Container.content_get;
      Elm.Container.content_set;
      Elm.Container.content_unset;
      Elm.Layout.sub_object_add_enable;
      Elm.Layout.sizing_eval;
      Elm_Interface_Atspi_Widget_Action.elm_actions.get;
   }
   events {
      language,changed;
      access,changed;
      focused;
      unfocused;
   }

}