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