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