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
  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_starts_word ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @iter:
 266 @Returns:
 267
 268
 269 <!-- ##### FUNCTION gtk_text_iter_ends_word ##### -->
 270 <para>
 271
 272 </para>
 273
 274 @iter:
 275 @Returns:
 276
 277
 278 <!-- ##### FUNCTION gtk_text_iter_inside_word ##### -->
 279 <para>
 280
 281 </para>
 282
 283 @iter:
 284 @Returns:
 285
 286
 287 <!-- ##### FUNCTION gtk_text_iter_starts_line ##### -->
 288 <para>
 289
 290 </para>
 291
 292 @iter:
 293 @Returns:
 294
 295
 296 <!-- ##### FUNCTION gtk_text_iter_ends_line ##### -->
 297 <para>
 298
 299 </para>
 300
 301 @iter:
 302 @Returns:
 303
 304
 305 <!-- ##### FUNCTION gtk_text_iter_starts_sentence ##### -->
 306 <para>
 307
 308 </para>
 309
 310 @iter:
 311 @Returns:
 312
 313
 314 <!-- ##### FUNCTION gtk_text_iter_ends_sentence ##### -->
 315 <para>
 316
 317 </para>
 318
 319 @iter:
 320 @Returns:
 321
 322
 323 <!-- ##### FUNCTION gtk_text_iter_inside_sentence ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @iter:
 329 @Returns:
 330
 331
 332 <!-- ##### FUNCTION gtk_text_iter_is_cursor_position ##### -->
 333 <para>
 334
 335 </para>
 336
 337 @iter:
 338 @Returns:
 339
 340
 341 <!-- ##### FUNCTION gtk_text_iter_get_chars_in_line ##### -->
 342 <para>
 343
 344 </para>
 345
 346 @iter:
 347 @Returns:
 348
 349
 350 <!-- ##### FUNCTION gtk_text_iter_get_bytes_in_line ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @iter:
 356 @Returns:
 357
 358
 359 <!-- ##### FUNCTION gtk_text_iter_get_attributes ##### -->
 360 <para>
 361
 362 </para>
 363
 364 @iter:
 365 @values:
 366 @Returns:
 367
 368
 369 <!-- ##### FUNCTION gtk_text_iter_get_language ##### -->
 370 <para>
 371
 372 </para>
 373
 374 @iter:
 375 @Returns:
 376
 377
 378 <!-- ##### FUNCTION gtk_text_iter_is_end ##### -->
 379 <para>
 380
 381 </para>
 382
 383 @iter:
 384 @Returns:
 385
 386
 387 <!-- ##### FUNCTION gtk_text_iter_is_start ##### -->
 388 <para>
 389
 390 </para>
 391
 392 @iter:
 393 @Returns:
 394
 395
 396 <!-- ##### FUNCTION gtk_text_iter_forward_char ##### -->
 397 <para>
 398
 399 </para>
 400
 401 @iter:
 402 @Returns:
 403
 404
 405 <!-- ##### FUNCTION gtk_text_iter_backward_char ##### -->
 406 <para>
 407
 408 </para>
 409
 410 @iter:
 411 @Returns:
 412
 413
 414 <!-- ##### FUNCTION gtk_text_iter_forward_chars ##### -->
 415 <para>
 416
 417 </para>
 418
 419 @iter:
 420 @count:
 421 @Returns:
 422
 423
 424 <!-- ##### FUNCTION gtk_text_iter_backward_chars ##### -->
 425 <para>
 426
 427 </para>
 428
 429 @iter:
 430 @count:
 431 @Returns:
 432
 433
 434 <!-- ##### FUNCTION gtk_text_iter_forward_line ##### -->
 435 <para>
 436
 437 </para>
 438
 439 @iter:
 440 @Returns:
 441
 442
 443 <!-- ##### FUNCTION gtk_text_iter_backward_line ##### -->
 444 <para>
 445
 446 </para>
 447
 448 @iter:
 449 @Returns:
 450
 451
 452 <!-- ##### FUNCTION gtk_text_iter_forward_lines ##### -->
 453 <para>
 454
 455 </para>
 456
 457 @iter:
 458 @count:
 459 @Returns:
 460
 461
 462 <!-- ##### FUNCTION gtk_text_iter_backward_lines ##### -->
 463 <para>
 464
 465 </para>
 466
 467 @iter:
 468 @count:
 469 @Returns:
 470
 471
 472 <!-- ##### FUNCTION gtk_text_iter_forward_word_ends ##### -->
 473 <para>
 474
 475 </para>
 476
 477 @iter:
 478 @count:
 479 @Returns:
 480
 481
 482 <!-- ##### FUNCTION gtk_text_iter_backward_word_starts ##### -->
 483 <para>
 484
 485 </para>
 486
 487 @iter:
 488 @count:
 489 @Returns:
 490
 491
 492 <!-- ##### FUNCTION gtk_text_iter_forward_word_end ##### -->
 493 <para>
 494
 495 </para>
 496
 497 @iter:
 498 @Returns:
 499
 500
 501 <!-- ##### FUNCTION gtk_text_iter_backward_word_start ##### -->
 502 <para>
 503
 504 </para>
 505
 506 @iter:
 507 @Returns:
 508
 509
 510 <!-- ##### FUNCTION gtk_text_iter_forward_cursor_position ##### -->
 511 <para>
 512
 513 </para>
 514
 515 @iter:
 516 @Returns:
 517
 518
 519 <!-- ##### FUNCTION gtk_text_iter_backward_cursor_position ##### -->
 520 <para>
 521
 522 </para>
 523
 524 @iter:
 525 @Returns:
 526
 527
 528 <!-- ##### FUNCTION gtk_text_iter_forward_cursor_positions ##### -->
 529 <para>
 530
 531 </para>
 532
 533 @iter:
 534 @count:
 535 @Returns:
 536
 537
 538 <!-- ##### FUNCTION gtk_text_iter_backward_cursor_positions ##### -->
 539 <para>
 540
 541 </para>
 542
 543 @iter:
 544 @count:
 545 @Returns:
 546
 547
 548 <!-- ##### FUNCTION gtk_text_iter_backward_sentence_start ##### -->
 549 <para>
 550
 551 </para>
 552
 553 @iter:
 554 @Returns:
 555
 556
 557 <!-- ##### FUNCTION gtk_text_iter_backward_sentence_starts ##### -->
 558 <para>
 559
 560 </para>
 561
 562 @iter:
 563 @count:
 564 @Returns:
 565
 566
 567 <!-- ##### FUNCTION gtk_text_iter_forward_sentence_end ##### -->
 568 <para>
 569
 570 </para>
 571
 572 @iter:
 573 @Returns:
 574
 575
 576 <!-- ##### FUNCTION gtk_text_iter_forward_sentence_ends ##### -->
 577 <para>
 578
 579 </para>
 580
 581 @iter:
 582 @count:
 583 @Returns:
 584
 585
 586 <!-- ##### FUNCTION gtk_text_iter_set_offset ##### -->
 587 <para>
 588
 589 </para>
 590
 591 @iter:
 592 @char_offset:
 593
 594
 595 <!-- ##### FUNCTION gtk_text_iter_set_line ##### -->
 596 <para>
 597
 598 </para>
 599
 600 @iter:
 601 @line_number:
 602
 603
 604 <!-- ##### FUNCTION gtk_text_iter_set_line_offset ##### -->
 605 <para>
 606
 607 </para>
 608
 609 @iter:
 610 @char_on_line:
 611
 612
 613 <!-- ##### FUNCTION gtk_text_iter_set_line_index ##### -->
 614 <para>
 615
 616 </para>
 617
 618 @iter:
 619 @byte_on_line:
 620
 621
 622 <!-- ##### FUNCTION gtk_text_iter_set_visible_line_index ##### -->
 623 <para>
 624
 625 </para>
 626
 627 @iter:
 628 @byte_on_line:
 629
 630
 631 <!-- ##### FUNCTION gtk_text_iter_set_visible_line_offset ##### -->
 632 <para>
 633
 634 </para>
 635
 636 @iter:
 637 @char_on_line:
 638
 639
 640 <!-- ##### FUNCTION gtk_text_iter_forward_to_end ##### -->
 641 <para>
 642
 643 </para>
 644
 645 @iter:
 646
 647
 648 <!-- ##### FUNCTION gtk_text_iter_forward_to_line_end ##### -->
 649 <para>
 650
 651 </para>
 652
 653 @iter:
 654 @Returns:
 655
 656
 657 <!-- ##### FUNCTION gtk_text_iter_forward_to_tag_toggle ##### -->
 658 <para>
 659
 660 </para>
 661
 662 @iter:
 663 @tag:
 664 @Returns:
 665
 666
 667 <!-- ##### FUNCTION gtk_text_iter_backward_to_tag_toggle ##### -->
 668 <para>
 669
 670 </para>
 671
 672 @iter:
 673 @tag:
 674 @Returns:
 675
 676
 677 <!-- ##### USER_FUNCTION GtkTextCharPredicate ##### -->
 678 <para>
 679
 680 </para>
 681
 682 @ch:
 683 @user_data:
 684 @Returns:
 685
 686
 687 <!-- ##### FUNCTION gtk_text_iter_forward_find_char ##### -->
 688 <para>
 689
 690 </para>
 691
 692 @iter:
 693 @pred:
 694 @user_data:
 695 @limit:
 696 @Returns:
 697
 698
 699 <!-- ##### FUNCTION gtk_text_iter_backward_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_forward_search ##### -->
 712 <para>
 713
 714 </para>
 715
 716 @iter:
 717 @str:
 718 @visible_only:
 719 @slice:
 720 @match_start:
 721 @match_end:
 722 @limit:
 723 @Returns:
 724
 725
 726 <!-- ##### FUNCTION gtk_text_iter_backward_search ##### -->
 727 <para>
 728
 729 </para>
 730
 731 @iter:
 732 @str:
 733 @visible_only:
 734 @slice:
 735 @match_start:
 736 @match_end:
 737 @limit:
 738 @Returns:
 739
 740
 741 <!-- ##### FUNCTION gtk_text_iter_equal ##### -->
 742 <para>
 743
 744 </para>
 745
 746 @lhs:
 747 @rhs:
 748 @Returns:
 749
 750
 751 <!-- ##### FUNCTION gtk_text_iter_compare ##### -->
 752 <para>
 753
 754 </para>
 755
 756 @lhs:
 757 @rhs:
 758 @Returns:
 759
 760
 761 <!-- ##### FUNCTION gtk_text_iter_in_range ##### -->
 762 <para>
 763
 764 </para>
 765
 766 @iter:
 767 @start:
 768 @end:
 769 @Returns:
 770
 771
 772 <!-- ##### FUNCTION gtk_text_iter_order ##### -->
 773 <para>
 774
 775 </para>
 776
 777 @first:
 778 @second:
 779
 780