/usr/share/gtk-doc/html/atk/AtkText.html is in libatk1.0-doc 2.28.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AtkText: ATK - Accessibility Toolkit</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="interfaces.html" title="ATK Interfaces">
<link rel="prev" href="AtkTableCell.html" title="AtkTableCell">
<link rel="next" href="AtkValue.html" title="AtkValue">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#AtkText.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#AtkText.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#AtkText.implementations" class="shortcut">Known Implementations</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#AtkText.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="interfaces.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="AtkTableCell.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="AtkValue.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="AtkText"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtkText.top_of_page"></a>AtkText</span></h2>
<p>AtkText — The ATK interface implemented by components
with text content.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="AtkText.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-text" title="atk_text_get_text ()">atk_text_get_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Unicode-Manipulation.html#gunichar"><span class="returnvalue">gunichar</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-character-at-offset" title="atk_text_get_character_at_offset ()">atk_text_get_character_at_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-text-after-offset" title="atk_text_get_text_after_offset ()">atk_text_get_text_after_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-text-at-offset" title="atk_text_get_text_at_offset ()">atk_text_get_text_at_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-text-before-offset" title="atk_text_get_text_before_offset ()">atk_text_get_text_before_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()">atk_text_get_string_at_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-caret-offset" title="atk_text_get_caret_offset ()">atk_text_get_caret_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-character-extents" title="atk_text_get_character_extents ()">atk_text_get_character_extents</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-run-attributes" title="atk_text_get_run_attributes ()">atk_text_get_run_attributes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-default-attributes" title="atk_text_get_default_attributes ()">atk_text_get_default_attributes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-character-count" title="atk_text_get_character_count ()">atk_text_get_character_count</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-offset-at-point" title="atk_text_get_offset_at_point ()">atk_text_get_offset_at_point</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkText.html#AtkTextRange"><span class="returnvalue">AtkTextRange</span></a> **
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-bounded-ranges" title="atk_text_get_bounded_ranges ()">atk_text_get_bounded_ranges</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-range-extents" title="atk_text_get_range_extents ()">atk_text_get_range_extents</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-free-ranges" title="atk_text_free_ranges ()">atk_text_free_ranges</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-n-selections" title="atk_text_get_n_selections ()">atk_text_get_n_selections</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-get-selection" title="atk_text_get_selection ()">atk_text_get_selection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-add-selection" title="atk_text_add_selection ()">atk_text_add_selection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-remove-selection" title="atk_text_remove_selection ()">atk_text_remove_selection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-set-selection" title="atk_text_set_selection ()">atk_text_set_selection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-set-caret-offset" title="atk_text_set_caret_offset ()">atk_text_set_caret_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-attribute-set-free" title="atk_attribute_set_free ()">atk_attribute_set_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="returnvalue">AtkTextAttribute</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-attribute-register" title="atk_text_attribute_register ()">atk_text_attribute_register</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-attribute-get-name" title="atk_text_attribute_get_name ()">atk_text_attribute_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="returnvalue">AtkTextAttribute</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-attribute-for-name" title="atk_text_attribute_for_name ()">atk_text_attribute_for_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkText.html#atk-text-attribute-get-value" title="atk_text_attribute_get_value ()">atk_text_attribute_get_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtkText.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkText.html#AtkText-text-attributes-changed" title="The “text-attributes-changed” signal">text-attributes-changed</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkText.html#AtkText-text-caret-moved" title="The “text-caret-moved” signal">text-caret-moved</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkText.html#AtkText-text-changed" title="The “text-changed” signal">text-changed</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkText.html#AtkText-text-insert" title="The “text-insert” signal">text-insert</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkText.html#AtkText-text-remove" title="The “text-remove” signal">text-remove</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkText.html#AtkText-text-selection-changed" title="The “text-selection-changed” signal">text-selection-changed</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
</tbody>
</table></div>
</div>
<a name="AtkTextRange"></a><div class="refsect1">
<a name="AtkText.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="AtkText.html#AtkText-struct" title="AtkText">AtkText</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="AtkText.html#AtkTextIface" title="struct AtkTextIface">AtkTextIface</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary">AtkTextBoundary</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="AtkText.html#AtkTextGranularity" title="enum AtkTextGranularity">AtkTextGranularity</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="AtkText.html#AtkTextClipType" title="enum AtkTextClipType">AtkTextClipType</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="AtkText.html#AtkTextRange-struct" title="struct AtkTextRange">AtkTextRange</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle">AtkTextRectangle</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute">AtkTextAttribute</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtkText.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
<span class="lineart">╰──</span> AtkTextRange
<a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
<span class="lineart">├──</span> AtkTextAttribute
<span class="lineart">├──</span> AtkTextBoundary
<span class="lineart">├──</span> AtkTextClipType
<span class="lineart">╰──</span> AtkTextGranularity
<a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> AtkText
</pre>
</div>
<div class="refsect1">
<a name="AtkText.implementations"></a><h2>Known Implementations</h2>
<p>
AtkText is implemented by
<a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
</div>
<div class="refsect1">
<a name="AtkText.description"></a><h2>Description</h2>
<p><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> should be implemented by <a href="AtkObject.html#AtkObject-struct"><span class="type">AtkObjects</span></a> on behalf of widgets
that have text content which is either attributed or otherwise
non-trivial. <a href="AtkObject.html#AtkObject-struct"><span class="type">AtkObjects</span></a> whose text content is simple,
unattributed, and very brief may expose that content via
<a class="link" href="AtkObject.html#atk-object-get-name" title="atk_object_get_name ()"><span class="type">atk_object_get_name</span></a> instead; however if the text is editable,
multi-line, typically longer than three or four words, attributed,
selectable, or if the object already uses the 'name' ATK property
for other information, the <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> interface should be used to
expose the text content. In the case of editable text content,
<a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> (a subtype of the <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> interface) should be
implemented instead.</p>
<p> <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> provides not only traversal facilities and change
notification for text content, but also caret tracking and glyph
bounding box calculations. Note that the text strings are exposed
as UTF-8, and are therefore potentially multi-byte, and
caret-to-byte offset mapping makes no assumptions about the
character length; also bounding box glyph-to-offset mapping may be
complex for languages which use ligatures.</p>
</div>
<div class="refsect1">
<a name="AtkText.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="atk-text-get-text"></a><h3>atk_text_get_text ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_text_get_text (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_offset</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_offset</code></em>);</pre>
<p>Gets the specified text.</p>
<div class="refsect3">
<a name="atk-text-get-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>start position</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>end position, or -1 for the end of the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-text.returns"></a><h4>Returns</h4>
<p> a newly allocated string containing the text from <em class="parameter"><code>start_offset</code></em>
up
to, but not including <em class="parameter"><code>end_offset</code></em>
. Use <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> to free the returned string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-character-at-offset"></a><h3>atk_text_get_character_at_offset ()</h3>
<pre class="programlisting"><a href="../glib/glib-Unicode-Manipulation.html#gunichar"><span class="returnvalue">gunichar</span></a>
atk_text_get_character_at_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>);</pre>
<p>Gets the specified text.</p>
<div class="refsect3">
<a name="atk-text-get-character-at-offset.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>position</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-character-at-offset.returns"></a><h4>Returns</h4>
<p> the character at <em class="parameter"><code>offset</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-text-after-offset"></a><h3>atk_text_get_text_after_offset ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_text_get_text_after_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>);</pre>
<div class="warning">
<p><code class="literal">atk_text_get_text_after_offset</code> has been deprecated since version 2.9.3 and should not be used in newly-written code.</p>
<p>Please use <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()"><code class="function">atk_text_get_string_at_offset()</code></a> instead.</p>
</div>
<p>Gets the specified text.</p>
<div class="refsect3">
<a name="atk-text-get-text-after-offset.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>position</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>boundary_type</p></td>
<td class="parameter_description"><p>An <a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>the start offset of the returned string. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>the offset of the first character after the
returned substring. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-text-after-offset.returns"></a><h4>Returns</h4>
<p> a newly allocated string containing the text after <em class="parameter"><code>offset</code></em>
bounded
by the specified <em class="parameter"><code>boundary_type</code></em>
. Use <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> to free the returned string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-text-at-offset"></a><h3>atk_text_get_text_at_offset ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_text_get_text_at_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>);</pre>
<div class="warning">
<p><code class="literal">atk_text_get_text_at_offset</code> is deprecated and should not be used in newly-written code.</p>
<p>This method is deprecated since ATK version
2.9.4. Please use <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()"><code class="function">atk_text_get_string_at_offset()</code></a> instead.</p>
</div>
<p>Gets the specified text.</p>
<p>If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the
offset is returned.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
is from the word start at or before the offset to the word start after
the offset.</p>
<p>The returned string will contain the word at the offset if the offset
is inside a word and will contain the word before the offset if the
offset is not inside a word.</p>
<p>If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
string is from the sentence start at or before the offset to the sentence
start after the offset.</p>
<p>The returned string will contain the sentence at the offset if the offset
is inside a sentence and will contain the sentence before the offset
if the offset is not inside a sentence.</p>
<p>If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
string is from the line start at or before the offset to the line
start after the offset.</p>
<div class="refsect3">
<a name="atk-text-get-text-at-offset.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>position</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>boundary_type</p></td>
<td class="parameter_description"><p>An <a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>the start offset of the returned string. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>the offset of the first character after the
returned substring. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-text-at-offset.returns"></a><h4>Returns</h4>
<p> a newly allocated string containing the text at <em class="parameter"><code>offset</code></em>
bounded by
the specified <em class="parameter"><code>boundary_type</code></em>
. Use <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> to free the returned string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-text-before-offset"></a><h3>atk_text_get_text_before_offset ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_text_get_text_before_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>);</pre>
<div class="warning">
<p><code class="literal">atk_text_get_text_before_offset</code> has been deprecated since version 2.9.3 and should not be used in newly-written code.</p>
<p>Please use <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()"><code class="function">atk_text_get_string_at_offset()</code></a> instead.</p>
</div>
<p>Gets the specified text.</p>
<div class="refsect3">
<a name="atk-text-get-text-before-offset.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>position</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>boundary_type</p></td>
<td class="parameter_description"><p>An <a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>the start offset of the returned string. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>the offset of the first character after the
returned substring. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-text-before-offset.returns"></a><h4>Returns</h4>
<p> a newly allocated string containing the text before <em class="parameter"><code>offset</code></em>
bounded
by the specified <em class="parameter"><code>boundary_type</code></em>
. Use <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> to free the returned string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-string-at-offset"></a><h3>atk_text_get_string_at_offset ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_text_get_string_at_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextGranularity" title="enum AtkTextGranularity"><span class="type">AtkTextGranularity</span></a> granularity</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>);</pre>
<p>Gets a portion of the text exposed through an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> according to a given <em class="parameter"><code>offset</code></em>
and a specific <em class="parameter"><code>granularity</code></em>
, along with the start and end offsets defining the
boundaries of such a portion of text.</p>
<p>If <em class="parameter"><code>granularity</code></em>
is ATK_TEXT_GRANULARITY_CHAR the character at the
offset is returned.</p>
<p>If <em class="parameter"><code>granularity</code></em>
is ATK_TEXT_GRANULARITY_WORD the returned string
is from the word start at or before the offset to the word start after
the offset.</p>
<p>The returned string will contain the word at the offset if the offset
is inside a word and will contain the word before the offset if the
offset is not inside a word.</p>
<p>If <em class="parameter"><code>granularity</code></em>
is ATK_TEXT_GRANULARITY_SENTENCE the returned string
is from the sentence start at or before the offset to the sentence
start after the offset.</p>
<p>The returned string will contain the sentence at the offset if the offset
is inside a sentence and will contain the sentence before the offset
if the offset is not inside a sentence.</p>
<p>If <em class="parameter"><code>granularity</code></em>
is ATK_TEXT_GRANULARITY_LINE the returned string
is from the line start at or before the offset to the line
start after the offset.</p>
<p>If <em class="parameter"><code>granularity</code></em>
is ATK_TEXT_GRANULARITY_PARAGRAPH the returned string
is from the start of the paragraph at or before the offset to the start
of the following paragraph after the offset.</p>
<div class="refsect3">
<a name="atk-text-get-string-at-offset.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>position</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>granularity</p></td>
<td class="parameter_description"><p>An <a class="link" href="AtkText.html#AtkTextGranularity" title="enum AtkTextGranularity"><span class="type">AtkTextGranularity</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>the start offset of the returned string, or -1
if an error has occurred (e.g. invalid offset, not implemented). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>the offset of the first character after the returned string,
or -1 if an error has occurred (e.g. invalid offset, not implemented). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-string-at-offset.returns"></a><h4>Returns</h4>
<p>a newly allocated string containing the text
at the <em class="parameter"><code>offset</code></em>
bounded by the specified <em class="parameter"><code>granularity</code></em>
. Use
<a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> to free the returned string. Returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the
offset is invalid or no implementation is available. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-caret-offset"></a><h3>atk_text_get_caret_offset ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
atk_text_get_caret_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);</pre>
<p>Gets the offset position of the caret (cursor).</p>
<div class="refsect3">
<a name="atk-text-get-caret-offset.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-caret-offset.returns"></a><h4>Returns</h4>
<p> the offset position of the caret (cursor).</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-character-extents"></a><h3>atk_text_get_character_extents ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atk_text_get_character_extents (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *x</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *y</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *width</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *height</code></em>,
<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coords</code></em>);</pre>
<p>Get the bounding box containing the glyph representing the character at
a particular text offset.</p>
<div class="refsect3">
<a name="atk-text-get-character-extents.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>The offset of the text character for which bounding information is required.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>Pointer for the x cordinate of the bounding box. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>Pointer for the y cordinate of the bounding box. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>Pointer for the width of the bounding box. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>Pointer for the height of the bounding box. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>coords</p></td>
<td class="parameter_description"><p>specify whether coordinates are relative to the screen or widget window </p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-run-attributes"></a><h3>atk_text_get_run_attributes ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *
atk_text_get_run_attributes (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>);</pre>
<p>Creates an <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which consists of the attributes explicitly
set at the position <em class="parameter"><code>offset</code></em>
in the text. <em class="parameter"><code>start_offset</code></em>
and <em class="parameter"><code>end_offset</code></em>
are
set to the start and end of the range around <em class="parameter"><code>offset</code></em>
where the attributes are
invariant. Note that <em class="parameter"><code>end_offset</code></em>
is the offset of the first character
after the range. See the enum AtkTextAttribute for types of text
attributes that can be returned. Note that other attributes may also be
returned.</p>
<div class="refsect3">
<a name="atk-text-get-run-attributes.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>the offset at which to get the attributes, -1 means the offset of
the character to be inserted at the caret location.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>the address to put the start offset of the range. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>the address to put the end offset of the range. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-run-attributes.returns"></a><h4>Returns</h4>
<p>an <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which contains the attributes
explicitly set at <em class="parameter"><code>offset</code></em>
. This <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> should be freed by a call
to <a class="link" href="AtkText.html#atk-attribute-set-free" title="atk_attribute_set_free ()"><code class="function">atk_attribute_set_free()</code></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-default-attributes"></a><h3>atk_text_get_default_attributes ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *
atk_text_get_default_attributes (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);</pre>
<p>Creates an <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which consists of the default values of
attributes for the text. See the enum AtkTextAttribute for types of text
attributes that can be returned. Note that other attributes may also be
returned.</p>
<div class="refsect3">
<a name="atk-text-get-default-attributes.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-default-attributes.returns"></a><h4>Returns</h4>
<p>an <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which contains the default
values of attributes. at <em class="parameter"><code>offset</code></em>
. this <span class="type">atkattributeset</span> should be freed by
a call to <a class="link" href="AtkText.html#atk-attribute-set-free" title="atk_attribute_set_free ()"><code class="function">atk_attribute_set_free()</code></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-character-count"></a><h3>atk_text_get_character_count ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
atk_text_get_character_count (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);</pre>
<p>Gets the character count.</p>
<div class="refsect3">
<a name="atk-text-get-character-count.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-character-count.returns"></a><h4>Returns</h4>
<p> the number of characters.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-offset-at-point"></a><h3>atk_text_get_offset_at_point ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
atk_text_get_offset_at_point (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coords</code></em>);</pre>
<p>Gets the offset of the character located at coordinates <em class="parameter"><code>x</code></em>
and <em class="parameter"><code>y</code></em>
. <em class="parameter"><code>x</code></em>
and <em class="parameter"><code>y</code></em>
are interpreted as being relative to the screen or this widget's window
depending on <em class="parameter"><code>coords</code></em>
.</p>
<div class="refsect3">
<a name="atk-text-get-offset-at-point.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>screen x-position of character</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>screen y-position of character</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>coords</p></td>
<td class="parameter_description"><p>specify whether coordinates are relative to the screen or
widget window </p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-offset-at-point.returns"></a><h4>Returns</h4>
<p> the offset to the character which is located at
the specified <em class="parameter"><code>x</code></em>
and <em class="parameter"><code>y</code></em>
coordinates.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-bounded-ranges"></a><h3>atk_text_get_bounded_ranges ()</h3>
<pre class="programlisting"><a class="link" href="AtkText.html#AtkTextRange"><span class="returnvalue">AtkTextRange</span></a> **
atk_text_get_bounded_ranges (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle"><span class="type">AtkTextRectangle</span></a> *rect</code></em>,
<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coord_type</code></em>,
<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextClipType" title="enum AtkTextClipType"><span class="type">AtkTextClipType</span></a> x_clip_type</code></em>,
<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextClipType" title="enum AtkTextClipType"><span class="type">AtkTextClipType</span></a> y_clip_type</code></em>);</pre>
<p>Get the ranges of text in the specified bounding box.</p>
<div class="refsect3">
<a name="atk-text-get-bounded-ranges.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rect</p></td>
<td class="parameter_description"><p>An AtkTextRectangle giving the dimensions of the bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>coord_type</p></td>
<td class="parameter_description"><p>Specify whether coordinates are relative to the screen or widget window.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_clip_type</p></td>
<td class="parameter_description"><p>Specify the horizontal clip type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_clip_type</p></td>
<td class="parameter_description"><p>Specify the vertical clip type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-bounded-ranges.returns"></a><h4>Returns</h4>
<p>Array of AtkTextRange. The last
element of the array returned by this function will be NULL. </p>
<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></p>
</div>
<p class="since">Since: 1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-range-extents"></a><h3>atk_text_get_range_extents ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atk_text_get_range_extents (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_offset</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_offset</code></em>,
<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coord_type</code></em>,
<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle"><span class="type">AtkTextRectangle</span></a> *rect</code></em>);</pre>
<p>Get the bounding box for text within the specified range.</p>
<div class="refsect3">
<a name="atk-text-get-range-extents.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>The offset of the first text character for which boundary
information is required.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>The offset of the text character after the last character
for which boundary information is required.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>coord_type</p></td>
<td class="parameter_description"><p>Specify whether coordinates are relative to the screen or widget window.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rect</p></td>
<td class="parameter_description"><p>A pointer to a AtkTextRectangle which is filled in by this function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-free-ranges"></a><h3>atk_text_free_ranges ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atk_text_free_ranges (<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextRange"><span class="type">AtkTextRange</span></a> **ranges</code></em>);</pre>
<p>Frees the memory associated with an array of AtkTextRange. It is assumed
that the array was returned by the function atk_text_get_bounded_ranges
and is NULL terminated.</p>
<div class="refsect3">
<a name="atk-text-free-ranges.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>ranges</p></td>
<td class="parameter_description"><p>A pointer to an array of <a class="link" href="AtkText.html#AtkTextRange"><span class="type">AtkTextRange</span></a> which is
to be freed. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-n-selections"></a><h3>atk_text_get_n_selections ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
atk_text_get_n_selections (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);</pre>
<p>Gets the number of selected regions.</p>
<div class="refsect3">
<a name="atk-text-get-n-selections.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-n-selections.returns"></a><h4>Returns</h4>
<p> The number of selected regions, or -1 if a failure
occurred.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-get-selection"></a><h3>atk_text_get_selection ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_text_get_selection (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> selection_num</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *start_offset</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *end_offset</code></em>);</pre>
<p>Gets the text from the specified selection.</p>
<div class="refsect3">
<a name="atk-text-get-selection.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selection_num</p></td>
<td class="parameter_description"><p>The selection number. The selected regions are
assigned numbers that correspond to how far the region is from the
start of the text. The selected region closest to the beginning
of the text region is assigned the number 0, etc. Note that adding,
moving or deleting a selected region can change the numbering.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>passes back the start position of the selected region. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>passes back the end position of (e.g. offset immediately past)
the selected region. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-get-selection.returns"></a><h4>Returns</h4>
<p> a newly allocated string containing the selected text. Use <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
to free the returned string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-add-selection"></a><h3>atk_text_add_selection ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
atk_text_add_selection (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_offset</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_offset</code></em>);</pre>
<p>Adds a selection bounded by the specified offsets.</p>
<div class="refsect3">
<a name="atk-text-add-selection.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>the start position of the selected region</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>the offset of the first character after the selected region.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-add-selection.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-remove-selection"></a><h3>atk_text_remove_selection ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
atk_text_remove_selection (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> selection_num</code></em>);</pre>
<p>Removes the specified selection.</p>
<div class="refsect3">
<a name="atk-text-remove-selection.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selection_num</p></td>
<td class="parameter_description"><p>The selection number. The selected regions are
assigned numbers that correspond to how far the region is from the
start of the text. The selected region closest to the beginning
of the text region is assigned the number 0, etc. Note that adding,
moving or deleting a selected region can change the numbering.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-remove-selection.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-set-selection"></a><h3>atk_text_set_selection ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
atk_text_set_selection (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> selection_num</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> start_offset</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> end_offset</code></em>);</pre>
<p>Changes the start and end offset of the specified selection.</p>
<div class="refsect3">
<a name="atk-text-set-selection.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selection_num</p></td>
<td class="parameter_description"><p>The selection number. The selected regions are
assigned numbers that correspond to how far the region is from the
start of the text. The selected region closest to the beginning
of the text region is assigned the number 0, etc. Note that adding,
moving or deleting a selected region can change the numbering.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_offset</p></td>
<td class="parameter_description"><p>the new start position of the selection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_offset</p></td>
<td class="parameter_description"><p>the new end position of (e.g. offset immediately past)
the selection</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-set-selection.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-set-caret-offset"></a><h3>atk_text_set_caret_offset ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
atk_text_set_caret_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>);</pre>
<p>Sets the caret (cursor) position to the specified <em class="parameter"><code>offset</code></em>
.</p>
<div class="refsect3">
<a name="atk-text-set-caret-offset.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>position</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-set-caret-offset.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-attribute-set-free"></a><h3>atk_attribute_set_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atk_attribute_set_free (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> *attrib_set</code></em>);</pre>
<p>Frees the memory used by an <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a>, including all its
<a href="AtkObject.html#AtkAttribute"><span class="type">AtkAttributes</span></a>.</p>
<div class="refsect3">
<a name="atk-attribute-set-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>attrib_set</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> to free</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-attribute-register"></a><h3>atk_text_attribute_register ()</h3>
<pre class="programlisting"><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="returnvalue">AtkTextAttribute</span></a>
atk_text_attribute_register (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Associate <em class="parameter"><code>name</code></em>
with a new <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a></p>
<div class="refsect3">
<a name="atk-text-attribute-register.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>a name string</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-attribute-register.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> associated with <em class="parameter"><code>name</code></em>
</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-attribute-get-name"></a><h3>atk_text_attribute_get_name ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_text_attribute_get_name (<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> attr</code></em>);</pre>
<p>Gets the name corresponding to the <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a></p>
<div class="refsect3">
<a name="atk-text-attribute-get-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>attr</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> whose name is required</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-attribute-get-name.returns"></a><h4>Returns</h4>
<p> a string containing the name; this string should not be freed</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-attribute-for-name"></a><h3>atk_text_attribute_for_name ()</h3>
<pre class="programlisting"><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="returnvalue">AtkTextAttribute</span></a>
atk_text_attribute_for_name (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Get the <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> type corresponding to a text attribute name.</p>
<div class="refsect3">
<a name="atk-text-attribute-for-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>a string which is the (non-localized) name of an ATK text attribute.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-attribute-for-name.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> enumerated type corresponding to the specified
name,
or <span class="type">ATK_TEXT_ATTRIBUTE_INVALID</span> if no matching text attribute is found.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-text-attribute-get-value"></a><h3>atk_text_attribute_get_value ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_text_attribute_get_value (<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> attr</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> index_</code></em>);</pre>
<p>Gets the value for the index of the <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a></p>
<div class="refsect3">
<a name="atk-text-attribute-get-value.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>attr</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> for which a value is required</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>index_</p></td>
<td class="parameter_description"><p>The index of the required value</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-text-attribute-get-value.returns"></a><h4>Returns</h4>
<p>a string containing the value; this string
should not be freed; <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned if there are no values
maintained for the attr value. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="AtkText.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AtkText-struct"></a><h3>AtkText</h3>
<pre class="programlisting">typedef struct _AtkText AtkText;</pre>
</div>
<hr>
<div class="refsect2">
<a name="AtkTextIface"></a><h3>struct AtkTextIface</h3>
<pre class="programlisting">struct AtkTextIface {
GTypeInterface parent;
gchar* (* get_text) (AtkText *text,
gint start_offset,
gint end_offset);
gchar* (* get_text_after_offset) (AtkText *text,
gint offset,
AtkTextBoundary boundary_type,
gint *start_offset,
gint *end_offset);
gchar* (* get_text_at_offset) (AtkText *text,
gint offset,
AtkTextBoundary boundary_type,
gint *start_offset,
gint *end_offset);
gunichar (* get_character_at_offset) (AtkText *text,
gint offset);
gchar* (* get_text_before_offset) (AtkText *text,
gint offset,
AtkTextBoundary boundary_type,
gint *start_offset,
gint *end_offset);
gint (* get_caret_offset) (AtkText *text);
AtkAttributeSet* (* get_run_attributes) (AtkText *text,
gint offset,
gint *start_offset,
gint *end_offset);
AtkAttributeSet* (* get_default_attributes) (AtkText *text);
void (* get_character_extents) (AtkText *text,
gint offset,
gint *x,
gint *y,
gint *width,
gint *height,
AtkCoordType coords);
gint (* get_character_count) (AtkText *text);
gint (* get_offset_at_point) (AtkText *text,
gint x,
gint y,
AtkCoordType coords);
gint (* get_n_selections) (AtkText *text);
gchar* (* get_selection) (AtkText *text,
gint selection_num,
gint *start_offset,
gint *end_offset);
gboolean (* add_selection) (AtkText *text,
gint start_offset,
gint end_offset);
gboolean (* remove_selection) (AtkText *text,
gint selection_num);
gboolean (* set_selection) (AtkText *text,
gint selection_num,
gint start_offset,
gint end_offset);
gboolean (* set_caret_offset) (AtkText *text,
gint offset);
/*
* signal handlers
*/
void (* text_changed) (AtkText *text,
gint position,
gint length);
void (* text_caret_moved) (AtkText *text,
gint location);
void (* text_selection_changed) (AtkText *text);
void (* text_attributes_changed) (AtkText *text);
void (* get_range_extents) (AtkText *text,
gint start_offset,
gint end_offset,
AtkCoordType coord_type,
AtkTextRectangle *rect);
AtkTextRange** (* get_bounded_ranges) (AtkText *text,
AtkTextRectangle *rect,
AtkCoordType coord_type,
AtkTextClipType x_clip_type,
AtkTextClipType y_clip_type);
gchar* (* get_string_at_offset) (AtkText *text,
gint offset,
AtkTextGranularity granularity,
gint *start_offset,
gint *end_offset);
};
</pre>
<div class="refsect3">
<a name="AtkTextIface.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="../gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="AtkTextIface.parent"></a>parent</code></em>;</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-text"></a>get_text</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-text-after-offset"></a>get_text_after_offset</code></em> ()</p></td>
<td class="struct_member_description"><p>Gets specified text. This virtual function
is deprecated and it should not be overridden.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-text-at-offset"></a>get_text_at_offset</code></em> ()</p></td>
<td class="struct_member_description"><p>Gets specified text. This virtual function
is deprecated and it should not be overridden.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-character-at-offset"></a>get_character_at_offset</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-text-before-offset"></a>get_text_before_offset</code></em> ()</p></td>
<td class="struct_member_description"><p>Gets specified text. This virtual function
is deprecated and it should not be overridden.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-caret-offset"></a>get_caret_offset</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-run-attributes"></a>get_run_attributes</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-default-attributes"></a>get_default_attributes</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-character-extents"></a>get_character_extents</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-character-count"></a>get_character_count</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-offset-at-point"></a>get_offset_at_point</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-n-selections"></a>get_n_selections</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-selection"></a>get_selection</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.add-selection"></a>add_selection</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.remove-selection"></a>remove_selection</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.set-selection"></a>set_selection</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.set-caret-offset"></a>set_caret_offset</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.text-changed"></a>text_changed</code></em> ()</p></td>
<td class="struct_member_description"><p>the signal handler which is executed when there is a
text change. This virtual function is deprecated sice 2.9.4 and
it should not be overriden.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.text-caret-moved"></a>text_caret_moved</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.text-selection-changed"></a>text_selection_changed</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.text-attributes-changed"></a>text_attributes_changed</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-range-extents"></a>get_range_extents</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-bounded-ranges"></a>get_bounded_ranges</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-string-at-offset"></a>get_string_at_offset</code></em> ()</p></td>
<td class="struct_member_description"><p>Gets a portion of the text exposed through
an AtkText according to a given offset and a specific
granularity, along with the start and end offsets defining the
boundaries of such a portion of text.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtkTextBoundary"></a><h3>enum AtkTextBoundary</h3>
<p>Text boundary types used for specifying boundaries for regions of text.
This enumeration is deprecated since 2.9.4 and should not be used. Use
AtkTextGranularity with <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()"><span class="type">atk_text_get_string_at_offset</span></a> instead.</p>
<div class="refsect3">
<a name="AtkTextBoundary.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-CHAR:CAPS"></a>ATK_TEXT_BOUNDARY_CHAR</p></td>
<td class="enum_member_description">
<p>Boundary is the boundary between characters
(including non-printing characters)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-WORD-START:CAPS"></a>ATK_TEXT_BOUNDARY_WORD_START</p></td>
<td class="enum_member_description">
<p>Boundary is the start (i.e. first character) of a word.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-WORD-END:CAPS"></a>ATK_TEXT_BOUNDARY_WORD_END</p></td>
<td class="enum_member_description">
<p>Boundary is the end (i.e. last
character) of a word.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-SENTENCE-START:CAPS"></a>ATK_TEXT_BOUNDARY_SENTENCE_START</p></td>
<td class="enum_member_description">
<p>Boundary is the first character in a sentence.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-SENTENCE-END:CAPS"></a>ATK_TEXT_BOUNDARY_SENTENCE_END</p></td>
<td class="enum_member_description">
<p>Boundary is the last (terminal)
character in a sentence; in languages which use "sentence stop"
punctuation such as English, the boundary is thus the '.', '?', or
similar terminal punctuation character.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-LINE-START:CAPS"></a>ATK_TEXT_BOUNDARY_LINE_START</p></td>
<td class="enum_member_description">
<p>Boundary is the initial character of the content or a
character immediately following a newline, linefeed, or return character.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-LINE-END:CAPS"></a>ATK_TEXT_BOUNDARY_LINE_END</p></td>
<td class="enum_member_description">
<p>Boundary is the linefeed, or return
character.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtkTextGranularity"></a><h3>enum AtkTextGranularity</h3>
<p>Text granularity types used for specifying the granularity of the region of
text we are interested in.</p>
<div class="refsect3">
<a name="AtkTextGranularity.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-GRANULARITY-CHAR:CAPS"></a>ATK_TEXT_GRANULARITY_CHAR</p></td>
<td class="enum_member_description">
<p>Granularity is defined by the boundaries between characters
(including non-printing characters)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-GRANULARITY-WORD:CAPS"></a>ATK_TEXT_GRANULARITY_WORD</p></td>
<td class="enum_member_description">
<p>Granularity is defined by the boundaries of a word,
starting at the beginning of the current word and finishing at the beginning of
the following one, if present.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-GRANULARITY-SENTENCE:CAPS"></a>ATK_TEXT_GRANULARITY_SENTENCE</p></td>
<td class="enum_member_description">
<p>Granularity is defined by the boundaries of a sentence,
starting at the beginning of the current sentence and finishing at the beginning of
the following one, if present.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-GRANULARITY-LINE:CAPS"></a>ATK_TEXT_GRANULARITY_LINE</p></td>
<td class="enum_member_description">
<p>Granularity is defined by the boundaries of a line,
starting at the beginning of the current line and finishing at the beginning of
the following one, if present.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-GRANULARITY-PARAGRAPH:CAPS"></a>ATK_TEXT_GRANULARITY_PARAGRAPH</p></td>
<td class="enum_member_description">
<p>Granularity is defined by the boundaries of a paragraph,
starting at the beginning of the current paragraph and finishing at the beginning of
the following one, if present.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtkTextClipType"></a><h3>enum AtkTextClipType</h3>
<p>Describes the type of clipping required.</p>
<div class="refsect3">
<a name="AtkTextClipType.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-CLIP-NONE:CAPS"></a>ATK_TEXT_CLIP_NONE</p></td>
<td class="enum_member_description">
<p>No clipping to be done</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-CLIP-MIN:CAPS"></a>ATK_TEXT_CLIP_MIN</p></td>
<td class="enum_member_description">
<p>Text clipped by min coordinate is omitted</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-CLIP-MAX:CAPS"></a>ATK_TEXT_CLIP_MAX</p></td>
<td class="enum_member_description">
<p>Text clipped by max coordinate is omitted</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-CLIP-BOTH:CAPS"></a>ATK_TEXT_CLIP_BOTH</p></td>
<td class="enum_member_description">
<p>Only text fully within mix/max bound is retained</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtkTextRange-struct"></a><h3>struct AtkTextRange</h3>
<pre class="programlisting">struct AtkTextRange {
AtkTextRectangle bounds;
gint start_offset;
gint end_offset;
gchar* content;
};
</pre>
<p>A structure used to describe a text range.</p>
<div class="refsect3">
<a name="AtkTextRange.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle"><span class="type">AtkTextRectangle</span></a> <em class="structfield"><code><a name="AtkTextRange-struct.bounds"></a>bounds</code></em>;</p></td>
<td class="struct_member_description"><p>A rectangle giving the bounds of the text range</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="AtkTextRange-struct.start-offset"></a>start_offset</code></em>;</p></td>
<td class="struct_member_description"><p>The start offset of a AtkTextRange</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="AtkTextRange-struct.end-offset"></a>end_offset</code></em>;</p></td>
<td class="struct_member_description"><p>The end offset of a AtkTextRange</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="AtkTextRange-struct.content"></a>content</code></em>;</p></td>
<td class="struct_member_description"><p>The text in the text range</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtkTextRectangle"></a><h3>struct AtkTextRectangle</h3>
<pre class="programlisting">struct AtkTextRectangle {
gint x;
gint y;
gint width;
gint height;
};
</pre>
<p>A structure used to store a rectangle used by AtkText.</p>
<div class="refsect3">
<a name="AtkTextRectangle.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="AtkTextRectangle.x"></a>x</code></em>;</p></td>
<td class="struct_member_description"><p>The horizontal coordinate of a rectangle</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="AtkTextRectangle.y"></a>y</code></em>;</p></td>
<td class="struct_member_description"><p>The vertical coordinate of a rectangle</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="AtkTextRectangle.width"></a>width</code></em>;</p></td>
<td class="struct_member_description"><p>The width of a rectangle</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="AtkTextRectangle.height"></a>height</code></em>;</p></td>
<td class="struct_member_description"><p>The height of a rectangle</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtkTextAttribute"></a><h3>enum AtkTextAttribute</h3>
<p>Describes the text attributes supported</p>
<div class="refsect3">
<a name="AtkTextAttribute.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-INVALID:CAPS"></a>ATK_TEXT_ATTR_INVALID</p></td>
<td class="enum_member_description">
<p>Invalid attribute, like bad spelling or grammar.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-LEFT-MARGIN:CAPS"></a>ATK_TEXT_ATTR_LEFT_MARGIN</p></td>
<td class="enum_member_description">
<p>The pixel width of the left margin</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-RIGHT-MARGIN:CAPS"></a>ATK_TEXT_ATTR_RIGHT_MARGIN</p></td>
<td class="enum_member_description">
<p>The pixel width of the right margin</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-INDENT:CAPS"></a>ATK_TEXT_ATTR_INDENT</p></td>
<td class="enum_member_description">
<p>The number of pixels that the text is indented</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-INVISIBLE:CAPS"></a>ATK_TEXT_ATTR_INVISIBLE</p></td>
<td class="enum_member_description">
<p>Either "true" or "false" indicating whether text is visible or not</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-EDITABLE:CAPS"></a>ATK_TEXT_ATTR_EDITABLE</p></td>
<td class="enum_member_description">
<p>Either "true" or "false" indicating whether text is editable or not</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-PIXELS-ABOVE-LINES:CAPS"></a>ATK_TEXT_ATTR_PIXELS_ABOVE_LINES</p></td>
<td class="enum_member_description">
<p>Pixels of blank space to leave above each newline-terminated line. </p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-PIXELS-BELOW-LINES:CAPS"></a>ATK_TEXT_ATTR_PIXELS_BELOW_LINES</p></td>
<td class="enum_member_description">
<p>Pixels of blank space to leave below each newline-terminated line.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-PIXELS-INSIDE-WRAP:CAPS"></a>ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP</p></td>
<td class="enum_member_description">
<p>Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph).</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-BG-FULL-HEIGHT:CAPS"></a>ATK_TEXT_ATTR_BG_FULL_HEIGHT</p></td>
<td class="enum_member_description">
<p>"true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-RISE:CAPS"></a>ATK_TEXT_ATTR_RISE</p></td>
<td class="enum_member_description">
<p>Number of pixels that the characters are risen above the baseline</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-UNDERLINE:CAPS"></a>ATK_TEXT_ATTR_UNDERLINE</p></td>
<td class="enum_member_description">
<p>"none", "single", "double", "low", or "error"</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-STRIKETHROUGH:CAPS"></a>ATK_TEXT_ATTR_STRIKETHROUGH</p></td>
<td class="enum_member_description">
<p>"true" or "false" whether the text is strikethrough </p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-SIZE:CAPS"></a>ATK_TEXT_ATTR_SIZE</p></td>
<td class="enum_member_description">
<p>The size of the characters in points. eg: 10</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-SCALE:CAPS"></a>ATK_TEXT_ATTR_SCALE</p></td>
<td class="enum_member_description">
<p>The scale of the characters. The value is a string representation of a double </p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-WEIGHT:CAPS"></a>ATK_TEXT_ATTR_WEIGHT</p></td>
<td class="enum_member_description">
<p>The weight of the characters.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-LANGUAGE:CAPS"></a>ATK_TEXT_ATTR_LANGUAGE</p></td>
<td class="enum_member_description">
<p>The language used</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-FAMILY-NAME:CAPS"></a>ATK_TEXT_ATTR_FAMILY_NAME</p></td>
<td class="enum_member_description">
<p>The font family name</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-BG-COLOR:CAPS"></a>ATK_TEXT_ATTR_BG_COLOR</p></td>
<td class="enum_member_description">
<p>The background color. The value is an RGB value of the format "<code class="literal">u</code>,<code class="literal">u</code>,<code class="literal">u</code>"</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-FG-COLOR:CAPS"></a>ATK_TEXT_ATTR_FG_COLOR</p></td>
<td class="enum_member_description">
<p>The foreground color. The value is an RGB value of the format "<code class="literal">u</code>,<code class="literal">u</code>,<code class="literal">u</code>"</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-BG-STIPPLE:CAPS"></a>ATK_TEXT_ATTR_BG_STIPPLE</p></td>
<td class="enum_member_description">
<p>"true" if a <span class="type">GdkBitmap</span> is set for stippling the background color.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-FG-STIPPLE:CAPS"></a>ATK_TEXT_ATTR_FG_STIPPLE</p></td>
<td class="enum_member_description">
<p>"true" if a <span class="type">GdkBitmap</span> is set for stippling the foreground color.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-WRAP-MODE:CAPS"></a>ATK_TEXT_ATTR_WRAP_MODE</p></td>
<td class="enum_member_description">
<p>The wrap mode of the text, if any. Values are "none", "char", "word", or "word_char".</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-DIRECTION:CAPS"></a>ATK_TEXT_ATTR_DIRECTION</p></td>
<td class="enum_member_description">
<p>The direction of the text, if set. Values are "none", "ltr" or "rtl" </p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-JUSTIFICATION:CAPS"></a>ATK_TEXT_ATTR_JUSTIFICATION</p></td>
<td class="enum_member_description">
<p>The justification of the text, if set. Values are "left", "right", "center" or "fill" </p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-STRETCH:CAPS"></a>ATK_TEXT_ATTR_STRETCH</p></td>
<td class="enum_member_description">
<p>The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded"</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-VARIANT:CAPS"></a>ATK_TEXT_ATTR_VARIANT</p></td>
<td class="enum_member_description">
<p>The capitalization variant of the text, if set. Values are "normal" or "small_caps"</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-STYLE:CAPS"></a>ATK_TEXT_ATTR_STYLE</p></td>
<td class="enum_member_description">
<p>The slant style of the text, if set. Values are "normal", "oblique" or "italic"</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-LAST-DEFINED:CAPS"></a>ATK_TEXT_ATTR_LAST_DEFINED</p></td>
<td class="enum_member_description">
<p>not a valid text attribute, used for finding end of enumeration</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="AtkText.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="AtkText-text-attributes-changed"></a><h3>The <code class="literal">“text-attributes-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The "text-attributes-changed" signal is emitted when the text
attributes of the text of an object which implements AtkText
changes.</p>
<div class="refsect3">
<a name="AtkText-text-attributes-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atktext</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AtkText-text-caret-moved"></a><h3>The <code class="literal">“text-caret-moved”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
<a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg1,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The "text-caret-moved" signal is emitted when the caret
position of the text of an object which implements AtkText
changes.</p>
<div class="refsect3">
<a name="AtkText-text-caret-moved.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atktext</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The new position of the text caret.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AtkText-text-changed"></a><h3>The <code class="literal">“text-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
<a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg1,
<a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg2,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The "text-changed" signal is emitted when the text of the
object which implements the AtkText interface changes, This
signal will have a detail which is either "insert" or
"delete" which identifies whether the text change was an
insertion or a deletion.</p>
<div class="warning">
<p><code class="literal">AtkText::text-changed</code> has been deprecated since version 2.9.4 and should not be used in newly-written code.</p>
<p>Use <span class="type">“text-insert”</span> or
<span class="type">“text-remove”</span> instead.</p>
</div>
<div class="refsect3">
<a name="AtkText-text-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atktext</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The position (character offset) of the insertion or deletion.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg2</p></td>
<td class="parameter_description"><p>The length (in characters) of text inserted or deleted.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AtkText-text-insert"></a><h3>The <code class="literal">“text-insert”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
<a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg1,
<a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg2,
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg3,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The "text-insert" signal is emitted when a new text is
inserted. If the signal was not triggered by the user
(e.g. typing or pasting text), the "system" detail should be
included.</p>
<div class="refsect3">
<a name="AtkText-text-insert.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atktext</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The position (character offset) of the insertion.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg2</p></td>
<td class="parameter_description"><p>The length (in characters) of text inserted.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg3</p></td>
<td class="parameter_description"><p>The new text inserted</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AtkText-text-remove"></a><h3>The <code class="literal">“text-remove”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
<a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg1,
<a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg2,
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg3,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The "text-remove" signal is emitted when a new text is
removed. If the signal was not triggered by the user
(e.g. typing or pasting text), the "system" detail should be
included.</p>
<div class="refsect3">
<a name="AtkText-text-remove.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atktext</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The position (character offset) of the removal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg2</p></td>
<td class="parameter_description"><p>The length (in characters) of text removed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg3</p></td>
<td class="parameter_description"><p>The old text removed</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AtkText-text-selection-changed"></a><h3>The <code class="literal">“text-selection-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The "text-selection-changed" signal is emitted when the
selected text of an object which implements AtkText changes.</p>
<div class="refsect3">
<a name="AtkText-text-selection-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atktext</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|