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_set_text ##### -->
 299 <para>
 300
 301 </para>
 302
 303 @buffer:
 304 @text:
 305 @len:
 306
 307
 308 <!-- ##### FUNCTION gtk_text_buffer_get_text ##### -->
 309 <para>
 310
 311 </para>
 312
 313 @buffer:
 314 @start:
 315 @end:
 316 @include_hidden_chars:
 317 @Returns:
 318 <!-- # Unused Parameters # -->
 319 @start_iter:
 320 @end_iter:
 321
 322
 323 <!-- ##### FUNCTION gtk_text_buffer_get_slice ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @buffer:
 329 @start:
 330 @end:
 331 @include_hidden_chars:
 332 @Returns:
 333 <!-- # Unused Parameters # -->
 334 @start_iter:
 335 @end_iter:
 336
 337
 338 <!-- ##### FUNCTION gtk_text_buffer_insert_pixbuf ##### -->
 339 <para>
 340
 341 </para>
 342
 343 @buffer:
 344 @iter:
 345 @pixbuf:
 346
 347
 348 <!-- ##### FUNCTION gtk_text_buffer_insert_child_anchor ##### -->
 349 <para>
 350
 351 </para>
 352
 353 @buffer:
 354 @iter:
 355 @anchor:
 356
 357
 358 <!-- ##### FUNCTION gtk_text_buffer_create_child_anchor ##### -->
 359 <para>
 360
 361 </para>
 362
 363 @buffer:
 364 @iter:
 365 @Returns:
 366
 367
 368 <!-- ##### FUNCTION gtk_text_buffer_create_mark ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @buffer:
 374 @mark_name:
 375 @where:
 376 @left_gravity:
 377 @Returns:
 378
 379
 380 <!-- ##### FUNCTION gtk_text_buffer_move_mark ##### -->
 381 <para>
 382
 383 </para>
 384
 385 @buffer:
 386 @mark:
 387 @where:
 388
 389
 390 <!-- ##### FUNCTION gtk_text_buffer_move_mark_by_name ##### -->
 391 <para>
 392
 393 </para>
 394
 395 @buffer:
 396 @name:
 397 @where:
 398
 399
 400 <!-- ##### FUNCTION gtk_text_buffer_delete_mark ##### -->
 401 <para>
 402
 403 </para>
 404
 405 @buffer:
 406 @mark:
 407
 408
 409 <!-- ##### FUNCTION gtk_text_buffer_delete_mark_by_name ##### -->
 410 <para>
 411
 412 </para>
 413
 414 @buffer:
 415 @name:
 416
 417
 418 <!-- ##### FUNCTION gtk_text_buffer_get_mark ##### -->
 419 <para>
 420
 421 </para>
 422
 423 @buffer:
 424 @name:
 425 @Returns:
 426
 427
 428 <!-- ##### FUNCTION gtk_text_buffer_get_insert ##### -->
 429 <para>
 430
 431 </para>
 432
 433 @buffer:
 434 @Returns:
 435
 436
 437 <!-- ##### FUNCTION gtk_text_buffer_get_selection_bound ##### -->
 438 <para>
 439
 440 </para>
 441
 442 @buffer:
 443 @Returns:
 444
 445
 446 <!-- ##### FUNCTION gtk_text_buffer_place_cursor ##### -->
 447 <para>
 448
 449 </para>
 450
 451 @buffer:
 452 @where:
 453
 454
 455 <!-- ##### FUNCTION gtk_text_buffer_select_range ##### -->
 456 <para>
 457
 458 </para>
 459
 460 @buffer:
 461 @ins:
 462 @bound:
 463
 464
 465 <!-- ##### FUNCTION gtk_text_buffer_apply_tag ##### -->
 466 <para>
 467
 468 </para>
 469
 470 @buffer:
 471 @tag:
 472 @start:
 473 @end:
 474 <!-- # Unused Parameters # -->
 475 @start_index:
 476 @end_index:
 477
 478
 479 <!-- ##### FUNCTION gtk_text_buffer_remove_tag ##### -->
 480 <para>
 481
 482 </para>
 483
 484 @buffer:
 485 @tag:
 486 @start:
 487 @end:
 488 <!-- # Unused Parameters # -->
 489 @start_index:
 490 @end_index:
 491
 492
 493 <!-- ##### FUNCTION gtk_text_buffer_apply_tag_by_name ##### -->
 494 <para>
 495
 496 </para>
 497
 498 @buffer:
 499 @name:
 500 @start:
 501 @end:
 502 <!-- # Unused Parameters # -->
 503 @start_index:
 504 @end_index:
 505
 506
 507 <!-- ##### FUNCTION gtk_text_buffer_remove_tag_by_name ##### -->
 508 <para>
 509
 510 </para>
 511
 512 @buffer:
 513 @name:
 514 @start:
 515 @end:
 516 <!-- # Unused Parameters # -->
 517 @start_index:
 518 @end_index:
 519
 520
 521 <!-- ##### FUNCTION gtk_text_buffer_remove_all_tags ##### -->
 522 <para>
 523
 524 </para>
 525
 526 @buffer:
 527 @start:
 528 @end:
 529
 530
 531 <!-- ##### FUNCTION gtk_text_buffer_create_tag ##### -->
 532 <para>
 533
 534 </para>
 535
 536 @buffer:
 537 @tag_name:
 538 @first_property_name:
 539 @Varargs:
 540 @Returns:
 541
 542
 543 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line_offset ##### -->
 544 <para>
 545
 546 </para>
 547
 548 @buffer:
 549 @iter:
 550 @line_number:
 551 @char_offset:
 552
 553
 554 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_offset ##### -->
 555 <para>
 556
 557 </para>
 558
 559 @buffer:
 560 @iter:
 561 @char_offset:
 562
 563
 564 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line ##### -->
 565 <para>
 566
 567 </para>
 568
 569 @buffer:
 570 @iter:
 571 @line_number:
 572
 573
 574 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line_index ##### -->
 575 <para>
 576
 577 </para>
 578
 579 @buffer:
 580 @iter:
 581 @line_number:
 582 @byte_index:
 583
 584
 585 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_mark ##### -->
 586 <para>
 587
 588 </para>
 589
 590 @buffer:
 591 @iter:
 592 @mark:
 593
 594
 595 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_child_anchor ##### -->
 596 <para>
 597
 598 </para>
 599
 600 @buffer:
 601 @iter:
 602 @anchor:
 603
 604
 605 <!-- ##### FUNCTION gtk_text_buffer_get_start_iter ##### -->
 606 <para>
 607
 608 </para>
 609
 610 @buffer:
 611 @iter:
 612
 613
 614 <!-- ##### FUNCTION gtk_text_buffer_get_end_iter ##### -->
 615 <para>
 616
 617 </para>
 618
 619 @buffer:
 620 @iter:
 621
 622
 623 <!-- ##### FUNCTION gtk_text_buffer_get_bounds ##### -->
 624 <para>
 625
 626 </para>
 627
 628 @buffer:
 629 @start:
 630 @end:
 631
 632
 633 <!-- ##### FUNCTION gtk_text_buffer_get_modified ##### -->
 634 <para>
 635
 636 </para>
 637
 638 @buffer:
 639 @Returns:
 640
 641
 642 <!-- ##### FUNCTION gtk_text_buffer_set_modified ##### -->
 643 <para>
 644
 645 </para>
 646
 647 @buffer:
 648 @setting:
 649
 650
 651 <!-- ##### FUNCTION gtk_text_buffer_delete_selection ##### -->
 652 <para>
 653
 654 </para>
 655
 656 @buffer:
 657 @interactive:
 658 @default_editable:
 659 @Returns:
 660
 661
 662 <!-- ##### FUNCTION gtk_text_buffer_paste_clipboard ##### -->
 663 <para>
 664
 665 </para>
 666
 667 @buffer:
 668 @clipboard:
 669 @override_location:
 670 @default_editable:
 671 <!-- # Unused Parameters # -->
 672 @time_:
 673 @interactive:
 674
 675
 676 <!-- ##### FUNCTION gtk_text_buffer_copy_clipboard ##### -->
 677 <para>
 678
 679 </para>
 680
 681 @buffer:
 682 @clipboard:
 683
 684
 685 <!-- ##### FUNCTION gtk_text_buffer_cut_clipboard ##### -->
 686 <para>
 687
 688 </para>
 689
 690 @buffer:
 691 @clipboard:
 692 @default_editable:
 693
 694
 695 <!-- ##### FUNCTION gtk_text_buffer_get_selection_bounds ##### -->
 696 <para>
 697
 698 </para>
 699
 700 @buffer:
 701 @start:
 702 @end:
 703 @Returns:
 704
 705
 706 <!-- ##### FUNCTION gtk_text_buffer_begin_user_action ##### -->
 707 <para>
 708
 709 </para>
 710
 711 @buffer:
 712
 713
 714 <!-- ##### FUNCTION gtk_text_buffer_end_user_action ##### -->
 715 <para>
 716
 717 </para>
 718
 719 @buffer:
 720
 721
 722 <!-- ##### FUNCTION gtk_text_buffer_add_selection_clipboard ##### -->
 723 <para>
 724
 725 </para>
 726
 727 @buffer:
 728 @clipboard:
 729
 730
 731 <!-- ##### FUNCTION gtk_text_buffer_remove_selection_clipboard ##### -->
 732 <para>
 733
 734 </para>
 735
 736 @buffer:
 737 @clipboard:
 738
 739