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