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 A <structname>GtkTextChildAnchor</structname> is a spot in the buffer
 329 where child widgets can be "anchored" (inserted inline, as if they were
 330 characters). The anchor can have multiple widgets anchored, to allow for
 331 multiple views.
 332 </para>
 333
 334
 335 <!-- ##### FUNCTION gtk_text_child_anchor_new ##### -->
 336 <para>
 337
 338 </para>
 339
 340 @Returns:
 341
 342
 343 <!-- ##### FUNCTION gtk_text_child_anchor_get_widgets ##### -->
 344 <para>
 345
 346 </para>
 347
 348 @anchor:
 349 @Returns:
 350
 351
 352 <!-- ##### FUNCTION gtk_text_child_anchor_get_deleted ##### -->
 353 <para>
 354
 355 </para>
 356
 357 @anchor:
 358 @Returns:
 359
 360
 361 <!-- ##### FUNCTION gtk_text_view_add_child_in_window ##### -->
 362 <para>
 363
 364 </para>
 365
 366 @text_view:
 367 @child:
 368 @which_window:
 369 @xpos:
 370 @ypos:
 371
 372
 373 <!-- ##### FUNCTION gtk_text_view_move_child ##### -->
 374 <para>
 375
 376 </para>
 377
 378 @text_view:
 379 @child:
 380 @xpos:
 381 @ypos:
 382
 383
 384 <!-- ##### FUNCTION gtk_text_view_set_wrap_mode ##### -->
 385 <para>
 386
 387 </para>
 388
 389 @text_view:
 390 @wrap_mode:
 391
 392
 393 <!-- ##### FUNCTION gtk_text_view_get_wrap_mode ##### -->
 394 <para>
 395
 396 </para>
 397
 398 @text_view:
 399 @Returns:
 400
 401
 402 <!-- ##### FUNCTION gtk_text_view_set_editable ##### -->
 403 <para>
 404
 405 </para>
 406
 407 @text_view:
 408 @setting:
 409
 410
 411 <!-- ##### FUNCTION gtk_text_view_get_editable ##### -->
 412 <para>
 413
 414 </para>
 415
 416 @text_view:
 417 @Returns:
 418
 419
 420 <!-- ##### FUNCTION gtk_text_view_set_cursor_visible ##### -->
 421 <para>
 422
 423 </para>
 424
 425 @text_view:
 426 @setting:
 427
 428
 429 <!-- ##### FUNCTION gtk_text_view_get_cursor_visible ##### -->
 430 <para>
 431
 432 </para>
 433
 434 @text_view:
 435 @Returns:
 436
 437
 438 <!-- ##### FUNCTION gtk_text_view_set_pixels_above_lines ##### -->
 439 <para>
 440
 441 </para>
 442
 443 @text_view:
 444 @pixels_above_lines:
 445
 446
 447 <!-- ##### FUNCTION gtk_text_view_get_pixels_above_lines ##### -->
 448 <para>
 449
 450 </para>
 451
 452 @text_view:
 453 @Returns:
 454
 455
 456 <!-- ##### FUNCTION gtk_text_view_set_pixels_below_lines ##### -->
 457 <para>
 458
 459 </para>
 460
 461 @text_view:
 462 @pixels_below_lines:
 463
 464
 465 <!-- ##### FUNCTION gtk_text_view_get_pixels_below_lines ##### -->
 466 <para>
 467
 468 </para>
 469
 470 @text_view:
 471 @Returns:
 472
 473
 474 <!-- ##### FUNCTION gtk_text_view_set_pixels_inside_wrap ##### -->
 475 <para>
 476
 477 </para>
 478
 479 @text_view:
 480 @pixels_inside_wrap:
 481
 482
 483 <!-- ##### FUNCTION gtk_text_view_get_pixels_inside_wrap ##### -->
 484 <para>
 485
 486 </para>
 487
 488 @text_view:
 489 @Returns:
 490
 491
 492 <!-- ##### FUNCTION gtk_text_view_set_justification ##### -->
 493 <para>
 494
 495 </para>
 496
 497 @text_view:
 498 @justification:
 499
 500
 501 <!-- ##### FUNCTION gtk_text_view_get_justification ##### -->
 502 <para>
 503
 504 </para>
 505
 506 @text_view:
 507 @Returns:
 508
 509
 510 <!-- ##### FUNCTION gtk_text_view_set_left_margin ##### -->
 511 <para>
 512
 513 </para>
 514
 515 @text_view:
 516 @left_margin:
 517
 518
 519 <!-- ##### FUNCTION gtk_text_view_get_left_margin ##### -->
 520 <para>
 521
 522 </para>
 523
 524 @text_view:
 525 @Returns:
 526
 527
 528 <!-- ##### FUNCTION gtk_text_view_set_right_margin ##### -->
 529 <para>
 530
 531 </para>
 532
 533 @text_view:
 534 @right_margin:
 535
 536
 537 <!-- ##### FUNCTION gtk_text_view_get_right_margin ##### -->
 538 <para>
 539
 540 </para>
 541
 542 @text_view:
 543 @Returns:
 544
 545
 546 <!-- ##### FUNCTION gtk_text_view_set_indent ##### -->
 547 <para>
 548
 549 </para>
 550
 551 @text_view:
 552 @indent:
 553
 554
 555 <!-- ##### FUNCTION gtk_text_view_get_indent ##### -->
 556 <para>
 557
 558 </para>
 559
 560 @text_view:
 561 @Returns:
 562
 563
 564 <!-- ##### FUNCTION gtk_text_view_set_tabs ##### -->
 565 <para>
 566
 567 </para>
 568
 569 @text_view:
 570 @tabs:
 571
 572
 573 <!-- ##### FUNCTION gtk_text_view_get_tabs ##### -->
 574 <para>
 575
 576 </para>
 577
 578 @text_view:
 579 @Returns:
 580
 581
 582 <!-- ##### FUNCTION gtk_text_view_get_default_attributes ##### -->
 583 <para>
 584
 585 </para>
 586
 587 @text_view:
 588 @Returns:
 589
 590
 591 <!-- ##### MACRO GTK_TEXT_VIEW_PRIORITY_VALIDATE ##### -->
 592 <para>
 593 The priority at which the text view validates onscreen lines
 594 in an idle job in the background.
 595 </para>
 596
 597
 598
 599 <!-- ##### SIGNAL GtkTextView::copy-clipboard ##### -->
 600 <para>
 601
 602 </para>
 603
 604 @textview: the object which received the signal.
 605
 606 <!-- ##### SIGNAL GtkTextView::cut-clipboard ##### -->
 607 <para>
 608
 609 </para>
 610
 611 @textview: the object which received the signal.
 612
 613 <!-- ##### SIGNAL GtkTextView::delete-from-cursor ##### -->
 614 <para>
 615
 616 </para>
 617
 618 @textview: the object which received the signal.
 619 @arg1:
 620 @arg2:
 621
 622 <!-- ##### SIGNAL GtkTextView::insert-at-cursor ##### -->
 623 <para>
 624
 625 </para>
 626
 627 @textview: the object which received the signal.
 628 @arg1:
 629
 630 <!-- ##### SIGNAL GtkTextView::move-cursor ##### -->
 631 <para>
 632
 633 </para>
 634
 635 @textview: the object which received the signal.
 636 @arg1:
 637 @arg2:
 638 @arg3:
 639
 640 <!-- ##### SIGNAL GtkTextView::move-focus ##### -->
 641 <para>
 642
 643 </para>
 644
 645 @textview: the object which received the signal.
 646 @arg1:
 647
 648 <!-- ##### SIGNAL GtkTextView::page-horizontally ##### -->
 649 <para>
 650
 651 </para>
 652
 653 @textview: the object which received the signal.
 654 @arg1:
 655 @arg2:
 656
 657 <!-- ##### SIGNAL GtkTextView::paste-clipboard ##### -->
 658 <para>
 659
 660 </para>
 661
 662 @textview: the object which received the signal.
 663
 664 <!-- ##### SIGNAL GtkTextView::populate-popup ##### -->
 665 <para>
 666
 667 </para>
 668
 669 @textview: the object which received the signal.
 670 @arg1:
 671
 672 <!-- ##### SIGNAL GtkTextView::set-anchor ##### -->
 673 <para>
 674
 675 </para>
 676
 677 @textview: the object which received the signal.
 678
 679 <!-- ##### SIGNAL GtkTextView::set-scroll-adjustments ##### -->
 680 <para>
 681
 682 </para>
 683
 684 @textview: the object which received the signal.
 685 @arg1:
 686 @arg2:
 687
 688 <!-- ##### SIGNAL GtkTextView::toggle-overwrite ##### -->
 689 <para>
 690
 691 </para>
 692
 693 @textview: the object which received the signal.
 694
 695 <!-- ##### ARG GtkTextView:cursor-visible ##### -->
 696 <para>
 697
 698 </para>
 699
 700 <!-- ##### ARG GtkTextView:editable ##### -->
 701 <para>
 702
 703 </para>
 704
 705 <!-- ##### ARG GtkTextView:indent ##### -->
 706 <para>
 707
 708 </para>
 709
 710 <!-- ##### ARG GtkTextView:justification ##### -->
 711 <para>
 712
 713 </para>
 714
 715 <!-- ##### ARG GtkTextView:left-margin ##### -->
 716 <para>
 717
 718 </para>
 719
 720 <!-- ##### ARG GtkTextView:pixels-above-lines ##### -->
 721 <para>
 722
 723 </para>
 724
 725 <!-- ##### ARG GtkTextView:pixels-below-lines ##### -->
 726 <para>
 727
 728 </para>
 729
 730 <!-- ##### ARG GtkTextView:pixels-inside-wrap ##### -->
 731 <para>
 732
 733 </para>
 734
 735 <!-- ##### ARG GtkTextView:right-margin ##### -->
 736 <para>
 737
 738 </para>
 739
 740 <!-- ##### ARG GtkTextView:tabs ##### -->
 741 <para>
 742
 743 </para>
 744
 745 <!-- ##### ARG GtkTextView:wrap-mode ##### -->
 746 <para>
 747
 748 </para>
 749