summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_widget.eo
blob: 5c369ba18b4d8b3156d7bd099b8aa2da41e4b3f6 (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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
import edje_types;
import elm_general;
import efl_input_types;

/* FIXME: This shouldn't be here. */
type list_data_get_func_type: __undefined_type; [[Elementary list data get function type]]
type region_hook_func_type: __undefined_type; [[Elementary region hook function type]]
type @extern Evas.Callback_Type: __undefined_type; [[Evas event type]]

enum Elm.Activate
{
   [[ Used in 'Virtual' function @Elm.Widget.activate. ]]
   default = 0, [[Activate default]]
   up, [[Activate up]]
   down, [[Activate down]]
   right, [[Activate right]]
   left, [[Activate left]]
   back, [[Activate back]]
}

struct Elm.Tooltip; [[Elementary tooltip]]
struct @extern Elm.Theme; [[Elementary theme]]

abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible,
                     Elm.Interface.Atspi_Component, Efl.Ui.Focus.User,
                     Efl.Ui.Focus.Object, Efl.Ui.Base, Efl.Ui.Cursor)
{
   [[Elementary widget abstract class]]
   legacy_prefix: elm_widget;
   eo_prefix: elm_obj_widget;
   event_prefix: elm_widget;
   data: Elm_Widget_Smart_Data;
   methods {
      @property resize_object @protected {
         [[This is the internal canvas object managed by a widget.

           This property is protected as it is meant for widget implementations
           only, to set and access the internal canvas object. Do use this
           function unless you're implementing a widget.
         ]]
         set {
            [[Sets the new resize object for this widget.]]
         }
         values {
            sobj: Efl.Canvas.Object @nullable;
               [[A canvas object (often a $Efl.Canvas.Layout object).]]
         }
      }
      @property disabled {
         [[Whether the widget is enabled (accepts and reacts to user inputs).

           Each widget may handle the disabled state differently, but overall
           disabled widgets shall not respond to any input events. This is
           $false by default, meaning the widget is enabled.
         ]]
         values {
            disabled: bool(false); [[$true if the widget is disabled.]]
         }
      }
      @property style {
         [[The widget style to use.

           Styles define different look and feel for widgets, and may provide
           different parts for layout-based widgets. Styles vary from widget
           to widget and may be defined by other themes by means of extensions
           and overlays.

           The style can only be set before @Efl.Object.finalize, which means
           at construction time of the object (inside $efl_add in C).
         ]]
         set {
            [[Can only be called during construction, before finalize.]]
            return: Efl.Ui.Theme.Apply(0);
               [[Whether the style was successfully applied or not, see
                 the values of @Efl.Ui.Theme.Apply for more information.]]
         }
         get {
            [[Returns the current style of a widget.]]
         }
         values {
            style: string;
               [[Name of the style to use. Refer to each widget's documentation
                 for the available style names, or to the themes in use.]]
         }
      }

      @property focus {
      	 [[Focus property]]
         values {
            focus: bool; [[$true if the widget has focus, $false otherwise]]
         }
      }
      @property drag_lock_y {
      	 [[Lock the Y axis from being dragged]]
         values {
            lock: bool; [[$true if the Y axis is locked, $false otherwise]]
         }
      }
      @property focus_highlight_style {
         [[Control the widget focus highlight style.]]
         set {
            return: bool; [[$true on success, $false otherwise.]]
         }
         get {
         }
         values {
            style: string; [[The name of the focus highlight style.]]
         }
      }
      @property tree_unfocusable {
         [[Make the elementary object and its children to be unfocusable (or focusable).
           If the tree is set as unfocusable, newest focused object which is not in
           this tree will get focus.
           This API can be helpful for an object to be deleted.
           When an object will be deleted soon, it and its children may not want to
           get focus (by focus reverting or by other focus controls).
           Then, just use this API before deleting.]]
         values {
            tree_unfocusable: bool; [[$true for unfocusable, $false for focusable.]]
         }
      }
      @property theme {
      	 [[Widget theme]]
         values {
            th: ptr(Elm.Theme) @nullable; [[Elementary theme]]
         }
      }
      @property highlight_ignore {
      	 [[Highlight ignore]]
         values {
            ignore: bool; [[$true if highlights are ignored, $false otherwise]]
         }
      }
      @property orientation_mode_disabled {
      	 [[Orientation mode disabled or enabled]]
         values {
            disabled: bool; [[$true if orientation mode is disabled, $false otherwise]]
         }
      }
      @property focus_custom_chain {
         [[A custom chain of objects to pass focus.

           Note: On focus cycle, only will be evaluated children of this container.]]
         set {
            [[This function overwrites any previous custom focus chain within
              the list of objects. The previous list will be deleted and this list
              will be managed by elementary. After it is set, don't modify it.]]
            values {
               objs: list<Efl.Canvas.Object>; [[Chain of objects to pass focus]]
            }
         }
         get {
            values {
               objs: const(list<Efl.Canvas.Object>); [[Chain of objects]]
            }
         }
      }
      @property can_focus {
         [[The ability for an Elementary object to be focused.

           Unfocusable objects do nothing when programmatically
           focused, being the nearest focusable parent object the one
           really getting focus. Also, when they receive mouse input, they
           will get the event, but not take away the focus from where it
           was previously.

           Note: Objects which are meant to be interacted with by input
           events are created able to be focused, by default. All the
           others are not.]]
         values {
            can_focus: bool; [[$true if the object can be focused,
                               $false if not.]]
         }
      }
      @property highlight_in_theme {
      	 [[Highlight in theme property]]
         values {
            highlight: bool; [[$true if widget gets hightlight, $false otherwise]]
         }
      }
      @property widget_parent @protected {
         [[The internal widget parent]]
         set {
            legacy: elm_widget_parent_set; /* Needed because we don't do duplication removal for legacy names. */
         }
         get {
            legacy: elm_widget_parent_get; /* Needed because we don't do duplication removal for legacy names. */
         }
         values {
            parent: Efl.Canvas.Object @nullable; [[Widget parent object]]
         }
      }
      @property access_info {
      	 [[Accessibility information]]
         values {
            txt: string @nullable; [[Accessibility text description]]
         }
      }
      @property drag_lock_x {
      	 [[Drag lock on X axis]]
         values {
            lock: bool; [[$true if drag is locked on X axis, $false otherwise]]
         }
      }
      @property access_highlight_in_theme {
         [[Accessibility highlight in theme]]
         values {
            highlight: bool; [[$true if highlighted, $false otherwise]]
         }
      }
      @property focus_region_show_mode {
         [[Control the focus_region_show mode.]]
         values {
            mode: Elm.Focus.Region.Show_Mode; [[Focus region show mode]]
         }
      }
      @property parent_highlight {
      	 [[Parent highlight property]]
         set {
         }
         values {
            highlighted: bool; [[$true if highlighted, $false otherwise]]
         }
      }
      @property theme_object {
      	 [[Theme object property]]
         set {
            return: Efl.Ui.Theme.Apply; [[Theme apply]]
         }
         values {
            edj: Efl.Canvas.Object; [[Edje object]]
            wname: string; [[Widget name]]
            welement: string; [[Widget element]]
            wstyle: string; [[Widget style]]
         }
      }
      @property hover_object {
      	 [[Hover object property]]
         set {
         }
         values {
            sobj: Efl.Canvas.Object @nullable; [[Hover sub object]]
         }
      }
      /* internal only - most objects use data = null as they work on
         themselves except scroller itself */
      @property on_show_region_hook {
      	 [[Region hook on show property]]
         set {
         }
         values {
            func: region_hook_func_type @nullable; [[Region hook function]]
            data: void_ptr @optional; [[Data pointer]]
         }
      }
      /* this is a part api */
      @property domain_part_text_translatable {
      	 [[Translate domain text part property]]
         set {
         }
         values {
            part: string; [[Part name]]
            domain: string; [[Domain]]
            translatable: bool; [[$true if translatable, $false otherwise]]
         }
      }
      @property orientation {
      	 [[Widget orientation]]
         set {
         }
         values {
            rotation: int; [[Orientation]]
         }
      }
      @property domain_translatable_part_text {
      	 [[Domain translatable text part property]]
         set {
         }
         values {
            part: string; [[Part name]]
            domain: string; [[Domain name]]
            label: string; [[Label]]
         }
      }
      @property scroll_hold {
      	 [[Scroll hold property]]
         get {
            return: int; [[FIXME]]
         }
      }
      @property drag_child_locked_y {
      	 [[Drag child locked Y axis property]]
         get {
            return: int; [[FIXME]]
         }
      }
      @property item_loop_enabled {
         [[Control item loop feature.]]
         values {
            enable: bool; [[$true if item loop is enabled, $false otherwise]]
         }
      }
      @property child_can_focus {
      	 [[Child can focus property]]
         get {
            return: bool; [[$true if child can focus, $false otherwise]]
         }
      }
      @property scroll_freeze {
      	 [[Scroll freeze property]]
         get {
            return: int; [[FIXME]]
         }
      }
      @property focus_region {
      	 [[Focus region property]]
         get {
            return: bool; [[$true on success, $false otherwise]]
         }
         values {
            x: int; [[X coordinate]]
            y: int; [[Y coordinate]]
            w: int; [[Width]]
            h: int; [[Height]]
         }
      }
      @property top {
      	 [[Top widget property]]
         get {
            return: Efl.Canvas.Object; [[Top widget]]
         }
      }
      @property focus_order {
      	 [[Focus order property]]
         get {
            return: uint; [[FIXME]]
         }
      }
      @property drag_child_locked_x {
      	 [[Drag child locked X axis]]
         get {
            return: int; [[FIXME]]
         }
      }
      @property can_focus_child_list {
      	 [[Can focus children list]]
         get {
            return: free(own(list<Efl.Canvas.Object>), eina_list_free) @warn_unused; [[List of children which can focus]]
         }
      }
      @property focused_item {
         get {
            [[Get the focused widget item.]]
            return: Elm.Widget.Item; [[Focused item]]
         }
      }
      @property parents_bounce {
      	 [[Parents bounce property]]
         get {
         }
         values {
            horiz: bool; [[$true if parents bounce horizontally, $false otherwise]]
            vert: bool; [[$true if parents bounce vertically, $false otherwise]]
         }
      }
      @property parent_widget {
      	 [[Parent widget property]]
         get @pure_virtual {
            return: Efl.Canvas.Object; [[Parent widget]]
            legacy: null;
         }
      }
      @property highlight {
      	 [[Highlight property]]
         get {
            return: bool; [[$true if widget is highlight, $false otherwise]]
         }
      }
      @property focused_object {
         [[Current focused object in object tree.]]
         get {
            return: Efl.Canvas.Object; [[Current focused or $null, if there is no focused object.]]
         }
      }
      @property parent2 {
      	 [[Second parent property]]
         values {
            parent: Efl.Canvas.Object @nullable; [[Second parent]]
         }
      }
      @property part_text {
      	 [[Part text property]]
         keys {
            part: string; [[Part name]]
         }
         values {
            label: string; [[Label]]
         }
      }
      newest_focus_order_get @const {
      	 [[Get newest focus in order]]
         return: Efl.Canvas.Object; [[Handle to focused widget]]
         params {
            @out newest_focus_order: uint; [[Newest focus order]]
            @in can_focus_only: bool; [[$true only us widgets which can focus, $false otherweise]]
         }
      }
      scroll_hold_push {
         [[Push scroll hold]]
      }
      focus_next_object_set {
         [[Set the next object with specific focus direction.

           @since 1.8]]
         params {
            @in next: Efl.Canvas.Object @nullable; [[Focus next object]]
            @in dir: Elm.Focus_Direction; [[Focus direction]]
         }
      }
      focus_next_object_get @const {
         [[Get the next object with specific focus direction.

           @since 1.8]]
         return: Efl.Canvas.Object; [[Focus next object]]
         params {
            @in dir: Elm.Focus_Direction; [[Focus direction]]
         }
      }
      focus_next_item_set {
         [[Set the next object item with specific focus direction.

           @since 1.16]]
         params {
            @in next_item: Elm.Widget.Item @nullable; [[Focus next object item]]
            @in dir: Elm.Focus_Direction; [[Focus direction]]
         }
      }
      focus_next_item_get @const {
         [[Get the next object item with specific focus direction.

           @since 1.16]]
         return: Elm.Widget.Item; [[Focus next object item]]
         params {
            @in dir: Elm.Focus_Direction; [[Focus direction]]
         }
      }
      focus_tree_unfocusable_handle {
         [[Handle focus tree unfocusable]]
      }
      focus_custom_chain_prepend {
         [[Prepend object to custom focus chain.

           Note: If @"relative_child" equal to $null or not in custom chain,
           the object will be added in begin.

           Note: On focus cycle, only will be evaluated children of this container.]]
         params {
            @in child: Efl.Canvas.Object; [[The child to be added in custom chain.]]
            @in relative_child: Efl.Canvas.Object @optional; [[The relative object to position the child.]]
         }
      }
      part_text_translate {
      	 [[Translate part text]]
         return: string; [[Translated text]]
         params {
            @in part: string; [[Part name]]
            @in text: string; [[Text]]
         }
      }
      focus_highlight_geometry_get @const {
         [[Get the focus highlight geometry of widget.]]
         params {
            @out x: int; [[X coordinate]]
            @out y: int; [[Y coordinate]]
            @out w: int; [[Width]]
            @out h: int; [[Height]]
         }
      }
      activate {
         [['Virtual' function to activate widget.]]
         params {
            @in act: Elm.Activate; [[Activate]]
         }
         return: bool; [[$true on success, $false otherwise]]
         legacy: null; /* the legacy API has not the same number of parameter to we don't generate it. */
      }
      sub_object_add {
         [['Virtual' function handling sub objects being added.]]
         return: bool; [[$true on success, $false otherwise]]
         params {
            @in sobj: Efl.Canvas.Object; [[Sub object]]
         }
      }
      focus_direction_manager_is {
         [['Virtual' function which checks if handling of passing focus to sub-objects in given direction is supported by widget.]]
         return: bool; [[$true on success, $false otherwise]]
         legacy: null;
      }
      widget_event {
         [['Virtual' function handling input events on the widget.]]
         legacy: elm_widget_event;
         params {
            @in source: Efl.Canvas.Object; [[Source object]]
            @in type: Evas.Callback_Type; [[Callback type]]
            @in event_info: void_ptr; [[Event info]]
         }
         return: bool; [[$true on success, $false otherwise]]
      }
      access {
         [['Virtual' function on the widget being set access.]]
         params {
            @in acs: bool; [[$true if access is set, $false otherwise]]
         }
         legacy: null;
      }
      on_focus {
         [['Virtual' function handling focus in/out events on the widget]]
         params {
            @in item: Elm.Widget.Item @nullable; [[Widget]]
         }
         return: bool; [[$true if this widget can handle focus, $false otherwise]]
      }
      on_focus_region {
         [['Virtual' function returning an inner area of a widget that should be brought into the visible area of a broader viewport, may this context arise.]]
         params {
            @out x: int; [[X coordinate]]
            @out y: int; [[Y coordinate]]
            @out w: int; [[Width]]
            @out h: int; [[Height]]
         }
         return: bool; [[$true on success, $false otherwise]]
      }
      focus_cycle {
         [[Give focus to next object with specific focus direction in
           object tree.]]
         params {
            @in dir: Elm.Focus_Direction; [[Direction to move the focus.]]
         }
      }
      focus_direction @pure_virtual {
         [['Virtual' function handling passing focus to sub-objects given a direction, in degrees.]]
         params {
            @in base: const(Efl.Canvas.Object); [[Base object]]
            @in degree: double; [[Degree]]
            @out direction: Efl.Canvas.Object; [[Direction]]
            @out direction_item: Elm.Widget.Item; [[Direction item]]
            @out weight: double; [[Weight]]
         }
         return: bool; [[$true on success, $false otherwise]]
      }
      focus_next_manager_is {
         [['Virtual' function which checks if handling of passing focus to sub-objects is supported by widget.]]
         return: bool; [[$true on success, $false otherwise]]
      }
      name_find @const {
      	 [[Find widget by name]]
         return: Efl.Canvas.Object; [[Widget]]
         params {
            @in name: string; [[Widget name]]
            @in recurse: int; [[Depth in the tree to search for the widget]]
         }
      }
      focus_list_direction_get @const {
      	 [[Get focus list direction]]
         return: bool; [[$true on success, $false otherwise]]
         params {
            @in base: const(Efl.Canvas.Object); [[Base object]]
            @in items: const(list<Efl.Object>); [[Item list]]
            @in list_data_get: list_data_get_func_type; [[Data get function]]
            @in degree: double; [[Degree]]
            @out direction: Efl.Canvas.Object; [[Direction]]
            @out direction_item: Elm.Widget.Item; [[Direction item]]
            @out weight: double; [[Weight]]
         }
      }
      focused_object_clear {
         [[Clear focused object]]
      }
      focus_direction_go {
      	 [[Go in focus direction]]
         return: bool; [[$true on success, $false otherwise]]
         params {
            @in degree: double; [[Degree]]
         }
      }
      show_region_set {
      	 [[Set show region]]
         params {
            @in x: int; [[X coordinate]]
            @in y: int; [[Y coordinate]]
            @in w: int; [[Width]]
            @in h: int; [[Height]]
            @in forceshow: bool; [[$true if show should be forced, $false otherwise]]
         }
      }
      show_region_get @const {
      	 [[Get show region]]
         params {
            @out x: int @optional; [[X coordinate]]
            @out y: int @optional; [[Y coordinate]]
            @out w: int @optional; [[Width]]
            @out h: int @optional; [[Height]]
         }
      }
      scroll_freeze_pop {
         [[Pop scroller freeze]]
      }
      tooltip_del {
      	 [[Delet widget tooltip]]
         params {
            @in tt: ptr(Elm.Tooltip); [[Tooltip to be deleted]]
         }
      }
      focus_next_get @const {
      	 [[Get next focus item]]
         return: bool; [[$true on success, $false otherwise]]
         params {
            @in dir: Elm.Focus_Direction; [[Focus direction]]
            @out next: Efl.Canvas.Object; [[Next object]]
            @out next_item: Elm.Widget.Item; [[Next item]]
         }
      }
      translatable_part_text_get @const {
      	 [[Get translatable part text]]
         return: string; [[Part text]]
         params {
            @in part: string; [[Part name]]
         }
      }
      focus_restore {
         [[Restore the focus state of the sub-tree.

         This API will restore the focus state of the sub-tree to the latest
         state. If a sub-tree is unfocused and wants to get back to the latest
         focus state, this API will be helpful.]]
      }
      scroll_hold_pop {
         [[Pop scroller hold]]
      }
      translate {
         [['Virtual' function handling language changes on Elementary.]]
         return: bool; [[$true on success, $false otherwise]]
         legacy: null;
      }
      scroll_freeze_push {
         [[Push scroller freeze]]
      }
      focus_custom_chain_unset {
         [[Unset a custom focus chain on a given Elementary widget.

           Any focus chain previously set is removed entirely after this call.]]
      }
      focus_steal {
      	 [[Steal focus]]
         params {
            @in item: Elm.Widget.Item @nullable; [[Widget to steal focus from]]
         }
      }
      focus_hide_handle {
         [[Handle hide focus]]
      }
      focus_next @pure_virtual {
         [['Virtual' function handling passing focus to sub-objects.]]
         params {
            @in dir: Elm.Focus_Direction; [[Focus direction]]
            @out next: Efl.Canvas.Object; [[Next object]]
            @out next_item: Elm.Widget.Item; [[Next item]]
         }
         return: bool; [[$true on success, $false otherwise]]
      }
      focus_list_next_get @const {
      	 [[Get next item in focus list]]
         return: bool; [[$true on success, $false otherwise]]
         params {
            @in items: const(list<Efl.Object>); [[Item list]]
            @in list_data_get: list_data_get_func_type; [[Function type]]
            @in dir: Elm.Focus_Direction; [[Focus direction]]
            @out next: Efl.Canvas.Object; [[Next object]]
            @out next_item: Elm.Widget.Item; [[Next item]]
         }
      }
      focus_mouse_up_handle {
      	 [[Handle focus mouse up]]
         legacy: null;
      }
      theme_apply {
         [['Virtual' function on the widget being re-themed.]]
         return: Efl.Ui.Theme.Apply; [[Theme apply]]
      }
      focus_direction_get @const {
      	 [[Get focus direction]]
         return: bool; [[$true on success, $false otherwise]]
         params {
            @in base: const(Efl.Canvas.Object); [[Base]]
            @in degree: double; [[Degree]]
            @out direction: Efl.Canvas.Object; [[Direction]]
            @out direction_item: Elm.Widget.Item; [[Direction item]]
            @out weight: double; [[Weight]]
         }
      }
      disable {
         [['Virtual' function on the widget being disabled.]]
         return: bool; [[$true on success, $false otherwise]]
      }
      sub_object_del {
         [['Virtual' function handling sub objects being removed.]]
         return: bool; [[$true on success, $false otherwise]]
         params {
            @in sobj: Efl.Canvas.Object; [[Object to be deleted]]
         }
      }
      tooltip_add {
      	 [[Add tooltip to widget]]
         params {
            @in tt: ptr(Elm.Tooltip); [[Tooltip]]
         }
      }
      focus_region_show @const {
         [[Show focus region]]
      }
      focus_disabled_handle {
         [[Handle disable widget focus]]
      }
      focus_custom_chain_append {
         [[Append object to custom focus chain.

           Note: If @"relative_child" equal to $null or not in custom chain,
           the object will be added in end.

           Note: On focus cycle, only will be evaluated children of this container.]]
         params {
            @in child: Efl.Canvas.Object; [[The child to be added in custom chain.]]
            @in relative_child: Efl.Canvas.Object @optional; [[The relative object to position the child.]]
         }
      }
      @property focus_move_policy {
         [[The widget's focus move policy.]]
         values {
            policy: Efl.Ui.Focus.Move_Policy; [[Focus move policy]]
         }
      }
      @property focus_move_policy_automatic {
         [[Control the widget's focus_move_policy mode setting.

           @since 1.18]]
         values {
            automatic: bool; [[$true to follow system focus move policy change, $false otherwise]]
         }
      }
      focus_reconfigure {
         [[@since 1.18]]
      }
      focus_register {
         [[Register focus with focus manager]]
         params {
            manager : Efl.Ui.Focus.Manager; [[The manager to register against]]
            logical : Efl.Ui.Focus.Object; [[The logical parent to use]]
            @inout logical_flag : bool; [[reference to the flag indicating if the should be logical or not change this flag to the value you have it registered]]
         }
         return : bool; [[return $true or $false if the registration was successfull or not]]
      }
      focus_manager_factory {
         [[If the widget needs a manager, this function is called

           It can be used and overriden to inject your own manager or set custom options on the manager
         ]]
         params {
            root : Efl.Ui.Focus.Object; [[the logical root to use in the manager.]]
         }
         return : Efl.Ui.Focus.Manager;
      }
   }
   implements {
      class.constructor;
      Efl.Object.constructor;
      Efl.Object.finalize;
      Efl.Object.destructor;
      Efl.Object.provider_find;
      Efl.Object.debug_name_override;
      Efl.Gfx.color { set; }
      Efl.Gfx.visible { set; }
      Efl.Gfx.position { set; }
      Efl.Gfx.size { set; }
      Efl.Canvas.Object.clip { set; }
      Efl.Canvas.Object.no_render { set; }
      Efl.Canvas.Object.is_frame_object { set; }
      Efl.Canvas.Group.group_calculate;
      Efl.Canvas.Group.group_member_del;
      Efl.Canvas.Group.group_member_add;
      Elm.Interface.Atspi_Accessible.name { get; }
      Elm.Interface.Atspi_Accessible.state_set { get; }
      Elm.Interface.Atspi_Accessible.children { get; }
      Elm.Interface.Atspi_Accessible.parent { get; }
      Elm.Interface.Atspi_Accessible.attributes { get; }
      Elm.Interface.Atspi_Component.focus_grab;
      Efl.Ui.Focus.User.manager { get; }
      Efl.Ui.Focus.User.parent { get; }
      Efl.Ui.Focus.Object.focus_geometry { get; }
      Efl.Ui.Focus.Object.focus { set; }
      Efl.Ui.Base.scale { get; set; }
      Efl.Ui.Base.mirrored { get; set; }
      Efl.Ui.Base.mirrored_automatic { get; set; }
      Efl.Ui.Cursor.cursor { get; set; }
      Efl.Ui.Cursor.cursor_style { get; set; }
      Efl.Ui.Cursor.cursor_theme_search_enabled { get; set; }
   }
   events {
      moved; [[Called when widget moved]]
      focused; [[Called when widget was focused]]
      unfocused; [[Called when widget was unfocused]]
      language,changed; [[Called when widget language changed]]
      access,changed; [[Called when accessibility changed]]
   }
}