summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/evas_canvas.eo
blob: 6ce459e0c50066da74bef28db8fd5ec241fd7766 (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
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
class Evas.Canvas (Eo.Base, Evas.Common_Interface)
{
   legacy_prefix: evas;
   data: Evas_Public_Data;
   properties {
      output_framespace {
         set {
            /*@
            Sets the output framespace size of the render engine of the given evas.

            The framespace size is used in the Wayland engines to denote space where
            the output is not drawn. This is mainly used in ecore_evas to draw borders

            The units used for @p w and @p h depend on the engine used by the
            evas.

            @ingroup Evas_Output_Size
            @since 1.1 */
         }
         get {
            /*@
            Get the render engine's output framespace co-ordinates in canvas units.

            @ingroup Evas_Output_Size
            @since 1.1 */
         }
         values {
            Evas_Coord x; /*@ The left coordinate in output units, usually pixels. */
            Evas_Coord y; /*@ The top coordinate in output units, usually pixels. */
            Evas_Coord w; /*@ The width in output units, usually pixels. */
            Evas_Coord h; /*@ The height in output units, usually pixels. */
         }
      }
      output_viewport {
         set {
            /*@
            Sets the output viewport of the given evas in evas units.

            The output viewport is the area of the evas that will be visible to
            the viewer.  The viewport will be stretched to fit the output
            target of the evas when rendering is performed.

            @note The coordinate values do not have to map 1-to-1 with the output
            target.  However, it is generally advised that it is done for ease
            of use.

            @ingroup Evas_Output_Size */
         }
         get {
            /*@
            Get the render engine's output viewport co-ordinates in canvas units.
            Calling this function writes the current canvas output viewport
            size and location values into the variables pointed to by @p x, @p
            y, @p w and @p h.  On success the variables have the output
            location and size values written to them in canvas units. Any of @p
            x, @p y, @p w or @p h that are @c NULL will not be written to. If @p e
            is invalid, the results are undefined.

            Example:
            @code
            extern Evas *evas;
            Evas_Coord x, y, width, height;

            evas_output_viewport_get(evas, &x, &y, &w, &h);
            @endcode */
         }
         values {
            Evas_Coord x; /*@ The top-left corner x value of the viewport. */
            Evas_Coord y; /*@ The top-left corner y value of the viewport. */
            Evas_Coord w; /*@ The width of the viewport.  Must be greater than 0. */
            Evas_Coord h; /*@ The height of the viewport.  Must be greater than 0. */
         }
      }
      image_cache {
         set {
            /*@
            Set the image cache.

            This function sets the image cache of canvas in bytes. */
         }
         get {
            /*@
            Get the image cache

            This function returns the image cache size of canvas in bytes. */
         }
         values {
            int size; /*@ The cache size. */
         }
      }
      event_default_flags {
         set {
            /*@
            Set the default set of flags an event begins with

            Events in evas can have an event_flags member. This starts out with
            and initial value (no flags). This lets you set the default flags that
            an event begins with to be @p flags

            @since 1.2 */
         }
         get {
            /*@
            Get the default set of flags an event begins with

            @return The default event flags for that canvas

            This gets the default event flags events are produced with when fed in.

            @see evas_event_default_flags_set()
            @since 1.2 */
         }
         values {
            Evas_Event_Flags flags; /*@ The default flags to use */
         }
      }
      output_method {
         set {
            /*@
            Sets the output engine for the given evas.

            Once the output engine for an evas is set, any attempt to change it
            will be ignored.  The value for @p render_method can be found using
            @ref evas_render_method_lookup .

            @attention it is mandatory that one calls evas_init() before
            setting the output method.

            @ingroup Evas_Output_Method */
         }
         get {
            /*@
            Retrieves the number of the output engine used for the given evas.
            @return  The ID number of the output engine being used.  @c 0 is
            returned if there is an error.
            @ingroup Evas_Output_Method */
         }
         values {
            int render_method; /*@ The numeric engine value to use. */
         }
      }
      font_cache {
         set {
            /*@
            Changes the size of font cache of the given evas.

            @ingroup Evas_Font_Group */
         }
         get {
            /*@
            Changes the size of font cache of the given evas.

            @return The size, in bytes.

            @ingroup Evas_Font_Group */
         }
         values {
            int size; /*@ The size, in bytes. */
         }
      }
      output_size {
         set {
            /*@
            Sets the output size of the render engine of the given evas.

            The evas will render to a rectangle of the given size once this
            function is called.  The output size is independent of the viewport
            size.  The viewport will be stretched to fill the given rectangle.

            The units used for @p w and @p h depend on the engine used by the
            evas.

            @ingroup Evas_Output_Size */
         }
         get {
            /*@
            Retrieve the output size of the render engine of the given evas.

            The output size is given in whatever the output units are for the
            engine.

            If either @p w or @p h is @c NULL, then it is ignored.  If @p e is
            invalid, the returned results are undefined.

            @ingroup Evas_Output_Size */
         }
         values {
            int w; /*@ The width in output units, usually pixels. */
            int h; /*@ The height in output units, usually pixels. */
         }
      }
      data_attach {
         set {
            /*@
            Attaches a specific pointer to the evas for fetching later

            @ingroup Evas_Canvas */
         }
         get {
            /*@
            Returns the pointer attached by evas_data_attach_set()

            @return The pointer attached
            @ingroup Evas_Canvas */
         }
         values {
            void *data; /*@ The pointer to attach */
         }
      }
      font_hinting {
         set {
            /*@
            Changes the font hinting for the given evas.

            #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
            @ingroup Evas_Font_Group */
         }
         get {
            /*@
            Retrieves the font hinting used by the given evas.

            @return The hinting in use, one of #EVAS_FONT_HINTING_NONE,
            #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
            @ingroup Evas_Font_Group */
         }
         values {
            Evas_Font_Hinting_Flags hinting; /*@ The hinting to use, one of #EVAS_FONT_HINTING_NONE, */
         }
      }
      engine_info {
         set {
            /*@
            Applies the engine settings for the given evas from the given @c
            Evas_Engine_Info structure.

            To get the Evas_Engine_Info structure to use, call @ref
            evas_engine_info_get .  Do not try to obtain a pointer to an
            @c Evas_Engine_Info structure in any other way.

            You will need to call this function at least once before you can
            create objects on an evas or render that evas.  Some engines allow
            their settings to be changed more than once.

            Once called, the @p info pointer should be considered invalid.

            @return  @c EINA_TRUE if no error occurred, @c EINA_FALSE otherwise.
            @ingroup Evas_Output_Method */
            return: bool;
         }
         get {
            /*@
            Retrieves the current render engine info struct from the given evas.

            The returned structure is publicly modifiable.  The contents are
            valid until either @ref evas_engine_info_set or @ref evas_render
            are called.

            This structure does not need to be freed by the caller.

            @return  A pointer to the Engine Info structure.  @c NULL is returned if
            an engine has not yet been assigned.
            @ingroup Evas_Output_Method */
         }
         values {
            Evas_Engine_Info *info; /*@ The pointer to the Engine Info to use */
         }
      }
      focus {
         get {
            /*@
            Retrieve the object that currently has focus.

            @return The object that has focus or @c NULL if there is not one.

            Evas can have (at most) one of its objects focused at a time.
            Focused objects will be the ones having <b>key events</b> delivered
            to, which the programmer can act upon by means of
            evas_object_event_callback_add() usage.

            @note Most users wouldn't be dealing directly with Evas' focused
            objects. Instead, they would be using a higher level library for
            that (like a toolkit, as Elementary) to handle focus and who's
            receiving input for them.

            This call returns the object that currently has focus on the canvas
            @p e or @c NULL, if none.

            @see evas_object_focus_set
            @see evas_object_focus_get
            @see evas_object_key_grab
            @see evas_object_key_ungrab

            Example:
            @dontinclude evas-events.c
            @skip evas_event_callback_add(d.canvas, EVAS_CALLBACK_CANVAS_OBJECT_FOCUS_IN,
            @until evas_object_focus_set(d.bg, EINA_TRUE);
            @dontinclude evas-events.c
            @skip called when our rectangle gets focus
            @until }

            In this example the @c event_info is exactly a pointer to that
            focused rectangle. See the full @ref Example_Evas_Events "example".

            @ingroup Evas_Object_Group_Find */
            return: Evas_Object * @warn_unused;
         }
      }
      object_top {
         get {
            /*@
            Get the highest (stacked) Evas object on the canvas @p e.

            @return a pointer to the highest object on it, if any, or @c NULL,
            otherwise

            This function will take all populated layers in the canvas into
            account, getting the highest object for the highest layer,
            naturally.

            @see evas_object_layer_get()
            @see evas_object_layer_set()
            @see evas_object_below_get()
            @see evas_object_above_get()

            @warning This function will @b skip objects parented by smart
            objects, acting only on the ones at the "top level", with regard to
            object parenting. */
            return: Evas_Object * @warn_unused;
         }
      }
      key_lock {
         get {
            /*@
            Returns a handle to the list of lock keys registered in the canvas
            @p e. This is required to check for which locks are set at a given
            time with the evas_key_lock_is_set() function.

            @see evas_key_lock_add
            @see evas_key_lock_del
            @see evas_key_lock_on
            @see evas_key_lock_off
            @see evas_key_lock_is_set

            @return An .Evas_Lock handle to query Evas' keys subsystem with
            evas_key_lock_is_set(), or @c NULL on error. */
            return: const(Evas_Lock)* @warn_unused;
         }
      }
      pointer_canvas_xy {
         get {
            /*@
            This function returns the current known pointer co-ordinates

            This function returns the current known canvas unit co-ordinates of
            the mouse pointer and sets the contents of the Evas_Coords pointed
            to by @p x and @p y to contain these co-ordinates. If @p e is not a
            valid canvas the results of this function are undefined.

            Example:
            @code
            extern Evas *evas;
            Evas_Coord mouse_x, mouse_y;

            evas_pointer_output_xy_get(evas, &mouse_x, &mouse_y);
            printf("Mouse is at canvas position %d, %d\n", mouse_x, mouse_y);
            @endcode */
         }
         values {
            Evas_Coord x; /*@ The pointer to a Evas_Coord to be filled in */
            Evas_Coord y; /*@ The pointer to a Evas_Coord to be filled in
            @ingroup Evas_Pointer_Group */
         }
      }
      event_down_count {
         get {
            /*@
            Get the number of mouse or multi presses currently active

            @p e The given canvas pointer.
            @return The number of presses (0 if none active).

            @since 1.2 */
            return: int;
         }
      }
      smart_objects_calculate_count {
         get {
            /*@
            This gets the internal counter that counts the number of smart calculations

            Whenever evas performs smart object calculations on the whole canvas
            it increments a counter by 1. This is the smart object calculate counter
            that this function returns the value of. It starts at the value of 0 and
            will increase (and eventually wrap around to negative values and so on) by
            1 every time objects are calculated. You can use this counter to ensure
            you don't re-do calculations withint the same calculation generation/run
            if the calculations maybe cause self-feeding effects.

            @ingroup Evas_Smart_Object_Group
            @since 1.1 */
            return: int;
         }
      }
      focus_state {
         get {
            /*@
            Get the focus state known by the given evas

            @return @c EINA_TRUE if it got the focus, @c EINA_FALSE otherwise.
            @ingroup Evas_Canvas */
            return: bool;
         }
      }
      changed {
         get {
            /*@
            Get the changed marker for the canvas

            @return @c EINA_TRUE if something has been marked as changed, @c EINA_FALSE otherwise.
            @ingroup Evas_Canvas
            @since 1.11
             */
            return: bool;
         }
      }
      pointer_output_xy {
         get {
            /*@
            This function returns the current known pointer co-ordinates

            This function returns the current known screen/output co-ordinates
            of the mouse pointer and sets the contents of the integers pointed
            to by @p x and @p y to contain these co-ordinates. If @p e is not a
            valid canvas the results of this function are undefined.

            Example:
            @code
            extern Evas *evas;
            int mouse_x, mouse_y;

            evas_pointer_output_xy_get(evas, &mouse_x, &mouse_y);
            printf("Mouse is at screen position %i, %i\n", mouse_x, mouse_y);
            @endcode */
         }
         values {
            int x; /*@ The pointer to an integer to be filled in */
            int y; /*@ The pointer to an integer to be filled in
            @ingroup Evas_Pointer_Group */
         }
      }
      pointer_inside {
         get {
            /*@
            Returns whether the mouse pointer is logically inside the canvas

            @return An integer that is 1 if the mouse is inside the canvas, 0 otherwise
            @ingroup Evas_Pointer_Group

            When this function is called it will return a value of either 0 or
            1, depending on if evas_event_feed_mouse_in(),
            evas_event_feed_mouse_in_data(), or evas_event_feed_mouse_out(),
            evas_event_feed_mouse_out_data() have been called to feed in a
            mouse enter event into the canvas.

            A return value of 1 indicates the mouse is logically inside the
            canvas, and 0 implies it is logically outside the canvas.

            A canvas begins with the mouse being assumed outside (0).

            If @p e is not a valid canvas, the return value is undefined.

            Example:
            @code
            extern Evas *evas;

            if (evas_pointer_inside_get(evas)) printf("Mouse is in!\n");
            else printf("Mouse is out!\n");
            @endcode */
            return: bool @warn_unused;
         }
      }
      image_max_size {
         get {
            /*@
            Get the maximum image size evas can possibly handle

            This function returns the larges image or surface size that evas can handle
            in pixels, and if there is one, returns @c EINA_TRUE. It returns
            @c EINA_FALSE if no extra constraint on maximum image size exists. You still
            should check the return values of @p maxw and @p maxh as there may still be
            a limit, just a much higher one.

            @since 1.1 */
            return: bool;
         }
         values {
            int maxw; /*@ Pointer to hold the return value in pixels of the maximum width */
            int maxh; /*@ Pointer to hold the return value in pixels of the maximum height */
         }
      }
      object_bottom {
         get {
            /*@
            Get the lowest (stacked) Evas object on the canvas @p e.

            @return a pointer to the lowest object on it, if any, or @c NULL,
            otherwise

            This function will take all populated layers in the canvas into
            account, getting the lowest object for the lowest layer, naturally.

            @see evas_object_layer_get()
            @see evas_object_layer_set()
            @see evas_object_below_get()
            @see evas_object_above_get()

            @warning This function will @b skip objects parented by smart
            objects, acting only on the ones at the "top level", with regard to
            object parenting. */
            return: Evas_Object * @warn_unused;
         }
      }
      key_modifier {
         get {
            /*@
            Returns a handle to the list of modifier keys registered in the
            canvas @p e. This is required to check for which modifiers are set
            at a given time with the evas_key_modifier_is_set() function.

            @see evas_key_modifier_add
            @see evas_key_modifier_del
            @see evas_key_modifier_on
            @see evas_key_modifier_off
            @see evas_key_modifier_is_set

            @return An .Evas_Modifier handle to query Evas' keys subsystem
            with evas_key_modifier_is_set(), or @c NULL on error. */
            return: const(Evas_Modifier)* @warn_unused;
         }
      }
      pointer_button_down_mask {
         get {
            /*@
            Returns a bitmask with the mouse buttons currently pressed, set to 1

            @return A bitmask of the currently depressed buttons on the canvas
            @ingroup Evas_Pointer_Group

            Calling this function will return a 32-bit integer with the
            appropriate bits set to 1 that correspond to a mouse button being
            depressed. This limits Evas to a mouse devices with a maximum of 32
            buttons, but that is generally in excess of any host system's
            pointing device abilities.

            A canvas by default begins with no mouse buttons being pressed and
            only calls to evas_event_feed_mouse_down(),
            evas_event_feed_mouse_down_data(), evas_event_feed_mouse_up() and
            evas_event_feed_mouse_up_data() will alter that.

            The least significant bit corresponds to the first mouse button
            (button 1) and the most significant bit corresponds to the last
            mouse button (button 32).

            If @p e is not a valid canvas, the return value is undefined.

            Example:
            @code
            extern Evas *evas;
            int button_mask, i;

            button_mask = evas_pointer_button_down_mask_get(evas);
            printf("Buttons currently pressed:\n");
            for (i = 0; i < 32; i++)
            {
            if ((button_mask & (1 << i)) != 0) printf("Button %i\n", i + 1);
            }
            @endcode */
            return: int @warn_unused;
         }
      }
   }
   methods {
      tree_objects_at_xy_get {
         /*@
         Retrieve a list of Evas objects lying over a given position in
         a canvas.

         This function will traverse all the layers of the given canvas,
         from top to bottom, querying for objects with areas covering the
         given position. It will enter the smart objects.
         It will not append to the list pass events as hidden objects.
         Call eina_list_free on the returned list after usage. */

         return: list<Evas.Object *> * @warn_unused;
         params {
            @in Evas_Object *stop; /*@ An Evas Object where to stop searching. */
            @in int x; /*@ The horizontal coordinate of the position. */
            @in int y; /*@ The vertical coordinate of the position. */
         }
      }
      event_feed_mouse_wheel {
         /*@
         Mouse wheel event feed.

         This function will set some evas properties that is necessary when
         the mouse wheel is scrolled up or down. It prepares information to
         be treated by the callback function. */

         params {
            @in int direction; /*@ The wheel mouse direction. */
            @in int z; /*@ How much mouse wheel was scrolled up or down. */
            @in uint timestamp; /*@ The timestamp of the mouse up event. */
            @in const(void)* data; /*@ The data for canvas. */
         }
      }
      key_lock_on {
         /*@
         Enables or turns on programmatically the lock key with name @p
         keyname.

         The effect will be as if the key was put on its active state after
         this call.

         @see evas_key_lock_get
         @see evas_key_lock_add
         @see evas_key_lock_del
         @see evas_key_lock_off */

         params {
            @in const(char)* keyname @nonull; /*@ The name of the lock to enable. */
         }
      }
      event_feed_key_down {
         /*@
         Key down event feed

         This function will set some evas properties that is necessary when
         a key is pressed. It prepares information to be treated by the
         callback function. */

         params {
            @in const(char)* keyname; /*@ Name of the key */
            @in const(char)* key; /*@ The key pressed. */
            @in const(char)* string; /*@ A String */
            @in const(char)* compose; /*@ The compose string */
            @in uint timestamp; /*@ Timestamp of the mouse up event */
            @in const(void)* data; /*@ Data for canvas. */
         }
      }
      key_modifier_mask_get @const {
         /*@
         Creates a bit mask from the @p keyname @b modifier key. Values
         returned from different calls to it may be ORed together,
         naturally.

         @returns the bit mask or 0 if the @p keyname key wasn't registered as a
         modifier for canvas @p e.

         This function is meant to be using in conjunction with
         evas_object_key_grab()/evas_object_key_ungrab(). Go check their
         documentation for more information.

         @see evas_key_modifier_add
         @see evas_key_modifier_get
         @see evas_key_modifier_on
         @see evas_key_modifier_off
         @see evas_key_modifier_is_set
         @see evas_object_key_grab
         @see evas_object_key_ungrab */
         return: Evas_Modifier_Mask @warn_unused;
         params {
            @in const(char)* keyname @nonull; /*@ The name of the modifier key to create the mask for. */
         }
      }
      key_modifier_add {
         /*@
         Adds the @p keyname key to the current list of modifier keys.

         Modifiers are keys like shift, alt and ctrl, i.e., keys which are
         meant to be pressed together with others, altering the behavior of
         the secondly pressed keys somehow. Evas is so that these keys can
         be user defined.

         This call allows custom modifiers to be added to the Evas system at
         run time. It is then possible to set and unset modifier keys
         programmatically for other parts of the program to check and act
         on. Programmers using Evas would check for modifier keys on key
         event callbacks using evas_key_modifier_is_set().

         @see evas_key_modifier_del
         @see evas_key_modifier_get
         @see evas_key_modifier_on
         @see evas_key_modifier_off
         @see evas_key_modifier_is_set

         @note If the programmer instantiates the canvas by means of the
         ecore_evas_new() family of helper functions, Ecore will take
         care of registering on it all standard modifiers: "Shift",
         "Control", "Alt", "Meta", "Hyper", "Super". */

         params {
            @in const(char)* keyname @nonull; /*@ The name of the modifier key to add to the list of
            Evas modifiers. */
         }
      }
      key_modifier_off {
         /*@
         Disables or turns off programmatically the modifier key with name
         @p keyname.

         @see evas_key_modifier_add
         @see evas_key_modifier_get
         @see evas_key_modifier_on
         @see evas_key_modifier_is_set */

         params {
            @in const(char)* keyname @nonull; /*@ The name of the modifier to disable. */
         }
      }
      event_feed_hold {
         /*@
         Hold event feed

         This function makes the object to stop sending events. */

         params {
            @in int hold; /*@ The hold. */
            @in uint timestamp; /*@ The timestamp of the mouse up event. */
            @in const(void)* data; /*@ The data for canvas. */
         }
      }
      event_feed_mouse_move {
         /*@
         Mouse move event feed.

         This function will set some evas properties that is necessary when
         the mouse is moved from its last position. It prepares information
         to be treated by the callback function. */

         params {
            @in int x; /*@ The horizontal position of the mouse pointer. */
            @in int y; /*@ The vertical position of the mouse pointer. */
            @in uint timestamp; /*@ The timestamp of the mouse up event. */
            @in const(void)* data; /*@ The data for canvas. */
         }
      }
      event_feed_key_up {
         /*@
         Key up event feed

         This function will set some evas properties that is necessary when
         a key is released. It prepares information to be treated by the
         callback function. */

         params {
            @in const(char)* keyname; /*@ Name of the key */
            @in const(char)* key; /*@ The key released. */
            @in const(char)* string; /*@ string */
            @in const(char)* compose; /*@ compose */
            @in uint timestamp; /*@ Timestamp of the mouse up event */
            @in const(void)* data; /*@ Data for canvas. */
         }
      }
      event_feed_mouse_out {
         /*@
         Mouse out event feed.

         This function will set some evas properties that is necessary when
         the mouse out event happens. It prepares information to be treated
         by the callback function. */

         params {
            @in uint timestamp; /*@ Timestamp of the mouse up event. */
            @in const(void)* data; /*@ The data for canvas. */
         }
      }
      event_input_multi_move {
         /*@ No description supplied by the EAPI. */
         params {
            @in int d;
            @in int x;
            @in int y;
            @in double rad;
            @in double radx;
            @in double rady;
            @in double pres;
            @in double ang;
            @in double fx;
            @in double fy;
            @in uint timestamp;
            @in const(void)* data;
         }
      }
      objects_at_xy_get @const {
         /*@
         Retrieve a list of Evas objects lying over a given position in
         a canvas

         @return  The list of Evas objects that are over the given position
         in @p e

         This function will traverse all the layers of the given canvas,
         from top to bottom, querying for objects with areas covering the
         given position. The user can remove from query
         objects which are hidden and/or which are set to pass events.

         @warning This function will @b skip objects parented by smart
         objects, acting only on the ones at the "top level", with regard to
         object parenting. */
         return: list<Evas.Object *> * @warn_unused;
         params {
            @in Evas_Coord x; /*@ The horizontal coordinate of the position */
            @in Evas_Coord y; /*@ The vertical coordinate of the position */
            @in bool include_pass_events_objects; /*@ Boolean flag to include or not
            objects which pass events in this calculation */
            @in bool include_hidden_objects; /*@ Boolean flag to include or not hidden
            objects in this calculation */
         }
      }
      event_input_multi_up {
         /*@ No description supplied by the EAPI. */
         params {
            @in int d;
            @in int x;
            @in int y;
            @in double rad;
            @in double radx;
            @in double rady;
            @in double pres;
            @in double ang;
            @in double fx;
            @in double fy;
            @in Evas_Button_Flags flags;
            @in uint timestamp;
            @in const(void)* data;
         }
      }
      event_feed_multi_down {
         /*@ No description supplied by the EAPI. */
         params {
            @in int d;
            @in int x;
            @in int y;
            @in double rad;
            @in double radx;
            @in double rady;
            @in double pres;
            @in double ang;
            @in double fx;
            @in double fy;
            @in Evas_Button_Flags flags;
            @in uint timestamp;
            @in const(void)* data;
         }
      }
      render_async {
         /*@
         Render the given Evas canvas asynchronously.

         @return EINA_TRUE if the canvas will render, EINA_FALSE otherwise.

         This function only returns EINA_TRUE when a frame will be rendered. If the
         previous frame is still rendering, EINA_FALSE will be returned so the users
         know not to wait for the updates callback and just return to their main
         loop.

         If a @p func callback is given, a list of updated areas will be generated
         and the function will be called from the main thread after the rendered
         frame is flushed to the screen. The resulting list should be freed with
         @f evas_render_updates_free().
         The list is given in the @p event_info parameter of the callback function.

         @ingroup Evas_Canvas
         @since 1.8 */

         return: bool;
      }
      render2 {
         /*@
         Render the given Evas canvas using the new rendering infra.

         This is experimental and will change over time until noted here.

         @return EINA_TRUE if the canvas will render, EINA_FALSE otherwise.

         This function only returns EINA_TRUE when a frame will be rendered. If the
         previous frame is still rendering, EINA_FALSE will be returned so the users
         know not to wait for the updates callback and just return to their main
         loop.

         @ingroup Evas_Canvas
         @since 1.14 */

         return: bool;
      }
      focus_out {
         /*@
         Inform to the evas that it lost the focus.

         @ingroup Evas_Canvas */

      }
      event_input_mouse_move {
         /*@
         Mouse move event feed from input.

         Similar to the evas_event_feed_mouse_move(), this function will inform Evas
         about mouse move events which were received by the input system, relative to
         the 0,0 of the window, not to the canvas 0,0. It will take care of doing any
         special transformation like adding the framespace offset to the mouse event.

         @since 1.8
         @see evas_event_feed_mouse_move */

         params {
            @in int x; /*@ The horizontal position of the mouse pointer relative to the 0,0 of
            the window/surface. */
            @in int y; /*@ The vertical position of the mouse pointer relative to the 0,0 of
            the window/surface. */
            @in uint timestamp; /*@ The timestamp of the mouse move event. */
            @in const(void)* data; /*@ The data for canvas. */
         }
      }
      norender {
         /*@
         Update the canvas internal objects but not triggering immediate
         renderization.

         This function updates the canvas internal objects not triggering
         renderization. To force renderization function evas_render() should
         be used.

         @see evas_render.

         @ingroup Evas_Canvas */

      }
      touch_point_list_count {
         /*@
         Get the number of touched point in the evas.

         @return The number of touched point on the evas.

         New touched point is added to the list whenever touching the evas
         and point is removed whenever removing touched point from the evas.

         Example:
         @code
         extern Evas *evas;
         int count;

         count = evas_touch_point_list_count(evas);
         printf("The count of touch points: %i\n", count);
         @endcode

         @see evas_touch_point_list_nth_xy_get()
         @see evas_touch_point_list_nth_id_get()
         @see evas_touch_point_list_nth_state_get() */

         return: uint;
      }
      event_input_multi_down {
         /*@ No description supplied by the EAPI. */
         params {
            @in int d;
            @in int x;
            @in int y;
            @in double rad;
            @in double radx;
            @in double rady;
            @in double pres;
            @in double ang;
            @in double fx;
            @in double fy;
            @in Evas_Button_Flags flags;
            @in uint timestamp;
            @in const(void)* data;
         }
      }
      nochange_pop {
         /*@
         Pop the nochange flag down 1

         This tells evas, that while the nochange flag is greater than 0, do not
         mark objects as "changed" when making changes.

         @warning Do not use this function unless you know what Evas exactly
         works with "changed" state.

         @ingroup Evas_Canvas */

      }
      key_lock_off {
         /*@
         Disables or turns off programmatically the lock key with name @p
         keyname.

         The effect will be as if the key was put on its inactive state
         after this call.

         @see evas_key_lock_get
         @see evas_key_lock_add
         @see evas_key_lock_del
         @see evas_key_lock_on */

         params {
            @in const(char)* keyname @nonull; /*@ The name of the lock to disable. */
         }
      }
      nochange_push {
         /*@
         Push the nochange flag up 1

         This tells evas, that while the nochange flag is greater than 0, do not
         mark objects as "changed" when making changes.

         @warning Do not use this function unless you know what Evas exactly
         works with "changed" state.

         @ingroup Evas_Canvas */

      }
      font_cache_flush {
         /*@
         Force the given evas and associated engine to flush its font cache.

         @ingroup Evas_Font_Group */

      }
      font_hinting_can_hint @const {
         /*@
         Checks if the font hinting is supported by the given evas.

         #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
         @return @c EINA_TRUE if it is supported, @c EINA_FALSE otherwise.
         @ingroup Evas_Font_Group */
         return: bool @warn_unused;
         params {
            @in Evas_Font_Hinting_Flags hinting; /*@ The hinting to use, one of #EVAS_FONT_HINTING_NONE, */
         }
      }
      object_top_at_xy_get @const {
         /*@
         Retrieve the Evas object stacked at the top of a given position in
         a canvas

         @return  The Evas object that is over all other objects at the given
         position.

         This function will traverse all the layers of the given canvas,
         from top to bottom, querying for objects with areas covering the
         given position. The user can remove from the query
         objects which are hidden and/or which are set to pass events.

         @warning This function will @b skip objects parented by smart
         objects, acting only on the ones at the "top level", with regard to
         object parenting. */
         return: Evas_Object * @warn_unused;
         params {
            @in Evas_Coord x; /*@ The horizontal coordinate of the position */
            @in Evas_Coord y; /*@ The vertical coordinate of the position */
            @in bool include_pass_events_objects; /*@ Boolean flag to include or not
            objects which pass events in this calculation */
            @in bool include_hidden_objects; /*@ Boolean flag to include or not hidden
            objects in this calculation */
         }
      }
      key_modifier_on {
         /*@
         Enables or turns on programmatically the modifier key with name @p
         keyname.

         The effect will be as if the key was pressed for the whole time
         between this call and a matching evas_key_modifier_off().

         @see evas_key_modifier_add
         @see evas_key_modifier_get
         @see evas_key_modifier_off
         @see evas_key_modifier_is_set */

         params {
            @in const(char)* keyname @nonull; /*@ The name of the modifier to enable. */
         }
      }
      event_feed_mouse_up {
         /*@
         Mouse up event feed.

         This function will set some evas properties that is necessary when
         the mouse button is released. It prepares information to be treated
         by the callback function. */

         params {
            @in int b; /*@ The button number. */
            @in Evas_Button_Flags flags; /*@ evas button flags. */
            @in uint timestamp; /*@ The timestamp of the mouse up event. */
            @in const(void)* data; /*@ The data for canvas. */
         }
      }
      event_feed_mouse_down {
         /*@
         Mouse down event feed.

         This function will set some evas properties that is necessary when
         the mouse button is pressed. It prepares information to be treated
         by the callback function. */

         params {
            @in int b; /*@ The button number. */
            @in Evas_Button_Flags flags; /*@ The evas button flags. */
            @in uint timestamp; /*@ The timestamp of the mouse down event. */
            @in const(void)* data; /*@ The data for canvas. */
         }
      }
      event_refeed_event {
         /*@
         Re feed event.

         This function re-feeds the event pointed by event_copy

         This function call evas_event_feed_* functions, so it can
         cause havoc if not used wisely. Please use it responsibly. */

         params {
            @in void *event_copy; /*@ the event to refeed */
            @in Evas_Callback_Type event_type; /*@ Event type */
         }
      }
      font_available_list @const {
         /*@
         List of available font descriptions known or found by this evas.

         The list depends on Evas compile time configuration, such as
         fontconfig support, and the paths provided at runtime as explained
         in @ref Evas_Font_Path_Group.

         @return a newly allocated list of strings. Do not change the
         strings.  Be sure to call evas_font_available_list_free()
         after you're done.

         @ingroup Evas_Font_Group */
         return: list<const(char) *> * @warn_unused;
      }
      objects_in_rectangle_get @const {
         return: list<Evas.Object *> * @warn_unused;
         params {
            @in Evas_Coord x;
            @in Evas_Coord y;
            @in Evas_Coord w;
            @in Evas_Coord h;
            @in bool include_pass_events_objects;
            @in bool include_hidden_objects;
         }
      }
      object_name_find @const {
         /*@
         Retrieves the object on the given evas with the given name.
         @return  If successful, the Evas object with the given name.  Otherwise,
         @c NULL.

         This looks for the evas object given a name by evas_object_name_set(). If
         the name is not unique canvas-wide, then which one of the many objects
         with that name is returned is undefined, so only use this if you can ensure
         the object name is unique.

         @ingroup Evas_Object_Group_Find */
         return: Evas_Object * @warn_unused;
         params {
            @in const(char)* name; /*@ The given name. */
         }
      }
      font_path_append {
         /*@
         Appends a font path to the list of font paths used by the given evas.
         @ingroup Evas_Font_Path_Group */

         params {
            @in const(char)* path @nonull; /*@ The new font path. */
         }
      }
      touch_point_list_nth_id_get {
         /*@
         This function returns the @p id of nth touch point.

         @return id of nth touch point, if the call succeeded, -1 otherwise.

         The point which comes from Mouse Event has @p id 0 and The point
         which comes from Multi Event has @p id that is same as Multi
         Event's device id.

         Example:
         @code
         extern Evas *evas;
         int id;

         if (evas_touch_point_list_count(evas))
         {
         id = evas_touch_point_nth_id_get(evas, 0);
         printf("The first touch point's id: %i\n", id);
         }
         @endcode

         @see evas_touch_point_list_count()
         @see evas_touch_point_list_nth_xy_get()
         @see evas_touch_point_list_nth_state_get() */

         return: int;
         params {
            @in uint n; /*@ The number of the touched point (0 being the first). */
         }
      }
      font_path_clear {
         /*@
         Removes all font paths loaded into memory for the given evas.
         @ingroup Evas_Font_Path_Group */

      }
      smart_objects_calculate {
         /*@
         Call user-provided @c calculate() smart functions and unset the
         flag signalling that the object needs to get recalculated to @b all
         smart objects in the canvas.

         @see evas_object_smart_need_recalculate_set()

         @ingroup Evas_Smart_Object_Group */

      }
      touch_point_list_nth_xy_get {
         /*@
         This function returns the nth touch point's co-ordinates.

         Touch point's co-ordinates is updated whenever moving that point
         on the canvas.

         Example:
         @code
         extern Evas *evas;
         Evas_Coord x, y;

         if (evas_touch_point_list_count(evas))
         {
         evas_touch_point_nth_xy_get(evas, 0, &x, &y);
         printf("The first touch point's co-ordinate: (%i, %i)\n", x, y);
         }
         @endcode

         @see evas_touch_point_list_count()
         @see evas_touch_point_list_nth_id_get()
         @see evas_touch_point_list_nth_state_get() */

         params {
            @in uint n; /*@ The number of the touched point (0 being the first). */
            @out Evas_Coord x; /*@ The pointer to a Evas_Coord to be filled in. */
            @out Evas_Coord y; /*@ The pointer to a Evas_Coord to be filled in. */
         }
      }
      key_lock_del {
         /*@
         Removes the @p keyname key from the current list of lock keys on
         canvas @p e.

         @see evas_key_lock_get
         @see evas_key_lock_add
         @see evas_key_lock_on
         @see evas_key_lock_off */

         params {
            @in const(char)* keyname @nonull; /*@ The name of the key to remove from the locks list. */
         }
      }
      damage_rectangle_add {
         /*@
         Add a damage rectangle.

         This is the function by which one tells evas that a part of the
         canvas has to be repainted.

         @note All newly created Evas rectangles get the default color values of 255 255 255 255 (opaque white).

         @ingroup Evas_Canvas */

         params {
            @in int x; /*@ The rectangle's left position. */
            @in int y; /*@ The rectangle's top position. */
            @in int w; /*@ The rectangle's width. */
            @in int h; /*@ The rectangle's height. */
         }
      }
      sync {
         /*@ No description supplied by the EAPI. */
      }
      font_path_list @const {
         /*@
         Retrieves the list of font paths used by the given evas.
         @return  The list of font paths used.
         @ingroup Evas_Font_Path_Group */
         return: const(list<const(char) *>)* @warn_unused;
      }
      image_cache_reload {
         /*@
         Reload the image cache

         This function reloads the image cache of canvas. */

      }
      coord_world_x_to_screen @const {
         /*@
         Convert/scale a canvas co-ordinate into output screen co-ordinates

         @return The output/screen co-ordinate translated to output co-ordinates
         @ingroup Evas_Coord_Mapping_Group

         This function takes in a horizontal co-ordinate as the @p x
         parameter and converts it into output units, accounting for output
         size, viewport size and location, returning it as the function
         return value. If @p e is invalid, the results are undefined.

         Example:
         @code
         extern Evas *evas;
         int screen_x;
         extern Evas_Coord canvas_x;

         screen_x = evas_coord_world_x_to_screen(evas, canvas_x);
         @endcode */
         return: int @warn_unused;
         params {
            @in Evas_Coord x; /*@ The canvas x co-ordinate */
         }
      }
      event_feed_multi_move {
         /*@ No description supplied by the EAPI. */
         params {
            @in int d;
            @in int x;
            @in int y;
            @in double rad;
            @in double radx;
            @in double rady;
            @in double pres;
            @in double ang;
            @in double fx;
            @in double fy;
            @in uint timestamp;
            @in const(void)* data;
         }
      }
      render_updates {
         /*@
         Force immediate renderization of the given Evas canvas.

         @return A newly allocated list of updated rectangles of the canvas
         (@c Eina.Rectangle structs). Free this list with
         evas_render_updates_free().

         This function forces an immediate renderization update of the given
         canvas @p e.

         @note This is a <b>very low level function</b>, which most of
         Evas' users wouldn't care about. One would use it, for example, to
         grab an Evas' canvas update regions and paint them back, using the
         canvas' pixmap, on a displaying system working below Evas.

         @note Evas is a stateful canvas. If no operations changing its
         state took place since the last rendering action, you won't see no
         changes and this call will be a no-op.

         Example code follows.
         @dontinclude evas-events.c
         @skip add an obscured
         @until d.obscured = !d.obscured;

         See the full @ref Example_Evas_Events "example".

         @ingroup Evas_Canvas */

         return: free(own(list<Eina.Rectangle *> *), evas_render_updates_free)
            @warn_unused;
      }
      image_cache_flush {
         /*@
         Flush the image cache of the canvas.

         This function flushes image cache of canvas. */

      }
      coord_screen_y_to_world @const {
         /*@
         Convert/scale an output screen co-ordinate into canvas co-ordinates

         @return The screen co-ordinate translated to canvas unit co-ordinates
         @ingroup Evas_Coord_Mapping_Group

         This function takes in a vertical co-ordinate as the @p y parameter
         and converts it into canvas units, accounting for output size,
         viewport size and location, returning it as the function return
         value. If @p e is invalid, the results are undefined.

         Example:
         @code
         extern Evas *evas;
         extern int screen_y;
         Evas_Coord canvas_y;

         canvas_y = evas_coord_screen_y_to_world(evas, screen_y);
         @endcode */
         return: Evas_Coord @warn_unused;
         params {
            @in int y; /*@ The screen/output y co-ordinate */
         }
      }
      key_modifier_del {
         /*@
         Removes the @p keyname key from the current list of modifier keys
         on canvas @p e.

         @see evas_key_modifier_add
         @see evas_key_modifier_get
         @see evas_key_modifier_on
         @see evas_key_modifier_off
         @see evas_key_modifier_is_set */

         params {
            @in const(char)* keyname @nonull; /*@ The name of the key to remove from the modifiers list. */
         }
      }
      touch_point_list_nth_state_get {
         /*@
         This function returns the @p state of nth touch point.

         @return @p state of nth touch point, if the call succeeded,
         EVAS_TOUCH_POINT_CANCEL otherwise.

         The point's @p state is EVAS_TOUCH_POINT_DOWN when pressed,
         EVAS_TOUCH_POINT_STILL when the point is not moved after pressed,
         EVAS_TOUCH_POINT_MOVE when moved at least once after pressed and
         EVAS_TOUCH_POINT_UP when released.

         Example:
         @code
         extern Evas *evas;
         Evas_Touch_Point_State state;

         if (evas_touch_point_list_count(evas))
         {
         state = evas_touch_point_nth_state_get(evas, 0);
         printf("The first touch point's state: %i\n", state);
         }
         @endcode

         @see evas_touch_point_list_count()
         @see evas_touch_point_list_nth_xy_get()
         @see evas_touch_point_list_nth_id_get() */

         return: Evas_Touch_Point_State;
         params {
            @in uint n; /*@ The number of the touched point (0 being the first). */
         }
      }
      focus_in {
         /*@
         Inform to the evas that it got the focus.

         @ingroup Evas_Canvas */

      }
      obscured_rectangle_add {
         /*@
         Add an "obscured region" to an Evas canvas.

         This is the function by which one tells an Evas canvas that a part
         of it <b>must not</b> be repainted. The region must be
         rectangular and its coordinates inside the canvas viewport are
         passed in the call. After this call, the region specified won't
         participate in any form in Evas' calculations and actions during
         its rendering updates, having its displaying content frozen as it
         was just after this function took place.

         We call it "obscured region" because the most common use case for
         this rendering (partial) freeze is something else (most probably
         other canvas) being on top of the specified rectangular region,
         thus shading it completely from the user's final scene in a
         display. To avoid unnecessary processing, one should indicate to the
         obscured canvas not to bother about the non-important area.

         The majority of users won't have to worry about this function, as
         they'll be using just one canvas in their applications, with
         nothing inset or on top of it in any form.

         To make this region one that @b has to be repainted again, call the
         function evas_obscured_clear().

         @note This is a <b>very low level function</b>, which most of
         Evas' users wouldn't care about.

         @note This function does @b not flag the canvas as having its state
         changed. If you want to re-render it afterwards expecting new
         contents, you have to add "damage" regions yourself (see
         evas_damage_rectangle_add()).

         @see evas_obscured_clear()
         @see evas_render_updates()

         Example code follows.
         @dontinclude evas-events.c
         @skip add an obscured
         @until evas_obscured_clear(evas);

         In that example, pressing the "Ctrl" and "o" keys will impose or
         remove an obscured region in the middle of the canvas. You'll get
         the same contents at the time the key was pressed, if toggling it
         on, until you toggle it off again (make sure the animation is
         running on to get the idea better). See the full @ref
         Example_Evas_Events "example".

         @ingroup Evas_Canvas */

         params {
            @in int x; /*@ The rectangle's top left corner's horizontal coordinate. */
            @in int y; /*@ The rectangle's top left corner's vertical coordinate */
            @in int w; /*@ The rectangle's width. */
            @in int h; /*@ The rectangle's height. */
         }
      }
      render_dump {
         /*@
         Make the canvas discard as much data as possible used by the engine at
         runtime.

         This function will unload images, delete textures and much more, where
         possible. You may also want to call evas_render_idle_flush() immediately
         prior to this to perhaps discard a little more, though evas_render_dump()
         should implicitly delete most of what evas_render_idle_flush() might
         discard too.

         @ingroup Evas_Canvas */

      }
      event_feed_mouse_in {
         /*@
         Mouse in event feed.

         This function will set some evas properties that is necessary when
         the mouse in event happens. It prepares information to be treated
         by the callback function. */

         params {
            @in uint timestamp; /*@ The timestamp of the mouse up event. */
            @in const(void)* data; /*@ The data for canvas. */
         }
      }
      object_top_in_rectangle_get @const {
         /*@
         Retrieve the Evas object stacked at the top of a given rectangular
         region in a canvas

         @return  The Evas object that is over all other objects at the given
         rectangular region.

         This function will traverse all the layers of the given canvas,
         from top to bottom, querying for objects with areas overlapping
         with the given rectangular region inside @p e. The user can remove
         from the query objects which are hidden and/or which are set to
         pass events.

         @warning This function will @b skip objects parented by smart
         objects, acting only on the ones at the "top level", with regard to
         object parenting. */
         return: Evas_Object * @warn_unused;
         params {
            @in Evas_Coord x; /*@ The top left corner's horizontal coordinate for the
            rectangular region */
            @in Evas_Coord y; /*@ The top left corner's vertical coordinate for the
            rectangular region */
            @in Evas_Coord w; /*@ The width of the rectangular region */
            @in Evas_Coord h; /*@ The height of the rectangular region */
            @in bool include_pass_events_objects; /*@ Boolean flag to include or not
            objects which pass events in this calculation */
            @in bool include_hidden_objects; /*@ Boolean flag to include or not hidden
            objects in this calculation */
         }
      }
      render {
         /*@
         Force renderization of the given canvas.

         @ingroup Evas_Canvas */

      }
      event_feed_multi_up {
         /*@ No description supplied by the EAPI. */
         params {
            @in int d;
            @in int x;
            @in int y;
            @in double rad;
            @in double radx;
            @in double rady;
            @in double pres;
            @in double ang;
            @in double fx;
            @in double fy;
            @in Evas_Button_Flags flags;
            @in uint timestamp;
            @in const(void)* data;
         }
      }
      font_path_prepend {
         /*@
         Prepends a font path to the list of font paths used by the given evas.
         @ingroup Evas_Font_Path_Group */

         params {
            @in const(char)* path @nonull; /*@ The new font path. */
         }
      }
      obscured_clear {
         /*@
         Remove all "obscured regions" from an Evas canvas.

         This function removes all the rectangles from the obscured regions
         list of the canvas @p e. It takes obscured areas added with
         evas_obscured_rectangle_add() and make them again a regions that @b
         have to be repainted on rendering updates.

         @note This is a <b>very low level function</b>, which most of
         Evas' users wouldn't care about.

         @note This function does @b not flag the canvas as having its state
         changed. If you want to re-render it afterwards expecting new
         contents, you have to add "damage" regions yourself (see
         evas_damage_rectangle_add()).

         @see evas_obscured_rectangle_add() for an example
         @see evas_render_updates()

         @ingroup Evas_Canvas */

      }
      event_feed_mouse_cancel {
         /*@
         Mouse cancel event feed.

         This function will call evas_event_feed_mouse_up() when a
         mouse cancel event happens. */

         params {
            @in uint timestamp; /*@ The timestamp of the mouse up event. */
            @in const(void)* data; /*@ The data for canvas. */
         }
      }
      coord_screen_x_to_world @const {
         /*@
         Convert/scale an output screen co-ordinate into canvas co-ordinates

         @return The screen co-ordinate translated to canvas unit co-ordinates
         @ingroup Evas_Coord_Mapping_Group

         This function takes in a horizontal co-ordinate as the @p x
         parameter and converts it into canvas units, accounting for output
         size, viewport size and location, returning it as the function
         return value. If @p e is invalid, the results are undefined.

         Example:
         @code
         extern Evas *evas;
         extern int screen_x;
         Evas_Coord canvas_x;

         canvas_x = evas_coord_screen_x_to_world(evas, screen_x);
         @endcode */
         return: Evas_Coord @warn_unused;
         params {
            @in int x; /*@ The screen/output x co-ordinate */
         }
      }
      key_lock_add {
         /*@
         Adds the @p keyname key to the current list of lock keys.

         Locks are keys like caps lock, num lock or scroll lock, i.e., keys
         which are meant to be pressed once -- toggling a binary state which
         is bound to it -- and thus altering the behavior of all
         subsequently pressed keys somehow, depending on its state. Evas is
         so that these keys can be defined by the user.

         This allows custom locks to be added to the evas system at run
         time. It is then possible to set and unset lock keys
         programmatically for other parts of the program to check and act
         on. Programmers using Evas would check for lock keys on key event
         callbacks using evas_key_lock_is_set().

         @see evas_key_lock_get
         @see evas_key_lock_del
         @see evas_key_lock_on
         @see evas_key_lock_off
         @see evas_key_lock_is_set

         @note If the programmer instantiates the canvas by means of the
         ecore_evas_new() family of helper functions, Ecore will take
         care of registering on it all standard lock keys: "Caps_Lock",
         "Num_Lock", "Scroll_Lock". */

         params {
            @in const(char)* keyname @nonull; /*@ The name of the key to add to the locks list. */
         }
      }
      render_idle_flush {
         /*@
         Make the canvas discard internally cached data used for rendering.

         This function flushes the arrays of delete, active and render objects.
         Other things it may also discard are: shared memory segments,
         temporary scratch buffers, cached data to avoid re-compute of that data etc.

         @ingroup Evas_Canvas */

      }
      coord_world_y_to_screen @const {
         /*@
         Convert/scale a canvas co-ordinate into output screen co-ordinates

         @return The output/screen co-ordinate translated to output co-ordinates
         @ingroup Evas_Coord_Mapping_Group

         This function takes in a vertical co-ordinate as the @p x parameter
         and converts it into output units, accounting for output size,
         viewport size and location, returning it as the function return
         value. If @p e is invalid, the results are undefined.

         Example:
         @code
         extern Evas *evas;
         int screen_y;
         extern Evas_Coord canvas_y;

         screen_y = evas_coord_world_y_to_screen(evas, canvas_y);
         @endcode */
         return: int @warn_unused;
         params {
            @in Evas_Coord y; /*@ The canvas y co-ordinate */
         }
      }
      event_feed_key_down_with_keycode {
         /*@
         Key down event feed with keycode

         This function will set some evas properties that is necessary when
         a key is pressed. It prepares information to be treated by the
         callback function.

         @since 1.10 */

         params {
            @in const(char)* keyname; /*@ Name of the key */
            @in const(char)* key; /*@ The key pressed. */
            @in const(char)* string; /*@ A String */
            @in const(char)* compose; /*@ The compose string */
            @in uint timestamp; /*@ Timestamp of the mouse up event */
            @in const(void)* data; /*@ Data for canvas. */
            @in uint keycode; /*@ Key scan code numeric value for canvas. */
         }
      }
      event_feed_key_up_with_keycode {
         /*@
         Key up event feed with keycode

         This function will set some evas properties that is necessary when
         a key is released. It prepares information to be treated by the
         callback function.

         @since 1.10 */

         params {
            @in const(char)* keyname; /*@ Name of the key */
            @in const(char)* key; /*@ The key released. */
            @in const(char)* string; /*@ string */
            @in const(char)* compose; /*@ compose */
            @in uint timestamp; /*@ Timestamp of the mouse up event */
            @in const(void)* data; /*@ Data for canvas. */
            @in uint keycode; /*@ Key scan code numeric value for canvas. */
         }
      }
      event_feed_axis_update {
         /*@
         Input device axis update event feed.

         This function will set some evas properties that is necessary when
         an e.g. stylus axis is updated. It prepares information to be treated
         by the callback function.

         @since 1.13 */

         params {
            @in uint timestamp; /*@ Timestamp of the axis event */
            @in int device; /*@ System-provided device identifier */
            @in int toolid; /*@ Type of tool currently being used */
            @in int naxes; /*@ Number of elements in the \p axis array */
            @in const(Evas_Axis)* axis; /*@ Array containing the current value of all updated axes */
            @in const(void)* data; /*@ Data for canvas. */
         }
      }
   }
   implements {
      Eo.Base.constructor;
      Eo.Base.destructor;
      Eo.Base.event_thaw;
      Eo.Base.event_freeze;
      Evas.Common_Interface.evas.get;
   }

}