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