/usr/share/gtk-doc/html/atk/AtkObject.html is in libatk1.0-doc 2.22.0-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AtkObject: ATK - Accessibility Toolkit</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atkobject.html" title="Base accessibility object">
<link rel="prev" href="atkobject.html" title="Base accessibility object">
<link rel="next" href="toolkit.html" title="Event and toolkit support">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#AtkObject.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#AtkObject.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_derived_interfaces"> <span class="dim">|</span>
<a href="#AtkObject.derived-interfaces" class="shortcut">Known Derived Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#AtkObject.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#AtkObject.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="atkobject.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="atkobject.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="toolkit.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="AtkObject"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtkObject.top_of_page"></a>AtkObject</span></h2>
<p>AtkObject — The base object class for the Accessibility Toolkit API.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="AtkObject.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-role-register" title="atk_role_register ()">atk_role_register</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="AtkObject.html#AtkFunction" title="AtkFunction ()">*AtkFunction</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="AtkObject.html#AtkPropertyChangeHandler" title="AtkPropertyChangeHandler ()">*AtkPropertyChangeHandler</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-implementor-ref-accessible" title="atk_implementor_ref_accessible ()">atk_implementor_ref_accessible</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-get-name" title="atk_object_get_name ()">atk_object_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-get-description" title="atk_object_get_description ()">atk_object_get_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-get-parent" title="atk_object_get_parent ()">atk_object_get_parent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-peek-parent" title="atk_object_peek_parent ()">atk_object_peek_parent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-get-n-accessible-children" title="atk_object_get_n_accessible_children ()">atk_object_get_n_accessible_children</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-ref-accessible-child" title="atk_object_ref_accessible_child ()">atk_object_ref_accessible_child</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkRelationSet.html" title="AtkRelationSet"><span class="returnvalue">AtkRelationSet</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-ref-relation-set" title="atk_object_ref_relation_set ()">atk_object_ref_relation_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkObject.html#AtkLayer" title="enum AtkLayer"><span class="returnvalue">AtkLayer</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-get-layer" title="atk_object_get_layer ()">atk_object_get_layer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-get-mdi-zorder" title="atk_object_get_mdi_zorder ()">atk_object_get_mdi_zorder</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-get-role" title="atk_object_get_role ()">atk_object_get_role</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkStateSet.html" title="AtkStateSet"><span class="returnvalue">AtkStateSet</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-ref-state-set" title="atk_object_ref_state_set ()">atk_object_ref_state_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-get-index-in-parent" title="atk_object_get_index_in_parent ()">atk_object_get_index_in_parent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-set-name" title="atk_object_set_name ()">atk_object_set_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-set-description" title="atk_object_set_description ()">atk_object_set_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-set-parent" title="atk_object_set_parent ()">atk_object_set_parent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-set-role" title="atk_object_set_role ()">atk_object_set_role</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-connect-property-change-handler" title="atk_object_connect_property_change_handler ()">atk_object_connect_property_change_handler</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-remove-property-change-handler" title="atk_object_remove_property_change_handler ()">atk_object_remove_property_change_handler</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-notify-state-change" title="atk_object_notify_state_change ()">atk_object_notify_state_change</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-initialize" title="atk_object_initialize ()">atk_object_initialize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-add-relationship" title="atk_object_add_relationship ()">atk_object_add_relationship</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-remove-relationship" title="atk_object_remove_relationship ()">atk_object_remove_relationship</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-get-attributes" title="atk_object_get_attributes ()">atk_object_get_attributes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-object-get-object-locale" title="atk_object_get_object_locale ()">atk_object_get_object_locale</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-role-get-name" title="atk_role_get_name ()">atk_role_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-role-get-localized-name" title="atk_role_get_localized_name ()">atk_role_get_localized_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkObject.html#atk-role-for-name" title="atk_role_for_name ()">atk_role_for_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtkObject.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-component-layer" title="The “accessible-component-layer” property">accessible-component-layer</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-component-mdi-zorder" title="The “accessible-component-mdi-zorder” property">accessible-component-mdi-zorder</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-description" title="The “accessible-description” property">accessible-description</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-hypertext-nlinks" title="The “accessible-hypertext-nlinks” property">accessible-hypertext-nlinks</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-name" title="The “accessible-name” property">accessible-name</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *</td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-parent" title="The “accessible-parent” property">accessible-parent</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-role" title="The “accessible-role” property">accessible-role</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-table-caption" title="The “accessible-table-caption” property">accessible-table-caption</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *</td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-table-caption-object" title="The “accessible-table-caption-object” property">accessible-table-caption-object</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-table-column-description" title="The “accessible-table-column-description” property">accessible-table-column-description</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *</td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-table-column-header" title="The “accessible-table-column-header” property">accessible-table-column-header</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-table-row-description" title="The “accessible-table-row-description” property">accessible-table-row-description</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *</td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-table-row-header" title="The “accessible-table-row-header” property">accessible-table-row-header</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *</td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-table-summary" title="The “accessible-table-summary” property">accessible-table-summary</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="AtkObject.html#AtkObject--accessible-value" title="The “accessible-value” property">accessible-value</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtkObject.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkObject.html#AtkObject-active-descendant-changed" title="The “active-descendant-changed” signal">active-descendant-changed</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkObject.html#AtkObject-children-changed" title="The “children-changed” signal">children-changed</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkObject.html#AtkObject-focus-event" title="The “focus-event” signal">focus-event</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkObject.html#AtkObject-property-change" title="The “property-change” signal">property-change</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkObject.html#AtkObject-state-change" title="The “state-change” signal">state-change</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkObject.html#AtkObject-visible-data-changed" title="The “visible-data-changed” signal">visible-data-changed</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
</tbody>
</table></div>
</div>
<a name="AtkImplementorIface"></a><div class="refsect1">
<a name="AtkObject.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="AtkObject.html#AtkObject-struct" title="struct AtkObject">AtkObject</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole">AtkRole</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="AtkObject.html#AtkLayer" title="enum AtkLayer">AtkLayer</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="AtkObject.html#AtkImplementor" title="AtkImplementor">AtkImplementor</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="AtkObject.html#AtkAttribute" title="struct AtkAttribute">AtkAttribute</a></td>
</tr>
<tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet">AtkAttributeSet</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="AtkObject.html#AtkPropertyValues" title="AtkPropertyValues">AtkPropertyValues</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtkObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> AtkImplementorIface
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> AtkObject
<span class="lineart">├──</span> <a class="link" href="AtkGObjectAccessible.html" title="AtkGObjectAccessible">AtkGObjectAccessible</a>
<span class="lineart">╰──</span> <a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>
</pre>
</div>
<div class="refsect1">
<a name="AtkObject.derived-interfaces"></a><h2>Known Derived Interfaces</h2>
<p>
AtkObject is required by
<a class="link" href="AtkTableCell.html" title="AtkTableCell">AtkTableCell</a> and <a class="link" href="AtkWindow.html" title="AtkWindow">AtkWindow</a>.</p>
</div>
<div class="refsect1">
<a name="AtkObject.description"></a><h2>Description</h2>
<p>This class is the primary class for accessibility support via the
Accessibility ToolKit (ATK). Objects which are instances of
<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> (or instances of AtkObject-derived types) are queried
for properties which relate basic (and generic) properties of a UI
component such as name and description. Instances of <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>
may also be queried as to whether they implement other ATK
interfaces (e.g. <a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a>, <a class="link" href="AtkComponent.html" title="AtkComponent"><span class="type">AtkComponent</span></a>, etc.), as appropriate
to the role which a given UI component plays in a user interface.</p>
<p>All UI components in an application which provide useful
information or services to the user must provide corresponding
<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> instances on request (in GTK+, for instance, usually on
a call to <code class="function"><GTKDOCLINK HREF="gtk-widget-get-accessible"><code class="function">gtk_widget_get_accessible()</code></code></GTKDOCLINK>), either via ATK support
built into the toolkit for the widget class or ancestor class, or
in the case of custom widgets, if the inherited <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>
implementation is insufficient, via instances of a new <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>
subclass.</p>
<p>See also: <a class="link" href="AtkObjectFactory.html" title="AtkObjectFactory"><span class="type">AtkObjectFactory</span></a>, <a class="link" href="AtkRegistry.html" title="AtkRegistry"><span class="type">AtkRegistry</span></a>. (GTK+ users see also
<span class="type">GtkAccessible</span>).</p>
</div>
<div class="refsect1">
<a name="AtkObject.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="atk-role-register"></a><h3>atk_role_register ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>
atk_role_register (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<div class="warning">
<p><code class="literal">atk_role_register</code> is deprecated and should not be used in newly-written code.</p>
<p>Since 2.12. If your application/toolkit doesn't find a
suitable role for a specific object defined at <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a>, please
submit a bug in order to add a new role to the specification.</p>
</div>
<p>Registers the role specified by <em class="parameter"><code>name</code></em>
. <em class="parameter"><code>name</code></em>
must be a meaningful
name. So it should not be empty, or consisting on whitespaces.</p>
<div class="refsect3">
<a name="atk-role-register.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>a character string describing the new role.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-role-register.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> for the new role if added
properly. ATK_ROLE_INVALID in case of error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtkFunction"></a><h3>AtkFunction ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
<span class="c_punctuation">(</span>*AtkFunction<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>An AtkFunction is a function definition used for padding which has
been added to class and interface structures to allow for expansion
in the future.</p>
<div class="refsect3">
<a name="AtkFunction.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>custom data defined by the user</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="AtkFunction.returns"></a><h4>Returns</h4>
<p> not used</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtkPropertyChangeHandler"></a><h3>AtkPropertyChangeHandler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*AtkPropertyChangeHandler<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *obj</code></em>,
<em class="parameter"><code><a class="link" href="AtkObject.html#AtkPropertyValues" title="AtkPropertyValues"><span class="type">AtkPropertyValues</span></a> *vals</code></em>);</pre>
<div class="warning">
<p><code class="literal">AtkPropertyChangeHandler</code> is deprecated and should not be used in newly-written code.</p>
<p>Since 2.12.</p>
</div>
<p>An AtkPropertyChangeHandler is a function which is executed when an
AtkObject's property changes value. It is specified in a call to
<a class="link" href="AtkObject.html#atk-object-connect-property-change-handler" title="atk_object_connect_property_change_handler ()"><code class="function">atk_object_connect_property_change_handler()</code></a>.</p>
<div class="refsect3">
<a name="AtkPropertyChangeHandler.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>atkobject which property changes</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>vals</p></td>
<td class="parameter_description"><p>values changed</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-implementor-ref-accessible"></a><h3>atk_implementor_ref_accessible ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
atk_implementor_ref_accessible (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkImplementor" title="AtkImplementor"><span class="type">AtkImplementor</span></a> *implementor</code></em>);</pre>
<p>Gets a reference to an object's <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> implementation, if
the object implements <span class="type">AtkObjectIface</span></p>
<div class="refsect3">
<a name="atk-implementor-ref-accessible.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>implementor</p></td>
<td class="parameter_description"><p>The <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> instance which should implement <a class="link" href="AtkObject.html#AtkImplementorIface"><span class="type">AtkImplementorIface</span></a>
if a non-null return value is required.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-implementor-ref-accessible.returns"></a><h4>Returns</h4>
<p> a reference to an object's <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>
implementation. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-get-name"></a><h3>atk_object_get_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_object_get_name (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<p>Gets the accessible name of the accessible.</p>
<div class="refsect3">
<a name="atk-object-get-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-get-name.returns"></a><h4>Returns</h4>
<p> a character string representing the accessible name of the object.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-get-description"></a><h3>atk_object_get_description ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_object_get_description (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<p>Gets the accessible description of the accessible.</p>
<div class="refsect3">
<a name="atk-object-get-description.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-get-description.returns"></a><h4>Returns</h4>
<p> a character string representing the accessible description
of the accessible.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-get-parent"></a><h3>atk_object_get_parent ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
atk_object_get_parent (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<p>Gets the accessible parent of the accessible. By default this is
the one assigned with <a class="link" href="AtkObject.html#atk-object-set-parent" title="atk_object_set_parent ()"><code class="function">atk_object_set_parent()</code></a>, but it is assumed
that ATK implementors have ways to get the parent of the object
without the need of assigning it manually with
<a class="link" href="AtkObject.html#atk-object-set-parent" title="atk_object_set_parent ()"><code class="function">atk_object_set_parent()</code></a>, and will return it with this method.</p>
<p>If you are only interested on the parent assigned with
<a class="link" href="AtkObject.html#atk-object-set-parent" title="atk_object_set_parent ()"><code class="function">atk_object_set_parent()</code></a>, use <a class="link" href="AtkObject.html#atk-object-peek-parent" title="atk_object_peek_parent ()"><code class="function">atk_object_peek_parent()</code></a>.</p>
<div class="refsect3">
<a name="atk-object-get-parent.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-get-parent.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> representing the accessible
parent of the accessible. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-peek-parent"></a><h3>atk_object_peek_parent ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
atk_object_peek_parent (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<p>Gets the accessible parent of the accessible, if it has been
manually assigned with atk_object_set_parent. Otherwise, this
function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p>This method is intended as an utility for ATK implementors, and not
to be exposed to accessible tools. See <a class="link" href="AtkObject.html#atk-object-get-parent" title="atk_object_get_parent ()"><code class="function">atk_object_get_parent()</code></a> for
further reference.</p>
<div class="refsect3">
<a name="atk-object-peek-parent.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-peek-parent.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> representing the accessible
parent of the accessible if assigned. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-get-n-accessible-children"></a><h3>atk_object_get_n_accessible_children ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
atk_object_get_n_accessible_children (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<p>Gets the number of accessible children of the accessible.</p>
<div class="refsect3">
<a name="atk-object-get-n-accessible-children.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-get-n-accessible-children.returns"></a><h4>Returns</h4>
<p> an integer representing the number of accessible children
of the accessible.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-ref-accessible-child"></a><h3>atk_object_ref_accessible_child ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
atk_object_ref_accessible_child (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
<p>Gets a reference to the specified accessible child of the object.
The accessible children are 0-based so the first accessible child is
at index 0, the second at index 1 and so on.</p>
<div class="refsect3">
<a name="atk-object-ref-accessible-child.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>a gint representing the position of the child, starting from 0</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-ref-accessible-child.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> representing the specified
accessible child of the accessible. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-ref-relation-set"></a><h3>atk_object_ref_relation_set ()</h3>
<pre class="programlisting"><a class="link" href="AtkRelationSet.html" title="AtkRelationSet"><span class="returnvalue">AtkRelationSet</span></a> *
atk_object_ref_relation_set (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<p>Gets the <a class="link" href="AtkRelationSet.html" title="AtkRelationSet"><span class="type">AtkRelationSet</span></a> associated with the object.</p>
<div class="refsect3">
<a name="atk-object-ref-relation-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-ref-relation-set.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="AtkRelationSet.html" title="AtkRelationSet"><span class="type">AtkRelationSet</span></a> representing the relation set
of the object. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-get-layer"></a><h3>atk_object_get_layer ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html#AtkLayer" title="enum AtkLayer"><span class="returnvalue">AtkLayer</span></a>
atk_object_get_layer (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<div class="warning">
<p><code class="literal">atk_object_get_layer</code> is deprecated and should not be used in newly-written code.</p>
<p>Use atk_component_get_layer instead.</p>
</div>
<p>Gets the layer of the accessible.</p>
<div class="refsect3">
<a name="atk-object-get-layer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-get-layer.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="AtkObject.html#AtkLayer" title="enum AtkLayer"><span class="type">AtkLayer</span></a> which is the layer of the accessible</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-get-mdi-zorder"></a><h3>atk_object_get_mdi_zorder ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
atk_object_get_mdi_zorder (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<div class="warning">
<p><code class="literal">atk_object_get_mdi_zorder</code> is deprecated and should not be used in newly-written code.</p>
<p>Use atk_component_get_mdi_zorder instead.</p>
</div>
<p>Gets the zorder of the accessible. The value G_MININT will be returned
if the layer of the accessible is not ATK_LAYER_MDI.</p>
<div class="refsect3">
<a name="atk-object-get-mdi-zorder.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-get-mdi-zorder.returns"></a><h4>Returns</h4>
<p> a gint which is the zorder of the accessible, i.e. the depth at
which the component is shown in relation to other components in the same
container.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-get-role"></a><h3>atk_object_get_role ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>
atk_object_get_role (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<p>Gets the role of the accessible.</p>
<div class="refsect3">
<a name="atk-object-get-role.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-get-role.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> which is the role of the accessible</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-ref-state-set"></a><h3>atk_object_ref_state_set ()</h3>
<pre class="programlisting"><a class="link" href="AtkStateSet.html" title="AtkStateSet"><span class="returnvalue">AtkStateSet</span></a> *
atk_object_ref_state_set (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<p>Gets a reference to the state set of the accessible; the caller must
unreference it when it is no longer needed.</p>
<div class="refsect3">
<a name="atk-object-ref-state-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-ref-state-set.returns"></a><h4>Returns</h4>
<p> a reference to an <a class="link" href="AtkStateSet.html" title="AtkStateSet"><span class="type">AtkStateSet</span></a> which is the state
set of the accessible. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-get-index-in-parent"></a><h3>atk_object_get_index_in_parent ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
atk_object_get_index_in_parent (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<p>Gets the 0-based index of this accessible in its parent; returns -1 if the
accessible does not have an accessible parent.</p>
<div class="refsect3">
<a name="atk-object-get-index-in-parent.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-get-index-in-parent.returns"></a><h4>Returns</h4>
<p> an integer which is the index of the accessible in its parent</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-set-name"></a><h3>atk_object_set_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atk_object_set_name (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Sets the accessible name of the accessible. You can't set the name
to NULL. This is reserved for the initial value. In this aspect
NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to
a empty value you can use "".</p>
<div class="refsect3">
<a name="atk-object-set-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>a character string to be set as the accessible name</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-set-description"></a><h3>atk_object_set_description ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atk_object_set_description (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);</pre>
<p>Sets the accessible description of the accessible. You can't set
the description to NULL. This is reserved for the initial value. In
this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set
the name to a empty value you can use "".</p>
<div class="refsect3">
<a name="atk-object-set-description.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>description</p></td>
<td class="parameter_description"><p>a character string to be set as the accessible description</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-set-parent"></a><h3>atk_object_set_parent ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atk_object_set_parent (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *parent</code></em>);</pre>
<p>Sets the accessible parent of the accessible. <em class="parameter"><code>parent</code></em>
can be NULL.</p>
<div class="refsect3">
<a name="atk-object-set-parent.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>parent</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> to be set as the accessible parent</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-set-role"></a><h3>atk_object_set_role ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atk_object_set_role (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
<em class="parameter"><code><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> role</code></em>);</pre>
<p>Sets the role of the accessible.</p>
<div class="refsect3">
<a name="atk-object-set-role.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>role</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> to be set as the role</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-connect-property-change-handler"></a><h3>atk_object_connect_property_change_handler ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
atk_object_connect_property_change_handler
(<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
<em class="parameter"><code><a class="link" href="AtkObject.html#AtkPropertyChangeHandler" title="AtkPropertyChangeHandler ()"><span class="type">AtkPropertyChangeHandler</span></a> *handler</code></em>);</pre>
<div class="warning">
<p><code class="literal">atk_object_connect_property_change_handler</code> is deprecated and should not be used in newly-written code.</p>
<p>Since 2.12. Connect directly to property-change or
notify signals.</p>
</div>
<div class="refsect3">
<a name="atk-object-connect-property-change-handler.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>handler</p></td>
<td class="parameter_description"><p>a function to be called when a property changes its value</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-connect-property-change-handler.returns"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> which is the handler id used in
<a class="link" href="AtkObject.html#atk-object-remove-property-change-handler" title="atk_object_remove_property_change_handler ()"><code class="function">atk_object_remove_property_change_handler()</code></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-remove-property-change-handler"></a><h3>atk_object_remove_property_change_handler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atk_object_remove_property_change_handler
(<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> handler_id</code></em>);</pre>
<div class="warning">
<p><code class="literal">atk_object_remove_property_change_handler</code> is deprecated and should not be used in newly-written code.</p>
<p>Since 2.12.</p>
<p>Removes a property change handler.</p>
</div>
<div class="refsect3">
<a name="atk-object-remove-property-change-handler.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>handler_id</p></td>
<td class="parameter_description"><p>a guint which identifies the handler to be removed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-notify-state-change"></a><h3>atk_object_notify_state_change ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atk_object_notify_state_change (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
<em class="parameter"><code><a class="link" href="atk-AtkState.html#AtkState" title="AtkState"><span class="type">AtkState</span></a> state</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);</pre>
<p>Emits a state-change signal for the specified state.</p>
<p>Note that as a general rule when the state of an existing object changes,
emitting a notification is expected.</p>
<div class="refsect3">
<a name="atk-object-notify-state-change.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>state</p></td>
<td class="parameter_description"><p>an <a class="link" href="atk-AtkState.html#AtkState" title="AtkState"><span class="type">AtkState</span></a> whose state is changed</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>a gboolean which indicates whether the state is being set on or off</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-initialize"></a><h3>atk_object_initialize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atk_object_initialize (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>This function is called when implementing subclasses of <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>.
It does initialization required for the new object. It is intended
that this function should called only in the ..._new() functions used
to create an instance of a subclass of <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p>
<div class="refsect3">
<a name="atk-object-initialize.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>a <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> which identifies the object for which the AtkObject was created.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-add-relationship"></a><h3>atk_object_add_relationship ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
atk_object_add_relationship (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *object</code></em>,
<em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> relationship</code></em>,
<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);</pre>
<p>Adds a relationship of the specified type with the specified target.</p>
<div class="refsect3">
<a name="atk-object-add-relationship.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> to which an AtkRelation is to be added. </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>relationship</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> of the relation</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> which is to be the target of the relation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-add-relationship.returns"></a><h4>Returns</h4>
<p> TRUE if the relationship is added.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-remove-relationship"></a><h3>atk_object_remove_relationship ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
atk_object_remove_relationship (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *object</code></em>,
<em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> relationship</code></em>,
<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);</pre>
<p>Removes a relationship of the specified type with the specified target.</p>
<div class="refsect3">
<a name="atk-object-remove-relationship.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> from which an AtkRelation is to be removed. </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>relationship</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> of the relation</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> which is the target of the relation to be removed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-remove-relationship.returns"></a><h4>Returns</h4>
<p> TRUE if the relationship is removed.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-get-attributes"></a><h3>atk_object_get_attributes ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *
atk_object_get_attributes (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<p>Get a list of properties applied to this object as a whole, as an <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> consisting of
name-value pairs. As such these attributes may be considered weakly-typed properties or annotations,
as distinct from strongly-typed object data available via other get/set methods.
Not all objects have explicit "name-value pair" <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> properties.</p>
<div class="refsect3">
<a name="atk-object-get-attributes.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>An <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-get-attributes.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> consisting of all
explicit properties/annotations applied to the object, or an empty
set if the object has no name-value pair attributes assigned to
it. This <span class="type">atkattributeset</span> should be freed by a call to
<a class="link" href="AtkText.html#atk-attribute-set-free" title="atk_attribute_set_free ()"><code class="function">atk_attribute_set_free()</code></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
<p class="since">Since: 1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="atk-object-get-object-locale"></a><h3>atk_object_get_object_locale ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_object_get_object_locale (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
<p>Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
of <em class="parameter"><code>accessible</code></em>
.</p>
<div class="refsect3">
<a name="atk-object-get-object-locale.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>accessible</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-object-get-object-locale.returns"></a><h4>Returns</h4>
<p> a UTF-8 string indicating the POSIX-style LC_MESSAGES
locale of <em class="parameter"><code>accessible</code></em>
.</p>
</div>
<p class="since">Since: 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="atk-role-get-name"></a><h3>atk_role_get_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_role_get_name (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> role</code></em>);</pre>
<p>Gets the description string describing the <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> <em class="parameter"><code>role</code></em>
.</p>
<div class="refsect3">
<a name="atk-role-get-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>role</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> whose name is required</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-role-get-name.returns"></a><h4>Returns</h4>
<p> the string describing the AtkRole</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-role-get-localized-name"></a><h3>atk_role_get_localized_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_role_get_localized_name (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> role</code></em>);</pre>
<p>Gets the localized description string describing the <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> <em class="parameter"><code>role</code></em>
.</p>
<div class="refsect3">
<a name="atk-role-get-localized-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>role</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> whose localized name is required</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-role-get-localized-name.returns"></a><h4>Returns</h4>
<p> the localized string describing the AtkRole</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-role-for-name"></a><h3>atk_role_for_name ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>
atk_role_for_name (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Get the <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> type corresponding to a rolew name.</p>
<div class="refsect3">
<a name="atk-role-for-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>a string which is the (non-localized) name of an ATK role.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-role-for-name.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> enumerated type corresponding to the specified name,
or <a class="link" href="AtkObject.html#ATK-ROLE-INVALID:CAPS"><span class="type">ATK_ROLE_INVALID</span></a> if no matching role is found.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="AtkObject.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AtkObject-struct"></a><h3>struct AtkObject</h3>
<pre class="programlisting">struct AtkObject;</pre>
</div>
<hr>
<div class="refsect2">
<a name="AtkRole"></a><h3>enum AtkRole</h3>
<p>Describes the role of an object</p>
<p>These are the built-in enumerated roles that UI components can have in
ATK. Other roles may be added at runtime, so an AtkRole >=
ATK_ROLE_LAST_DEFINED is not necessarily an error.</p>
<div class="refsect3">
<a name="AtkRole.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-INVALID:CAPS"></a>ATK_ROLE_INVALID</p></td>
<td class="enum_member_description">
<p>Invalid role</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-ACCEL-LABEL:CAPS"></a>ATK_ROLE_ACCEL_LABEL</p></td>
<td class="enum_member_description">
<p>A label which represents an accelerator</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-ALERT:CAPS"></a>ATK_ROLE_ALERT</p></td>
<td class="enum_member_description">
<p>An object which is an alert to the user. Assistive Technologies typically respond to ATK_ROLE_ALERT by reading the entire onscreen contents of containers advertising this role. Should be used for warning dialogs, etc.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-ANIMATION:CAPS"></a>ATK_ROLE_ANIMATION</p></td>
<td class="enum_member_description">
<p>An object which is an animated image</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-ARROW:CAPS"></a>ATK_ROLE_ARROW</p></td>
<td class="enum_member_description">
<p>An arrow in one of the four cardinal directions</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-CALENDAR:CAPS"></a>ATK_ROLE_CALENDAR</p></td>
<td class="enum_member_description">
<p>An object that displays a calendar and allows the user to select a date</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-CANVAS:CAPS"></a>ATK_ROLE_CANVAS</p></td>
<td class="enum_member_description">
<p>An object that can be drawn into and is used to trap events</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-CHECK-BOX:CAPS"></a>ATK_ROLE_CHECK_BOX</p></td>
<td class="enum_member_description">
<p>A choice that can be checked or unchecked and provides a separate indicator for the current state</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-CHECK-MENU-ITEM:CAPS"></a>ATK_ROLE_CHECK_MENU_ITEM</p></td>
<td class="enum_member_description">
<p>A menu item with a check box</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-COLOR-CHOOSER:CAPS"></a>ATK_ROLE_COLOR_CHOOSER</p></td>
<td class="enum_member_description">
<p>A specialized dialog that lets the user choose a color</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-COLUMN-HEADER:CAPS"></a>ATK_ROLE_COLUMN_HEADER</p></td>
<td class="enum_member_description">
<p>The header for a column of data</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-COMBO-BOX:CAPS"></a>ATK_ROLE_COMBO_BOX</p></td>
<td class="enum_member_description">
<p>A collapsible list of choices the user can select from</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DATE-EDITOR:CAPS"></a>ATK_ROLE_DATE_EDITOR</p></td>
<td class="enum_member_description">
<p>An object whose purpose is to allow a user to edit a date</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DESKTOP-ICON:CAPS"></a>ATK_ROLE_DESKTOP_ICON</p></td>
<td class="enum_member_description">
<p>An inconifed internal frame within a DESKTOP_PANE</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DESKTOP-FRAME:CAPS"></a>ATK_ROLE_DESKTOP_FRAME</p></td>
<td class="enum_member_description">
<p>A pane that supports internal frames and iconified versions of those internal frames</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DIAL:CAPS"></a>ATK_ROLE_DIAL</p></td>
<td class="enum_member_description">
<p>An object whose purpose is to allow a user to set a value</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DIALOG:CAPS"></a>ATK_ROLE_DIALOG</p></td>
<td class="enum_member_description">
<p>A top level window with title bar and a border</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DIRECTORY-PANE:CAPS"></a>ATK_ROLE_DIRECTORY_PANE</p></td>
<td class="enum_member_description">
<p>A pane that allows the user to navigate through and select the contents of a directory</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DRAWING-AREA:CAPS"></a>ATK_ROLE_DRAWING_AREA</p></td>
<td class="enum_member_description">
<p>An object used for drawing custom user interface elements</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-FILE-CHOOSER:CAPS"></a>ATK_ROLE_FILE_CHOOSER</p></td>
<td class="enum_member_description">
<p>A specialized dialog that lets the user choose a file</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-FILLER:CAPS"></a>ATK_ROLE_FILLER</p></td>
<td class="enum_member_description">
<p>A object that fills up space in a user interface</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-FONT-CHOOSER:CAPS"></a>ATK_ROLE_FONT_CHOOSER</p></td>
<td class="enum_member_description">
<p>A specialized dialog that lets the user choose a font</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-FRAME:CAPS"></a>ATK_ROLE_FRAME</p></td>
<td class="enum_member_description">
<p>A top level window with a title bar, border, menubar, etc.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-GLASS-PANE:CAPS"></a>ATK_ROLE_GLASS_PANE</p></td>
<td class="enum_member_description">
<p>A pane that is guaranteed to be painted on top of all panes beneath it</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-HTML-CONTAINER:CAPS"></a>ATK_ROLE_HTML_CONTAINER</p></td>
<td class="enum_member_description">
<p>A document container for HTML, whose children represent the document content</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-ICON:CAPS"></a>ATK_ROLE_ICON</p></td>
<td class="enum_member_description">
<p>A small fixed size picture, typically used to decorate components</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-IMAGE:CAPS"></a>ATK_ROLE_IMAGE</p></td>
<td class="enum_member_description">
<p>An object whose primary purpose is to display an image</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-INTERNAL-FRAME:CAPS"></a>ATK_ROLE_INTERNAL_FRAME</p></td>
<td class="enum_member_description">
<p>A frame-like object that is clipped by a desktop pane</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-LABEL:CAPS"></a>ATK_ROLE_LABEL</p></td>
<td class="enum_member_description">
<p>An object used to present an icon or short string in an interface</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-LAYERED-PANE:CAPS"></a>ATK_ROLE_LAYERED_PANE</p></td>
<td class="enum_member_description">
<p>A specialized pane that allows its children to be drawn in layers, providing a form of stacking order</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-LIST:CAPS"></a>ATK_ROLE_LIST</p></td>
<td class="enum_member_description">
<p>An object that presents a list of objects to the user and allows the user to select one or more of them </p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-LIST-ITEM:CAPS"></a>ATK_ROLE_LIST_ITEM</p></td>
<td class="enum_member_description">
<p>An object that represents an element of a list </p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-MENU:CAPS"></a>ATK_ROLE_MENU</p></td>
<td class="enum_member_description">
<p>An object usually found inside a menu bar that contains a list of actions the user can choose from</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-MENU-BAR:CAPS"></a>ATK_ROLE_MENU_BAR</p></td>
<td class="enum_member_description">
<p>An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from </p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-MENU-ITEM:CAPS"></a>ATK_ROLE_MENU_ITEM</p></td>
<td class="enum_member_description">
<p>An object usually contained in a menu that presents an action the user can choose</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-OPTION-PANE:CAPS"></a>ATK_ROLE_OPTION_PANE</p></td>
<td class="enum_member_description">
<p>A specialized pane whose primary use is inside a DIALOG</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-PAGE-TAB:CAPS"></a>ATK_ROLE_PAGE_TAB</p></td>
<td class="enum_member_description">
<p>An object that is a child of a page tab list</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-PAGE-TAB-LIST:CAPS"></a>ATK_ROLE_PAGE_TAB_LIST</p></td>
<td class="enum_member_description">
<p>An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object </p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-PANEL:CAPS"></a>ATK_ROLE_PANEL</p></td>
<td class="enum_member_description">
<p>A generic container that is often used to group objects</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-PASSWORD-TEXT:CAPS"></a>ATK_ROLE_PASSWORD_TEXT</p></td>
<td class="enum_member_description">
<p>A text object uses for passwords, or other places where the text content is not shown visibly to the user</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-POPUP-MENU:CAPS"></a>ATK_ROLE_POPUP_MENU</p></td>
<td class="enum_member_description">
<p>A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-PROGRESS-BAR:CAPS"></a>ATK_ROLE_PROGRESS_BAR</p></td>
<td class="enum_member_description">
<p>An object used to indicate how much of a task has been completed</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-PUSH-BUTTON:CAPS"></a>ATK_ROLE_PUSH_BUTTON</p></td>
<td class="enum_member_description">
<p>An object the user can manipulate to tell the application to do something</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-RADIO-BUTTON:CAPS"></a>ATK_ROLE_RADIO_BUTTON</p></td>
<td class="enum_member_description">
<p>A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-RADIO-MENU-ITEM:CAPS"></a>ATK_ROLE_RADIO_MENU_ITEM</p></td>
<td class="enum_member_description">
<p>A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-ROOT-PANE:CAPS"></a>ATK_ROLE_ROOT_PANE</p></td>
<td class="enum_member_description">
<p>A specialized pane that has a glass pane and a layered pane as its children</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-ROW-HEADER:CAPS"></a>ATK_ROLE_ROW_HEADER</p></td>
<td class="enum_member_description">
<p>The header for a row of data</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-SCROLL-BAR:CAPS"></a>ATK_ROLE_SCROLL_BAR</p></td>
<td class="enum_member_description">
<p>An object usually used to allow a user to incrementally view a large amount of data.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-SCROLL-PANE:CAPS"></a>ATK_ROLE_SCROLL_PANE</p></td>
<td class="enum_member_description">
<p>An object that allows a user to incrementally view a large amount of information</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-SEPARATOR:CAPS"></a>ATK_ROLE_SEPARATOR</p></td>
<td class="enum_member_description">
<p>An object usually contained in a menu to provide a visible and logical separation of the contents in a menu</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-SLIDER:CAPS"></a>ATK_ROLE_SLIDER</p></td>
<td class="enum_member_description">
<p>An object that allows the user to select from a bounded range</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-SPLIT-PANE:CAPS"></a>ATK_ROLE_SPLIT_PANE</p></td>
<td class="enum_member_description">
<p>A specialized panel that presents two other panels at the same time</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-SPIN-BUTTON:CAPS"></a>ATK_ROLE_SPIN_BUTTON</p></td>
<td class="enum_member_description">
<p>An object used to get an integer or floating point number from the user</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-STATUSBAR:CAPS"></a>ATK_ROLE_STATUSBAR</p></td>
<td class="enum_member_description">
<p>An object which reports messages of minor importance to the user</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TABLE:CAPS"></a>ATK_ROLE_TABLE</p></td>
<td class="enum_member_description">
<p>An object used to represent information in terms of rows and columns</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TABLE-CELL:CAPS"></a>ATK_ROLE_TABLE_CELL</p></td>
<td class="enum_member_description">
<p>A cell in a table</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TABLE-COLUMN-HEADER:CAPS"></a>ATK_ROLE_TABLE_COLUMN_HEADER</p></td>
<td class="enum_member_description">
<p>The header for a column of a table</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TABLE-ROW-HEADER:CAPS"></a>ATK_ROLE_TABLE_ROW_HEADER</p></td>
<td class="enum_member_description">
<p>The header for a row of a table</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TEAR-OFF-MENU-ITEM:CAPS"></a>ATK_ROLE_TEAR_OFF_MENU_ITEM</p></td>
<td class="enum_member_description">
<p>A menu item used to tear off and reattach its menu</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TERMINAL:CAPS"></a>ATK_ROLE_TERMINAL</p></td>
<td class="enum_member_description">
<p>An object that represents an accessible terminal. <em class="parameter"><code>Since</code></em>
: ATK-0.6</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TEXT:CAPS"></a>ATK_ROLE_TEXT</p></td>
<td class="enum_member_description">
<p>An interactive widget that supports multiple lines of text and
optionally accepts user input, but whose purpose is not to solicit user input.
Thus ATK_ROLE_TEXT is appropriate for the text view in a plain text editor
but inappropriate for an input field in a dialog box or web form. For widgets
whose purpose is to solicit input from the user, see ATK_ROLE_ENTRY and
ATK_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount of
textual information, see ATK_ROLE_STATIC.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TOGGLE-BUTTON:CAPS"></a>ATK_ROLE_TOGGLE_BUTTON</p></td>
<td class="enum_member_description">
<p>A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TOOL-BAR:CAPS"></a>ATK_ROLE_TOOL_BAR</p></td>
<td class="enum_member_description">
<p>A bar or palette usually composed of push buttons or toggle buttons</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TOOL-TIP:CAPS"></a>ATK_ROLE_TOOL_TIP</p></td>
<td class="enum_member_description">
<p>An object that provides information about another object</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TREE:CAPS"></a>ATK_ROLE_TREE</p></td>
<td class="enum_member_description">
<p>An object used to represent hierarchical information to the user</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TREE-TABLE:CAPS"></a>ATK_ROLE_TREE_TABLE</p></td>
<td class="enum_member_description">
<p>An object capable of expanding and collapsing rows as well as showing multiple columns of data. <em class="parameter"><code>Since</code></em>
: ATK-0.7</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-UNKNOWN:CAPS"></a>ATK_ROLE_UNKNOWN</p></td>
<td class="enum_member_description">
<p>The object contains some Accessible information, but its role is not known</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-VIEWPORT:CAPS"></a>ATK_ROLE_VIEWPORT</p></td>
<td class="enum_member_description">
<p>An object usually used in a scroll pane</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-WINDOW:CAPS"></a>ATK_ROLE_WINDOW</p></td>
<td class="enum_member_description">
<p>A top level window with no title or border.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-HEADER:CAPS"></a>ATK_ROLE_HEADER</p></td>
<td class="enum_member_description">
<p>An object that serves as a document header. <em class="parameter"><code>Since</code></em>
: ATK-1.1.1</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-FOOTER:CAPS"></a>ATK_ROLE_FOOTER</p></td>
<td class="enum_member_description">
<p>An object that serves as a document footer. <em class="parameter"><code>Since</code></em>
: ATK-1.1.1</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-PARAGRAPH:CAPS"></a>ATK_ROLE_PARAGRAPH</p></td>
<td class="enum_member_description">
<p>An object which is contains a paragraph of text content. <em class="parameter"><code>Since</code></em>
: ATK-1.1.1</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-RULER:CAPS"></a>ATK_ROLE_RULER</p></td>
<td class="enum_member_description">
<p>An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such). <em class="parameter"><code>Since</code></em>
: ATK-1.1.1</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-APPLICATION:CAPS"></a>ATK_ROLE_APPLICATION</p></td>
<td class="enum_member_description">
<p>The object is an application object, which may contain <em class="parameter"><code>ATK_ROLE_FRAME</code></em>
objects or other types of accessibles. The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION. <em class="parameter"><code>Since</code></em>
: ATK-1.1.4</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-AUTOCOMPLETE:CAPS"></a>ATK_ROLE_AUTOCOMPLETE</p></td>
<td class="enum_member_description">
<p>The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry. <em class="parameter"><code>Since</code></em>
: ATK-1.3</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-EDITBAR:CAPS"></a>ATK_ROLE_EDITBAR</p></td>
<td class="enum_member_description">
<p>The object is an editable text object in a toolbar. <em class="parameter"><code>Since</code></em>
: ATK-1.5</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-EMBEDDED:CAPS"></a>ATK_ROLE_EMBEDDED</p></td>
<td class="enum_member_description">
<p>The object is an embedded container within a document or panel. This role is a grouping "hint" indicating that the contained objects share a context. <em class="parameter"><code>Since</code></em>
: ATK-1.7.2</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-ENTRY:CAPS"></a>ATK_ROLE_ENTRY</p></td>
<td class="enum_member_description">
<p>The object is a component whose textual content may be entered or modified by the user, provided <em class="parameter"><code>ATK_STATE_EDITABLE</code></em>
is present. <em class="parameter"><code>Since</code></em>
: ATK-1.11</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-CHART:CAPS"></a>ATK_ROLE_CHART</p></td>
<td class="enum_member_description">
<p>The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property. <em class="parameter"><code>Since</code></em>
: ATK-1.11</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-CAPTION:CAPS"></a>ATK_ROLE_CAPTION</p></td>
<td class="enum_member_description">
<p>The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. <em class="parameter"><code>Since</code></em>
: ATK-1.11</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DOCUMENT-FRAME:CAPS"></a>ATK_ROLE_DOCUMENT_FRAME</p></td>
<td class="enum_member_description">
<p>The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface. <em class="parameter"><code>Since</code></em>
: ATK-1.11</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-HEADING:CAPS"></a>ATK_ROLE_HEADING</p></td>
<td class="enum_member_description">
<p>The object serves as a heading for content which follows it in a document. The 'heading level' of the heading, if availabe, may be obtained by querying the object's attributes.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-PAGE:CAPS"></a>ATK_ROLE_PAGE</p></td>
<td class="enum_member_description">
<p>The object is a containing instance which encapsulates a page of information. <em class="parameter"><code>ATK_ROLE_PAGE</code></em>
is used in documents and content which support a paginated navigation model. <em class="parameter"><code>Since</code></em>
: ATK-1.11</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-SECTION:CAPS"></a>ATK_ROLE_SECTION</p></td>
<td class="enum_member_description">
<p>The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections may be nested. <em class="parameter"><code>Since</code></em>
: ATK-1.11</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-REDUNDANT-OBJECT:CAPS"></a>ATK_ROLE_REDUNDANT_OBJECT</p></td>
<td class="enum_member_description">
<p>The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should normally be ignored by clients. <em class="parameter"><code>Since</code></em>
: ATK-1.11</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-FORM:CAPS"></a>ATK_ROLE_FORM</p></td>
<td class="enum_member_description">
<p>The object is a container for form controls, for instance as part of a
web form or user-input form within a document. This role is primarily a tag/convenience for
clients when navigating complex documents, it is not expected that ordinary GUI containers will
always have ATK_ROLE_FORM. <em class="parameter"><code>Since</code></em>
: ATK-1.12.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-LINK:CAPS"></a>ATK_ROLE_LINK</p></td>
<td class="enum_member_description">
<p>The object is a hypertext anchor, i.e. a "link" in a
hypertext document. Such objects are distinct from 'inline'
content which may also use the Hypertext/Hyperlink interfaces
to indicate the range/location within a text object where
an inline or embedded object lies. <em class="parameter"><code>Since</code></em>
: ATK-1.12.1</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-INPUT-METHOD-WINDOW:CAPS"></a>ATK_ROLE_INPUT_METHOD_WINDOW</p></td>
<td class="enum_member_description">
<p>The object is a window or similar viewport
which is used to allow composition or input of a 'complex character',
in other words it is an "input method window." <em class="parameter"><code>Since</code></em>
: ATK-1.12.1</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TABLE-ROW:CAPS"></a>ATK_ROLE_TABLE_ROW</p></td>
<td class="enum_member_description">
<p>A row in a table. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TREE-ITEM:CAPS"></a>ATK_ROLE_TREE_ITEM</p></td>
<td class="enum_member_description">
<p>An object that represents an element of a tree. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DOCUMENT-SPREADSHEET:CAPS"></a>ATK_ROLE_DOCUMENT_SPREADSHEET</p></td>
<td class="enum_member_description">
<p>A document frame which contains a spreadsheet. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DOCUMENT-PRESENTATION:CAPS"></a>ATK_ROLE_DOCUMENT_PRESENTATION</p></td>
<td class="enum_member_description">
<p>A document frame which contains a presentation or slide content. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DOCUMENT-TEXT:CAPS"></a>ATK_ROLE_DOCUMENT_TEXT</p></td>
<td class="enum_member_description">
<p>A document frame which contains textual content, such as found in a word processing application. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DOCUMENT-WEB:CAPS"></a>ATK_ROLE_DOCUMENT_WEB</p></td>
<td class="enum_member_description">
<p>A document frame which contains HTML or other markup suitable for display in a web browser. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DOCUMENT-EMAIL:CAPS"></a>ATK_ROLE_DOCUMENT_EMAIL</p></td>
<td class="enum_member_description">
<p>A document frame which contains email content to be displayed or composed either in plain text or HTML. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-COMMENT:CAPS"></a>ATK_ROLE_COMMENT</p></td>
<td class="enum_member_description">
<p>An object found within a document and designed to present a comment, note, or other annotation. In some cases, this object might not be visible until activated. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-LIST-BOX:CAPS"></a>ATK_ROLE_LIST_BOX</p></td>
<td class="enum_member_description">
<p>A non-collapsible list of choices the user can select from. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-GROUPING:CAPS"></a>ATK_ROLE_GROUPING</p></td>
<td class="enum_member_description">
<p>A group of related widgets. This group typically has a label. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-IMAGE-MAP:CAPS"></a>ATK_ROLE_IMAGE_MAP</p></td>
<td class="enum_member_description">
<p>An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-NOTIFICATION:CAPS"></a>ATK_ROLE_NOTIFICATION</p></td>
<td class="enum_member_description">
<p>A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-INFO-BAR:CAPS"></a>ATK_ROLE_INFO_BAR</p></td>
<td class="enum_member_description">
<p>An object designed to present a message to the user within an existing window. <em class="parameter"><code>Since</code></em>
: ATK-2.1.0</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-LEVEL-BAR:CAPS"></a>ATK_ROLE_LEVEL_BAR</p></td>
<td class="enum_member_description">
<p>A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery. <em class="parameter"><code>Since</code></em>
: ATK-2.7.3</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TITLE-BAR:CAPS"></a>ATK_ROLE_TITLE_BAR</p></td>
<td class="enum_member_description">
<p>A bar that serves as the title of a window or a
dialog. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-BLOCK-QUOTE:CAPS"></a>ATK_ROLE_BLOCK_QUOTE</p></td>
<td class="enum_member_description">
<p>An object which contains a text section
that is quoted from another source. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-AUDIO:CAPS"></a>ATK_ROLE_AUDIO</p></td>
<td class="enum_member_description">
<p>An object which represents an audio element. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-VIDEO:CAPS"></a>ATK_ROLE_VIDEO</p></td>
<td class="enum_member_description">
<p>An object which represents a video element. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DEFINITION:CAPS"></a>ATK_ROLE_DEFINITION</p></td>
<td class="enum_member_description">
<p>A definition of a term or concept. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-ARTICLE:CAPS"></a>ATK_ROLE_ARTICLE</p></td>
<td class="enum_member_description">
<p>A section of a page that consists of a
composition that forms an independent part of a document, page, or
site. Examples: A blog entry, a news story, a forum post. <em class="parameter"><code>Since</code></em>
:
ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-LANDMARK:CAPS"></a>ATK_ROLE_LANDMARK</p></td>
<td class="enum_member_description">
<p>A region of a web page intended as a
navigational landmark. This is designed to allow Assistive
Technologies to provide quick navigation among key regions within a
document. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-LOG:CAPS"></a>ATK_ROLE_LOG</p></td>
<td class="enum_member_description">
<p>A text widget or container holding log content, such
as chat history and error logs. In this role there is a
relationship between the arrival of new items in the log and the
reading order. The log contains a meaningful sequence and new
information is added only to the end of the log, not at arbitrary
points. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-MARQUEE:CAPS"></a>ATK_ROLE_MARQUEE</p></td>
<td class="enum_member_description">
<p>A container where non-essential information
changes frequently. Common usages of marquee include stock tickers
and ad banners. The primary difference between a marquee and a log
is that logs usually have a meaningful order or sequence of
important content changes. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-MATH:CAPS"></a>ATK_ROLE_MATH</p></td>
<td class="enum_member_description">
<p>A text widget or container that holds a mathematical
expression. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-RATING:CAPS"></a>ATK_ROLE_RATING</p></td>
<td class="enum_member_description">
<p>A widget whose purpose is to display a rating,
such as the number of stars associated with a song in a media
player. Objects of this role should also implement
AtkValue. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-TIMER:CAPS"></a>ATK_ROLE_TIMER</p></td>
<td class="enum_member_description">
<p>An object containing a numerical counter which
indicates an amount of elapsed time from a start point, or the time
remaining until an end point. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DESCRIPTION-LIST:CAPS"></a>ATK_ROLE_DESCRIPTION_LIST</p></td>
<td class="enum_member_description">
<p>An object that represents a list of
term-value groups. A term-value group represents a individual
description and consist of one or more names
(ATK_ROLE_DESCRIPTION_TERM) followed by one or more values
(ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be
more than one group with the same term name. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DESCRIPTION-TERM:CAPS"></a>ATK_ROLE_DESCRIPTION_TERM</p></td>
<td class="enum_member_description">
<p>An object that represents the term, or
name, part of a term-description group in a description
list. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-DESCRIPTION-VALUE:CAPS"></a>ATK_ROLE_DESCRIPTION_VALUE</p></td>
<td class="enum_member_description">
<p>An object that represents the
description, definition or value of a term-description group in a
description list. The values within a group are alternatives,
meaning that you can have several ATK_ROLE_DESCRIPTION_VALUE for a
given ATK_ROLE_DESCRIPTION_TERM. <em class="parameter"><code>Since</code></em>
: ATK-2.12</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-STATIC:CAPS"></a>ATK_ROLE_STATIC</p></td>
<td class="enum_member_description">
<p>A generic non-container object whose purpose is to display a
brief amount of information to the user and whose role is known by the
implementor but lacks semantic value for the user. Examples in which
ATK_ROLE_STATIC is appropriate include the message displayed in a message box
and an image used as an alternative means to display text. ATK_ROLE_STATIC
should not be applied to widgets which are traditionally interactive, objects
which display a significant amount of content, or any object which has an
accessible relation pointing to another object. Implementors should expose the
displayed information through the accessible name of the object. If doing so seems
inappropriate, it may indicate that a different role should be used. For
labels which describe another widget, see ATK_ROLE_LABEL. For text views, see
ATK_ROLE_TEXT. For generic containers, see ATK_ROLE_PANEL. For objects whose
role is not known by the implementor, see ATK_ROLE_UNKNOWN. <em class="parameter"><code>Since</code></em>
: ATK-2.16.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-MATH-FRACTION:CAPS"></a>ATK_ROLE_MATH_FRACTION</p></td>
<td class="enum_member_description">
<p>An object that represents a mathematical fraction.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-MATH-ROOT:CAPS"></a>ATK_ROLE_MATH_ROOT</p></td>
<td class="enum_member_description">
<p>An object that represents a mathematical expression
displayed with a radical. <em class="parameter"><code>Since</code></em>
: ATK-2.16.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-SUBSCRIPT:CAPS"></a>ATK_ROLE_SUBSCRIPT</p></td>
<td class="enum_member_description">
<p>An object that contains text that is displayed as a
subscript. <em class="parameter"><code>Since</code></em>
: ATK-2.16.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-SUPERSCRIPT:CAPS"></a>ATK_ROLE_SUPERSCRIPT</p></td>
<td class="enum_member_description">
<p>An object that contains text that is displayed as a
superscript. <em class="parameter"><code>Since</code></em>
: ATK-2.16.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-ROLE-LAST-DEFINED:CAPS"></a>ATK_ROLE_LAST_DEFINED</p></td>
<td class="enum_member_description">
<p>not a valid role, used for finding end of the enumeration</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtkLayer"></a><h3>enum AtkLayer</h3>
<p>Describes the layer of a component</p>
<p>These enumerated "layer values" are used when determining which UI
rendering layer a component is drawn into, which can help in making
determinations of when components occlude one another.</p>
<div class="refsect3">
<a name="AtkLayer.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="ATK-LAYER-INVALID:CAPS"></a>ATK_LAYER_INVALID</p></td>
<td class="enum_member_description">
<p>The object does not have a layer</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-LAYER-BACKGROUND:CAPS"></a>ATK_LAYER_BACKGROUND</p></td>
<td class="enum_member_description">
<p>This layer is reserved for the desktop background</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-LAYER-CANVAS:CAPS"></a>ATK_LAYER_CANVAS</p></td>
<td class="enum_member_description">
<p>This layer is used for Canvas components</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-LAYER-WIDGET:CAPS"></a>ATK_LAYER_WIDGET</p></td>
<td class="enum_member_description">
<p>This layer is normally used for components</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-LAYER-MDI:CAPS"></a>ATK_LAYER_MDI</p></td>
<td class="enum_member_description">
<p>This layer is used for layered components</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-LAYER-POPUP:CAPS"></a>ATK_LAYER_POPUP</p></td>
<td class="enum_member_description">
<p>This layer is used for popup components, such as menus</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-LAYER-OVERLAY:CAPS"></a>ATK_LAYER_OVERLAY</p></td>
<td class="enum_member_description">
<p>This layer is reserved for future use.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-LAYER-WINDOW:CAPS"></a>ATK_LAYER_WINDOW</p></td>
<td class="enum_member_description">
<p>This layer is used for toplevel windows.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtkImplementor"></a><h3>AtkImplementor</h3>
<pre class="programlisting">typedef struct _AtkImplementor AtkImplementor;</pre>
</div>
<hr>
<div class="refsect2">
<a name="AtkAttribute"></a><h3>struct AtkAttribute</h3>
<pre class="programlisting">struct AtkAttribute {
gchar* name;
gchar* value;
};
</pre>
<p>AtkAttribute is a string name/value pair representing a generic
attribute. This can be used to expose additional information from
an accessible object as a whole (see <a class="link" href="AtkObject.html#atk-object-get-attributes" title="atk_object_get_attributes ()"><code class="function">atk_object_get_attributes()</code></a>)
or an document (see <a class="link" href="AtkDocument.html#atk-document-get-attributes" title="atk_document_get_attributes ()"><code class="function">atk_document_get_attributes()</code></a>). In the case of
text attributes (see <a class="link" href="AtkText.html#atk-text-get-default-attributes" title="atk_text_get_default_attributes ()"><code class="function">atk_text_get_default_attributes()</code></a>),
<a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> enum defines all the possible text attribute
names. You can use <a class="link" href="AtkText.html#atk-text-attribute-get-name" title="atk_text_attribute_get_name ()"><code class="function">atk_text_attribute_get_name()</code></a> to get the string
name from the enum value. See also <a class="link" href="AtkText.html#atk-text-attribute-for-name" title="atk_text_attribute_for_name ()"><code class="function">atk_text_attribute_for_name()</code></a>
and <a class="link" href="AtkText.html#atk-text-attribute-get-value" title="atk_text_attribute_get_value ()"><code class="function">atk_text_attribute_get_value()</code></a> for more information.</p>
<p>A string name/value pair representing a generic attribute.</p>
<div class="refsect3">
<a name="AtkAttribute.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="AtkAttribute.name"></a>name</code></em>;</p></td>
<td class="struct_member_description"><p>The attribute name.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="AtkAttribute.value"></a>value</code></em>;</p></td>
<td class="struct_member_description"><p>the value of the attribute, represented as a string.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtkAttributeSet"></a><h3>AtkAttributeSet</h3>
<pre class="programlisting">typedef GSList AtkAttributeSet;
</pre>
<p>This is a singly-linked list (a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a>) of <a class="link" href="AtkObject.html#AtkAttribute" title="struct AtkAttribute"><span class="type">AtkAttribute</span></a>. It is
used by <a class="link" href="AtkText.html#atk-text-get-run-attributes" title="atk_text_get_run_attributes ()"><code class="function">atk_text_get_run_attributes()</code></a>,
<a class="link" href="AtkText.html#atk-text-get-default-attributes" title="atk_text_get_default_attributes ()"><code class="function">atk_text_get_default_attributes()</code></a>,
<a class="link" href="AtkEditableText.html#atk-editable-text-set-run-attributes" title="atk_editable_text_set_run_attributes ()"><code class="function">atk_editable_text_set_run_attributes()</code></a>,
<a class="link" href="AtkDocument.html#atk-document-get-attributes" title="atk_document_get_attributes ()"><code class="function">atk_document_get_attributes()</code></a> and <a class="link" href="AtkObject.html#atk-object-get-attributes" title="atk_object_get_attributes ()"><code class="function">atk_object_get_attributes()</code></a></p>
</div>
<hr>
<div class="refsect2">
<a name="AtkPropertyValues"></a><h3>AtkPropertyValues</h3>
<pre class="programlisting">typedef struct {
const gchar *property_name;
GValue old_value;
GValue new_value;
} AtkPropertyValues;
</pre>
<p>Note: <em class="parameter"><code>old_value</code></em>
field of <a class="link" href="AtkObject.html#AtkPropertyValues" title="AtkPropertyValues"><span class="type">AtkPropertyValues</span></a> will not contain a
valid value. This is a field defined with the purpose of contain
the previous value of the property, but is not used anymore.</p>
<div class="refsect3">
<a name="AtkPropertyValues.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="AtkPropertyValues.property-name"></a>property_name</code></em>;</p></td>
<td class="struct_member_description"><p>The name of the ATK property which has changed.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> <em class="structfield"><code><a name="AtkPropertyValues.old-value"></a>old_value</code></em>;</p></td>
<td class="struct_member_description"><p>NULL. This field is not used anymore.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> <em class="structfield"><code><a name="AtkPropertyValues.new-value"></a>new_value</code></em>;</p></td>
<td class="struct_member_description"><p>The new value of the named property.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="AtkObject.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="AtkObject--accessible-component-layer"></a><h3>The <code class="literal">“accessible-component-layer”</code> property</h3>
<pre class="programlisting"> “accessible-component-layer” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The accessible layer of this object.</p>
<p>Flags: Read</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-component-mdi-zorder"></a><h3>The <code class="literal">“accessible-component-mdi-zorder”</code> property</h3>
<pre class="programlisting"> “accessible-component-mdi-zorder” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The accessible MDI value of this object.</p>
<p>Flags: Read</p>
<p>Default value: -2147483648</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-description"></a><h3>The <code class="literal">“accessible-description”</code> property</h3>
<pre class="programlisting"> “accessible-description” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Description of an object, formatted for assistive technology access.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-hypertext-nlinks"></a><h3>The <code class="literal">“accessible-hypertext-nlinks”</code> property</h3>
<pre class="programlisting"> “accessible-hypertext-nlinks” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The number of links which the current AtkHypertext has.</p>
<p>Flags: Read</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-name"></a><h3>The <code class="literal">“accessible-name”</code> property</h3>
<pre class="programlisting"> “accessible-name” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Object instance's name formatted for assistive technology access.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-parent"></a><h3>The <code class="literal">“accessible-parent”</code> property</h3>
<pre class="programlisting"> “accessible-parent” <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *</pre>
<p>Parent of the current accessible as returned by atk_object_get_parent().</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-role"></a><h3>The <code class="literal">“accessible-role”</code> property</h3>
<pre class="programlisting"> “accessible-role” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The accessible role of this object.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 0</p>
<p>Default value: 66</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-table-caption"></a><h3>The <code class="literal">“accessible-table-caption”</code> property</h3>
<pre class="programlisting"> “accessible-table-caption” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Table caption.</p>
<div class="warning">
<p><code class="literal">AtkObject:accessible-table-caption</code> is deprecated and should not be used in newly-written code.</p>
<p>Since 1.3. Use table-caption-object instead.</p>
</div>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-table-caption-object"></a><h3>The <code class="literal">“accessible-table-caption-object”</code> property</h3>
<pre class="programlisting"> “accessible-table-caption-object” <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *</pre>
<p>Is used to notify that the table caption has changed.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-table-column-description"></a><h3>The <code class="literal">“accessible-table-column-description”</code> property</h3>
<pre class="programlisting"> “accessible-table-column-description” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Accessible table column description.</p>
<div class="warning">
<p><code class="literal">AtkObject:accessible-table-column-description</code> is deprecated and should not be used in newly-written code.</p>
<p>Since 2.12. Use <a class="link" href="AtkTable.html#atk-table-get-column-description" title="atk_table_get_column_description ()"><code class="function">atk_table_get_column_description()</code></a>
and <a class="link" href="AtkTable.html#atk-table-set-column-description" title="atk_table_set_column_description ()"><code class="function">atk_table_set_column_description()</code></a> instead.</p>
</div>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-table-column-header"></a><h3>The <code class="literal">“accessible-table-column-header”</code> property</h3>
<pre class="programlisting"> “accessible-table-column-header” <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *</pre>
<p>Accessible table column header.</p>
<div class="warning">
<p><code class="literal">AtkObject:accessible-table-column-header</code> is deprecated and should not be used in newly-written code.</p>
<p>Since 2.12. Use <a class="link" href="AtkTable.html#atk-table-get-column-header" title="atk_table_get_column_header ()"><code class="function">atk_table_get_column_header()</code></a> and
<a class="link" href="AtkTable.html#atk-table-set-column-header" title="atk_table_set_column_header ()"><code class="function">atk_table_set_column_header()</code></a> instead.</p>
</div>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-table-row-description"></a><h3>The <code class="literal">“accessible-table-row-description”</code> property</h3>
<pre class="programlisting"> “accessible-table-row-description” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Accessible table row description.</p>
<div class="warning">
<p><code class="literal">AtkObject:accessible-table-row-description</code> is deprecated and should not be used in newly-written code.</p>
<p>Since 2.12. Use <a class="link" href="AtkTable.html#atk-table-get-row-description" title="atk_table_get_row_description ()"><code class="function">atk_table_get_row_description()</code></a> and
<a class="link" href="AtkTable.html#atk-table-set-row-description" title="atk_table_set_row_description ()"><code class="function">atk_table_set_row_description()</code></a> instead.</p>
</div>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-table-row-header"></a><h3>The <code class="literal">“accessible-table-row-header”</code> property</h3>
<pre class="programlisting"> “accessible-table-row-header” <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *</pre>
<p>Accessible table row header.</p>
<div class="warning">
<p><code class="literal">AtkObject:accessible-table-row-header</code> is deprecated and should not be used in newly-written code.</p>
<p>Since 2.12. Use <a class="link" href="AtkTable.html#atk-table-get-row-header" title="atk_table_get_row_header ()"><code class="function">atk_table_get_row_header()</code></a> and
<a class="link" href="AtkTable.html#atk-table-set-row-header" title="atk_table_set_row_header ()"><code class="function">atk_table_set_row_header()</code></a> instead.</p>
</div>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-table-summary"></a><h3>The <code class="literal">“accessible-table-summary”</code> property</h3>
<pre class="programlisting"> “accessible-table-summary” <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *</pre>
<p>Is used to notify that the table summary has changed.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject--accessible-value"></a><h3>The <code class="literal">“accessible-value”</code> property</h3>
<pre class="programlisting"> “accessible-value” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>Numeric value of this object, in case being and AtkValue.</p>
<div class="warning">
<p><code class="literal">AtkObject:accessible-value</code> is deprecated and should not be used in newly-written code.</p>
<p>Since 2.12. Use <a class="link" href="AtkValue.html#atk-value-get-value-and-text" title="atk_value_get_value_and_text ()"><code class="function">atk_value_get_value_and_text()</code></a> to get
the value, and value-changed signal to be notified on their value
changes.</p>
</div>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="AtkObject.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="AtkObject-active-descendant-changed"></a><h3>The <code class="literal">“active-descendant-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *atkobject,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> arg1,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The "active-descendant-changed" signal is emitted by an object
which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus
object in the object changes. For instance, a table will emit the
signal when the cell in the table which has focus changes.</p>
<div class="refsect3">
<a name="AtkObject-active-descendant-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atkobject</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>the newly focused object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject-children-changed"></a><h3>The <code class="literal">“children-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *atkobject,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> arg1,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> arg2,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The signal "children-changed" is emitted when a child is added or
removed form an object. It supports two details: "add" and
"remove"</p>
<div class="refsect3">
<a name="AtkObject-children-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atkobject</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The index of the added or removed child. The value can be
-1. This is used if the value is not known by the implementor
when the child is added/removed or irrelevant.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg2</p></td>
<td class="parameter_description"><p>A gpointer to the child AtkObject which was added or
removed. If the child was removed, it is possible that it is not
available for the implementor. In that case this pointer can be
NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject-focus-event"></a><h3>The <code class="literal">“focus-event”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *atkobject,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> arg1,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The signal "focus-event" is emitted when an object gained or lost
focus.</p>
<div class="warning">
<p><code class="literal">AtkObject::focus-event</code> has been deprecated since version 2.9.4 and should not be used in newly-written code.</p>
<p>Use the <a class="link" href="AtkObject.html#AtkObject-state-change" title="The “state-change” signal"><span class="type">“state-change”</span></a> signal instead.</p>
</div>
<div class="refsect3">
<a name="AtkObject-focus-event.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atkobject</p></td>
<td class="parameter_description"><p>the object which received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>a boolean value which indicates whether the object gained
or lost focus.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject-property-change"></a><h3>The <code class="literal">“property-change”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *atkobject,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> arg1,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The signal "property-change" is emitted when an object's property
value changes. <em class="parameter"><code>arg1</code></em>
contains an <a class="link" href="AtkObject.html#AtkPropertyValues" title="AtkPropertyValues"><span class="type">AtkPropertyValues</span></a> with the name
and the new value of the property whose value has changed. Note
that, as with GObject notify, getting this signal does not
guarantee that the value of the property has actually changed; it
may also be emitted when the setter of the property is called to
reinstate the previous value.</p>
<p>Toolkit implementor note: ATK implementors should use
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-notify"><code class="function">g_object_notify()</code></a> to emit property-changed
notifications. <span class="type">“property-changed”</span> is needed by the
implementation of <a class="link" href="AtkUtil.html#atk-add-global-event-listener" title="atk_add_global_event_listener ()"><code class="function">atk_add_global_event_listener()</code></a> because GObject
notify doesn't support emission hooks.</p>
<div class="refsect3">
<a name="AtkObject-property-change.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atkobject</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html#AtkPropertyValues" title="AtkPropertyValues"><span class="type">AtkPropertyValues</span></a> containing the new value of the
property which changed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject-state-change"></a><h3>The <code class="literal">“state-change”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *atkobject,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg1,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> arg2,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The "state-change" signal is emitted when an object's state
changes. The detail value identifies the state type which has
changed.</p>
<div class="refsect3">
<a name="AtkObject-state-change.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atkobject</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The name of the state which has changed</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg2</p></td>
<td class="parameter_description"><p>A boolean which indicates whether the state has been set or unset.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AtkObject-visible-data-changed"></a><h3>The <code class="literal">“visible-data-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *atkobject,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The "visible-data-changed" signal is emitted when the visual
appearance of the object changed.</p>
<div class="refsect3">
<a name="AtkObject-visible-data-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atkobject</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|