don't disable use of deprecated APIs unless asked to do so. add Meta case
[vte.git] / doc / reference / tmpl / vte.sgml
1 <!-- ##### SECTION Title ##### -->
2 VteTerminal
3
4 <!-- ##### SECTION Short_Description ##### -->
5 A terminal widget implementation.
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 A VteTerminal is a terminal emulator implemented as a GTK2 widget.
10 </para>
11
12 <!-- ##### SECTION See_Also ##### -->
13 <para>
14
15 </para>
16
17 <!-- ##### STRUCT VteTerminal ##### -->
18 <para>
19 All of these fields should be considered read-only.
20 </para>
21
22 @widget: 
23 @adjustment: Scroll bar adjustments.
24 @char_width: Width of a narrow character cell.
25 @char_height: Height of a character cell.
26 @char_ascent: The distance (in pixels) from the baseline of drawn text to the top of the character cell.
27 @char_descent: The distance (in pixels) from the baseline of drawn text to the bottom of the character cell.
28 @row_count: Number of visible rows.
29 @column_count: Number of visible columns.
30 @window_title: The terminal's idea of what the window's title should be.
31 @icon_title: The terminal's idea of what the window's title should be when iconified.
32
33 <!-- ##### SIGNAL VteTerminal::char-size-changed ##### -->
34 <para>
35 Emitted whenever selection of a new font causes the values of the
36 @char_width or @char_height fields to change.
37 </para>
38
39 @vteterminal: the object which received the signal.
40 @arg1: the new character cell width.
41 @arg2: the new character cell height.
42
43 <!-- ##### SIGNAL VteTerminal::child-exited ##### -->
44 <para>
45 This signal is emitted when the terminal detects that a child started using
46 vte_terminal_fork_command() has exited.
47 </para>
48
49 @vteterminal: the object which received the signal.
50
51 <!-- ##### SIGNAL VteTerminal::commit ##### -->
52 <para>
53 Emitted whenever the terminal receives input from the user and prepares to send
54 it to the child process.  The signal is emitted even when there is no child
55 process.
56 </para>
57
58 @vteterminal: the object which received the signal.
59 @arg1: a string of text.
60 @arg2: the length of that string of text.
61
62 <!-- ##### SIGNAL VteTerminal::contents-changed ##### -->
63 <para>
64 Emitted whenever the visible appearance of the terminal has changed.  Used
65 primarily by #VteTerminalAccessible.
66 </para>
67
68 @vteterminal: the object which received the signal.
69
70 <!-- ##### SIGNAL VteTerminal::cursor-moved ##### -->
71 <para>
72 Emitted whenever the cursor moves to a new character cell.  Used primarily
73 by #VteTerminalAccessible.
74 </para>
75
76 @vteterminal: the object which received the signal.
77
78 <!-- ##### SIGNAL VteTerminal::decrease-font-size ##### -->
79 <para>
80 Emitted when the user hits the '-' key while holding the Control key.
81 </para>
82
83 @vteterminal: the object which received the signal.
84
85 <!-- ##### SIGNAL VteTerminal::deiconify-window ##### -->
86 <para>
87 Emitted at the child application's request.
88 </para>
89
90 @vteterminal: the object which received the signal.
91
92 <!-- ##### SIGNAL VteTerminal::emulation-changed ##### -->
93 <para>
94
95 </para>
96
97 @vteterminal: the object which received the signal.
98
99 <!-- ##### SIGNAL VteTerminal::encoding-changed ##### -->
100 <para>
101
102 </para>
103
104 @vteterminal: the object which received the signal.
105
106 <!-- ##### SIGNAL VteTerminal::eof ##### -->
107 <para>
108 Emitted when the terminal receives an end-of-file from a child which is running
109 in the terminal.  This signal is frequently (but not always) emitted with a
110 "child-exited" signal.
111 </para>
112
113 @vteterminal: the object which received the signal.
114
115 <!-- ##### SIGNAL VteTerminal::icon-title-changed ##### -->
116 <para>
117 Emitted when the terminal's @icon_title field is modified.
118 </para>
119
120 @vteterminal: the object which received the signal.
121
122 <!-- ##### SIGNAL VteTerminal::iconify-window ##### -->
123 <para>
124 Emitted at the child application's request.
125 </para>
126
127 @vteterminal: the object which received the signal.
128
129 <!-- ##### SIGNAL VteTerminal::increase-font-size ##### -->
130 <para>
131 Emitted when the user hits the '+' key while holding the Control key.
132 </para>
133
134 @vteterminal: the object which received the signal.
135
136 <!-- ##### SIGNAL VteTerminal::lower-window ##### -->
137 <para>
138 Emitted at the child application's request.
139 </para>
140
141 @vteterminal: the object which received the signal.
142
143 <!-- ##### SIGNAL VteTerminal::maximize-window ##### -->
144 <para>
145 Emitted at the child application's request.
146 </para>
147
148 @vteterminal: the object which received the signal.
149
150 <!-- ##### SIGNAL VteTerminal::move-window ##### -->
151 <para>
152 Emitted at the child application's request.
153 </para>
154
155 @vteterminal: the object which received the signal.
156 @arg1: the terminal's desired location, X coordinate.
157 @arg2: the terminal's desired location, Y coordinate.
158
159 <!-- ##### SIGNAL VteTerminal::raise-window ##### -->
160 <para>
161 Emitted at the child application's request.
162 </para>
163
164 @vteterminal: the object which received the signal.
165
166 <!-- ##### SIGNAL VteTerminal::refresh-window ##### -->
167 <para>
168 Emitted at the child application's request.
169 </para>
170
171 @vteterminal: the object which received the signal.
172
173 <!-- ##### SIGNAL VteTerminal::resize-window ##### -->
174 <para>
175 Emitted at the child application's request.
176 </para>
177
178 @vteterminal: the object which received the signal.
179 @arg1: the desired width in pixels, including padding.
180 @arg2: the desired height in pixels, including padding.
181
182 <!-- ##### SIGNAL VteTerminal::restore-window ##### -->
183 <para>
184 Emitted at the child application's request.
185 </para>
186
187 @vteterminal: the object which received the signal.
188
189 <!-- ##### SIGNAL VteTerminal::selection-changed ##### -->
190 <para>
191 Emitted whenever the contents of terminal's selection changes.
192 </para>
193
194 @vteterminal: the object which received the signal.
195
196 <!-- ##### SIGNAL VteTerminal::status-line-changed ##### -->
197 <para>
198 Emitted whenever the contents of the status line are modified or cleared.
199 </para>
200
201 @vteterminal: the object which received the signal.
202
203 <!-- ##### SIGNAL VteTerminal::text-deleted ##### -->
204 <para>
205 An internal signal used for communication between the terminal and its
206 accessibility peer.  May not be emitted under certain circumstances.
207 </para>
208
209 @vteterminal: the object which received the signal.
210
211 <!-- ##### SIGNAL VteTerminal::text-inserted ##### -->
212 <para>
213 An internal signal used for communication between the terminal and its
214 accessibility peer.  May not be emitted under certain circumstances.
215 </para>
216
217 @vteterminal: the object which received the signal.
218
219 <!-- ##### SIGNAL VteTerminal::text-modified ##### -->
220 <para>
221 An internal signal used for communication between the terminal and its
222 accessibility peer.  May not be emitted under certain circumstances.
223 </para>
224
225 @vteterminal: the object which received the signal.
226
227 <!-- ##### SIGNAL VteTerminal::text-scrolled ##### -->
228 <para>
229 An internal signal used for communication between the terminal and its
230 accessibility peer.  May not be emitted under certain circumstances.
231 </para>
232
233 @vteterminal: the object which received the signal.
234 @arg1: 
235
236 <!-- ##### SIGNAL VteTerminal::window-title-changed ##### -->
237 <para>
238 Emitted when the terminal's @window_title field is modified.
239 </para>
240
241 @vteterminal: the object which received the signal.
242
243 <!-- ##### ENUM VteTerminalEraseBinding ##### -->
244 <para>
245 An enumerated type which can be used to indicate which string the terminal
246 should send to an application when the user presses the Delete or Backspace
247 keys.
248 </para>
249
250 @VTE_ERASE_AUTO: For backspace, attempt to determine the right value from the terminal's IO settings.  For delete, use the control sequence.
251 @VTE_ERASE_ASCII_BACKSPACE: Send an ASCII backspace character (0x08).
252 @VTE_ERASE_ASCII_DELETE: Send an ASCII delete character (0x7F).
253 @VTE_ERASE_DELETE_SEQUENCE: Send the "@@7" control sequence.
254
255 <!-- ##### FUNCTION vte_terminal_new ##### -->
256 <para>
257 </para>
258
259 @Returns: 
260
261
262 <!-- ##### FUNCTION vte_terminal_im_append_menuitems ##### -->
263 <para>
264 </para>
265
266 @terminal: 
267 @menushell: 
268
269
270 <!-- ##### FUNCTION vte_terminal_fork_command ##### -->
271 <para>
272 </para>
273
274 @terminal: 
275 @command: 
276 @argv: 
277 @envv: 
278 @directory: 
279 @lastlog: 
280 @utmp: 
281 @wtmp: 
282 @Returns: 
283
284
285 <!-- ##### FUNCTION vte_terminal_forkpty ##### -->
286 <para>
287
288 </para>
289
290 @terminal: 
291 @envv: 
292 @directory: 
293 @lastlog: 
294 @utmp: 
295 @wtmp: 
296 @Returns: 
297
298
299 <!-- ##### FUNCTION vte_terminal_feed ##### -->
300 <para>
301
302 </para>
303
304 @terminal: 
305 @data: 
306 @length: 
307
308
309 <!-- ##### FUNCTION vte_terminal_feed_child ##### -->
310 <para>
311
312 </para>
313
314 @terminal: 
315 @data: 
316 @length: 
317
318
319 <!-- ##### FUNCTION vte_terminal_copy_clipboard ##### -->
320 <para>
321
322 </para>
323
324 @terminal: 
325
326
327 <!-- ##### FUNCTION vte_terminal_paste_clipboard ##### -->
328 <para>
329
330 </para>
331
332 @terminal: 
333
334
335 <!-- ##### FUNCTION vte_terminal_copy_primary ##### -->
336 <para>
337
338 </para>
339
340 @terminal: 
341
342
343 <!-- ##### FUNCTION vte_terminal_paste_primary ##### -->
344 <para>
345
346 </para>
347
348 @terminal: 
349
350
351 <!-- ##### FUNCTION vte_terminal_set_size ##### -->
352 <para>
353
354 </para>
355
356 @terminal: 
357 @columns: 
358 @rows: 
359 <!-- # Unused Parameters # -->
360 @Param2: 
361 @Param3: 
362
363
364 <!-- ##### FUNCTION vte_terminal_set_audible_bell ##### -->
365 <para>
366
367 </para>
368
369 @terminal: 
370 @is_audible: 
371
372
373 <!-- ##### FUNCTION vte_terminal_get_audible_bell ##### -->
374 <para>
375
376 </para>
377
378 @terminal: 
379 @Returns: 
380
381
382 <!-- ##### FUNCTION vte_terminal_set_visible_bell ##### -->
383 <para>
384
385 </para>
386
387 @terminal: 
388 @is_visible: 
389
390
391 <!-- ##### FUNCTION vte_terminal_get_visible_bell ##### -->
392 <para>
393
394 </para>
395
396 @terminal: 
397 @Returns: 
398
399
400 <!-- ##### FUNCTION vte_terminal_set_allow_bold ##### -->
401 <para>
402
403 </para>
404
405 @terminal: 
406 @allow_bold: 
407
408
409 <!-- ##### FUNCTION vte_terminal_get_allow_bold ##### -->
410 <para>
411
412 </para>
413
414 @terminal: 
415 @Returns: 
416
417
418 <!-- ##### FUNCTION vte_terminal_set_scroll_on_output ##### -->
419 <para>
420
421 </para>
422
423 @terminal: 
424 @scroll: 
425
426
427 <!-- ##### FUNCTION vte_terminal_set_scroll_on_keystroke ##### -->
428 <para>
429
430 </para>
431
432 @terminal: 
433 @scroll: 
434
435
436 <!-- ##### FUNCTION vte_terminal_set_color_bold ##### -->
437 <para>
438
439 </para>
440
441 @terminal: 
442 @bold: 
443
444
445 <!-- ##### FUNCTION vte_terminal_set_color_foreground ##### -->
446 <para>
447
448 </para>
449
450 @terminal: 
451 @foreground: 
452
453
454 <!-- ##### FUNCTION vte_terminal_set_color_background ##### -->
455 <para>
456
457 </para>
458
459 @terminal: 
460 @background: 
461
462
463 <!-- ##### FUNCTION vte_terminal_set_color_dim ##### -->
464 <para>
465
466 </para>
467
468 @terminal: 
469 @dim: 
470 <!-- # Unused Parameters # -->
471 @bold: 
472
473
474 <!-- ##### FUNCTION vte_terminal_set_colors ##### -->
475 <para>
476
477 </para>
478
479 @terminal: 
480 @foreground: 
481 @background: 
482 @palette: 
483 @palette_size: 
484
485
486 <!-- ##### FUNCTION vte_terminal_set_default_colors ##### -->
487 <para>
488
489 </para>
490
491 @terminal: 
492
493
494 <!-- ##### FUNCTION vte_terminal_set_background_image ##### -->
495 <para>
496
497 </para>
498
499 @terminal: 
500 @image: 
501
502
503 <!-- ##### FUNCTION vte_terminal_set_background_image_file ##### -->
504 <para>
505
506 </para>
507
508 @terminal: 
509 @path: 
510
511
512 <!-- ##### FUNCTION vte_terminal_set_background_saturation ##### -->
513 <para>
514
515 </para>
516
517 @terminal: 
518 @saturation: 
519
520
521 <!-- ##### FUNCTION vte_terminal_set_background_transparent ##### -->
522 <para>
523
524 </para>
525
526 @terminal: 
527 @transparent: 
528
529
530 <!-- ##### FUNCTION vte_terminal_set_background_tint_color ##### -->
531 <para>
532
533 </para>
534
535 @terminal: 
536 @color: 
537
538
539 <!-- ##### FUNCTION vte_terminal_set_scroll_background ##### -->
540 <para>
541
542 </para>
543
544 @terminal: 
545 @scroll: 
546
547
548 <!-- ##### FUNCTION vte_terminal_set_cursor_blinks ##### -->
549 <para>
550
551 </para>
552
553 @terminal: 
554 @blink: 
555
556
557 <!-- ##### FUNCTION vte_terminal_set_scrollback_lines ##### -->
558 <para>
559
560 </para>
561
562 @terminal: 
563 @lines: 
564 <!-- # Unused Parameters # -->
565 @Param2: 
566
567
568 <!-- ##### FUNCTION vte_terminal_set_font ##### -->
569 <para>
570
571 </para>
572
573 @terminal: 
574 @font_desc: 
575
576
577 <!-- ##### FUNCTION vte_terminal_set_font_from_string ##### -->
578 <para>
579
580 </para>
581
582 @terminal: 
583 @name: 
584
585
586 <!-- ##### FUNCTION vte_terminal_get_font ##### -->
587 <para>
588
589 </para>
590
591 @terminal: 
592 @Returns: 
593
594
595 <!-- ##### FUNCTION vte_terminal_get_using_xft ##### -->
596 <para>
597
598 </para>
599
600 @terminal: 
601 @Returns: 
602
603
604 <!-- ##### FUNCTION vte_terminal_get_has_selection ##### -->
605 <para>
606
607 </para>
608
609 @terminal: 
610 @Returns: 
611
612
613 <!-- ##### FUNCTION vte_terminal_set_word_chars ##### -->
614 <para>
615
616 </para>
617
618 @terminal: 
619 @spec: 
620
621
622 <!-- ##### FUNCTION vte_terminal_is_word_char ##### -->
623 <para>
624
625 </para>
626
627 @terminal: 
628 @c: 
629 @Returns: 
630
631
632 <!-- ##### FUNCTION vte_terminal_set_backspace_binding ##### -->
633 <para>
634
635 </para>
636
637 @terminal: 
638 @binding: 
639
640
641 <!-- ##### FUNCTION vte_terminal_set_delete_binding ##### -->
642 <para>
643
644 </para>
645
646 @terminal: 
647 @binding: 
648
649
650 <!-- ##### FUNCTION vte_terminal_set_mouse_autohide ##### -->
651 <para>
652
653 </para>
654
655 @terminal: 
656 @setting: 
657
658
659 <!-- ##### FUNCTION vte_terminal_get_mouse_autohide ##### -->
660 <para>
661
662 </para>
663
664 @terminal: 
665 @Returns: 
666
667
668 <!-- ##### FUNCTION vte_terminal_reset ##### -->
669 <para>
670
671 </para>
672
673 @terminal: 
674 @full: 
675 @clear_history: 
676
677
678 <!-- ##### FUNCTION vte_terminal_get_text ##### -->
679 <para>
680
681 </para>
682
683 @terminal: 
684 @is_selected: 
685 @data: 
686 @attributes: 
687 @Returns: 
688
689
690 <!-- ##### FUNCTION vte_terminal_get_text_range ##### -->
691 <para>
692
693 </para>
694
695 @terminal: 
696 @start_row: 
697 @start_col: 
698 @end_row: 
699 @end_col: 
700 @is_selected: 
701 @data: 
702 @attributes: 
703 @Returns: 
704
705
706 <!-- ##### FUNCTION vte_terminal_get_cursor_position ##### -->
707 <para>
708
709 </para>
710
711 @terminal: 
712 @column: 
713 @row: 
714
715
716 <!-- ##### FUNCTION vte_terminal_match_clear_all ##### -->
717 <para>
718
719 </para>
720
721 @terminal: 
722
723
724 <!-- ##### FUNCTION vte_terminal_match_add ##### -->
725 <para>
726
727 </para>
728
729 @terminal: 
730 @match: 
731 @Returns: 
732
733
734 <!-- ##### FUNCTION vte_terminal_match_remove ##### -->
735 <para>
736
737 </para>
738
739 @terminal: 
740 @tag: 
741
742
743 <!-- ##### FUNCTION vte_terminal_match_check ##### -->
744 <para>
745
746 </para>
747
748 @terminal: 
749 @column: 
750 @row: 
751 @tag: 
752 @Returns: 
753 <!-- # Unused Parameters # -->
754 @Param2: 
755 @Param3: 
756
757
758 <!-- ##### FUNCTION vte_terminal_match_set_cursor ##### -->
759 <para>
760
761 </para>
762
763 @terminal: 
764 @tag: 
765 @cursor: 
766
767
768 <!-- ##### FUNCTION vte_terminal_set_emulation ##### -->
769 <para>
770
771 </para>
772
773 @terminal: 
774 @emulation: 
775
776
777 <!-- ##### FUNCTION vte_terminal_get_emulation ##### -->
778 <para>
779
780 </para>
781
782 @terminal: 
783 @Returns: 
784
785
786 <!-- ##### FUNCTION vte_terminal_set_encoding ##### -->
787 <para>
788
789 </para>
790
791 @terminal: 
792 @codeset: 
793
794
795 <!-- ##### FUNCTION vte_terminal_get_encoding ##### -->
796 <para>
797
798 </para>
799
800 @terminal: 
801 @Returns: 
802
803
804 <!-- ##### FUNCTION vte_terminal_get_status_line ##### -->
805 <para>
806
807 </para>
808
809 @terminal: 
810 @Returns: 
811
812
813 <!-- ##### FUNCTION vte_terminal_get_padding ##### -->
814 <para>
815
816 </para>
817
818 @terminal: 
819 @xpad: 
820 @ypad: 
821
822
823 <!-- ##### FUNCTION vte_terminal_get_adjustment ##### -->
824 <para>
825
826 </para>
827
828 @terminal: 
829 @Returns: 
830
831
832 <!-- ##### FUNCTION vte_terminal_get_char_ascent ##### -->
833 <para>
834
835 </para>
836
837 @terminal: 
838 @Returns: 
839
840
841 <!-- ##### FUNCTION vte_terminal_get_char_descent ##### -->
842 <para>
843
844 </para>
845
846 @terminal: 
847 @Returns: 
848
849
850 <!-- ##### FUNCTION vte_terminal_get_char_height ##### -->
851 <para>
852
853 </para>
854
855 @terminal: 
856 @Returns: 
857
858
859 <!-- ##### FUNCTION vte_terminal_get_char_width ##### -->
860 <para>
861
862 </para>
863
864 @terminal: 
865 @Returns: 
866
867
868 <!-- ##### FUNCTION vte_terminal_get_column_count ##### -->
869 <para>
870
871 </para>
872
873 @terminal: 
874 @Returns: 
875
876
877 <!-- ##### FUNCTION vte_terminal_get_icon_title ##### -->
878 <para>
879
880 </para>
881
882 @terminal: 
883 @Returns: 
884
885
886 <!-- ##### FUNCTION vte_terminal_get_row_count ##### -->
887 <para>
888
889 </para>
890
891 @terminal: 
892 @Returns: 
893
894
895 <!-- ##### FUNCTION vte_terminal_get_window_title ##### -->
896 <para>
897
898 </para>
899
900 @terminal: 
901 @Returns: 
902
903