/usr/include/ecore-evas-1/Ecore_Evas.h is in libecore-dev 1.8.6-2.1+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 | #ifndef _ECORE_EVAS_H
#define _ECORE_EVAS_H
#include <Evas.h>
#include <Ecore_Evas_Types.h>
#ifdef EAPI
# undef EAPI
#endif
#ifdef _WIN32
# ifdef EFL_ECORE_EVAS_BUILD
# ifdef DLL_EXPORT
# define EAPI __declspec(dllexport)
# else
# define EAPI
# endif /* ! DLL_EXPORT */
# else
# define EAPI __declspec(dllimport)
# endif /* ! EFL_ECORE_EVAS_BUILD */
#else
# ifdef __GNUC__
# if __GNUC__ >= 4
# define EAPI __attribute__ ((visibility("default")))
# else
# define EAPI
# endif
# else
# define EAPI
# endif
#endif /* ! _WIN32 */
/**
* @file Ecore_Evas.h
* @brief Evas wrapper functions
*
* The following is a list of example that partially exemplify Ecore_Evas's API:
* @li @ref ecore_evas_callbacks_example_c
* @li @ref ecore_evas_object_example_c
* @li @ref ecore_evas_basics_example_c
* @li @ref Ecore_Evas_Window_Sizes_Example_c
* @li @ref Ecore_Evas_Buffer_Example_01_c
* @li @ref Ecore_Evas_Buffer_Example_02_c
*/
/* FIXME:
* to do soon:
* - iconfication api needs to work
* - maximization api needs to work
* - document all calls
*
* later:
* - buffer back-end that renders to an evas_image_object ???
* - qt back-end ???
* - dfb back-end ??? (dfb's threads make this REALLY HARD)
*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup Ecore_Evas_Group Ecore_Evas wrapper/helper set of functions
* @ingroup Ecore
*
* Ecore evas is a set of functions that makes it easy to tie together ecore's
* main loop and input handling to evas. As such it's a natural base for EFL
* applications. While this combination makes it easy to create the basic
* aspects all applications need, for normal applications(ones with buttons,
* checkboxes and layouts) one should consider using Elementary.
*
* Ecore evas is extremely well suited for applications that are not based on
* widgets. It has a main loop that delivers events, does basic window handling
* and leaves all of the drawing up to the user. This works very well if used
* in conjunction with Edje or if doing custom drawing as, for example, is done
* in games.
*
* This is a list of examples of these functions:
* @li @ref ecore_evas_basics_example_c
* @li @ref ecore_evas_object_example_c
* @li @ref ecore_evas_callbacks_example_c
* @li @ref Ecore_Evas_Window_Sizes_Example_c
* @li @ref Ecore_Evas_Buffer_Example_01_c
* @li @ref Ecore_Evas_Buffer_Example_02_c
*
* @{
*/
/* these are dummy and just tell u what API levels ecore_evas supports - not if
* the actual support is compiled in. You need to query for that separately.
*/
#define HAVE_ECORE_EVAS_X 1
#define HAVE_ECORE_EVAS_FB 1
#define HAVE_ECORE_EVAS_X11_GL 1
//#define HAVE_ECORE_EVAS_X11_16 1
//#define HAVE_ECORE_EVAS_DIRECTFB 1
#define HAVE_ECORE_EVAS_WIN32 1
#define HAVE_ECORE_EVAS_COCOA 1
#define HAVE_ECORE_EVAS_SDL 1
//#define HAVE_ECORE_EVAS_WINCE 1
#define HAVE_ECORE_EVAS_EWS 1
#define HAVE_ECORE_EVAS_PSL1GHT 1
#define HAVE_ECORE_EVAS_WAYLAND_SHM 1
#define HAVE_ECORE_EVAS_WAYLAND_EGL 1
#define HAVE_ECORE_EVAS_DRM 1
typedef enum _Ecore_Evas_Engine_Type
{
ECORE_EVAS_ENGINE_SOFTWARE_BUFFER,
ECORE_EVAS_ENGINE_SOFTWARE_XLIB,
ECORE_EVAS_ENGINE_XRENDER_X11,
ECORE_EVAS_ENGINE_OPENGL_X11,
ECORE_EVAS_ENGINE_SOFTWARE_XCB,
ECORE_EVAS_ENGINE_XRENDER_XCB,
ECORE_EVAS_ENGINE_SOFTWARE_GDI,
ECORE_EVAS_ENGINE_SOFTWARE_DDRAW,
ECORE_EVAS_ENGINE_DIRECT3D,
ECORE_EVAS_ENGINE_OPENGL_GLEW,
ECORE_EVAS_ENGINE_OPENGL_COCOA,
ECORE_EVAS_ENGINE_SOFTWARE_SDL,
ECORE_EVAS_ENGINE_DIRECTFB,
ECORE_EVAS_ENGINE_SOFTWARE_FB,
ECORE_EVAS_ENGINE_SOFTWARE_8_X11,
ECORE_EVAS_ENGINE_SOFTWARE_16_X11,
ECORE_EVAS_ENGINE_SOFTWARE_16_DDRAW,
ECORE_EVAS_ENGINE_SOFTWARE_16_WINCE,
ECORE_EVAS_ENGINE_OPENGL_SDL,
ECORE_EVAS_ENGINE_EWS,
ECORE_EVAS_ENGINE_PSL1GHT,
ECORE_EVAS_ENGINE_WAYLAND_SHM,
ECORE_EVAS_ENGINE_WAYLAND_EGL,
ECORE_EVAS_ENGINE_DRM
} Ecore_Evas_Engine_Type;
typedef enum _Ecore_Evas_Avoid_Damage_Type
{
ECORE_EVAS_AVOID_DAMAGE_NONE = 0,
ECORE_EVAS_AVOID_DAMAGE_EXPOSE = 1,
ECORE_EVAS_AVOID_DAMAGE_BUILT_IN = 2
} Ecore_Evas_Avoid_Damage_Type;
typedef enum _Ecore_Evas_Object_Associate_Flags
{
ECORE_EVAS_OBJECT_ASSOCIATE_BASE = 0,
ECORE_EVAS_OBJECT_ASSOCIATE_STACK = 1 << 0,
ECORE_EVAS_OBJECT_ASSOCIATE_LAYER = 1 << 1,
ECORE_EVAS_OBJECT_ASSOCIATE_DEL = 1 << 2
} Ecore_Evas_Object_Associate_Flags;
/* module setup/shutdown calls */
EAPI int ecore_evas_engine_type_supported_get(Ecore_Evas_Engine_Type engine);
/**
* @brief Init the Ecore_Evas system.
*
* @return How many times the lib has been initialized, 0 indicates failure.
*
* Set up the Evas wrapper system. Init Evas and Ecore libraries.
*
* @see ecore_evas_shutdown()
*/
EAPI int ecore_evas_init(void);
/**
* @brief Shut down the Ecore_Evas system.
*
* @return 0 if ecore evas is fully shut down, or > 0 if it still being used.
*
* This closes the Evas wrapper system down. Shut down Evas and Ecore libraries.
*
* @see ecore_evas_init()
*/
EAPI int ecore_evas_shutdown(void);
EAPI void ecore_evas_app_comp_sync_set(Eina_Bool do_sync);
EAPI Eina_Bool ecore_evas_app_comp_sync_get(void);
/**
* @brief Returns a list of supported engines names.
*
* @return Newly allocated list with engines names. Engines names
* strings are internal and should be considered constants, do not
* free or modify them, to free the list use ecore_evas_engines_free().
*/
EAPI Eina_List *ecore_evas_engines_get(void);
/**
* @brief Free list returned by ecore_evas_engines_get()
*
* @param engines list with engines names
*/
EAPI void ecore_evas_engines_free(Eina_List *engines);
/**
* @brief Creates a new Ecore_Evas based on engine name and common parameters.
*
* @param engine_name engine name as returned by
* ecore_evas_engines_get() or @c NULL to use environment variable
* ECORE_EVAS_ENGINE, that can be undefined and in this case
* this call will try to find the first working engine.
* @param x horizontal position of window (not supported in all engines)
* @param y vertical position of window (not supported in all engines)
* @param w width of window
* @param h height of window
* @param extra_options string with extra parameter, dependent on engines
* or @ NULL. String is usually in the form: 'key1=value1;key2=value2'.
* Pay attention that when getting that from shell commands, most
* consider ';' as the command terminator, so you need to escape
* it or use quotes.
*
* @return Ecore_Evas instance or @c NULL if creation failed.
*/
EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options);
/**
* @brief Set whether an Ecore_Evas has an alpha channel or not.
*
* @param ee The Ecore_Evas to shape
* @param alpha @c EINA_TRUE to enable the alpha channel, @c EINA_FALSE to
* disable it
*
* This function allows you to make an Ecore_Evas translucent using an
* alpha channel. See ecore_evas_shaped_set() for details. The difference
* between a shaped window and a window with an alpha channel is that an
* alpha channel supports multiple levels of transparency, as opposed to
* the 1 bit transparency of a shaped window (a pixel is either opaque, or
* it's transparent).
*
* @warning Support for this depends on the underlying windowing system.
*/
EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha);
/**
* @brief Query whether an Ecore_Evas has an alpha channel.
* @param ee The Ecore_Evas to query.
* @return @c EINA_TRUE if ee has an alpha channel, @c EINA_FALSE if it does
* not.
*
* This function returns @c EINA_TRUE if @p ee has an alpha channel, and
* @c EINA_FALSE if it does not.
*
* @see ecore_evas_alpha_set()
*/
EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee);
/**
* @brief Set whether an Ecore_Evas has an transparent window or not.
*
* @param ee The Ecore_Evas to shape
* @param transparent @c EINA_TRUE to enable the transparent window,
* @c EINA_FALSE to disable it
*
* This function sets some translucency options, for more complete support see
* ecore_evas_alpha_set().
*
* @warning Support for this depends on the underlying windowing system.
*
* @see ecore_evas_alpha_set()
*/
EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparent);
/**
* @brief Query whether an Ecore_Evas is transparent.
*
* @param ee The Ecore_Evas to query.
* @return @c EINA_TRUE if ee is transparent, @c EINA_FALSE if it isn't.
*
* @see ecore_evas_transparent_set()
*/
EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee);
/**
* @brief Get the geometry of an Ecore_Evas.
*
* @param ee The Ecore_Evas whose geometry y
* @param x A pointer to an int to place the x coordinate in
* @param y A pointer to an int to place the y coordinate in
* @param w A pointer to an int to place the w size in
* @param h A pointer to an int to place the h size in
*
* This function takes four pointers to (already allocated) ints, and places
* the geometry of @p ee in them. If any of the parameters is not desired you
* may pass @c NULL on them.
*
* @code
* int x, y, w, h;
* ecore_evas_geometry_get(ee, &x, &y, &w, &h);
* @endcode
*
* @see ecore_evas_new()
* @see ecore_evas_resize()
* @see ecore_evas_move()
* @see ecore_evas_move_resize()
*/
EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
/**
* @brief Get the geometry which an Ecore_Evas was latest recently requested.
*
* @param ee The Ecore_Evas whose geometry y
* @param x A pointer to an int to place the x coordinate in
* @param y A pointer to an int to place the y coordinate in
* @param w A pointer to an int to place the w size in
* @param h A pointer to an int to place the h size in
*
* This function takes four pointers to (already allocated) ints, and places
* the geometry which @p ee was latest recently requested . If any of the
* parameters is not desired you may pass @c NULL on them.
* This function can represent recently requested geometry.
* ecore_evas_geometry_get function returns the value is updated after engine
* finished request. By comparison, ecore_evas_request_geometry_get returns
* recently requested value.
*
* @code
* int x, y, w, h;
* ecore_evas_request_geometry_get(ee, &x, &y, &w, &h);
* @endcode
*
* @since 1.1
*/
EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
/**
* @brief Set the focus of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
* @param on @c EINA_TRUE for focus, @c EINA_FALSE to defocus.
*
* This function focuses @p ee if @p on is @c EINA_TRUE, or unfocuses @p ee if
* @p on is @c EINA_FALSE.
*
* @warning Support for this depends on the underlying windowing system.
*/
EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on);
/**
* @brief Query whether an Ecore_Evas' window is focused or not.
*
* @param ee The Ecore_Evas to set
* @return @c EINA_TRUE if @p ee if focused, @c EINA_FALSE if not.
*
* @see ecore_evas_focus_set()
*/
EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee);
/**
* @brief Iconify or uniconify an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
* @param on @c EINA_TRUE to iconify, @c EINA_FALSE to uniconify.
*
* This function iconifies @p ee if @p on is @c EINA_TRUE, or uniconifies @p ee
* if @p on is @c EINA_FALSE.
*
* @note Iconify and minimize are synonyms.
*
* @warning Support for this depends on the underlying windowing system.
*/
EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on);
/**
* @brief Query whether an Ecore_Evas' window is iconified or not.
*
* @param ee The Ecore_Evas to set
* @return @c EINA_TRUE if @p ee is iconified, @c EINA_FALSE if not.
*
* @note Iconify and minimize are synonyms.
*
* @see ecore_evas_iconified_set()
*/
EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee);
/**
* @brief Set whether an Ecore_Evas' window is borderless or not.
*
* @param ee The Ecore_Evas
* @param on @c EINA_TRUE for borderless, @c EINA_FALSE for bordered.
*
* This function makes @p ee borderless if @p on is @c EINA_TRUE, or bordered
* if @p on is @c EINA_FALSE.
*
* @warning Support for this depends on the underlying windowing system.
*/
EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on);
/**
* @brief Query whether an Ecore_Evas' window is borderless or not.
*
* @param ee The Ecore_Evas to set
* @return @c EINA_TRUE if @p ee is borderless, @c EINA_FALSE if not.
*
* @see ecore_evas_borderless_set()
*/
EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee);
/**
* @brief Set whether or not an Ecore_Evas' window is fullscreen.
*
* @param ee The Ecore_Evas
* @param on @c EINA_TRUE fullscreen, @c EINA_FALSE not.
*
* This function causes @p ee to be fullscreen if @p on is @c EINA_TRUE, or
* not if @p on is @c EINA_FALSE.
*
* @warning Support for this depends on the underlying windowing system.
*/
EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on);
/**
* @brief Query whether an Ecore_Evas' window is fullscreen or not.
*
* @param ee The Ecore_Evas to set
* @return @c EINA_TRUE if @p ee is fullscreen, @c EINA_FALSE if not.
*
* @see ecore_evas_fullscreen_set()
*/
EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee);
/**
* @brief Set another window that this window is a group member of
*
* @param ee The Ecore_Evas
* @param ee_group The other group member
*
* If @p ee_group is @c NULL, @p ee is removed from the group, otherwise it is
* added. Note that if you free the @p ee_group canvas before @p ee, then
* getting the group canvas with ecore_evas_window_group_get() will return
* an invalid handle.
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.2
*/
EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *ee_group);
/**
* @brief Get the canvas group set.
*
* This returns the handle set by ecore_evas_window_group_set().
*
* @param ee The Ecore_Evas to set
* @return The Canvas group handle
*
* @see ecore_evas_window_group_set()
* @since 1.2
*/
EAPI const Ecore_Evas *ecore_evas_window_group_get(const Ecore_Evas *ee);
/**
* @brief Set the aspect ratio of a canvas window
*
* @param ee The Ecore_Evas
* @param aspect The aspect ratio (width divided by height), or 0 to disable
*
* This sets the desired aspect ratio of a canvas window
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.2
*/
EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect);
/**
* @brief Get the aspect ratio of a canvas window
*
* This returns the value set by ecore_evas_aspect_set().
*
* @param ee The Ecore_Evas to set
* @return The aspect ratio
*
* @see ecore_evas_aspect_set()
* @since 1.2
*/
EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee);
/**
* @brief Set The urgent hint flag
*
* @param ee The Ecore_Evas
* @param urgent The urgent state flag
*
* This sets the "urgent" state hint on a window so the desktop environment
* can highlight it somehow.
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.2
*/
EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent);
/**
* @brief Get the urgent state on the cavas window
*
* This returns the value set by ecore_evas_urgent_set()
*
* @param ee The Ecore_Evas to set
* @return The urgent state set
*
* @see ecore_evas_urgent_set()
* @since 1.2
*/
EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee);
/**
* @brief Set the modal state flag on the canvas window
*
* @param ee The Ecore_Evas
* @param modal The modal hint flag
*
* This hints if the window should be modal (eg if it is also transient
* for another window, the other window will maybe be denied focus by
* the desktop window manager).
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.2
*/
EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal);
/**
* @brief Get The modal flag
*
* This returns the value set by ecore_evas_modal_set().
*
* @param ee The Ecore_Evas to set
* @return The modal flag
*
* @see ecore_evas_modal_set()
* @since 1.2
*/
EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee);
/**
* @brief Set the "i demand attention" flag on a canvas window
*
* @param ee The Ecore_Evas
* @param demand The flag state to set
*
* A window may demand attention now (eg you must enter a password before
* continuing), and so it may flag a window with this.
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.2
*/
EAPI void ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand);
/**
* @brief Get the "i demand attention" flag
*
* This returns the value set by ecore_evas_demand_attention_set().
*
* @param ee The Ecore_Evas to set
* @return The "i demand attention" flag.
*
* @see ecore_evas_demand_attention_set()
* @since 1.2
*/
EAPI Eina_Bool ecore_evas_demand_attention_get(const Ecore_Evas *ee);
/**
* @brief Set the "focus skip" flag
*
* @param ee The Ecore_Evas
* @param skip The "focus skip" state to set.
*
* A window may not want to accept focus, be in the taskbar, pager etc.
* sometimes (example for a small notification window that hovers around
* a taskbar or panel, or hovers around a window until some activity
* dismisses it).
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.2
*/
EAPI void ecore_evas_focus_skip_set(Ecore_Evas *ee, Eina_Bool skip);
/**
* @brief Get the "focus skip" flag
*
* This returns the value set by ecore_evas_focus_skip_set().
*
* @param ee The Ecore_Evas to set
* @return The "focus skip" flag.
*
* @see ecore_evas_focus_skip_set()
* @since 1.2
*/
EAPI Eina_Bool ecore_evas_focus_skip_get(const Ecore_Evas *ee);
/**
* @brief Set if this evas should ignore @b all events.
*
* @param ee The Ecore_Evas whose window's to ignore events.
* @param ignore The Ecore_Evas new ignore state.
*
* @warning Support for this depends on the underlying windowing system.
*/
EAPI void ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore);
/**
* @brief Returns the ignore state of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas whose window's ignore events state is returned.
* @return The Ecore_Evas window's ignore state.
*
* @see ecore_evas_ignore_events_set()
*/
EAPI Eina_Bool ecore_evas_ignore_events_get(const Ecore_Evas *ee);
/**
* @brief Query whether an Ecore_Evas' window is visible or not.
*
* @param ee The Ecore_Evas to query.
* @return 1 if visible, 0 if not.
*
* This function queries @p ee and returns 1 if it is visible, and 0 if not.
*
* @see ecore_evas_show()
* @see ecore_evas_hide()
*/
EAPI int ecore_evas_visibility_get(const Ecore_Evas *ee);
/**
* @brief Set the layer of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
* @param layer The layer to put @p ee on.
*
* This function moves @p ee to the layer @p layer.
*
* @warning Support for this depends on the underlying windowing system.
*
* @see ecore_evas_lower()
* @see ecore_evas_raise()
*/
EAPI void ecore_evas_layer_set(Ecore_Evas *ee, int layer);
/**
* @brief Get the layer of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas to set
* @return the layer @p ee's window is on.
*
* @see ecore_evas_layer_set()
* @see ecore_evas_lower()
* @see ecore_evas_raise()
*/
EAPI int ecore_evas_layer_get(const Ecore_Evas *ee);
/**
* @brief Maximize (or unmaximize) an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
* @param on @c EINA_TRUE to maximize, @c EINA_FALSE to unmaximize.
*
* This function maximizes @p ee if @p on is @c EINA_TRUE, or unmaximizes @p ee
* if @p on is @c EINA_FALSE.
*
* @warning Support for this depends on the underlying windowing system.
*/
EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on);
/**
* @brief Query whether an Ecore_Evas' window is maximized or not.
*
* @param ee The Ecore_Evas to set
* @return @c EINA_TRUE if @p ee is maximized, @c EINA_FALSE if not.
*
* @see ecore_evas_maximized_set()
*/
EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee);
/**
* @brief Query if the underlying windowing system supports the window profile.
*
* @param ee The Ecore_Evas
* @return @c EINA_TRUE if the window profile is supported, @c EINA_FALSE otherwise.
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.8.0
*/
EAPI Eina_Bool ecore_evas_window_profile_supported_get(const Ecore_Evas *ee);
/**
* @brief Set the window profile
*
* @param ee The Ecore_Evas to set
* @param profile The string value of the window profile
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.8.0
*/
EAPI void ecore_evas_window_profile_set(Ecore_Evas *ee, const char *profile);
/**
* @brief Get the window profile
*
* @param ee The Ecore_Evas to get the window profile from.
* @return The string value of the window profile, or NULL if none exists
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.8.0
*/
EAPI const char *ecore_evas_window_profile_get(const Ecore_Evas *ee);
/**
* @brief Set the array of available window profiles
*
* @param ee The Ecore_Evas to set
* @param profiles The string array of available window profiels
* @param count The number of members in profiles
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.8.0
*/
EAPI void ecore_evas_window_available_profiles_set(Ecore_Evas *ee, const char **profiles, const unsigned int count);
/**
* @brief Get the array of available window profiles
*
* @param ee The Ecore_Evas to get available window profiles from.
* @param profiles Where to return the string array of available window profiles
* @param count Where to return the number of members in profiles
* @return EINA_TRUE if available window profiles exist, EINA_FALSE otherwise
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.8.0
*/
EAPI Eina_Bool ecore_evas_window_available_profiles_get(Ecore_Evas *ee, char ***profiles, unsigned int *count);
/**
* @brief Send message to parent ecore
*
* @param ee The Ecore_Evas to set
* @param msg_domain The domain of message
* @param msg_id The id of message
* @param data The data of message
* @param size The size of message data
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.8.0
*
* @see ecore_evas_msg_send()
* @see ecore_evas_callback_msg_parent_handle_set()
* @see eecore_evas_callback_msg_handle_set()
*
* This is a list of examples of these functions:
* @li @ref ecore_evas_extn_socket_example
* @li @ref ecore_evas_extn_plug_example
*/
EAPI void ecore_evas_msg_parent_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size);
/**
* @brief Send message to child ecore
*
* @param ee The Ecore_Evas to set
* @param msg_domain The domain of message
* @param msg_id The id of message
* @param data The data of message
* @param size The size of message data
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.8.0
*
* @see ecore_evas_msg_parent_send()
* @see ecore_evas_callback_msg_parent_handle_set()
* @see eecore_evas_callback_msg_handle_set()
*/
EAPI void ecore_evas_msg_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size);
/**
* Set a callback for parent Ecore_Evas message.
*
* @param ee The Ecore_Evas to set callbacks on
* @param func_parent_handle The handle to be called when message arive.
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.8.0
*
* @see ecore_evas_msg_parent_send()
* @see ecore_evas_msg_send()
* @see eecore_evas_callback_msg_handle_set()
*/
EAPI void ecore_evas_callback_msg_parent_handle_set(Ecore_Evas *ee, void (*func_parent_handle)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size));
/**
* Set a callback for child Ecore_Evas message.
*
* @param ee The Ecore_Evas to set callbacks on
* @param func_handle The handle to be called when message arive
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.8.0
*
* @see ecore_evas_msg_parent_send()
* @see ecore_evas_msg_send()
* @see ecore_evas_callback_msg_parent_handle_set()
*/
EAPI void ecore_evas_callback_msg_handle_set(Ecore_Evas *ee, void (*func_handle)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size));
/**
* @brief Move an Ecore_Evas.
*
* @param ee The Ecore_Evas to move
* @param x The x coordinate to move to
* @param y The y coordinate to move to
*
* This moves @p ee to the screen coordinates (@p x, @p y)
*
* @warning Support for this depends on the underlying windowing system.
*
* @see ecore_evas_new()
* @see ecore_evas_resize()
* @see ecore_evas_move_resize()
*/
EAPI void ecore_evas_move(Ecore_Evas *ee, int x, int y);
/**
* @brief Resize an Ecore_Evas.
*
* @param ee The Ecore_Evas to move
* @param w The w coordinate to resize to
* @param h The h coordinate to resize to
*
* This resizes @p ee to @p w x @p h.
*
* @warning Support for this depends on the underlying windowing system.
*
* @see ecore_evas_new()
* @see ecore_evas_move()
* @see ecore_evas_move_resize()
*/
EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h);
/**
* @brief Move and resize an Ecore_Evas
*
* @param ee The Ecore_Evas to move and resize
* @param x The x coordinate to move to
* @param y The y coordinate to move to
* @param w The w coordinate to resize to
* @param h The h coordinate to resize to
*
* This moves @p ee to the screen coordinates (@p x, @p y) and resizes
* it to @p w x @p h.
*
* @warning Support for this depends on the underlying windowing system.
*
* @see ecore_evas_new()
* @see ecore_evas_move()
* @see ecore_evas_resize()
*/
EAPI void ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h);
/**
* @brief Set the rotation of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
* @param rot the angle (in degrees) of rotation.
*
* The allowed values of @p rot depend on the engine being used. Most only
* allow multiples of 90.
*
* @warning Support for this depends on the underlying windowing system.
*
* @see ecore_evas_rotation_with_resize_set()
*/
EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot);
/**
* @brief Set the rotation of an Ecore_Evas' window
*
* @param ee The Ecore_Evas
* @param rot the angle (in degrees) of rotation.
*
* Like ecore_evas_rotation_set(), but it also resizes the window's contents so
* that they fit inside the current window geometry.
*
* @warning Support for this depends on the underlying windowing system.
*
* @see ecore_evas_rotation_set()
*/
EAPI void ecore_evas_rotation_with_resize_set(Ecore_Evas *ee, int rot);
/**
* @brief Get the rotation of an Ecore_Evas' window
*
* @param ee The Ecore_Evas
* @return the angle (in degrees) of rotation.
*
* @see ecore_evas_rotation_set()
* @see ecore_evas_rotation_with_resize_set()
*/
EAPI int ecore_evas_rotation_get(const Ecore_Evas *ee);
/**
* @brief Raise an Ecore_Evas' window.
*
* @param ee The Ecore_Evas to raise.
*
* This functions raises the Ecore_Evas to the front.
*
* @warning Support for this depends on the underlying windowing system.
*
* @see ecore_evas_lower()
* @see ecore_evas_layer_set()
*/
EAPI void ecore_evas_raise(Ecore_Evas *ee);
/**
* @brief Lower an Ecore_Evas' window.
*
* @param ee The Ecore_Evas to raise.
*
* This functions lowers the Ecore_Evas to the back.
*
* @warning Support for this depends on the underlying windowing system.
*
* @see ecore_evas_raise()
* @see ecore_evas_layer_set()
*/
EAPI void ecore_evas_lower(Ecore_Evas *ee);
/**
* @brief Set the title of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas whose title you wish to set.
* @param t The title
*
* This function sets the title of @p ee to @p t.
*
* @warning Support for this depends on the underlying windowing system.
*/
EAPI void ecore_evas_title_set(Ecore_Evas *ee, const char *t);
/**
* @brief Get the title of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas whose title you wish to get.
* @return The title of @p ee.
*
* This function returns the title of @p ee.
*
* @see ecore_evas_title_set()
*/
EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee);
/**
* @brief Set the name and class of an Ecore_Evas' window.
*
* @param ee the Ecore_Evas
* @param n the name
* @param c the class
*
* This function sets the name of @p ee to @p n, and its class to @p c. The
* meaning of @p name and @p class depends on the underlying windowing system.
*
* @warning Support for this depends on the underlying windowing system.
*/
EAPI void ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c);
/**
* @brief Get the name and class of an Ecore_Evas' window
*
* This function gets the name of @p ee into @p n, and its class into
* @p c.
*
* @param ee The Ecore_Evas to query.
* @param n A pointer to a string to place the name in.
* @param c A pointer to a string to place the class in.
* @see ecore_evas_name_class_set()
*/
EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, const char **c);
/**
* @brief Returns a pointer to the underlying window.
*
* @param ee The Ecore_Evas whose window is desired.
* @return A pointer to the underlying window.
*
* @warning Support for this depends on the underlying windowing system.
*/
EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee);
/* engine/target specific init calls */
EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee);
EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee);
EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
/**
* @brief Create a new Ecore_Evas which does not contain an XWindow. It will
* only contain an XPixmap to render to
*
* @warning The XPixmap ID can change with every frame after it is rendered,
* so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you
* need the current pixmap id.
*
* @since 1.8
*/
EAPI Ecore_Evas *ecore_evas_software_x11_pixmap_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
/**
* @brief Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas
*
* @param ee The Ecore_Evas whose pixmap is desired.
* @return The underlying Ecore_X_Pixmap
*
* @warning Support for this depends on the underlying windowing system.
*
* @warning The XPixmap ID can change with every frame after it is rendered,
* so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you
* need the current pixmap id.
*
* @since 1.8
*/
EAPI Ecore_X_Pixmap ecore_evas_software_x11_pixmap_get(const Ecore_Evas *ee);
#define ECORE_EVAS_GL_X11_OPT_NONE 0
#define ECORE_EVAS_GL_X11_OPT_INDIRECT 1
#define ECORE_EVAS_GL_X11_OPT_VSYNC 2
#define ECORE_EVAS_GL_X11_OPT_SWAP_MODE 3
#define ECORE_EVAS_GL_X11_OPT_LAST 4
#define ECORE_EVAS_GL_X11_SWAP_MODE_AUTO 0
#define ECORE_EVAS_GL_X11_SWAP_MODE_FULL 1
#define ECORE_EVAS_GL_X11_SWAP_MODE_COPY 2
#define ECORE_EVAS_GL_X11_SWAP_MODE_DOUBLE 3
#define ECORE_EVAS_GL_X11_SWAP_MODE_TRIPLE 4
EAPI Ecore_Evas *ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
EAPI Ecore_Evas *ecore_evas_gl_x11_options_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h, const int *opt);
EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee);
EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee);
EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
EAPI void ecore_evas_gl_x11_pre_post_swap_callback_set(const Ecore_Evas *ee, void *data, void (*pre_cb) (void *data, Evas *e), void (*post_cb) (void *data, Evas *e));
/**
* @brief Create a new Ecore_Evas which does not contain an XWindow. It will
* only contain an XPixmap to render to
*
* @warning The XPixmap ID can change with every frame after it is rendered,
* so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you
* need the current pixmap id.
*
* @since 1.8
*/
EAPI Ecore_Evas *ecore_evas_gl_x11_pixmap_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
/**
* @brief Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas
*
* @param ee The Ecore_Evas whose pixmap is desired.
* @return The underlying Ecore_X_Pixmap
*
* @warning Support for this depends on the underlying windowing system.
*
* @warning The XPixmap ID can change with every frame after it is rendered,
* so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you
* need the current pixmap id.
*
* @since 1.8
*/
EAPI Ecore_X_Pixmap ecore_evas_gl_x11_pixmap_get(const Ecore_Evas *ee);
EAPI Ecore_Evas *ecore_evas_xrender_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h) EINA_DEPRECATED;
EAPI Ecore_X_Window ecore_evas_xrender_x11_window_get(const Ecore_Evas *ee) EINA_DEPRECATED;
EAPI void ecore_evas_xrender_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on) EINA_DEPRECATED;
EAPI Eina_Bool ecore_evas_xrender_x11_direct_resize_get(const Ecore_Evas *ee) EINA_DEPRECATED;
EAPI void ecore_evas_xrender_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win) EINA_DEPRECATED;
EAPI Ecore_Evas *ecore_evas_software_x11_8_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h) EINA_DEPRECATED;
EAPI Ecore_X_Window ecore_evas_software_x11_8_window_get(const Ecore_Evas *ee) EINA_DEPRECATED;
EAPI Ecore_X_Window ecore_evas_software_x11_8_subwindow_get(const Ecore_Evas *ee) EINA_DEPRECATED;
EAPI void ecore_evas_software_x11_8_direct_resize_set(Ecore_Evas *ee, Eina_Bool on) EINA_DEPRECATED;
EAPI Eina_Bool ecore_evas_software_x11_8_direct_resize_get(const Ecore_Evas *ee) EINA_DEPRECATED;
EAPI void ecore_evas_software_x11_8_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win) EINA_DEPRECATED;
EAPI Ecore_Evas *ecore_evas_software_x11_16_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h) EINA_DEPRECATED;
EAPI Ecore_X_Window ecore_evas_software_x11_16_window_get(const Ecore_Evas *ee) EINA_DEPRECATED;
EAPI void ecore_evas_software_x11_16_direct_resize_set(Ecore_Evas *ee, Eina_Bool on) EINA_DEPRECATED;
EAPI Eina_Bool ecore_evas_software_x11_16_direct_resize_get(const Ecore_Evas *ee) EINA_DEPRECATED;
EAPI void ecore_evas_software_x11_16_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win) EINA_DEPRECATED;
EAPI Ecore_Evas *ecore_evas_fb_new(const char *disp_name, int rotation, int w, int h);
EAPI Ecore_Evas *ecore_evas_directfb_new(const char *disp_name, int windowed, int x, int y, int w, int h) EINA_DEPRECATED;
EAPI Ecore_DirectFB_Window *ecore_evas_directfb_window_get(const Ecore_Evas *ee) EINA_DEPRECATED;
EAPI Ecore_Evas *ecore_evas_wayland_shm_new(const char *disp_name, unsigned int parent, int x, int y, int w, int h, Eina_Bool frame);
EAPI Ecore_Evas *ecore_evas_wayland_egl_new(const char *disp_name, unsigned int parent, int x, int y, int w, int h, Eina_Bool frame);
EAPI void ecore_evas_wayland_resize(Ecore_Evas *ee, int location);
EAPI void ecore_evas_wayland_move(Ecore_Evas *ee, int x, int y);
EAPI void ecore_evas_wayland_pointer_set(Ecore_Evas *ee, int hot_x, int hot_y);
EAPI void ecore_evas_wayland_type_set(Ecore_Evas *ee, int type);
EAPI Ecore_Wl_Window *ecore_evas_wayland_window_get(const Ecore_Evas *ee);
EAPI Ecore_Evas *ecore_evas_drm_new(const char *device, unsigned int parent, int x, int y, int w, int h);
/**
* @brief Create a new @c Ecore_Evas canvas bound to the Evas
* @b buffer engine
*
* @param w The width of the canvas, in pixels
* @param h The height of the canvas, in pixels
* @return A new @c Ecore_Evas instance or @c NULL, on failure
*
* This creates a new buffer canvas wrapper, with image data array
* @b bound to the ARGB format, 8 bits per pixel.
*
* This function will allocate the needed pixels array with canonical
* @c malloc(). If you wish a custom function to allocate it, consider
* using ecore_evas_buffer_allocfunc_new(), instead.
*
* @note This function actually is a wrapper on
* ecore_evas_buffer_allocfunc_new(), using the same @a w and @a h
* arguments and canonical @c malloc() and @c free() to the memory
* allocation and freeing functions. See that function's documentation
* for more details.
*/
EAPI Ecore_Evas *ecore_evas_buffer_new(int w, int h);
/**
* @brief Create a new @c Ecore_Evas canvas bound to the Evas
* @b buffer engine, giving custom allocation and freeing functions for
* the canvas memory region
*
* @param w The width of the canvas, in canvas units
* @param h The height of the canvas, in canvas units
* @param alloc_func Function to be called to allocate the memory
* needed for the new buffer canvas. @a data will be passed the same
* value as the @p data of this function, while @a size will be passed
* @p w times @p h times @c sizeof(int).
* @param free_func Function to be called to free the memory used by
* the new buffer canvas. @a data will be passed the same value as the
* @p data of this function, while @a pix will be passed the canvas
* memory pointer.
* @param data Custom data to be passed to the allocation and freeing
* functions
* @return A new @c Ecore_Evas instance or @c NULL, on failure
*
* This creates a new buffer canvas wrapper, with image data array
* @b bound to the ARGB format, 8 bits per pixel.
*
* This function is useful when one wants an @c Ecore_Evas buffer
* canvas with a custom allocation function, like one getting memory
* chunks from a memory pool, for example.
*
* On any resizing of this @c Ecore_Evas buffer canvas, its image data
* will be @b freed, to be allocated again with the new size.
*
* @note @p w and @p h sizes have to greater or equal to 1. Otherwise,
* they'll be interpreted as 1, exactly.
*
* @see ecore_evas_buffer_new()
*/
EAPI Ecore_Evas *ecore_evas_buffer_allocfunc_new(int w, int h, void *(*alloc_func) (void *data, int size), void (*free_func) (void *data, void *pix), const void *data);
/**
* @brief Grab a pointer to the actual pixels array of a given
* @c Ecore_Evas @b buffer canvas/window.
*
* @param ee An @c Ecore_Evas handle
* @return A pointer to the internal pixels array of @p ee
*
* Besides returning a pointer to the actual pixel array of the given
* canvas, this call will force a <b>rendering update on @p ee</b>,
* first.
*
* A common use case for this call is to create an image object, from
* @b another canvas, to have as data @p ee's contents, thus
* snapshoting the canvas. For that case, one can also use the
* ecore_evas_object_image_new() helper function.
*/
EAPI const void *ecore_evas_buffer_pixels_get(Ecore_Evas *ee);
/**
* @brief Create a new @c Ecore_Evas canvas bound to the Evas
* @b ews (Ecore + Evas Single Process Windowing System) engine
*
* EWS is a simple single process windowing system. The backing store
* is also an @c Ecore_Evas that can be setup with
* ecore_evas_ews_setup() and retrieved with
* ecore_evas_ews_ecore_evas_get(). It will allow window management
* using events prefixed with @c ECORE_EVAS_EVENT_EWS_.
*
* The EWS windows (returned by this function or
* ecore_evas_new("ews"...)) will all be software buffer windows
* automatic rendered to the backing store.
*
* @param x horizontal position of window, in pixels
* @param y vertical position of window, in pixels
* @param w The width of the canvas, in pixels
* @param h The height of the canvas, in pixels
* @return A new @c Ecore_Evas instance or @c NULL, on failure
*
* @see ecore_evas_ews_setup()
* @see ecore_evas_ews_ecore_evas_get()
*
* @since 1.1
*/
EAPI Ecore_Evas *ecore_evas_ews_new(int x, int y, int w, int h);
/**
* Returns the backing store image object that represents the given
* window in EWS.
* @return The evas object of EWS backing store.
*
* @note This should not be modified anyhow, but may be helpful to
* determine stacking and geometry of it for window managers
* that decorate windows.
*
* @param ee The Ecore_Evas from which to get the backing store.
* @see ecore_evas_ews_manager_set()
* @see ecore_evas_ews_evas_get()
* @since 1.1
*/
EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee);
/**
* Calls the window to be deleted (freed), but can let user decide to
* forbid it by using ecore_evas_callback_delete_request_set()
*
* @param ee The Ecore_Evas for which window will be deleted.
* @since 1.1
*/
EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee);
/**
* @brief Create an Evas image object with image data <b>bound to an
* own, internal @c Ecore_Evas canvas wrapper</b>
*
* @param ee_target @c Ecore_Evas to have the canvas receiving the new
* image object
* @return A handle to the new image object
*
* This will create a @b special Evas image object. The image's pixel
* array will get bound to the same image data array of an @b internal
* @b buffer @c Ecore_Evas canvas. The user of this function is, then,
* supposed to grab that @c Ecore_Evas handle, with
* ecore_evas_object_ecore_evas_get(), and use its canvas to render
* whichever contents he/she wants, @b independently of the contents
* of the canvas owned by @p ee_target. Those contents will reflect on
* the canvas of @p ee, though, being exactly the image data of the
* object returned by this function.
*
* This is a helper function for the scenario of one wanting to grab a
* buffer canvas' contents (with ecore_evas_buffer_pixels_get()) to be
* used on another canvas, for whichever reason. The most common goal
* of this setup is to @b save an image file with a whole canvas as
* contents, which could not be achieved by using an image file within
* the target canvas.
*
* @warning Always resize the returned image and its underlying
* @c Ecore_Evas handle accordingly. They must be kept with same sizes
* for things to work as expected. Also, you @b must issue
* @c evas_object_image_size_set() on the image with that same size. If
* the image is to be shown in a canvas bound to an engine different
* than the buffer one, then you must also set this image's @b fill
* properties accordingly.
*
* @note The image returned will always be bound to the
* @c EVAS_COLORSPACE_ARGB8888 colorspace, always.
*
* @note Use ecore_evas_object_evas_get() to grab the image's internal
* own canvas directly.
*
* @note If snapshoting this image's internal canvas, remember to
* flush its internal @c Ecore_Evas firstly, with
* ecore_evas_manual_render().
*/
EAPI Evas_Object *ecore_evas_object_image_new(Ecore_Evas *ee_target);
/**
* @brief Retrieve the internal @c Ecore_Evas handle of an image
* object created via ecore_evas_object_image_new()
*
* @param obj A handle to an image object created via
* ecore_evas_object_image_new()
* @return The underlying @c Ecore_Evas handle in @p obj
*/
EAPI Ecore_Evas *ecore_evas_object_ecore_evas_get(Evas_Object *obj);
/**
* @brief Retrieve the canvas bound to the internal @c Ecore_Evas
* handle of an image object created via ecore_evas_object_image_new()
*
* @param obj A handle to an image object created via
* ecore_evas_object_image_new()
* @return A handle to @p obj's underlying @c Ecore_Evas's canvas
*/
EAPI Evas *ecore_evas_object_evas_get(Evas_Object *obj);
EAPI Ecore_Evas *ecore_evas_software_gdi_new(Ecore_Win32_Window *parent,
int x,
int y,
int width,
int height);
EAPI Ecore_Evas *ecore_evas_software_ddraw_new(Ecore_Win32_Window *parent,
int x,
int y,
int width,
int height);
EAPI Ecore_Evas *ecore_evas_software_16_ddraw_new(Ecore_Win32_Window *parent,
int x,
int y,
int width,
int height);
EAPI Ecore_Evas *ecore_evas_direct3d_new(Ecore_Win32_Window *parent,
int x,
int y,
int width,
int height);
EAPI Ecore_Evas *ecore_evas_gl_glew_new(Ecore_Win32_Window *parent,
int x,
int y,
int width,
int height);
EAPI Ecore_Win32_Window *ecore_evas_win32_window_get(const Ecore_Evas *ee);
EAPI Ecore_Evas *ecore_evas_sdl_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha);
EAPI Ecore_Evas *ecore_evas_sdl16_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha);
EAPI Ecore_Evas *ecore_evas_gl_sdl_new(const char* name, int w, int h, int fullscreen, int noframe);
EAPI Ecore_Evas *ecore_evas_software_wince_new(Ecore_WinCE_Window *parent,
int x,
int y,
int width,
int height) EINA_DEPRECATED;
EAPI Ecore_Evas *ecore_evas_software_wince_fb_new(Ecore_WinCE_Window *parent,
int x,
int y,
int width,
int height) EINA_DEPRECATED;
EAPI Ecore_Evas *ecore_evas_software_wince_gapi_new(Ecore_WinCE_Window *parent,
int x,
int y,
int width,
int height) EINA_DEPRECATED;
EAPI Ecore_Evas *ecore_evas_software_wince_ddraw_new(Ecore_WinCE_Window *parent,
int x,
int y,
int width,
int height) EINA_DEPRECATED;
EAPI Ecore_Evas *ecore_evas_software_wince_gdi_new(Ecore_WinCE_Window *parent,
int x,
int y,
int width,
int height) EINA_DEPRECATED;
EAPI Ecore_WinCE_Window *ecore_evas_software_wince_window_get(const Ecore_Evas *ee) EINA_DEPRECATED;
EAPI Ecore_Evas *ecore_evas_cocoa_new(Ecore_Cocoa_Window *parent,
int x,
int y,
int w,
int h);
EAPI Ecore_Evas *ecore_evas_psl1ght_new(const char* name, int w, int h);
/* generic manipulation calls */
/**
* @brief Get the engine name used by this Ecore_Evas(window).
*
* @param ee Ecore_Evas whose engine's name is desired.
* @return A string that can(usually) be used in ecore_evas_new()
*
* @see ecore_evas_free()
*/
EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee);
/**
* @brief Return the Ecore_Evas for this Evas
*
* @param e The Evas to get the Ecore_Evas from
* @return The Ecore_Evas that holds this Evas, or @c NULL if not held by one.
*
* @warning Only use on Evas' created with ecore evas!
*/
EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e);
/**
* @brief Free an Ecore_Evas
*
* @param ee The Ecore_Evas to free
*
* This frees up any memory used by the Ecore_Evas.
*/
EAPI void ecore_evas_free(Ecore_Evas *ee);
/**
* @brief Retrieve user data associated with an Ecore_Evas.
*
* @param ee The Ecore_Evas to retrieve the user data from.
* @param key The key which the user data to be retrieved is associated with.
*
* This function retrieves user specific data that has been stored within an
* Ecore_Evas structure with ecore_evas_data_set().
*
* @returns @c NULL on error or no data found, A pointer to the user data on
* success.
*
* @see ecore_evas_data_set()
*/
EAPI void *ecore_evas_data_get(const Ecore_Evas *ee, const char *key);
/**
* @brief Store user data in an Ecore_Evas structure.
*
* @param ee The Ecore_Evas to store the user data in.
* @param key A unique string to associate the user data against. Cannot
* be NULL.
* @param data A pointer to the user data to store.
*
* This function associates the @p data with a @p key which is stored by
* the Ecore_Evas @p ee. Be aware that a call to ecore_evas_free() will
* not free any memory for the associated user data, this is the responsibility
* of the caller.
*
* @see ecore_evas_callback_pre_free_set()
* @see ecore_evas_free()
* @see ecore_evas_data_get()
*/
EAPI void ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void *data);
/**
* Set a callback for Ecore_Evas resize events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee is resized.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas move events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee is moved.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_move_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas show events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee is shown.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_show_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas hide events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee is hidden.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_hide_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas delete request events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee gets a delete request.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_delete_request_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas destroy events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee is destroyed.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_destroy_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas focus in events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee gets focus.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_focus_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas focus out events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee loses focus.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas sticky events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee becomes sticky.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas un-sticky events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee becomes un-sticky.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas mouse in events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever the mouse enters @p ee.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas mouse out events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever the mouse leaves @p ee.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas pre render events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called just before the evas in @p ee is rendered.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_pre_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas mouse post render events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called just after the evas in @p ee is rendered.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_post_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas pre-free event.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called just before the instance @p ee is freed.
*
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_pre_free_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Set a callback for Ecore_Evas state changes.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
* A call to this function will set a callback on an Ecore_Evas, causing
* @p func to be called whenever @p ee changes state.
*
* @since 1.2
* @warning If and when this function is called depends on the underlying
* windowing system.
*/
EAPI void ecore_evas_callback_state_change_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
* Get an Ecore_Evas's Evas
* @param ee The Ecore_Evas whose Evas you wish to get
* @return The Evas wrapped by @p ee
*
* This function returns the Evas contained within @p ee.
*/
EAPI Evas *ecore_evas_get(const Ecore_Evas *ee);
/**
* Provide Managed move co-ordinates for an Ecore_Evas
* @param ee The Ecore_Evas to move
* @param x The x coordinate to set as the managed location
* @param y The y coordinate to set as the managed location
*
* This sets the managed geometry position of the @p ee to (@p x, @p y)
*/
EAPI void ecore_evas_managed_move(Ecore_Evas *ee, int x, int y);
/**
* Set whether an Ecore_Evas is shaped or not.
*
* @param ee The Ecore_Evas to shape.
* @param shaped @c EINA_TRUE to shape, @c EINA_FALSE to not.
*
* This function allows one to make an Ecore_Evas shaped to the contents of the
* evas. If @p shaped is @c EINA_TRUE, @p ee will be transparent in parts of
* the evas that contain no objects. If @p shaped is @c EINA_FALSE, then @p ee
* will be rectangular, and parts with no data will show random framebuffer
* artifacting. For non-shaped Ecore_Evases, it is recommended to cover the
* entire evas with a background object.
*/
EAPI void ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped);
/**
* Query whether an Ecore_Evas is shaped or not.
*
* @param ee The Ecore_Evas to query.
* @return @c EINA_TRUE if shaped, @c EINA_FALSE if not.
*
* This function returns @c EINA_TRUE if @p ee is shaped, and @c EINA_FALSE if not.
*/
EAPI Eina_Bool ecore_evas_shaped_get(const Ecore_Evas *ee);
/**
* @brief Show an Ecore_Evas' window
*
* @param ee The Ecore_Evas to show.
*
* This function makes @p ee visible.
*/
EAPI void ecore_evas_show(Ecore_Evas *ee);
/**
* @brief Hide an Ecore_Evas' window
*
* @param ee The Ecore_Evas to hide.
*
* This function makes @p ee hidden(not visible).
*/
EAPI void ecore_evas_hide(Ecore_Evas *ee);
/**
* Activate (set focus to, via the window manager) an Ecore_Evas' window.
* @param ee The Ecore_Evas to activate.
*
* This functions activates the Ecore_Evas.
*/
EAPI void ecore_evas_activate(Ecore_Evas *ee);
/**
* Set the minimum size of a given @c Ecore_Evas window
*
* @param ee An @c Ecore_Evas window's handle
* @param w The minimum width
* @param h The minimum height
*
* This function sets the minimum size of @p ee to be @p w x @p h.
* One won't be able to resize that window to dimensions smaller than
* the ones set.
*
* @note When base sizes are set, via ecore_evas_size_base_set(),
* they'll be used to calculate a window's minimum size, instead of
* those set by this function.
*
* @see ecore_evas_size_min_get()
*/
EAPI void ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h);
/**
* Get the minimum size set for a given @c Ecore_Evas window
*
* @param ee An @c Ecore_Evas window's handle
* @param w A pointer to an int to place the minimum width in.
* @param h A pointer to an int to place the minimum height in.
*
* @note Use @c NULL pointers on the size components you're not
* interested in: they'll be ignored by the function.
*
* @see ecore_evas_size_min_set() for more details
*/
EAPI void ecore_evas_size_min_get(const Ecore_Evas *ee, int *w, int *h);
/**
* Set the maximum size of a given @c Ecore_Evas window
*
* @param ee An @c Ecore_Evas window's handle
* @param w The maximum width
* @param h The maximum height
*
* This function sets the maximum size of @p ee to be @p w x @p h.
* One won't be able to resize that window to dimensions bigger than
* the ones set.
*
* @see ecore_evas_size_max_get()
*/
EAPI void ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h);
/**
* Get the maximum size set for a given @c Ecore_Evas window
*
* @param ee An @c Ecore_Evas window's handle
* @param w A pointer to an int to place the maximum width in.
* @param h A pointer to an int to place the maximum height in.
*
* @note Use @c NULL pointers on the size components you're not
* interested in: they'll be ignored by the function.
*
* @see ecore_evas_size_max_set() for more details
*/
EAPI void ecore_evas_size_max_get(const Ecore_Evas *ee, int *w, int *h);
/**
* Set the base size for a given @c Ecore_Evas window
*
* @param ee An @c Ecore_Evas window's handle
* @param w The base width
* @param h The base height
*
* This function sets the @b base size of @p ee to be @p w x @p h.
* When base sizes are set, they'll be used to calculate a window's
* @b minimum size, instead of those set by ecore_evas_size_min_get().
*
* @see ecore_evas_size_base_get()
*/
EAPI void ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h);
/**
* Get the base size set for a given @c Ecore_Evas window
*
* @param ee An @c Ecore_Evas window's handle
* @param w A pointer to an int to place the base width in.
* @param h A pointer to an int to place the base height in.
*
* @note Use @c NULL pointers on the size components you're not
* interested in: they'll be ignored by the function.
*
* @see ecore_evas_size_base_set() for more details
*/
EAPI void ecore_evas_size_base_get(const Ecore_Evas *ee, int *w, int *h);
/**
* Set the "size step" for a given @c Ecore_Evas window
*
* @param ee An @c Ecore_Evas window's handle
* @param w The step width
* @param h The step height
*
* This function sets the size steps of @p ee to be @p w x @p h. This
* limits the size of this @c Ecore_Evas window to be @b always an
* integer multiple of the step size, for each axis.
*/
EAPI void ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h);
/**
* Get the "size step" set for a given @c Ecore_Evas window
*
* @param ee An @c Ecore_Evas window's handle
* @param w A pointer to an int to place the step width in.
* @param h A pointer to an int to place the step height in.
*
* @note Use @c NULL pointers on the size components you're not
* interested in: they'll be ignored by the function.
*
* @see ecore_evas_size_base_set() for more details
*/
EAPI void ecore_evas_size_step_get(const Ecore_Evas *ee, int *w, int *h);
/**
* @brief Set the cursor of an Ecore_Evas.
*
* @param ee The Ecore_Evas
* @param file The path to an image file for the cursor.
* @param layer The layer in which the cursor will appear.
* @param hot_x The x coordinate of the cursor's hot spot.
* @param hot_y The y coordinate of the cursor's hot spot.
*
* This function makes the mouse cursor over @p ee be the image specified by
* @p file. The actual point within the image that the mouse is at is specified
* by @p hot_x and @p hot_y, which are coordinates with respect to the top left
* corner of the cursor image.
*
* @note This function creates an object from the image and uses
* ecore_evas_object_cursor_set().
*
* @see ecore_evas_object_cursor_set()
*/
EAPI void ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y);
/**
* @brief Get information about an Ecore_Evas' cursor
*
* @param ee The Ecore_Evas to set
* @param obj A pointer to an Evas_Object to place the cursor Evas_Object.
* @param layer A pointer to an int to place the cursor's layer in.
* @param hot_x A pointer to an int to place the cursor's hot_x coordinate in.
* @param hot_y A pointer to an int to place the cursor's hot_y coordinate in.
*
* This function queries information about an Ecore_Evas' cursor.
*
* @see ecore_evas_cursor_set()
* @see ecore_evas_object_cursor_set()
*/
EAPI void ecore_evas_cursor_get(const Ecore_Evas *ee, Evas_Object **obj, int *layer, int *hot_x, int *hot_y);
/**
* @brief Set the cursor of an Ecore_Evas
*
* @param ee The Ecore_Evas
*
* @param obj The Evas_Object which will be the cursor.
* @param layer The layer in which the cursor will appear.
* @param hot_x The x coordinate of the cursor's hot spot.
* @param hot_y The y coordinate of the cursor's hot spot.
*
* This function makes the mouse cursor over @p ee be the object specified by
* @p obj. The actual point within the object that the mouse is at is specified
* by @p hot_x and @p hot_y, which are coordinates with respect to the top left
* corner of the cursor object.
*
* @see ecore_evas_cursor_set()
*/
EAPI void ecore_evas_object_cursor_set(Ecore_Evas *ee, Evas_Object *obj, int layer, int hot_x, int hot_y);
/**
* Tell the WM whether or not to ignore an Ecore_Evas' window
*
* @param ee The Ecore_Evas.
* @param on @c EINA_TRUE to ignore, @c EINA_FALSE to not.
*
* This function causes the window manager to ignore @p ee if @p on is
* @c EINA_TRUE, or not ignore @p ee if @p on is @c EINA_FALSE.
*/
EAPI void ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on);
/**
* Query whether an Ecore_Evas' window is overridden or not
*
* @param ee The Ecore_Evas to set.
* @return @c EINA_TRUE if @p ee is overridden, @c EINA_FALSE if not.
*/
EAPI Eina_Bool ecore_evas_override_get(const Ecore_Evas *ee);
/**
* Set whether or not an Ecore_Evas' window should avoid damage
*
* @param ee The Ecore_Evas
* @param on The type of the damage management
*
* This option causes updates of the Ecore_Evas to be done on a pixmap, and
* then copied to the window, or the pixmap used directly on the window,
* depending on the setting. Possible options are:
*
* @li @ref ECORE_EVAS_AVOID_DAMAGE_NONE - every expose event triggers a new
* damage and consequently render of the affected area. The rendering of things
* happens directly on the window;
*
* @li @ref ECORE_EVAS_AVOID_DAMAGE_EXPOSE - there's a pixmap where everything
* is rendered into, and then copied to the window. On expose events, there's
* no need to render things again, just to copy the exposed region to the
* window;
*
* @li @ref ECORE_EVAS_AVOID_DAMAGE_BUILT_IN - there's the same pixmap as the
* previous one, but it is set as a "background pixmap" of the window. The
* rendered things appear directly on the window, with no need to copy
* anything, but would stay stored on the pixmap, so there's no need to render
* things again on expose events. This option can be faster than the previous
* one, but may lead to artifacts during resize of the window.
*/
EAPI void ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Damage_Type on);
/**
* Query whether an Ecore_Evas' window avoids damage or not
* @param ee The Ecore_Evas to set
* @return The type of the damage management
*
*/
EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas *ee);
/**
* Set the withdrawn state of an Ecore_Evas' window.
* @param ee The Ecore_Evas whose window's withdrawn state is set.
* @param withdrawn The Ecore_Evas window's new withdrawn state.
*
*/
EAPI void ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn);
/**
* Returns the withdrawn state of an Ecore_Evas' window.
* @param ee The Ecore_Evas whose window's withdrawn state is returned.
* @return The Ecore_Evas window's withdrawn state.
*
*/
EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee);
/**
* Set the sticky state of an Ecore_Evas window.
*
* @param ee The Ecore_Evas whose window's sticky state is set.
* @param sticky The Ecore_Evas window's new sticky state.
*
*/
EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky);
/**
* Returns the sticky state of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas whose window's sticky state is returned.
* @return The Ecore_Evas window's sticky state.
*
*/
EAPI Eina_Bool ecore_evas_sticky_get(const Ecore_Evas *ee);
EAPI void ecore_evas_manual_render_set(Ecore_Evas *ee, Eina_Bool manual_render);
EAPI Eina_Bool ecore_evas_manual_render_get(const Ecore_Evas *ee);
/**
* @brief Registers an @c Ecore_Evas to receive events through ecore_input_evas.
*
* @param ee The @c Ecore_Evas handle.
*
* This function calls ecore_event_window_register() with the @p ee as its @c
* id argument, @c window argument, and uses its @c Evas too. It is useful when
* no @c window information is available on a given @c Ecore_Evas backend.
*
* @see ecore_evas_input_event_unregister()
* @since 1.1
*/
EAPI void ecore_evas_input_event_register(Ecore_Evas *ee);
/**
* @brief Unregisters an @c Ecore_Evas receiving events through ecore_input_evas.
*
* @param ee The @c Ecore_Evas handle.
*
* @see ecore_evas_input_event_register()
* @since 1.1
*/
EAPI void ecore_evas_input_event_unregister(Ecore_Evas *ee);
/**
* @brief Force immediate rendering on a given @c Ecore_Evas window
*
* @param ee An @c Ecore_Evas handle
*
* Use this call to forcefully flush the @p ee's canvas rendering
* pipeline, thus bring its window to an up to date state.
*/
EAPI void ecore_evas_manual_render(Ecore_Evas *ee);
EAPI void ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync);
EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee);
/**
* @brief Get geometry of screen associated with this Ecore_Evas.
*
* @param ee The Ecore_Evas whose window's to query container screen geometry.
* @param x where to return the horizontal offset value. May be @c NULL.
* @param y where to return the vertical offset value. May be @c NULL.
* @param w where to return the width value. May be @c NULL.
* @param h where to return the height value. May be @c NULL.
*
* @since 1.1
*/
EAPI void ecore_evas_screen_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
/**
* @brief Get the dpi of the screen the Ecore_Evas is primarily on.
*
* @param ee The Ecore_Evas whose window's to query.
* @param xdpi Pointer to integer to store horizontal DPI. May be @c NULL.
* @param ydpi Pointer to integer to store vertical DPI. May be @c NULL.
*
* @since 1.7
*/
EAPI void ecore_evas_screen_dpi_get(const Ecore_Evas *ee, int *xdpi, int *ydpi);
EAPI void ecore_evas_draw_frame_set(Ecore_Evas *ee, Eina_Bool draw_frame);
EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee);
/**
* @brief Associate the given object to this ecore evas.
*
* @param ee The Ecore_Evas to associate to @a obj
* @param obj The object to associate to @a ee
* @param flags The association flags.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* Association means that operations on one will affect the other, for
* example moving the object will move the window, resize the object will
* also affect the ecore evas window, hide and show applies as well.
*
* This is meant to simplify development, since you often need to associate
* these events with your "base" objects, background or bottom-most object.
*
* Be aware that some methods might not be what you would like, deleting
* either the window or the object will delete the other. If you want to
* change that behavior, let's say to hide window when it's closed, you
* must use ecore_evas_callback_delete_request_set() and set your own code,
* like ecore_evas_hide(). Just remember that if you override delete_request
* and still want to delete the window/object, you must do that yourself.
*
* Since we now define delete_request, deleting windows will not quit
* main loop, if you wish to do so, you should listen for EVAS_CALLBACK_FREE
* on the object, that way you get notified and you can call
* ecore_main_loop_quit().
*
* Flags can be OR'ed of:
* @li ECORE_EVAS_OBJECT_ASSOCIATE_BASE (or 0): to listen to basic events
* like delete, resize and move, but no stacking or layer are used.
* @li ECORE_EVAS_OBJECT_ASSOCIATE_STACK: stacking operations will act
* on the Ecore_Evas, not the object. So evas_object_raise() will
* call ecore_evas_raise(). Relative operations (stack_above, stack_below)
* are still not implemented.
* @li ECORE_EVAS_OBJECT_ASSOCIATE_LAYER: stacking operations will act
* on the Ecore_Evas, not the object. So evas_object_layer_set() will
* call ecore_evas_layer_set().
* @li ECORE_EVAS_OBJECT_ASSOCIATE_DEL: the object delete will delete the
* ecore_evas as well as delete_requests on the ecore_evas will delete
* etc.
*/
EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags);
/**
* @brief Cancel the association set with ecore_evas_object_associate().
*
* @param ee The Ecore_Evas to dissociate from @a obj
* @param obj The object to dissociate from @a ee
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj);
/**
* @brief Get the object associated with @p ee
*
* @param ee The Ecore_Evas to get the object from.
* @return The associated object, or @c NULL if there is no associated object.
*/
EAPI Evas_Object *ecore_evas_object_associate_get(const Ecore_Evas *ee);
/* helper function to be used with ECORE_GETOPT_CALLBACK_*() */
EAPI unsigned char ecore_getopt_callback_ecore_evas_list_engines(const Ecore_Getopt *parser, const Ecore_Getopt_Desc *desc, const char *str, void *data, Ecore_Getopt_Value *storage);
/**
* @brief Get a list of all the ecore_evases.
*
* @return A list of ecore_evases.
*
* The returned list of ecore evases is only valid until the canvases are
* destroyed (and should not be cached for instance). The list can be freed by
* just deleting the list.
*/
EAPI Eina_List *ecore_evas_ecore_evas_list_get(void);
/**
* @brief Get a list of all the sub ecore_evases.
*
* @param ee Ecore_Evas to get the list from.
* @return A list of sub ecore_evases, or @c NULL if there is no sub ecore_evases.
*/
EAPI Eina_List *ecore_evas_sub_ecore_evas_list_get(const Ecore_Evas *ee);
/* specific calls to an x11 environment ecore_evas */
EAPI void ecore_evas_x11_leader_set(Ecore_Evas *ee, Ecore_X_Window win);
EAPI Ecore_X_Window ecore_evas_x11_leader_get(Ecore_Evas *ee);
EAPI void ecore_evas_x11_leader_default_set(Ecore_Evas *ee);
EAPI void ecore_evas_x11_shape_input_rectangle_set(Ecore_Evas *ee, int x, int y, int w, int h);
EAPI void ecore_evas_x11_shape_input_rectangle_add(Ecore_Evas *ee, int x, int y, int w, int h);
EAPI void ecore_evas_x11_shape_input_rectangle_subtract(Ecore_Evas *ee, int x, int y, int w, int h);
EAPI void ecore_evas_x11_shape_input_empty(Ecore_Evas *ee);
EAPI void ecore_evas_x11_shape_input_reset(Ecore_Evas *ee);
EAPI void ecore_evas_x11_shape_input_apply(Ecore_Evas *ee);
/**
* @defgroup Ecore_Evas_Ews Ecore_Evas Single Process Windowing System.
* @ingroup Ecore_Evas_Group
*
* These are global scope functions to manage the EWS to be used by
* ecore_evas_ews_new().
*
* @since 1.1
* @{
*/
/**
* Sets the engine to be used by the backing store engine.
*
* @param engine The engine to be set.
* @param options The options of the engine to be set.
* @return @c EINA_TRUE on success, @c EINA_FALSE if ews is already in use.
* @since 1.1
*/
EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options);
/**
* Reconfigure the backing store used.
*
* @param x The X coordinate to be used.
* @param y The Y coordinate to be used.
* @param w The width of the Ecore_Evas to setup.
* @param h The height of the Ecore_Evas to setup.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
* @since 1.1
*/
EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h);
/**
* Return the internal backing store in use.
*
* @return The internal backing store in use.
* @note this will forced it to be created, making future calls to
* ecore_evas_ews_engine_set() void.
*
* @see ecore_evas_ews_evas_get()
* @since 1.1
*/
EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void);
/**
* Return the internal backing store in use.
*
* @return The internal backing store in use.
* @note this will forced it to be created, making future calls to
* ecore_evas_ews_engine_set() void.
*
* @see ecore_evas_ews_ecore_evas_get()
* @since 1.1
*/
EAPI Evas *ecore_evas_ews_evas_get(void);
/**
* Get the current background.
*/
EAPI Evas_Object *ecore_evas_ews_background_get(void);
/**
* Set the current background, must be created at evas ecore_evas_ews_evas_get()
*
* It will be kept at lowest layer (EVAS_LAYER_MIN) and below
* everything else. You can set any object, default is a black
* rectangle.
*
* @note previous object will be deleted!
* @param o The Evas_Object for which to set the background.
*/
EAPI void ecore_evas_ews_background_set(Evas_Object *o);
/**
* Return all Ecore_Evas* created by EWS.
*
* @return An eina list of Ecore_evases.
e @note Do not change the returned list or its contents.
* @since 1.1
*/
EAPI const Eina_List *ecore_evas_ews_children_get(void);
/**
* Set the identifier of the manager taking care of internal windows.
*
* The ECORE_EVAS_EWS_EVENT_MANAGER_CHANGE event is issued. Consider
* handling it to know if you should stop handling events yourself
* (ie: another manager took over)
*
* @param manager any unique identifier address.
*
* @see ecore_evas_ews_manager_get()
* @since 1.1
*/
EAPI void ecore_evas_ews_manager_set(const void *manager);
/**
* Get the identifier of the manager taking care of internal windows.
*
* @return the value set by ecore_evas_ews_manager_set()
* @since 1.1
*/
EAPI const void *ecore_evas_ews_manager_get(void);
EAPI extern int ECORE_EVAS_EWS_EVENT_MANAGER_CHANGE; /**< manager was changed @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_ADD; /**< window was created @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_DEL; /**< window was deleted, pointer is already invalid but may be used as reference for further cleanup work. @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_RESIZE; /**< window was resized @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_MOVE; /**< window was moved @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_SHOW; /**< window become visible @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_HIDE; /**< window become hidden @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_FOCUS; /**< window was focused @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_UNFOCUS; /**< window lost focus @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_RAISE; /**< window was raised @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_LOWER; /**< window was lowered @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_ACTIVATE; /**< window was activated @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_ICONIFIED_CHANGE; /**< window minimized/iconified changed @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_MAXIMIZED_CHANGE; /**< window maximized changed @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_LAYER_CHANGE; /**< window layer changed @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_FULLSCREEN_CHANGE; /**< window fullscreen changed @since 1.1 */
EAPI extern int ECORE_EVAS_EWS_EVENT_CONFIG_CHANGE; /**< some other window property changed (title, name, class, alpha, transparent, shaped...) @since 1.1 */
/**
* @}
*/
/**
* @defgroup Ecore_Evas_Extn External plug/socket infrastructure to remote canvases
* @ingroup Ecore_Evas_Group
*
* These functions allow 1 process to create a "socket" was pluged into which another
* process can create a "plug" remotely to plug into.
* Socket can provides content for several plugs.
* This is best for small sized objects (about the size range
* of a small icon up to a few large icons). Sine the plug is actually an
* image object, you can fetch the pixel data
*
* @since 1.2
* @{
*/
EAPI extern int ECORE_EVAS_EXTN_CLIENT_ADD; /**< this event is received when a plug has connected to an extn socket @since 1.2 */
EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a plug has disconnected from an extn socket @since 1.2 */
/**
* @brief Create a new Ecore_Evas canvas for the new external ecore evas socket
*
* @param w The width of the canvas, in pixels
* @param h The height of the canvas, in pixels
* @return A new @c Ecore_Evas instance or @c NULL, on failure
*
* This creates a new extn_socket canvas wrapper, with image data array
* @b bound to the ARGB format, 8 bits per pixel.
*
* If creation is successful, an Ecore_Evas handle is returned or @c NULL if
* creation fails. Also focus, show, hide etc. callbacks will also be called
* if the plug object is shown, or already visible on connect, or if it is
* hidden later, focused or unfocused.
*
* This function has to be flowed by ecore_evas_extn_socket_listen(),
* for starting ecore ipc service.
*
* @code
* Eina_Bool res = EINA_FALSE;
* Ecore_Evas *ee = ecore_evas_extn_socket_new(1, 1);
*
* res = ecore_evas_extn_socket_listen("svcname", 1, EINA_FALSE);
* if (!res) return;
* ecore_evas_resize(ee, 240, 400);
* @endcode
*
* or
*
* @code
* Eina_Bool res = EINA_FALSE;
* Ecore_Evas *ee = ecore_evas_extn_socket_new(240, 400);
*
* res = ecore_evas_extn_socket_listen("svcname", 1, EINA_FALSE);
* if (!res) return;
* @endcode
*
* When a client(plug) connects, you will get the ECORE_EVAS_EXTN_CLIENT_ADD event
* in the ecore event queue, with event_info being the image object pointer
* passed as a void pointer. When a client disconnects you will get the
* ECORE_EVAS_EXTN_CLIENT_DEL event.
*
* You can set up event handles for these events as follows:
*
* @code
* static void client_add_cb(void *data, int event, void *event_info)
* {
* Evas_Object *obj = event_info;
* printf("client added to image object %p\n", obj);
* evas_object_show(obj);
* }
*
* static void client_del_cb(void *data, int event, void *event_info)
* {
* Evas_Object *obj = event_info;
* printf("client deleted from image object %p\n", obj);
* evas_object_hide(obj);
* }
*
* void setup(void)
* {
* ecore_event_handler_add(ECORE_EVAS_EXTN_CLIENT_ADD,
* client_add_cb, NULL);
* ecore_event_handler_add(ECORE_EVAS_EXTN_CLIENT_DEL,
* client_del_cb, NULL);
* }
* @endcode
*
* Note that events come in later after the event happened. You may want to be
* careful as data structures you had associated with the image object
* may have been freed after deleting, but the object may still be around
* awating cleanup and thus still be valid.You can change the size with something like:
*
* @see ecore_evas_extn_socket_listen()
* @see ecore_evas_extn_plug_new()
* @see ecore_evas_extn_plug_object_data_lock()
* @see ecore_evas_extn_plug_object_data_unlock()
*
* @since 1.2
*/
EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h);
/**
* @brief Create a socket to provide the service for external ecore evas
* socket.
*
* @param ee The Ecore_Evas.
* @param svcname The name of the service to be advertised. ensure that it is
* unique (when combined with @p svcnum) otherwise creation may fail.
* @param svcnum A number (any value, @c 0 being the common default) to
* differentiate multiple instances of services with the same name.
* @param svcsys A boolean that if true, specifies to create a system-wide
* service all users can connect to, otherwise the service is private to the
* user ide that created the service.
* @return @c EINA_TRUE if creation is successful, @c EINA_FALSE if it does
* not.
*
* This creates socket specified by @p svcname, @p svcnum and @p svcsys. If
* creation is successful, @c EINA_TRUE is returned or @c EINA_FALSE if
* creation fails.
*
* @see ecore_evas_extn_socket_new()
* @see ecore_evas_extn_plug_new()
* @see ecore_evas_extn_plug_object_data_lock()
* @see ecore_evas_extn_plug_object_data_unlock()
*
* @since 1.2
*/
EAPI Eina_Bool ecore_evas_extn_socket_listen(Ecore_Evas *ee, const char *svcname, int svcnum, Eina_Bool svcsys);
/**
* @brief Lock the pixel data so the socket cannot change it
*
* @param obj The image object returned by ecore_evas_extn_plug_new() to lock
*
* You may need to get the image pixel data with evas_object_image_data_get()
* from the image object, but need to ensure that it does not change while
* you are using the data. This function lets you set an advisory lock on the
* image data so the external plug process will not render to it or alter it.
*
* You should only hold the lock for just as long as you need to read out the
* image data or otherwise deal with it, and then unlock it with
* ecore_evas_extn_plug_object_data_unlock(). Keeping a lock over more than
* 1 iteration of the main ecore loop will be problematic, so avoid it. Also
* forgetting to unlock may cause the socket process to freeze and thus create
* odd behavior.
*
* @see ecore_evas_extn_plug_new()
* @see ecore_evas_extn_plug_object_data_unlock()
*
* @since 1.2
*/
EAPI void ecore_evas_extn_plug_object_data_lock(Evas_Object *obj);
/**
* @brief Unlock the pixel data so the socket can change it again.
*
* @param obj The image object returned by ecore_evas_extn_plug_new() to unlock
*
* This unlocks after an advisor lock has been taken by
* ecore_evas_extn_plug_object_data_lock().
*
* @see ecore_evas_extn_plug_new()
* @see ecore_evas_extn_plug_object_data_lock()
*
* @since 1.2
*/
EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj);
/**
* @brief Create a new external ecore evas plug
*
* @param ee_target The Ecore_Evas containing the canvas in which the new image object will live.
* @return An evas image object that will contain the image output of a socket.
*
* This creates an image object that will contain the output of another
* processes socket canvas when it connects. All input will be sent back to
* this process as well, effectively swallowing or placing the socket process
* in the canvas of the plug process in place of the image object. The image
* object by default is created to be filled (equivalent of
* evas_object_image_filled_add() on creation) so image content will scale
* to fill the image unless otherwise reconfigured. The Ecore_Evas size
* of the plug is the master size and determines size in pixels of the
* plug canvas. You can change the size with something like:
*
* @code
* Eina_Bool res = EINA_FALSE;
* Evas_Object *obj = ecore_evas_extn_plug_new(ee);
*
* res = ecore_evas_extn_plug_connect("svcname", 1, EINA_FALSE);
* if (!res) return;
* ecore_evas_resize(ee, 240, 400);
* @endcode
*
* @see ecore_evas_extn_socket_new()
* @see ecore_evas_extn_plug_connect()
* @since 1.2
*/
EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target);
/**
* @brief Connect an external ecore evas plug to service provided by external
* ecore evas socket.
*
* @param obj The Ecore_Evas containing the canvas in which the new image
* object will live.
* @param svcname The service name to connect to set up by the socket.
* @param svcnum The service number to connect to (set up by socket).
* @param svcsys Boolean to set if the service is a system one or not (set up
* by socket).
* @return @c EINA_TRUE if creation is successful, @c EINA_FALSE if it does
* not.
*
* @see ecore_evas_extn_plug_new()
*
* @since 1.2
*/
EAPI Eina_Bool ecore_evas_extn_plug_connect(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
/**
* @brief Retrieve the coordinates of the mouse pointer
*
* @param ee The Ecore_Evas containing the pointer
* @param x Pointer to integer to store horizontal coordinate. May be @c NULL.
* @param y Pointer to integer to store vertical coordinate. May be @c NULL.
*
* @since 1.8
*/
EAPI void ecore_evas_pointer_xy_get(const Ecore_Evas *ee, Evas_Coord *x, Evas_Coord *y);
/**
* @brief Retrieve the coordinates of the mouse pointer
*
* @param ee The Ecore_Evas containing the pointer
* @param x The horizontal coordinate to move the pointer to
* @param y The vertical coordinate to move the pointer to
*
* @return @c EINA_TRUE on success, EINA_FALSE on failure.
*
* @since 1.8
*/
EAPI Eina_Bool ecore_evas_pointer_warp(const Ecore_Evas *ee, Evas_Coord x, Evas_Coord y);
/**
* @brief Retrieve the Visual used for pixmap creation
*
* @param ee The Ecore_Evas containing the pixmap
*
* @return The Visual which was used when creating the pixmap
*
* @warning If and when this function is called depends on the underlying
* windowing system. This function should only be called if the Ecore_Evas was
* created using @c ecore_evas_software_x11_pixmap_new or @c ecore_evas_gl_x11_pixmap_new
*
* @since 1.8
*/
EAPI void *ecore_evas_pixmap_visual_get(const Ecore_Evas *ee);
/**
* @brief Retrieve the Colormap used for pixmap creation
*
* @param ee The Ecore_Evas containing the pixmap
*
* @return The Colormap which was used when creating the pixmap
*
* @warning If and when this function is called depends on the underlying
* windowing system. This function should only be called if the Ecore_Evas was
* created using @c ecore_evas_software_x11_pixmap_new or @c ecore_evas_gl_x11_pixmap_new
*
* @since 1.8
*/
EAPI unsigned long ecore_evas_pixmap_colormap_get(const Ecore_Evas *ee);
/**
* @brief Retrieve the depth used for pixmap creation
*
* @param ee The Ecore_Evas containing the pixmap
*
* @return The depth which was used when creating the pixmap
*
* @warning If and when this function is called depends on the underlying
* windowing system. This function should only be called if the Ecore_Evas was
* created using @c ecore_evas_software_x11_pixmap_new or @c ecore_evas_gl_x11_pixmap_new
*
* @since 1.8
*/
EAPI int ecore_evas_pixmap_depth_get(const Ecore_Evas *ee);
/**
* @}
*/
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif
|