/usr/share/gtk-doc/html/libatspi/libatspi-atspi-constants.html is in at-spi2-doc 2.10.2.is.2.10.1-0ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>atspi-constants</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="libatspi-atspi-types.html" title="atspi-types">
<link rel="next" href="libatspi-atspi-misc.html" title="atspi-misc">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="libatspi-atspi-types.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libatspi Reference Manual</th>
<td><a accesskey="n" href="libatspi-atspi-misc.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libatspi-atspi-constants.synopsis" class="shortcut">Top</a>
|
<a href="#libatspi-atspi-constants.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libatspi-atspi-constants"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-constants.top_of_page"></a>atspi-constants</span></h2>
<p>atspi-constants — Constant definitions needed by multiple interfaces.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libatspi-atspi-constants.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum <a class="link" href="libatspi-atspi-constants.html#AtspiLocaleType" title="enum AtspiLocaleType">AtspiLocaleType</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-LOCALE-TYPE:CAPS" title="ATSPI_LOCALE_TYPE">ATSPI_LOCALE_TYPE</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType">AtspiCoordType</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-COORD-TYPE-COUNT:CAPS" title="ATSPI_COORD_TYPE_COUNT">ATSPI_COORD_TYPE_COUNT</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder">AtspiCollectionSortOrder</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-SORTORDER-COUNT:CAPS" title="ATSPI_SORTORDER_COUNT">ATSPI_SORTORDER_COUNT</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType">AtspiCollectionMatchType</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-MATCHTYPES-COUNT:CAPS" title="ATSPI_MATCHTYPES_COUNT">ATSPI_MATCHTYPES_COUNT</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionTreeTraversalType" title="enum AtspiCollectionTreeTraversalType">AtspiCollectionTreeTraversalType</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-TREETRAVERSALTYPE:CAPS" title="ATSPI_TREETRAVERSALTYPE">ATSPI_TREETRAVERSALTYPE</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer">AtspiComponentLayer</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-COMPONENTLAYER-COUNT:CAPS" title="ATSPI_COMPONENTLAYER_COUNT">ATSPI_COMPONENTLAYER_COUNT</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType">AtspiTextBoundaryType</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-TEXT-BOUNDARY-TYPE-COUNT:CAPS" title="ATSPI_TEXT_BOUNDARY_TYPE_COUNT">ATSPI_TEXT_BOUNDARY_TYPE_COUNT</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType">AtspiTextClipType</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-TEXT-CLIP-TYPE-COUNT:CAPS" title="ATSPI_TEXT_CLIP_TYPE_COUNT">ATSPI_TEXT_CLIP_TYPE_COUNT</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType">AtspiStateType</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-STATETYPE-COUNT:CAPS" title="ATSPI_STATETYPE_COUNT">ATSPI_STATETYPE_COUNT</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiKeyEventType" title="enum AtspiKeyEventType">AtspiKeyEventType</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-KEYEVENTTYPE-COUNT:CAPS" title="ATSPI_KEYEVENTTYPE_COUNT">ATSPI_KEYEVENTTYPE_COUNT</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiEventType" title="enum AtspiEventType">AtspiEventType</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-EVENTTYPE-COUNT:CAPS" title="ATSPI_EVENTTYPE_COUNT">ATSPI_EVENTTYPE_COUNT</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiKeySynthType" title="enum AtspiKeySynthType">AtspiKeySynthType</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-KEYSYNTHTYPE-COUNT:CAPS" title="ATSPI_KEYSYNTHTYPE_COUNT">ATSPI_KEYSYNTHTYPE_COUNT</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiModifierType" title="enum AtspiModifierType">AtspiModifierType</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-MODIFIERTYPE-COUNT:CAPS" title="ATSPI_MODIFIERTYPE_COUNT">ATSPI_MODIFIERTYPE_COUNT</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType">AtspiRelationType</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-RELATIONTYPE-COUNT:CAPS" title="ATSPI_RELATIONTYPE_COUNT">ATSPI_RELATIONTYPE_COUNT</a>
enum <a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole">AtspiRole</a>;
#define <a class="link" href="libatspi-atspi-constants.html#ATSPI-ROLE-COUNT:CAPS" title="ATSPI_ROLE_COUNT">ATSPI_ROLE_COUNT</a>
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-constants.description"></a><h2>Description</h2>
<p>
Constant definitions needed by multiple interfaces.
</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-constants.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiLocaleType"></a><h3>enum AtspiLocaleType</h3>
<pre class="programlisting">typedef enum {
ATSPI_LOCALE_TYPE_MESSAGES,
ATSPI_LOCALE_TYPE_COLLATE,
ATSPI_LOCALE_TYPE_CTYPE,
ATSPI_LOCALE_TYPE_MONETARY,
ATSPI_LOCALE_TYPE_NUMERIC,
ATSPI_LOCALE_TYPE_TIME,
} AtspiLocaleType;
</pre>
<p>
Used by interfaces <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> and <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a>, this
enumeration corresponds to the POSIX 'setlocale' enum values.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-LOCALE-TYPE-MESSAGES:CAPS"></a><span class="term"><code class="literal">ATSPI_LOCALE_TYPE_MESSAGES</code></span></p></td>
<td>For localizable natural-language messages.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LOCALE-TYPE-COLLATE:CAPS"></a><span class="term"><code class="literal">ATSPI_LOCALE_TYPE_COLLATE</code></span></p></td>
<td>For regular expression matching and string
collation.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LOCALE-TYPE-CTYPE:CAPS"></a><span class="term"><code class="literal">ATSPI_LOCALE_TYPE_CTYPE</code></span></p></td>
<td>For regular expression matching, character
classification, conversion, case-sensitive comparison, and wide character
functions.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LOCALE-TYPE-MONETARY:CAPS"></a><span class="term"><code class="literal">ATSPI_LOCALE_TYPE_MONETARY</code></span></p></td>
<td>For monetary formatting.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LOCALE-TYPE-NUMERIC:CAPS"></a><span class="term"><code class="literal">ATSPI_LOCALE_TYPE_NUMERIC</code></span></p></td>
<td>For number formatting (such as the decimal
point and the thousands separator).
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LOCALE-TYPE-TIME:CAPS"></a><span class="term"><code class="literal">ATSPI_LOCALE_TYPE_TIME</code></span></p></td>
<td>For time and date formatting.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-LOCALE-TYPE:CAPS"></a><h3>ATSPI_LOCALE_TYPE</h3>
<pre class="programlisting">#define ATSPI_LOCALE_TYPE _COUNT(5+1)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiCoordType"></a><h3>enum AtspiCoordType</h3>
<pre class="programlisting">typedef enum {
ATSPI_COORD_TYPE_SCREEN,
ATSPI_COORD_TYPE_WINDOW,
} AtspiCoordType;
</pre>
<p>
Enumeration used by <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>, <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a>, and <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> interfaces
to specify whether coordinates are relative to the window or the screen.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-COORD-TYPE-SCREEN:CAPS"></a><span class="term"><code class="literal">ATSPI_COORD_TYPE_SCREEN</code></span></p></td>
<td>Specifies xy coordinates relative to the screen.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-COORD-TYPE-WINDOW:CAPS"></a><span class="term"><code class="literal">ATSPI_COORD_TYPE_WINDOW</code></span></p></td>
<td>Specifies xy coordinates relative to the widget's
top-level window.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-COORD-TYPE-COUNT:CAPS"></a><h3>ATSPI_COORD_TYPE_COUNT</h3>
<pre class="programlisting">#define ATSPI_COORD_TYPE_COUNT (1+1)
</pre>
<p>
One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiCollectionSortOrder"></a><h3>enum AtspiCollectionSortOrder</h3>
<pre class="programlisting">typedef enum {
ATSPI_Collection_SORT_ORDER_INVALID,
ATSPI_Collection_SORT_ORDER_CANONICAL,
ATSPI_Collection_SORT_ORDER_FLOW,
ATSPI_Collection_SORT_ORDER_TAB,
ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL,
ATSPI_Collection_SORT_ORDER_REVERSE_FLOW,
ATSPI_Collection_SORT_ORDER_REVERSE_TAB,
ATSPI_Collection_SORT_ORDER_LAST_DEFINED,
} AtspiCollectionSortOrder;
</pre>
<p>
Enumeration used by interface <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> to specify
the way <span class="type">AtspiAccesible</span> objects should be sorted.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-Collection-SORT-ORDER-INVALID"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_INVALID</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-SORT-ORDER-CANONICAL"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_CANONICAL</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-SORT-ORDER-FLOW"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_FLOW</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-SORT-ORDER-TAB"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_TAB</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-SORT-ORDER-REVERSE-CANONICAL"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-SORT-ORDER-REVERSE-FLOW"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_REVERSE_FLOW</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-SORT-ORDER-REVERSE-TAB"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_REVERSE_TAB</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-SORT-ORDER-LAST-DEFINED"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_LAST_DEFINED</code></span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-SORTORDER-COUNT:CAPS"></a><h3>ATSPI_SORTORDER_COUNT</h3>
<pre class="programlisting">#define ATSPI_SORTORDER_COUNT (7+1)
</pre>
<p>
One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder"><span class="type">AtspiCollectionSortOrder</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiCollectionMatchType"></a><h3>enum AtspiCollectionMatchType</h3>
<pre class="programlisting">typedef enum {
ATSPI_Collection_MATCH_INVALID,
ATSPI_Collection_MATCH_ALL,
ATSPI_Collection_MATCH_ANY,
ATSPI_Collection_MATCH_NONE,
ATSPI_Collection_MATCH_EMPTY,
ATSPI_Collection_MATCH_LAST_DEFINED,
} AtspiCollectionMatchType;
</pre>
<p>
Enumeration used by <a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> to specify
how to interpret <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> objects.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-Collection-MATCH-INVALID"></a><span class="term"><code class="literal">ATSPI_Collection_MATCH_INVALID</code></span></p></td>
<td>Indicates an error condition or
uninitialized value.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-MATCH-ALL"></a><span class="term"><code class="literal">ATSPI_Collection_MATCH_ALL</code></span></p></td>
<td>
<span class="type">TRUE</span> if all of the criteria are met.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-MATCH-ANY"></a><span class="term"><code class="literal">ATSPI_Collection_MATCH_ANY</code></span></p></td>
<td>
<span class="type">TRUE</span> if any of the criteria are met.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-MATCH-NONE"></a><span class="term"><code class="literal">ATSPI_Collection_MATCH_NONE</code></span></p></td>
<td>
<span class="type">TRUE</span> if none of the criteria are met.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-MATCH-EMPTY"></a><span class="term"><code class="literal">ATSPI_Collection_MATCH_EMPTY</code></span></p></td>
<td>Same as <em class="parameter"><code>ATSPI_Collection_MATCH_ALL</code></em> if
the criteria is non-empty; for empty criteria this rule requires returned
value to also have empty set.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-MATCH-LAST-DEFINED"></a><span class="term"><code class="literal">ATSPI_Collection_MATCH_LAST_DEFINED</code></span></p></td>
<td>Used only to determine the end of the
enumeration.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-MATCHTYPES-COUNT:CAPS"></a><h3>ATSPI_MATCHTYPES_COUNT</h3>
<pre class="programlisting">#define ATSPI_MATCHTYPES_COUNT (5+1)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiCollectionTreeTraversalType"></a><h3>enum AtspiCollectionTreeTraversalType</h3>
<pre class="programlisting">typedef enum {
ATSPI_Collection_TREE_RESTRICT_CHILDREN,
ATSPI_Collection_TREE_RESTRICT_SIBLING,
ATSPI_Collection_TREE_INORDER,
ATSPI_Collection_TREE_LAST_DEFINED,
} AtspiCollectionTreeTraversalType;
</pre>
<p>
Enumeration used by interface <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> to specify
restrictions on <span class="type">AtspiAccesible</span> objects to be traversed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-Collection-TREE-RESTRICT-CHILDREN"></a><span class="term"><code class="literal">ATSPI_Collection_TREE_RESTRICT_CHILDREN</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-TREE-RESTRICT-SIBLING"></a><span class="term"><code class="literal">ATSPI_Collection_TREE_RESTRICT_SIBLING</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-TREE-INORDER"></a><span class="term"><code class="literal">ATSPI_Collection_TREE_INORDER</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="ATSPI-Collection-TREE-LAST-DEFINED"></a><span class="term"><code class="literal">ATSPI_Collection_TREE_LAST_DEFINED</code></span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-TREETRAVERSALTYPE:CAPS"></a><h3>ATSPI_TREETRAVERSALTYPE</h3>
<pre class="programlisting">#define ATSPI_TREETRAVERSALTYPE _COUNT(3+1)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiComponentLayer"></a><h3>enum AtspiComponentLayer</h3>
<pre class="programlisting">typedef enum {
ATSPI_LAYER_INVALID,
ATSPI_LAYER_BACKGROUND,
ATSPI_LAYER_CANVAS,
ATSPI_LAYER_WIDGET,
ATSPI_LAYER_MDI,
ATSPI_LAYER_POPUP,
ATSPI_LAYER_OVERLAY,
ATSPI_LAYER_WINDOW,
ATSPI_LAYER_LAST_DEFINED,
} AtspiComponentLayer;
</pre>
<p>
The <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a> of an <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> instance indicates its
relative stacking order with respect to the onscreen visual representation
of the UI. <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a>, in combination with <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> bounds
information, can be used to compute the visibility of all or part of a
component. This is important in programmatic determination of
region-of-interest for magnification, and in
flat screen review models of the screen, as well as
for other uses. Objects residing in two of the <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a>
categories support further z-ordering information, with respect to their
peers in the same layer: namely, <em class="parameter"><code>ATSPI_LAYER_WINDOW</code></em> and
<em class="parameter"><code>ATSPI_LAYER_MDI</code></em>. Relative stacking order for other objects within the
same layer is not available; the recommended heuristic is
first child paints first. In other words, assume that the
first siblings in the child list are subject to being overpainted by later
siblings if their bounds intersect. The order of layers, from bottom to top,
is: <em class="parameter"><code>ATSPI_LAYER_BACKGROUND</code></em>, <em class="parameter"><code>ATSPI_LAYER_WINDOW</code></em>, <em class="parameter"><code>ATSPI_LAYER_MDI</code></em>,
<em class="parameter"><code>ATSPI_LAYER_CANVAS</code></em>, <em class="parameter"><code>ATSPI_LAYER_WIDGET</code></em>, <em class="parameter"><code>ATSPI_LAYER_POPUP</code></em>, and
<em class="parameter"><code>ATSPI_LAYER_OVERLAY</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-LAYER-INVALID:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_INVALID</code></span></p></td>
<td>Indicates an error condition or uninitialized value.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LAYER-BACKGROUND:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_BACKGROUND</code></span></p></td>
<td>The bottom-most layer, over which everything else
is painted. The 'desktop background' is generally in this layer.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LAYER-CANVAS:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_CANVAS</code></span></p></td>
<td>The 'background' layer for most content renderers and
UI <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> containers.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LAYER-WIDGET:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_WIDGET</code></span></p></td>
<td>The layer in which the majority of ordinary
'foreground' widgets reside.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LAYER-MDI:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_MDI</code></span></p></td>
<td>A special layer between <em class="parameter"><code>ATSPI_LAYER_CANVAS</code></em> and
<em class="parameter"><code>ATSPI_LAYER_WIDGET</code></em>, in which the 'pseudo windows' (e.g. the MDI frames)
reside. See <a class="link" href="libatspi-atspi-component.html#atspi-component-get-mdi-z-order" title="atspi_component_get_mdi_z_order ()"><span class="type">atspi_component_get_mdi_z_order</span></a>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LAYER-POPUP:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_POPUP</code></span></p></td>
<td>A layer for popup window content, above
<em class="parameter"><code>ATSPI_LAYER_WIDGET</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LAYER-OVERLAY:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_OVERLAY</code></span></p></td>
<td>The topmost layer.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LAYER-WINDOW:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_WINDOW</code></span></p></td>
<td>The layer in which a toplevel window background usually
resides.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-LAYER-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_LAST_DEFINED</code></span></p></td>
<td>Used only to determine the end of the
enumeration.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-COMPONENTLAYER-COUNT:CAPS"></a><h3>ATSPI_COMPONENTLAYER_COUNT</h3>
<pre class="programlisting">#define ATSPI_COMPONENTLAYER_COUNT (8+1)
</pre>
<p>
One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiTextBoundaryType"></a><h3>enum AtspiTextBoundaryType</h3>
<pre class="programlisting">typedef enum {
ATSPI_TEXT_BOUNDARY_CHAR,
ATSPI_TEXT_BOUNDARY_WORD_START,
ATSPI_TEXT_BOUNDARY_WORD_END,
ATSPI_TEXT_BOUNDARY_SENTENCE_START,
ATSPI_TEXT_BOUNDARY_SENTENCE_END,
ATSPI_TEXT_BOUNDARY_LINE_START,
ATSPI_TEXT_BOUNDARY_LINE_END,
} AtspiTextBoundaryType;
</pre>
<p>
Specifies the boundary conditions determining a run of text as returned from
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-at-offset" title="atspi_text_get_text_at_offset ()"><span class="type">atspi_text_get_text_at_offset</span></a>, <a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-after-offset" title="atspi_text_get_text_after_offset ()"><span class="type">atspi_text_get_text_after_offset</span></a>, and
<a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-before-offset" title="atspi_text_get_text_before_offset ()"><span class="type">atspi_text_get_text_before_offset</span></a>.
</p>
<p>
This enumerationis deprecated since 2.9.90 and should not be used. Use
AtspiTextGranularity with <span class="type">atspi_text_get_string_at_offset</span> instead.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-TEXT-BOUNDARY-CHAR:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_CHAR</code></span></p></td>
<td>An <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> instance is bounded by this
character only. Start and end offsets differ by one, by definition,
for this value.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-TEXT-BOUNDARY-WORD-START:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_WORD_START</code></span></p></td>
<td>Boundary condition is start of a word; i.e.
range is from start of one word to the start of another word.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-TEXT-BOUNDARY-WORD-END:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_WORD_END</code></span></p></td>
<td>Boundary condition is the end of a word; i.e.
range is from the end of one word to the end of another. Some locales
may not distinguish between words and characters or glyphs. In particular,
those locales which use wholly or partially ideographic character sets.
In these cases, characters may be returned in lieu of multi-character
substrings.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-TEXT-BOUNDARY-SENTENCE-START:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_SENTENCE_START</code></span></p></td>
<td>Boundary condition is start of a
sentence, as determined by the application. Some locales or
character sets may not include explicit sentence delimiters, so this
boundary type can not always be honored. Some locales will return lines
of text instead of grammatical sentences.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-TEXT-BOUNDARY-SENTENCE-END:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_SENTENCE_END</code></span></p></td>
<td>Boundary condition is end of a sentence,
as determined by the application, including the sentence-delimiting
character, for instance '.' Some locales or character sets may not
include explicit sentence delimiters, so this boundary type can not
always be honored. Some locales will return lines of text instead of
grammatical sentences.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-TEXT-BOUNDARY-LINE-START:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_LINE_START</code></span></p></td>
<td>Boundary condition is the start of a line;
i.e. range is from start of one line to the start of another. This
generally means that an end-of-line character will appear at the end of
the range.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-TEXT-BOUNDARY-LINE-END:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_LINE_END</code></span></p></td>
<td>Boundary condition is the end of a line; i.e.
range is from start of one line to the start of another. This generally
means that an end-of-line character will be the first character of the
range.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-TEXT-BOUNDARY-TYPE-COUNT:CAPS"></a><h3>ATSPI_TEXT_BOUNDARY_TYPE_COUNT</h3>
<pre class="programlisting">#define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1)
</pre>
<p>
One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiTextClipType"></a><h3>enum AtspiTextClipType</h3>
<pre class="programlisting">typedef enum {
ATSPI_TEXT_CLIP_NONE,
ATSPI_TEXT_CLIP_MIN,
ATSPI_TEXT_CLIP_MAX,
ATSPI_TEXT_CLIP_BOTH,
} AtspiTextClipType;
</pre>
<p>
Enumeration used by interface <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> to indicate
how to treat characters intersecting bounding boxes.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-TEXT-CLIP-NONE:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_CLIP_NONE</code></span></p></td>
<td>No characters/glyphs are omitted.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-TEXT-CLIP-MIN:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_CLIP_MIN</code></span></p></td>
<td>Characters/glyphs clipped by the minimum coordinate
are omitted.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-TEXT-CLIP-MAX:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_CLIP_MAX</code></span></p></td>
<td>Characters/glyphs which intersect the maximum
coordinate are omitted.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-TEXT-CLIP-BOTH:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_CLIP_BOTH</code></span></p></td>
<td>Only glyphs falling entirely within the region
bounded by min and max are retained.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-TEXT-CLIP-TYPE-COUNT:CAPS"></a><h3>ATSPI_TEXT_CLIP_TYPE_COUNT</h3>
<pre class="programlisting">#define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1)
</pre>
<p>
One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiStateType"></a><h3>enum AtspiStateType</h3>
<pre class="programlisting">typedef enum {
ATSPI_STATE_INVALID,
ATSPI_STATE_ACTIVE,
ATSPI_STATE_ARMED,
ATSPI_STATE_BUSY,
ATSPI_STATE_CHECKED,
ATSPI_STATE_COLLAPSED,
ATSPI_STATE_DEFUNCT,
ATSPI_STATE_EDITABLE,
ATSPI_STATE_ENABLED,
ATSPI_STATE_EXPANDABLE,
ATSPI_STATE_EXPANDED,
ATSPI_STATE_FOCUSABLE,
ATSPI_STATE_FOCUSED,
ATSPI_STATE_HAS_TOOLTIP,
ATSPI_STATE_HORIZONTAL,
ATSPI_STATE_ICONIFIED,
ATSPI_STATE_MODAL,
ATSPI_STATE_MULTI_LINE,
ATSPI_STATE_MULTISELECTABLE,
ATSPI_STATE_OPAQUE,
ATSPI_STATE_PRESSED,
ATSPI_STATE_RESIZABLE,
ATSPI_STATE_SELECTABLE,
ATSPI_STATE_SELECTED,
ATSPI_STATE_SENSITIVE,
ATSPI_STATE_SHOWING,
ATSPI_STATE_SINGLE_LINE,
ATSPI_STATE_STALE,
ATSPI_STATE_TRANSIENT,
ATSPI_STATE_VERTICAL,
ATSPI_STATE_VISIBLE,
ATSPI_STATE_MANAGES_DESCENDANTS,
ATSPI_STATE_INDETERMINATE,
ATSPI_STATE_REQUIRED,
ATSPI_STATE_TRUNCATED,
ATSPI_STATE_ANIMATED,
ATSPI_STATE_INVALID_ENTRY,
ATSPI_STATE_SUPPORTS_AUTOCOMPLETION,
ATSPI_STATE_SELECTABLE_TEXT,
ATSPI_STATE_IS_DEFAULT,
ATSPI_STATE_VISITED,
ATSPI_STATE_LAST_DEFINED,
} AtspiStateType;
</pre>
<p>
Enumeration used by various interfaces indicating every possible state
an <span class="type">AtspiAccesible</span> object can assume.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-STATE-INVALID:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_INVALID</code></span></p></td>
<td>Indicates an invalid state - probably an error
condition.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-ACTIVE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_ACTIVE</code></span></p></td>
<td>Indicates a window is currently the active window, or
is an active subelement within a container or table.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-ARMED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_ARMED</code></span></p></td>
<td>Indicates that the object is armed.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-BUSY:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_BUSY</code></span></p></td>
<td>Indicates the current object is busy, i.e. onscreen
representation is in the process of changing, or the object is
temporarily unavailable for interaction due to activity already in progress.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-CHECKED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_CHECKED</code></span></p></td>
<td>Indicates this object is currently checked.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-COLLAPSED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_COLLAPSED</code></span></p></td>
<td>Indicates this object is collapsed.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-DEFUNCT:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_DEFUNCT</code></span></p></td>
<td>Indicates that this object no longer has a valid
backing widget (for instance, if its peer object has been destroyed).
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-EDITABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_EDITABLE</code></span></p></td>
<td>Indicates the user can change the contents of this
object.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-ENABLED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_ENABLED</code></span></p></td>
<td>Indicates that this object is enabled, i.e. that it
currently reflects some application state. Objects that are "greyed out"
may lack this state, and may lack the <em class="parameter"><code>ATSPI_STATE_SENSITIVE</code></em> if direct
user interaction cannot cause them to acquire <em class="parameter"><code>ATSPI_STATE_ENABLED</code></em>.
See <em class="parameter"><code>ATSPI_STATE_SENSITIVE</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-EXPANDABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_EXPANDABLE</code></span></p></td>
<td>Indicates this object allows progressive
disclosure of its children.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-EXPANDED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_EXPANDED</code></span></p></td>
<td>Indicates this object is expanded.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-FOCUSABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_FOCUSABLE</code></span></p></td>
<td>Indicates this object can accept keyboard focus,
which means all events resulting from typing on the keyboard will
normally be passed to it when it has focus.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-FOCUSED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_FOCUSED</code></span></p></td>
<td>Indicates this object currently has the keyboard
focus.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-HAS-TOOLTIP:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_HAS_TOOLTIP</code></span></p></td>
<td>Indicates that the object has an associated
tooltip.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-HORIZONTAL:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_HORIZONTAL</code></span></p></td>
<td>Indicates the orientation of this object is
horizontal.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-ICONIFIED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_ICONIFIED</code></span></p></td>
<td>Indicates this object is minimized and is
represented only by an icon.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-MODAL:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_MODAL</code></span></p></td>
<td>Indicates something must be done with this object
before the user can interact with an object in a different window.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-MULTI-LINE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_MULTI_LINE</code></span></p></td>
<td>Indicates this (text) object can contain multiple
lines of text.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-MULTISELECTABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_MULTISELECTABLE</code></span></p></td>
<td>Indicates this object allows more than one of
its children to be selected at the same time, or in the case of text
objects, that the object supports non-contiguous text selections.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-OPAQUE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_OPAQUE</code></span></p></td>
<td>Indicates this object paints every pixel within its
rectangular region. It also indicates an alpha value of unity, if it
supports alpha blending.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-PRESSED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_PRESSED</code></span></p></td>
<td>Indicates this object is currently pressed.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-RESIZABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_RESIZABLE</code></span></p></td>
<td>Indicates the size of this object's size is not
fixed.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-SELECTABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SELECTABLE</code></span></p></td>
<td>Indicates this object is the child of an object
that allows its children to be selected and that this child is one of
those children that can be selected.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-SELECTED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SELECTED</code></span></p></td>
<td>Indicates this object is the child of an object that
allows its children to be selected and that this child is one of those
children that has been selected.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-SENSITIVE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SENSITIVE</code></span></p></td>
<td>Indicates this object is sensitive, e.g. to user
interaction. <em class="parameter"><code>ATSPI_STATE_SENSITIVE</code></em> usually accompanies.
<em class="parameter"><code>ATSPI_STATE_ENABLED</code></em> for user-actionable controls, but may be found in the
absence of <em class="parameter"><code>ATSPI_STATE_ENABLED</code></em> if the current visible state of the control
is "disconnected" from the application state. In such cases, direct user
interaction can often result in the object gaining <em class="parameter"><code>ATSPI_STATE_SENSITIVE</code></em>,
for instance if a user makes an explicit selection using an object whose
current state is ambiguous or undefined. See <em class="parameter"><code>ATSPI_STATE_ENABLED</code></em>,
<em class="parameter"><code>ATSPI_STATE_INDETERMINATE</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-SHOWING:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SHOWING</code></span></p></td>
<td>Indicates this object, the object's parent, the
object's parent's parent, and so on, are all 'shown' to the end-user,
i.e. subject to "exposure" if blocking or obscuring objects do not
interpose between this object and the top of the window stack.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-SINGLE-LINE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SINGLE_LINE</code></span></p></td>
<td>Indicates this (text) object can contain only a
single line of text.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-STALE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_STALE</code></span></p></td>
<td>Indicates that the information returned for this object
may no longer be synchronized with the application state. This can occur
if the object has <em class="parameter"><code>ATSPI_STATE_TRANSIENT</code></em>, and can also occur towards the
end of the object peer's lifecycle.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-TRANSIENT:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_TRANSIENT</code></span></p></td>
<td>Indicates this object is transient.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-VERTICAL:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_VERTICAL</code></span></p></td>
<td>Indicates the orientation of this object is vertical;
for example this state may appear on such objects as scrollbars, text
objects (with vertical text flow), separators, etc.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-VISIBLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_VISIBLE</code></span></p></td>
<td>Indicates this object is visible, e.g. has been
explicitly marked for exposure to the user. <em class="parameter"><code>ATSPI_STATE_VISIBLE</code></em> is no
guarantee that the object is actually unobscured on the screen, only that
it is 'potentially' visible, barring obstruction, being scrolled or clipped
out of the field of view, or having an ancestor container that has not yet
made visible. A widget is potentially onscreen if it has both
<em class="parameter"><code>ATSPI_STATE_VISIBLE</code></em> and <em class="parameter"><code>ATSPI_STATE_SHOWING</code></em>. The absence of
<em class="parameter"><code>ATSPI_STATE_VISIBLE</code></em> and <em class="parameter"><code>ATSPI_STATE_SHOWING</code></em> is
semantically equivalent to saying that an object is 'hidden'.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-MANAGES-DESCENDANTS:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_MANAGES_DESCENDANTS</code></span></p></td>
<td>Indicates that "active-descendant-changed"
event is sent when children become 'active' (i.e. are selected or
navigated to onscreen). Used to prevent need to enumerate all children
in very large containers, like tables. The presence of
<em class="parameter"><code>ATSPI_STATE_MANAGES_DESCENDANTS</code></em> is an indication to the client that the
children should not, and need not, be enumerated by the client.
Objects implementing this state are expected to provide relevant state
notifications to listening clients, for instance notifications of
visibility changes and activation of their contained child objects, without
the client having previously requested references to those children.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-INDETERMINATE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_INDETERMINATE</code></span></p></td>
<td>Indicates that a check box or other boolean
indicator is in a state other than checked or not checked. This
usually means that the boolean value reflected or controlled by the
object does not apply consistently to the entire current context.
For example, a checkbox for the "Bold" attribute of text may have
<em class="parameter"><code>ATSPI_STATE_INDETERMINATE</code></em> if the currently selected text contains a mixture
of weight attributes. In many cases interacting with a
<em class="parameter"><code>ATSPI_STATE_INDETERMINATE</code></em> object will cause the context's corresponding
boolean attribute to be homogenized, whereupon the object will lose
<em class="parameter"><code>ATSPI_STATE_INDETERMINATE</code></em> and a corresponding state-changed event will be
fired.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-REQUIRED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_REQUIRED</code></span></p></td>
<td>Indicates that user interaction with this object is
'required' from the user, for instance before completing the
processing of a form.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-TRUNCATED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_TRUNCATED</code></span></p></td>
<td>Indicates that an object's onscreen content
is truncated, e.g. a text value in a spreadsheet cell.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-ANIMATED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_ANIMATED</code></span></p></td>
<td>Indicates this object's visual representation is
dynamic, not static. This state may be applied to an object during an
animated 'effect' and be removed from the object once its visual
representation becomes static. Some applications, notably content viewers,
may not be able to detect all kinds of animated content. Therefore the
absence of this state should not be taken as
definitive evidence that the object's visual representation is
static; this state is advisory.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-INVALID-ENTRY:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_INVALID_ENTRY</code></span></p></td>
<td>This object has indicated an error condition
due to failure of input validation. For instance, a form control may
acquire this state in response to invalid or malformed user input.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-SUPPORTS-AUTOCOMPLETION:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SUPPORTS_AUTOCOMPLETION</code></span></p></td>
<td>This state indicates that the object
in question implements some form of typeahead or
pre-selection behavior whereby entering the first character of one or more
sub-elements causes those elements to scroll into view or become
selected. Subsequent character input may narrow the selection further as
long as one or more sub-elements match the string. This state is normally
only useful and encountered on objects that implement <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>.
In some cases the typeahead behavior may result in full or partial
completion of the data in the input field, in which case
these input events may trigger text-changed events from the source.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-SELECTABLE-TEXT:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SELECTABLE_TEXT</code></span></p></td>
<td>This state indicates that the object in
question supports text selection. It should only be exposed on objects
which implement the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> interface, in order to distinguish this state
from <em class="parameter"><code>ATSPI_STATE_SELECTABLE</code></em>, which infers that the object in question is a
selectable child of an object which implements <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>. While
similar, text selection and subelement selection are distinct operations.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-IS-DEFAULT:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_IS_DEFAULT</code></span></p></td>
<td>This state indicates that the object in question is
the 'default' interaction object in a dialog, i.e. the one that gets
activated if the user presses "Enter" when the dialog is initially
posted.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-VISITED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_VISITED</code></span></p></td>
<td>This state indicates that the object (typically a
hyperlink) has already been activated or invoked, with the result that
some backing data has been downloaded or rendered.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-STATE-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_LAST_DEFINED</code></span></p></td>
<td>This value of the enumeration should not be used
as a parameter, it indicates the number of items in the <a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a>
enumeration.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-STATETYPE-COUNT:CAPS"></a><h3>ATSPI_STATETYPE_COUNT</h3>
<pre class="programlisting">#define ATSPI_STATETYPE_COUNT (41+1)
</pre>
<p>
One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiKeyEventType"></a><h3>enum AtspiKeyEventType</h3>
<pre class="programlisting">typedef enum {
ATSPI_KEY_PRESSED,
ATSPI_KEY_RELEASED,
} AtspiKeyEventType;
</pre>
<p>
Deprecated. Should not be used.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-KEY-PRESSED:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_PRESSED</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="ATSPI-KEY-RELEASED:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_RELEASED</code></span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-KEYEVENTTYPE-COUNT:CAPS"></a><h3>ATSPI_KEYEVENTTYPE_COUNT</h3>
<pre class="programlisting">#define ATSPI_KEYEVENTTYPE_COUNT (1+1)
</pre>
<p>
One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiKeyEventType" title="enum AtspiKeyEventType"><span class="type">AtspiKeyEventType</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiEventType"></a><h3>enum AtspiEventType</h3>
<pre class="programlisting">typedef enum {
ATSPI_KEY_PRESSED_EVENT,
ATSPI_KEY_RELEASED_EVENT,
ATSPI_BUTTON_PRESSED_EVENT,
ATSPI_BUTTON_RELEASED_EVENT,
} AtspiEventType;
</pre>
<p>
Enumeration used to specify the event types of interest to an
<a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a>, or
to identify the type of an event for which notification has been sent.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-KEY-PRESSED-EVENT:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_PRESSED_EVENT</code></span></p></td>
<td>Indicates that a key on a keyboard device was
pressed.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-KEY-RELEASED-EVENT:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_RELEASED_EVENT</code></span></p></td>
<td>Indicates that a key on a keyboard device was
released.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-BUTTON-PRESSED-EVENT:CAPS"></a><span class="term"><code class="literal">ATSPI_BUTTON_PRESSED_EVENT</code></span></p></td>
<td>Indicates that a button on a non-keyboard
human interface device (HID) was pressed.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-BUTTON-RELEASED-EVENT:CAPS"></a><span class="term"><code class="literal">ATSPI_BUTTON_RELEASED_EVENT</code></span></p></td>
<td>Indicates that a button on a non-keyboard
human interface device (HID) was released.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-EVENTTYPE-COUNT:CAPS"></a><h3>ATSPI_EVENTTYPE_COUNT</h3>
<pre class="programlisting">#define ATSPI_EVENTTYPE_COUNT (3+1)
</pre>
<p>
One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiEventType" title="enum AtspiEventType"><span class="type">AtspiEventType</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiKeySynthType"></a><h3>enum AtspiKeySynthType</h3>
<pre class="programlisting">typedef enum {
ATSPI_KEY_PRESS,
ATSPI_KEY_RELEASE,
ATSPI_KEY_PRESSRELEASE,
ATSPI_KEY_SYM,
ATSPI_KEY_STRING,
} AtspiKeySynthType;
</pre>
<p>
Enumeration used when synthesizing keyboard input via
<a class="link" href="libatspi-atspi-registry.html#atspi-generate-keyboard-event" title="atspi_generate_keyboard_event ()"><span class="type">atspi_generate_keyboard_event</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-KEY-PRESS:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_PRESS</code></span></p></td>
<td>Emulates the pressing of a hardware keyboard key.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-KEY-RELEASE:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_RELEASE</code></span></p></td>
<td>Emulates the release of a hardware keyboard key.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-KEY-PRESSRELEASE:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_PRESSRELEASE</code></span></p></td>
<td>Emulates the pressing and immediate releasing
of a hardware keyboard key.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-KEY-SYM:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_SYM</code></span></p></td>
<td>A symbolic key event is generated, without specifying a
hardware key. Note: if the keysym is not present in the current keyboard
map, the <span class="type">AtspiDeviceEventController</span> instance has a limited ability to
generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent
calls using out-of-keymap keysyms will vary from system to system, and on
the number of different out-of-keymap keysyms being generated in quick
succession.
In practice this is rarely significant, since the keysyms of interest to
AT clients and keyboard emulators are usually part of the current keymap,
i.e., present on the system keyboard for the current locale (even if a
physical hardware keyboard is not connected).
</td>
</tr>
<tr>
<td><p><a name="ATSPI-KEY-STRING:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_STRING</code></span></p></td>
<td>A string is converted to its equivalent keyboard events
and emitted. If the string consists of complex characters or composed
characters which are not in the current keymap, string emission is
subject to the out-of-keymap limitations described for
<em class="parameter"><code>ATSPI_KEY_SYM</code></em>. In practice this limitation primarily effects
Chinese and Japanese locales.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-KEYSYNTHTYPE-COUNT:CAPS"></a><h3>ATSPI_KEYSYNTHTYPE_COUNT</h3>
<pre class="programlisting">#define ATSPI_KEYSYNTHTYPE_COUNT (4+1)
</pre>
<p>
One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiKeySynthType" title="enum AtspiKeySynthType"><span class="type">AtspiKeySynthType</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiModifierType"></a><h3>enum AtspiModifierType</h3>
<pre class="programlisting">typedef enum {
ATSPI_MODIFIER_SHIFT,
ATSPI_MODIFIER_SHIFTLOCK,
ATSPI_MODIFIER_CONTROL,
ATSPI_MODIFIER_ALT,
ATSPI_MODIFIER_META,
ATSPI_MODIFIER_META2,
ATSPI_MODIFIER_META3,
ATSPI_MODIFIER_NUMLOCK = 14,
} AtspiModifierType;
</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-MODIFIER-SHIFT:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_SHIFT</code></span></p></td>
<td>The left or right 'Shift' key.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-MODIFIER-SHIFTLOCK:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_SHIFTLOCK</code></span></p></td>
<td>The ShiftLock or CapsLock key.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-MODIFIER-CONTROL:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_CONTROL</code></span></p></td>
<td>'Control'/'Ctrl'.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-MODIFIER-ALT:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_ALT</code></span></p></td>
<td>The Alt key (as opposed to AltGr).
</td>
</tr>
<tr>
<td><p><a name="ATSPI-MODIFIER-META:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_META</code></span></p></td>
<td>Depending on the platform, this may map to 'Window',
'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will
map to one of META, META2, META3. On X Windows platforms these META
values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an
event having <em class="parameter"><code>ATSPI_MODIFIER_META2</code></em> means that the 'Mod2Mask' bit
is set in the corresponding XEvent.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-MODIFIER-META2:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_META2</code></span></p></td>
<td>See <em class="parameter"><code>ATSPI_MODIFIER_META</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-MODIFIER-META3:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_META3</code></span></p></td>
<td>See <em class="parameter"><code>ATSPI_MODIFIER_META</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-MODIFIER-NUMLOCK:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_NUMLOCK</code></span></p></td>
<td>A symbolic meta key name that is mapped by AT-SPI
to the appropriate META value, for the convenience of the client.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-MODIFIERTYPE-COUNT:CAPS"></a><h3>ATSPI_MODIFIERTYPE_COUNT</h3>
<pre class="programlisting">#define ATSPI_MODIFIERTYPE_COUNT (7+1)
</pre>
<p>
One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiModifierType" title="enum AtspiModifierType"><span class="type">AtspiModifierType</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiRelationType"></a><h3>enum AtspiRelationType</h3>
<pre class="programlisting">typedef enum {
ATSPI_RELATION_NULL,
ATSPI_RELATION_LABEL_FOR,
ATSPI_RELATION_LABELLED_BY,
ATSPI_RELATION_CONTROLLER_FOR,
ATSPI_RELATION_CONTROLLED_BY,
ATSPI_RELATION_MEMBER_OF,
ATSPI_RELATION_TOOLTIP_FOR,
ATSPI_RELATION_NODE_CHILD_OF,
ATSPI_RELATION_NODE_PARENT_OF,
ATSPI_RELATION_EXTENDED,
ATSPI_RELATION_FLOWS_TO,
ATSPI_RELATION_FLOWS_FROM,
ATSPI_RELATION_SUBWINDOW_OF,
ATSPI_RELATION_EMBEDS,
ATSPI_RELATION_EMBEDDED_BY,
ATSPI_RELATION_POPUP_FOR,
ATSPI_RELATION_PARENT_WINDOW_OF,
ATSPI_RELATION_DESCRIPTION_FOR,
ATSPI_RELATION_DESCRIBED_BY,
ATSPI_RELATION_LAST_DEFINED,
} AtspiRelationType;
</pre>
<p>
<a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="type">AtspiRelationType</span></a> specifies a relationship between objects
(possibly one-to-many
or many-to-one) outside of the normal parent/child hierarchical
relationship. It allows better semantic identification of how objects
are associated with one another. For instance the
<em class="parameter"><code>ATSPI_RELATION_LABELLED_BY</code></em>
relationship may be used to identify labelling information that should
accompany the accessible name property when presenting an object's content or
identity to the end user. Similarly,
<em class="parameter"><code>ATSPI_RELATION_CONTROLLER_FOR</code></em> can be used
to further specify the context in which a valuator is useful, and/or the
other UI components which are directly effected by user interactions with
the valuator. Common examples include association of scrollbars with the
viewport or panel which they control.
</p>
<p>
Enumeration used to specify
the type of relation encapsulated in an <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-RELATION-NULL:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_NULL</code></span></p></td>
<td>Not a meaningful relationship; clients should not
normally encounter this <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="type">AtspiRelationType</span></a> value.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-LABEL-FOR:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_LABEL_FOR</code></span></p></td>
<td>Object is a label for one or more other objects.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-LABELLED-BY:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_LABELLED_BY</code></span></p></td>
<td>Object is labelled by one or more other
objects.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-CONTROLLER-FOR:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_CONTROLLER_FOR</code></span></p></td>
<td>Object is an interactive object which
modifies the state, onscreen location, or other attributes of one or more
target objects.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-CONTROLLED-BY:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_CONTROLLED_BY</code></span></p></td>
<td>Object state, position, etc. is
modified/controlled by user interaction with one or more other objects.
For instance a viewport or scroll pane may be <em class="parameter"><code>ATSPI_RELATION_CONTROLLED_BY</code></em>
scrollbars.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-MEMBER-OF:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_MEMBER_OF</code></span></p></td>
<td>Object has a grouping relationship (e.g. 'same
group as') to one or more other objects.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-TOOLTIP-FOR:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_TOOLTIP_FOR</code></span></p></td>
<td>Object is a tooltip associated with another
object.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-NODE-CHILD-OF:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_NODE_CHILD_OF</code></span></p></td>
<td>Object is a child of the target.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-NODE-PARENT-OF:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_NODE_PARENT_OF</code></span></p></td>
<td>Object is a parent of the target.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-EXTENDED:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_EXTENDED</code></span></p></td>
<td>Used to indicate that a relationship exists, but
its type is not specified in the enumeration.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-FLOWS-TO:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_FLOWS_TO</code></span></p></td>
<td>Object renders content which flows logically to
another object. For instance, text in a paragraph may flow to another
object which is not the 'next sibling' in the accessibility hierarchy.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-FLOWS-FROM:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_FLOWS_FROM</code></span></p></td>
<td>Reciprocal of <em class="parameter"><code>ATSPI_RELATION_FLOWS_TO</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-SUBWINDOW-OF:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_SUBWINDOW_OF</code></span></p></td>
<td>Object is visually and semantically considered
a subwindow of another object, even though it is not the object's child.
Useful when dealing with embedded applications and other cases where the
widget hierarchy does not map cleanly to the onscreen presentation.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-EMBEDS:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_EMBEDS</code></span></p></td>
<td>Similar to <em class="parameter"><code>ATSPI_RELATION_SUBWINDOW_OF</code></em>, but
specifically used for cross-process embedding.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-EMBEDDED-BY:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_EMBEDDED_BY</code></span></p></td>
<td>Reciprocal of <em class="parameter"><code>ATSPI_RELATION_EMBEDS</code></em>. Used to
denote content rendered by embedded renderers that live in a separate process
space from the embedding context.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-POPUP-FOR:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_POPUP_FOR</code></span></p></td>
<td>Denotes that the object is a transient window or
frame associated with another onscreen object. Similar to <em class="parameter"><code>ATSPI_TOOLTIP_FOR</code></em>,
but more general. Useful for windows which are technically toplevels
but which, for one or more reasons, do not explicitly cause their
associated window to lose 'window focus'. Creation of an <em class="parameter"><code>ATSPI_ROLE_WINDOW</code></em>
object with the <em class="parameter"><code>ATSPI_RELATION_POPUP_FOR</code></em> relation usually requires
some presentation action on the part
of assistive technology clients, even though the previous toplevel
<em class="parameter"><code>ATSPI_ROLE_FRAME</code></em> object may still be the active window.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-PARENT-WINDOW-OF:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_PARENT_WINDOW_OF</code></span></p></td>
<td>This is the reciprocal relation to
<em class="parameter"><code>ATSPI_RELATION_POPUP_FOR</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-DESCRIPTION-FOR:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_DESCRIPTION_FOR</code></span></p></td>
<td>Indicates that an object provides
descriptive information about another object; more verbose than
<em class="parameter"><code>ATSPI_RELATION_LABEL_FOR</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-DESCRIBED-BY:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_DESCRIBED_BY</code></span></p></td>
<td>Indicates that another object provides
descriptive information about this object; more verbose than
<em class="parameter"><code>ATSPI_RELATION_LABELLED_BY</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-RELATION-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_LAST_DEFINED</code></span></p></td>
<td>Do not use as a parameter value, used to
determine the size of the enumeration.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-RELATIONTYPE-COUNT:CAPS"></a><h3>ATSPI_RELATIONTYPE_COUNT</h3>
<pre class="programlisting">#define ATSPI_RELATIONTYPE_COUNT (19+1)
</pre>
<p>
One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="type">AtspiRelationType</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiRole"></a><h3>enum AtspiRole</h3>
<pre class="programlisting">typedef enum {
ATSPI_ROLE_INVALID,
ATSPI_ROLE_ACCELERATOR_LABEL,
ATSPI_ROLE_ALERT,
ATSPI_ROLE_ANIMATION,
ATSPI_ROLE_ARROW,
ATSPI_ROLE_CALENDAR,
ATSPI_ROLE_CANVAS,
ATSPI_ROLE_CHECK_BOX,
ATSPI_ROLE_CHECK_MENU_ITEM,
ATSPI_ROLE_COLOR_CHOOSER,
ATSPI_ROLE_COLUMN_HEADER,
ATSPI_ROLE_COMBO_BOX,
ATSPI_ROLE_DATE_EDITOR,
ATSPI_ROLE_DESKTOP_ICON,
ATSPI_ROLE_DESKTOP_FRAME,
ATSPI_ROLE_DIAL,
ATSPI_ROLE_DIALOG,
ATSPI_ROLE_DIRECTORY_PANE,
ATSPI_ROLE_DRAWING_AREA,
ATSPI_ROLE_FILE_CHOOSER,
ATSPI_ROLE_FILLER,
ATSPI_ROLE_FOCUS_TRAVERSABLE,
ATSPI_ROLE_FONT_CHOOSER,
ATSPI_ROLE_FRAME,
ATSPI_ROLE_GLASS_PANE,
ATSPI_ROLE_HTML_CONTAINER,
ATSPI_ROLE_ICON,
ATSPI_ROLE_IMAGE,
ATSPI_ROLE_INTERNAL_FRAME,
ATSPI_ROLE_LABEL,
ATSPI_ROLE_LAYERED_PANE,
ATSPI_ROLE_LIST,
ATSPI_ROLE_LIST_ITEM,
ATSPI_ROLE_MENU,
ATSPI_ROLE_MENU_BAR,
ATSPI_ROLE_MENU_ITEM,
ATSPI_ROLE_OPTION_PANE,
ATSPI_ROLE_PAGE_TAB,
ATSPI_ROLE_PAGE_TAB_LIST,
ATSPI_ROLE_PANEL,
ATSPI_ROLE_PASSWORD_TEXT,
ATSPI_ROLE_POPUP_MENU,
ATSPI_ROLE_PROGRESS_BAR,
ATSPI_ROLE_PUSH_BUTTON,
ATSPI_ROLE_RADIO_BUTTON,
ATSPI_ROLE_RADIO_MENU_ITEM,
ATSPI_ROLE_ROOT_PANE,
ATSPI_ROLE_ROW_HEADER,
ATSPI_ROLE_SCROLL_BAR,
ATSPI_ROLE_SCROLL_PANE,
ATSPI_ROLE_SEPARATOR,
ATSPI_ROLE_SLIDER,
ATSPI_ROLE_SPIN_BUTTON,
ATSPI_ROLE_SPLIT_PANE,
ATSPI_ROLE_STATUS_BAR,
ATSPI_ROLE_TABLE,
ATSPI_ROLE_TABLE_CELL,
ATSPI_ROLE_TABLE_COLUMN_HEADER,
ATSPI_ROLE_TABLE_ROW_HEADER,
ATSPI_ROLE_TEAROFF_MENU_ITEM,
ATSPI_ROLE_TERMINAL,
ATSPI_ROLE_TEXT,
ATSPI_ROLE_TOGGLE_BUTTON,
ATSPI_ROLE_TOOL_BAR,
ATSPI_ROLE_TOOL_TIP,
ATSPI_ROLE_TREE,
ATSPI_ROLE_TREE_TABLE,
ATSPI_ROLE_UNKNOWN,
ATSPI_ROLE_VIEWPORT,
ATSPI_ROLE_WINDOW,
ATSPI_ROLE_EXTENDED,
ATSPI_ROLE_HEADER,
ATSPI_ROLE_FOOTER,
ATSPI_ROLE_PARAGRAPH,
ATSPI_ROLE_RULER,
ATSPI_ROLE_APPLICATION,
ATSPI_ROLE_AUTOCOMPLETE,
ATSPI_ROLE_EDITBAR,
ATSPI_ROLE_EMBEDDED,
ATSPI_ROLE_ENTRY,
ATSPI_ROLE_CHART,
ATSPI_ROLE_CAPTION,
ATSPI_ROLE_DOCUMENT_FRAME,
ATSPI_ROLE_HEADING,
ATSPI_ROLE_PAGE,
ATSPI_ROLE_SECTION,
ATSPI_ROLE_REDUNDANT_OBJECT,
ATSPI_ROLE_FORM,
ATSPI_ROLE_LINK,
ATSPI_ROLE_INPUT_METHOD_WINDOW,
ATSPI_ROLE_TABLE_ROW,
ATSPI_ROLE_TREE_ITEM,
ATSPI_ROLE_DOCUMENT_SPREADSHEET,
ATSPI_ROLE_DOCUMENT_PRESENTATION,
ATSPI_ROLE_DOCUMENT_TEXT,
ATSPI_ROLE_DOCUMENT_WEB,
ATSPI_ROLE_DOCUMENT_EMAIL,
ATSPI_ROLE_COMMENT,
ATSPI_ROLE_LIST_BOX,
ATSPI_ROLE_GROUPING,
ATSPI_ROLE_IMAGE_MAP,
ATSPI_ROLE_NOTIFICATION,
ATSPI_ROLE_INFO_BAR,
ATSPI_ROLE_LEVEL_BAR,
ATSPI_ROLE_LAST_DEFINED,
} AtspiRole;
</pre>
<p>
Enumeration used by interface <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> to specify the role
of an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATSPI-ROLE-INVALID:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_INVALID</code></span></p></td>
<td>A role indicating an error condition, such as
uninitialized Role data.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-ACCELERATOR-LABEL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ACCELERATOR_LABEL</code></span></p></td>
<td>Object is a label indicating the keyboard
accelerators for the parent.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-ALERT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ALERT</code></span></p></td>
<td>Object is used to alert the user about something.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-ANIMATION:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ANIMATION</code></span></p></td>
<td>Object contains a dynamic or moving image of some
kind.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-ARROW:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ARROW</code></span></p></td>
<td>Object is a 2d directional indicator.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-CALENDAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_CALENDAR</code></span></p></td>
<td>Object contains one or more dates, usually arranged
into a 2d list.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-CANVAS:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_CANVAS</code></span></p></td>
<td>Object that can be drawn into and is used to trap
events.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-CHECK-BOX:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_CHECK_BOX</code></span></p></td>
<td>A choice that can be checked or unchecked and
provides a separate indicator for the current state.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-CHECK-MENU-ITEM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_CHECK_MENU_ITEM</code></span></p></td>
<td>A menu item that behaves like a check box. See
<em class="parameter"><code>ATSPI_ROLE_CHECK_BOX</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-COLOR-CHOOSER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_COLOR_CHOOSER</code></span></p></td>
<td>A specialized dialog that lets the user choose a
color.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-COLUMN-HEADER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_COLUMN_HEADER</code></span></p></td>
<td>The header for a column of data.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-COMBO-BOX:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_COMBO_BOX</code></span></p></td>
<td>A list of choices the user can select from.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DATE-EDITOR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DATE_EDITOR</code></span></p></td>
<td>An object which allows entry of a date.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DESKTOP-ICON:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DESKTOP_ICON</code></span></p></td>
<td>An inconifed internal frame within a DESKTOP_PANE.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DESKTOP-FRAME:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DESKTOP_FRAME</code></span></p></td>
<td>A pane that supports internal frames and
iconified versions of those internal frames.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DIAL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DIAL</code></span></p></td>
<td>An object that allows a value to be changed via rotating a
visual element, or which displays a value via such a rotating element.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DIALOG:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DIALOG</code></span></p></td>
<td>A top level window with title bar and a border.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DIRECTORY-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DIRECTORY_PANE</code></span></p></td>
<td>A pane that allows the user to navigate through
and select the contents of a directory.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DRAWING-AREA:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DRAWING_AREA</code></span></p></td>
<td>A specialized dialog that displays the files in
the directory and lets the user select a file, browse a different
directory, or specify a filename.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-FILE-CHOOSER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FILE_CHOOSER</code></span></p></td>
<td>An object used for drawing custom user interface
elements.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-FILLER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FILLER</code></span></p></td>
<td>A object that fills up space in a user interface.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-FOCUS-TRAVERSABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FOCUS_TRAVERSABLE</code></span></p></td>
<td>Don't use, reserved for future use.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-FONT-CHOOSER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FONT_CHOOSER</code></span></p></td>
<td>Allows selection of a display font.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-FRAME:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FRAME</code></span></p></td>
<td>A top level window with a title bar, border, menubar,
etc.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-GLASS-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_GLASS_PANE</code></span></p></td>
<td>A pane that is guaranteed to be painted on top of
all panes beneath it.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-HTML-CONTAINER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_HTML_CONTAINER</code></span></p></td>
<td>A document container for HTML, whose children
represent the document content.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-ICON:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ICON</code></span></p></td>
<td>A small fixed size picture, typically used to decorate
components.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-IMAGE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_IMAGE</code></span></p></td>
<td>An image, typically static.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-INTERNAL-FRAME:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_INTERNAL_FRAME</code></span></p></td>
<td>A frame-like object that is clipped by a desktop
pane.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-LABEL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LABEL</code></span></p></td>
<td>An object used to present an icon or short string in an
interface.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-LAYERED-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LAYERED_PANE</code></span></p></td>
<td>A specialized pane that allows its children to be
drawn in layers, providing a form of stacking order.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-LIST:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LIST</code></span></p></td>
<td>An object that presents a list of objects to the user and
allows the user to select one or more of them.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-LIST-ITEM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LIST_ITEM</code></span></p></td>
<td>An object that represents an element of a list.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-MENU:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_MENU</code></span></p></td>
<td>An object usually found inside a menu bar that contains a
list of actions the user can choose from.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-MENU-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_MENU_BAR</code></span></p></td>
<td>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.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-MENU-ITEM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_MENU_ITEM</code></span></p></td>
<td>An object usually contained in a menu that presents
an action the user can choose.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-OPTION-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_OPTION_PANE</code></span></p></td>
<td>A specialized pane whose primary use is inside a
dialog.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-PAGE-TAB:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PAGE_TAB</code></span></p></td>
<td>An object that is a child of a page tab list.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-PAGE-TAB-LIST:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PAGE_TAB_LIST</code></span></p></td>
<td>An object that presents a series of panels (or
page tabs), one at a time,through some mechanism provided by the
object.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-PANEL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PANEL</code></span></p></td>
<td>A generic container that is often used to group objects.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-PASSWORD-TEXT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PASSWORD_TEXT</code></span></p></td>
<td>A text object uses for passwords, or other places
where the text content is not shown visibly to the user.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-POPUP-MENU:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_POPUP_MENU</code></span></p></td>
<td>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.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-PROGRESS-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PROGRESS_BAR</code></span></p></td>
<td>An object used to indicate how much of a task has
been completed.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-PUSH-BUTTON:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PUSH_BUTTON</code></span></p></td>
<td>An object the user can manipulate to tell the
application to do something.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-RADIO-BUTTON:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_RADIO_BUTTON</code></span></p></td>
<td>A specialized check box that will cause other
radio buttons in the same group to become unchecked when this one is
checked.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-RADIO-MENU-ITEM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_RADIO_MENU_ITEM</code></span></p></td>
<td>Object is both a menu item and a "radio button"
. See <em class="parameter"><code>ATSPI_ROLE_RADIO_BUTTON</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-ROOT-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ROOT_PANE</code></span></p></td>
<td>A specialized pane that has a glass pane and a
layered pane as its children.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-ROW-HEADER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ROW_HEADER</code></span></p></td>
<td>The header for a row of data.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-SCROLL-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SCROLL_BAR</code></span></p></td>
<td>An object usually used to allow a user to
incrementally view a large amount of data by moving the bounds of a
viewport along a one-dimensional axis.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-SCROLL-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SCROLL_PANE</code></span></p></td>
<td>An object that allows a user to incrementally view
a large amount of information. <em class="parameter"><code>ATSPI_ROLE_SCROLL_PANE</code></em> objects are usually
accompanied by <em class="parameter"><code>ATSPI_ROLE_SCROLL_BAR</code></em> controllers, on which the
<em class="parameter"><code>ATSPI_RELATION_CONTROLLER_FOR</code></em> and <em class="parameter"><code>ATSPI_RELATION_CONTROLLED_BY</code></em>
reciprocal relations are set. See <span class="type">atspi_get_relation_set</span>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-SEPARATOR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SEPARATOR</code></span></p></td>
<td>An object usually contained in a menu to provide a
visible and logical separation of the contents in a menu.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-SLIDER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SLIDER</code></span></p></td>
<td>An object that allows the user to select from a bounded
range.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-SPIN-BUTTON:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SPIN_BUTTON</code></span></p></td>
<td>An object which allows one of a set of choices to
be selected, and which displays the current choice. Unlike
<em class="parameter"><code>ATSPI_ROLE_SCROLL_BAR</code></em>, <em class="parameter"><code>ATSPI_ROLE_SLIDER</code></em> objects need not control
'viewport'-like objects.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-SPLIT-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SPLIT_PANE</code></span></p></td>
<td>A specialized panel that presents two other panels
at the same time.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-STATUS-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_STATUS_BAR</code></span></p></td>
<td>Object displays non-quantitative status information
(c.f. <em class="parameter"><code>ATSPI_ROLE_PROGRESS_BAR</code></em>)
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TABLE</code></span></p></td>
<td>An object used to repesent information in terms of rows
and columns.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TABLE-CELL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TABLE_CELL</code></span></p></td>
<td>A 'cell' or discrete child within a Table. Note:
Table cells need not have <em class="parameter"><code>ATSPI_ROLE_TABLE_CELL</code></em>, other
<span class="type">AtspiRoleType</span> values are valid as well.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TABLE-COLUMN-HEADER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TABLE_COLUMN_HEADER</code></span></p></td>
<td>An object which labels a particular column
in an <a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TABLE-ROW-HEADER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TABLE_ROW_HEADER</code></span></p></td>
<td>An object which labels a particular row in a
<a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a>. <a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a> rows and columns may also be labelled via the
<em class="parameter"><code>ATSPI_RELATION_LABEL_FOR</code></em>/<em class="parameter"><code>ATSPI_RELATION_LABELLED_BY</code></em> relationships.
See <span class="type">atspi_get_relation_set</span>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TEAROFF-MENU-ITEM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TEAROFF_MENU_ITEM</code></span></p></td>
<td>Object allows menu to be removed from menubar
and shown in its own window.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TERMINAL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TERMINAL</code></span></p></td>
<td>An object that emulates a terminal.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TEXT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TEXT</code></span></p></td>
<td>An object that presents text to the user, of nonspecific
type.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TOGGLE-BUTTON:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TOGGLE_BUTTON</code></span></p></td>
<td>A specialized push button that can be checked or
unchecked, but does not procide a separate indicator for the current
state.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TOOL-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TOOL_BAR</code></span></p></td>
<td>A bar or palette usually composed of push buttons or
toggle buttons.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TOOL-TIP:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TOOL_TIP</code></span></p></td>
<td>An object that provides information about another
object.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TREE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TREE</code></span></p></td>
<td>An object used to repsent hierarchical information to the
user.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TREE-TABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TREE_TABLE</code></span></p></td>
<td>An object that presents both tabular and
hierarchical info to the user.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_UNKNOWN</code></span></p></td>
<td>The object contains some <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> information,
but its role is not known.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-VIEWPORT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_VIEWPORT</code></span></p></td>
<td>An object usually used in a scroll pane, or to
otherwise clip a larger object or content renderer to a specific
onscreen viewport.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-WINDOW:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_WINDOW</code></span></p></td>
<td>A top level window with no title or border.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-EXTENDED:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_EXTENDED</code></span></p></td>
<td>means that the role for this item is known, but not
included in the core enumeration.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-HEADER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_HEADER</code></span></p></td>
<td>An object that serves as a document header.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-FOOTER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FOOTER</code></span></p></td>
<td>An object that serves as a document footer.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-PARAGRAPH:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PARAGRAPH</code></span></p></td>
<td>An object which is contains a single paragraph of
text content. See also <em class="parameter"><code>ATSPI_ROLE_TEXT</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-RULER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_RULER</code></span></p></td>
<td>An object which describes margins and tab stops, etc.
for text objects which it controls (should have
<em class="parameter"><code>ATSPI_RELATION_CONTROLLER_FOR</code></em> relation to such).
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-APPLICATION:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_APPLICATION</code></span></p></td>
<td>An object corresponding to the toplevel accessible
of an application, which may contain <em class="parameter"><code>ATSPI_ROLE_FRAME</code></em> objects or other
accessible objects. Children of <span class="type">AccessibleDesktop</span> objects are generally
<em class="parameter"><code>ATSPI_ROLE_APPLICATION</code></em> objects.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-AUTOCOMPLETE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_AUTOCOMPLETE</code></span></p></td>
<td>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.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-EDITBAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_EDITBAR</code></span></p></td>
<td>The object is an editable text object in a toolbar.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-EMBEDDED:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_EMBEDDED</code></span></p></td>
<td>The object is an embedded component container. This
role is a "grouping" hint that the contained objects share a context
which is different from the container in which this accessible is
embedded. In particular, it is used for some kinds of document embedding,
and for embedding of out-of-process component, "panel applets", etc.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-ENTRY:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ENTRY</code></span></p></td>
<td>The object is a component whose textual content may be
entered or modified by the user, provided <em class="parameter"><code>ATSPI_STATE_EDITABLE</code></em> is present.
A readonly <em class="parameter"><code>ATSPI_ROLE_ENTRY</code></em> object (i.e. where <em class="parameter"><code>ATSPI_STATE_EDITABLE</code></em> is
not present) implies a read-only 'text field' in a form, as opposed to a
title, label, or caption.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-CHART:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_CHART</code></span></p></td>
<td>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 <em class="parameter"><code>ATSPI_LABELLED_BY</code></em> relation is
particularly important in interpreting objects of this type, as is the
accessible description property. See <em class="parameter"><code>ATSPI_ROLE_CAPTION</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-CAPTION:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_CAPTION</code></span></p></td>
<td>The object contains descriptive information, usually
textual, about another user interface element such as a table, chart, or
image.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DOCUMENT-FRAME:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DOCUMENT_FRAME</code></span></p></td>
<td>The object is a visual frame or container which
contains a view of document content. <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> frames may occur within
another <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> instance, in which case the second document may be
said to be embedded in the containing instance. HTML frames are often
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-HEADING:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_HEADING</code></span></p></td>
<td>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.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-PAGE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PAGE</code></span></p></td>
<td>The object is a containing instance which encapsulates a
page of information. <em class="parameter"><code>ATSPI_ROLE_PAGE</code></em> is used in documents and content which
support a paginated navigation model.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-SECTION:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SECTION</code></span></p></td>
<td>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.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-REDUNDANT-OBJECT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_REDUNDANT_OBJECT</code></span></p></td>
<td>The object is redundant with another object in
the hierarchy, and is exposed for purely technical reasons. Objects of
this role should be ignored by clients, if they are encountered at all.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-FORM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FORM</code></span></p></td>
<td>The object is a containing instance of document content
which has within it components with which the user can interact in order
to input information; i.e. the object is a container for pushbuttons,
comboboxes, text input fields, and other 'GUI' components. <em class="parameter"><code>ATSPI_ROLE_FORM</code></em>
should not, in general, be used for toplevel GUI containers or dialogs,
but should be reserved for 'GUI' containers which occur within document
content, for instance within Web documents, presentations, or text
documents. Unlike other GUI containers and dialogs which occur inside
application instances, <em class="parameter"><code>ATSPI_ROLE_FORM</code></em> containers' components are
associated with the current document, rather than the current foreground
application or viewer instance.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-LINK:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LINK</code></span></p></td>
<td>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 <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>/<a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> interfacesto indicate
the range/location within a text object where an inline or embedded object
lies.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-INPUT-METHOD-WINDOW:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_INPUT_METHOD_WINDOW</code></span></p></td>
<td>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".
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TABLE-ROW:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TABLE_ROW</code></span></p></td>
<td>A row in a table.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-TREE-ITEM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TREE_ITEM</code></span></p></td>
<td>An object that represents an element of a tree.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DOCUMENT-SPREADSHEET:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DOCUMENT_SPREADSHEET</code></span></p></td>
<td>A document frame which contains a
spreadsheet.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DOCUMENT-PRESENTATION:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DOCUMENT_PRESENTATION</code></span></p></td>
<td>A document frame which contains a
presentation or slide content.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DOCUMENT-TEXT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DOCUMENT_TEXT</code></span></p></td>
<td>A document frame which contains textual content,
such as found in a word processing
application.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DOCUMENT-WEB:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DOCUMENT_WEB</code></span></p></td>
<td>A document frame which contains HTML or other
markup suitable for display in a web browser.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-DOCUMENT-EMAIL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DOCUMENT_EMAIL</code></span></p></td>
<td>A document frame which contains email content
to be displayed or composed either in plain text or
HTML.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-COMMENT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_COMMENT</code></span></p></td>
<td>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.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-LIST-BOX:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LIST_BOX</code></span></p></td>
<td>A non-collapsible list of choices the user can
select from.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-GROUPING:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_GROUPING</code></span></p></td>
<td>A group of related widgets. This group typically has
a label.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-IMAGE-MAP:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_IMAGE_MAP</code></span></p></td>
<td>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.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-NOTIFICATION:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_NOTIFICATION</code></span></p></td>
<td>A transitory object designed to present a
message to the user, typically at the desktop level rather than inside a
particular application.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-INFO-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_INFO_BAR</code></span></p></td>
<td>An object designed to present a message to the user
within an existing window.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-LEVEL-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LEVEL_BAR</code></span></p></td>
<td>A bar that serves as a level indicator to, for
instance, show the strength of a password or the state of a battery.
Since: 2.8
</td>
</tr>
<tr>
<td><p><a name="ATSPI-ROLE-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LAST_DEFINED</code></span></p></td>
<td>Not a valid role, used for finding end of
enumeration.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-ROLE-COUNT:CAPS"></a><h3>ATSPI_ROLE_COUNT</h3>
<pre class="programlisting">#define ATSPI_ROLE_COUNT (90+1)
</pre>
<p>
One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole"><span class="type">AtspiRole</span></a>.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|