/usr/include/edje-1/Edje_Edit.h is in libedje-dev 1.8.6-2.5build1.
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 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 | #ifndef _EDJE_EDIT_H
#define _EDJE_EDIT_H
#ifndef EDJE_EDIT_IS_UNSTABLE_AND_I_KNOW_ABOUT_IT
#error "Do not use the Edje_Edit API unless you know what you are doing. It's meant only for writing editors and nothing else."
#endif
#include <Edje.h>
#ifdef EAPI
# undef EAPI
#endif
#ifdef _WIN32
# ifdef EFL_EDJE_BUILD
# ifdef DLL_EXPORT
# define EAPI __declspec(dllexport)
# else
# define EAPI
# endif /* ! DLL_EXPORT */
# else
# define EAPI __declspec(dllimport)
# endif /* ! EFL_EDJE_BUILD */
#else
# ifdef __GNUC__
# if __GNUC__ >= 4
# define EAPI __attribute__ ((visibility("default")))
# else
# define EAPI
# endif
# else
# define EAPI
# endif
#endif
typedef enum _Edje_Edit_Image_Comp
{
EDJE_EDIT_IMAGE_COMP_RAW,
EDJE_EDIT_IMAGE_COMP_USER,
EDJE_EDIT_IMAGE_COMP_COMP,
EDJE_EDIT_IMAGE_COMP_LOSSY
} Edje_Edit_Image_Comp;
struct _Edje_Edit_Script_Error
{
const char *program_name; /* null == group shared script */
int line;
const char *error_str;
};
typedef struct _Edje_Edit_Script_Error Edje_Edit_Script_Error;
/**
* @file
* @brief Functions to deal with edje internal object. Don't use in standard
* situations. The use of any of the edje_edit_* functions can break your
* theme ability, remember that the program must be separated from the interface!
*
* This was intended ONLY for use in an actual edje editor program. Unless
* you are writing one of these, do NOT use this API here.
*
* The API can be used to query or set every part of an edje object in real time.
* You can manage every aspect of parts, part states, programs, script and whatever
* is contained in the edje file. For a reference of what all parameter means
* look at the complete @ref edcref.
*
* Don't forget to free all the strings and the lists returned by any edje_edit_*()
* functions using edje_edit_string_free() and edje_edit_string_list_free() when
* you don't need anymore.
*
* Example: print all the part in a loaded edje_object
* @code
* Eina_List *parts, *l;
* char *part;
*
* parts = edje_edit_parts_list_get(edje_object);
* EINA_LIST_FOREACH(parts, l, part)
* {
* printf("Part: %s\n", part);
* }
* edje_edit_string_list_free(parts);
* @endcode
*
* Example: Change the color of a rect inside an edje file
* @code
* Evas_Object *edje;
*
* edje = edje_edit_object_add(evas);
* edje_object_file_set(edje, "edj/file/name", "group to load");
* edje_edit_state_color_set(edje, "MyRectName", "default", 0.00, 255, 255, 0, 255);
* edje_edit_save(edje);
* @endcode
*
*/
#ifdef __cplusplus
extern "C" {
#endif
/******************************************************************************/
/************************** GENERAL API ***********************************/
/******************************************************************************/
/** @name General API
* General functions that don't fit in other cateories.
*/ //@{
/** Adds an editable Edje object to the canvas.
*
* An Edje_Edit object is, for the most part, a standard Edje object. Only
* difference is you can use the Edje_Edit API on them.
*
* @param e Evas canvas where to add the object.
*
* @return An Evas_Object of type Edje_Edit, or NULL if an error occurred.
*/
EAPI Evas_Object * edje_edit_object_add(Evas *e);
/** Free a generic Eina_List of (char *) allocated by an edje_edit_*_get() function.
*
* @param lst List of strings to free.
*/
EAPI void edje_edit_string_list_free(Eina_List *lst);
/** Free a generic string (char *) allocated by an edje_edit_*_get() function.
*
* @param str String to free.
*/
EAPI void edje_edit_string_free(const char *str);
/** Get the name of the program that compiled the edje file.
* Can be 'edje_cc' or 'edje_edit'
*
* @param obj Object being edited.
*
* @return Compiler stored in the Edje file
*/
EAPI const char * edje_edit_compiler_get(Evas_Object *obj);
/** Save the modified edje object back to his file.
*
* Use this function when you are done with your editing, all the change made
* to the current loaded group will be saved back to the original file.
*
* @note Source for the whole file will be auto generated and will overwrite
* any previously stored source.
*
* @param obj Object to save back to the file it was loaded from.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*
* @todo Add a way to check what the error actually was, the way Edje Load does.
*/
EAPI Eina_Bool edje_edit_save(Evas_Object *obj);
/** Saves every group back into the file.
*
* @param obj Object to save.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*
* @see edje_edit_save()
*/
EAPI Eina_Bool edje_edit_save_all(Evas_Object *obj);
/** Print on standard output many information about the internal status
* of the edje object.
*
* This is probably only useful to debug.
*
* @param obj Object being edited.
*/
EAPI void edje_edit_print_internal_status(Evas_Object *obj);
//@}
/******************************************************************************/
/************************** GROUPS API ************************************/
/******************************************************************************/
/** @name Groups API
* Functions to deal with groups property (see @ref edcref).
*/ //@{
/** Create a new empty group in the given edje.
*
* If a group with the same name exist none is created.
*
* @param obj Object being edited.
* @param name Name of the new group.
*
* @return EINA_TRUE if successfully added the group, EINA_FALSE if an error
* occurred or if a group with the same name exists.
*/
/**
* @brief Add an edje (empty) group to an edje object's group set.
*
* @param obj The pointer to edje object.
* @param name The name of the group.
*
* @return 1 If it could allocate memory to the part group added
* or zero if not.
*
* This function adds, at run time, one more group, which will reside
* in memory, to the group set found in the .edj file which @a obj was
* loaded with. This group can be manipulated by other API functions,
* like @c edje_edit_part_add(), for example. If desired, the new
* group can be actually committed the respective .edj by use of @c
* edje_edit_save().
*
*/
EAPI Eina_Bool edje_edit_group_add(Evas_Object *obj, const char *name);
/** Delete the specified group from the given edje.
*
* You can only delete a currently unused group.
* All the parts and the programs inside the group will be deleted as well,
* but not image or font embedded in the edje.
*
* @param obj Object being edited.
* @param group_name Name of group to delete.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
/**
* @brief Delete the specified group from the edje file.
*
* @param obj The pointer to the edje object.
* @param group_name Group to delete.
*
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
*
* This function deletes the given group from the file @a obj is set to. This
* operation can't be undone as all references to the group are removed from
* the file.
* This function may fail if the group to be deleted is currently in use.
*
*/
EAPI Eina_Bool edje_edit_group_del(Evas_Object *obj, const char *group_name);
/** Check if a group with the given name exist in the edje.
*
* @param obj Object being edited.
* @param group Group name to check for.
*
* @return EINA_TRUE if group exists, EINA_FALSE if not.
*/
EAPI Eina_Bool edje_edit_group_exist(Evas_Object *obj, const char *group);
/** Set a new name for the current open group.
*
* You can only rename a group that is currently loaded
* Note that the relative getter function don't exist as it doesn't make sense ;)
* @param obj Object being edited.
* @param new_name New name for the group.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_name_set(Evas_Object *obj, const char *new_name);
/** Get the group minimum width.
*
* @param obj Object being edited.
*
* @return The minimum width set for the group. -1 if an error occurred.
*/
EAPI int edje_edit_group_min_w_get(Evas_Object *obj);
/** Set the group minimum width.
*
* @param obj Object being edited.
* @param w New minimum width for the group.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_min_w_set(Evas_Object *obj, int w);
/** Get the group minimum height.
*
* @param obj Object being edited.
*
* @return The minimum height set for the group. -1 if an error occurred.
*/
EAPI int edje_edit_group_min_h_get(Evas_Object *obj);
/** Set the group minimum height.
*
* @param obj Object being edited.
* @param h New minimum height for the group.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_min_h_set(Evas_Object *obj, int h);
/** Get the group maximum width.
*
* @param obj Object being edited.
*
* @return The maximum width set for the group. -1 if an error occurred.
*/
EAPI int edje_edit_group_max_w_get(Evas_Object *obj);
/** Set the group maximum width.
*
* @param obj Object being edited.
* @param w New maximum width for the group.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_max_w_set(Evas_Object *obj, int w);
/** Get the group maximum height.
*
* @param obj Object being edited.
*
* @return The maximum height set for the group. -1 if an error occurred.
*/
EAPI int edje_edit_group_max_h_get(Evas_Object *obj);
/** Set the group maximum height.
*
* @param obj Object being edited.
* @param h New maximum height for the group.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_max_h_set(Evas_Object *obj, int h);
//@}
/******************************************************************************/
/************************** DATA API **************************************/
/******************************************************************************/
/** @name Data API
* Functions to deal with data embedded in the edje (see @ref edcref).
*/ //@{
/** Retrieves a list with the item names inside the data block.
*
* @param obj Object being edited.
*
* @return List of strings, each being a name entry in the global data block for the file.
*/
EAPI Eina_List * edje_edit_data_list_get(Evas_Object *obj);
/** Create a new *global* data object in the given edje file.
*
* If another data entry with the same name exists, nothing is created and
* EINA_FALSE is returned.
*
* @param obj Object being edited.
* @param itemname Name for the new data entry.
* @param value Value for the new data entry.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_data_add(Evas_Object *obj, const char *itemname, const char *value);
/** Delete the given data object from edje.
*
* @param obj Object being edited.
* @param itemname Data entry to remove from the global data block.
*
* @return EINA_TRUE on success, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_data_del(Evas_Object *obj, const char *itemname);
/** Get the data associated with the given itemname.
*
* @param obj Object being edited.
* @param itemname Name of the data entry to fetch the value for.
*
* @return Value of the given entry, or NULL if not found.
*/
EAPI const char * edje_edit_data_value_get(Evas_Object *obj, const char *itemname);
/** Set the data associated with the given itemname.
*
* @param obj Object being edited.
* @param itemname Name of data entry to change the value.
* @param value New value for the entry.
*
* @return EINA_TRUE on success, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_data_value_set(Evas_Object *obj, const char *itemname, const char *value);
/** Change the name of the given data object.
*
* @param obj Object being edited.
* @param itemname Data entry to rename.
* @param newname New name for the data entry.
*
* @return EINA_TRUE on success, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_data_name_set(Evas_Object *obj, const char *itemname, const char *newname);
/** Retrieves a list with the item names inside the data block at the group level.
*
* @param obj Object being edited.
*
* @return List of strings, each being a name entry in the data block for the group.
*/
EAPI Eina_List * edje_edit_group_data_list_get(Evas_Object *obj);
/** Create a new data object in the given edje file *belonging to the current group*.
*
* If another data entry with the same name exists,
* nothing is created and EINA_FALSE is returned.
*
* @param obj Object being edited.
* @param itemname Name for the new data entry.
* @param value Value for the new data entry.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_data_add(Evas_Object *obj, const char *itemname, const char *value);
/** Delete the given data object from the group.
*
* @param obj Object being edited.
* @param itemname Name of the data entry to remove.
*
* @return EINA_TRUE on success, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_data_del(Evas_Object *obj, const char *itemname);
/** Get the data associated with the given itemname.
*
* @param obj Object being edited.
* @param itemname Name of the data entry.
*
* @return Value of the data entry or NULL if not found.
*/
EAPI const char * edje_edit_group_data_value_get(Evas_Object *obj, const char *itemname);
/** Set the data associated with the given itemname.
*
* @param obj Object being edited.
* @param itemname Name of the data entry to set the value.
* @param value Value to set for the data entry.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_data_value_set(Evas_Object *obj, const char *itemname, const char *value);
/** Change the name of the given data object.
*
* @param obj Object being edited.
* @param itemname Name of the data entry to rename.
* @param newname New name for the data entry.
*
* @return EINA_TRUE on success, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_data_name_set(Evas_Object *obj, const char *itemname, const char *newname);
//@}
/******************************************************************************/
/*********************** COLOR CLASSES API ********************************/
/******************************************************************************/
/** @name Color Classes API
* Functions to deal with Color Classes (see @ref edcref).
*/ //@{
/** Get the list of all the Color Classes in the given edje object.
*
* @param obj Object being edited.
*
* @return List of strings, each being one color class.
*/
EAPI Eina_List * edje_edit_color_classes_list_get(Evas_Object *obj);
/** Create a new color class object in the given edje.
*
* If another class with the same name exists nothing is created and EINA_FALSE is returned.
*
* @param obj Object being edited.
* @param name Name for the new color class.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_color_class_add(Evas_Object *obj, const char *name);
/** Delete the given class object from edje.
*
* @param obj Object being edited.
* @param name Color class to delete.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_color_class_del(Evas_Object *obj, const char *name);
/** Get all the colors that compose the class.
*
* You can pass NULL to colors you are not intrested in.
*
* @param obj Object being edited.
* @param class_name Color class to fetch values.
* @param r Red component of main color.
* @param g Green component of main color.
* @param b Blue component of main color.
* @param a Alpha component of main color.
* @param r2 Red component of secondary color.
* @param g2 Green component of secondary color.
* @param b2 Blue component of secondary color.
* @param a2 Alpha component of secondary color.
* @param r3 Red component of tertiary color.
* @param g3 Green component of tertiary color.
* @param b3 Blue component of tertiary color.
* @param a3 Alpha component of tertiary color.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_color_class_colors_get(Evas_Object *obj, const char *class_name, int *r, int *g, int *b, int *a, int *r2, int *g2, int *b2, int *a2, int *r3, int *g3, int *b3, int *a3);
/** Set the colors for the given color class.
*
* If you set a color to -1 it will not be touched.
*
* @param obj Object being edited.
* @param class_name Color class to fetch values.
* @param r Red component of main color.
* @param g Green component of main color.
* @param b Blue component of main color.
* @param a Alpha component of main color.
* @param r2 Red component of secondary color.
* @param g2 Green component of secondary color.
* @param b2 Blue component of secondary color.
* @param a2 Alpha component of secondary color.
* @param r3 Red component of tertiary color.
* @param g3 Green component of tertiary color.
* @param b3 Blue component of tertiary color.
* @param a3 Alpha component of tertiary color.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_color_class_colors_set(Evas_Object *obj, const char *class_name, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3);
/** Change the name of a color class.
*
* @param obj Object being edited.
* @param name Color class to rename.
* @param newname New name for the color class.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_color_class_name_set(Evas_Object *obj, const char *name, const char *newname);
//@}
/******************************************************************************/
/************************** TEXT STYLES *************************************/
/******************************************************************************/
/** @name Text styles API
* Functions to deal with text styles (see @ref edcref).
*/ //@{
/** Get the list of all the text styles in the given edje object.
*
* @param obj Object being edited.
*
* @return List of strings, each being the name for a text style.
*/
EAPI Eina_List * edje_edit_styles_list_get(Evas_Object *obj);
/** Create a new text style object in the given edje.
*
* If another style with the same name exists nothing is created and EINA_FALSE is returned.
*
* @param obj Object being edited.
* @param style Name for the new style.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_style_add(Evas_Object *obj, const char *style);
/** Delete the given text style and all the child tags.
*
* @param obj Object being edited.
* @param style Style to delete.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_style_del(Evas_Object *obj, const char *style);
/** Get the list of all the tags name in the given text style.
*
* @param obj Object being edited.
* @param style Style to get the tags for.
*
* @return List of strings, each being one tag in the given style.
*/
EAPI Eina_List * edje_edit_style_tags_list_get(Evas_Object *obj, const char *style);
/** Get the value of the given tag.
*
* @param obj Object being edited.
* @param style Style containing the tag being.
* @param tag Tag to get the value for.
*
* @return Value of the given tag.
*/
EAPI const char * edje_edit_style_tag_value_get(Evas_Object *obj, const char *style, const char *tag);
/** Set the value of the given tag.
*
* @param obj Object being edited.
* @param style Style containing the tag to change.
* @param tag Name of the tag to set the value for.
* @param new_value Value for the tag.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_style_tag_value_set(Evas_Object *obj, const char *style, const char *tag, const char *new_value);
/** Set the name of the given tag.
*
* @param obj Object being edited.
* @param style Style containing the tag to rename.
* @param tag Tag to rename.
* @param new_name New name for the tag.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_style_tag_name_set(Evas_Object *obj, const char *style, const char *tag, const char *new_name);
/** Add a new tag to the given text style.
*
* If another tag with the same name exists nothing is created and EINA_FALSE is returned.
*
* @param obj Object being edited.
* @param style Style where to add the new tag.
* @param tag_name Name for the new tag.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_style_tag_add(Evas_Object *obj, const char *style, const char *tag_name);
/** Delete the given tag.
*
* @param obj Object being edited.
* @param style Style from where to remove the tag.
* @param tag Tag to delete.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_style_tag_del(Evas_Object *obj, const char *style, const char *tag);
//@}
/******************************************************************************/
/************************ EXTERNALS API ***********************************/
/******************************************************************************/
/** @name Externals API
* Functions to deal with list of external modules (see @ref edcref).
*/ //@{
/** Get the list of all the externals requested in the given edje object.
*
* @param obj Object being edited.
*
* @return List of strings, each being an entry in the block of automatically loaded external modules.
*/
EAPI Eina_List * edje_edit_externals_list_get(Evas_Object *obj);
/** Add an external module to be requested on edje load.
*
* @param obj Object being edited.
* @param external Name of the external module to add to the list of autoload.
*
* @return EINA_TRUE on success (or it was already there), EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_external_add(Evas_Object *obj, const char *external);
/** Delete the given external from the list.
*
* @param obj Object being edited.
* @param external Name of the external module to remove from the autoload list.
*
* @return EINA_TRUE on success, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_external_del(Evas_Object *obj, const char *external);
//@}
/******************************************************************************/
/************************** PARTS API *************************************/
/******************************************************************************/
/** @name Parts API
* Functions to deal with part objects (see @ref edcref).
*/ //@{
/** Get the list of all the parts in the given edje object.
*
* @param obj Object being edited.
*
* @return List of strings, each being the name for a part in the open group.
*/
EAPI Eina_List * edje_edit_parts_list_get(Evas_Object *obj);
/** Create a new part in the given edje.
*
* If another part with the same name just exists nothing is created and EINA_FALSE is returned.
* Note that this function also create a default description for the part.
*
* @param obj Object being edited.
* @param name Name for the new part.
* @param type Type of the new part. See @ref edcref for more info on this.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_add(Evas_Object *obj, const char *name, Edje_Part_Type type);
/** Create a new part of type EXTERNAL in the given edje.
*
* If another part with the same name just exists nothing is created and EINA_FALSE is returned.
* Note that this function also create a default description for the part.
*
* @param obj Object being edited.
* @param name Name for the new part.
* @param source The registered external type to use for this part.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_external_add(Evas_Object *obj, const char *name, const char *source);
/** Delete the given part from the edje.
*
* All the reference to this part will be zeroed.
*
* @param obj Object being edited.
* @param part Name of part to delete.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_del(Evas_Object *obj, const char *part);
/** Check if a part with the given name exist in the edje object.
*
* @param obj Object being edited.
* @param part Name of part to check for its existence.
*
* @return EINA_TRUE if the part exists, EINA_FALSE if not.
*/
EAPI Eina_Bool edje_edit_part_exist(Evas_Object *obj, const char *part);
/** Get the name of part stacked above the one passed.
*
* @param obj Object being edited.
* @param part Name of part of which to check the one above.
*
* @return Name of the part above. NULL if an error occurred or if @p part is
* the topmost part in the group.
*/
EAPI const char * edje_edit_part_above_get(Evas_Object *obj, const char *part);
/** Get the name of part stacked below the one passed.
*
* @param obj Object being edited.
* @param part Name of part of which to check the one below.
*
* @return Name of the part below. NULL if an error occurred or if @p part is
* the bottommost part in the group.
*/
EAPI const char * edje_edit_part_below_get(Evas_Object *obj, const char *part);
/** Move the given part below the previous one.
*
* @param obj Object being edited.
* @param part Name of part to move one step below.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_restack_below(Evas_Object *obj, const char *part);
/** Move the given part above the next one.
*
* @param obj Object being edited.
* @param part Name of part to move one step above.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_restack_above(Evas_Object *obj, const char *part);
/** Set a new name for part.
*
* Note that the relative getter function don't exist as it don't make sense ;)
*
* @param obj Object being edited.
* @param part Name of part to rename.
* @param new_name New name for the given part.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_name_set(Evas_Object *obj, const char *part, const char *new_name);
/** Get api's name of a part.
*
* @param obj Object being edited.
* @param part Name of the part.
*
* @return name of the api if successful, NULL otherwise.
*/
EAPI const char * edje_edit_part_api_name_get(Evas_Object *obj, const char *part);
/** Get api's description of a part.
*
* @param obj Object being edited.
* @param part Name of the part.
*
* @return description of the api if successful, NULL otherwise.
*/
EAPI const char * edje_edit_part_api_description_get(Evas_Object *obj, const char *part);
/** Set api's name of a part.
*
* @param obj Object being edited.
* @param part Name of the part.
* @param name New name for the api property.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_api_name_set(Evas_Object *obj, const char *part, const char *name);
/** Set api's description of a part.
*
* @param obj Object being edited.
* @param part Name of part.
* @param description New description for the api property.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_api_description_set(Evas_Object *obj, const char *part, const char *description);
/** Get the type of a part.
*
* @param obj Object being edited.
* @param part Name of part to get the type of.
*
* @return Type of the part. See @ref edcref for details.
*/
EAPI Edje_Part_Type edje_edit_part_type_get(Evas_Object *obj, const char *part);
/** Get the clip_to part.
*
* @param obj Object being edited.
* @param part Name of the part whose clipper to get.
*
* @return Name of the part @p part is clipped to. NULL is returned on errors and if the part don't have a clip.
*/
EAPI const char * edje_edit_part_clip_to_get(Evas_Object *obj, const char *part);
/** Set a part to clip part to.
*
* @param obj Object being edited.
* @param part Part to set the clipper to.
* @param clip_to Part to use as clipper, if NULL then the clipping value will be cancelled (unset clipping).
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_clip_to_set(Evas_Object *obj, const char *part, const char *clip_to);
/** Get the source of part.
*
* The meaning of this parameter varies depending on the type of the part.
* For GROUP parts, it's the name of another group in the Edje file which will
* be autoloaded and swallowed on this part.
* For TEXTBLOCK parts, it's the name of a group to be used for selection
* display under the text.
* For EXTERNAL parts, it's the name of the registered external widget to load
* and swallow on this part.
*
* @param obj Object being edited.
* @param part Part to get the source from.
*
* @return Content of the source parameter or NULL if nothing set or an error occurred.
*/
EAPI const char * edje_edit_part_source_get(Evas_Object *obj, const char *part);
/** Set the source of part.
*
* @param obj Object being edited.
* @param part Part to set the source of.
* @param source Value for the source parameter.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*
* @see edje_edit_part_source_get()
*
* @note You can't change the source for EXTERNAL parts, it's akin to changing
* the type of the part.
*
* NOTE: This is not applied now. You must reload the edje to see the change.
*/
EAPI Eina_Bool edje_edit_part_source_set(Evas_Object *obj, const char *part, const char *source);
/** Get the effect for a given part.
*
* Gets the effect used for parts of type TEXT. See @ref edcref for more details.
*
* @param obj Object being edited.
* @param part Part to get the effect of.
*
* @return The effect set for the part.
*/
EAPI Edje_Text_Effect edje_edit_part_effect_get(Evas_Object *obj, const char *part);
/** Set the effect for a given part.
* Effects and shadow directions can be combined.
*
* For effect and shadow direction list please look at Edje Part Text ref page.
*
* @param obj Object being edited.
* @param part Part to set the effect to. Only makes sense on type TEXT.
* @param effect Effect to set for the part.
*
* @see Edje_Part_Text
*/
EAPI Eina_Bool edje_edit_part_effect_set(Evas_Object *obj, const char *part, Edje_Text_Effect effect);
/** Get the current selected state in part.
*
* @param obj Object being edited.
* @param part Part to get the selected state of.
* @param value Pointer to a double where the value of the state will be stored.
*
* @return The name of the currently selected state for the part.
*/
EAPI const char * edje_edit_part_selected_state_get(Evas_Object *obj, const char *part, double *value);
/** Set the current state in part.
*
* @param obj Object being edited.
* @param part Part to set the state of.
* @param state Name of the state to set.
* @param value Value of the state.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_selected_state_set(Evas_Object *obj, const char *part, const char *state, double value);
/** Get mouse_events for part.
*
* @param obj Object being edited.
* @param part Part to get if the mouse events is accepted.
*
* @return EINA_TRUE if part will accept mouse events, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_mouse_events_get(Evas_Object *obj, const char *part);
/** Set mouse_events for part.
*
* @param obj Object being edited.
* @param part The part to set if the mouse events is accepted.
* @param mouse_events EINA_TRUE if part will accept mouse events, EINA_FALSE otherwise.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_mouse_events_set(Evas_Object *obj, const char *part, Eina_Bool mouse_events);
/** Get repeat_events for part.
*
* @param obj Object being edited.
* @param part Part to get if it will pass all events to the other parts.
*
* @return EINA_TRUE if the events received will propagate to other parts, EINA_FALSE otherwise
*/
EAPI Eina_Bool edje_edit_part_repeat_events_get(Evas_Object *obj, const char *part);
/** Set repeat_events for part.
*
* @param obj Object being edited.
* @param part Part to set if will repeat all the received mouse events to other parts.
* @param repeat_events EINA_TRUE if the events received will propagate to other parts, EINA_FALSE otherwise
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_repeat_events_set(Evas_Object *obj, const char *part, Eina_Bool repeat_events);
/** Get ignore_flags for part.
*
* @param obj Object being edited.
* @param part Part to get which event_flags are being ignored.
*
* @return The Event flags set to the part.
*/
EAPI Evas_Event_Flags edje_edit_part_ignore_flags_get(Evas_Object *obj, const char *part);
/** Set ignore_flags for part.
*
* @param obj Object being edited.
* @param part Part to set which event flags will be ignored.
* @param ignore_flags The Event flags to be ignored by the part.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_ignore_flags_set(Evas_Object *obj, const char *part, Evas_Event_Flags ignore_flags);
/** Set scale property for the part.
*
* This property tells Edje that the given part should be scaled by the
* Edje scale factor.
*
* @param obj Object being edited.
* @param part Part to set scale for.
* @param scale Scale value to set.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_scale_set(Evas_Object *obj, const char *part, Eina_Bool scale);
/** Get scale for the part.
*
* @param obj Object being edited.
* @param part Part to get the scale value of.
*
* @return Whether scale is on (EINA_TRUE) or not.
*/
EAPI Eina_Bool edje_edit_part_scale_get(Evas_Object *obj, const char *part);
/** Get horizontal dragable state for part.
*
* @param obj Object being edited.
* @param part Part to get if can be dragged horizontally;
*
* @return 1 (or -1) if the part can be dragged horizontally, 0 otherwise.
*/
EAPI int edje_edit_part_drag_x_get(Evas_Object *obj, const char *part);
/** Set horizontal dragable state for part.
*
* @param obj Object being edited.
* @param part Part to set if should be dragged horizontally.
* @param drag 1 (or -1) if the part should be dragged horizontally, 0 otherwise.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_x_set(Evas_Object *obj, const char *part, int drag);
/** Get vertical dragable state for part.
*
* @param obj Object being edited.
* @param part Part to get if can be dragged vertically.
*
* @return 1 (or - 1) if the part can be dragged vertically, 0 otherwise.
*/
EAPI int edje_edit_part_drag_y_get(Evas_Object *obj, const char *part);
/** Set vertical dragable state for part.
*
* @param obj Object being edited.
* @param part Part to set if should be dragged vertically.
* @param drag 1 (or -1) of the part shpuld be dragged vertically, 0 otherwise.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_y_set(Evas_Object *obj, const char *part, int drag);
/** Get horizontal dragable step for part.
*
* @param obj Object being edited.
* @param part Part to get the drag horizontal step value.
*
* @return The step value.
*/
EAPI int edje_edit_part_drag_step_x_get(Evas_Object *obj, const char *part);
/** Set horizontal dragable state for part.
*
* @param obj Object being edited.
* @param part Part to set the drag horizontal step value.
* @param step The step the will be dragged.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_step_x_set(Evas_Object *obj, const char *part, int step);
/** Get vertical dragable step for part.
*
* @param obj Object being edited.
* @param part Part to get the drag vertical step value.
*
* @return The step value.
*/
EAPI int edje_edit_part_drag_step_y_get(Evas_Object *obj, const char *part);
/** Set vertical dragable state for part.
*
* @param obj Object being edited.
* @param part Part to set the drag vertical step value.
* @param step The step the will be dragged.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_step_y_set(Evas_Object *obj, const char *part, int step);
/** Get horizontal dragable count for part.
*
* @param obj Object being edited.
* @param part Part to get the drag horizontal count value.
*/
EAPI int edje_edit_part_drag_count_x_get(Evas_Object *obj, const char *part);
/** Set horizontal dragable count for part.
*
* @param obj Object being edited.
* @param part Part to set the drag horizontal count value.
* @param count The count value.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_count_x_set(Evas_Object *obj, const char *part, int count);
/** Get vertical dragable count for part.
*
* @param obj Object being edited.
* @param part Part to get the drag vertical count value.
*/
EAPI int edje_edit_part_drag_count_y_get(Evas_Object *obj, const char *part);
/** Set vertical dragable count for part.
*
* @param obj Object being edited.
* @param part Part to set the drag vertical count value.
* @param count The count value.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_count_y_set(Evas_Object *obj, const char *part, int count);
/** Get the name of the part that is used as 'confine' for the given draggies.
*
* @param obj Object being edited.
* @param part Part to get the name that is used as 'confine' for the given draggies.
*
* @return The name of the confine part or NULL (if unset).
*/
EAPI const char * edje_edit_part_drag_confine_get(Evas_Object *obj, const char *part);
/** Set the name of the part that is used as 'confine' for the given draggies.
*
* @param obj Object being edited.
* @param part Part to set the name that is used as 'confine' for the given draggies.
* @param confine The name of the confine part or NULL to unset confine.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_confine_set(Evas_Object *obj, const char *part, const char *confine);
/** Get the name of the part that is used as the receiver of the drag event.
*
* @param obj Object being edited.
* @param part Part to get the name that is used as the receiver of the drag event.
*
* @return The name of the part that will receive events, or NULL (if unset).
*/
EAPI const char * edje_edit_part_drag_event_get(Evas_Object *obj, const char *part);
/** Set the name of the part that will receive events from the given draggies.
*
* @param obj Object being edited.
* @param part Part to set the name that will receive events from the given draggies.
* @param event The name of the part that will receive events, or NULL to unset.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_event_set(Evas_Object *obj, const char *part, const char *event);
/** Get the name of the part that is used as 'threshold' for the given draggies.
*
* @param obj Object being edited.
* @param part Part to get the name that is used as 'threshold' for the given draggies.
*
* @return The name of the threshold part or NULL (if unset).
*/
EAPI const char * edje_edit_part_drag_threshold_get(Evas_Object *obj, const char *part);
/** Set the name of the part that is used as 'threshold' for the given draggies.
*
* @param obj Object being edited.
* @param part Part to set the name that is used as 'threshold' for the given draggies.
* @param confine The name of the threshold part or NULL to unset confine.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_threshold_set(Evas_Object *obj, const char *part, const char *threshold);
//@}
/******************************************************************************/
/************************** STATES API ************************************/
/******************************************************************************/
/** @name States API
* Functions to deal with part states (see @ref edcref).
*/ //@{
/** Get the list of all the states in the given part.
*
* @param obj Object being edited.
* @param part Part to get the states names list.
*
* @return An Eina_List* of string (char *)containing all the states names found
* in part, including the float value (ex: "default 0.00").
*
* Use edje_edit_string_list_free() when you don't need it anymore.
*/
EAPI Eina_List * edje_edit_part_states_list_get(Evas_Object *obj, const char *part);
/** Set a new name for the given state in the given part.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state Name of the state to rename.
* @param value Value of the state to rename.
* @param new_name The new name for the state.
* @param new_value The new value for the state.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_name_set(Evas_Object *obj, const char *part, const char *state, double value, const char *new_name, double new_value);
/** Create a new state to the give part.
*
* @param obj Object being edited.
* @param part Part to set the name of the new state.
* @param name Name for the new state (not including the state value).
* @param value The state value.
*
* @return EINA_TRUE if successfully, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_add(Evas_Object *obj, const char *part, const char *name, double value);
/** Delete the given part state from the edje.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The current name of the state (not including the state value).
* @param value The state value.
*
* @return EINA_TRUE if successfully, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_del(Evas_Object *obj, const char *part, const char *state, double value);
/** Check if a part state with the given name exist.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to check (not including the state value).
* @param value The state value.
*
* @return EINA_TRUE if the part state exist, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_exist(Evas_Object *obj, const char *part, const char *state, double value);
/** Copies the state @p from into @p to. If @p to doesn't exist it will be created.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param from State to copy from (not including state value).
* @param val_from The value of the state to copy from.
* @param to State to copy into (not including state value).
* @param val_to The value of the state to copy into.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_copy(Evas_Object *obj, const char *part, const char *from, double val_from, const char *to, double val_to);
/** Get the 'rel1 relative X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get 'rel1 relative X' (not including the state value).
* @param value The state value.
*
* @return The 'rel1 relative X' value of the part state.
*/
EAPI double edje_edit_state_rel1_relative_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the 'rel1 relative Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get 'rel1 relative Y' (not including the state value).
* @param value The state value.
*
* @return The 'rel1 relative Y' value of the part state.
*/
EAPI double edje_edit_state_rel1_relative_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the 'rel2 relative X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get 'rel2 relative X' (not including the state value).
* @param value The state value.
*
* @return The 'rel2 relative X' value of the part state.
*/
EAPI double edje_edit_state_rel2_relative_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the 'rel2 relative Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get 'rel2 relative Y' (not including the state value).
* @param value The state value.
*
* @return The 'rel2 relative Y' value of the part state.
*/
EAPI double edje_edit_state_rel2_relative_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the 'rel1 relative X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set 'rel1 relative X' (not including the state value).
* @param value The state value.
* @param x The new 'rel1 relative X' value to set'.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel1_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
/** Set the 'rel1 relative Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set 'rel1 relative Y' (not including the state value).
* @param value The state value.
* @param y The new 'rel1 relative Y' value to set'.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel1_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
/** Set the 'rel2 relative X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set 'rel2 relative X' (not including the state value).
* @param value The state value.
* @param x The new 'rel2 relative X' value to set'.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel2_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
/** Set the 'rel2 relative Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set 'rel2 relative Y' (not including the state value).
* @param value The state value.
* @param y The new 'rel2 relative Y' value to set'.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel2_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
/** Get the 'rel1 offset X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get 'rel1 offset X' (not including the state value).
* @param value The state value.
*
* @return The 'rel1 offset X' value of the part state.
*/
EAPI int edje_edit_state_rel1_offset_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the 'rel1 offset Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get 'rel1 offset Y' (not including the state value).
* @param value The state value.
*
* @return The 'rel1 offset Y' value of the part state.
*/
EAPI int edje_edit_state_rel1_offset_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the 'rel2 offset X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get 'rel2 offset X' (not including the state value).
* @param value The state value.
*
* @return The 'rel2 offset X' value of the part state.
*/
EAPI int edje_edit_state_rel2_offset_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the 'rel2 offset Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get 'rel2 offset Y' (not including the state value).
* @param value The state value.
*
* @return The 'rel2 offset Y' value of the part state.
*/
EAPI int edje_edit_state_rel2_offset_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the 'rel1 offset X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set 'rel1 offset X' (not including the state value).
* @param value The state value.
* @param x The new 'rel1 offset X' value to set'.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel1_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
/** Set the 'rel1 offset Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set 'rel1 offset Y' (not including the state value).
* @param value The state value.
* @param y The new 'rel1 offset Y' value to set'.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel1_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
/** Set the 'rel2 offset X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set 'rel2 offset X' (not including the state value).
* @param value The state value.
* @param x The new 'rel2 offset X' value to set'.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel2_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
/** Set the 'rel2 offset Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set 'rel2 offset Y' (not including the state value).
* @param value The state value.
* @param y The new 'rel2 offset Y' value to set'.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel2_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
/** Get the part name rel1x is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The state that contain which the part name rel1x is relative to (not including the state value).
* @param value The state value.
*
* @return The part name rel1x is relative to or NULL if the part is relative to the whole interface.
*/
EAPI const char * edje_edit_state_rel1_to_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the part name rel1y is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The state that contain which the part name rel1y is relative to (not including the state value).
* @param value The state value.
*
* @return The part name rel1y is relative to or NULL if the part is relative to the whole interface.
*/
EAPI const char * edje_edit_state_rel1_to_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the part name rel2x is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The state that contain which the part name rel2x is relative to (not including the state value).
* @param value The state value.
*
* @return The part name rel2x is relative to or NULL if the part is relative to the whole interface.
*/
EAPI const char * edje_edit_state_rel2_to_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the part name rel2y is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The state that contain which the part name rel2y is relative to (not including the state value).
* @param value The state value.
*
* @return The part name rel2y is relative to or NULL if the part is relative to the whole interface.
*/
EAPI const char * edje_edit_state_rel2_to_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the part rel1x is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set rel1x is relative to (not including the state value).
* @param value The state value.
* @param rel_to The name of the part that is used as container/parent (NULL make the part relative to the whole interface).
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel1_to_x_set(Evas_Object *obj, const char *part, const char *state, double value, const char *rel_to);
/** Set the part rel1y is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set rel1y is relative to (not including the state value).
* @param value The state value.
* @param rel_to The name of the part that is used as container/parent (NULL make the part relative to the whole interface).
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel1_to_y_set(Evas_Object *obj, const char *part, const char *state, double value, const char *rel_to);
/** Set the part rel2x is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set rel2x is relative to (not including the state value).
* @param value The state value.
* @param rel_to The name of the part that is used as container/parent (NULL make the part relative to the whole interface).
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel2_to_x_set(Evas_Object *obj, const char *part, const char *state, double value, const char *rel_to);
/** Set the part rel2y is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set rel2y is relative to (not including the state value).
* @param value The state value.
* @param rel_to The name of the part that is used as container/parent (NULL make the part relative to the whole interface).
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel2_to_y_set(Evas_Object *obj, const char *part, const char *state, double value, const char *rel_to);
/** Get the color of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get color (not including the state value).
* @param value The state value.
* @param r A pointer to store the red value.
* @param g A pointer to store the green value.
* @param b A pointer to store the blue value.
* @param a A pointer to store the alpha value.
*/
EAPI void edje_edit_state_color_get(Evas_Object *obj, const char *part, const char *state, double value, int *r, int *g, int *b, int *a);
/** Get the color2 of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get color (not including the state value).
* @param value The state value.
* @param r A pointer to store the red value.
* @param g A pointer to store the green value.
* @param b A pointer to store the blue value.
* @param a A pointer to store the alpha value.
*/
EAPI void edje_edit_state_color2_get(Evas_Object *obj, const char *part, const char *state, double value, int *r, int *g, int *b, int *a);
/** Get the color3 of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get color (not including the state value).
* @param value The state value.
* @param r A pointer to store the red value.
* @param g A pointer to store the green value.
* @param b A pointer to store the blue value.
* @param a A pointer to store the alpha value.
*/
EAPI void edje_edit_state_color3_get(Evas_Object *obj, const char *part, const char *state, double value, int *r, int *g, int *b, int *a);
/** Set the color of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set color (not including the state value).
* @param value The state value.
* @param r The red value of the color.
* @param g The green value of the color.
* @param b The blue value of the color.
* @param a The alpha value of the color.
*
* @return EINA_TRUE If successfull, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_color_set(Evas_Object *obj, const char *part, const char *state, double value, int r, int g, int b, int a);
/** Set the color2 of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set color (not including the state value).
* @param value The state value.
* @param r The red value of the color.
* @param g The green value of the color.
* @param b The blue value of the color.
* @param a The alpha value of the color.
*
* @return EINA_TRUE If successfull, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_color2_set(Evas_Object *obj, const char *part, const char *state, double value, int r, int g, int b, int a);
/** Set the color3 of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set color (not including the state value).
* @param value The state value.
* @param r The red value of the color.
* @param g The green value of the color.
* @param b The blue value of the color.
* @param a The alpha value of the color.
*
* @return EINA_TRUE If successfull, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_color3_set(Evas_Object *obj, const char *part, const char *state, double value, int r, int g, int b, int a);
/** Get the horizontal align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get horizontal align (not including the state value).
* @param value The state value.
*
* @return The horizontal align value for the given state
*/
EAPI double edje_edit_state_align_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the vertical align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get horizontal align (not including the state value).
* @param value The state value.
*
* @return The vertical align value for the given state
*/
EAPI double edje_edit_state_align_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the horizontal align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get horizontal align (not including the state value).
* @param value The state value.
* @param align The new vertical align value.
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_align_x_set(Evas_Object *obj, const char *part, const char *state, double value, double align);
/** Set the vertical align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get vertical align (not including the state value).
* @param value The state value.
* @param align The new vertical align value.
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_align_y_set(Evas_Object *obj, const char *part, const char *state, double value, double align);
/** Get the minimum width value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get minimum width (not including the state value).
* @param value The state value.
*
* @return The minimum width value.
*/
EAPI int edje_edit_state_min_w_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the minimum width value of a part state.
* The minimum width should be greater than 0.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set minimum width (not including the state value).
* @param value The state value.
* @param min_w Minimum width value.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_min_w_set(Evas_Object *obj, const char *part, const char *state, double value, int min_w);
/** Get the minimum height value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get minimum height (not including the state value).
* @param value The state value.
*
* @return The minimum height value.
*/
EAPI int edje_edit_state_min_h_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the minimum height value of a part state.
* The minimum height should be greater than 0.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set minimum height (not including the state value).
* @param value The state value.
* @param min_h Minimum height value.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_min_h_set(Evas_Object *obj, const char *part, const char *state, double value, int min_h);
/** Get the maximum width value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get maximum width (not including the state value).
* @param value The state value.
*
* @return The maximum width value.
*/
EAPI int edje_edit_state_max_w_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the maximum width value of a part state.
* The maximum width should be greater than -1.
* The value -1 means that state doesn't have any boundaries on width direction.
* (it can be any size that is bigger than it's min)
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set maximum width (not including the state value).
* @param value The state value.
* @param max_w Maximum width value.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_max_w_set(Evas_Object *obj, const char *part, const char *state, double value, int max_w);
/** Get the maximum height value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get maximum height (not including the state value).
* @param value The state value.
*
* @return The maximum height value.
*/
EAPI int edje_edit_state_max_h_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the maximum height value of a part state.
* The maximum height should be greater than -1.
* The value -1 means that state doesn't have any boundaries on height direction.
* (it can be any size that is bigger than it's min)
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set maximum height (not including the state value).
* @param value The state value.
* @param max_h Maximum height value.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_max_h_set(Evas_Object *obj, const char *part, const char *state, double value, int max_h);
/** Get the minimum aspect value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get minimum aspect (not including the state value).
* @param value The state value.
*
* @return The minimum aspect
*/
EAPI double edje_edit_state_aspect_min_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the maximum aspect value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get maximum aspect (not including the state value).
* @param value The state value.
*
* @return The maximum aspect
*/
EAPI double edje_edit_state_aspect_max_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the minimum aspect value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set minimum aspect (not including the state value).
* @param value The state value.
* @param aspect Minimum aspect value.
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_aspect_min_set(Evas_Object *obj, const char *part, const char *state, double value, double aspect);
/** Set the maximum aspect value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set maximum aspect (not including the state value).
* @param value The state value.
* @param aspect Maximum aspect value.
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_aspect_max_set(Evas_Object *obj, const char *part, const char *state, double value, double aspect);
/** Get the aspect preference of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get aspect preference (not including the state value).
* @param value The state value.
*
* @return The aspect preference (0 = None, 1 = Vertical, 2 = Horizontal, 3 = Both)
*/
EAPI unsigned char edje_edit_state_aspect_pref_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the aspect preference of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set aspect preference (not
* including the state value).
* @param value The state value.
* @param pref The aspect preference to set (0 = None, 1 = Vertical, 2
* = Horizontal, 3 = Both)
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_aspect_pref_set(Evas_Object *obj, const char *part, const char *state, double value, unsigned char pref);
/** Get the fill horizontal origin relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the fill horizontal origin relative to area (not including the state value).
* @param value The state value.
*
* @return The fill horizontal origin relative to area.
*/
EAPI double edje_edit_state_fill_origin_relative_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the fill vertical origin relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get fill vertical origin relative to area (not including the state value).
* @param value The state value.
*
* @return The fill vertical origin relative to area.
*/
EAPI double edje_edit_state_fill_origin_relative_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the fill horizontal origin offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get fill horizontal origin offset relative to area (not including the state value).
* @param value The state value.
*
* @return The fill horizontal origin offset relative to area.
*/
EAPI int edje_edit_state_fill_origin_offset_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the fill vertical origin offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get fill vertical origin offset relative to area (not including the state value).
* @param value The state value.
*
* @return The fill vertical origin offset value.
*/
EAPI int edje_edit_state_fill_origin_offset_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the fill horizontal origin relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set fill horizontal origin relative to area (not including the state value).
* @param value The state value.
* @param x The fill horizontal origin value.
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_origin_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
/** Set the fill horizontal origin relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set fill vertical origin relative to area (not including the state value).
* @param value The state value.
* @param y The fill vertical origin value.
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_origin_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
/** Set the fill horizontal origin offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set fill horizontal origin offset relative to area (not including the state value).
* @param value The state value.
* @param x The fill horizontal origin offset value.
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_origin_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
/** Set the fill vertical origin offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set fill vertical origin offset relative to area (not including the state value).
* @param value The state value.
* @param y The fill vertical origin offset value.
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_origin_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
/** Get the fill horizontal size relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get fill horizontal size relative to area (not including the state value).
* @param value The state value.
*
* @return The fill horizontal size relative to area.
*/
EAPI double edje_edit_state_fill_size_relative_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the fill vertical size relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get fill vertical size relative to area (not including the state value).
* @param value The state value.
*
* @return The fill vertical size relative to area.
*/
EAPI double edje_edit_state_fill_size_relative_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the fill horizontal size offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get fill horizontal size
* offset relative to area (not including the state value).
* @param value The state value.
*
* @return The fill horizontal size offset relative to area.
*/
EAPI int edje_edit_state_fill_size_offset_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the fill vertical size offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get fill vertical size offset
* relative to area (not including the state value).
* @param value The state value.
*
* @return The fill vertical size offset relative to area.
*/
EAPI int edje_edit_state_fill_size_offset_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the fill horizontal size relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set fill horizontal size
* relative value (not including the state value).
* @param value The state value.
* @param x The horizontal size relative value.
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_size_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
/** Set the fill vertical size relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set fill vertical size
* relative value (not including the state value).
* @param value The state value.
* @param x The vertical size relative value.
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_size_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
/** Set the fill horizontal size offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set fill horizontal size
* offset relative value (not including the state value).
* @param value The state value.
* @param x The horizontal size offset value.
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_size_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
/** Set the fill vertical size offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set fill vertical size offset
* relative value (not including the state value).
* @param value The state value.
* @param y The vertical size offset value.
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_size_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
/** Get the visibility of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get visibility (not including the state value).
* @param value The state value.
*
* @return EINA_TRUE if the state is visible, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_visible_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the visibility of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set visibility (not including the state value).
* @param value The state value.
* @param visible To set state visible (EINA_TRUE if the state is visible, EINA_FALSE otherwise)
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_visible_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool visible);
/** Get the color class of the given part state.
*
* Remember to free the string with edje_edit_string_free()
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get color class (not including the state value).
* @param value The state value.
*
* @return The current color class.
*/
EAPI const char *edje_edit_state_color_class_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the color class of the given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set color class (not including the state value).
* @param value The state value.
* @param color_class The color class to assign.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_color_class_set(Evas_Object *obj, const char *part, const char *state, double value, const char *color_class);
/** Get the list of parameters for an external part.
*
* DO NOT FREE THE LIST!
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get list of Edje_External_Param (not including the state value).
* @param value The state value.
*
* @return The list of Edje_External_Param.
*/
EAPI const Eina_List * edje_edit_state_external_params_list_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the external parameter type and value.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get external parameter (not including the state value).
* @param value The state value.
* @param param The name of the paramter to look for.
* @param type The type of the parameter will be stored here.
* @param val Pointer to value will be stored here - DO NOT FREE IT!
*
* @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_external_param_get(Evas_Object *obj, const char *part, const char *state, double value, const char *param, Edje_External_Param_Type *type, void **val);
/** Get external parameter of type INT.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get external parameter of type INT (not including the state value).
* @param value The state value.
* @param param The name of the paramter.
* @param val The value of the parameter.
*
* @return EINA_TRUE if successful. EINA_FALSE if not found or is of different type.
*/
EAPI Eina_Bool edje_edit_state_external_param_int_get(Evas_Object *obj, const char *part, const char *state, double value, const char *param, int *val);
/** Get external parameter of type BOOL.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get external parameter of type BOOL (not including the state value).
* @param value The state value.
* @param param The name of the paramter.
* @param val The value of the parameter.
*
* @return EINA_TRUE if successful. EINA_FALSE if not found or is of different type.
*/
EAPI Eina_Bool edje_edit_state_external_param_bool_get(Evas_Object *obj, const char *part, const char *state, double value, const char *param, Eina_Bool *val);
/** Get external parameter of type DOUBLE.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get external parameter of type DOUBLE (not including the state value).
* @param value The state value.
* @param param The name of the paramter.
* @param val The value of the parameter.
*
* @return EINA_TRUE if successful. EINA_FALSE if not found or is of different type.
*/
EAPI Eina_Bool edje_edit_state_external_param_double_get(Evas_Object *obj, const char *part, const char *state, double value, const char *param, double *val);
/** Get external parameter of type STRING.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get external parameter of
* type STRING (not including the state value).
* @param value The state value.
* @param param The name of the paramter.
* @param val The value of the parameter.
*
* @return EINA_TRUE if successful. EINA_FALSE if not found or is of
* different type.
*/
EAPI Eina_Bool edje_edit_state_external_param_string_get(Evas_Object *obj, const char *part, const char *state, double value, const char *param, const char **val);
/** Get external parameter of type CHOICE.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get external parameter of
* type CHOICE (not including the state value).
* @param value The state value.
* @param param The name of the paramter.
* @param val The value of the parameter.
*
* @return EINA_TRUE if successful. EINA_FALSE if not found or is of
* different type.
*/
EAPI Eina_Bool edje_edit_state_external_param_choice_get(Evas_Object *obj, const char *part, const char *state, double value, const char *param, const char **val);
/** Set the external parameter type and value, adding it if it didn't
* exist before.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get external parameter (not
* including the state value).
* @param value The state value.
* @param param The name of the paramter set.
* @param type The type of the parameter.
*
* @return EINA_TRUE if it was set, EINA_FALSE otherwise.
*/
/**
* Arguments should have proper sized values matching their types:
* - EDJE_EXTERNAL_PARAM_TYPE_INT: int
* - EDJE_EXTERNAL_PARAM_TYPE_BOOL: int
* - EDJE_EXTERNAL_PARAM_TYPE_DOUBLE: double
* - EDJE_EXTERNAL_PARAM_TYPE_STRING: char*
* - EDJE_EXTERNAL_PARAM_TYPE_CHOICE: char*
*
* @note: The validation of the parameter will occur only if the part
* is in the same state as the one being modified.
*/
EAPI Eina_Bool edje_edit_state_external_param_set(Evas_Object *obj, const char *part, const char *state, double value, const char *param, Edje_External_Param_Type type, ...);
/** Set external parameter of type INT.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get external parameter of
* type INT (not including the state value).
* @param value The state value.
* @param param The name of the paramter.
* @param val Value will be stored here.
*
* @return EINA_TRUE if it was set, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_external_param_int_set(Evas_Object *obj, const char *part, const char *state, double value, const char *param, int val);
/** Set external parameter of type BOOL.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get external parameter of type BOOL (not including the state value).
* @param value The state value.
* @param param The name of the paramter.
* @param val Value will be stored here.
*
* @return EINA_TRUE if it was set, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_external_param_bool_set(Evas_Object *obj, const char *part, const char *state, double value, const char *param, Eina_Bool val);
/** Set external parameter of type DOUBLE.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get external parameter of type DOUBLE (not including the state value).
* @param value The state value.
* @param param The name of the paramter.
* @param val Value will be stored here.
*
* @return EINA_TRUE if it was set, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_external_param_double_set(Evas_Object *obj, const char *part, const char *state, double value, const char *param, double val);
/** Set external parameter of type STRING.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get external parameter of type STRING (not including the state value).
* @param value The state value.
* @param param The name of the paramter.
* @param val Value will be stored here.
*
* @return EINA_TRUE if it was set, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_external_param_string_set(Evas_Object *obj, const char *part, const char *state, double value, const char *param, const char *val);
/** Set external parameter of type CHOICE.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get external parameter of type CHOICE (not including the state value).
* @param value The state value.
* @param param The name of the paramter.
* @param val Value will be stored here.
*
* @return EINA_TRUE if it was set, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_external_param_choice_set(Evas_Object *obj, const char *part, const char *state, double value, const char *param, const char *val);
//@}
/******************************************************************************/
/************************** TEXT API ************************************/
/******************************************************************************/
/** @name Text API
* Functions to deal with text objects (see @ref edcref).
*/ //@{
/** Get the text of a part state.
*
* Remember to free the returned string with edje_edit_string_free().
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get text (not including the state value).
* @param value The state value.
*
* @return A newly allocated string containing the text for the given state.
*/
EAPI const char * edje_edit_state_text_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the text of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set text (not including the state value).
* @param value The state value.
* @param text The new text to assign.
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_set(Evas_Object *obj, const char *part, const char *state, double value,const char *text);
/** Get font name for a given part state.
*
* @param obj Object being edited.
* @param part The name of the part to get the font of.
* @param state The state of the part to get the font of.
* @param value Value of the state.
*
* @return Font used by the part or NULL if error or nothing is set.
*/
EAPI const char * edje_edit_state_font_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set font name for a given part state.
*
* Font name can be any alias of an internal font in the Edje file and,
* if it doesn't match any, Edje will look for a font with the given name
* in the system fonts.
*
* @param obj Object being edited.
* @param part Part to set the font of.
* @param state State in which the font is set.
* @param value Value of the state.
* @param font The font name to use.
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_font_set(Evas_Object *obj, const char *part, const char *state, double value, const char *font);
/** Get the text size of a part state
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get text size (not including the state value).
* @param value The state value.
*
* @return The text size or -1 on errors.
*/
EAPI int edje_edit_state_text_size_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the text size of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set text size (not including the state value).
* @param value The state value.
* @param size The new font size to set (in pixel)
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_size_set(Evas_Object *obj, const char *part, const char *state, double value, int size);
/** Get the text horizontal align of a part state.
*
* The value range is from 0.0(right) to 1.0(left)
* If the value is between -1.0 and 0.0 then it uses align automatically.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the text horizontal align (not including the state value).
* @param value The state value.
*
* @return The text horizont align value
*/
EAPI double edje_edit_state_text_align_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the text vertical align of a part state.
*
* The value range is from 0.0(top) to 1.0(bottom)
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the text vertical align (not including the state value).
* @param value The state value.
*
* @return The text horizont align value
*/
EAPI double edje_edit_state_text_align_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the text horizontal align of a part state.
*
* The value range is from 0.0(right) to 1.0(left)
* If the value is between -1.0 and 0.0 then it uses align automatically.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the text horizontal align (not including the state value).
* @param value The state value.
* @param align The new text horizontal align value
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_align_x_set(Evas_Object *obj, const char *part, const char *state, double value, double align);
/** Set the text vertical align of a part state.
*
* The value range is from 0.0(top) to 1.0(bottom)
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the text vertical align (not including the state value).
* @param value The state value.
* @param align The new text vertical align value
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_align_y_set(Evas_Object *obj, const char *part, const char *state, double value, double align);
/** Get the text elipsis of a part state.
*
* The value range is from 0.0(right) to 1.0(left), and -1.0 (if disabled)
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the text elipses value (not including the state value).
* @param value The state value.
*
* @return The text elipsis value
*/
EAPI double edje_edit_state_text_elipsis_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the text vertical align of a part state.
*
* The value range is from 0.0(right) to 1.0(left)
* If the value is in range from -1.0 to 0.0 then ellipsis is disabled.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the text elipses value (not including the state value).
* @param value The state value.
* @param balance The position where to cut the string
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_elipsis_set(Evas_Object *obj, const char *part, const char *state, double value, double balance);
/** Get if the text part fit it's container horizontally
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the if the text part fit it's container horizontally (not including the state value).
* @param value The state value.
*
* @return EINA_TRUE If the part fit it's container horizontally, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_fit_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set if the text part should fit it's container horizontally
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the if the text part fit it's container horizontally (not including the state value).
* @param value The state value.
* @param fit EINA_TRUE to make the text fit it's container horizontally, EINA_FALSE otherwise.
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_fit_x_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool fit);
/** Get if the text part fit it's container vertically
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the if the text part fit it's container vertically (not including the state value).
* @param value The state value.
*
* @return EINA_TRUE If the part fit it's container vertically, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_fit_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set if the text part should fit it's container vertically
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the if the text part fit it's container vertically (not including the state value).
* @param value The state value.
* @param fit EINA_TRUE to make the text fit it's container vertically, EINA_FALSE otherwise.
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_fit_y_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool fit);
/** Get if the text part forces the minimum horizontal size of the container to be equal to the minimum horizontal size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the the minimum horizontal size of the container to be equal (not including the state value).
* @param value The state value.
*
* @return EINA_TRUE If the part forces container's minimum horizontal size, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_min_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get if the text part forces the maximum horizontal size of the container to be equal to the maximum horizontal size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the the minimum horizontal size of the container to be equal (not including the state value).
* @param value The state value.
*
* @return EINA_TRUE If the part forces container's maximum horizontal size, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_max_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get if the text part forces the minimum vertical size of the container to be equal to the minimum vertical size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the the minimum vertical size of the container to be equal (not including the state value).
* @param value The state value.
*
* @return EINA_TRUE If the part forces container's minimum vertical size, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_min_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get if the text part forces the maximum vertical size of the container to be equal to the maximum vertical size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the the maximum vertical size of the container to be equal (not including the state value).
* @param value The state value.
*
* @return EINA_TRUE If the part forces container's maximum vertical size, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_max_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set if the text part forces the minimum horizontal size of the container to be equal to the minimum horizontal size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the the minimum horizontal size of the container to be equal (not including the state value).
* @param value The state value.
* @param v EINA_TRUE to make the text force it's forces container's minimum horizontal size, EINA_FALSE otherwise.
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_min_x_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool v);
/** Set if the text part forces the maximum horizontal size of the container to be equal to the maximum horizontal size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the the maximum horizontal size of the container to be equal (not including the state value).
* @param value The state value.
* @param v EINA_TRUE to make the text force it's forces container's maximum horizontal size, EINA_FALSE otherwise.
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_max_x_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool v);
/** Set if the text part forces the minimum vertical size of the container to be equal to the minimum vertical size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the the minimum vertical size of the container to be equal (not including the state value).
* @param value The state value.
* @param v EINA_TRUE to make the text force it's forces container's minimum vertical size, EINA_FALSE otherwise.
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_min_y_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool v);
/** Set if the text part forces the maximum vertical size of the container to be equal to the maximum vertical size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the the maximum vertical size of the container to be equal (not including the state value).
* @param value The state value.
* @param v EINA_TRUE to make the text force it's forces container's maximum vertical size, EINA_FALSE otherwise.
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_max_y_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool v);
/** Get the list of all the fonts in the given edje.
*
* Use edje_edit_string_list_free() when you don't need the list anymore.
*
* @param obj Object being edited.
*
* @return A list containing all the fonts names found in the edje file.
*/
EAPI Eina_List * edje_edit_fonts_list_get(Evas_Object *obj);
/** Add a new font to the edje file.
*
* The newly created font will be available to all the groups in the edje, not only the current one.
*
* @param obj Object being edited.
* @param path The file path to load the font from.
* @param alias The alias for file, or NULL to use filename
*
* @return EINA_TRUE if font cat be loaded, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_font_add(Evas_Object *obj, const char *path, const char* alias);
/** Delete font from the edje file.
*
* The font will be removed from all the groups in the edje, not only the current one.
*
* @param obj Object being edited.
* @param alias The font alias
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise (including the
* case when the alias is not valid).
*/
EAPI Eina_Bool edje_edit_font_del(Evas_Object *obj, const char* alias);
/** Get font path for a given font alias.
*
* Remember to free the string with edje_edit_string_free()
*
* @param obj Object being edited.
* @param alias The font alias.
*
* @return The path of the given font alias.
*/
EAPI const char *edje_edit_font_path_get(Evas_Object *obj, const char *alias);
/** Get font name for a given part state.
*
* Remember to free the returned string using edje_edit_string_free().
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the name of the font used (not including the state value).
* @param value The state value.
*
* @return The name of the font used in the given part state.
*/
EAPI const char * edje_edit_state_font_get(Evas_Object *obj, const char *part, const char *state, double value);
//@}
/******************************************************************************/
/************************** IMAGES API ************************************/
/******************************************************************************/
/** @name Images API
* Functions to deal with image objects (see @ref edcref).
*/ //@{
/** Get the list of all the images in the given edje.
* Use edje_edit_string_list_free() when you don't need the list anymore.
*
* @param obj Object being edited.
*
* @return A List containing all images names found in the edje file.
*/
EAPI Eina_List * edje_edit_images_list_get(Evas_Object *obj);
/** Add an new image to the image collection
*
* This function add the given image inside the edje. Don't add a new image part
* but only put the image inside the edje file. It actually write directly to
* the file so you don't have to save.
* After you have to create a new image_part that use this image. Note that all
* the parts in the edje share the same image collection, thus you can/must use
* the same image for different part.
*
* The format of the image files that can be loaded depend on the evas engine on your system
*
* @param obj Object being edited.
* @param path The name of the image file to include in the edje.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_image_add(Evas_Object *obj, const char *path);
/** Delete an image from the image collection
*
* It actually write directly to the file so you don't have to save.
*
* @param obj Object being edited.
* @param name The name of the image file to include in the edje.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise (including the
* case when the name is not valid).
*/
EAPI Eina_Bool edje_edit_image_del(Evas_Object *obj, const char *name);
/** Add an image entry to the image collection
*
* This function adds the given image entry to the edje image collection. The
* image needs to be inside the eet already, with key name "images/id". After
* you have to create a new image_part that use this image, referring to it as
* "name". Note that all the parts in the edje share the same image collection,
* thus you can/must use the same image for different part.
*
* @param obj Object being edited.
* @param name The image entry name.
* @param id The image id.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_image_data_add(Evas_Object *obj, const char *name, int id);
/** Get normal image name for a given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the name that is being used (not including the state value).
* @param value The state value.
*
* @return The name of the image used by state.
*/
EAPI const char * edje_edit_state_image_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set normal image for a given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the image that will be used (not including the state value).
* @param value The state value.
* @param image The name of the image (must be an image contained in the edje file).
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_image_set(Evas_Object *obj, const char *part, const char *state, double value, const char *image);
/** Get image id for a given image name.
*
* @param obj Object being edited.
* @param image_name The image name.
*
* @return The id of the given image name.
*/
EAPI int edje_edit_image_id_get(Evas_Object *obj, const char *image_name);
/** Get compression type for the given image.
*
* @param obj Object being edited.
* @param image The name of the image.
*
* @return One of Image Compression types.
* (EDJE_EDIT_IMAGE_COMP_RAW, EDJE_EDIT_IMAGE_COMP_USER, EDJE_EDIT_IMAGE_COMP_COMP, EDJE_EDIT_IMAGE_COMP_LOSSY).
*/
EAPI Edje_Edit_Image_Comp edje_edit_image_compression_type_get(Evas_Object *obj, const char *image);
/** Get compression rate for the given image.
*
* @param obj Object being edited.
* @param image The name of the image.
*
* @return The compression rate (if the imnage is @c
* EDJE_EDIT_IMAGE_COMP_LOSSY) or < 0, on errors.
*/
EAPI int edje_edit_image_compression_rate_get(Evas_Object *obj, const char *image);
/** Get the image border of a part state.
*
* Pass NULL to any of [r,g,b,a] to get only the others.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the image border (not
* including the state value).
* @param value The state value.
* @param l A pointer to store the left value
* @param r A pointer to store the right value
* @param t A pointer to store the top value
* @param b A pointer to store the bottom value
*/
EAPI void edje_edit_state_image_border_get(Evas_Object *obj, const char *part, const char *state, double value, int *l, int *r, int *t, int *b);
/** Set the image border of a part state.
*
* Pass -1 to any of [l,r,t,b] to leave the value untouched.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the image border (not
* including the state value).
* @param value The state value.
* @param l Left border value (or -1).
* @param r Right border value (or -1).
* @param t Top border value (or -1).
* @param b Bottom border value (or -1).
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_image_border_set(Evas_Object *obj, const char *part, const char *state, double value, int l, int r, int t, int b);
/** Get if the image center should be draw.
*
* 1 or 2 means to draw the center, 0 to don't draw it.
* If 1 - then the center will apply alpha channel.
* If 2 (SOLID mode) - then the center of an image wont have alpha channel (Just black color).
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the image border fill (not including the state value).
* @param value The state value.
*
* @return 2 if the center of the bordered image is draw without alpha, 1 dawing with alpha and 0 not drawing the center.
*/
EAPI unsigned char edje_edit_state_image_border_fill_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set if the image center should be draw.
*
* 1 or 2 means to draw the center, 0 to don't draw it.
* If 1 - then the center will apply alpha channel.
* If 2 (SOLID mode) - then the center of an image wont have alpha channel (Just black color).
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the image border fill (not including the state value).
* @param value The state value.
* @param fill Fill to be set. 1 or 2 if the center of the bordered image is draw, 0 otherwise.
*
* @return EINA_TRUE if successful, EINA_FALSE - otherwise.
*/
EAPI Eina_Bool edje_edit_state_image_border_fill_set(Evas_Object *obj, const char *part, const char *state, double value, unsigned char fill);
/** Get the list of all the tweens images in the given part state.
*
* Use edje_edit_string_list_free() when you don't need it anymore.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get the list of all the tweens images (not including the state value).
* @param value The state value.
*
* @return A string list containing all the image name that form a tween animation in the given part state.
*/
EAPI Eina_List * edje_edit_state_tweens_list_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Add a new tween frame to the given part state.
*
* The tween param must be the name of an existing image.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to add a new tween frame (not including the state value).
* @param value The state value.
* @param tween The name of the image to add.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_tween_add(Evas_Object *obj, const char *part, const char *state, double value, const char *tween);
/** Remove the first tween with the given name.
*
* The image is not removed from the edje.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to del the tween (not including the state value).
* @param value The state value.
* @param tween The name of the image to del.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_tween_del(Evas_Object *obj, const char *part, const char *state, double value, const char *tween);
//@}
/******************************************************************************/
/************************* SPECTRUM API ***********************************/
/******************************************************************************/
/** @name Spectrum API
* Functions to manage spectrum (see @ref edcref).
*/ //@{
/** Get the list of all the spectrum in the given edje object.
*
* Use edje_edit_string_list_free() when you don't need it anymore.
*
* @param obj Object being edited.
*
* @return A list containing all the spectra names.
*/
EAPI Eina_List * edje_edit_spectrum_list_get(Evas_Object *obj);
/** Add a new spectra in the given edje object.
*
* @param obj Object being edited.
* @param name The name of the spectra to include in the edje.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_spectra_add(Evas_Object *obj, const char *name);
/** Delete the given spectra from the edje object.
*
* @param obj Object being edited.
* @param spectra The name of the spectra to delete.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_spectra_del(Evas_Object *obj, const char *spectra);
/** Change the name of the given spectra.
*
* @param obj Object being edited.
* @param spectra The name of the current spectra.
* @param name The new name to assign.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_spectra_name_set(Evas_Object *obj, const char *spectra, const char *name);
/** Get the number of stops in the given spectra.
*
* @param obj Object being edited.
* @param spectra The name of the spectra.
*
* @return The number of stops (or 0 on errors).
*/
EAPI int edje_edit_spectra_stop_num_get(Evas_Object *obj, const char *spectra);
/** Set the number of stops in the given spectra.
*
* @param obj Object being edited.
* @param spectra The name of the spectra.
* @param num The number of stops you want
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_spectra_stop_num_set(Evas_Object *obj, const char *spectra, int num);
/** Get the colors of the given stop.
*
* @param obj Object being edited.
* @param spectra The name of the spectra.
* @param stop_number The number of the stop,
* @param r Where to store the red color value,
* @param g Where to store the green color value,
* @param b Where to store the blue color value,
* @param a Where to store the alpha color value,
* @param d Where to store the delta stop value,
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_spectra_stop_color_get(Evas_Object *obj, const char *spectra, int stop_number, int *r, int *g, int *b, int *a, int *d);
/** Set the colors of the given stop.
*
* @param obj Object being edited.
* @param spectra The name of the spectra.
* @param stop_number The number of the stops,
* @param r The red color value to set,
* @param g The green color value to set,
* @param b The blue color value to set,
* @param a The alpha color value to set,
* @param d The delta stop value to set,
*/
EAPI Eina_Bool edje_edit_spectra_stop_color_set(Evas_Object *obj, const char *spectra, int stop_number, int r, int g, int b, int a, int d);
//@}
/******************************************************************************/
/************************* GRADIENT API ***********************************/
/******************************************************************************/
/** @name Gradient API
* Functions to deal with gradient objects (see @ref edcref).
*/ //@{
/** Get the type of gradient.
*
* Remember to free the string with edje_edit_string_free().
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to get the gradient type (not including the state value).
* @param value The state value.
*
* @return The type of gradient used in state.
* (linear, linear.diag, linear.codiag, radial, rectangular, angular, sinosoidal)
*/
EAPI const char * edje_edit_state_gradient_type_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the type of gradient.
*
* Gradient type can be on of the following: linear, linear.diag, linear.codiag, radial, rectangular, angular, sinusoidal
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to set the gradient type (not including the state value).
* @param value The state value.
* @param type The type of gradient to use.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_gradient_type_set(Evas_Object *obj, const char *part, const char *state, double value, const char *type);
/** Get if the current gradient use the fill properties or the gradient_rel as params.
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to set the gradient type (not including the state value).
* @param value The state value.
*
* @return EINA_TRUE if gradient use the fill properties, EINA_FALSE otherwise.
* */
EAPI Eina_Bool edje_edit_state_gradient_use_fill_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the spectra used by part state.
*
* Remember to free the string with edje_edit_string_free().
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to get the spectra name used (not including the state value).
* @param value The state value.
*
* @return The spectra name used in state.
*/
EAPI const char * edje_edit_state_gradient_spectra_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the spectra used by part state.
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to set the spectra (not including the state value).
* @param value The state value.
* @param spectra The spectra name to assign
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_gradient_spectra_set(Evas_Object *obj, const char *part, const char *state, double value, const char *spectra);
/** Get the angle of the gradient.
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to get the angle (not including the state value).
* @param value The state value.
*
* @return The angle of the gradient.
*/
EAPI int edje_edit_state_gradient_angle_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the angle of the gradient.
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to set the angle (not including the state value).
* @param value The state value.
* @param angle The angle to set.
*/
EAPI void edje_edit_state_gradient_angle_set(Evas_Object *obj, const char *part, const char *state, double value, int angle);
/** Get the gradient rel1 horizontal relative value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to get rel1 relative x value (not including the state value).
* @param value The state value.
*
* @return The gradient rel1 horizontal relative value.
*/
EAPI double edje_edit_state_gradient_rel1_relative_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the gradient rel1 vertical relative value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to get rel1 relative y value (not including the state value).
* @param value The state value.
*
* @return The gradient rel1 vertical relative value.
*/
EAPI double edje_edit_state_gradient_rel1_relative_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the gradient rel2 horizontal relative value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to get rel2 relative x value (not including the state value).
* @param value The state value.
*
* @return The gradient rel2 horizontal relative value.
*/
EAPI double edje_edit_state_gradient_rel2_relative_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the gradient rel2 vertical relative value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to get rel2 relative y value (not including the state value).
* @param value The state value.
*
* @return The gradient rel2 vertical relative value.
*/
EAPI double edje_edit_state_gradient_rel2_relative_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the gradient rel1 horizontal relative value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to set rel1 relative x value (not including the state value).
* @param value The state value.
* @param val The rel1 relative x to be set,
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise..
*/
EAPI Eina_Bool edje_edit_state_gradient_rel1_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double val);
/** Set the gradient rel1 vertical relative value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to set rel1 relative y value (not including the state value).
* @param value The state value.
* @param val The rel1 relative y to be set,
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise..
*/
EAPI Eina_Bool edje_edit_state_gradient_rel1_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double val);
/** Set the gradient rel2 horizontal relative value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to set rel2 relative x value (not including the state value).
* @param value The state value.
* @param val The rel2 relative x to be set,
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise..
*/
EAPI Eina_Bool edje_edit_state_gradient_rel2_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double val);
/** Set the gradient rel2 vertical relative value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to set rel2 relative y value (not including the state value).
* @param value The state value.
* @param val The rel2 relative y to be set,
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise..
*/
EAPI Eina_Bool edje_edit_state_gradient_rel2_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double val);
/** Get the gradient rel1 horizontal offset value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to get rel1 offset x value (not including the state value).
* @param value The state value.
*
* @return The gradient rel1 horizontal offset value.
*/
EAPI int edje_edit_state_gradient_rel1_offset_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the gradient rel1 vertical offset value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to get rel1 offset y value (not including the state value).
* @param value The state value.
*
* @return The gradient rel1 vertical offset value.
*/
EAPI int edje_edit_state_gradient_rel1_offset_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the gradient rel2 horizontal offset value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to get rel2 offset x value (not including the state value).
* @param value The state value.
*
* @return The gradient rel2 horizontal offset value.
*/
EAPI int edje_edit_state_gradient_rel2_offset_x_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Get the gradient rel2 vertical offset value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to get rel2 offset y value (not including the state value).
* @param value The state value.
*
* @return The gradient rel2 vertical offset value.
*/
EAPI int edje_edit_state_gradient_rel2_offset_y_get(Evas_Object *obj, const char *part, const char *state, double value);
/** Set the gradient rel1 horizontal offset value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to set rel1 offset x value (not including the state value).
* @param value The state value.
* @param val The rel1 offset x value.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_gradient_rel1_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, int val);
/** Set the gradient rel1 vertical offset value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to set rel1 offset y value (not including the state value).
* @param value The state value.
* @param val The rel1 offset y value.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_gradient_rel1_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, int val);
/** Set the gradient rel2 horizontal offset value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to set rel2 offset x value (not including the state value).
* @param value The state value.
* @param val The rel2 offset x value.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_gradient_rel2_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, int val);
/** Set the gradient rel2 vertical offset value
*
* @param obj Object being edited.
* @param part The part that contain state.
* @param state The name of the state to set rel2 offset y value (not including the state value).
* @param value The state value.
* @param val The rel2 offset y value.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_gradient_rel2_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, int val);
//@}
/******************************************************************************/
/************************* PROGRAMS API ***********************************/
/******************************************************************************/
/** @name Programs API
* Functions to deal with programs (see @ref edcref).
*/ //@{
/** Get the list of all the programs in the given edje object.
*
* Use edje_edit_string_list_free() when you don't need it anymore.
*
* @param obj Object being edited.
*
* @return A list containing all the program names.
*/
EAPI Eina_List * edje_edit_programs_list_get(Evas_Object *obj);
/** Add a new program to the edje file
*
* If a program with the same name just exist the function will fail.
*
* @param obj Object being edited.
* @param name The name of the new program.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_add(Evas_Object *obj, const char *name);
/** Remove the given program from the edje file.
*
* @param obj Object being edited.
* @param prog The name of the program to remove.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_del(Evas_Object *obj, const char *prog);
/** Check if a program with the given name exist in the edje object.
*
* @param obj Object being edited.
* @param prog The prog of the program that will be searched.
*
* @return EINA_TRUE if the program exist, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_exist(Evas_Object *obj, const char *prog);
/** Run the given program.
*
* @param obj Object being edited.
* @param prog The name of the program to execute.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_run(Evas_Object *obj, const char *prog);
/** Set a new name for the given program
*
* @param obj Object being edited.
* @param prog The current program name.
* @param new_name The new name to assign.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_name_set(Evas_Object *obj, const char *prog, const char *new_name);
/** Get source of a given program.
*
* Remember to free the returned string using edje_edit_string_free().
*
* @param obj Object being edited.
* @param prog The name of the program to get source.
*
* @return The source value por program.
*/
EAPI const char * edje_edit_program_source_get(Evas_Object *obj, const char *prog);
/** Set source of the given program.
*
* @param obj Object being edited.
* @param prog The name of the program to set source.
* @param source The new source value.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_source_set(Evas_Object *obj, const char *prog, const char *source);
/** Get signal of a given program.
*
* Remember to free the returned string using edje_edit_string_free().
*
* @param obj Object being edited.
* @param prog The name of the program to get the signal.
*
* @return The signal value for program.
*/
EAPI const char * edje_edit_program_signal_get(Evas_Object *obj, const char *prog);
/** Set signal of the given program.
*
* @param obj Object being edited.
* @param prog The name of the program to set the signal.
* @param signal The new signal value.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_signal_set(Evas_Object *obj, const char *prog, const char *signal);
/** Get in.from of a given program.
*
* @param obj Object being edited.
* @param prog The name of the program to get the delay.
*
* @return The delay.
*/
EAPI double edje_edit_program_in_from_get(Evas_Object *obj, const char *prog);
/** Set in.from of a given program.
*
* @param obj Object being edited.
* @param prog The name of the program to set the delay.
* @param seconds Number of seconds to delay the program execution
*
* */
EAPI Eina_Bool edje_edit_program_in_from_set(Evas_Object *obj, const char *prog, double seconds);
/** Get in.range of a given program.
*
* @param obj Object being edited.
* @param prog The name of the program to get random delay.
*
* @return The delay random.
*/
EAPI double edje_edit_program_in_range_get(Evas_Object *obj, const char *prog);
/** Set in.range of a given program.
*
* @param obj Object being edited.
* @param prog The name of the program to set random delay.
* @param seconds Max random number of seconds to delay.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_in_range_set(Evas_Object *obj, const char *prog, double seconds);
/** Get the action of a given program.
*
* @param obj Object being edited.
* @param prog The name of the program to get the action.
*
* @return The action type, or -1 on errors.
* Action can be one of EDJE_ACTION_TYPE_NONE, _STATE_SET, ACTION_STOP, SIGNAL_EMIT, DRAG_VAL_SET, _DRAG_VAL_STEP, _DRAG_VAL_PAGE, _SCRIPT
*/
EAPI Edje_Action_Type edje_edit_program_action_get(Evas_Object *obj, const char *prog);
/** Set the action of a given program.
*
* Action can be one of EDJE_ACTION_TYPE_NONE, _STATE_SET, ACTION_STOP, SIGNAL_EMIT, DRAG_VAL_SET, _DRAG_VAL_STEP, _DRAG_VAL_PAGE, _SCRIPT
*
* @param obj Object being edited.
* @param prog The name of the program to set the action.
* @param action The new action type.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_action_set(Evas_Object *obj, const char *prog, Edje_Action_Type action);
/** Get the list of the targets for the given program.
*
* Use edje_edit_string_list_free() when you don't need it anymore.
*
* @param obj Object being edited.
* @param prog The name of the progrem to get the list of the targets.
*
* @return A list with all the targets names, or NULL on error.
*/
EAPI Eina_List * edje_edit_program_targets_get(Evas_Object *obj, const char *prog);
/** Add a new target program to the list of 'targets' in the given program.
*
* If program action is @c EDJE_ACTION_TYPE_ACTION_STOP, then 'target'
* must be an existing program name. If it's @c
* EDJE_ACTION_TYPE_STATE_SET, then 'target' must be an existing part
* name.
*
* @param obj Object being edited.
* @param prog The name of the program to add a new target.
* @param target The name of the new target itself.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_target_add(Evas_Object *obj, const char *prog, const char *target);
/** Deletes a target from the list of 'targets' in the given program.
*
* If program action is EDJE_ACTION_TYPE_ACTION_STOP then 'target' must be an existing program name.
* If action is EDJE_ACTION_TYPE_STATE_SET then 'target' must be an existing part name.
*
* @param obj Object being edited.
* @param prog The name of the program to del a target from the list of targets.
* @param target The name of another program or another part.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_target_del(Evas_Object *obj, const char *prog, const char *target);
/** Clear the 'targets' list of the given program
*
* @param obj Object being edited.
* @param prog The name of the program to cleaar the 'targets' list.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_targets_clear(Evas_Object *obj, const char *prog);
/** Get the list of action that will be run after the give program
*
* Use edje_edit_string_list_free() when you don't need it anymore.
*
* @param obj Object being edited.
* @param prog The name of the program to get the list of actions
*
* @return A list with all program names. or NULL on error.
*/
EAPI Eina_List * edje_edit_program_afters_get(Evas_Object *obj, const char *prog);
/** Add a new program name to the list of 'afters' in the given program.
*
* All the programs listed in 'afters' will be executed after program execution.
*
* @param obj Object being edited.
* @param prog The name of the program that contains the list of afters
* @param after The name of another program to add to the afters list
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_after_add(Evas_Object *obj, const char *prog, const char *after);
/** Delete the given program from the list of 'afters' of the program.
*
* @param obj Object being edited.
* @param prog The name of the program from where to remove the after.
* @param after The name of the program to remove from the list of afters.
*
* @return EINA_TRUE is successful or not in the list, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_after_del(Evas_Object *obj, const char *prog, const char *after);
/** Clear the 'afters' list of the given program.
*
* @param obj Object being edited.
* @param prog The name of the program to clear the 'afters' list.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_afters_clear(Evas_Object *obj, const char *prog);
/** Get the state for the given program
*
* In a STATE_SET action this is the name of state to set.
* In a SIGNAL_EMIT action is the name of the signal to emit.
*
* @param obj Object being edited.
* @param prog The name of the program to get the state.
*
* @return The name of the state.
*/
EAPI const char * edje_edit_program_state_get(Evas_Object *obj, const char *prog);
/** Get api's name of a program.
*
* @param obj Object being edited.
* @param prog Name of program.
*
* @return name of the api if successful, NULL otherwise.
*/
EAPI const char * edje_edit_program_api_name_get(Evas_Object *obj, const char *prog);
/** Get api's description of a program.
*
* @param obj Object being edited.
* @param prog Name of program.
*
* @return description of the api if successful, NULL otherwise.
*/
EAPI const char * edje_edit_program_api_description_get(Evas_Object *obj, const char *prog);
/** Set api's name of a program.
*
* @param obj Object being edited.
* @param prog Name of the part.
* @param name New name for the api property.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_api_name_set(Evas_Object *obj, const char *prog, const char *name);
/** Set api's description of a program.
*
* @param obj Object being edited.
* @param prog Name of the program.
* @param description New description for the api property.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_api_description_set(Evas_Object *obj, const char *prog, const char *description);
/** Set the state for the given program
*
* In a STATE_SET action this is the name of state to set.
* In a SIGNAL_EMIT action is the name of the signal to emit.
*
* @param obj Object being edited.
* @param prog The name of the program to set a state.
* @param state The nameo of the state to set (not including the state value)
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_state_set(Evas_Object *obj, const char *prog, const char *state);
/** Get the value of state for the given program.
*
* In a STATE_SET action this is the value of state to set.
* Not used on SIGNAL_EMIT action.
*
* @param obj Object being edited.
* @param prog The name of the program to get the value of state.
*
* @return The value of state for the program.
*/
EAPI double edje_edit_program_value_get(Evas_Object *obj, const char *prog);
/** Set the value of state for the given program.
*
* In a STATE_SET action this is the value of state to set.
* Not used on SIGNAL_EMIT action.
*
* @param obj Object being edited.
* @param prog The name of the program to set the value of state.
* @param value The vale to set.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_value_set(Evas_Object *obj, const char *prog, double value);
/** Get the state2 for the given program
*
* In a STATE_SET action is not used
* In a SIGNAL_EMIT action is the source of the emitted signal.
*
* @param obj Object being edited.
* @param prog The name of the program to get the state2.
*
* @return The source to emit for the program.
*/
EAPI const char * edje_edit_program_state2_get(Evas_Object *obj, const char *prog);
/** Set the state2 for the given program
*
* In a STATE_SET action is not used
* In a SIGNAL_EMIT action is the source of the emitted signal.
*
* @param obj Object being edited.
* @param prog The name of the program to set the state2.
* @param state2 The name of the state to set.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_state2_set(Evas_Object *obj, const char *prog, const char *state2);
/** Get the value of state2 for the given program.
*
* @param obj Object being edited.
* @param prog The name of the program to get the state2 value.
*
* @return The vale of the state2 for the program.
*/
EAPI double edje_edit_program_value2_get(Evas_Object *obj, const char *prog);
/** Set the value2 of state for the given program.
*
* This is used in DRAG_ACTION
*
* @param obj Object being edited.
* @param prog The name of the program to set the state2 value.
* @param value The value of the state2 to set.
*/
EAPI Eina_Bool edje_edit_program_value2_set(Evas_Object *obj, const char *prog, double value);
/** Get the type of transition to use when apply animations.
*
* Can be one of: EDJE_TWEEN_MODE_NONE, EDJE_TWEEN_MODE_LINEAR, EDJE_TWEEN_MODE_SINUSOIDAL, EDJE_TWEEN_MODE_ACCELERATE or EDJE_TWEEN_MODE_DECELERATE.
*
* @param obj Object being edited.
* @param prog The name of the program to get the transition.
*
* @return The type of transition used by program.
*/
EAPI Edje_Tween_Mode edje_edit_program_transition_get(Evas_Object *obj, const char *prog);
/** Set the type of transition to use when apply animations.
*
* Can be one of: EDJE_TWEEN_MODE_NONE, EDJE_TWEEN_MODE_LINEAR, EDJE_TWEEN_MODE_SINUSOIDAL, EDJE_TWEEN_MODE_ACCELERATE or EDJE_TWEEN_MODE_DECELERATE.
*
* @param obj Object being edited.
* @param prog The name of the program to set the transition.
* @param transition The transition type to set
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_transition_set(Evas_Object *obj, const char *prog, Edje_Tween_Mode transition);
/** Get the interpolation value 1 of the transition.
* Can be used with one of transition type: EDJE_TWEEN_MODE_ACCELERATE_FACTOR, EDJE_TWEEN_MODE_DECELERATE_FACTOR, EDJE_TWEEN_MODE_SINUSOIDAL_FACTOR, EDJE_TWEEN_MODE_DIVISOR_INTERP, EDJE_TWEEN_MODE_BOUNCE or EDJE_TWEEN_MODE_SPRING.
*
* @param obj Object being edited.
* @param prog The name of the program to get the interpolation value 1.
*
* @return interpolation value 1.
*/
EAPI double
edje_edit_program_transition_value1_get(Evas_Object *obj, const char *prog);
/** Set the interpolation value 1 of the transition.
* Can be used with one of transition type: EDJE_TWEEN_MODE_ACCELERATE_FACTOR, EDJE_TWEEN_MODE_DECELERATE_FACTOR, EDJE_TWEEN_MODE_SINUSOIDAL_FACTOR, EDJE_TWEEN_MODE_DIVISOR_INTERP, EDJE_TWEEN_MODE_BOUNCE or EDJE_TWEEN_MODE_SPRING.
*
* @param obj Object being edited.
* @param prog The name of the program to get the interpolation value 1.
* @param value The interpolation value 1 for the transition.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_program_transition_value1_set(Evas_Object *obj, const char *prog, double value);
/** Get the interpolation value 2 of the transition.
* Can be used with one of transition type: EDJE_TWEEN_MODE_DIVISOR_INTERP, EDJE_TWEEN_MODE_BOUNCE or EDJE_TWEEN_MODE_SPRING.
* @param obj Object being edited.
* @param prog The name of the program to get the interpolation value 2.
*
* @return interpolation value 2.
*/
EAPI double
edje_edit_program_transition_value2_get(Evas_Object *obj, const char *prog);
/** Set the interpolation value 2 of the transition.
* Can be used with one of transition type: EDJE_TWEEN_MODE_DIVISOR_INTERP, EDJE_TWEEN_MODE_BOUNCE or EDJE_TWEEN_MODE_SPRING.
*
* @param obj Object being edited.
* @param prog The name of the program to get the interpolation value 2.
* @param value The interpolation value 2 for the transition.
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_program_transition_value2_set(Evas_Object *obj, const char *prog, double value);
/** Get the duration of the transition in seconds.
*
* @param obj Object being edited.
* @param prog The name of the program to get the transition time.
*
* @return The duration of the transition.
*/
EAPI double edje_edit_program_transition_time_get(Evas_Object *obj, const char *prog);
/** Set the duration of the transition in seconds.
*
* @param obj Object being edited.
* @param prog The name of the program to set the transition time.
* @param seconds The duration of the transition (in seconds).
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_transition_time_set(Evas_Object *obj, const char *prog, double seconds);
EAPI const char * edje_edit_program_filter_part_get(Evas_Object *obj, const char *prog);
EAPI Eina_Bool edje_edit_program_filter_part_set(Evas_Object *obj, const char *prog, const char *filter_part);
//@}
/******************************************************************************/
/************************** SCRIPTS API ***********************************/
/******************************************************************************/
/** @name Scripts API
* Functions to deal with embryo scripts (see @ref edcref).
*/ //@{
/**
* Get the Embryo script for the group of the given object.
*
* Get the shared script for the group under edition. Shared script means
* the script {} block for the group, not counting what's in each program.
* It returns a malloc'd duplicate of the code, so users are free to modify
* the contents directly and they should remember to free() it when done.
* NULL will be returned if there's no script or an error occurred.
*
* @param obj Object being edited.
*
* @return The shared script code for this group.
*/
EAPI char *edje_edit_script_get(Evas_Object *obj);
/**
* Set the code for the group script.
*
* Set the Embryo source code for the shared script of the edited group.
* Note that changing the code itself will not update the running VM, you
* need to call edje_edit_script_compile for it to get updated.
*
* @param obj The object being edited
* @param code The Embryo source
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_script_set(Evas_Object *obj, const char *code);
/**
* Get the Embryo script for the given program.
*
* Get the script code for the given program. Like the group script, this
* function returns a duplicate of the code that the user can modify at will
* and must free when done using it.
* NULL will be returned if the program doesn't exist, doesn't have any
* script or is not of type script.
*
* @param obj Object being edited
* @param prog Program name
*
* @return The program script code
*/
EAPI char *edje_edit_script_program_get(Evas_Object *obj, const char *prog);
/**
* Set the Embryo script for the given program.
*
* Set the Embryo source code for the program @p prog. It must be an
* existing program of type EDJE_ACTION_TYPE_SCRIPT, or the function
* will fail and do nothing.
* Note that changing the code itself will not update the running VM, you
* need to call edje_edit_script_compile for it to get updated.
*
* @param obj The object being edited
* @param prog The program name.
* @param code The Embryo source
*
* @return EINA_TRUE if successful, EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_script_program_set(Evas_Object *obj, const char *prog, const char *code);
/**
* Compile the Embryo script for the given object
*
* If required, this function will process all script code for the group and
* build the bytecode, updating the running Embryo VM Program if the build
* is succesful.
*
* @param obj The object being edited
*
*/
EAPI Eina_Bool edje_edit_script_compile(Evas_Object *obj);
/**
* Get the list of errors resulting from the last script build
*
* Get the list of errors that resulted from the last attempt to rebuild
* the Embryo script for the edited group. This will be a standard Eina_List
* with Edje_Edit_Script_Error pointers as its data.
* The user should not do anything else but read the contents of this list.
* These errors can be the output of the embryo compiler, or internal errors
* generated by Edje_Edit if the preprocessing of the scripts failed.
*
* @param obj The object being edited
*
* @return A constant list of Edje_Edit_Script_Error, or NULL if there are none
*/
EAPI const Eina_List *edje_edit_script_error_list_get(Evas_Object *obj);
//@}
/******************************************************************************/
/************************** ERROR API ***********************************/
/******************************************************************************/
/** @name Error API
* to deal with error messages (see @ref edcref).
*/ //@{
EAPI extern Eina_Error EDJE_EDIT_ERROR_GROUP_CURRENTLY_USED;
EAPI extern Eina_Error EDJE_EDIT_ERROR_GROUP_REFERENCED;
EAPI extern Eina_Error EDJE_EDIT_ERROR_GROUP_DOES_NOT_EXIST;
#ifdef __cplusplus
}
#endif
#endif
|