Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtktextview.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkTextView
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Widget that displays a <link linkend="GtkTextBuffer">GtkTextBuffer</link>
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 You may wish to begin by reading the <link linkend="TextWidget">text widget
  10 conceptual overview</link> which gives an overview of all the objects and data
  11 types related to the text widget and how they work together.
  12 </para>
  13
  14 <para>
  15
  16 </para>
  17
  18 <!-- ##### SECTION See_Also ##### -->
  19 <para>
  20 #GtkTextBuffer, #GtkTextIter
  21 </para>
  22
  23 <!-- ##### SECTION Stability_Level ##### -->
  24
  25
  26 <!-- ##### STRUCT GtkTextView ##### -->
  27 <para>
  28
  29 </para>
  30
  31
  32 <!-- ##### SIGNAL GtkTextView::backspace ##### -->
  33 <para>
  34
  35 </para>
  36
  37 @textview: the object which received the signal.
  38
  39 <!-- ##### SIGNAL GtkTextView::copy-clipboard ##### -->
  40 <para>
  41
  42 </para>
  43
  44 @textview: the object which received the signal.
  45
  46 <!-- ##### SIGNAL GtkTextView::cut-clipboard ##### -->
  47 <para>
  48
  49 </para>
  50
  51 @textview: the object which received the signal.
  52
  53 <!-- ##### SIGNAL GtkTextView::delete-from-cursor ##### -->
  54 <para>
  55
  56 </para>
  57
  58 @textview: the object which received the signal.
  59 @arg1:
  60 @arg2:
  61
  62 <!-- ##### SIGNAL GtkTextView::insert-at-cursor ##### -->
  63 <para>
  64
  65 </para>
  66
  67 @textview: the object which received the signal.
  68 @arg1:
  69
  70 <!-- ##### SIGNAL GtkTextView::move-cursor ##### -->
  71 <para>
  72
  73 </para>
  74
  75 @textview: the object which received the signal.
  76 @arg1:
  77 @arg2:
  78 @arg3:
  79
  80 <!-- ##### SIGNAL GtkTextView::move-focus ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @textview: the object which received the signal.
  86 @arg1:
  87
  88 <!-- ##### SIGNAL GtkTextView::move-viewport ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @textview: the object which received the signal.
  94 @arg1:
  95 @arg2:
  96
  97 <!-- ##### SIGNAL GtkTextView::page-horizontally ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @textview: the object which received the signal.
 103 @arg1:
 104 @arg2:
 105
 106 <!-- ##### SIGNAL GtkTextView::paste-clipboard ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @textview: the object which received the signal.
 112
 113 <!-- ##### SIGNAL GtkTextView::populate-popup ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @textview: the object which received the signal.
 119 @arg1:
 120
 121 <!-- ##### SIGNAL GtkTextView::select-all ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @textview: the object which received the signal.
 127 @arg1:
 128
 129 <!-- ##### SIGNAL GtkTextView::set-anchor ##### -->
 130 <para>
 131
 132 </para>
 133
 134 @textview: the object which received the signal.
 135
 136 <!-- ##### SIGNAL GtkTextView::set-scroll-adjustments ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @textview: the object which received the signal.
 142 @arg1:
 143 @arg2:
 144
 145 <!-- ##### SIGNAL GtkTextView::toggle-overwrite ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @textview: the object which received the signal.
 151
 152 <!-- ##### ARG GtkTextView:accepts-tab ##### -->
 153 <para>
 154
 155 </para>
 156
 157 <!-- ##### ARG GtkTextView:buffer ##### -->
 158 <para>
 159
 160 </para>
 161
 162 <!-- ##### ARG GtkTextView:cursor-visible ##### -->
 163 <para>
 164
 165 </para>
 166
 167 <!-- ##### ARG GtkTextView:editable ##### -->
 168 <para>
 169
 170 </para>
 171
 172 <!-- ##### ARG GtkTextView:indent ##### -->
 173 <para>
 174
 175 </para>
 176
 177 <!-- ##### ARG GtkTextView:justification ##### -->
 178 <para>
 179
 180 </para>
 181
 182 <!-- ##### ARG GtkTextView:left-margin ##### -->
 183 <para>
 184
 185 </para>
 186
 187 <!-- ##### ARG GtkTextView:overwrite ##### -->
 188 <para>
 189
 190 </para>
 191
 192 <!-- ##### ARG GtkTextView:pixels-above-lines ##### -->
 193 <para>
 194
 195 </para>
 196
 197 <!-- ##### ARG GtkTextView:pixels-below-lines ##### -->
 198 <para>
 199
 200 </para>
 201
 202 <!-- ##### ARG GtkTextView:pixels-inside-wrap ##### -->
 203 <para>
 204
 205 </para>
 206
 207 <!-- ##### ARG GtkTextView:right-margin ##### -->
 208 <para>
 209
 210 </para>
 211
 212 <!-- ##### ARG GtkTextView:tabs ##### -->
 213 <para>
 214
 215 </para>
 216
 217 <!-- ##### ARG GtkTextView:wrap-mode ##### -->
 218 <para>
 219
 220 </para>
 221
 222 <!-- ##### ARG GtkTextView:error-underline-color ##### -->
 223 <para>
 224
 225 </para>
 226
 227 <!-- ##### ENUM GtkTextWindowType ##### -->
 228 <para>
 229
 230 </para>
 231
 232 @GTK_TEXT_WINDOW_PRIVATE:
 233 @GTK_TEXT_WINDOW_WIDGET:
 234 @GTK_TEXT_WINDOW_TEXT:
 235 @GTK_TEXT_WINDOW_LEFT:
 236 @GTK_TEXT_WINDOW_RIGHT:
 237 @GTK_TEXT_WINDOW_TOP:
 238 @GTK_TEXT_WINDOW_BOTTOM:
 239
 240 <!-- ##### FUNCTION gtk_text_view_new ##### -->
 241 <para>
 242
 243 </para>
 244
 245 @Returns:
 246
 247
 248 <!-- ##### FUNCTION gtk_text_view_new_with_buffer ##### -->
 249 <para>
 250
 251 </para>
 252
 253 @buffer:
 254 @Returns:
 255
 256
 257 <!-- ##### FUNCTION gtk_text_view_set_buffer ##### -->
 258 <para>
 259
 260 </para>
 261
 262 @text_view:
 263 @buffer:
 264
 265
 266 <!-- ##### FUNCTION gtk_text_view_get_buffer ##### -->
 267 <para>
 268
 269 </para>
 270
 271 @text_view:
 272 @Returns:
 273
 274
 275 <!-- ##### FUNCTION gtk_text_view_scroll_to_mark ##### -->
 276 <para>
 277
 278 </para>
 279
 280 @text_view:
 281 @mark:
 282 @within_margin:
 283 @use_align:
 284 @xalign:
 285 @yalign:
 286 <!-- # Unused Parameters # -->
 287 @Returns:
 288 @mark_within_margin:
 289
 290
 291 <!-- ##### FUNCTION gtk_text_view_scroll_to_iter ##### -->
 292 <para>
 293
 294 </para>
 295
 296 @text_view:
 297 @iter:
 298 @within_margin:
 299 @use_align:
 300 @xalign:
 301 @yalign:
 302 @Returns:
 303
 304
 305 <!-- ##### FUNCTION gtk_text_view_scroll_mark_onscreen ##### -->
 306 <para>
 307
 308 </para>
 309
 310 @text_view:
 311 @mark:
 312 <!-- # Unused Parameters # -->
 313 @Returns:
 314
 315
 316 <!-- ##### FUNCTION gtk_text_view_move_mark_onscreen ##### -->
 317 <para>
 318
 319 </para>
 320
 321 @text_view:
 322 @mark:
 323 @Returns:
 324
 325
 326 <!-- ##### FUNCTION gtk_text_view_place_cursor_onscreen ##### -->
 327 <para>
 328
 329 </para>
 330
 331 @text_view:
 332 @Returns:
 333
 334
 335 <!-- ##### FUNCTION gtk_text_view_get_visible_rect ##### -->
 336 <para>
 337
 338 </para>
 339
 340 @text_view:
 341 @visible_rect:
 342
 343
 344 <!-- ##### FUNCTION gtk_text_view_get_iter_location ##### -->
 345 <para>
 346
 347 </para>
 348
 349 @text_view:
 350 @iter:
 351 @location:
 352
 353
 354 <!-- ##### FUNCTION gtk_text_view_get_line_at_y ##### -->
 355 <para>
 356
 357 </para>
 358
 359 @text_view:
 360 @target_iter:
 361 @y:
 362 @line_top:
 363
 364
 365 <!-- ##### FUNCTION gtk_text_view_get_line_yrange ##### -->
 366 <para>
 367
 368 </para>
 369
 370 @text_view:
 371 @iter:
 372 @y:
 373 @height:
 374
 375
 376 <!-- ##### FUNCTION gtk_text_view_get_iter_at_location ##### -->
 377 <para>
 378
 379 </para>
 380
 381 @text_view:
 382 @iter:
 383 @x:
 384 @y:
 385
 386
 387 <!-- ##### FUNCTION gtk_text_view_get_iter_at_position ##### -->
 388 <para>
 389
 390 </para>
 391
 392 @text_view:
 393 @iter:
 394 @trailing:
 395 @x:
 396 @y:
 397
 398
 399 <!-- ##### FUNCTION gtk_text_view_buffer_to_window_coords ##### -->
 400 <para>
 401
 402 </para>
 403
 404 @text_view:
 405 @win:
 406 @buffer_x:
 407 @buffer_y:
 408 @window_x:
 409 @window_y:
 410
 411
 412 <!-- ##### FUNCTION gtk_text_view_window_to_buffer_coords ##### -->
 413 <para>
 414
 415 </para>
 416
 417 @text_view:
 418 @win:
 419 @window_x:
 420 @window_y:
 421 @buffer_x:
 422 @buffer_y:
 423
 424
 425 <!-- ##### FUNCTION gtk_text_view_get_window ##### -->
 426 <para>
 427
 428 </para>
 429
 430 @text_view:
 431 @win:
 432 @Returns:
 433
 434
 435 <!-- ##### FUNCTION gtk_text_view_get_window_type ##### -->
 436 <para>
 437
 438 </para>
 439
 440 @text_view:
 441 @window:
 442 @Returns:
 443
 444
 445 <!-- ##### FUNCTION gtk_text_view_set_border_window_size ##### -->
 446 <para>
 447
 448 </para>
 449
 450 @text_view:
 451 @type:
 452 @size:
 453
 454
 455 <!-- ##### FUNCTION gtk_text_view_get_border_window_size ##### -->
 456 <para>
 457
 458 </para>
 459
 460 @text_view:
 461 @type:
 462 @Returns:
 463
 464
 465 <!-- ##### FUNCTION gtk_text_view_forward_display_line ##### -->
 466 <para>
 467
 468 </para>
 469
 470 @text_view:
 471 @iter:
 472 @Returns:
 473
 474
 475 <!-- ##### FUNCTION gtk_text_view_backward_display_line ##### -->
 476 <para>
 477
 478 </para>
 479
 480 @text_view:
 481 @iter:
 482 @Returns:
 483
 484
 485 <!-- ##### FUNCTION gtk_text_view_forward_display_line_end ##### -->
 486 <para>
 487
 488 </para>
 489
 490 @text_view:
 491 @iter:
 492 @Returns:
 493
 494
 495 <!-- ##### FUNCTION gtk_text_view_backward_display_line_start ##### -->
 496 <para>
 497
 498 </para>
 499
 500 @text_view:
 501 @iter:
 502 @Returns:
 503
 504
 505 <!-- ##### FUNCTION gtk_text_view_starts_display_line ##### -->
 506 <para>
 507
 508 </para>
 509
 510 @text_view:
 511 @iter:
 512 @Returns:
 513
 514
 515 <!-- ##### FUNCTION gtk_text_view_move_visually ##### -->
 516 <para>
 517
 518 </para>
 519
 520 @text_view:
 521 @iter:
 522 @count:
 523 @Returns:
 524
 525
 526 <!-- ##### FUNCTION gtk_text_view_add_child_at_anchor ##### -->
 527 <para>
 528
 529 </para>
 530
 531 @text_view:
 532 @child:
 533 @anchor:
 534
 535
 536 <!-- ##### STRUCT GtkTextChildAnchor ##### -->
 537 <para>
 538 A <structname>GtkTextChildAnchor</structname> is a spot in the buffer
 539 where child widgets can be "anchored" (inserted inline, as if they were
 540 characters). The anchor can have multiple widgets anchored, to allow for
 541 multiple views.
 542 </para>
 543
 544
 545 <!-- ##### FUNCTION gtk_text_child_anchor_new ##### -->
 546 <para>
 547
 548 </para>
 549
 550 @Returns:
 551
 552
 553 <!-- ##### FUNCTION gtk_text_child_anchor_get_widgets ##### -->
 554 <para>
 555
 556 </para>
 557
 558 @anchor:
 559 @Returns:
 560
 561
 562 <!-- ##### FUNCTION gtk_text_child_anchor_get_deleted ##### -->
 563 <para>
 564
 565 </para>
 566
 567 @anchor:
 568 @Returns:
 569
 570
 571 <!-- ##### FUNCTION gtk_text_view_add_child_in_window ##### -->
 572 <para>
 573
 574 </para>
 575
 576 @text_view:
 577 @child:
 578 @which_window:
 579 @xpos:
 580 @ypos:
 581
 582
 583 <!-- ##### FUNCTION gtk_text_view_move_child ##### -->
 584 <para>
 585
 586 </para>
 587
 588 @text_view:
 589 @child:
 590 @xpos:
 591 @ypos:
 592
 593
 594 <!-- ##### FUNCTION gtk_text_view_set_wrap_mode ##### -->
 595 <para>
 596
 597 </para>
 598
 599 @text_view:
 600 @wrap_mode:
 601
 602
 603 <!-- ##### FUNCTION gtk_text_view_get_wrap_mode ##### -->
 604 <para>
 605
 606 </para>
 607
 608 @text_view:
 609 @Returns:
 610
 611
 612 <!-- ##### FUNCTION gtk_text_view_set_editable ##### -->
 613 <para>
 614
 615 </para>
 616
 617 @text_view:
 618 @setting:
 619
 620
 621 <!-- ##### FUNCTION gtk_text_view_get_editable ##### -->
 622 <para>
 623
 624 </para>
 625
 626 @text_view:
 627 @Returns:
 628
 629
 630 <!-- ##### FUNCTION gtk_text_view_set_cursor_visible ##### -->
 631 <para>
 632
 633 </para>
 634
 635 @text_view:
 636 @setting:
 637
 638
 639 <!-- ##### FUNCTION gtk_text_view_get_cursor_visible ##### -->
 640 <para>
 641
 642 </para>
 643
 644 @text_view:
 645 @Returns:
 646
 647
 648 <!-- ##### FUNCTION gtk_text_view_set_overwrite ##### -->
 649 <para>
 650
 651 </para>
 652
 653 @text_view:
 654 @overwrite:
 655
 656
 657 <!-- ##### FUNCTION gtk_text_view_get_overwrite ##### -->
 658 <para>
 659
 660 </para>
 661
 662 @text_view:
 663 @Returns:
 664
 665
 666 <!-- ##### FUNCTION gtk_text_view_set_pixels_above_lines ##### -->
 667 <para>
 668
 669 </para>
 670
 671 @text_view:
 672 @pixels_above_lines:
 673
 674
 675 <!-- ##### FUNCTION gtk_text_view_get_pixels_above_lines ##### -->
 676 <para>
 677
 678 </para>
 679
 680 @text_view:
 681 @Returns:
 682
 683
 684 <!-- ##### FUNCTION gtk_text_view_set_pixels_below_lines ##### -->
 685 <para>
 686
 687 </para>
 688
 689 @text_view:
 690 @pixels_below_lines:
 691
 692
 693 <!-- ##### FUNCTION gtk_text_view_get_pixels_below_lines ##### -->
 694 <para>
 695
 696 </para>
 697
 698 @text_view:
 699 @Returns:
 700
 701
 702 <!-- ##### FUNCTION gtk_text_view_set_pixels_inside_wrap ##### -->
 703 <para>
 704
 705 </para>
 706
 707 @text_view:
 708 @pixels_inside_wrap:
 709
 710
 711 <!-- ##### FUNCTION gtk_text_view_get_pixels_inside_wrap ##### -->
 712 <para>
 713
 714 </para>
 715
 716 @text_view:
 717 @Returns:
 718
 719
 720 <!-- ##### FUNCTION gtk_text_view_set_justification ##### -->
 721 <para>
 722
 723 </para>
 724
 725 @text_view:
 726 @justification:
 727
 728
 729 <!-- ##### FUNCTION gtk_text_view_get_justification ##### -->
 730 <para>
 731
 732 </para>
 733
 734 @text_view:
 735 @Returns:
 736
 737
 738 <!-- ##### FUNCTION gtk_text_view_set_left_margin ##### -->
 739 <para>
 740
 741 </para>
 742
 743 @text_view:
 744 @left_margin:
 745
 746
 747 <!-- ##### FUNCTION gtk_text_view_get_left_margin ##### -->
 748 <para>
 749
 750 </para>
 751
 752 @text_view:
 753 @Returns:
 754
 755
 756 <!-- ##### FUNCTION gtk_text_view_set_right_margin ##### -->
 757 <para>
 758
 759 </para>
 760
 761 @text_view:
 762 @right_margin:
 763
 764
 765 <!-- ##### FUNCTION gtk_text_view_get_right_margin ##### -->
 766 <para>
 767
 768 </para>
 769
 770 @text_view:
 771 @Returns:
 772
 773
 774 <!-- ##### FUNCTION gtk_text_view_set_indent ##### -->
 775 <para>
 776
 777 </para>
 778
 779 @text_view:
 780 @indent:
 781
 782
 783 <!-- ##### FUNCTION gtk_text_view_get_indent ##### -->
 784 <para>
 785
 786 </para>
 787
 788 @text_view:
 789 @Returns:
 790
 791
 792 <!-- ##### FUNCTION gtk_text_view_set_tabs ##### -->
 793 <para>
 794
 795 </para>
 796
 797 @text_view:
 798 @tabs:
 799
 800
 801 <!-- ##### FUNCTION gtk_text_view_get_tabs ##### -->
 802 <para>
 803
 804 </para>
 805
 806 @text_view:
 807 @Returns:
 808
 809
 810 <!-- ##### FUNCTION gtk_text_view_set_accepts_tab ##### -->
 811 <para>
 812
 813 </para>
 814
 815 @text_view:
 816 @accepts_tab:
 817
 818
 819 <!-- ##### FUNCTION gtk_text_view_get_accepts_tab ##### -->
 820 <para>
 821
 822 </para>
 823
 824 @text_view:
 825 @Returns:
 826
 827
 828 <!-- ##### FUNCTION gtk_text_view_get_default_attributes ##### -->
 829 <para>
 830
 831 </para>
 832
 833 @text_view:
 834 @Returns:
 835
 836
 837 <!-- ##### MACRO GTK_TEXT_VIEW_PRIORITY_VALIDATE ##### -->
 838 <para>
 839 The priority at which the text view validates onscreen lines
 840 in an idle job in the background.
 841 </para>
 842
 843
 844