summaryrefslogtreecommitdiff
path: root/src/lib/elc_multibuttonentry.eo
blob: 69612f12d5bcd1f7f1048d865595f1c3207cd13b (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
275
276
277
278
279
280
281
282
283
284
285
class Elm_Multibuttonentry (Elm_Layout)
{
   eo_prefix: elm_obj_multibuttonentry;
   properties {
      editable {
         set {
            /*@
            Sets if the multibuttonentry is to be editable or not.

            @ingroup Multibuttonentry

            @since 1.7 */
         }
         get {
            /*@
            Get whether the multibuttonentry is editable or not.

            @return @c EINA_TRUE if the multibuttonentry is editable by the user. @c EINA_FALSE if not.

            @ingroup Multibuttonentry

            @since 1.7 */
         }
         values {
            Eina_Bool editable; /*@ If @c EINA_TRUE, user can add/delete item in multibuttonentry, if not, the multibuttonentry is non-editable. */
         }
      }
      expanded {
         set {
            /*@
            Set/Unset the multibuttonentry to expanded state.
            In expanded state, the complete entry will be displayed.
            Otherwise, only single line of the entry will be displayed.

            @ingroup Multibuttonentry */
         }
         get {
            /*@
            Get the value of expanded state.
            In expanded state, the complete entry will be displayed.
            Otherwise, only single line of the entry will be displayed.

            @return @c EINA_TRUE if the widget is in expanded state. @c EINA_FALSE if not.

            @ingroup Multibuttonentry */
         }
         values {
            Eina_Bool expanded; /*@ the value of expanded state.
            Set this to @c EINA_TRUE for expanded state.
            Set this to EINA_FALSE for single line state. */
         }
      }
      format_function {
         set {
            /*@
            Set a function to format the string that will be used to display
            the hidden items counter.

            If @a format_function is @c NULL, the default format will be used,
            which is @c "... + %d".

            @see elm_multibuttonentry_format_function_set
            @since 1.9

            @ingroup Multibuttonentry */
         }
         values {
            Elm_Multibuttonentry_Format_Cb format_function; /*@ format_function The actual format function */
            const void *data; /*@ data User data to passed to @a format_function */
         }
      }
      items {
         get {
            /*@
            Get a list of items in the multibuttonentry

            @return The list of items, or NULL if none

            @ingroup Multibuttonentry */
            return const Eina_List *;
         }
      }
      first_item {
         get {
            /*@
            Get the first item in the multibuttonentry

            @return The first item, or NULL if none

            @ingroup Multibuttonentry */
            return Elm_Object_Item *;
         }
      }
      last_item {
         get {
            /*@
            Get the last item in the multibuttonentry

            @return The last item, or NULL if none

            @ingroup Multibuttonentry */
            return Elm_Object_Item *;
         }
      }
      entry {
         get {
            /*@
            Get the entry of the multibuttonentry object

            @return The entry object, or NULL if none

            @ingroup Multibuttonentry */
            return Evas_Object *;
         }
      }
      selected_item {
         get {
            /*@
            Get the selected item in the multibuttonentry

            @return The selected item, or NULL if none

            @ingroup Multibuttonentry */
            return Elm_Object_Item *;
         }
      }
   }
   methods {
      item_prepend {
         /*@
         Prepend a new item to the multibuttonentry

         @return A handle to the item added or NULL if not possible

         @see Use elm_object_item_del() to delete the item.

         @ingroup Multibuttonentry */

         return Elm_Object_Item *;
         params {
            @in const char *label; /*@ The label of new item */
            @in Evas_Smart_Cb func; /*@ The callback function to be invoked when this item is pressed. */
            @in void *data; /*@ The pointer to the data to be attached */
         }
      }
      clear {
         /*@
         Remove all items in the multibuttonentry.

         @ingroup Multibuttonentry */

      }
      item_filter_remove {
         /*@
         Remove a filter from the list

         Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
         for more information.

         @ingroup Multibuttonentry */

         params {
            @in Elm_Multibuttonentry_Item_Filter_Cb func; /*@ The filter function to remove */
            @in void *data; /*@ The user data passed when adding the function */
         }
      }
      item_insert_before {
         /*@
         Add a new item to the multibuttonentry before the indicated object

         reference.
         @return A handle to the item added or NULL if not possible

         @see Use elm_object_item_del() to delete the item.

         @ingroup Multibuttonentry */

         return Elm_Object_Item *;
         params {
            @in Elm_Object_Item *before; /*@ The item before which to add it */
            @in const char *label; /*@ The label of new item */
            @in Evas_Smart_Cb func; /*@ The callback function to be invoked when this item is pressed. */
            @in void *data; /*@ The pointer to the data to be attached */
         }
      }
      item_append {
         /*@
         Append a new item to the multibuttonentry

         @return A handle to the item added or NULL if not possible

         @see Use elm_object_item_del() to delete the item.

         @ingroup Multibuttonentry */

         return Elm_Object_Item *;
         params {
            @in const char *label; /*@ The label of new item */
            @in Evas_Smart_Cb func; /*@ The callback function to be invoked when this item is pressed. */
            @in void *data; /*@ The pointer to the data to be attached */
         }
      }
      item_filter_prepend {
         /*@
         Prepend a filter function for text inserted in the Multibuttonentry

         Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
         for more information

         @ingroup Multibuttonentry */

         params {
            @in Elm_Multibuttonentry_Item_Filter_Cb func; /*@ The function to use as text filter */
            @in void *data; /*@ User data to pass to @p func */
         }
      }
      item_filter_append {
         /*@
         Append an item filter function for text inserted in the Multibuttonentry

         Append the given callback to the list. This functions will be called
         whenever any text is inserted into the Multibuttonentry, with the text to be inserted
         as a parameter. The callback function is free to alter the text in any way
         it wants, but it must remember to free the given pointer and update it.
         If the new text is to be discarded, the function can free it and set it text
         parameter to NULL. This will also prevent any following filters from being
         called.

         @ingroup Multibuttonentry */

         params {
            @in Elm_Multibuttonentry_Item_Filter_Cb func; /*@ The function to use as item filter */
            @in void *data; /*@ User data to pass to @p func */
         }
      }
      item_insert_after {
         /*@
         Add a new item to the multibuttonentry after the indicated object

         @return A handle to the item added or NULL if not possible

         @see Use elm_object_item_del() to delete the item.

         @ingroup Multibuttonentry */

         return Elm_Object_Item *;
         params {
            @in Elm_Object_Item *after; /*@ The item after which to add it */
            @in const char *label; /*@ The label of new item */
            @in Evas_Smart_Cb func; /*@ The callback function to be invoked when this item is pressed. */
            @in void *data; /*@ The pointer to the data to be attached */
         }
      }
   }
   implements {
      class.constructor;
      Eo_Base.constructor;
      Evas_Object_Smart.add;
      Evas_Object_Smart.del;
      Elm_Widget.theme_apply;
      Elm_Widget.focus_next_manager_is;
      Elm_Widget.focus_direction_manager_is;
      Elm_Widget.access;
      Elm_Widget.focus_next;
      Elm_Widget.on_focus;
      Elm_Widget.translate;
      Elm_Widget.event;
      Elm_Layout.text_set;
      Elm_Layout.text_get;
      Elm_Layout.sizing_eval;
   }
   events {
      item,selected;
      item,added;
      item,deleted;
      item,clicked;
      clicked;
      focused;
      unfocused;
      expanded;
      contracted;
      expand,state,changed;
   }

}