/usr/share/gtk-doc/html/libatspi/libatspi-atspi-text.html is in at-spi2-doc 2.10.2.is.2.10.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>atspi-text</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="ch01.html" title="API reference">
<link rel="next" href="AtspiStateSet.html" title="atspi-stateset">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libatspi Reference Manual</th>
<td><a accesskey="n" href="AtspiStateSet.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libatspi-atspi-text.synopsis" class="shortcut">Top</a>
|
<a href="#libatspi-atspi-text.description" class="shortcut">Description</a>
|
<a href="#libatspi-atspi-text.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#libatspi-atspi-text.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="libatspi-atspi-text"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-text.top_of_page"></a>atspi-text</span></h2>
<p>atspi-text — An interface implemented by objects which place textual
information onscreen.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libatspi-atspi-text.synopsis"></a><h2>Synopsis</h2>
<a name="AtspiRange"></a><a name="AtspiTextRange"></a><a name="AtspiText"></a><pre class="synopsis">struct <a class="link" href="libatspi-atspi-text.html#AtspiRange-struct" title="struct AtspiRange">AtspiRange</a>;
#define <a class="link" href="libatspi-atspi-text.html#ATSPI-TYPE-RANGE:CAPS" title="ATSPI_TYPE_RANGE">ATSPI_TYPE_RANGE</a>
<a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> * <a class="link" href="libatspi-atspi-text.html#atspi-range-copy" title="atspi_range_copy ()">atspi_range_copy</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> *src</code></em>);
struct <a class="link" href="libatspi-atspi-text.html#AtspiTextRange-struct" title="struct AtspiTextRange">AtspiTextRange</a>;
#define <a class="link" href="libatspi-atspi-text.html#ATSPI-TYPE-TEXT-RANGE:CAPS" title="ATSPI_TYPE_TEXT_RANGE">ATSPI_TYPE_TEXT_RANGE</a>
<span class="returnvalue">GType</span> <a class="link" href="libatspi-atspi-text.html#atspi-text-get-type" title="atspi_text_get_type ()">atspi_text_get_type</a> ();
<a class="link" href="libatspi-atspi-text.html#AtspiText-struct" title="AtspiText">AtspiText</a>;
<span class="returnvalue">GType</span> <a class="link" href="libatspi-atspi-text.html#atspi-text-range-get-type" title="atspi_text_range_get_type ()">atspi_text_range_get_type</a> ();
<span class="returnvalue">gint</span> <a class="link" href="libatspi-atspi-text.html#atspi-text-get-character-count" title="atspi_text_get_character_count ()">atspi_text_get_character_count</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libatspi-atspi-text.html#atspi-text-get-text" title="atspi_text_get_text ()">atspi_text_get_text</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="libatspi-atspi-text.html#atspi-text-get-caret-offset" title="atspi_text_get_caret_offset ()">atspi_text_get_caret_offset</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GHashTable</span> * <a class="link" href="libatspi-atspi-text.html#atspi-text-get-attributes" title="atspi_text_get_attributes ()">atspi_text_get_attributes</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GHashTable</span> * <a class="link" href="libatspi-atspi-text.html#atspi-text-get-attribute-run" title="atspi_text_get_attribute_run ()">atspi_text_get_attribute_run</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> include_defaults</code></em>,
<em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libatspi-atspi-text.html#atspi-text-get-attribute-value" title="atspi_text_get_attribute_value ()">atspi_text_get_attribute_value</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *attribute_name</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GHashTable</span> * <a class="link" href="libatspi-atspi-text.html#atspi-text-get-default-attributes" title="atspi_text_get_default_attributes ()">atspi_text_get_default_attributes</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-text.html#atspi-text-set-caret-offset" title="atspi_text_set_caret_offset ()">atspi_text_set_caret_offset</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> * <a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-before-offset" title="atspi_text_get_text_before_offset ()">atspi_text_get_text_before_offset</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> * <a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-at-offset" title="atspi_text_get_text_at_offset ()">atspi_text_get_text_at_offset</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> * <a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-after-offset" title="atspi_text_get_text_after_offset ()">atspi_text_get_text_after_offset</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="libatspi-atspi-text.html#atspi-text-get-character-at-offset" title="atspi_text_get_character_at_offset ()">atspi_text_get_character_at_offset</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> * <a class="link" href="libatspi-atspi-text.html#atspi-text-get-character-extents" title="atspi_text_get_character_extents ()">atspi_text_get_character_extents</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="libatspi-atspi-text.html#atspi-text-get-offset-at-point" title="atspi_text_get_offset_at_point ()">atspi_text_get_offset_at_point</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> * <a class="link" href="libatspi-atspi-text.html#atspi-text-get-range-extents" title="atspi_text_get_range_extents ()">atspi_text_get_range_extents</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GArray</span> * <a class="link" href="libatspi-atspi-text.html#atspi-text-get-bounded-ranges" title="atspi_text_get_bounded_ranges ()">atspi_text_get_bounded_ranges</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
<em class="parameter"><code><span class="type">gint</span> height</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> type</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a> clipTypeX</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a> clipTypeY</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="libatspi-atspi-text.html#atspi-text-get-n-selections" title="atspi_text_get_n_selections ()">atspi_text_get_n_selections</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> * <a class="link" href="libatspi-atspi-text.html#atspi-text-get-selection" title="atspi_text_get_selection ()">atspi_text_get_selection</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-text.html#atspi-text-add-selection" title="atspi_text_add_selection ()">atspi_text_add_selection</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-text.html#atspi-text-remove-selection" title="atspi_text_remove_selection ()">atspi_text_remove_selection</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-text.html#atspi-text-set-selection" title="atspi_text_set_selection ()">atspi_text_set_selection</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-text.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GBoxed
+----AtspiRange
</pre>
<pre class="synopsis">
GBoxed
+----AtspiTextRange
</pre>
<pre class="synopsis">
GInterface
+----AtspiText
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-text.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiText is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-text.description"></a><h2>Description</h2>
<p>
The text interface should be implemented by objects which place textual
information onscreen as character strings or glyphs. The text interface
allows access to textual content including display attributes and
semantic hints associated with runs of text, and to bounding boc
information for glyphs and substrings. It also alows portions of text to
be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT.
</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-text.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiRange-struct"></a><h3>struct AtspiRange</h3>
<pre class="programlisting">struct AtspiRange {
gint start_offset;
gint end_offset;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-TYPE-RANGE:CAPS"></a><h3>ATSPI_TYPE_RANGE</h3>
<pre class="programlisting">#define ATSPI_TYPE_RANGE atspi_range_get_type ()
</pre>
<p>
The <span class="type">GType</span> for a boxed type holding a range within a text bock.
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-range-copy"></a><h3>atspi_range_copy ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> * atspi_range_copy (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> *src</code></em>);</pre>
<p>
Gets a copy of an <a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
<td>a pointer to the source <a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> object that will be copied.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> copy of an <a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="type">AtspiRange</span></a> object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AtspiTextRange-struct"></a><h3>struct AtspiTextRange</h3>
<pre class="programlisting">struct AtspiTextRange {
gint start_offset;
gint end_offset;
gchar *content;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-TYPE-TEXT-RANGE:CAPS"></a><h3>ATSPI_TYPE_TEXT_RANGE</h3>
<pre class="programlisting">#define ATSPI_TYPE_TEXT_RANGE atspi_text_range_get_type ()
</pre>
<p>
The <span class="type">GType</span> for a boxed type holding a range within a text bock.
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-type"></a><h3>atspi_text_get_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span> atspi_text_get_type ();</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiText-struct"></a><h3>AtspiText</h3>
<pre class="programlisting">typedef struct _AtspiText AtspiText;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-range-get-type"></a><h3>atspi_text_range_get_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span> atspi_text_range_get_type ();</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-character-count"></a><h3>atspi_text_get_character_count ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> atspi_text_get_character_count (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the character count of an <span class="type">AccessibleText</span> object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">gint</span> indicating the total number of
characters in the <span class="type">AccessibleText</span> object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-text"></a><h3>atspi_text_get_text ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * atspi_text_get_text (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets a range of text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object. The number of bytes
in the returned string may exceed either end_offset or start_offset, since
UTF-8 is a variable-width encoding.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the start of the desired text range.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the first character past the desired range.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a text string containing characters from <em class="parameter"><code>start_offset</code></em>
to <em class="parameter"><code>end_offset</code></em>-1, inclusive, encoded as UTF-8.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-caret-offset"></a><h3>atspi_text_get_caret_offset ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> atspi_text_get_caret_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the current offset of the text caret in an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">gint</span> indicating the current position of the text caret.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-attributes"></a><h3>atspi_text_get_attributes ()</h3>
<pre class="programlisting"><span class="returnvalue">GHashTable</span> * atspi_text_get_attributes (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">atspi_text_get_attributes</code> has been deprecated since version 2.10 and should not be used in newly-written code. Use atspi_text_get_text_attributes instead.
Rename to: atspi_text_get_text_attributes</p>
</div>
<p>
Gets the attributes applied to a range of text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a>
object. The text attributes correspond to CSS attributes
where possible.
<span style="color: red"><em>DEPRECATED</em></span>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the offset from which the attribute
search is based.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> pointer indicating the start of the desired text
range. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> pointer indicating the first character past the desired
range. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">GHashTable</span>
describing the attributes at the given character offset. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-attribute-run"></a><h3>atspi_text_get_attribute_run ()</h3>
<pre class="programlisting"><span class="returnvalue">GHashTable</span> * atspi_text_get_attribute_run (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> include_defaults</code></em>,
<em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets a set of attributes applied to a range of text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object, optionally
including its 'default' attributes.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the offset from which the attribute
search is based.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>include_defaults</code></em> :</span></p></td>
<td>a <span class="type">bool</span> that, when set as <span class="type">FALSE</span>, indicates the call
should only return those attributes which are explicitly set on the current
attribute run, omitting any attributes which are inherited from the
default values.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> pointer indicating the start of the desired text
range. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> pointer indicating the first character past the desired
range. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">GHashTable</span> with attributes
defined at the indicated offset, optionally including the 'default' ones. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-attribute-value"></a><h3>atspi_text_get_attribute_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * atspi_text_get_attribute_value (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *attribute_name</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">atspi_text_get_attribute_value</code> has been deprecated since version 2.10 and should not be used in newly-written code. Use atspi_text_get_text_attribute_value instead.
Rename to: atspi_text_get_text_attribute_value</p>
</div>
<p>
Gets the value of a named attribute at a given offset.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>The character offset at which to query the attribute.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>attribute_name</code></em> :</span></p></td>
<td>The attribute to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of a given attribute at the given offset, or NULL if
not present.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-default-attributes"></a><h3>atspi_text_get_default_attributes ()</h3>
<pre class="programlisting"><span class="returnvalue">GHashTable</span> * atspi_text_get_default_attributes (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the default attributes applied to an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a>
object. The text attributes correspond to CSS attributes
where possible. The combination of this attribute set and
the attributes reported by <a class="link" href="libatspi-atspi-text.html#atspi-text-get-attributes" title="atspi_text_get_attributes ()"><span class="type">atspi_text_get_attributes</span></a>
describes the entire set of text attributes over a range.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">GHashTable</span>
containing the default attributes applied to a text object,
(exclusive of explicitly-set attributes), encoded as UTF-8. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-set-caret-offset"></a><h3>atspi_text_set_caret_offset ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_text_set_caret_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> new_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Moves the text caret to a given position.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_offset</code></em> :</span></p></td>
<td>the offset to which the text caret is to be moved.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-text-before-offset"></a><h3>atspi_text_get_text_before_offset ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> * atspi_text_get_text_before_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets delimited text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object which precedes a given
text offset.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the offset from which the delimiter
search is based.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> indicating whether the desired
text string is a word, sentence, line, or attribute run.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="type">AtspiTextRange</span></a> containing a UTF-8 string representing the
delimited text, both of whose delimiting boundaries are before the
current offset, or an empty string if no such text exists.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-text-at-offset"></a><h3>atspi_text_get_text_at_offset ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> * atspi_text_get_text_at_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">atspi_text_get_text_at_offset</code> has been deprecated since version 2.10 and should not be used in newly-written code. Use atspi_text_get_string_at_offset.</p>
</div>
<p>
Gets delimited text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object which includes a given
text offset.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the offset from which the delimiter
search is based.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> indicating whether the desired
text string is a word, sentence, line, or attribute run.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="type">AtspiTextRange</span></a> containing a UTF-8 string representing the
delimited text, whose delimiting boundaries bracket the
current offset, or an empty string if no such text exists.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-text-after-offset"></a><h3>atspi_text_get_text_after_offset ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="returnvalue">AtspiTextRange</span></a> * atspi_text_get_text_after_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets delimited text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object which follows a given
text offset.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the offset from which the delimiter
search is based.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a> indicating whether the desired
text string is a word, sentence, line, or attribute run.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="type">AtspiTextRange</span></a> containing a UTF-8 string representing the
delimited text, both of whose delimiting boundaries are after or
inclusive of the current offset, or an empty string if no such
text exists.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-character-at-offset"></a><h3>atspi_text_get_character_at_offset ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> atspi_text_get_character_at_offset (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the character at a given offset for an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the text offset where the desired
character is located.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">guint</span> representing the
UCS-4 unicode code point of the given character, or
0xFFFFFFFF if the character in question cannot be represented
in the UCS-4 encoding.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-character-extents"></a><h3>atspi_text_get_character_extents ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> * atspi_text_get_character_extents (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets a bounding box containing the glyph representing
the character at a particular text offset.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the offset of the text character for
whom boundary information is requested.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>an <span class="type">AccessibleCoordType</span> indicating the coordinate system to use
for the returned values.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> specifying the position and size of the character.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-offset-at-point"></a><h3>atspi_text_get_offset_at_point ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> atspi_text_get_offset_at_point (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the character offset into the text at a given point.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>the x coordinate of the point to be queried.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>the y coordinate of the point to be queried.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>an <a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> indicating the coordinate system in which
the values should be returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the offset (as a <span class="type">gint</span>) at the point (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>)
in the specified coordinate system.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-range-extents"></a><h3>atspi_text_get_range_extents ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> * atspi_text_get_range_extents (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the bounding box for text within a range in an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the offset of the first text character for
whom boundary information is requested.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the offset of the text character
after the last character for whom boundary information is requested.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>an <a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> indicating the coordinate system to use
for the returned values.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> giving the position and size of the specified range
of text.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-bounded-ranges"></a><h3>atspi_text_get_bounded_ranges ()</h3>
<pre class="programlisting"><span class="returnvalue">GArray</span> * atspi_text_get_bounded_ranges (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
<em class="parameter"><code><span class="type">gint</span> height</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> type</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a> clipTypeX</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a> clipTypeY</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the ranges of text from an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object which lie within the
bounds defined by (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>) and (<em class="parameter"><code>x</code></em>+<em class="parameter"><code>width</code></em>, <em class="parameter"><code>y</code></em>+<em class="parameter"><code>height</code></em>).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>the 'starting' x coordinate of the bounding box.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>the 'starting' y coordinate of the bounding box.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>the x extent of the bounding box.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>the y extent of the bounding box.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>an <span class="type">AccessibleCoordType</span> indicating the coordinate system to use
for the returned values.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>clipTypeX</code></em> :</span></p></td>
<td>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a> indicating how to treat characters that
intersect the bounding box's x extents.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>clipTypeY</code></em> :</span></p></td>
<td>an <a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a> indicating how to treat characters that
intersect the bounding box's y extents.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a null-terminated list of
pointers to <a class="link" href="libatspi-atspi-text.html#AtspiTextRange"><span class="type">AtspiTextRange</span></a> structs detailing the bounded text. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiTextRange*]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-n-selections"></a><h3>atspi_text_get_n_selections ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> atspi_text_get_n_selections (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the number of active non-contiguous selections for an
<a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">gint</span> indicating the current
number of non-contiguous text selections active
within an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-get-selection"></a><h3>atspi_text_get_selection ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiRange"><span class="returnvalue">AtspiRange</span></a> * atspi_text_get_selection (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the bounds of the <em class="parameter"><code>selection_num</code></em>-th active text selection for an
<a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>selection_num</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating which selection to query.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-add-selection"></a><h3>atspi_text_add_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_text_add_selection (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Selects some text (adds a text selection) in an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
<td>the starting offset of the desired new selection.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
<td>the offset of the first character after the new selection.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-remove-selection"></a><h3>atspi_text_remove_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_text_remove_selection (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
De-selects a text selection.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>selection_num</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating which text selection to remove.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-text-set-selection"></a><h3>atspi_text_set_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_text_set_selection (<em class="parameter"><code><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Changes the bounds of an existing <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> text selection.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>selection_num</code></em> :</span></p></td>
<td>a zero-offset index indicating which text selection to modify.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the new starting offset for the selection.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the desired new offset of the first character
after the selection.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|