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