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