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