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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkTextBuffer
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6 Stores attributed text for display in a <link
   7 linkend="GtkTextView">GtkTextView</link>
   8
   9 <!-- ##### SECTION Long_Description ##### -->
  10
  11 <para>
  12 You may wish to begin by reading the <link linkend="TextWidget">text widget
  13 conceptual overview</link> which gives an overview of all the objects and data
  14 types related to the text widget and how they work together.
  15 </para>
  16
  17 <para>
  18
  19 </para>
  20
  21 <!-- ##### SECTION See_Also ##### -->
  22 <para>
  23 #GtkTextView, #GtkTextIter, #GtkTextMark
  24 </para>
  25
  26 <!-- ##### SECTION Stability_Level ##### -->
  27
  28
  29 <!-- ##### STRUCT GtkTextBuffer ##### -->
  30 <para>
  31
  32 </para>
  33
  34
  35 <!-- ##### SIGNAL GtkTextBuffer::apply-tag ##### -->
  36 <para>
  37
  38 </para>
  39
  40 @textbuffer: the object which received the signal.
  41 @arg1:
  42 @arg2:
  43 @arg3:
  44
  45 <!-- ##### SIGNAL GtkTextBuffer::begin-user-action ##### -->
  46 <para>
  47
  48 </para>
  49
  50 @textbuffer: the object which received the signal.
  51
  52 <!-- ##### SIGNAL GtkTextBuffer::changed ##### -->
  53 <para>
  54
  55 </para>
  56
  57 @textbuffer: the object which received the signal.
  58
  59 <!-- ##### SIGNAL GtkTextBuffer::delete-range ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @textbuffer: the object which received the signal.
  65 @arg1:
  66 @arg2:
  67
  68 <!-- ##### SIGNAL GtkTextBuffer::end-user-action ##### -->
  69 <para>
  70
  71 </para>
  72
  73 @textbuffer: the object which received the signal.
  74
  75 <!-- ##### SIGNAL GtkTextBuffer::insert-child-anchor ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @textbuffer: the object which received the signal.
  81 @arg1:
  82 @arg2:
  83
  84 <!-- ##### SIGNAL GtkTextBuffer::insert-pixbuf ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @textbuffer: the object which received the signal.
  90 @arg1:
  91 @arg2:
  92
  93 <!-- ##### SIGNAL GtkTextBuffer::insert-text ##### -->
  94 <para>
  95
  96 </para>
  97
  98 @textbuffer: the object which received the signal.
  99 @arg1:
 100 @arg2:
 101 @arg3:
 102
 103 <!-- ##### SIGNAL GtkTextBuffer::mark-deleted ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @textbuffer: the object which received the signal.
 109 @arg1:
 110
 111 <!-- ##### SIGNAL GtkTextBuffer::mark-set ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @textbuffer: the object which received the signal.
 117 @arg1:
 118 @arg2:
 119
 120 <!-- ##### SIGNAL GtkTextBuffer::modified-changed ##### -->
 121 <para>
 122
 123 </para>
 124
 125 @textbuffer: the object which received the signal.
 126
 127 <!-- ##### SIGNAL GtkTextBuffer::remove-tag ##### -->
 128 <para>
 129
 130 </para>
 131
 132 @textbuffer: the object which received the signal.
 133 @arg1:
 134 @arg2:
 135 @arg3:
 136
 137 <!-- ##### ARG GtkTextBuffer:copy-target-list ##### -->
 138 <para>
 139
 140 </para>
 141
 142 <!-- ##### ARG GtkTextBuffer:has-selection ##### -->
 143 <para>
 144
 145 </para>
 146
 147 <!-- ##### ARG GtkTextBuffer:paste-target-list ##### -->
 148 <para>
 149
 150 </para>
 151
 152 <!-- ##### ARG GtkTextBuffer:tag-table ##### -->
 153 <para>
 154
 155 </para>
 156
 157 <!-- ##### ARG GtkTextBuffer:text ##### -->
 158 <para>
 159
 160 </para>
 161
 162 <!-- ##### FUNCTION gtk_text_buffer_new ##### -->
 163 <para>
 164
 165 </para>
 166
 167 @table:
 168 @Returns:
 169
 170
 171 <!-- ##### FUNCTION gtk_text_buffer_get_line_count ##### -->
 172 <para>
 173
 174 </para>
 175
 176 @buffer:
 177 @Returns:
 178
 179
 180 <!-- ##### FUNCTION gtk_text_buffer_get_char_count ##### -->
 181 <para>
 182
 183 </para>
 184
 185 @buffer:
 186 @Returns:
 187
 188
 189 <!-- ##### FUNCTION gtk_text_buffer_get_tag_table ##### -->
 190 <para>
 191
 192 </para>
 193
 194 @buffer:
 195 @Returns:
 196
 197
 198 <!-- ##### FUNCTION gtk_text_buffer_insert ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @buffer:
 204 @iter:
 205 @text:
 206 @len:
 207
 208
 209 <!-- ##### FUNCTION gtk_text_buffer_insert_at_cursor ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @buffer:
 215 @text:
 216 @len:
 217
 218
 219 <!-- ##### FUNCTION gtk_text_buffer_insert_interactive ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @buffer:
 225 @iter:
 226 @text:
 227 @len:
 228 @default_editable:
 229 @Returns:
 230
 231
 232 <!-- ##### FUNCTION gtk_text_buffer_insert_interactive_at_cursor ##### -->
 233 <para>
 234
 235 </para>
 236
 237 @buffer:
 238 @text:
 239 @len:
 240 @default_editable:
 241 @Returns:
 242
 243
 244 <!-- ##### FUNCTION gtk_text_buffer_insert_range ##### -->
 245 <para>
 246
 247 </para>
 248
 249 @buffer:
 250 @iter:
 251 @start:
 252 @end:
 253
 254
 255 <!-- ##### FUNCTION gtk_text_buffer_insert_range_interactive ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @buffer:
 261 @iter:
 262 @start:
 263 @end:
 264 @default_editable:
 265 @Returns:
 266
 267
 268 <!-- ##### FUNCTION gtk_text_buffer_insert_with_tags ##### -->
 269 <para>
 270
 271 </para>
 272
 273 @buffer:
 274 @iter:
 275 @text:
 276 @len:
 277 @first_tag:
 278 @Varargs:
 279
 280
 281 <!-- ##### FUNCTION gtk_text_buffer_insert_with_tags_by_name ##### -->
 282 <para>
 283
 284 </para>
 285
 286 @buffer:
 287 @iter:
 288 @text:
 289 @len:
 290 @first_tag_name:
 291 @Varargs:
 292
 293
 294 <!-- ##### FUNCTION gtk_text_buffer_delete ##### -->
 295 <para>
 296
 297 </para>
 298
 299 @buffer:
 300 @start:
 301 @end:
 302
 303
 304 <!-- ##### FUNCTION gtk_text_buffer_delete_interactive ##### -->
 305 <para>
 306
 307 </para>
 308
 309 @buffer:
 310 @start_iter:
 311 @end_iter:
 312 @default_editable:
 313 @Returns:
 314
 315
 316 <!-- ##### FUNCTION gtk_text_buffer_backspace ##### -->
 317 <para>
 318
 319 </para>
 320
 321 @buffer:
 322 @iter:
 323 @interactive:
 324 @default_editable:
 325 @Returns:
 326
 327
 328 <!-- ##### FUNCTION gtk_text_buffer_set_text ##### -->
 329 <para>
 330
 331 </para>
 332
 333 @buffer:
 334 @text:
 335 @len:
 336
 337
 338 <!-- ##### FUNCTION gtk_text_buffer_get_text ##### -->
 339 <para>
 340
 341 </para>
 342
 343 @buffer:
 344 @start:
 345 @end:
 346 @include_hidden_chars:
 347 @Returns:
 348
 349
 350 <!-- ##### FUNCTION gtk_text_buffer_get_slice ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @buffer:
 356 @start:
 357 @end:
 358 @include_hidden_chars:
 359 @Returns:
 360
 361
 362 <!-- ##### FUNCTION gtk_text_buffer_insert_pixbuf ##### -->
 363 <para>
 364
 365 </para>
 366
 367 @buffer:
 368 @iter:
 369 @pixbuf:
 370
 371
 372 <!-- ##### FUNCTION gtk_text_buffer_insert_child_anchor ##### -->
 373 <para>
 374
 375 </para>
 376
 377 @buffer:
 378 @iter:
 379 @anchor:
 380
 381
 382 <!-- ##### FUNCTION gtk_text_buffer_create_child_anchor ##### -->
 383 <para>
 384
 385 </para>
 386
 387 @buffer:
 388 @iter:
 389 @Returns:
 390
 391
 392 <!-- ##### FUNCTION gtk_text_buffer_create_mark ##### -->
 393 <para>
 394
 395 </para>
 396
 397 @buffer:
 398 @mark_name:
 399 @where:
 400 @left_gravity:
 401 @Returns:
 402
 403
 404 <!-- ##### FUNCTION gtk_text_buffer_move_mark ##### -->
 405 <para>
 406
 407 </para>
 408
 409 @buffer:
 410 @mark:
 411 @where:
 412
 413
 414 <!-- ##### FUNCTION gtk_text_buffer_move_mark_by_name ##### -->
 415 <para>
 416
 417 </para>
 418
 419 @buffer:
 420 @name:
 421 @where:
 422
 423
 424 <!-- ##### FUNCTION gtk_text_buffer_delete_mark ##### -->
 425 <para>
 426
 427 </para>
 428
 429 @buffer:
 430 @mark:
 431
 432
 433 <!-- ##### FUNCTION gtk_text_buffer_delete_mark_by_name ##### -->
 434 <para>
 435
 436 </para>
 437
 438 @buffer:
 439 @name:
 440
 441
 442 <!-- ##### FUNCTION gtk_text_buffer_get_mark ##### -->
 443 <para>
 444
 445 </para>
 446
 447 @buffer:
 448 @name:
 449 @Returns:
 450
 451
 452 <!-- ##### FUNCTION gtk_text_buffer_get_insert ##### -->
 453 <para>
 454
 455 </para>
 456
 457 @buffer:
 458 @Returns:
 459
 460
 461 <!-- ##### FUNCTION gtk_text_buffer_get_selection_bound ##### -->
 462 <para>
 463
 464 </para>
 465
 466 @buffer:
 467 @Returns:
 468
 469
 470 <!-- ##### FUNCTION gtk_text_buffer_get_has_selection ##### -->
 471 <para>
 472
 473 </para>
 474
 475 @buffer:
 476 @Returns:
 477
 478
 479 <!-- ##### FUNCTION gtk_text_buffer_place_cursor ##### -->
 480 <para>
 481
 482 </para>
 483
 484 @buffer:
 485 @where:
 486
 487
 488 <!-- ##### FUNCTION gtk_text_buffer_select_range ##### -->
 489 <para>
 490
 491 </para>
 492
 493 @buffer:
 494 @ins:
 495 @bound:
 496
 497
 498 <!-- ##### FUNCTION gtk_text_buffer_apply_tag ##### -->
 499 <para>
 500
 501 </para>
 502
 503 @buffer:
 504 @tag:
 505 @start:
 506 @end:
 507
 508
 509 <!-- ##### FUNCTION gtk_text_buffer_remove_tag ##### -->
 510 <para>
 511
 512 </para>
 513
 514 @buffer:
 515 @tag:
 516 @start:
 517 @end:
 518
 519
 520 <!-- ##### FUNCTION gtk_text_buffer_apply_tag_by_name ##### -->
 521 <para>
 522
 523 </para>
 524
 525 @buffer:
 526 @name:
 527 @start:
 528 @end:
 529
 530
 531 <!-- ##### FUNCTION gtk_text_buffer_remove_tag_by_name ##### -->
 532 <para>
 533
 534 </para>
 535
 536 @buffer:
 537 @name:
 538 @start:
 539 @end:
 540
 541
 542 <!-- ##### FUNCTION gtk_text_buffer_remove_all_tags ##### -->
 543 <para>
 544
 545 </para>
 546
 547 @buffer:
 548 @start:
 549 @end:
 550
 551
 552 <!-- ##### FUNCTION gtk_text_buffer_create_tag ##### -->
 553 <para>
 554
 555 </para>
 556
 557 @buffer:
 558 @tag_name:
 559 @first_property_name:
 560 @Varargs:
 561 @Returns:
 562
 563
 564 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line_offset ##### -->
 565 <para>
 566
 567 </para>
 568
 569 @buffer:
 570 @iter:
 571 @line_number:
 572 @char_offset:
 573
 574
 575 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_offset ##### -->
 576 <para>
 577
 578 </para>
 579
 580 @buffer:
 581 @iter:
 582 @char_offset:
 583
 584
 585 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line ##### -->
 586 <para>
 587
 588 </para>
 589
 590 @buffer:
 591 @iter:
 592 @line_number:
 593
 594
 595 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line_index ##### -->
 596 <para>
 597
 598 </para>
 599
 600 @buffer:
 601 @iter:
 602 @line_number:
 603 @byte_index:
 604
 605
 606 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_mark ##### -->
 607 <para>
 608
 609 </para>
 610
 611 @buffer:
 612 @iter:
 613 @mark:
 614
 615
 616 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_child_anchor ##### -->
 617 <para>
 618
 619 </para>
 620
 621 @buffer:
 622 @iter:
 623 @anchor:
 624
 625
 626 <!-- ##### FUNCTION gtk_text_buffer_get_start_iter ##### -->
 627 <para>
 628
 629 </para>
 630
 631 @buffer:
 632 @iter:
 633
 634
 635 <!-- ##### FUNCTION gtk_text_buffer_get_end_iter ##### -->
 636 <para>
 637
 638 </para>
 639
 640 @buffer:
 641 @iter:
 642
 643
 644 <!-- ##### FUNCTION gtk_text_buffer_get_bounds ##### -->
 645 <para>
 646
 647 </para>
 648
 649 @buffer:
 650 @start:
 651 @end:
 652
 653
 654 <!-- ##### FUNCTION gtk_text_buffer_get_modified ##### -->
 655 <para>
 656
 657 </para>
 658
 659 @buffer:
 660 @Returns:
 661
 662
 663 <!-- ##### FUNCTION gtk_text_buffer_set_modified ##### -->
 664 <para>
 665
 666 </para>
 667
 668 @buffer:
 669 @setting:
 670
 671
 672 <!-- ##### FUNCTION gtk_text_buffer_delete_selection ##### -->
 673 <para>
 674
 675 </para>
 676
 677 @buffer:
 678 @interactive:
 679 @default_editable:
 680 @Returns:
 681
 682
 683 <!-- ##### FUNCTION gtk_text_buffer_paste_clipboard ##### -->
 684 <para>
 685
 686 </para>
 687
 688 @buffer:
 689 @clipboard:
 690 @override_location:
 691 @default_editable:
 692
 693
 694 <!-- ##### FUNCTION gtk_text_buffer_copy_clipboard ##### -->
 695 <para>
 696
 697 </para>
 698
 699 @buffer:
 700 @clipboard:
 701
 702
 703 <!-- ##### FUNCTION gtk_text_buffer_cut_clipboard ##### -->
 704 <para>
 705
 706 </para>
 707
 708 @buffer:
 709 @clipboard:
 710 @default_editable:
 711
 712
 713 <!-- ##### FUNCTION gtk_text_buffer_get_selection_bounds ##### -->
 714 <para>
 715
 716 </para>
 717
 718 @buffer:
 719 @start:
 720 @end:
 721 @Returns:
 722
 723
 724 <!-- ##### FUNCTION gtk_text_buffer_begin_user_action ##### -->
 725 <para>
 726
 727 </para>
 728
 729 @buffer:
 730
 731
 732 <!-- ##### FUNCTION gtk_text_buffer_end_user_action ##### -->
 733 <para>
 734
 735 </para>
 736
 737 @buffer:
 738
 739
 740 <!-- ##### FUNCTION gtk_text_buffer_add_selection_clipboard ##### -->
 741 <para>
 742
 743 </para>
 744
 745 @buffer:
 746 @clipboard:
 747
 748
 749 <!-- ##### FUNCTION gtk_text_buffer_remove_selection_clipboard ##### -->
 750 <para>
 751
 752 </para>
 753
 754 @buffer:
 755 @clipboard:
 756
 757
 758 <!-- ##### ENUM GtkTextBufferTargetInfo ##### -->
 759 <para>
 760
 761 </para>
 762
 763 @GTK_TEXT_BUFFER_TARGET_INFO_BUFFER_CONTENTS:
 764 @GTK_TEXT_BUFFER_TARGET_INFO_RICH_TEXT:
 765 @GTK_TEXT_BUFFER_TARGET_INFO_TEXT:
 766
 767 <!-- ##### USER_FUNCTION GtkTextBufferDeserializeFunc ##### -->
 768 <para>
 769
 770 </para>
 771
 772 @register_buffer:
 773 @content_buffer:
 774 @iter:
 775 @data:
 776 @length:
 777 @create_tags:
 778 @user_data:
 779 @error:
 780 @Returns:
 781
 782
 783 <!-- ##### FUNCTION gtk_text_buffer_deserialize ##### -->
 784 <para>
 785
 786 </para>
 787
 788 @register_buffer:
 789 @content_buffer:
 790 @format:
 791 @iter:
 792 @data:
 793 @length:
 794 @error:
 795 @Returns:
 796
 797
 798 <!-- ##### FUNCTION gtk_text_buffer_deserialize_get_can_create_tags ##### -->
 799 <para>
 800
 801 </para>
 802
 803 @buffer:
 804 @format:
 805 @Returns:
 806
 807
 808 <!-- ##### FUNCTION gtk_text_buffer_deserialize_set_can_create_tags ##### -->
 809 <para>
 810
 811 </para>
 812
 813 @buffer:
 814 @format:
 815 @can_create_tags:
 816
 817
 818 <!-- ##### FUNCTION gtk_text_buffer_get_copy_target_list ##### -->
 819 <para>
 820
 821 </para>
 822
 823 @buffer:
 824 @Returns:
 825
 826
 827 <!-- ##### FUNCTION gtk_text_buffer_get_deserialize_formats ##### -->
 828 <para>
 829
 830 </para>
 831
 832 @buffer:
 833 @n_formats:
 834 @Returns:
 835
 836
 837 <!-- ##### FUNCTION gtk_text_buffer_get_paste_target_list ##### -->
 838 <para>
 839
 840 </para>
 841
 842 @buffer:
 843 @Returns:
 844
 845
 846 <!-- ##### FUNCTION gtk_text_buffer_get_serialize_formats ##### -->
 847 <para>
 848
 849 </para>
 850
 851 @buffer:
 852 @n_formats:
 853 @Returns:
 854
 855
 856 <!-- ##### FUNCTION gtk_text_buffer_register_deserialize_format ##### -->
 857 <para>
 858
 859 </para>
 860
 861 @buffer:
 862 @mime_type:
 863 @function:
 864 @user_data:
 865 @user_data_destroy:
 866 @Returns:
 867
 868
 869 <!-- ##### FUNCTION gtk_text_buffer_register_deserialize_tagset ##### -->
 870 <para>
 871
 872 </para>
 873
 874 @buffer:
 875 @tagset_name:
 876 @Returns:
 877
 878
 879 <!-- ##### FUNCTION gtk_text_buffer_register_serialize_format ##### -->
 880 <para>
 881
 882 </para>
 883
 884 @buffer:
 885 @mime_type:
 886 @function:
 887 @user_data:
 888 @user_data_destroy:
 889 @Returns:
 890
 891
 892 <!-- ##### FUNCTION gtk_text_buffer_register_serialize_tagset ##### -->
 893 <para>
 894
 895 </para>
 896
 897 @buffer:
 898 @tagset_name:
 899 @Returns:
 900
 901
 902 <!-- ##### USER_FUNCTION GtkTextBufferSerializeFunc ##### -->
 903 <para>
 904
 905 </para>
 906
 907 @register_buffer:
 908 @content_buffer:
 909 @start:
 910 @end:
 911 @length:
 912 @user_data:
 913 @Returns:
 914
 915
 916 <!-- ##### FUNCTION gtk_text_buffer_serialize ##### -->
 917 <para>
 918
 919 </para>
 920
 921 @register_buffer:
 922 @content_buffer:
 923 @format:
 924 @start:
 925 @end:
 926 @length:
 927 @Returns:
 928
 929
 930 <!-- ##### FUNCTION gtk_text_buffer_unregister_deserialize_format ##### -->
 931 <para>
 932
 933 </para>
 934
 935 @buffer:
 936 @format:
 937
 938
 939 <!-- ##### FUNCTION gtk_text_buffer_unregister_serialize_format ##### -->
 940 <para>
 941
 942 </para>
 943
 944 @buffer:
 945 @format:
 946
 947