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 <!-- # Unused Parameters # -->
 103 @arg4:
 104
 105 <!-- ##### SIGNAL GtkTextBuffer::mark-deleted ##### -->
 106 <para>
 107
 108 </para>
 109
 110 @textbuffer: the object which received the signal.
 111 @arg1:
 112
 113 <!-- ##### SIGNAL GtkTextBuffer::mark-set ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @textbuffer: the object which received the signal.
 119 @arg1:
 120 @arg2:
 121
 122 <!-- ##### SIGNAL GtkTextBuffer::modified-changed ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @textbuffer: the object which received the signal.
 128
 129 <!-- ##### SIGNAL GtkTextBuffer::remove-tag ##### -->
 130 <para>
 131
 132 </para>
 133
 134 @textbuffer: the object which received the signal.
 135 @arg1:
 136 @arg2:
 137 @arg3:
 138
 139 <!-- ##### ARG GtkTextBuffer:tag-table ##### -->
 140 <para>
 141
 142 </para>
 143
 144 <!-- ##### ARG GtkTextBuffer:text ##### -->
 145 <para>
 146
 147 </para>
 148
 149 <!-- ##### FUNCTION gtk_text_buffer_new ##### -->
 150 <para>
 151
 152 </para>
 153
 154 @table:
 155 @Returns:
 156
 157
 158 <!-- ##### FUNCTION gtk_text_buffer_get_line_count ##### -->
 159 <para>
 160
 161 </para>
 162
 163 @buffer:
 164 @Returns:
 165
 166
 167 <!-- ##### FUNCTION gtk_text_buffer_get_char_count ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @buffer:
 173 @Returns:
 174
 175
 176 <!-- ##### FUNCTION gtk_text_buffer_get_tag_table ##### -->
 177 <para>
 178
 179 </para>
 180
 181 @buffer:
 182 @Returns:
 183
 184
 185 <!-- ##### FUNCTION gtk_text_buffer_insert ##### -->
 186 <para>
 187
 188 </para>
 189
 190 @buffer:
 191 @iter:
 192 @text:
 193 @len:
 194
 195
 196 <!-- ##### FUNCTION gtk_text_buffer_insert_at_cursor ##### -->
 197 <para>
 198
 199 </para>
 200
 201 @buffer:
 202 @text:
 203 @len:
 204
 205
 206 <!-- ##### FUNCTION gtk_text_buffer_insert_interactive ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @buffer:
 212 @iter:
 213 @text:
 214 @len:
 215 @default_editable:
 216 @Returns:
 217
 218
 219 <!-- ##### FUNCTION gtk_text_buffer_insert_interactive_at_cursor ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @buffer:
 225 @text:
 226 @len:
 227 @default_editable:
 228 @Returns:
 229
 230
 231 <!-- ##### FUNCTION gtk_text_buffer_insert_range ##### -->
 232 <para>
 233
 234 </para>
 235
 236 @buffer:
 237 @iter:
 238 @start:
 239 @end:
 240
 241
 242 <!-- ##### FUNCTION gtk_text_buffer_insert_range_interactive ##### -->
 243 <para>
 244
 245 </para>
 246
 247 @buffer:
 248 @iter:
 249 @start:
 250 @end:
 251 @default_editable:
 252 @Returns:
 253
 254
 255 <!-- ##### FUNCTION gtk_text_buffer_insert_with_tags ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @buffer:
 261 @iter:
 262 @text:
 263 @len:
 264 @first_tag:
 265 @Varargs:
 266
 267
 268 <!-- ##### FUNCTION gtk_text_buffer_insert_with_tags_by_name ##### -->
 269 <para>
 270
 271 </para>
 272
 273 @buffer:
 274 @iter:
 275 @text:
 276 @len:
 277 @first_tag_name:
 278 @Varargs:
 279
 280
 281 <!-- ##### FUNCTION gtk_text_buffer_delete ##### -->
 282 <para>
 283
 284 </para>
 285
 286 @buffer:
 287 @start:
 288 @end:
 289 <!-- # Unused Parameters # -->
 290 @start_iter:
 291 @end_iter:
 292
 293
 294 <!-- ##### FUNCTION gtk_text_buffer_delete_interactive ##### -->
 295 <para>
 296
 297 </para>
 298
 299 @buffer:
 300 @start_iter:
 301 @end_iter:
 302 @default_editable:
 303 @Returns:
 304
 305
 306 <!-- ##### FUNCTION gtk_text_buffer_backspace ##### -->
 307 <para>
 308
 309 </para>
 310
 311 @buffer:
 312 @iter:
 313 @interactive:
 314 @default_editable:
 315 @Returns:
 316
 317
 318 <!-- ##### FUNCTION gtk_text_buffer_set_text ##### -->
 319 <para>
 320
 321 </para>
 322
 323 @buffer:
 324 @text:
 325 @len:
 326
 327
 328 <!-- ##### FUNCTION gtk_text_buffer_get_text ##### -->
 329 <para>
 330
 331 </para>
 332
 333 @buffer:
 334 @start:
 335 @end:
 336 @include_hidden_chars:
 337 @Returns:
 338 <!-- # Unused Parameters # -->
 339 @start_iter:
 340 @end_iter:
 341
 342
 343 <!-- ##### FUNCTION gtk_text_buffer_get_slice ##### -->
 344 <para>
 345
 346 </para>
 347
 348 @buffer:
 349 @start:
 350 @end:
 351 @include_hidden_chars:
 352 @Returns:
 353 <!-- # Unused Parameters # -->
 354 @start_iter:
 355 @end_iter:
 356
 357
 358 <!-- ##### FUNCTION gtk_text_buffer_insert_pixbuf ##### -->
 359 <para>
 360
 361 </para>
 362
 363 @buffer:
 364 @iter:
 365 @pixbuf:
 366
 367
 368 <!-- ##### FUNCTION gtk_text_buffer_insert_child_anchor ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @buffer:
 374 @iter:
 375 @anchor:
 376
 377
 378 <!-- ##### FUNCTION gtk_text_buffer_create_child_anchor ##### -->
 379 <para>
 380
 381 </para>
 382
 383 @buffer:
 384 @iter:
 385 @Returns:
 386
 387
 388 <!-- ##### FUNCTION gtk_text_buffer_create_mark ##### -->
 389 <para>
 390
 391 </para>
 392
 393 @buffer:
 394 @mark_name:
 395 @where:
 396 @left_gravity:
 397 @Returns:
 398
 399
 400 <!-- ##### FUNCTION gtk_text_buffer_move_mark ##### -->
 401 <para>
 402
 403 </para>
 404
 405 @buffer:
 406 @mark:
 407 @where:
 408
 409
 410 <!-- ##### FUNCTION gtk_text_buffer_move_mark_by_name ##### -->
 411 <para>
 412
 413 </para>
 414
 415 @buffer:
 416 @name:
 417 @where:
 418
 419
 420 <!-- ##### FUNCTION gtk_text_buffer_delete_mark ##### -->
 421 <para>
 422
 423 </para>
 424
 425 @buffer:
 426 @mark:
 427
 428
 429 <!-- ##### FUNCTION gtk_text_buffer_delete_mark_by_name ##### -->
 430 <para>
 431
 432 </para>
 433
 434 @buffer:
 435 @name:
 436
 437
 438 <!-- ##### FUNCTION gtk_text_buffer_get_mark ##### -->
 439 <para>
 440
 441 </para>
 442
 443 @buffer:
 444 @name:
 445 @Returns:
 446
 447
 448 <!-- ##### FUNCTION gtk_text_buffer_get_insert ##### -->
 449 <para>
 450
 451 </para>
 452
 453 @buffer:
 454 @Returns:
 455
 456
 457 <!-- ##### FUNCTION gtk_text_buffer_get_selection_bound ##### -->
 458 <para>
 459
 460 </para>
 461
 462 @buffer:
 463 @Returns:
 464
 465
 466 <!-- ##### FUNCTION gtk_text_buffer_place_cursor ##### -->
 467 <para>
 468
 469 </para>
 470
 471 @buffer:
 472 @where:
 473
 474
 475 <!-- ##### FUNCTION gtk_text_buffer_select_range ##### -->
 476 <para>
 477
 478 </para>
 479
 480 @buffer:
 481 @ins:
 482 @bound:
 483
 484
 485 <!-- ##### FUNCTION gtk_text_buffer_apply_tag ##### -->
 486 <para>
 487
 488 </para>
 489
 490 @buffer:
 491 @tag:
 492 @start:
 493 @end:
 494 <!-- # Unused Parameters # -->
 495 @start_index:
 496 @end_index:
 497
 498
 499 <!-- ##### FUNCTION gtk_text_buffer_remove_tag ##### -->
 500 <para>
 501
 502 </para>
 503
 504 @buffer:
 505 @tag:
 506 @start:
 507 @end:
 508 <!-- # Unused Parameters # -->
 509 @start_index:
 510 @end_index:
 511
 512
 513 <!-- ##### FUNCTION gtk_text_buffer_apply_tag_by_name ##### -->
 514 <para>
 515
 516 </para>
 517
 518 @buffer:
 519 @name:
 520 @start:
 521 @end:
 522 <!-- # Unused Parameters # -->
 523 @start_index:
 524 @end_index:
 525
 526
 527 <!-- ##### FUNCTION gtk_text_buffer_remove_tag_by_name ##### -->
 528 <para>
 529
 530 </para>
 531
 532 @buffer:
 533 @name:
 534 @start:
 535 @end:
 536 <!-- # Unused Parameters # -->
 537 @start_index:
 538 @end_index:
 539
 540
 541 <!-- ##### FUNCTION gtk_text_buffer_remove_all_tags ##### -->
 542 <para>
 543
 544 </para>
 545
 546 @buffer:
 547 @start:
 548 @end:
 549
 550
 551 <!-- ##### FUNCTION gtk_text_buffer_create_tag ##### -->
 552 <para>
 553
 554 </para>
 555
 556 @buffer:
 557 @tag_name:
 558 @first_property_name:
 559 @Varargs:
 560 @Returns:
 561
 562
 563 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line_offset ##### -->
 564 <para>
 565
 566 </para>
 567
 568 @buffer:
 569 @iter:
 570 @line_number:
 571 @char_offset:
 572
 573
 574 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_offset ##### -->
 575 <para>
 576
 577 </para>
 578
 579 @buffer:
 580 @iter:
 581 @char_offset:
 582
 583
 584 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line ##### -->
 585 <para>
 586
 587 </para>
 588
 589 @buffer:
 590 @iter:
 591 @line_number:
 592
 593
 594 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line_index ##### -->
 595 <para>
 596
 597 </para>
 598
 599 @buffer:
 600 @iter:
 601 @line_number:
 602 @byte_index:
 603
 604
 605 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_mark ##### -->
 606 <para>
 607
 608 </para>
 609
 610 @buffer:
 611 @iter:
 612 @mark:
 613
 614
 615 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_child_anchor ##### -->
 616 <para>
 617
 618 </para>
 619
 620 @buffer:
 621 @iter:
 622 @anchor:
 623
 624
 625 <!-- ##### FUNCTION gtk_text_buffer_get_start_iter ##### -->
 626 <para>
 627
 628 </para>
 629
 630 @buffer:
 631 @iter:
 632
 633
 634 <!-- ##### FUNCTION gtk_text_buffer_get_end_iter ##### -->
 635 <para>
 636
 637 </para>
 638
 639 @buffer:
 640 @iter:
 641
 642
 643 <!-- ##### FUNCTION gtk_text_buffer_get_bounds ##### -->
 644 <para>
 645
 646 </para>
 647
 648 @buffer:
 649 @start:
 650 @end:
 651
 652
 653 <!-- ##### FUNCTION gtk_text_buffer_get_modified ##### -->
 654 <para>
 655
 656 </para>
 657
 658 @buffer:
 659 @Returns:
 660
 661
 662 <!-- ##### FUNCTION gtk_text_buffer_set_modified ##### -->
 663 <para>
 664
 665 </para>
 666
 667 @buffer:
 668 @setting:
 669
 670
 671 <!-- ##### FUNCTION gtk_text_buffer_delete_selection ##### -->
 672 <para>
 673
 674 </para>
 675
 676 @buffer:
 677 @interactive:
 678 @default_editable:
 679 @Returns:
 680
 681
 682 <!-- ##### FUNCTION gtk_text_buffer_paste_clipboard ##### -->
 683 <para>
 684
 685 </para>
 686
 687 @buffer:
 688 @clipboard:
 689 @override_location:
 690 @default_editable:
 691 <!-- # Unused Parameters # -->
 692 @time_:
 693 @interactive:
 694
 695
 696 <!-- ##### FUNCTION gtk_text_buffer_copy_clipboard ##### -->
 697 <para>
 698
 699 </para>
 700
 701 @buffer:
 702 @clipboard:
 703
 704
 705 <!-- ##### FUNCTION gtk_text_buffer_cut_clipboard ##### -->
 706 <para>
 707
 708 </para>
 709
 710 @buffer:
 711 @clipboard:
 712 @default_editable:
 713
 714
 715 <!-- ##### FUNCTION gtk_text_buffer_get_selection_bounds ##### -->
 716 <para>
 717
 718 </para>
 719
 720 @buffer:
 721 @start:
 722 @end:
 723 @Returns:
 724
 725
 726 <!-- ##### FUNCTION gtk_text_buffer_begin_user_action ##### -->
 727 <para>
 728
 729 </para>
 730
 731 @buffer:
 732
 733
 734 <!-- ##### FUNCTION gtk_text_buffer_end_user_action ##### -->
 735 <para>
 736
 737 </para>
 738
 739 @buffer:
 740
 741
 742 <!-- ##### FUNCTION gtk_text_buffer_add_selection_clipboard ##### -->
 743 <para>
 744
 745 </para>
 746
 747 @buffer:
 748 @clipboard:
 749
 750
 751 <!-- ##### FUNCTION gtk_text_buffer_remove_selection_clipboard ##### -->
 752 <para>
 753
 754 </para>
 755
 756 @buffer:
 757 @clipboard:
 758
 759