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