summaryrefslogtreecommitdiff
path: root/src/lib/elm_toolbar_item.eo
blob: 04800f0d40682b6cbd1d7d06ee2c3943f6676b8c (plain)
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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
enum Elm.Toolbar_Item.Scrollto_Type
{
/**
   Defines where to position the item in the toolbar.

   @ingroup Toolbar
 */

   legacy: elm_toolbar_item_scrollto;

   none = 0,   /*@< no scrollto */
   in = (1 << 0),   /*@< to the nearest viewport */
   first = (1 << 1),   /*@< to the first of viewport */
   middle = (1 << 2),   /*@< to the middle of viewport */
   last = (1 << 3)   /*@< to the last of viewport */
}

class Elm.Toolbar_Item(Elm.Widget_Item)
{
      eo_prefix: elm_obj_toolbar_item;
      methods {
           @property prev {
                get {
                     /*@
                      Get the item before @p item in toolbar.

                      @note If it is the first item, @c NULL will be returned.

                      @see elm_toolbar_item_prepend()

                      @ingroup Toolbar
                      */
                }
                values {
                     Elm_Object_Item *item; /*@ The item before @p item, or @c NULL if none or on failure. */
                }
           }
           @property next {
                get {
                     /*@
                      Get the item after @p item in toolbar.

                      @note If it is the last item, @c NULL will be returned.

                      @see elm_toolbar_item_append()

                      @ingroup Toolbar
                      */
                }
                values {
                     Elm_Object_Item *item; /*@ The item after @p item, or @c NULL if none or on failure. */
                }
           }
           @property priority {
                get {
                     /*@
                      Get the priority of a toolbar item.

                      @see elm_toolbar_item_priority_set() for details.

                      @ingroup Toolbar
                      */
                }
                set {
                     /*@
                      Set the priority of a toolbar item.

                      This is used only when the toolbar shrink mode is set
                      to #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
                      When space is less than required, items with low priority
                      will be removed from the toolbar and added to a dynamically-created menu,
                      while items with higher priority will remain on the toolbar,
                      with the same order they were added.

                      @see elm_toolbar_item_priority_get()

                      @ingroup Toolbar
                      */
                }
                values {
                     int priority; /*@ The @p item priority. The default is zero for set and 0 is returned on failure. */
                }
           }
           @property selected {
                get {
                     /*@
                      Get whether the @p item is selected or not.

                      @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
                      it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.

                      @see elm_toolbar_selected_item_set() for details.
                      @see elm_toolbar_item_selected_get()

                      @ingroup Toolbar
                      */
                }
                set {
                     /*@
                      Set the selected state of an item.

                      This sets the selected state of the given item @p it.
                      @c EINA_TRUE for selected, @c EINA_FALSE for not selected.

                      If a new item is selected the previously selected will be unselected.
                      Previously selected item can be get with function
                      elm_toolbar_selected_item_get().

                      Selected items will be highlighted.

                      @see elm_toolbar_item_selected_get()
                      @see elm_toolbar_selected_item_get()

                      @ingroup Toolbar
                      */
                }
                values {
                     bool selected; /*@ The selected state */
                }
           }
           @property icon {
                get {
                     /*@
                      Get the string used to set the icon of @p item.

                      @return The string associated with the icon object.

                      @see elm_toolbar_item_icon_set() for details.

                      @ingroup Toolbar
                      */
                }
                set {
                     /*@
                      Set the icon associated with @p item.

                      @param icon A string with icon name or the absolute path of an image file.

                      Toolbar will load icon image from fdo or current theme.
                      This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
                      If an absolute path is provided it will load it direct from a file.

                      @note This function does not accept relative icon path.

                      @see elm_toolbar_icon_order_lookup_set()
                      @see elm_toolbar_icon_order_lookup_get()

                      @ingroup Toolbar
                      */
                }
                values {
                     const (char) *icon;
                }
           }
           @property object {
                get {
                     /*@
                      Get the real Evas(Edje) object created to implement the view of a given
                      toolbar @p item.

                      @ingroup Toolbar
                      */
                }
                values {
                     Evas_Object *obj; /*@ The base Edje object associated with @p it. */
                }
           }
           @property icon_object {
                get {
                     /*@
                      Get the icon object of @p item.

                      @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
                      or elm_toolbar_item_icon_memfile_set() for details.

                      @ingroup Toolbar
                      */
                }
                values {
                     Evas_Object *obj; /*@ The icon object */
                }
           }
           @property separator {
                get {
                     /*@
                      Get a value whether item is a separator or not.

                      @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
                      indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.

                      @see elm_toolbar_item_separator_set() for details.

                      @ingroup Toolbar
                      */
                }
                set {
                     /*@
                      Set or unset item as a separator.

                      @param separator @c EINA_TRUE to set item @p item as separator or
                      @c EINA_FALSE to unset, i.e., item will be used as a regular item.

                      Items aren't set as separator by default.

                      If set as separator it will display separator theme, so won't display
                      icons or label.

                      @see elm_toolbar_item_separator_get()

                      @ingroup Toolbar
                      */
                }
                values {
                     bool separator;
                }
           }
           @property menu {
                get {
                     /*@
                      Get toolbar item's menu.

                      If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
                      this function will set it.

                      @see elm_toolbar_item_menu_set() for details.

                      @ingroup Toolbar
                      */
                }
                values {
                     Evas_Object *menu; /*@ Item's menu object or @c NULL on failure. */
                }
           }
           @property state {
                get {
                     /*@
                      Get the current state of @p it.

                      @return The selected state or @c NULL if none is selected or on failure.

                      @see elm_toolbar_item_state_set() for details.
                      @see elm_toolbar_item_state_unset()
                      @see elm_toolbar_item_state_add()

                      @ingroup Toolbar
                      */
                }
                set {
                     /*@
                      Set @p state as the current state of @p it.

                      @param state The state to use.
                      @return @c EINA_TRUE on success or @c EINA_FALSE on failure.

                      If @p state is @c NULL, it won't select any state and the default item's
                      icon and label will be used. It's the same behaviour than
                      elm_toolbar_item_state_unset().

                      @see elm_toolbar_item_state_unset()

                      @ingroup Toolbar
                      */
                     return: bool;
                }
                values {
                     Elm_Toolbar_Item_State *state @nullable;
                }
           }
           /*      init { FIXME
                   params {
                   Evas_Smart_Cb func;
                   const(void)* data;
                   }
                   }*/
           icon_memfile_set {
                /*@
                 Set the icon associated with @p item to an image in a binary buffer.

                 @note The icon image set by this function can be changed by
                 elm_toolbar_item_icon_set().

                 @ingroup Toolbar
                 */
                params {
                     @in const (void) *img; /*@ The binary data that will be used as an image */
                     @in size_t size; /*@ The size of binary data @p img */
                     @in const (char) *format; /*@ Optional format of @p img to pass to the image loader */
                     @in const (char) *key; /*@ Optional key of @p img to pass to the image loader (eg. if @p img is an edje file) */
                }
                return: bool; /*@ (@c EINA_TRUE = success, @c EINA_FALSE = error) */
           }
           icon_file_set {
                /*@
                 Set the icon associated with @p item to an image in a binary buffer.

                 @note The icon image set by this function can be changed by
                 elm_toolbar_item_icon_set().

                 @ingroup Toolbar
                 */
                params {
                     @in const (char) *file; /*@ The file that contains the image */
                     @in const (char) *key; /*@ Optional key of @p img to pass to the image loader (eg. if @p img is an edje file) */
                }
                return: bool; /*@ (@c EINA_TRUE = success, @c EINA_FALSE = error) */
           }
           state_add {
                /*@
                 Add a new state to @p item.

                 Toolbar will load icon image from fdo or current theme.
                 This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
                 If an absolute path is provided it will load it direct from a file.

                 States created with this function can be removed with
                 elm_toolbar_item_state_del().

                 @see elm_toolbar_item_state_del()
                 @see elm_toolbar_item_state_sel()
                 @see elm_toolbar_item_state_get()

                 @ingroup Toolbar
                 */
                params {
                     @in const (char) *icon; /*@ A string with icon name or the absolute path of an image file. */
                     @in const (char) *label; /*@ The label of the new state. */
                     @in Evas_Smart_Cb func @optional; /*@ The function to call when the item is clicked when this * state is selected. */
                     @in const (void) *data @optional; /*@ The data to associate with the state. */
                }
                return: Elm_Toolbar_Item_State *; /*@ The toolbar item state, or @c NULL upon failure. */
           }
           state_del {
                /*@
                 Delete a previously added state to @p item.

                 @see elm_toolbar_item_state_add()
                 */
                params {
                     @in Elm_Toolbar_Item_State *state; /*@ The state to be deleted. */
                }
                return: bool; /*@ @c EINA_TRUE on success or @c EINA_FALSE on failure. */
           }
           state_next {
                /*@
                 Get the state after selected state in toolbar's @p item.

                 If last state is selected, this function will return first state.

                 @see elm_toolbar_item_state_set()
                 @see elm_toolbar_item_state_add()

                 @ingroup Toolbar
                 */
                return: Elm_Toolbar_Item_State *; /*@ The state after current state, or @c NULL on failure. */
           }
           state_prev {
                /*@
                 Get the state before selected state in toolbar's @p item.


                 If first state is selected, this function will return last state.

                 @see elm_toolbar_item_state_set()
                 @see elm_toolbar_item_state_add()

                 @ingroup Toolbar
                 */
                return: Elm_Toolbar_Item_State *; /*@ The state before current state, or @c NULL on failure. */
           }
           show {
                /*@
                 Show a specific item, when the toolbar can be scrolled.

                 see elm_toolbar_item_bring_in()

                 @since 1.8
                 @ingroup Toolbar
                 */
                params {
                     @in Elm_Toolbar_Item_Scrollto_Type scrollto; /*@ the position the item should appear at */
                }
           }
           bring_in {
                /*@
                 Show a specific item with scroll animation, when the toolbar can be scrolled.

                 see elm_toolbar_item_show()

                 @since 1.8
                 @ingroup Toolbar
                 */
                params {
                     @in Elm_Toolbar_Item_Scrollto_Type scrollto; /*@ the position the item should appear at */
                }
           }
           menu_set {
                /*@
                 Set whether the toolbar item opens a menu.

                 A toolbar item can be set to be a menu, using this function.

                 Once it is set to be a menu, it can be manipulated through the
                 menu-like function elm_toolbar_menu_parent_set() and the other
                 elm_menu functions, using the Evas_Object @c menu returned by
                 elm_toolbar_item_menu_get().

                 So, items to be displayed in this item's menu should be added with
                 elm_menu_item_add().

                 The following code exemplifies the most basic usage:
                 @code
                 tb = elm_toolbar_add(win)
                 item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
                 elm_toolbar_item_menu_set(item, EINA_TRUE);
                 elm_toolbar_menu_parent_set(tb, win);
                 menu = elm_toolbar_item_menu_get(item);
                 elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
                 menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
                 NULL);
                 @endcode

                 @see elm_toolbar_item_menu_get()

                 @ingroup Toolbar
                 */
                params {
                     @in bool menu; /*@ If @c EINA_TRUE, @p item will opens a menu when selected. */
                }
           }
      }
      implements {
           Eo.Base.constructor;
           Eo.Base.destructor;
           Elm.Widget_Item.disable;
           Elm.Widget_Item.focus.set;
           Elm.Widget_Item.focus.get;
           Elm.Widget_Item.part_text.get;
           Elm.Widget_Item.part_text.set;
           Elm.Widget_Item.part_content.get;
           Elm.Widget_Item.part_content.set;
           Elm.Widget_Item.part_content_unset;
           Elm_Interface_Atspi_Accessible.name.get;
           Elm_Interface_Atspi_Accessible.state_set.get;
      }
}