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 @Returns:
  89 <!-- # Unused Parameters # -->
  90 @mark_within_margin:
  91
  92
  93 <!-- ##### FUNCTION gtk_text_view_scroll_mark_onscreen ##### -->
  94 <para>
  95
  96 </para>
  97
  98 @text_view:
  99 @mark:
 100 @Returns:
 101
 102
 103 <!-- ##### FUNCTION gtk_text_view_move_mark_onscreen ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @text_view:
 109 @mark:
 110 @Returns:
 111
 112
 113 <!-- ##### FUNCTION gtk_text_view_place_cursor_onscreen ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @text_view:
 119 @Returns:
 120
 121
 122 <!-- ##### FUNCTION gtk_text_view_get_visible_rect ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @text_view:
 128 @visible_rect:
 129
 130
 131 <!-- ##### FUNCTION gtk_text_view_get_iter_location ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @text_view:
 137 @iter:
 138 @location:
 139
 140
 141 <!-- ##### FUNCTION gtk_text_view_get_line_at_y ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @text_view:
 147 @target_iter:
 148 @y:
 149 @line_top:
 150
 151
 152 <!-- ##### FUNCTION gtk_text_view_get_line_yrange ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @text_view:
 158 @iter:
 159 @y:
 160 @height:
 161
 162
 163 <!-- ##### FUNCTION gtk_text_view_get_iter_at_location ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @text_view:
 169 @iter:
 170 @x:
 171 @y:
 172
 173
 174 <!-- ##### FUNCTION gtk_text_view_buffer_to_window_coords ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @text_view:
 180 @win:
 181 @buffer_x:
 182 @buffer_y:
 183 @window_x:
 184 @window_y:
 185
 186
 187 <!-- ##### FUNCTION gtk_text_view_window_to_buffer_coords ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @text_view:
 193 @win:
 194 @window_x:
 195 @window_y:
 196 @buffer_x:
 197 @buffer_y:
 198
 199
 200 <!-- ##### FUNCTION gtk_text_view_get_window ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @text_view:
 206 @win:
 207 @Returns:
 208
 209
 210 <!-- ##### FUNCTION gtk_text_view_get_window_type ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @text_view:
 216 @window:
 217 @Returns:
 218
 219
 220 <!-- ##### FUNCTION gtk_text_view_set_border_window_size ##### -->
 221 <para>
 222
 223 </para>
 224
 225 @text_view:
 226 @type:
 227 @size:
 228
 229
 230 <!-- ##### FUNCTION gtk_text_view_set_text_window_size ##### -->
 231 <para>
 232
 233 </para>
 234
 235 @text_view:
 236 @width:
 237 @height:
 238
 239
 240 <!-- ##### FUNCTION gtk_text_view_forward_display_line ##### -->
 241 <para>
 242
 243 </para>
 244
 245 @text_view:
 246 @iter:
 247 @Returns:
 248
 249
 250 <!-- ##### FUNCTION gtk_text_view_backward_display_line ##### -->
 251 <para>
 252
 253 </para>
 254
 255 @text_view:
 256 @iter:
 257 @Returns:
 258
 259
 260 <!-- ##### FUNCTION gtk_text_view_forward_display_line_end ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @text_view:
 266 @iter:
 267 @Returns:
 268
 269
 270 <!-- ##### FUNCTION gtk_text_view_backward_display_line_start ##### -->
 271 <para>
 272
 273 </para>
 274
 275 @text_view:
 276 @iter:
 277 @Returns:
 278
 279
 280 <!-- ##### FUNCTION gtk_text_view_starts_display_line ##### -->
 281 <para>
 282
 283 </para>
 284
 285 @text_view:
 286 @iter:
 287 @Returns:
 288
 289
 290 <!-- ##### FUNCTION gtk_text_view_move_visually ##### -->
 291 <para>
 292
 293 </para>
 294
 295 @text_view:
 296 @iter:
 297 @count:
 298 @Returns:
 299
 300
 301 <!-- ##### FUNCTION gtk_text_view_add_child_at_anchor ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @text_view:
 307 @child:
 308 @anchor:
 309
 310
 311 <!-- ##### FUNCTION gtk_text_view_add_child_in_window ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @text_view:
 317 @child:
 318 @which_window:
 319 @xpos:
 320 @ypos:
 321
 322
 323 <!-- ##### FUNCTION gtk_text_view_move_child ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @text_view:
 329 @child:
 330 @xpos:
 331 @ypos:
 332
 333
 334 <!-- ##### FUNCTION gtk_text_view_set_wrap_mode ##### -->
 335 <para>
 336
 337 </para>
 338
 339 @text_view:
 340 @wrap_mode:
 341
 342
 343 <!-- ##### FUNCTION gtk_text_view_get_wrap_mode ##### -->
 344 <para>
 345
 346 </para>
 347
 348 @text_view:
 349 @Returns:
 350
 351
 352 <!-- ##### FUNCTION gtk_text_view_set_editable ##### -->
 353 <para>
 354
 355 </para>
 356
 357 @text_view:
 358 @setting:
 359
 360
 361 <!-- ##### FUNCTION gtk_text_view_get_editable ##### -->
 362 <para>
 363
 364 </para>
 365
 366 @text_view:
 367 @Returns:
 368
 369
 370 <!-- ##### FUNCTION gtk_text_view_set_cursor_visible ##### -->
 371 <para>
 372
 373 </para>
 374
 375 @text_view:
 376 @setting:
 377
 378
 379 <!-- ##### FUNCTION gtk_text_view_get_cursor_visible ##### -->
 380 <para>
 381
 382 </para>
 383
 384 @text_view:
 385 @Returns:
 386
 387
 388 <!-- ##### FUNCTION gtk_text_view_set_pixels_above_lines ##### -->
 389 <para>
 390
 391 </para>
 392
 393 @text_view:
 394 @pixels_above_lines:
 395
 396
 397 <!-- ##### FUNCTION gtk_text_view_get_pixels_above_lines ##### -->
 398 <para>
 399
 400 </para>
 401
 402 @text_view:
 403 @Returns:
 404
 405
 406 <!-- ##### FUNCTION gtk_text_view_set_pixels_below_lines ##### -->
 407 <para>
 408
 409 </para>
 410
 411 @text_view:
 412 @pixels_below_lines:
 413
 414
 415 <!-- ##### FUNCTION gtk_text_view_get_pixels_below_lines ##### -->
 416 <para>
 417
 418 </para>
 419
 420 @text_view:
 421 @Returns:
 422
 423
 424 <!-- ##### FUNCTION gtk_text_view_set_pixels_inside_wrap ##### -->
 425 <para>
 426
 427 </para>
 428
 429 @text_view:
 430 @pixels_inside_wrap:
 431
 432
 433 <!-- ##### FUNCTION gtk_text_view_get_pixels_inside_wrap ##### -->
 434 <para>
 435
 436 </para>
 437
 438 @text_view:
 439 @Returns:
 440
 441
 442 <!-- ##### FUNCTION gtk_text_view_set_justification ##### -->
 443 <para>
 444
 445 </para>
 446
 447 @text_view:
 448 @justification:
 449
 450
 451 <!-- ##### FUNCTION gtk_text_view_get_justification ##### -->
 452 <para>
 453
 454 </para>
 455
 456 @text_view:
 457 @Returns:
 458
 459
 460 <!-- ##### FUNCTION gtk_text_view_set_left_margin ##### -->
 461 <para>
 462
 463 </para>
 464
 465 @text_view:
 466 @left_margin:
 467
 468
 469 <!-- ##### FUNCTION gtk_text_view_get_left_margin ##### -->
 470 <para>
 471
 472 </para>
 473
 474 @text_view:
 475 @Returns:
 476
 477
 478 <!-- ##### FUNCTION gtk_text_view_set_right_margin ##### -->
 479 <para>
 480
 481 </para>
 482
 483 @text_view:
 484 @right_margin:
 485
 486
 487 <!-- ##### FUNCTION gtk_text_view_get_right_margin ##### -->
 488 <para>
 489
 490 </para>
 491
 492 @text_view:
 493 @Returns:
 494
 495
 496 <!-- ##### FUNCTION gtk_text_view_set_indent ##### -->
 497 <para>
 498
 499 </para>
 500
 501 @text_view:
 502 @indent:
 503
 504
 505 <!-- ##### FUNCTION gtk_text_view_get_indent ##### -->
 506 <para>
 507
 508 </para>
 509
 510 @text_view:
 511 @Returns:
 512
 513
 514 <!-- ##### FUNCTION gtk_text_view_set_tabs ##### -->
 515 <para>
 516
 517 </para>
 518
 519 @text_view:
 520 @tabs:
 521
 522
 523 <!-- ##### FUNCTION gtk_text_view_get_tabs ##### -->
 524 <para>
 525
 526 </para>
 527
 528 @text_view:
 529 @Returns:
 530
 531
 532 <!-- ##### SIGNAL GtkTextView::copy-clipboard ##### -->
 533 <para>
 534
 535 </para>
 536
 537 @textview: the object which received the signal.
 538
 539 <!-- ##### SIGNAL GtkTextView::cut-clipboard ##### -->
 540 <para>
 541
 542 </para>
 543
 544 @textview: the object which received the signal.
 545
 546 <!-- ##### SIGNAL GtkTextView::delete-from-cursor ##### -->
 547 <para>
 548
 549 </para>
 550
 551 @textview: the object which received the signal.
 552 @arg1:
 553 @arg2:
 554
 555 <!-- ##### SIGNAL GtkTextView::insert-at-cursor ##### -->
 556 <para>
 557
 558 </para>
 559
 560 @textview: the object which received the signal.
 561 @arg1:
 562
 563 <!-- ##### SIGNAL GtkTextView::move-cursor ##### -->
 564 <para>
 565
 566 </para>
 567
 568 @textview: the object which received the signal.
 569 @arg1:
 570 @arg2:
 571 @arg3:
 572
 573 <!-- ##### SIGNAL GtkTextView::paste-clipboard ##### -->
 574 <para>
 575
 576 </para>
 577
 578 @textview: the object which received the signal.
 579
 580 <!-- ##### SIGNAL GtkTextView::set-anchor ##### -->
 581 <para>
 582
 583 </para>
 584
 585 @textview: the object which received the signal.
 586
 587 <!-- ##### SIGNAL GtkTextView::set-scroll-adjustments ##### -->
 588 <para>
 589
 590 </para>
 591
 592 @textview: the object which received the signal.
 593 @arg1:
 594 @arg2:
 595
 596 <!-- ##### SIGNAL GtkTextView::toggle-overwrite ##### -->
 597 <para>
 598
 599 </para>
 600
 601 @textview: the object which received the signal.
 602
 603 <!-- ##### ARG GtkTextView:height-lines ##### -->
 604 <para>
 605
 606 </para>
 607
 608 <!-- ##### ARG GtkTextView:width-columns ##### -->
 609 <para>
 610
 611 </para>
 612
 613 <!-- ##### ARG GtkTextView:pixels-above-lines ##### -->
 614 <para>
 615
 616 </para>
 617
 618 <!-- ##### ARG GtkTextView:pixels-below-lines ##### -->
 619 <para>
 620
 621 </para>
 622
 623 <!-- ##### ARG GtkTextView:pixels-inside-wrap ##### -->
 624 <para>
 625
 626 </para>
 627
 628 <!-- ##### ARG GtkTextView:editable ##### -->
 629 <para>
 630
 631 </para>
 632
 633 <!-- ##### ARG GtkTextView:wrap-mode ##### -->
 634 <para>
 635
 636 </para>
 637
 638 <!-- ##### ARG GtkTextView:justify ##### -->
 639 <para>
 640
 641 </para>
 642
 643 <!-- ##### ARG GtkTextView:left-margin ##### -->
 644 <para>
 645
 646 </para>
 647
 648 <!-- ##### ARG GtkTextView:right-margin ##### -->
 649 <para>
 650
 651 </para>
 652
 653 <!-- ##### ARG GtkTextView:indent ##### -->
 654 <para>
 655
 656 </para>
 657
 658 <!-- ##### ARG GtkTextView:tabs ##### -->
 659 <para>
 660
 661 </para>
 662