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