Gnome2::Vte::Terminal(3pm)

1Gnome2::Vte::Terminal(3U)ser Contributed Perl DocumentatiGonnome2::Vte::Terminal(3)
2
3
4

NAME

6       Gnome2::Vte::Terminal
7

HIERARCHY

9         Glib::Object
10         +----Glib::InitiallyUnowned
11              +----Gtk2::Object
12                   +----Gtk2::Widget
13                        +----Gnome2::Vte::Terminal
14

INTERFACES

16         Glib::Object::_Unregistered::AtkImplementorIface
17         Gtk2::Buildable
18

METHODS

20   widget = Gnome2::Vte::Terminal->new
21   adjustment = $terminal->get_adjustment
22   boolean = $terminal->get_allow_bold
23   $terminal->set_allow_bold ($allow_bold)
24       •   $allow_bold (boolean)
25
26   boolean = $terminal->get_audible_bell
27   $terminal->set_audible_bell ($is_audible)
28       •   $is_audible (boolean)
29
30   $terminal->set_background_image_file ($path)
31       •   $path (string)
32
33   $terminal->set_background_image ($image)
34       •   $image (Gtk2::Gdk::Pixbuf or undef)
35
36   $terminal->set_background_saturation ($saturation)
37       •   $saturation (double)
38
39   $terminal->set_background_tint_color ($color)
40       •   $color (Gtk2::Gdk::Color)
41
42       Since: vte 0.12
43
44   $terminal->set_background_transparent ($transparent)
45       •   $transparent (boolean)
46
47   $terminal->set_backspace_binding ($binding)
48       •   $binding (Gnome2::Vte::Terminal::EraseBinding)
49
50   integer = $terminal->get_char_ascent
51   integer = $terminal->get_char_descent
52   integer = $terminal->get_char_height
53   integer = $terminal->get_char_width
54   $terminal->set_color_background ($background)
55       •   $background (Gtk2::Gdk::Color)
56
57   $terminal->set_color_bold ($bold)
58       •   $bold (Gtk2::Gdk::Color)
59
60   $terminal->set_color_cursor ($cursor_background)
61       •   $cursor_background (Gtk2::Gdk::Color or undef)
62
63       Since: vte 0.12
64
65   $terminal->set_color_dim ($dim)
66       •   $dim (Gtk2::Gdk::Color)
67
68   $terminal->set_color_foreground ($foreground)
69       •   $foreground (Gtk2::Gdk::Color)
70
71   $terminal->set_color_highlight ($highlight_background)
72       •   $highlight_background (Gtk2::Gdk::Color or undef)
73
74       Since: vte 0.12
75
76   $terminal->set_colors ($foreground, $background, $palette_ref)
77       •   $foreground (Gtk2::Gdk::Color or undef)
78
79       •   $background (Gtk2::Gdk::Color or undef)
80
81       •   $palette_ref (scalar)
82
83   integer = $terminal->get_column_count
84   $terminal->copy_clipboard
85   $terminal->copy_primary
86   $terminal->set_cursor_blinks ($blink)
87       •   $blink (boolean)
88
89   (column, row) = $terminal->get_cursor_position
90   $terminal->set_default_colors
91   string = $terminal->get_default_emulation
92       Since: vte 0.12
93
94   $terminal->set_delete_binding ($binding)
95       •   $binding (Gnome2::Vte::Terminal::EraseBinding)
96
97   string = $terminal->get_emulation
98   $terminal->set_emulation ($emulation)
99       •   $emulation (string)
100
101   string = $terminal->get_encoding
102   $terminal->set_encoding ($codeset)
103       •   $codeset (string)
104
105   $terminal->feed ($data)
106       •   $data (scalar)
107
108   $terminal->feed_child ($data)
109       •   $data (scalar)
110
111   $terminal->feed_child_binary ($data)
112       •   $data (scalar)
113
114       Since: vte 0.12
115
116   $terminal->set_font_from_string_full ($name, $anti_alias)
117       •   $name (string)
118
119       •   $anti_alias (Gnome2::Vte::Terminal::AntiAlias)
120
121       Since: vte 0.12
122
123   $terminal->set_font_from_string ($name)
124       •   $name (string)
125
126   $terminal->set_font_full ($font_desc, $anti_alias)
127       •   $font_desc (Pango::FontDescription or undef)
128
129       •   $anti_alias (Gnome2::Vte::Terminal::AntiAlias)
130
131       Since: vte 0.12
132
133   fontdescription = $terminal->get_font
134   $terminal->set_font ($font_desc)
135       •   $font_desc (Pango::FontDescription)
136
137   integer = $terminal->fork_command ($command, $arg_ref, $env_ref,
138       $directory, $lastlog, $utmp, $wtmp)
139       •   $command (string)
140
141       •   $arg_ref (scalar)
142
143       •   $env_ref (scalar)
144
145       •   $directory (string or undef)
146
147       •   $lastlog (boolean)
148
149       •   $utmp (boolean)
150
151       •   $wtmp (boolean)
152
153   boolean = $terminal->get_has_selection
154   string = $terminal->get_icon_title
155   $terminal->im_append_menuitems ($menushell)
156       •   $menushell (Gtk2::MenuShell)
157
158   boolean = $terminal->is_word_char ($c)
159       •   $c (character)
160
161   integer = $terminal->match_add ($match)
162       •   $match (string)
163
164   list = $terminal->match_check ($column, $row)
165       •   $column (integer)
166
167       •   $row (integer)
168
169   $terminal->match_clear_all
170   $terminal->match_remove ($tag)
171       •   $tag (integer)
172
173   $terminal->match_set_cursor ($tag, $cursor)
174       •   $tag (integer)
175
176       •   $cursor (Gtk2::Gdk::Cursor)
177
178       Since: vte 0.12
179
180   $terminal->match_set_cursor_type ($tag, $cursor_type)
181       •   $tag (integer)
182
183       •   $cursor_type (Gtk2::Gdk::CursorType)
184
185       Since: vte 0.12
186
187   boolean = $terminal->get_mouse_autohide
188   $terminal->set_mouse_autohide ($setting)
189       •   $setting (boolean)
190
191   $terminal->set_opacity ($opacity)
192       •   $opacity (unsigned)
193
194       Since: vte 0.14
195
196   (xpad, ypad) = $terminal->get_padding
197   $terminal->paste_clipboard
198   $terminal->paste_primary
199   $terminal->set_pty ($pty_master)
200       •   $pty_master (integer)
201
202       Since: vte 0.12
203
204   $terminal->reset ($full, $clear_history)
205       •   $full (boolean)
206
207       •   $clear_history (boolean)
208
209   integer = $terminal->get_row_count
210   $terminal->set_scroll_background ($scroll)
211       •   $scroll (boolean)
212
213       Since: vte 0.12
214
215   $terminal->set_scroll_on_keystroke ($scroll)
216       •   $scroll (boolean)
217
218   $terminal->set_scroll_on_output ($scroll)
219       •   $scroll (boolean)
220
221   $terminal->set_scrollback_lines ($lines)
222       •   $lines (integer)
223
224   $terminal->set_size ($columns, $rows)
225       •   $columns (integer)
226
227       •   $rows (integer)
228
229   string = $terminal->get_status_line
230   list = $terminal->get_text ($func=undef, $data=undef)
231       •   $func (scalar)
232
233       •   $data (scalar)
234
235       Returns the selected text and a reference to a VteCharAttributes array
236       describing every character in that text.
237
238   list = $terminal->get_text_include_trailing_spaces ($func, $data=undef)
239       •   $func (scalar)
240
241       •   $data (scalar)
242
243       Returns the selected text and a reference to a VteCharAttributes array
244       describing every character in that text.
245
246       Since: vte 0.12
247
248   list = $terminal->get_text_range ($start_row, $start_col, $end_row,
249       $end_col, $func, $data=undef)
250       •   $start_row (integer)
251
252       •   $start_col (integer)
253
254       •   $end_row (integer)
255
256       •   $end_col (integer)
257
258       •   $func (scalar)
259
260       •   $data (scalar)
261
262       Returns the selected text and a reference to a VteCharAttributes array
263       describing every character in that text.
264
265   boolean = $terminal->get_using_xft
266   boolean = $terminal->get_visible_bell
267   $terminal->set_visible_bell ($is_visible)
268       •   $is_visible (boolean)
269
270   string = $terminal->get_window_title
271   $terminal->set_word_chars ($spec)
272       •   $spec (string or undef)
273

PROPERTIES

275       'allow-bold' (boolean : default true : readable / writable / private /
276       static-nick / static-blurb)
277       'audible-bell' (boolean : default true : readable / writable / private
278       / static-nick / static-blurb)
279       'background-image-file' (string : default undef : readable / writable /
280       private / static-nick / static-blurb)
281       'background-image-pixbuf' (Gtk2::Gdk::Pixbuf : default undef : readable
282       / writable / private / static-nick / static-blurb)
283       'background-opacity' (double : default 1 : readable / writable /
284       private / static-nick / static-blurb)
285       'background-saturation' (double : default 0.4 : readable / writable /
286       private / static-nick / static-blurb)
287       'background-tint-color' (Gtk2::Gdk::Color : default undef : readable /
288       writable / private / static-nick / static-blurb)
289       'background-transparent' (boolean : default false : readable / writable
290       / private / static-nick / static-blurb)
291       'backspace-binding' (Gnome2::Vte::Terminal::EraseBinding : default
292       "auto" : readable / writable / private / static-nick / static-blurb)
293       'cursor-blink-mode' (VteTerminalCursorBlinkMode : default "system" :
294       readable / writable / private / static-nick / static-blurb)
295       'cursor-shape' (VteTerminalCursorShape : default "block" : readable /
296       writable / private / static-nick / static-blurb)
297       'delete-binding' (Gnome2::Vte::Terminal::EraseBinding : default "auto"
298       : readable / writable / private / static-nick / static-blurb)
299       'emulation' (string : default "xterm" : readable / writable / private /
300       static-nick / static-blurb)
301       'encoding' (string : default undef : readable / writable / private /
302       static-nick / static-blurb)
303       'font-desc' (Pango::FontDescription : default undef : readable /
304       writable / private / static-nick / static-blurb)
305       'icon-title' (string : default undef : readable / private / static-nick
306       / static-blurb)
307       'pointer-autohide' (boolean : default false : readable / writable /
308       private / static-nick / static-blurb)
309       'pty' (integer : default -1 : readable / writable / private / static-
310       nick / static-blurb)
311       'pty-object' (Glib::Object::_Unregistered::VtePty : default undef :
312       readable / writable / private / static-nick / static-blurb)
313       'scroll-background' (boolean : default false : readable / writable /
314       private / static-nick / static-blurb)
315       'scroll-on-keystroke' (boolean : default false : readable / writable /
316       private / static-nick / static-blurb)
317       'scroll-on-output' (boolean : default true : readable / writable /
318       private / static-nick / static-blurb)
319       'scrollback-lines' (Glib::UInt : default 100 : readable / writable /
320       private / static-nick / static-blurb)
321       'visible-bell' (boolean : default false : readable / writable / private
322       / static-nick / static-blurb)
323       'window-title' (string : default undef : readable / private / static-
324       nick / static-blurb)
325       'word-chars' (string : default undef : readable / writable / private /
326       static-nick / static-blurb)
327

STYLE PROPERTIES

329       'inner-border' (Gtk2::Border : default undef : readable / private /
330       static-nick / static-blurb)
331

SIGNALS

333       beep (Gnome2::Vte::Terminal)
334       char-size-changed (Gnome2::Vte::Terminal, Glib::UInt, Glib::UInt)
335       child-exited (Gnome2::Vte::Terminal)
336       commit (Gnome2::Vte::Terminal, string, Glib::UInt)
337       contents-changed (Gnome2::Vte::Terminal)
338       copy-clipboard (Gnome2::Vte::Terminal)
339       cursor-moved (Gnome2::Vte::Terminal)
340       decrease-font-size (Gnome2::Vte::Terminal)
341       deiconify-window (Gnome2::Vte::Terminal)
342       emulation-changed (Gnome2::Vte::Terminal)
343       encoding-changed (Gnome2::Vte::Terminal)
344       eof (Gnome2::Vte::Terminal)
345       icon-title-changed (Gnome2::Vte::Terminal)
346       iconify-window (Gnome2::Vte::Terminal)
347       increase-font-size (Gnome2::Vte::Terminal)
348       lower-window (Gnome2::Vte::Terminal)
349       maximize-window (Gnome2::Vte::Terminal)
350       move-window (Gnome2::Vte::Terminal, Glib::UInt, Glib::UInt)
351       paste-clipboard (Gnome2::Vte::Terminal)
352       raise-window (Gnome2::Vte::Terminal)
353       refresh-window (Gnome2::Vte::Terminal)
354       resize-window (Gnome2::Vte::Terminal, Glib::UInt, Glib::UInt)
355       restore-window (Gnome2::Vte::Terminal)
356       selection-changed (Gnome2::Vte::Terminal)
357       set-scroll-adjustments (Gnome2::Vte::Terminal, Gtk2::Adjustment,
358       Gtk2::Adjustment)
359       status-line-changed (Gnome2::Vte::Terminal)
360       text-deleted (Gnome2::Vte::Terminal)
361       text-inserted (Gnome2::Vte::Terminal)
362       text-modified (Gnome2::Vte::Terminal)
363       text-scrolled (Gnome2::Vte::Terminal, integer)
364       window-title-changed (Gnome2::Vte::Terminal)
365

ENUMS AND FLAGS

367   enum Gnome2::Vte::Terminal::AntiAlias
368       •   'use-default' / 'VTE_ANTI_ALIAS_USE_DEFAULT'
369
370       •   'force-enable' / 'VTE_ANTI_ALIAS_FORCE_ENABLE'
371
372       •   'force-disable' / 'VTE_ANTI_ALIAS_FORCE_DISABLE'
373
374   enum Gnome2::Vte::Terminal::EraseBinding
375       •   'auto' / 'VTE_ERASE_AUTO'
376
377       •   'ascii-backspace' / 'VTE_ERASE_ASCII_BACKSPACE'
378
379       •   'ascii-delete' / 'VTE_ERASE_ASCII_DELETE'
380
381       •   'delete-sequence' / 'VTE_ERASE_DELETE_SEQUENCE'
382
383       •   'tty' / 'VTE_ERASE_TTY'
384
385   enum Gtk2::Gdk::CursorType
386       •   'x-cursor' / 'GDK_X_CURSOR'
387
388       •   'arrow' / 'GDK_ARROW'
389
390       •   'based-arrow-down' / 'GDK_BASED_ARROW_DOWN'
391
392       •   'based-arrow-up' / 'GDK_BASED_ARROW_UP'
393
394       •   'boat' / 'GDK_BOAT'
395
396       •   'bogosity' / 'GDK_BOGOSITY'
397
398       •   'bottom-left-corner' / 'GDK_BOTTOM_LEFT_CORNER'
399
400       •   'bottom-right-corner' / 'GDK_BOTTOM_RIGHT_CORNER'
401
402       •   'bottom-side' / 'GDK_BOTTOM_SIDE'
403
404       •   'bottom-tee' / 'GDK_BOTTOM_TEE'
405
406       •   'box-spiral' / 'GDK_BOX_SPIRAL'
407
408       •   'center-ptr' / 'GDK_CENTER_PTR'
409
410       •   'circle' / 'GDK_CIRCLE'
411
412       •   'clock' / 'GDK_CLOCK'
413
414       •   'coffee-mug' / 'GDK_COFFEE_MUG'
415
416       •   'cross' / 'GDK_CROSS'
417
418       •   'cross-reverse' / 'GDK_CROSS_REVERSE'
419
420       •   'crosshair' / 'GDK_CROSSHAIR'
421
422       •   'diamond-cross' / 'GDK_DIAMOND_CROSS'
423
424       •   'dot' / 'GDK_DOT'
425
426       •   'dotbox' / 'GDK_DOTBOX'
427
428       •   'double-arrow' / 'GDK_DOUBLE_ARROW'
429
430       •   'draft-large' / 'GDK_DRAFT_LARGE'
431
432       •   'draft-small' / 'GDK_DRAFT_SMALL'
433
434       •   'draped-box' / 'GDK_DRAPED_BOX'
435
436       •   'exchange' / 'GDK_EXCHANGE'
437
438       •   'fleur' / 'GDK_FLEUR'
439
440       •   'gobbler' / 'GDK_GOBBLER'
441
442       •   'gumby' / 'GDK_GUMBY'
443
444       •   'hand1' / 'GDK_HAND1'
445
446       •   'hand2' / 'GDK_HAND2'
447
448       •   'heart' / 'GDK_HEART'
449
450       •   'icon' / 'GDK_ICON'
451
452       •   'iron-cross' / 'GDK_IRON_CROSS'
453
454       •   'left-ptr' / 'GDK_LEFT_PTR'
455
456       •   'left-side' / 'GDK_LEFT_SIDE'
457
458       •   'left-tee' / 'GDK_LEFT_TEE'
459
460       •   'leftbutton' / 'GDK_LEFTBUTTON'
461
462       •   'll-angle' / 'GDK_LL_ANGLE'
463
464       •   'lr-angle' / 'GDK_LR_ANGLE'
465
466       •   'man' / 'GDK_MAN'
467
468       •   'middlebutton' / 'GDK_MIDDLEBUTTON'
469
470       •   'mouse' / 'GDK_MOUSE'
471
472       •   'pencil' / 'GDK_PENCIL'
473
474       •   'pirate' / 'GDK_PIRATE'
475
476       •   'plus' / 'GDK_PLUS'
477
478       •   'question-arrow' / 'GDK_QUESTION_ARROW'
479
480       •   'right-ptr' / 'GDK_RIGHT_PTR'
481
482       •   'right-side' / 'GDK_RIGHT_SIDE'
483
484       •   'right-tee' / 'GDK_RIGHT_TEE'
485
486       •   'rightbutton' / 'GDK_RIGHTBUTTON'
487
488       •   'rtl-logo' / 'GDK_RTL_LOGO'
489
490       •   'sailboat' / 'GDK_SAILBOAT'
491
492       •   'sb-down-arrow' / 'GDK_SB_DOWN_ARROW'
493
494       •   'sb-h-double-arrow' / 'GDK_SB_H_DOUBLE_ARROW'
495
496       •   'sb-left-arrow' / 'GDK_SB_LEFT_ARROW'
497
498       •   'sb-right-arrow' / 'GDK_SB_RIGHT_ARROW'
499
500       •   'sb-up-arrow' / 'GDK_SB_UP_ARROW'
501
502       •   'sb-v-double-arrow' / 'GDK_SB_V_DOUBLE_ARROW'
503
504       •   'shuttle' / 'GDK_SHUTTLE'
505
506       •   'sizing' / 'GDK_SIZING'
507
508       •   'spider' / 'GDK_SPIDER'
509
510       •   'spraycan' / 'GDK_SPRAYCAN'
511
512       •   'star' / 'GDK_STAR'
513
514       •   'target' / 'GDK_TARGET'
515
516       •   'tcross' / 'GDK_TCROSS'
517
518       •   'top-left-arrow' / 'GDK_TOP_LEFT_ARROW'
519
520       •   'top-left-corner' / 'GDK_TOP_LEFT_CORNER'
521
522       •   'top-right-corner' / 'GDK_TOP_RIGHT_CORNER'
523
524       •   'top-side' / 'GDK_TOP_SIDE'
525
526       •   'top-tee' / 'GDK_TOP_TEE'
527
528       •   'trek' / 'GDK_TREK'
529
530       •   'ul-angle' / 'GDK_UL_ANGLE'
531
532       •   'umbrella' / 'GDK_UMBRELLA'
533
534       •   'ur-angle' / 'GDK_UR_ANGLE'
535
536       •   'watch' / 'GDK_WATCH'
537
538       •   'xterm' / 'GDK_XTERM'
539
540       •   'last-cursor' / 'GDK_LAST_CURSOR'
541
542       •   'blank-cursor' / 'GDK_BLANK_CURSOR'
543
544       •   'cursor-is-pixmap' / 'GDK_CURSOR_IS_PIXMAP'
545
546   enum VteTerminalCursorBlinkMode
547       •   'system' / 'VTE_CURSOR_BLINK_SYSTEM'
548
549       •   'on' / 'VTE_CURSOR_BLINK_ON'
550
551       •   'off' / 'VTE_CURSOR_BLINK_OFF'
552
553   enum VteTerminalCursorShape
554       •   'block' / 'VTE_CURSOR_SHAPE_BLOCK'
555
556       •   'ibeam' / 'VTE_CURSOR_SHAPE_IBEAM'
557
558       •   'underline' / 'VTE_CURSOR_SHAPE_UNDERLINE'
559

COPYRIGHT

565       Copyright (C) 2003-2006 by the gtk2-perl team.
566
567       This software is licensed under the LGPL.  See Gnome2::Vte for a full
568       notice.
569
570
571
572perl v5.36.0                      2022-07-22          Gnome2::Vte::Terminal(3)