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