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