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_create_child_anchor ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @buffer:
 239 @iter:
 240 @Returns:
 241
 242
 243 <!-- ##### FUNCTION gtk_text_buffer_create_mark ##### -->
 244 <para>
 245
 246 </para>
 247
 248 @buffer:
 249 @mark_name:
 250 @where:
 251 @left_gravity:
 252 @Returns:
 253
 254
 255 <!-- ##### FUNCTION gtk_text_buffer_move_mark ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @buffer:
 261 @mark:
 262 @where:
 263
 264
 265 <!-- ##### FUNCTION gtk_text_buffer_move_mark_by_name ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @buffer:
 271 @name:
 272 @where:
 273
 274
 275 <!-- ##### FUNCTION gtk_text_buffer_delete_mark ##### -->
 276 <para>
 277
 278 </para>
 279
 280 @buffer:
 281 @mark:
 282
 283
 284 <!-- ##### FUNCTION gtk_text_buffer_delete_mark_by_name ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @buffer:
 290 @name:
 291
 292
 293 <!-- ##### FUNCTION gtk_text_buffer_get_mark ##### -->
 294 <para>
 295
 296 </para>
 297
 298 @buffer:
 299 @name:
 300 @Returns:
 301
 302
 303 <!-- ##### FUNCTION gtk_text_buffer_get_insert ##### -->
 304 <para>
 305
 306 </para>
 307
 308 @buffer:
 309 @Returns:
 310
 311
 312 <!-- ##### FUNCTION gtk_text_buffer_get_selection_bound ##### -->
 313 <para>
 314
 315 </para>
 316
 317 @buffer:
 318 @Returns:
 319
 320
 321 <!-- ##### FUNCTION gtk_text_buffer_place_cursor ##### -->
 322 <para>
 323
 324 </para>
 325
 326 @buffer:
 327 @where:
 328
 329
 330 <!-- ##### FUNCTION gtk_text_buffer_apply_tag ##### -->
 331 <para>
 332
 333 </para>
 334
 335 @buffer:
 336 @tag:
 337 @start:
 338 @end:
 339 <!-- # Unused Parameters # -->
 340 @start_index:
 341 @end_index:
 342
 343
 344 <!-- ##### FUNCTION gtk_text_buffer_remove_tag ##### -->
 345 <para>
 346
 347 </para>
 348
 349 @buffer:
 350 @tag:
 351 @start:
 352 @end:
 353 <!-- # Unused Parameters # -->
 354 @start_index:
 355 @end_index:
 356
 357
 358 <!-- ##### FUNCTION gtk_text_buffer_apply_tag_by_name ##### -->
 359 <para>
 360
 361 </para>
 362
 363 @buffer:
 364 @name:
 365 @start:
 366 @end:
 367 <!-- # Unused Parameters # -->
 368 @start_index:
 369 @end_index:
 370
 371
 372 <!-- ##### FUNCTION gtk_text_buffer_remove_tag_by_name ##### -->
 373 <para>
 374
 375 </para>
 376
 377 @buffer:
 378 @name:
 379 @start:
 380 @end:
 381 <!-- # Unused Parameters # -->
 382 @start_index:
 383 @end_index:
 384
 385
 386 <!-- ##### FUNCTION gtk_text_buffer_create_tag ##### -->
 387 <para>
 388
 389 </para>
 390
 391 @buffer:
 392 @tag_name:
 393 @first_property_name:
 394 @Varargs:
 395 @Returns:
 396
 397
 398 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line_offset ##### -->
 399 <para>
 400
 401 </para>
 402
 403 @buffer:
 404 @iter:
 405 @line_number:
 406 @char_offset:
 407
 408
 409 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_offset ##### -->
 410 <para>
 411
 412 </para>
 413
 414 @buffer:
 415 @iter:
 416 @char_offset:
 417
 418
 419 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line ##### -->
 420 <para>
 421
 422 </para>
 423
 424 @buffer:
 425 @iter:
 426 @line_number:
 427
 428
 429 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line_index ##### -->
 430 <para>
 431
 432 </para>
 433
 434 @buffer:
 435 @iter:
 436 @line_number:
 437 @byte_index:
 438
 439
 440 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_mark ##### -->
 441 <para>
 442
 443 </para>
 444
 445 @buffer:
 446 @iter:
 447 @mark:
 448
 449
 450 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_child_anchor ##### -->
 451 <para>
 452
 453 </para>
 454
 455 @buffer:
 456 @iter:
 457 @anchor:
 458
 459
 460 <!-- ##### FUNCTION gtk_text_buffer_get_bounds ##### -->
 461 <para>
 462
 463 </para>
 464
 465 @buffer:
 466 @start:
 467 @end:
 468
 469
 470 <!-- ##### FUNCTION gtk_text_buffer_set_modified ##### -->
 471 <para>
 472
 473 </para>
 474
 475 @buffer:
 476 @setting:
 477
 478
 479 <!-- ##### FUNCTION gtk_text_buffer_delete_selection ##### -->
 480 <para>
 481
 482 </para>
 483
 484 @buffer:
 485 @interactive:
 486 @default_editable:
 487 @Returns:
 488
 489
 490 <!-- ##### FUNCTION gtk_text_buffer_paste_clipboard ##### -->
 491 <para>
 492
 493 </para>
 494
 495 @buffer:
 496 @default_editable:
 497 <!-- # Unused Parameters # -->
 498 @time:
 499 @interactive:
 500
 501
 502 <!-- ##### FUNCTION gtk_text_buffer_copy_clipboard ##### -->
 503 <para>
 504
 505 </para>
 506
 507 @buffer:
 508
 509
 510 <!-- ##### FUNCTION gtk_text_buffer_cut_clipboard ##### -->
 511 <para>
 512
 513 </para>
 514
 515 @buffer:
 516 @default_editable:
 517
 518
 519 <!-- ##### FUNCTION gtk_text_buffer_paste_primary ##### -->
 520 <para>
 521
 522 </para>
 523
 524 @buffer:
 525 @override_location:
 526 @default_editable:
 527
 528
 529 <!-- ##### FUNCTION gtk_text_buffer_get_selection_bounds ##### -->
 530 <para>
 531
 532 </para>
 533
 534 @buffer:
 535 @start:
 536 @end:
 537 @Returns:
 538
 539
 540 <!-- ##### FUNCTION gtk_text_buffer_begin_user_action ##### -->
 541 <para>
 542
 543 </para>
 544
 545 @buffer:
 546
 547
 548 <!-- ##### FUNCTION gtk_text_buffer_end_user_action ##### -->
 549 <para>
 550
 551 </para>
 552
 553 @buffer:
 554
 555
 556 <!-- ##### SIGNAL GtkTextBuffer::apply-tag ##### -->
 557 <para>
 558
 559 </para>
 560
 561 @textbuffer: the object which received the signal.
 562 @arg1:
 563 @arg2:
 564 @arg3:
 565
 566 <!-- ##### SIGNAL GtkTextBuffer::begin-user-action ##### -->
 567 <para>
 568
 569 </para>
 570
 571 @textbuffer: the object which received the signal.
 572
 573 <!-- ##### SIGNAL GtkTextBuffer::changed ##### -->
 574 <para>
 575
 576 </para>
 577
 578 @textbuffer: the object which received the signal.
 579
 580 <!-- ##### SIGNAL GtkTextBuffer::delete-range ##### -->
 581 <para>
 582
 583 </para>
 584
 585 @textbuffer: the object which received the signal.
 586 @arg1:
 587 @arg2:
 588
 589 <!-- ##### SIGNAL GtkTextBuffer::end-user-action ##### -->
 590 <para>
 591
 592 </para>
 593
 594 @textbuffer: the object which received the signal.
 595
 596 <!-- ##### SIGNAL GtkTextBuffer::insert-child-anchor ##### -->
 597 <para>
 598
 599 </para>
 600
 601 @textbuffer: the object which received the signal.
 602 @arg1:
 603 @arg2:
 604
 605 <!-- ##### SIGNAL GtkTextBuffer::insert-pixbuf ##### -->
 606 <para>
 607
 608 </para>
 609
 610 @textbuffer: the object which received the signal.
 611 @arg1:
 612 @arg2:
 613
 614 <!-- ##### SIGNAL GtkTextBuffer::insert-text ##### -->
 615 <para>
 616
 617 </para>
 618
 619 @textbuffer: the object which received the signal.
 620 @arg1:
 621 @arg2:
 622 @arg3:
 623 <!-- # Unused Parameters # -->
 624 @arg4:
 625
 626 <!-- ##### SIGNAL GtkTextBuffer::mark-deleted ##### -->
 627 <para>
 628
 629 </para>
 630
 631 @textbuffer: the object which received the signal.
 632 @arg1:
 633
 634 <!-- ##### SIGNAL GtkTextBuffer::mark-set ##### -->
 635 <para>
 636
 637 </para>
 638
 639 @textbuffer: the object which received the signal.
 640 @arg1:
 641 @arg2:
 642
 643 <!-- ##### SIGNAL GtkTextBuffer::modified-changed ##### -->
 644 <para>
 645
 646 </para>
 647
 648 @textbuffer: the object which received the signal.
 649
 650 <!-- ##### SIGNAL GtkTextBuffer::remove-tag ##### -->
 651 <para>
 652
 653 </para>
 654
 655 @textbuffer: the object which received the signal.
 656 @arg1:
 657 @arg2:
 658 @arg3:
 659