gtktextiter.sgml 8.51 KB
Newer Older
1
<!-- ##### SECTION Title ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
2
GtkTextIter
3 4

<!-- ##### SECTION Short_Description ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
5
Text buffer iterator
6 7

<!-- ##### SECTION Long_Description ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
8 9 10 11 12 13
<para>
You may wish to begin by reading the <link linkend="TextWidget">text widget
conceptual overview</link> which gives an overview of all the objects and data
types related to the text widget and how they work together.
</para>

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
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### STRUCT GtkTextBuffer ##### -->
<para>

</para>


<!-- ##### STRUCT GtkTextIter ##### -->
<para>

</para>

@dummy1: 
@dummy2: 
@dummy3: 
@dummy4: 
@dummy5: 
@dummy6: 
@dummy7: 
@dummy8: 
@dummy9: 
Havoc Pennington's avatar
Havoc Pennington committed
43 44 45
@dummy10: 
@dummy11: 
@dummy12: 
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

<!-- ##### FUNCTION gtk_text_iter_get_buffer ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_copy ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_free ##### -->
<para>

</para>

@iter: 


<!-- ##### FUNCTION gtk_text_iter_get_offset ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_get_line ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_get_line_offset ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_get_line_index ##### -->
<para>

</para>

@iter: 
@Returns: 


Havoc Pennington's avatar
Havoc Pennington committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
<!-- ##### FUNCTION gtk_text_iter_get_visible_line_index ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_get_visible_line_offset ##### -->
<para>

</para>

@iter: 
@Returns: 


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
<!-- ##### FUNCTION gtk_text_iter_get_char ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_get_slice ##### -->
<para>

</para>

@start: 
@end: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_get_text ##### -->
<para>

</para>

@start: 
@end: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_get_visible_slice ##### -->
<para>

</para>

@start: 
@end: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_get_visible_text ##### -->
<para>

</para>

@start: 
@end: 
@Returns: 


Havoc Pennington's avatar
Havoc Pennington committed
176
<!-- ##### FUNCTION gtk_text_iter_get_pixbuf ##### -->
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
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_get_marks ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_get_toggled_tags ##### -->
<para>

</para>

@iter: 
@toggled_on: 
@Returns: 


204 205 206 207 208 209 210 211 212
<!-- ##### FUNCTION gtk_text_iter_get_child_anchor ##### -->
<para>

</para>

@iter: 
@Returns: 


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
<!-- ##### FUNCTION gtk_text_iter_begins_tag ##### -->
<para>

</para>

@iter: 
@tag: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_ends_tag ##### -->
<para>

</para>

@iter: 
@tag: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_toggles_tag ##### -->
<para>

</para>

@iter: 
@tag: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_has_tag ##### -->
<para>

</para>

@iter: 
@tag: 
@Returns: 


253 254 255 256 257 258 259 260 261
<!-- ##### FUNCTION gtk_text_iter_get_tags ##### -->
<para>

</para>

@iter: 
@Returns: 


262 263 264 265 266 267 268 269 270 271
<!-- ##### FUNCTION gtk_text_iter_editable ##### -->
<para>

</para>

@iter: 
@default_setting: 
@Returns: 


Owen Taylor's avatar
Owen Taylor committed
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
<!-- ##### FUNCTION gtk_text_iter_starts_word ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_ends_word ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_inside_word ##### -->
<para>

</para>

@iter: 
@Returns: 


299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
<!-- ##### FUNCTION gtk_text_iter_starts_line ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_ends_line ##### -->
<para>

</para>

@iter: 
@Returns: 


Havoc Pennington's avatar
Havoc Pennington committed
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
<!-- ##### FUNCTION gtk_text_iter_starts_sentence ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_ends_sentence ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_inside_sentence ##### -->
<para>

</para>

@iter: 
@Returns: 


Owen Taylor's avatar
Owen Taylor committed
344 345 346 347 348 349 350 351 352
<!-- ##### FUNCTION gtk_text_iter_is_cursor_position ##### -->
<para>

</para>

@iter: 
@Returns: 


353 354 355 356 357 358 359 360 361
<!-- ##### FUNCTION gtk_text_iter_get_chars_in_line ##### -->
<para>

</para>

@iter: 
@Returns: 


Owen Taylor's avatar
Owen Taylor committed
362 363 364 365 366 367 368 369 370
<!-- ##### FUNCTION gtk_text_iter_get_bytes_in_line ##### -->
<para>

</para>

@iter: 
@Returns: 


371 372 373 374 375 376 377 378 379 380
<!-- ##### FUNCTION gtk_text_iter_get_attributes ##### -->
<para>

</para>

@iter: 
@values: 
@Returns: 


Owen Taylor's avatar
Owen Taylor committed
381 382 383 384 385 386 387 388 389
<!-- ##### FUNCTION gtk_text_iter_get_language ##### -->
<para>

</para>

@iter: 
@Returns: 


Havoc Pennington's avatar
Havoc Pennington committed
390 391 392 393 394 395 396
<!-- ##### FUNCTION gtk_text_iter_is_end ##### -->
<para>

</para>

@iter: 
@Returns: 
397 398


Havoc Pennington's avatar
Havoc Pennington committed
399 400 401 402 403 404 405 406 407
<!-- ##### FUNCTION gtk_text_iter_is_start ##### -->
<para>

</para>

@iter: 
@Returns: 


Owen Taylor's avatar
Owen Taylor committed
408
<!-- ##### FUNCTION gtk_text_iter_forward_char ##### -->
409 410 411 412 413 414 415 416
<para>

</para>

@iter: 
@Returns: 


Owen Taylor's avatar
Owen Taylor committed
417
<!-- ##### FUNCTION gtk_text_iter_backward_char ##### -->
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
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_forward_chars ##### -->
<para>

</para>

@iter: 
@count: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_backward_chars ##### -->
<para>

</para>

@iter: 
@count: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_forward_line ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_backward_line ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_forward_lines ##### -->
<para>

</para>

@iter: 
@count: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_backward_lines ##### -->
<para>

</para>

@iter: 
@count: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_forward_word_ends ##### -->
<para>

</para>

@iter: 
@count: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_backward_word_starts ##### -->
<para>

</para>

@iter: 
@count: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_forward_word_end ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_backward_word_start ##### -->
<para>

</para>

@iter: 
@Returns: 


Owen Taylor's avatar
Owen Taylor committed
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
<!-- ##### FUNCTION gtk_text_iter_forward_cursor_position ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_backward_cursor_position ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_forward_cursor_positions ##### -->
<para>

</para>

@iter: 
@count: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_backward_cursor_positions ##### -->
<para>

</para>

@iter: 
@count: 
@Returns: 


Havoc Pennington's avatar
Havoc Pennington committed
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
<!-- ##### FUNCTION gtk_text_iter_backward_sentence_start ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_backward_sentence_starts ##### -->
<para>

</para>

@iter: 
@count: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_forward_sentence_end ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_forward_sentence_ends ##### -->
<para>

</para>

@iter: 
@count: 
@Returns: 


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
<!-- ##### FUNCTION gtk_text_iter_set_offset ##### -->
<para>

</para>

@iter: 
@char_offset: 


<!-- ##### FUNCTION gtk_text_iter_set_line ##### -->
<para>

</para>

@iter: 
@line_number: 


<!-- ##### FUNCTION gtk_text_iter_set_line_offset ##### -->
<para>

</para>

@iter: 
@char_on_line: 


625 626 627 628 629 630 631 632 633
<!-- ##### FUNCTION gtk_text_iter_set_line_index ##### -->
<para>

</para>

@iter: 
@byte_on_line: 


Havoc Pennington's avatar
Havoc Pennington committed
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
<!-- ##### FUNCTION gtk_text_iter_set_visible_line_index ##### -->
<para>

</para>

@iter: 
@byte_on_line: 


<!-- ##### FUNCTION gtk_text_iter_set_visible_line_offset ##### -->
<para>

</para>

@iter: 
@char_on_line: 


652 653 654 655 656 657 658 659
<!-- ##### FUNCTION gtk_text_iter_forward_to_end ##### -->
<para>

</para>

@iter: 


Owen Taylor's avatar
Owen Taylor committed
660
<!-- ##### FUNCTION gtk_text_iter_forward_to_line_end ##### -->
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
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_forward_to_tag_toggle ##### -->
<para>

</para>

@iter: 
@tag: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_backward_to_tag_toggle ##### -->
<para>

</para>

@iter: 
@tag: 
@Returns: 


<!-- ##### USER_FUNCTION GtkTextCharPredicate ##### -->
<para>

</para>

@ch: 
@user_data: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_forward_find_char ##### -->
<para>

</para>

@iter: 
@pred: 
@user_data: 
707
@limit: 
708 709 710 711 712 713 714 715 716 717 718
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_backward_find_char ##### -->
<para>

</para>

@iter: 
@pred: 
@user_data: 
719
@limit: 
720 721 722 723 724 725 726 727 728 729 730 731
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_forward_search ##### -->
<para>

</para>

@iter: 
@str: 
@visible_only: 
@slice: 
Havoc Pennington's avatar
Havoc Pennington committed
732 733
@match_start: 
@match_end: 
734
@limit: 
735 736 737 738 739 740 741 742 743 744 745 746
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_backward_search ##### -->
<para>

</para>

@iter: 
@str: 
@visible_only: 
@slice: 
747 748
@match_start: 
@match_end: 
749
@limit: 
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_equal ##### -->
<para>

</para>

@lhs: 
@rhs: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_compare ##### -->
<para>

</para>

@lhs: 
@rhs: 
@Returns: 


Havoc Pennington's avatar
Havoc Pennington committed
773
<!-- ##### FUNCTION gtk_text_iter_in_range ##### -->
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
<para>

</para>

@iter: 
@start: 
@end: 
@Returns: 


<!-- ##### FUNCTION gtk_text_iter_spew ##### -->
<para>

</para>

@iter: 
@desc: