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