vte.sgml 14.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<!-- ##### SECTION Title ##### -->
VteTerminal

<!-- ##### SECTION Short_Description ##### -->
A terminal widget implementation.

<!-- ##### SECTION Long_Description ##### -->
<para>
A VteTerminal is a terminal emulator implemented as a GTK2 widget.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### STRUCT VteTerminal ##### -->
<para>
19
All of these fields should be considered read-only.
20
21
22
23
24
25
</para>

@widget: 
@adjustment: Scroll bar adjustments.
@char_width: Width of a narrow character cell.
@char_height: Height of a character cell.
26
27
@char_ascent: The distance (in pixels) from the baseline of drawn text to the top of the character cell.
@char_descent: The distance (in pixels) from the baseline of drawn text to the bottom of the character cell.
28
29
30
31
32
@row_count: Number of visible rows.
@column_count: Number of visible columns.
@window_title: The terminal's idea of what the window's title should be.
@icon_title: The terminal's idea of what the window's title should be when iconified.

33
34
35
36
37
38
39
40
41
42
43
44
<!-- ##### ENUM VteTerminalEraseBinding ##### -->
<para>
An enumerated type which can be used to indicate which string the terminal
should send to an application when the user presses the Delete or Backspace
keys.
</para>

@VTE_ERASE_AUTO: For backspace, attempt to determine the right value from the terminal's IO settings.  For delete, use the control sequence.
@VTE_ERASE_ASCII_BACKSPACE: Send an ASCII backspace character (0x08).
@VTE_ERASE_ASCII_DELETE: Send an ASCII delete character (0x7F).
@VTE_ERASE_DELETE_SEQUENCE: Send the "@@7" control sequence.

45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<!-- ##### FUNCTION vte_terminal_new ##### -->
<para>
</para>

@Returns: 


<!-- ##### FUNCTION vte_terminal_im_append_menuitems ##### -->
<para>
</para>

@terminal: 
@menushell: 


<!-- ##### FUNCTION vte_terminal_fork_command ##### -->
<para>
</para>

@terminal: 
@command: 
@argv: 
@envv: 
68
@directory: 
69
70
71
72
73
74
@lastlog: 
@utmp: 
@wtmp: 
@Returns: 


75
76
77
78
79
80
81
82
83
84
85
86
87
88
<!-- ##### FUNCTION vte_terminal_forkpty ##### -->
<para>

</para>

@terminal: 
@envv: 
@directory: 
@lastlog: 
@utmp: 
@wtmp: 
@Returns: 


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
<!-- ##### FUNCTION vte_terminal_feed ##### -->
<para>

</para>

@terminal: 
@data: 
@length: 


<!-- ##### FUNCTION vte_terminal_feed_child ##### -->
<para>

</para>

@terminal: 
@data: 
@length: 


<!-- ##### FUNCTION vte_terminal_copy_clipboard ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_paste_clipboard ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_copy_primary ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_paste_primary ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_set_size ##### -->
<para>

</para>

@terminal: 
@columns: 
@rows: 
<!-- # Unused Parameters # -->
@Param2: 
@Param3: 


<!-- ##### FUNCTION vte_terminal_set_audible_bell ##### -->
<para>

</para>

@terminal: 
@is_audible: 


<!-- ##### FUNCTION vte_terminal_get_audible_bell ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_set_visible_bell ##### -->
<para>

</para>

@terminal: 
@is_visible: 


<!-- ##### FUNCTION vte_terminal_get_visible_bell ##### -->
<para>

</para>

@terminal: 
@Returns: 


190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<!-- ##### FUNCTION vte_terminal_set_allow_bold ##### -->
<para>

</para>

@terminal: 
@allow_bold: 


<!-- ##### FUNCTION vte_terminal_get_allow_bold ##### -->
<para>

</para>

@terminal: 
@Returns: 


208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<!-- ##### FUNCTION vte_terminal_set_scroll_on_output ##### -->
<para>

</para>

@terminal: 
@scroll: 


<!-- ##### FUNCTION vte_terminal_set_scroll_on_keystroke ##### -->
<para>

</para>

@terminal: 
@scroll: 


<!-- ##### FUNCTION vte_terminal_set_color_bold ##### -->
<para>

</para>

@terminal: 
@bold: 


<!-- ##### FUNCTION vte_terminal_set_color_foreground ##### -->
<para>

</para>

@terminal: 
@foreground: 


<!-- ##### FUNCTION vte_terminal_set_color_background ##### -->
<para>

</para>

@terminal: 
@background: 


253
254
255
256
257
258
259
260
261
262
263
<!-- ##### FUNCTION vte_terminal_set_color_dim ##### -->
<para>

</para>

@terminal: 
@dim: 
<!-- # Unused Parameters # -->
@bold: 


264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<!-- ##### FUNCTION vte_terminal_set_colors ##### -->
<para>

</para>

@terminal: 
@foreground: 
@background: 
@palette: 
@palette_size: 


<!-- ##### FUNCTION vte_terminal_set_default_colors ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_set_background_image ##### -->
<para>

</para>

@terminal: 
@image: 


<!-- ##### FUNCTION vte_terminal_set_background_image_file ##### -->
<para>

</para>

@terminal: 
@path: 


<!-- ##### FUNCTION vte_terminal_set_background_saturation ##### -->
<para>

</para>

@terminal: 
@saturation: 


<!-- ##### FUNCTION vte_terminal_set_background_transparent ##### -->
<para>

</para>

@terminal: 
@transparent: 


320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
<!-- ##### FUNCTION vte_terminal_set_background_tint_color ##### -->
<para>

</para>

@terminal: 
@color: 


<!-- ##### FUNCTION vte_terminal_set_scroll_background ##### -->
<para>

</para>

@terminal: 
@scroll: 


338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
<!-- ##### FUNCTION vte_terminal_set_cursor_blinks ##### -->
<para>

</para>

@terminal: 
@blink: 


<!-- ##### FUNCTION vte_terminal_set_scrollback_lines ##### -->
<para>

</para>

@terminal: 
@lines: 
<!-- # Unused Parameters # -->
@Param2: 


<!-- ##### FUNCTION vte_terminal_set_font ##### -->
<para>

</para>

@terminal: 
@font_desc: 


<!-- ##### FUNCTION vte_terminal_set_font_from_string ##### -->
<para>

</para>

@terminal: 
@name: 


<!-- ##### FUNCTION vte_terminal_get_font ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_using_xft ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_has_selection ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_set_word_chars ##### -->
<para>

</para>

@terminal: 
@spec: 


<!-- ##### FUNCTION vte_terminal_is_word_char ##### -->
<para>

</para>

@terminal: 
@c: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_set_backspace_binding ##### -->
<para>

</para>

@terminal: 
@binding: 


<!-- ##### FUNCTION vte_terminal_set_delete_binding ##### -->
<para>

</para>

@terminal: 
@binding: 


<!-- ##### FUNCTION vte_terminal_set_mouse_autohide ##### -->
<para>

</para>

@terminal: 
@setting: 


<!-- ##### FUNCTION vte_terminal_get_mouse_autohide ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_reset ##### -->
<para>

</para>

@terminal: 
@full: 
@clear_history: 


<!-- ##### FUNCTION vte_terminal_get_text ##### -->
<para>

</para>

@terminal: 
@is_selected: 
475
@data: 
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
@attributes: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_text_range ##### -->
<para>

</para>

@terminal: 
@start_row: 
@start_col: 
@end_row: 
@end_col: 
@is_selected: 
491
@data: 
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
@attributes: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_cursor_position ##### -->
<para>

</para>

@terminal: 
@column: 
@row: 


<!-- ##### FUNCTION vte_terminal_match_clear_all ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_match_add ##### -->
<para>

</para>

@terminal: 
@match: 
@Returns: 


524
525
526
527
528
529
530
531
532
<!-- ##### FUNCTION vte_terminal_match_remove ##### -->
<para>

</para>

@terminal: 
@tag: 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
<!-- ##### FUNCTION vte_terminal_match_check ##### -->
<para>

</para>

@terminal: 
@column: 
@row: 
@tag: 
@Returns: 
<!-- # Unused Parameters # -->
@Param2: 
@Param3: 


548
549
550
551
552
553
554
555
556
557
<!-- ##### FUNCTION vte_terminal_match_set_cursor ##### -->
<para>

</para>

@terminal: 
@tag: 
@cursor: 


558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
<!-- ##### FUNCTION vte_terminal_set_emulation ##### -->
<para>

</para>

@terminal: 
@emulation: 


<!-- ##### FUNCTION vte_terminal_get_emulation ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_set_encoding ##### -->
<para>

</para>

@terminal: 
@codeset: 


<!-- ##### FUNCTION vte_terminal_get_encoding ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_status_line ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_padding ##### -->
<para>

</para>

@terminal: 
@xpad: 
@ypad: 


613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
<!-- ##### FUNCTION vte_terminal_get_adjustment ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_char_ascent ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_char_descent ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_char_height ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_char_width ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_column_count ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_icon_title ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_row_count ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_window_title ##### -->
<para>

</para>

@terminal: 
@Returns: 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
<!-- ##### SIGNAL VteTerminal::char-size-changed ##### -->
<para>
Emitted whenever selection of a new font causes the values of the
@char_width or @char_height fields to change.
</para>

@vteterminal: the object which received the signal.
@arg1: the new character cell width.
@arg2: the new character cell height.

<!-- ##### SIGNAL VteTerminal::child-exited ##### -->
<para>
This signal is emitted when the terminal detects that a child started using
vte_terminal_fork_command() has exited.
</para>

@vteterminal: the object which received the signal.

712
713
714
715
716
717
718
719
720
721
722
<!-- ##### SIGNAL VteTerminal::commit ##### -->
<para>
Emitted whenever the terminal receives input from the user and prepares to send
it to the child process.  The signal is emitted even when there is no child
process.
</para>

@vteterminal: the object which received the signal.
@arg1: a string of text.
@arg2: the length of that string of text.

723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
<!-- ##### SIGNAL VteTerminal::contents-changed ##### -->
<para>
Emitted whenever the visible appearance of the terminal has changed.  Used
primarily by #VteTerminalAccessible.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::cursor-moved ##### -->
<para>
Emitted whenever the cursor moves to a new character cell.  Used primarily
by #VteTerminalAccessible.
</para>

@vteterminal: the object which received the signal.

739
740
<!-- ##### SIGNAL VteTerminal::decrease-font-size ##### -->
<para>
741
Emitted when the user hits the '-' key while holding the Control key.
742
743
744
745
</para>

@vteterminal: the object which received the signal.

746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
<!-- ##### SIGNAL VteTerminal::deiconify-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::emulation-changed ##### -->
<para>

</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::encoding-changed ##### -->
<para>

</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::eof ##### -->
<para>
769
770
771
Emitted when the terminal receives an end-of-file from a child which is running
in the terminal.  This signal is frequently (but not always) emitted with a
"child-exited" signal.
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::icon-title-changed ##### -->
<para>
Emitted when the terminal's @icon_title field is modified.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::iconify-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

790
791
<!-- ##### SIGNAL VteTerminal::increase-font-size ##### -->
<para>
792
Emitted when the user hits the '+' key while holding the Control key.
793
794
795
796
</para>

@vteterminal: the object which received the signal.

797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
<!-- ##### SIGNAL VteTerminal::lower-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::maximize-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::move-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.
@arg1: the terminal's desired location, X coordinate.
@arg2: the terminal's desired location, Y coordinate.

<!-- ##### SIGNAL VteTerminal::raise-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::refresh-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::resize-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.
840
841
@arg1: the desired width in pixels, including padding.
@arg2: the desired height in pixels, including padding.
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863

<!-- ##### SIGNAL VteTerminal::restore-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::selection-changed ##### -->
<para>
Emitted whenever the contents of terminal's selection changes.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::status-line-changed ##### -->
<para>
Emitted whenever the contents of the status line are modified or cleared.
</para>

@vteterminal: the object which received the signal.

864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
<!-- ##### SIGNAL VteTerminal::text-deleted ##### -->
<para>
An internal signal used for communication between the terminal and its
accessibility peer.  May not be emitted under certain circumstances.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::text-inserted ##### -->
<para>
An internal signal used for communication between the terminal and its
accessibility peer.  May not be emitted under certain circumstances.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::text-modified ##### -->
<para>
An internal signal used for communication between the terminal and its
accessibility peer.  May not be emitted under certain circumstances.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::text-scrolled ##### -->
<para>
An internal signal used for communication between the terminal and its
accessibility peer.  May not be emitted under certain circumstances.
</para>

@vteterminal: the object which received the signal.
@arg1: 

897
898
899
900
901
902
903
<!-- ##### SIGNAL VteTerminal::window-title-changed ##### -->
<para>
Emitted when the terminal's @window_title field is modified.
</para>

@vteterminal: the object which received the signal.