Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtktextiter.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkTextIter
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Text buffer iterator
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 You may wish to begin by reading the <link linkend="TextWidget">text widget
  10 conceptual overview</link> which gives an overview of all the objects and data
  11 types related to the text widget and how they work together.
  12 </para>
  13
  14 <para>
  15
  16 </para>
  17
  18 <!-- ##### SECTION See_Also ##### -->
  19 <para>
  20
  21 </para>
  22
  23 <!-- ##### SECTION Stability_Level ##### -->
  24
  25
  26 <!-- ##### STRUCT GtkTextIter ##### -->
  27 <para>
  28
  29 </para>
  30
  31
  32 <!-- ##### FUNCTION gtk_text_iter_get_buffer ##### -->
  33 <para>
  34
  35 </para>
  36
  37 @iter:
  38 @Returns:
  39
  40
  41 <!-- ##### FUNCTION gtk_text_iter_copy ##### -->
  42 <para>
  43
  44 </para>
  45
  46 @iter:
  47 @Returns:
  48
  49
  50 <!-- ##### FUNCTION gtk_text_iter_free ##### -->
  51 <para>
  52
  53 </para>
  54
  55 @iter:
  56
  57
  58 <!-- ##### FUNCTION gtk_text_iter_get_offset ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @iter:
  64 @Returns:
  65
  66
  67 <!-- ##### FUNCTION gtk_text_iter_get_line ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @iter:
  73 @Returns:
  74
  75
  76 <!-- ##### FUNCTION gtk_text_iter_get_line_offset ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @iter:
  82 @Returns:
  83
  84
  85 <!-- ##### FUNCTION gtk_text_iter_get_line_index ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @iter:
  91 @Returns:
  92
  93
  94 <!-- ##### FUNCTION gtk_text_iter_get_visible_line_index ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @iter:
 100 @Returns:
 101
 102
 103 <!-- ##### FUNCTION gtk_text_iter_get_visible_line_offset ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @iter:
 109 @Returns:
 110
 111
 112 <!-- ##### FUNCTION gtk_text_iter_get_char ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @iter:
 118 @Returns:
 119
 120
 121 <!-- ##### FUNCTION gtk_text_iter_get_slice ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @start:
 127 @end:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION gtk_text_iter_get_text ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @start:
 137 @end:
 138 @Returns:
 139
 140
 141 <!-- ##### FUNCTION gtk_text_iter_get_visible_slice ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @start:
 147 @end:
 148 @Returns:
 149
 150
 151 <!-- ##### FUNCTION gtk_text_iter_get_visible_text ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @start:
 157 @end:
 158 @Returns:
 159
 160
 161 <!-- ##### FUNCTION gtk_text_iter_get_pixbuf ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @iter:
 167 @Returns:
 168
 169
 170 <!-- ##### FUNCTION gtk_text_iter_get_marks ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @iter:
 176 @Returns:
 177
 178
 179 <!-- ##### FUNCTION gtk_text_iter_get_toggled_tags ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @iter:
 185 @toggled_on:
 186 @Returns:
 187
 188
 189 <!-- ##### FUNCTION gtk_text_iter_get_child_anchor ##### -->
 190 <para>
 191
 192 </para>
 193
 194 @iter:
 195 @Returns:
 196
 197
 198 <!-- ##### FUNCTION gtk_text_iter_begins_tag ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @iter:
 204 @tag:
 205 @Returns:
 206
 207
 208 <!-- ##### FUNCTION gtk_text_iter_ends_tag ##### -->
 209 <para>
 210
 211 </para>
 212
 213 @iter:
 214 @tag:
 215 @Returns:
 216
 217
 218 <!-- ##### FUNCTION gtk_text_iter_toggles_tag ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @iter:
 224 @tag:
 225 @Returns:
 226
 227
 228 <!-- ##### FUNCTION gtk_text_iter_has_tag ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @iter:
 234 @tag:
 235 @Returns:
 236
 237
 238 <!-- ##### FUNCTION gtk_text_iter_get_tags ##### -->
 239 <para>
 240
 241 </para>
 242
 243 @iter:
 244 @Returns:
 245
 246
 247 <!-- ##### FUNCTION gtk_text_iter_editable ##### -->
 248 <para>
 249
 250 </para>
 251
 252 @iter:
 253 @default_setting:
 254 @Returns:
 255
 256
 257 <!-- ##### FUNCTION gtk_text_iter_can_insert ##### -->
 258 <para>
 259
 260 </para>
 261
 262 @iter:
 263 @default_editability:
 264 @Returns:
 265
 266
 267 <!-- ##### FUNCTION gtk_text_iter_starts_word ##### -->
 268 <para>
 269
 270 </para>
 271
 272 @iter:
 273 @Returns:
 274
 275
 276 <!-- ##### FUNCTION gtk_text_iter_ends_word ##### -->
 277 <para>
 278
 279 </para>
 280
 281 @iter:
 282 @Returns:
 283
 284
 285 <!-- ##### FUNCTION gtk_text_iter_inside_word ##### -->
 286 <para>
 287
 288 </para>
 289
 290 @iter:
 291 @Returns:
 292
 293
 294 <!-- ##### FUNCTION gtk_text_iter_starts_line ##### -->
 295 <para>
 296
 297 </para>
 298
 299 @iter:
 300 @Returns:
 301
 302
 303 <!-- ##### FUNCTION gtk_text_iter_ends_line ##### -->
 304 <para>
 305
 306 </para>
 307
 308 @iter:
 309 @Returns:
 310
 311
 312 <!-- ##### FUNCTION gtk_text_iter_starts_sentence ##### -->
 313 <para>
 314
 315 </para>
 316
 317 @iter:
 318 @Returns:
 319
 320
 321 <!-- ##### FUNCTION gtk_text_iter_ends_sentence ##### -->
 322 <para>
 323
 324 </para>
 325
 326 @iter:
 327 @Returns:
 328
 329
 330 <!-- ##### FUNCTION gtk_text_iter_inside_sentence ##### -->
 331 <para>
 332
 333 </para>
 334
 335 @iter:
 336 @Returns:
 337
 338
 339 <!-- ##### FUNCTION gtk_text_iter_is_cursor_position ##### -->
 340 <para>
 341
 342 </para>
 343
 344 @iter:
 345 @Returns:
 346
 347
 348 <!-- ##### FUNCTION gtk_text_iter_get_chars_in_line ##### -->
 349 <para>
 350
 351 </para>
 352
 353 @iter:
 354 @Returns:
 355
 356
 357 <!-- ##### FUNCTION gtk_text_iter_get_bytes_in_line ##### -->
 358 <para>
 359
 360 </para>
 361
 362 @iter:
 363 @Returns:
 364
 365
 366 <!-- ##### FUNCTION gtk_text_iter_get_attributes ##### -->
 367 <para>
 368
 369 </para>
 370
 371 @iter:
 372 @values:
 373 @Returns:
 374
 375
 376 <!-- ##### FUNCTION gtk_text_iter_get_language ##### -->
 377 <para>
 378
 379 </para>
 380
 381 @iter:
 382 @Returns:
 383
 384
 385 <!-- ##### FUNCTION gtk_text_iter_is_end ##### -->
 386 <para>
 387
 388 </para>
 389
 390 @iter:
 391 @Returns:
 392
 393
 394 <!-- ##### FUNCTION gtk_text_iter_is_start ##### -->
 395 <para>
 396
 397 </para>
 398
 399 @iter:
 400 @Returns:
 401
 402
 403 <!-- ##### FUNCTION gtk_text_iter_forward_char ##### -->
 404 <para>
 405
 406 </para>
 407
 408 @iter:
 409 @Returns:
 410
 411
 412 <!-- ##### FUNCTION gtk_text_iter_backward_char ##### -->
 413 <para>
 414
 415 </para>
 416
 417 @iter:
 418 @Returns:
 419
 420
 421 <!-- ##### FUNCTION gtk_text_iter_forward_chars ##### -->
 422 <para>
 423
 424 </para>
 425
 426 @iter:
 427 @count:
 428 @Returns:
 429
 430
 431 <!-- ##### FUNCTION gtk_text_iter_backward_chars ##### -->
 432 <para>
 433
 434 </para>
 435
 436 @iter:
 437 @count:
 438 @Returns:
 439
 440
 441 <!-- ##### FUNCTION gtk_text_iter_forward_line ##### -->
 442 <para>
 443
 444 </para>
 445
 446 @iter:
 447 @Returns:
 448
 449
 450 <!-- ##### FUNCTION gtk_text_iter_backward_line ##### -->
 451 <para>
 452
 453 </para>
 454
 455 @iter:
 456 @Returns:
 457
 458
 459 <!-- ##### FUNCTION gtk_text_iter_forward_lines ##### -->
 460 <para>
 461
 462 </para>
 463
 464 @iter:
 465 @count:
 466 @Returns:
 467
 468
 469 <!-- ##### FUNCTION gtk_text_iter_backward_lines ##### -->
 470 <para>
 471
 472 </para>
 473
 474 @iter:
 475 @count:
 476 @Returns:
 477
 478
 479 <!-- ##### FUNCTION gtk_text_iter_forward_word_ends ##### -->
 480 <para>
 481
 482 </para>
 483
 484 @iter:
 485 @count:
 486 @Returns:
 487
 488
 489 <!-- ##### FUNCTION gtk_text_iter_backward_word_starts ##### -->
 490 <para>
 491
 492 </para>
 493
 494 @iter:
 495 @count:
 496 @Returns:
 497
 498
 499 <!-- ##### FUNCTION gtk_text_iter_forward_word_end ##### -->
 500 <para>
 501
 502 </para>
 503
 504 @iter:
 505 @Returns:
 506
 507
 508 <!-- ##### FUNCTION gtk_text_iter_backward_word_start ##### -->
 509 <para>
 510
 511 </para>
 512
 513 @iter:
 514 @Returns:
 515
 516
 517 <!-- ##### FUNCTION gtk_text_iter_forward_cursor_position ##### -->
 518 <para>
 519
 520 </para>
 521
 522 @iter:
 523 @Returns:
 524
 525
 526 <!-- ##### FUNCTION gtk_text_iter_backward_cursor_position ##### -->
 527 <para>
 528
 529 </para>
 530
 531 @iter:
 532 @Returns:
 533
 534
 535 <!-- ##### FUNCTION gtk_text_iter_forward_cursor_positions ##### -->
 536 <para>
 537
 538 </para>
 539
 540 @iter:
 541 @count:
 542 @Returns:
 543
 544
 545 <!-- ##### FUNCTION gtk_text_iter_backward_cursor_positions ##### -->
 546 <para>
 547
 548 </para>
 549
 550 @iter:
 551 @count:
 552 @Returns:
 553
 554
 555 <!-- ##### FUNCTION gtk_text_iter_backward_sentence_start ##### -->
 556 <para>
 557
 558 </para>
 559
 560 @iter:
 561 @Returns:
 562
 563
 564 <!-- ##### FUNCTION gtk_text_iter_backward_sentence_starts ##### -->
 565 <para>
 566
 567 </para>
 568
 569 @iter:
 570 @count:
 571 @Returns:
 572
 573
 574 <!-- ##### FUNCTION gtk_text_iter_forward_sentence_end ##### -->
 575 <para>
 576
 577 </para>
 578
 579 @iter:
 580 @Returns:
 581
 582
 583 <!-- ##### FUNCTION gtk_text_iter_forward_sentence_ends ##### -->
 584 <para>
 585
 586 </para>
 587
 588 @iter:
 589 @count:
 590 @Returns:
 591
 592
 593 <!-- ##### FUNCTION gtk_text_iter_forward_visible_word_ends ##### -->
 594 <para>
 595
 596 </para>
 597
 598 @iter:
 599 @count:
 600 @Returns:
 601
 602
 603 <!-- ##### FUNCTION gtk_text_iter_backward_visible_word_starts ##### -->
 604 <para>
 605
 606 </para>
 607
 608 @iter:
 609 @count:
 610 @Returns:
 611
 612
 613 <!-- ##### FUNCTION gtk_text_iter_forward_visible_word_end ##### -->
 614 <para>
 615
 616 </para>
 617
 618 @iter:
 619 @Returns:
 620
 621
 622 <!-- ##### FUNCTION gtk_text_iter_backward_visible_word_start ##### -->
 623 <para>
 624
 625 </para>
 626
 627 @iter:
 628 @Returns:
 629
 630
 631 <!-- ##### FUNCTION gtk_text_iter_forward_visible_cursor_position ##### -->
 632 <para>
 633
 634 </para>
 635
 636 @iter:
 637 @Returns:
 638
 639
 640 <!-- ##### FUNCTION gtk_text_iter_backward_visible_cursor_position ##### -->
 641 <para>
 642
 643 </para>
 644
 645 @iter:
 646 @Returns:
 647
 648
 649 <!-- ##### FUNCTION gtk_text_iter_forward_visible_cursor_positions ##### -->
 650 <para>
 651
 652 </para>
 653
 654 @iter:
 655 @count:
 656 @Returns:
 657
 658
 659 <!-- ##### FUNCTION gtk_text_iter_backward_visible_cursor_positions ##### -->
 660 <para>
 661
 662 </para>
 663
 664 @iter:
 665 @count:
 666 @Returns:
 667
 668
 669 <!-- ##### FUNCTION gtk_text_iter_forward_visible_line ##### -->
 670 <para>
 671
 672 </para>
 673
 674 @iter:
 675 @Returns:
 676
 677
 678 <!-- ##### FUNCTION gtk_text_iter_backward_visible_line ##### -->
 679 <para>
 680
 681 </para>
 682
 683 @iter:
 684 @Returns:
 685
 686
 687 <!-- ##### FUNCTION gtk_text_iter_forward_visible_lines ##### -->
 688 <para>
 689
 690 </para>
 691
 692 @iter:
 693 @count:
 694 @Returns:
 695
 696
 697 <!-- ##### FUNCTION gtk_text_iter_backward_visible_lines ##### -->
 698 <para>
 699
 700 </para>
 701
 702 @iter:
 703 @count:
 704 @Returns:
 705
 706
 707 <!-- ##### FUNCTION gtk_text_iter_set_offset ##### -->
 708 <para>
 709
 710 </para>
 711
 712 @iter:
 713 @char_offset:
 714
 715
 716 <!-- ##### FUNCTION gtk_text_iter_set_line ##### -->
 717 <para>
 718
 719 </para>
 720
 721 @iter:
 722 @line_number:
 723
 724
 725 <!-- ##### FUNCTION gtk_text_iter_set_line_offset ##### -->
 726 <para>
 727
 728 </para>
 729
 730 @iter:
 731 @char_on_line:
 732
 733
 734 <!-- ##### FUNCTION gtk_text_iter_set_line_index ##### -->
 735 <para>
 736
 737 </para>
 738
 739 @iter:
 740 @byte_on_line:
 741
 742
 743 <!-- ##### FUNCTION gtk_text_iter_set_visible_line_index ##### -->
 744 <para>
 745
 746 </para>
 747
 748 @iter:
 749 @byte_on_line:
 750
 751
 752 <!-- ##### FUNCTION gtk_text_iter_set_visible_line_offset ##### -->
 753 <para>
 754
 755 </para>
 756
 757 @iter:
 758 @char_on_line:
 759
 760
 761 <!-- ##### FUNCTION gtk_text_iter_forward_to_end ##### -->
 762 <para>
 763
 764 </para>
 765
 766 @iter:
 767
 768
 769 <!-- ##### FUNCTION gtk_text_iter_forward_to_line_end ##### -->
 770 <para>
 771
 772 </para>
 773
 774 @iter:
 775 @Returns:
 776
 777
 778 <!-- ##### FUNCTION gtk_text_iter_forward_to_tag_toggle ##### -->
 779 <para>
 780
 781 </para>
 782
 783 @iter:
 784 @tag:
 785 @Returns:
 786
 787
 788 <!-- ##### FUNCTION gtk_text_iter_backward_to_tag_toggle ##### -->
 789 <para>
 790
 791 </para>
 792
 793 @iter:
 794 @tag:
 795 @Returns:
 796
 797
 798 <!-- ##### USER_FUNCTION GtkTextCharPredicate ##### -->
 799 <para>
 800
 801 </para>
 802
 803 @ch:
 804 @user_data:
 805 @Returns:
 806
 807
 808 <!-- ##### FUNCTION gtk_text_iter_forward_find_char ##### -->
 809 <para>
 810
 811 </para>
 812
 813 @iter:
 814 @pred:
 815 @user_data:
 816 @limit:
 817 @Returns:
 818
 819
 820 <!-- ##### FUNCTION gtk_text_iter_backward_find_char ##### -->
 821 <para>
 822
 823 </para>
 824
 825 @iter:
 826 @pred:
 827 @user_data:
 828 @limit:
 829 @Returns:
 830
 831
 832 <!-- ##### ENUM GtkTextSearchFlags ##### -->
 833 <para>
 834
 835 </para>
 836
 837 @GTK_TEXT_SEARCH_VISIBLE_ONLY:
 838 @GTK_TEXT_SEARCH_TEXT_ONLY:
 839
 840 <!-- ##### FUNCTION gtk_text_iter_forward_search ##### -->
 841 <para>
 842
 843 </para>
 844
 845 @iter:
 846 @str:
 847 @flags:
 848 @match_start:
 849 @match_end:
 850 @limit:
 851 @Returns:
 852
 853
 854 <!-- ##### FUNCTION gtk_text_iter_backward_search ##### -->
 855 <para>
 856
 857 </para>
 858
 859 @iter:
 860 @str:
 861 @flags:
 862 @match_start:
 863 @match_end:
 864 @limit:
 865 @Returns:
 866
 867
 868 <!-- ##### FUNCTION gtk_text_iter_equal ##### -->
 869 <para>
 870
 871 </para>
 872
 873 @lhs:
 874 @rhs:
 875 @Returns:
 876
 877
 878 <!-- ##### FUNCTION gtk_text_iter_compare ##### -->
 879 <para>
 880
 881 </para>
 882
 883 @lhs:
 884 @rhs:
 885 @Returns:
 886
 887
 888 <!-- ##### FUNCTION gtk_text_iter_in_range ##### -->
 889 <para>
 890
 891 </para>
 892
 893 @iter:
 894 @start:
 895 @end:
 896 @Returns:
 897
 898
 899 <!-- ##### FUNCTION gtk_text_iter_order ##### -->
 900 <para>
 901
 902 </para>
 903
 904 @first:
 905 @second:
 906
 907