summaryrefslogtreecommitdiff
path: root/src/lib/edje/edje_object.eo
blob: 9e08693b6c62dadf91314d1f67dcb5a57f592739 (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
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
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
import edje_types;

// FIXME: This EO doc needs a direct link to the "edcref" doc

class Edje.Object (Efl.Canvas.Group.Clipped, Efl.File, Efl.Container, Efl.Part,
                   Efl.Observer)
{
   [[Edje object class]]
   legacy_prefix: edje_object;
   eo_prefix: edje_obj;
   event_prefix: edje_object;
   data: Edje;
   methods {
      @property mirrored {
         set {
            [[Sets the RTL orientation for this object.

              @since 1.1.0]]
         }
         get {
            [[Gets the RTL orientation for this object.

              You can RTL orientation explicitly with edje_object_mirrored_set.

              @since 1.1.0]]
         }
         values {
            rtl: bool; [[New value of flag $true/$false]]
         }
      }
      @property language {
         set {
            [[Sets the language for this object.

              @since 1.1.0]]
         }
         get {
            [[Gets the language for this object.

              @since 1.1.0]]
         }
         values {
            language: string; [[The language value]]
          }
      }
      @property animation {
         [[Whether this object is animating or not.

           This property indicates whether animations are stopped or not.
           Animations here refer to transitions between states.

           If animations are disabled, transitions between states (as
           defined in EDC) are then instantaneous. This is conceptually similar
           to setting the @.transition_duration_factor to an infinitely high
           value.
         ]]
         get {
            [[Get the current state of animation, $true by default.]]
         }
         set {
            [[Start or stop animating this object.]]
         }
         values {
            on: bool; [[The animation state, $true by default.]]
         }
      }
      @property play {
         [[Whether this object is playing or not.

           This property indicates whether the object is running or not. If
           stopped (or paused), all transitions are disabled and programs
           stop running, until resumed.

           If play is disabled, the object will remain the same, and its parts
           will not change state. Note that play can be disabled during a
           transition between states, effectively freezing the object in
           flight. When paused, no events will be processed or sent.

           Setting to $true resumes playing from the current state.
         ]]
         get {
            [[Get the current state of play, $true by default.]]
         }
         set {
            [[Start or stop playing programs in this object.]]
         }
         values {
            play: bool; [[The play state, $true by default.]]
         }
      }
      @property perspective {
         set {
            [[Sets the given perspective object on this Edje object.

              Make the given perspective object be the default perspective for this Edje
              object.

              There can be only one perspective object per Edje object, and if a
              previous one was set, it will be removed and the new perspective object
              will be used.

              An Edje perspective will only affect a part if it doesn't point to another
              part to be used as perspective.

              \@ref edje_object_perspective_new()
              See also @.perspective.get()
              \@ref edje_perspective_set()]]
            values {
                ps: ptr(Edje.Perspective); [[The perspective object that will be used.]]
            }
         }
         get {
            [[Gets the current perspective used on this Edje object.

              See also @.perspective.set()]]
            values {
                ps: ptr(const(Edje.Perspective)); [[The perspective object that will be used.]]
            }
         }
      }
      @property transition_duration_factor {
         [[Transition duration factor.

           This defines a multiplier for the duration of transitions as they
           are defined in EDC. By default this factor is 1.0, which means
           animations play at the same speed as described in EDC.
         ]]
         set {
            [[Sets transition duration factor.]]
         }
         get {
            [[Gets transition duration factor.]]
         }
         values {
            scale: double(1.0); [[The transition duration factor.]]
         }
      }

      // TODO: An Efl.Ui.Base class that contains mirrored, language, scale
      @property scale {
         set {
            [[Sets the scaling factor for a given Edje object.

              This function sets an  individual scaling factor on the  obj
              Edje object. This property (or Edje's global scaling factor, when
              applicable), will affect this object's part sizes. If scale is
              not zero, than the individual scaling will  override any global
              scaling set, for the object obj's parts. Put it back to zero to
              get the effects of the global scaling again.

              Warning: Only parts which, at EDC level, had the @"scale"
              property set to @1, will be affected by this function. Check the
              complete \@ref edcref "syntax reference" for EDC files.

              See also @.scale.get()
              \@ref edje_scale_get() for more details]]
            return: bool; [[$true on success, $false otherwise]]
         }
         get {
            [[Gets a given Edje object's scaling factor.

              This function returns the individual scaling factor set on the
               obj Edje object.

              See also @.scale.set() for more details]]
         }
         values {
            scale: double; [[The scaling factor (the default value is @0.0,
                             meaning individual scaling  not set)]]
         }
      }
      @property base_scale {
         get {
            [[Gets a given Edje object's base_scale factor.

              This function returns the base_scale factor set on the
               obj Edje object.
              The base_scale can be set in the collection of edc.
              If it isn't set, the default value is 1.0]]
         }
         values {
            base_scale: double(1.0); [[The base_scale factor (the default value is @ 1.0,
                                  that means the edc file is made based on scale 1.0.]]
         }
      }

      // TODO: Legacy only. EO may rely on futures.
      preload {
         [[Preloads the images on the Edje Object in the background.

           This function requests the preload of all data images (on the given
           object) in the background. The work is queued before being processed
           (because there might be other pending requests of this type).
           It emits a signal "preload,done" when finished.

           Note: Use $true on scenarios where you don't need
           the image data preloaded anymore.]]

         return: bool; [[$false if obj was not a valid Edje object
                         otherwise $true]]
         params {
            @in cancel: bool; [[$false will add it the preloading work queue,
                                $true will remove it (if it was issued before).]]
         }
      }
      @property load_error {
         get {
            [[Gets the (last) file loading error for a given Edje object

              This function is meant to be used after an Edje EDJ file
              loading, what takes place with the $file_set() function. If that
              function does not return $true, one should check for the reason
              of failure with this one.
            ]]
            legacy: null;
         }
         values {
            error: Efl.Image.Load.Error(Efl.Image.Load.Error.generic);
               [[The load error code.]]
         }
      }

      /* EDJE CALC APIS BEGIN ---------------------------------------------- */
      @property calc_update_hints {
         [[Whether this object updates its size hints automatically.

           By default edje doesn't set size hints on itself. If this property
           is set to $true, size hints will be updated after recalculation.
           Be careful, as recalculation may happen often, enabling this
           property may have a considerable performance impact as other widgets
           will be notified of the size hints changes.

           A layout recalculation can be triggered by @.size_min_calc(),
           @.size_min_restricted_calc(), @.parts_extends_calc() or even any
           other internal event.
         ]]
         set {
            [[Enable or disable auto-update of size hints.]]
            legacy: edje_object_update_hints_set;
         }
         get {
            [[Whether this object updates its size hints automatically.]]
            legacy: edje_object_update_hints_get;
         }
         values {
            update: bool(false); [[Whether or not update the size hints.]]
         }
      }
      // FIXME: Prefix with calc_ ?
      size_min_calc {
         [[Calculates the minimum required size for a given Edje object.

           This call works exactly as edje_object_size_min_restricted_calc(),
           with the last two arguments set to 0. Please refer to its
           documentation, then.
         ]]
         // FIXME: Return a 2D size type (no @out values)
         params {
            @out minw: int; [[The minimum required width (return value)]]
            @out minh: int; [[The minimum required height (return value)]]
         }
      }
      // FIXME: Prefix with calc_ ?
      size_min_restricted_calc {
         [[Calculates the minimum required size for a given Edje object.

           This call will trigger an internal recalculation of all parts of
           the object, in order to return its minimum required dimensions for
           width and height. The user might choose to impose those minimum
           sizes, making the resulting calculation to get to values equal or
           larger than $restrictedw and $restrictedh, for width and height,
           respectively.

           Note: At the end of this call, the object  won't be automatically
           resized to the new dimensions, but just return the calculated sizes.
           The caller is the one up to change its geometry or not.

           Warning: Be advised that invisible parts in the object will be taken
           into account in this calculation.
         ]]
         // FIXME: Return a 2D size type (no @out values)
         params {
            @out minw: int; [[The minimum required width (return value)]]
            @out minh: int; [[The minimum required height (return value)]]
            @in restrictedw: int; [[The minimum width constraint as input,
                                    $minw can not be lower than this]]
            @in restrictedh: int; [[The minimum height constraint as input,
                                    $minh can not be lower than this]]
         }
      }
      // FIXME: Prefix with calc_ ?
      parts_extends_calc {
         [[Calculates the geometry of the region, relative to a given Edje
           object's area, occupied by all parts in the object.

           This function gets the geometry of the rectangle equal to the area
           required to group all parts in obj's group/collection. The x
           and y coordinates are relative to the top left corner of the
           whole obj object's area. Parts placed out of the group's
           boundaries will also be taken in account, so that x and y
           may be negative.

           Note: On failure, this function will make all non-$null geometry
           pointers' pointed variables be set to zero.
         ]]
         return: bool; [[$true on success, $false otherwise]]
         /* FIXME: Return a 2D size type (no @out values) */
         params {
            @out x: int; [[The parts region's X coordinate]]
            @out y: int; [[The parts region's Y coordinate]]
            @out w: int; [[The parts region's width]]
            @out h: int; [[The parts region's height]]
         }
      }
      calc_force {
         [[Forces a Size/Geometry calculation.

           Forces the object to recalculate its layout regardless of
           freeze/thaw.

           See also @.calc_freeze and @.calc_thaw.
         ]]
      }
      calc_freeze {
         [[Freezes the Edje object.

           This function puts all changes on hold. Successive freezes will
           nest, requiring an equal number of thaws.

           See also @.calc_thaw()
         ]]
         return: int; [[The frozen state or 0 on error]]
         legacy: edje_object_freeze;
      }
      calc_thaw {
         [[Thaws the Edje object.

           This function thaws the given Edje object.

           Note: If sucessive freezes were done, an equal number of thaws will
           be required.

           See also @.calc_freeze()
         ]]
         return: int; [[The frozen state or 0 if the object is not frozen or on error.]]
         legacy: edje_object_thaw;
      }
      /* EDJE CALC APIS END ------------------------------------------------ */

      /* EDJE GROUP DATA APIS BEGIN ---------------------------------------- */
      @property group_size_min {
         get {
            [[Gets the minimum size specified -- as an EDC property -- for a
              given Edje object

              This function retrieves the obj object's minimum size values,
              as declared in its EDC group definition. For instance, for an
              Edje object of minimum size 100x100 pixels:
              collections {
                 group {
                    name: "a_group";
                    min: 100 100;
                 }
              }

              Note: If the $min EDC property was not declared for this object,
              this call will return 0x0.

              Note: On failure, this function also return 0x0.

              See also @.group_size_max.
            ]]
            legacy: edje_object_size_min_get;
         }
         values {
            minw: int; [[Pointer to a variable where to store the minimum width]]
            minh: int; [[Pointer to a variable where to store the minimum height]]
         }
      }
      @property group_size_max {
         get {
            [[Gets the maximum size specified -- as an EDC property -- for a
              given Edje object

              This function retrieves the object's maximum size values,
              as declared in its EDC group definition. For instance, for an
              Edje object of maximum size 100x100 pixels:
              collections {
                 group {
                    name: "a_group";
                    max: 100 100;
                 }
              }

              Note: If the $max EDC property was not declared for the object,
              this call will return the maximum size a given Edje object may
              have, for each axis.

              Note: On failure, this function will return 0x0.

              See also @.group_size_min.
            ]]
            legacy: edje_object_size_max_get;
         }
         values {
            maxw: int; [[The maximum width]]
            maxh: int; [[The maximum height]]
         }
      }
      @property group_data {
         get {
            [[Retrives an EDC data field's value from a given Edje object's group.

              This function fetches an EDC data field's value, which is declared
              on the objects building EDC file, under its group. EDC data blocks
              are most commonly used to pass arbitrary parameters from an
              application's theme to its code.

              EDC data fields always hold  strings as values, hence the return
              type of this function. Check the complete "syntax reference"
              for EDC files.

              This is how a data item is defined in EDC:
              collections {
                 group {
                    name: "a_group";
                    data {
                       item: "key1" "value1";
                       item: "key2" "value2";
                    }
                 }
              }

              Warning: Do not confuse this call with edje_file_data_get(), which
              queries for a global EDC data field on an EDC declaration file.
            ]]
            legacy: edje_object_data_get;
         }
         keys {
            key: string; [[The data field's key string]]
         }
         values {
            val: string; [[The data's value string.]]
         }
      }
      /* EDJE GROUP DATA APIS END ------------------------------------------ */

      /* MESSAGE & SIGNAL APIS BEGIN --------------------------------------- */
      message_send {
         [[Sends an (Edje) message to a given Edje object

           This function sends an Edje message to obj and to all of its
           child objects, if it has any (swallowed objects are one kind of
           child object). Only a few types are supported:
             - int,
             - float/double,
             - string/stringshare,
             - arrays of int, float, double or strings.

           The id argument as a form of code and theme defining a common
           interface on message communication. One should define the same IDs
           on both code and EDC declaration, to individualize messages
           (binding them to a given context).
         ]]
         params {
            @in id: int; [[A identification number for the message to be sent]]
            @in msg: const(generic_value); [[The message's payload]]
         }
         legacy: null;
      }
      signal_callback_add {
         [[Adds a callback for an arriving Edje signal, emitted by
           a given Edje object.

           Edje signals are one of the communication interfaces between
            code and a given Edje object's theme. With signals, one can
           communicate two string values at a time, which are:
           - "emission" value: the name of the signal, in general
           - "source" value: a name for the signal's context, in general

           Though there are those common uses for the two strings, one is free
           to use them however they like.

           Signal callback registration is powerful, in the way that  blobs
           may be used to match multiple signals at once. All the
           "*?[\" set of $fnmatch() operators can be used, both for
           emission and source.

           Edje has  internal signals it will emit, automatically, on
           various actions taking place on group parts. For example, the mouse
           cursor being moved, pressed, released, etc., over a given part's
           area, all generate individual signals.

           By using something like
           edje_object_signal_callback_add(obj, "mouse,down,*", "button.*",
           signal_cb, NULL);
           being \@ref "button.*" the pattern for the names of parts implementing
           buttons on an interface, you'd be registering for notifications on
           events of mouse buttons being pressed down on either of those parts
           (those events all have the @"mouse,down," common prefix on their
           names, with a suffix giving the button number). The actual emission
           and source strings of an event will be passed in as the  emission
           and  source parameters of the callback function (e.g.
           "mouse,down,2" and @"button.close"), for each of those events.

           Note: See \@ref edcref "the syntax" for EDC files
           See also @.signal_emit() on how to emits Edje signals from
           code to a an object
           \@ref edje_object_signal_callback_del_full()]]
           /* FIXME-doc
            * This function adds a callback function to a signal emitted by  obj, to
            * be issued every time an EDC program like the following
            * @code
            * program
            *   {
            *      name: "emit_example";
            *      action: SIGNAL_EMIT "a_signal" "a_source";
            *   }
            * @endcode
            * is run, if emission and source are given those same values,
            * here.
            */

         params {
            @in emission: string; [[The signal's "emission" string]]
            @in source: string; [[The signal's "source" string]]
            @in func: Edje.Signal_Cb; [[The callback function to be executed when the signal is
                                        emitted.]]
            @in data: void_ptr; [[A pointer to data to pass in to func.]]
         }
      }
      signal_callback_del {
         [[Removes a signal-triggered callback from an object.

           This function removes a callback, previously attached to the
           emission of a signal, from the object  obj. The parameters
           emission,  source and  func must match exactly those passed to
           a previous call to edje_object_signal_callback_add(). The data
           pointer that was passed to this call will be returned.

           See also @.signal_callback_add().
           \@ref edje_object_signal_callback_del_full().]]

         legacy: null;
         return: void_ptr; [[The data pointer]]
         params {
            @in emission: string; [[The emission string.]]
            @in source: string; [[The source string.]]
            @in func: Edje.Signal_Cb; [[The callback function.]]
            @in data: void_ptr; [[The callback function.]]
         }
      }
      signal_emit {
         [[Sends/emits an Edje signal to a given Edje object

           This function sends a signal to the object  obj. An Edje program,
           at obj's EDC specification level, can respond to a signal by
           having declared matching @'signal' and @'source' fields on its
           block (see \@ref edcref "the syntax" for EDC files).

           See also @.signal_callback_add() for more on Edje signals.]]
           /* FIXME-doc
            * @code
            * program
            *   {
            *      name: "a_program";
            *      signal: "a_signal";
            *      source: "";
            *      action: ...
            *   }
            * @endcode
            */
         params {
            @in emission: string; [[The signal's "emission" string]]
            @in source: string; [[The signal's "source" string]]
         }
      }
      message_signal_process {
         [[Processes an object's message queue.

           This function goes through the object message queue processing the
           pending messages for this specific Edje object. Normally they'd
           be processed only at idle time.

           If $recurse is $true, this function will be called recursively
           on all subobjects.
         ]]
         params {
            recurse: bool @optional; [[Whether to process messages on children
                                       objects.]]
         }
         legacy: null;
      }
      /* MESSAGE & SIGNAL APIS END ----------------------------------------- */

      /* CLASS APIS BEGIN -------------------------------------------------- */
      @property global_color_class @class {
         set {
            [[Sets Edje color class.

              This function sets the color values for a process level color
              class.  This will cause all edje parts in the current process that
              have the specified color class to have their colors multiplied by
              these values.  (Object level color classes set by
              edje_object_color_class_set() will override the values set by this
              function).

              Setting color emits a signal "color_class,set" with source being
              the given color class in all objects.

              Note: unlike Evas, Edje colors are not pre-multiplied. That is,
              half-transparent white is 255 255 255 128.]]
            legacy: null;
            return: bool; [[$true on success, $false otherwise]]
         }
         get {
            [[Gets Edje color class.

              This function gets the color values for a process level color
              class. This value is the globally set and not per-object, that is,
              the value that would be used by objects if they did not override with
              @.color_class.set().

              See also, @.global_color_class.set()

              Note: unlike Evas, Edje colors are not pre-multiplied. That is,
              half-transparent white is 255 255 255 128.]]
            legacy: null;
            return: bool; [[$true if found or $false if not found and all values
                            are zeored.]]
         }
         keys {
            color_class: string; [[The name of color class]]
            mode: Edje.Color_Class.Mode; [[Edje color class mode]]
         }
         values {
            r: int; [[Object Red value]]
            g: int; [[Object Green value]]
            b: int; [[Object Blue value]]
            a: int; [[Object Alpha value]]
         }
      }
      @property color_class {
         set {
            [[Sets the object color class.

              This function sets the color values for an object level color
              class. This will cause all edje parts in the specified object that
              have the specified color class to have their colors multiplied by
              these values.

              The first color is the object, the second is the text outline, and
              the third is the text shadow. (Note that the second two only apply
              to text parts).

              Setting color emits a signal "color_class,set" with source being
              the given color.

              Note: unlike Evas, Edje colors are not pre-multiplied. That is,
              half-transparent white is 255 255 255 128.]]
            legacy: null;
            return: bool; [[$true on success, $false otherwise]]
         }
         get {
            [[Gets the object color class.

              This function gets the color values for an object level color
              class. If no explicit object color is set, then global values will
              be used.

              The first color is the object, the second is the text outline, and
              the third is the text shadow. (Note that the second two only apply
              to text parts).

              Note: unlike Evas, Edje colors are not pre-multiplied. That is,
              half-transparent white is 255 255 255 128.]]
            legacy: null;
            return: bool; [[$true if found or $false if not found and all
                            values are zeroed.]]
         }
         keys {
            color_class: string; [[The name of color class]]
            mode: Edje.Color_Class.Mode; [[Edje color class mode]]
         }
         values {
            r: int; [[Object Red value]]
            g: int; [[Object Green value]]
            b: int; [[Object Blue value]]
            a: int; [[Object Alpha value]]
         }
      }
      @property color_class_description {
         get {
            [[Gets the description of an object color class.

              This function gets the description of a color class in use by an object.]]
            return: string; [[The description of the target color class or $null if not found]]
         }
         keys {
            color_class: string; [[Color class description]]
         }
      }
      color_class_clear @const {
         [[Clears object color classes.

           @since 1.17.0]]
         return: bool; [[$true on success, or $false on error]]
      }
      color_class_del {
         [[Deletes the object color class.

           This function deletes any values at the object level for the
           specified object and color class.

           Deleting the color class will revert it to the values
           defined by edje_color_class_set() or the color class
           defined in the theme file.

           Deleting the color class will emit the signal "color_class,del"
           for the given Edje object.]]
         params {
            @in color_class: string; [[The color class to be deleted.]]
         }
      }
      @property text_class {
         set {
            [[Sets Edje text class.

              This function sets the text class for the Edje.]]
            return: bool; [[$true on success, or $false on error]]
         }
         get {
            [[Gets font and font size from edje text class.

              This function gets the font and the font size from the object
              text class. The font string will only be valid until the text
              class is changed or the edje object is deleted.]]
            return: bool; [[$true on success, or $false on error]]
         }
         keys {
            text_class: string; [[The text class name]]
         }
         values {
            font: string; [[Font name]]
            size: int; [[Font Size]]
         }
      }
      text_class_del {
         [[Deletes the object text class.

           This function deletes any values at the object level for the
           specified object and text class.

           Deleting the text class will revert it to the values
           defined by edje_text_class_set() or the text class
           defined in the theme file.

           @since 1.17]]
         params {
            @in text_class: string; [[The color class to be deleted.]]
         }
      }
      @property size_class {
         set {
            [[Sets the object size class.

              This function sets the min and max values for an object level size
              class. This will make all edje parts in the specified object that
              have the specified size class update their min and max size with given values.

              @since 1.17]]
            return: bool; [[$true on success, or $false on error]]
         }
         get {
            [[Gets the object size class.

              This function gets the min and max values for an object level size
              class. These values will only be valid until the size class is changed
              or the edje object is deleted.

              @since 1.17]]
            return: bool; [[$true on success, or $false on error]]
         }
         keys {
            size_class: string; [[The size class name]]
         }
         values {
            minw: int; [[The min width]]
            minh: int; [[The min height]]
            maxw: int; [[The max width]]
            maxh: int; [[The max height]]
         }
      }
      size_class_del {
         [[Deletes the object size class.

           This function deletes any values at the object level for the
           specified object and size class.

           Deleting the size class will revert it to the values
           defined by edje_size_class_set() or the color class
           defined in the theme file.

           @since 1.17]]
         params {
            @in size_class: string; [[Size class name]]
         }
      }
      /* CLASS APIS END ---------------------------------------------------- */

      access_part_iterate {
         [[Iterates over all accessibility-enabled part names.]]
         legacy: null;
         return: free(own(iterator<string>), eina_iterator_free); [[Part name iterator]]
      }
      part_exists @const {
         [[Checks if a part exists in a given Edje object's group definition.

           This function returns if a given part exists in the Edje group
           bound to this object (with @Efl.File.file.set()).

           This call is useful, for example, when one could expect or not a
           given GUI element, depending on the theme applied to the object.

           Note: @Efl.Part.part() called on an Edje object will return $null
           if it doesn't contain the given part.
         ]]
         return: bool; [[$true if the Edje part exists in obj's group, or
                         $false otherwise (and on errors)]]
         params {
            @in part: string; [[The part's name to check for existence in obj's
                                group]]
         }
      }

      /* TEXT PART APIS BEGIN ---------------------------------------------- */
      @property text_change_cb {
         set {
            [[Sets the object text callback.

              This function sets the callback to be called when the text changes.]]
         }
         values {
            func: Edje.Text.Change_Cb; [[The callback function to handle the text change]]
            data: void_ptr; [[The data associated to the callback function.]]
         }
      }
      @property part_text {
         set {
            [[Sets the text for an object part]]
            return: bool; [[$true on success, $false otherwise]]
         }
         get {
            [[Returns the text of the object part.

              This function returns the text associated to the object part.

              See also @.part_text.set().]]
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            text: string; [[The text string]]
         }
      }
      @property part_text_escaped {
         set {
            [[Sets the text for an object part, but converts HTML escapes to UTF8

              This converts the given string text to UTF8 assuming it contains HTML
              style escapes like "&amp;" and "&copy;" etc. IF the part is of type TEXT,
              as opposed to TEXTBLOCK.

              @since 1.2]]
            return: bool; [[$true on success, $false otherwise]]
         }
         values {
            part: string; [[The part name]]
            text: string; [[The text string]]
         }
      }
      @property part_text_unescaped {
         set {
            [[Sets the raw (non escaped) text for an object part.

              This function will not do escape for you if it is a TEXTBLOCK part, that is,
              if text contain tags, these tags will not be interpreted/parsed by TEXTBLOCK.

              See also @.part_text_unescaped.get().]]
            return: bool; [[$true on success, $false otherwise]]
            values {
               text_to_escape: string; [[The text string]]
            }
         }
         get {
            [[Returns the text of the object part, without escaping.

              This function is the counterpart of
              @.part_text_unescaped.set(). Please notice that the
              result is newly allocated memory and should be released with free()
              when done.

              See also @.part_text_unescaped.set().]]
            values {
               text_to_escape: own(ptr(char)); [[The text string]]
            }
         }
         keys {
            part: string; [[The part name]]
         }
      }
      part_text_append {
         [[Inserts text for an object part.

           This function inserts the text for an object part at the end; It does not
           move the cursor.

           @since 1.1]]

         params {
            @in part: string; [[The part name]]
            @in text: string; [[The text string]]
         }
      }
      part_text_insert {
         [[Inserts text for an object part.

           This function inserts the text for an object part just before the
           cursor position.]]

         params {
            @in part: string; [[The part name]]
            @in text: string; [[The text string]]
         }
      }
      part_text_user_insert @const {
         [[This function inserts text as if the user has inserted it.

           This means it actually registers as a change and emits signals, triggers
           callbacks as appropriate.

           @since 1.2.0]]
         params {
            @in part: string; [[The part name]]
            @in text: string; [[The text string]]
         }
      }
      @property part_text_autocapital_type {
         set {
            [[Sets the autocapitalization type on the immodule.

              @since 1.1.0]]
         }
         get {
            [[Retrieves the autocapitalization type

              @since 1.1.0]]
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            autocapital_type: Edje.Text.Autocapital_Type; [[The type of autocapitalization]]
         }
      }
      @property part_text_prediction_allow {
         set {
            [[Sets whether the prediction is allowed or not.

              @since 1.2.0]]
         }
         get {
            [[Gets whether the prediction is allowed or not.

              @since 1.2.0]]
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            prediction: bool; [[If $true, the prediction feature is allowed.]]
         }
      }
      part_text_hide_visible_password {
         [[Hides visible last character for password mode.

           @since 1.18.0]]
         params {
            @in part: string; [[The part name]]
         }
         return: bool; [[$true if the visible character is hidden. $false if there is no visible character or the object is not set for password mode.]]
      }
      @property part_text_cursor_begin {
         set {
            [[Moves the cursor to the beginning of the text part
              \@ref evas_textblock_cursor_paragraph_first]]
         }
         values {
            part: string; [[The part name]]
            cur: Edje.Cursor; [[The edje cursor to work on]]
         }
      }
      @property part_text_cursor_end {
         set {
            [[Moves the cursor to the end of the text part.
              \@ref evas_textblock_cursor_paragraph_last]]
         }
         values {
            part: string; [[The part name]]
            cur: Edje.Cursor; [[The edje cursor to work on]]
         }
      }
      @property part_text_cursor_line_begin {
         set {
            [[Moves the cursor to the beginning of the line.
              \@ref evas_textblock_cursor_line_char_first]]
         }
         values {
            part: string; [[The part name]]
            cur: Edje.Cursor; [[The edje cursor to work on]]
         }
      }
      @property part_text_cursor_line_end {
         set {
            [[Moves the cursor to the end of the line.
              \@ref evas_textblock_cursor_line_char_last]]
         }
         values {
            part: string; [[The part name]]
            cur: Edje.Cursor; [[The edje cursor to work on]]
         }
      }
      part_text_cursor_prev {
         [[Moves the cursor to the previous char
           \@ref evas_textblock_cursor_char_prev]]

         return: bool; [[$true on success, $false otherwise]]
         params {
            @in part: string; [[The part name]]
            @in cur: Edje.Cursor; [[The edje cursor to work on]]
         }
      }
      part_text_cursor_next {
         [[Advances the cursor to the next cursor position.
           \@ref evas_textblock_cursor_char_next]]

         return: bool; [[$true on success, $false otherwise]]
         params {
            @in part: string; [[The part name]]
            @in cur: Edje.Cursor; [[The edje cursor to advance]]
         }
      }
      part_text_cursor_up {
         [[Moves the cursor to the char above the current cursor position.]]

         return: bool; [[$true on success, $false otherwise]]
         params {
            @in part: string; [[The part name]]
            @in cur: Edje.Cursor; [[The edje cursor to work on]]
         }
      }
      part_text_cursor_down {
         [[Moves the cursor to the char below the current cursor position.]]

         return: bool; [[$true on success, $false otherwise]]
         params {
            @in part: string; [[The part name]]
            @in cur: Edje.Cursor; [[The edje cursor to work on]]
         }
      }
      @property part_text_cursor_geometry {
         get {
            [[Returns the cursor geometry of the part relative to the edje
              object.]]
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            x: int; [[Cursor X position]]
            y: int; [[Cursor Y position]]
            w: int; [[Cursor width]]
            h: int; [[Cursor height]]
         }
      }
      @property part_text_cursor_coord {
         set {
            [[Position the given cursor to a X,Y position.

              This is frequently used with the user cursor.]]

            return: bool; [[$true on success, $false otherwise]]
         }
         values {
            part: string; [[The part containing the object.]]
            cur: Edje.Cursor; [[The cursor to adjust.]]
            x: int; [[X Coordinate.]]
            y: int; [[Y Coordinate.]]
         }
      }
      @property part_text_cursor_pos {
         set {
            [[Sets the cursor position to the given value

              @since 1.1.0]]
         }
         get {
            [[Retrieves the current position of the cursor

              @since 1.1.0]]
         }
         keys {
            part: string; [[The part name]]
            cur: Edje.Cursor; [[The cursor to move]]
         }
         values {
            pos: int; [[The position of the cursor]]
         }
      }
      part_text_cursor_copy {
         [[Copies the cursor to another cursor.]]

         params {
            @in part: string; [[The part name]]
            @in src: Edje.Cursor; [[The cursor to copy from]]
            @in dst: Edje.Cursor; [[The cursor to copy to]]
         }
      }
      @property part_text_cursor_content {
         get {
            [[Returns the content (char) at the cursor position.
              \@ref evas_textblock_cursor_content_get

              You must free the return (if not $null) after you are done with it.]]
            return: own(ptr(char)); [[The character string pointed to (may be a multi-byte utf8 sequence) terminated by a null byte.]]
         }
         keys {
            part: string; [[The part name]]
            cur: Edje.Cursor; [[The cursor to use]]
         }
      }
      @property part_text_cursor_is_format {
         get {
            [[Returns whether the cursor points to a format.
              \@ref evas_textblock_cursor_is_format]]
            return: bool; [[$true if the cursor points to a format, $false otherwise.]]
         }
         keys {
            part: string; [[The part name]]
            cur: Edje.Cursor; [[The cursor to adjust.]]
         }
      }
      @property part_text_cursor_is_visible_format {
         get {
            [[Returns $true if the cursor points to a visible format
              For example \\t, \\n, item and etc.
              \@ref evas_textblock_cursor_format_is_visible_get]]
            return: bool; [[$true if the cursor points to a visible format, $false otherwise.]]
         }
         keys {
            part: string; [[The part name]]
            cur: Edje.Cursor; [[The cursor to adjust.]]
         }
      }
      @property item_provider {
         set {
            [[Sets the function that provides item objects for named items in an edje entry text

              Item objects may be deleted any time by Edje, and will be deleted when the
              Edje object is deleted (or file is set to a new file).]]
         }
         values {
            func: Edje.Item_Provider_Cb; [[The function to call (or $null to disable) to get item objects]]
            data: void_ptr; [[The data pointer to pass to the func callback]]
         }
      }
      @property part_text_select_allow {
         set {
            [[Enables selection if the entry is an EXPLICIT selection mode
              type.

              The default is to  not allow selection. This function only affects user
              selection, functions such as edje_object_part_text_select_all() and
              edje_object_part_text_select_none() are not affected.]]
            legacy: null;
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            allow: bool; [[$true to enable, $false otherwise]]
         }
      }
      part_text_select_begin @const {
         [[Starts selecting at current cursor position]]
         params {
            @in part: string; [[The part name]]
         }
      }
      part_text_select_abort @const {
         [[Aborts any selection action on a part.]]
         params {
            @in part: string; [[The part name]]
         }
      }
      part_text_select_extend @const {
         [[Extends the current selection to the current cursor position]]
         params {
            @in part: string; [[The part name]]
         }
      }
      part_text_select_all @const {
         [[Sets the selection to be everything.

           This function selects all text of the object of the part.]]
         params {
            @in part: string; [[The part name]]
         }
      }
      part_text_select_none @const {
         [[Sets the selection to be none.

           This function sets the selection text to be none.]]
         params {
            @in part: string; [[The part name]]
         }
      }
      @property part_text_selection {
         get {
            [[Returns the selection text of the object part.

              This function returns selection text of the object part.

              See also @.part_text_select_all() and @.part_text_select_none()]]
            return: string; [[The text string]]
         }
         keys {
            part: string; [[The part name]]
         }
      }
      @property part_text_imf_context {
         get {
            [[Gets the input method context in entry.

              If ecore_imf was not available when edje was compiled, this function returns $null
              otherwise, the returned pointer is an Ecore_IMF

              @since 1.2.0]]
            return: void_ptr; [[The input method context (Ecore_IMF_Context *) in entry]]
         }
         keys {
            part: string; [[The part name]]
         }
      }
      part_text_imf_context_reset @const {
         [[Resets the input method context if needed.

           This can be necessary in the case where modifying the buffer would confuse on-going input method behavior

           @since 1.2.0]]
         params {
            @in part: string; [[The part name]]
         }
      }
      part_text_style_user_peek @const {
         [[Returns the text of the object part.

           This function returns the style associated with the textblock part.

           @since 1.2.0]]
         return: string; [[The text string]]
         params {
            @in part: string; [[The part name]]
         }
      }
      part_text_style_user_push {
         [[Sets the style of the

           This function sets the style associated with the textblock part.

           @since 1.2.0]]

         params {
            @in part: string; [[The part name]]
            @in style: string; [[The style to set (textblock conventions).]]
         }
      }
      part_text_style_user_pop {
         [[Deletes the top style form the user style stack.

           @since 1.2.0]]

         params {
            @in part: string; [[The part name]]
         }
      }
      @property part_text_input_hint {
         set {
            [[Sets the input hint which allows input methods to fine-tune their behavior.

              @since 1.12.0]]
         }
         get {
            [[Gets the value of input hint

              @since 1.12.0]]
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            input_hints: Edje.Input_Hints; [[Input hints]]
         }
      }
      part_text_input_panel_show @const {
         [[Shows the input panel (virtual keyboard) based on the input panel property such as layout, autocapital types, and so on.

           Note that input panel is shown or hidden automatically according to the focus state.
           This API can be used in the case of manually controlling by using edje_object_part_text_input_panel_enabled_set.

           @since 1.2.0]]
         params {
            @in part: string; [[The part name]]
         }
      }
      part_text_input_panel_hide @const {
         [[Hides the input panel (virtual keyboard).
           See also @.part_text_input_panel_show

           Note that input panel is shown or hidden automatically according to the focus state.
           This API can be used in the case of manually controlling by using edje_object_part_text_input_panel_enabled_set.

           @since 1.2.0]]
         params {
            @in part: string; [[The part name]]
         }
      }
      @property part_text_input_panel_imdata {
         set {
            [[Sets the input panel-specific data to deliver to the input panel.

              This API is used by applications to deliver specific data to the input panel.
              The data format MUST be negotiated by both application and the input panel.
              The size and format of data are defined by the input panel.

              @since 1.2.0]]
            keys {
               part: string; [[The part name]]
               data: const(void_ptr); [[The specific data to be set to the input panel.]]
            }
         }
         get {
            [[Gets the specific data of the current active input panel.

              @since 1.2.0]]
            return: void; [[FIXME: void needed here?]]
            keys {
               part: string; [[The part name]]
               data: void_ptr; [[The specific data to be set to the input panel.]]
            }
         }
         values {
            len: int; [[The length of data, in bytes, to send to the input panel]]
         }
      }
      @property part_text_input_panel_layout {
         set {
            [[Sets the layout of the input panel.

              The layout of the input panel or virtual keyboard can make it easier or
              harder to enter content. This allows you to hint what kind of input you
              are expecting to enter and thus have the input panel automatically
              come up with the right mode.

              @since 1.1]]
         }
         get {
            [[Gets the layout of the input panel.

              See also @.part_text_input_panel_layout.set

              @since 1.1]]
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            layout: Edje.Input_Panel.Layout; [[Layout type of the input panel]]
         }
      }
      @property part_text_input_panel_language {
         set {
            [[Sets the language mode of the input panel.

              This API can be used if you want to show the Alphabet keyboard.

              @since 1.2.0]]
         }
         get {
            [[Gets the language mode of the input panel.

              See also @.part_text_input_panel_language.set for more details.

              @since 1.2.0]]
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            lang: Edje.Input_Panel.Lang; [[The language to be set to the input panel.]]
         }
      }
      @property part_text_input_panel_layout_variation {
         set {
            [[Sets the layout variation of the input panel.

              The layout variation of the input panel or virtual keyboard can make it easier or
              harder to enter content. This allows you to hint what kind of input you
              are expecting to enter and thus have the input panel automatically
              come up with the right mode.

              @since 1.8]]
         }
         get {
            [[Gets the layout variation of the input panel.

              See also @.part_text_input_panel_layout_variation.set

              @since 1.8]]
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            variation: int; [[Layout variation type]]
         }
      }
      @property part_text_input_panel_enabled {
         set {
            [[Sets the attribute to show the input panel automatically.

              @since 1.1.0]]
         }
         get {
            [[Retrieves the attribute to show the input panel automatically.
              See also @.part_text_input_panel_enabled.set

              @since 1.1.0]]
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            enabled: bool; [[If $true, the input panel is appeared when entry is clicked or has a focus]]
         }
      }
      @property part_text_input_panel_return_key_disabled {
         set {
            [[Sets the return key on the input panel to be disabled.

              @since 1.2.0]]
         }
         get {
            [[Gets whether the return key on the input panel should be disabled or not.

              @since 1.2.0]]
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            disabled: bool; [[The state]]
         }
      }
      @property part_text_input_panel_return_key_type {
         set {
            [[Sets the "return" key type. This type is used to set string or icon on the "return" key of the input panel.

              An input panel displays the string or icon associated with this type

              @since 1.2.0]]
         }
         get {
            [[Gets the "return" key type.

              See also @.part_text_input_panel_return_key_type.set() for more details

              @since 1.2.0]]
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            return_key_type: Edje.Input_Panel.Return_Key_Type; [[The type of "return" key on the input panel]]
         }
      }
      @property part_text_input_panel_show_on_demand {
         set {
            [[Sets the attribute to show the input panel in case of only an user's explicit Mouse Up event.
              It doesn't request to show the input panel even though it has focus.

              @since 1.9.0]]
         }
         get {
            [[Gets the attribute to show the input panel in case of only an user's explicit Mouse Up event.

              @since 1.9.0]]
         }
         keys {
            part: string; [[The part name]]
         }
         values {
            ondemand: bool; [[If $true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.)]]
         }
      }
      @property part_text_anchor_geometry {
         get {
            [[Returns a list of Evas_Textblock_Rectangle anchor rectangles.

              This function return a list of Evas_Textblock_Rectangle anchor
              rectangles.]]
            return: const(list<ptr(const(Evas.Textblock_Rectangle))>); [[The list of anchor rects (const Evas_Textblock_Rectangle
                                                                     *), do not modify! Geometry is relative to entry part.]]
         }
         keys {
            part: string; [[The part name]]
            anchor: string; [[The anchor name]]
         }
      }
      @property part_text_anchor_list {
         get {
            [[Returns a list of char anchor names.

              This function returns a list of char anchor names.]]
            return: const(list<string>); [[The list of anchors (const char *), do not modify!]]
         }
         keys {
            part: string; [[The part name]]
         }
      }
      text_insert_filter_callback_add {
         [[Adds a filter function for newly inserted text.

           Whenever text is inserted (not the same as set) into the given part,
           the list of filter functions will be called to decide if and how the new
           text will be accepted.
           There are three types of filters, EDJE_TEXT_FILTER_TEXT,
           EDJE_TEXT_FILTER_FORMAT and EDJE_TEXT_FILTER_MARKUP.
           The text parameter in the func filter can be modified by the user and
           it's up to him to free the one passed if he's to change the pointer. If
           doing so, the newly set text should be malloc'ed, as once all the filters
           are called Edje will free it.
           If the text is to be rejected, freeing it and setting the pointer to $null
           will make Edje break out of the filter cycle and reject the inserted
           text.

           Warning: This function will be deprecated because of difficulty in use.
           The type(format, text, or markup) of text should be always
           checked in the filter function for correct filtering.
           Please use edje_object_text_markup_filter_callback_add() instead. There
           is no need to check the type of text in the filter function
           because the text is always markup.
           Warning: If you use this function with
           edje_object_text_markup_filter_callback_add() together, all
           Edje_Text_Filter_Cb functions and Edje_Markup_Filter_Cb functions
           will be executed, and then filtered text will be inserted.

           See also @.text_insert_filter_callback_del, @.text_insert_filter_callback_del_full
           and @.text_markup_filter_callback_add]]

         params {
            @in part: string; [[The part name]]
            @in func: Edje.Text.Filter_Cb; [[The callback function that will act as filter]]
            @in data: void_ptr; [[User provided data to pass to the filter function]]
         }
      }
      text_insert_filter_callback_del {
         [[Deletes a function from the filter list.

           Delete the given func filter from the list in part. Returns
           the user data pointer given when added.

           See also @.text_insert_filter_callback_add and @.text_insert_filter_callback_del_full]]

         return: void_ptr; [[The user data pointer if successful, or $null otherwise]]
         params {
            @in part: string; [[The part name]]
            @in func: Edje.Text.Filter_Cb; [[The function callback to remove]]
         }
      }
      text_insert_filter_callback_del_full {
         [[Deletes a function and matching user data from the filter list.

           Delete the given func filter and data user data from the list
           in part.
           Returns the user data pointer given when added.

           See also @.text_insert_filter_callback_add and @.text_insert_filter_callback_del]]

         return: void_ptr; [[The same data pointer if successful, or $null otherwise]]
         params {
            @in part: string; [[The part name]]
            @in func: Edje.Text.Filter_Cb; [[The function callback to remove]]
            @in data: void_ptr; [[The data passed to the callback function]]
         }
      }
      text_markup_filter_callback_add {
         [[Adds a markup filter function for newly inserted text.

           Whenever text is inserted (not the same as set) into the given part,
           the list of markup filter functions will be called to decide if and how
           the new text will be accepted.
           The text parameter in the func filter is always markup. It can be
           modified by the user and it's up to him to free the one passed if he's to
           change the pointer. If doing so, the newly set text should be malloc'ed,
           as once all the filters are called Edje will free it.
           If the text is to be rejected, freeing it and setting the pointer to $null
           will make Edje break out of the filter cycle and reject the inserted
           text.
           This function is different from edje_object_text_insert_filter_callback_add()
           in that the text parameter in the fucn filter is always markup.

           Warning: If you use this function with
           edje_object_text_insert_filter_callback_add() togehter, all
           Edje_Text_Filter_Cb functions and Edje_Markup_Filter_Cb functions
           will be executed, and then filtered text will be inserted.

           See also @.text_markup_filter_callback_del, @.text_markup_filter_callback_del_full
           and @.text_insert_filter_callback_add

           @since 1.2.0]]

         params {
            @in part: string; [[The part name]]
            @in func: Edje.Markup_Filter_Cb; [[The callback function that will act as markup filter]]
            @in data: void_ptr; [[User provided data to pass to the filter function]]
         }
      }
      text_markup_filter_callback_del {
         [[Deletes a function from the markup filter list.

           Delete the given func filter from the list in part. Returns
           the user data pointer given when added.

           See also @.text_markup_filter_callback_add and @.text_markup_filter_callback_del_full

           @since 1.2.0]]

         return: void_ptr; [[The user data pointer if successful, or $null otherwise]]
         params {
            @in part: string; [[The part name]]
            @in func: Edje.Markup_Filter_Cb; [[The function callback to remove]]
         }
      }
      text_markup_filter_callback_del_full {
         [[Deletes a function and matching user data from the markup filter list.

           Delete the given func filter and data user data from the list
           in part.
           Returns the user data pointer given when added.

           See also @.text_markup_filter_callback_add and @.text_markup_filter_callback_del

           @since 1.2.0]]

         return: void_ptr; [[The same data pointer if successful, or $null otherwise]]
         params {
            @in part: string; [[The part name]]
            @in func: Edje.Markup_Filter_Cb; [[The function callback to remove]]
            @in data: void_ptr; [[The data passed to the callback function]]
         }
      }
      @property part_text_item_geometry {
         get {
            [[Returns item geometry.

              This function return a list of Evas_Textblock_Rectangle item
              rectangles.]]
            return: bool; [[$1 if item exists, $0 if not]]
         }
         keys {
            part: string; [[The part name]]
            item: string; [[The item name]]
         }
         values {
            cx: int; [[Item x return (relative to entry part)]]
            cy: int; [[Item y return (relative to entry part)]]
            cw: int; [[Item width return]]
            ch: int; [[Item height return]]
         }
      }
      @property part_text_item_list {
         get {
            [[Returns a list of char item names.

              This function returns a list of char item names.]]
            return: const(list<string>); [[The list of items (const char *), do not modify!]]
         }
         keys {
            part: string; [[The part name]]
         }
      }
      /* TEXT PART APIS END ------------------------------------------------ */

      @property seat {
         get {
            [[Returns the seat device given its Edje's name.

              Edje references seats by a name that differs from Evas.
              Edje naming follows a incrementional convention: first
              registered name is "seat1", second is "seat2", differently
              from Evas.

              @since 1.19]]

            return: Efl.Input.Device; [[The seat device or $null if not found.]]
         }
         keys {
            name: stringshare; [[The name's character string.]]
         }
      }
      @property seat_name {
         get {
            [[Gets the name given to a set by Edje.

              Edje references seats by a name that differs from Evas.
              Edje naming follows a incrementional convention: first
              registered name is "seat1", second is "seat2", differently
              from Evas.

              @since 1.19]]

            return: stringshare; [[The name's character string or $null if not found.]]
         }
         keys {
            device: Efl.Input.Device; [[The seat device]]
         }
      }
   }
   implements {
      Efl.Gfx.visible { set; }
      Efl.Gfx.position { set; }
      Efl.Gfx.size { set; }
      Efl.Object.constructor;
      Efl.Object.destructor;
      Efl.Canvas.Object.no_render { set; }
      Efl.Canvas.Object.paragraph_direction { set; }
      Efl.Canvas.Group.group_calculate;
      Efl.File.file { get; set; }
      Efl.File.mmap { get; set; }
      Efl.Container.content_remove;
      Efl.Part.part;
      Efl.Observer.update;
   }
   events {
      recalc; [[Edje re-calculated the object.]]
   }
}