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_index:
 338 @end_index:
 339
 340
 341 <!-- ##### FUNCTION gtk_text_buffer_remove_tag ##### -->
 342 <para>
 343
 344 </para>
 345
 346 @buffer:
 347 @tag:
 348 @start_index:
 349 @end_index:
 350
 351
 352 <!-- ##### FUNCTION gtk_text_buffer_apply_tag_by_name ##### -->
 353 <para>
 354
 355 </para>
 356
 357 @buffer:
 358 @name:
 359 @start_index:
 360 @end_index:
 361
 362
 363 <!-- ##### FUNCTION gtk_text_buffer_remove_tag_by_name ##### -->
 364 <para>
 365
 366 </para>
 367
 368 @buffer:
 369 @name:
 370 @start_index:
 371 @end_index:
 372
 373
 374 <!-- ##### FUNCTION gtk_text_buffer_create_tag ##### -->
 375 <para>
 376
 377 </para>
 378
 379 @buffer:
 380 @tag_name:
 381 @Returns:
 382
 383
 384 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line_offset ##### -->
 385 <para>
 386
 387 </para>
 388
 389 @buffer:
 390 @iter:
 391 @line_number:
 392 @char_offset:
 393
 394
 395 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_offset ##### -->
 396 <para>
 397
 398 </para>
 399
 400 @buffer:
 401 @iter:
 402 @char_offset:
 403
 404
 405 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line ##### -->
 406 <para>
 407
 408 </para>
 409
 410 @buffer:
 411 @iter:
 412 @line_number:
 413
 414
 415 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_line_index ##### -->
 416 <para>
 417
 418 </para>
 419
 420 @buffer:
 421 @iter:
 422 @line_number:
 423 @byte_index:
 424
 425
 426 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_mark ##### -->
 427 <para>
 428
 429 </para>
 430
 431 @buffer:
 432 @iter:
 433 @mark:
 434
 435
 436 <!-- ##### FUNCTION gtk_text_buffer_get_iter_at_child_anchor ##### -->
 437 <para>
 438
 439 </para>
 440
 441 @buffer:
 442 @iter:
 443 @anchor:
 444
 445
 446 <!-- ##### FUNCTION gtk_text_buffer_get_last_iter ##### -->
 447 <para>
 448
 449 </para>
 450
 451 @buffer:
 452 @iter:
 453
 454
 455 <!-- ##### FUNCTION gtk_text_buffer_get_bounds ##### -->
 456 <para>
 457
 458 </para>
 459
 460 @buffer:
 461 @start:
 462 @end:
 463
 464
 465 <!-- ##### FUNCTION gtk_text_buffer_get_tags ##### -->
 466 <para>
 467
 468 </para>
 469
 470 @buffer:
 471 @iter:
 472 @Returns:
 473
 474
 475 <!-- ##### FUNCTION gtk_text_buffer_modified ##### -->
 476 <para>
 477
 478 </para>
 479
 480 @buffer:
 481 @Returns:
 482
 483
 484 <!-- ##### FUNCTION gtk_text_buffer_set_modified ##### -->
 485 <para>
 486
 487 </para>
 488
 489 @buffer:
 490 @setting:
 491
 492
 493 <!-- ##### FUNCTION gtk_text_buffer_delete_selection ##### -->
 494 <para>
 495
 496 </para>
 497
 498 @buffer:
 499 @interactive:
 500 @default_editable:
 501 @Returns:
 502
 503
 504 <!-- ##### FUNCTION gtk_text_buffer_paste_clipboard ##### -->
 505 <para>
 506
 507 </para>
 508
 509 @buffer:
 510 @default_editable:
 511 <!-- # Unused Parameters # -->
 512 @time:
 513 @interactive:
 514
 515
 516 <!-- ##### FUNCTION gtk_text_buffer_copy_clipboard ##### -->
 517 <para>
 518
 519 </para>
 520
 521 @buffer:
 522
 523
 524 <!-- ##### FUNCTION gtk_text_buffer_cut_clipboard ##### -->
 525 <para>
 526
 527 </para>
 528
 529 @buffer:
 530 @default_editable:
 531
 532
 533 <!-- ##### FUNCTION gtk_text_buffer_paste_primary ##### -->
 534 <para>
 535
 536 </para>
 537
 538 @buffer:
 539 @override_location:
 540 @default_editable:
 541
 542
 543 <!-- ##### FUNCTION gtk_text_buffer_get_selection_bounds ##### -->
 544 <para>
 545
 546 </para>
 547
 548 @buffer:
 549 @start:
 550 @end:
 551 @Returns:
 552
 553
 554 <!-- ##### SIGNAL GtkTextBuffer::apply-tag ##### -->
 555 <para>
 556
 557 </para>
 558
 559 @textbuffer: the object which received the signal.
 560 @arg1:
 561 @arg2:
 562 @arg3:
 563
 564 <!-- ##### SIGNAL GtkTextBuffer::changed ##### -->
 565 <para>
 566
 567 </para>
 568
 569 @textbuffer: the object which received the signal.
 570
 571 <!-- ##### SIGNAL GtkTextBuffer::delete-text ##### -->
 572 <para>
 573
 574 </para>
 575
 576 @textbuffer: the object which received the signal.
 577 @arg1:
 578 @arg2:
 579 @arg3:
 580
 581 <!-- ##### SIGNAL GtkTextBuffer::insert-text ##### -->
 582 <para>
 583
 584 </para>
 585
 586 @textbuffer: the object which received the signal.
 587 @arg1:
 588 @arg2:
 589 @arg3:
 590 @arg4:
 591
 592 <!-- ##### SIGNAL GtkTextBuffer::mark-deleted ##### -->
 593 <para>
 594
 595 </para>
 596
 597 @textbuffer: the object which received the signal.
 598 @arg1:
 599
 600 <!-- ##### SIGNAL GtkTextBuffer::mark-set ##### -->
 601 <para>
 602
 603 </para>
 604
 605 @textbuffer: the object which received the signal.
 606 @arg1:
 607 @arg2:
 608
 609 <!-- ##### SIGNAL GtkTextBuffer::modified-changed ##### -->
 610 <para>
 611
 612 </para>
 613
 614 @textbuffer: the object which received the signal.
 615
 616 <!-- ##### SIGNAL GtkTextBuffer::remove-tag ##### -->
 617 <para>
 618
 619 </para>
 620
 621 @textbuffer: the object which received the signal.
 622 @arg1:
 623 @arg2:
 624 @arg3:
 625