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

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