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