vte.sgml 16.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!-- ##### 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>

Behdad Esfahbod's avatar
Behdad Esfahbod committed
17
18
19
<!-- ##### SECTION Stability_Level ##### -->


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

Behdad Esfahbod's avatar
Behdad Esfahbod committed
25
@widget: Base #GtkWidget of the terminal widget.
26
27
28
@adjustment: Scroll bar adjustments.
@char_width: Width of a narrow character cell.
@char_height: Height of a character cell.
29
30
@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.
31
32
33
34
35
@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.

36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<!-- ##### 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.

<!-- ##### 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.

<!-- ##### 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.

73
74
<!-- ##### SIGNAL VteTerminal::copy-clipboard ##### -->
<para>
75
Emitted whenever vte_terminal_copy_clipboard() is called.
76
77
78
79
</para>

@vteterminal: the object which received the signal.

80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<!-- ##### 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.

<!-- ##### SIGNAL VteTerminal::decrease-font-size ##### -->
<para>
Emitted when the user hits the '-' key while holding the Control key.
</para>

@vteterminal: the object which received the signal.

<!-- ##### 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>
104
105
Emitted whenever the terminal's emulation changes, only possible at the
parent application's request.
106
107
108
109
110
111
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::encoding-changed ##### -->
<para>
112
113
114
Emitted whenever the terminal's current encoding has changed, either as a
result of receiving a control sequence which toggled between the local and
UTF-8 encodings, or at the parent application's request.
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
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::eof ##### -->
<para>
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.
</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.

<!-- ##### SIGNAL VteTerminal::increase-font-size ##### -->
<para>
Emitted when the user hits the '+' key while holding the Control key.
</para>

@vteterminal: the object which received the signal.

<!-- ##### 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.

172
173
<!-- ##### SIGNAL VteTerminal::paste-clipboard ##### -->
<para>
174
Emitted whenever vte_terminal_paste_clipboard() is called.
175
176
177
178
</para>

@vteterminal: the object which received the signal.

179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
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
253
<!-- ##### 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.
@arg1: the desired width in pixels, including padding.
@arg2: the desired height in pixels, including padding.

<!-- ##### 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.

<!-- ##### 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.
Behdad Esfahbod's avatar
Behdad Esfahbod committed
254
@arg1: the number of lines scrolled.
255
256
257
258
259
260
261
262

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

@vteterminal: the object which received the signal.

263
264
265
266
267
268
269
270
271
272
273
274
<!-- ##### 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.

275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<!-- ##### 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: 
298
@directory: 
299
300
301
302
303
304
@lastlog: 
@utmp: 
@wtmp: 
@Returns: 


305
306
307
308
309
310
311
312
313
314
315
316
317
318
<!-- ##### FUNCTION vte_terminal_forkpty ##### -->
<para>

</para>

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


319
320
321
322
323
324
325
326
327
<!-- ##### FUNCTION vte_terminal_set_pty ##### -->
<para>

</para>

@terminal: 
@pty_master: 


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
<!-- ##### FUNCTION vte_terminal_feed ##### -->
<para>

</para>

@terminal: 
@data: 
@length: 


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

</para>

Behdad Esfahbod's avatar
Behdad Esfahbod committed
343
344
345
346
347
348
349
350
351
352
@terminal: 
@text: 
@length: 


<!-- ##### FUNCTION vte_terminal_feed_child_binary ##### -->
<para>

</para>

353
354
355
356
357
@terminal: 
@data: 
@length: 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
<!-- ##### FUNCTION vte_terminal_select_all ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_select_none ##### -->
<para>

</para>

@terminal: 


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
<!-- ##### 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: 


<!-- ##### 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: 


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
<!-- ##### FUNCTION vte_terminal_set_allow_bold ##### -->
<para>

</para>

@terminal: 
@allow_bold: 


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

</para>

@terminal: 
@Returns: 


470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
<!-- ##### 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: 


515
516
517
518
519
520
521
522
523
<!-- ##### FUNCTION vte_terminal_set_color_dim ##### -->
<para>

</para>

@terminal: 
@dim: 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
<!-- ##### FUNCTION vte_terminal_set_color_cursor ##### -->
<para>

</para>

@terminal: 
@cursor_background: 


<!-- ##### FUNCTION vte_terminal_set_color_highlight ##### -->
<para>

</para>

@terminal: 
@highlight_background: 


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
<!-- ##### FUNCTION vte_terminal_set_colors ##### -->
<para>

</para>

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


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

</para>

@terminal: 


562
563
564
565
566
567
568
569
570
<!-- ##### FUNCTION vte_terminal_set_opacity ##### -->
<para>

</para>

@terminal: 
@opacity: 


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
<!-- ##### 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: 


607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
<!-- ##### FUNCTION vte_terminal_set_background_tint_color ##### -->
<para>

</para>

@terminal: 
@color: 


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

</para>

@terminal: 
@scroll: 


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
<!-- ##### FUNCTION vte_terminal_set_cursor_blinks ##### -->
<para>

</para>

@terminal: 
@blink: 


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

</para>

@terminal: 
@lines: 


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

</para>

@terminal: 
@font_desc: 


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

</para>

@terminal: 
@name: 


661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
<!-- ##### FUNCTION vte_terminal_set_font_from_string_full ##### -->
<para>

</para>

@terminal: 
@name: 
@antialias: 


<!-- ##### FUNCTION vte_terminal_set_font_full ##### -->
<para>

</para>

@terminal: 
@font_desc: 
@antialias: 


681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
<!-- ##### 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: 
780
@data: 
781
782
783
784
@attributes: 
@Returns: 


Behdad Esfahbod's avatar
Behdad Esfahbod committed
785
786
787
788
789
790
791
792
793
794
795
796
<!-- ##### FUNCTION vte_terminal_get_text_include_trailing_spaces ##### -->
<para>

</para>

@terminal: 
@is_selected: 
@data: 
@attributes: 
@Returns: 


797
798
799
800
801
802
803
804
805
806
807
<!-- ##### FUNCTION vte_terminal_get_text_range ##### -->
<para>

</para>

@terminal: 
@start_row: 
@start_col: 
@end_row: 
@end_col: 
@is_selected: 
808
@data: 
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
840
@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: 


841
842
843
844
845
846
847
848
849
<!-- ##### FUNCTION vte_terminal_match_remove ##### -->
<para>

</para>

@terminal: 
@tag: 


850
851
852
853
854
855
856
857
858
859
860
861
<!-- ##### FUNCTION vte_terminal_match_check ##### -->
<para>

</para>

@terminal: 
@column: 
@row: 
@tag: 
@Returns: 


862
863
864
865
866
867
868
869
870
871
<!-- ##### FUNCTION vte_terminal_match_set_cursor ##### -->
<para>

</para>

@terminal: 
@tag: 
@cursor: 


872
873
874
875
876
877
878
879
880
881
<!-- ##### FUNCTION vte_terminal_match_set_cursor_type ##### -->
<para>

</para>

@terminal: 
@tag: 
@cursor_type: 


882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
<!-- ##### FUNCTION vte_terminal_set_emulation ##### -->
<para>

</para>

@terminal: 
@emulation: 


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

</para>

@terminal: 
@Returns: 


900
901
902
903
904
905
906
907
908
<!-- ##### FUNCTION vte_terminal_get_default_emulation ##### -->
<para>

</para>

@terminal: 
@Returns: 


909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
<!-- ##### 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: 


946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
<!-- ##### 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: