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