Gnome2::Vte::Terminal(3)

NAME
Gnome2::Vte::Terminal

HIERARCHY
  Glib::Object
  +----Glib::InitiallyUnowned
       +----Gtk2::Object
            +----Gtk2::Widget
                 +----Gnome2::Vte::Terminal

INTERFACES
  Glib::Object::_Unregistered::AtkImplementorIface
  Gtk2::Buildable

METHODS

  widget = Gnome2::Vte::Terminal->new

  adjustment = $terminal->get_adjustment

  boolean = $terminal->get_allow_bold

  $terminal->set_allow_bold ($allow_bold)

•   $allow_bold (boolean)

  boolean = $terminal->get_audible_bell

  $terminal->set_audible_bell ($is_audible)

•   $is_audible (boolean)

  $terminal->set_background_image_file ($path)

•   $path (string)

  $terminal->set_background_image ($image)

•   $image (Gtk2::Gdk::Pixbuf or undef)

  $terminal->set_background_saturation ($saturation)

•   $saturation (double)

  $terminal->set_background_tint_color ($color)

•   $color (Gtk2::Gdk::Color)

Since: vte 0.12

  $terminal->set_background_transparent ($transparent)

•   $transparent (boolean)

  $terminal->set_backspace_binding ($binding)

•   $binding (Gnome2::Vte::Terminal::EraseBinding)

  integer = $terminal->get_char_ascent

  integer = $terminal->get_char_descent

  integer = $terminal->get_char_height

  integer = $terminal->get_char_width

  $terminal->set_color_background ($background)

•   $background (Gtk2::Gdk::Color)

  $terminal->set_color_bold ($bold)

•   $bold (Gtk2::Gdk::Color)

  $terminal->set_color_cursor ($cursor_background)

•   $cursor_background (Gtk2::Gdk::Color or undef)

Since: vte 0.12

  $terminal->set_color_dim ($dim)

•   $dim (Gtk2::Gdk::Color)

  $terminal->set_color_foreground ($foreground)

•   $foreground (Gtk2::Gdk::Color)

  $terminal->set_color_highlight ($highlight_background)

•   $highlight_background (Gtk2::Gdk::Color or undef)

Since: vte 0.12

  $terminal->set_colors ($foreground, $background, $palette_ref)

•   $foreground (Gtk2::Gdk::Color or undef)

•   $background (Gtk2::Gdk::Color or undef)

•   $palette_ref (scalar)

  integer = $terminal->get_column_count

  $terminal->copy_clipboard

  $terminal->copy_primary

  $terminal->set_cursor_blinks ($blink)

•   $blink (boolean)

  (column, row) = $terminal->get_cursor_position

  $terminal->set_default_colors

  string = $terminal->get_default_emulation
Since: vte 0.12

  $terminal->set_delete_binding ($binding)

•   $binding (Gnome2::Vte::Terminal::EraseBinding)

  string = $terminal->get_emulation

  $terminal->set_emulation ($emulation)

•   $emulation (string)

  string = $terminal->get_encoding

  $terminal->set_encoding ($codeset)

•   $codeset (string)

  $terminal->feed ($data)

•   $data (scalar)

  $terminal->feed_child ($data)

•   $data (scalar)

  $terminal->feed_child_binary ($data)

•   $data (scalar)

Since: vte 0.12

  $terminal->set_font_from_string_full ($name, $anti_alias)

•   $name (string)

•   $anti_alias (Gnome2::Vte::Terminal::AntiAlias)

Since: vte 0.12

  $terminal->set_font_from_string ($name)

•   $name (string)

  $terminal->set_font_full ($font_desc, $anti_alias)

•   $font_desc (Pango::FontDescription or undef)

•   $anti_alias (Gnome2::Vte::Terminal::AntiAlias)

Since: vte 0.12

  fontdescription = $terminal->get_font

  $terminal->set_font ($font_desc)

•   $font_desc (Pango::FontDescription)

  integer = $terminal->fork_command ($command, $arg_ref, $env_ref, $directory, $lastlog, $utmp, $wtmp)

•   $command (string)

•   $arg_ref (scalar)

•   $env_ref (scalar)

•   $directory (string or undef)

•   $lastlog (boolean)

•   $utmp (boolean)

•   $wtmp (boolean)

  boolean = $terminal->get_has_selection

  string = $terminal->get_icon_title

  $terminal->im_append_menuitems ($menushell)

•   $menushell (Gtk2::MenuShell)

  boolean = $terminal->is_word_char ($c)

•   $c (character)

  integer = $terminal->match_add ($match)

•   $match (string)

  list = $terminal->match_check ($column, $row)

•   $column (integer)

•   $row (integer)

  $terminal->match_clear_all

  $terminal->match_remove ($tag)

•   $tag (integer)

  $terminal->match_set_cursor ($tag, $cursor)

•   $tag (integer)

•   $cursor (Gtk2::Gdk::Cursor)

Since: vte 0.12

  $terminal->match_set_cursor_type ($tag, $cursor_type)

•   $tag (integer)

•   $cursor_type (Gtk2::Gdk::CursorType)

Since: vte 0.12

  boolean = $terminal->get_mouse_autohide

  $terminal->set_mouse_autohide ($setting)

•   $setting (boolean)

  $terminal->set_opacity ($opacity)

•   $opacity (unsigned)

Since: vte 0.14

  (xpad, ypad) = $terminal->get_padding

  $terminal->paste_clipboard

  $terminal->paste_primary

  $terminal->set_pty ($pty_master)

•   $pty_master (integer)

Since: vte 0.12

  $terminal->reset ($full, $clear_history)

•   $full (boolean)

•   $clear_history (boolean)

  integer = $terminal->get_row_count

  $terminal->set_scroll_background ($scroll)

•   $scroll (boolean)

Since: vte 0.12

  $terminal->set_scroll_on_keystroke ($scroll)

•   $scroll (boolean)

  $terminal->set_scroll_on_output ($scroll)

•   $scroll (boolean)

  $terminal->set_scrollback_lines ($lines)

•   $lines (integer)

  $terminal->set_size ($columns, $rows)

•   $columns (integer)

•   $rows (integer)

  string = $terminal->get_status_line

  list = $terminal->get_text ($func=undef, $data=undef)

•   $func (scalar)

•   $data (scalar)

Returns the selected text and a reference to a VteCharAttributes array describing every character in that text.

  list = $terminal->get_text_include_trailing_spaces ($func, $data=undef)

•   $func (scalar)

•   $data (scalar)

Returns the selected text and a reference to a VteCharAttributes array describing every character in that text.

Since: vte 0.12

  list = $terminal->get_text_range ($start_row, $start_col, $end_row, $end_col, $func, $data=undef)

•   $start_row (integer)

•   $start_col (integer)

•   $end_row (integer)

•   $end_col (integer)

•   $func (scalar)

•   $data (scalar)

Returns the selected text and a reference to a VteCharAttributes array describing every character in that text.

  boolean = $terminal->get_using_xft

  boolean = $terminal->get_visible_bell

  $terminal->set_visible_bell ($is_visible)

•   $is_visible (boolean)

  string = $terminal->get_window_title

  $terminal->set_word_chars ($spec)

•   $spec (string or undef)

PROPERTIES

'allow-bold' (boolean : default true : readable / writable / private)
'audible-bell' (boolean : default true : readable / writable / private)
'background-image-file' (string : default undef : readable / writable / private)
'background-image-pixbuf' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private)
'background-opacity' (double : default 1 : readable / writable / private)
'background-saturation' (double : default 0.4 : readable / writable / private)
'background-tint-color' (Gtk2::Gdk::Color : default undef : readable / writable / private)
'background-transparent' (boolean : default false : readable / writable / private)
'backspace-binding' (Gnome2::Vte::Terminal::EraseBinding : default "auto" : readable / writable / private)
'cursor-blink-mode' (VteTerminalCursorBlinkMode : default "system" : readable / writable / private)
'cursor-shape' (VteTerminalCursorShape : default "block" : readable / writable / private)
'delete-binding' (Gnome2::Vte::Terminal::EraseBinding : default "auto" : readable / writable / private)
'emulation' (string : default "xterm" : readable / writable / private)
'encoding' (string : default undef : readable / writable / private)
'font-desc' (Pango::FontDescription : default undef : readable / writable / private)
'icon-title' (string : default undef : readable / private)
'pointer-autohide' (boolean : default false : readable / writable / private)
'pty' (integer : default -1 : readable / writable / private)
'pty-object' (Glib::Object::_Unregistered::VtePty : default undef : readable / writable / private)
'scroll-background' (boolean : default false : readable / writable / private)
'scroll-on-keystroke' (boolean : default false : readable / writable / private)
'scroll-on-output' (boolean : default true : readable / writable / private)
'scrollback-lines' (Glib::UInt : default 100 : readable / writable / private)
'visible-bell' (boolean : default false : readable / writable / private)
'window-title' (string : default undef : readable / private)
'word-chars' (string : default undef : readable / writable / private)

STYLE PROPERTIES

'inner-border' (Gtk2::Border : default undef : readable / private)

SIGNALS
set-scroll-adjustments (Gnome2::Vte::Terminal, Gtk2::Adjustment, Gtk2::Adjustment)
eof (Gnome2::Vte::Terminal)
child-exited (Gnome2::Vte::Terminal)
window-title-changed (Gnome2::Vte::Terminal)
icon-title-changed (Gnome2::Vte::Terminal)
encoding-changed (Gnome2::Vte::Terminal)
commit (Gnome2::Vte::Terminal, string, Glib::UInt)
emulation-changed (Gnome2::Vte::Terminal)
char-size-changed (Gnome2::Vte::Terminal, Glib::UInt, Glib::UInt)
selection-changed (Gnome2::Vte::Terminal)
contents-changed (Gnome2::Vte::Terminal)
cursor-moved (Gnome2::Vte::Terminal)
deiconify-window (Gnome2::Vte::Terminal)
iconify-window (Gnome2::Vte::Terminal)
raise-window (Gnome2::Vte::Terminal)
lower-window (Gnome2::Vte::Terminal)
refresh-window (Gnome2::Vte::Terminal)
restore-window (Gnome2::Vte::Terminal)
maximize-window (Gnome2::Vte::Terminal)
resize-window (Gnome2::Vte::Terminal, Glib::UInt, Glib::UInt)
move-window (Gnome2::Vte::Terminal, Glib::UInt, Glib::UInt)
status-line-changed (Gnome2::Vte::Terminal)
increase-font-size (Gnome2::Vte::Terminal)
decrease-font-size (Gnome2::Vte::Terminal)
text-modified (Gnome2::Vte::Terminal)
text-inserted (Gnome2::Vte::Terminal)
text-deleted (Gnome2::Vte::Terminal)
text-scrolled (Gnome2::Vte::Terminal, integer)
copy-clipboard (Gnome2::Vte::Terminal)
paste-clipboard (Gnome2::Vte::Terminal)
beep (Gnome2::Vte::Terminal)

ENUMS AND FLAGS

  enum Gnome2::Vte::Terminal::AntiAlias

•   'use-default' / 'VTE_ANTI_ALIAS_USE_DEFAULT'

•   'force-enable' / 'VTE_ANTI_ALIAS_FORCE_ENABLE'

•   'force-disable' / 'VTE_ANTI_ALIAS_FORCE_DISABLE'

  enum Gnome2::Vte::Terminal::EraseBinding

•   'auto' / 'VTE_ERASE_AUTO'

•   'ascii-backspace' / 'VTE_ERASE_ASCII_BACKSPACE'

•   'ascii-delete' / 'VTE_ERASE_ASCII_DELETE'

•   'delete-sequence' / 'VTE_ERASE_DELETE_SEQUENCE'

•   'tty' / 'VTE_ERASE_TTY'

  enum Gtk2::Gdk::CursorType

•   'x-cursor' / 'GDK_X_CURSOR'

•   'arrow' / 'GDK_ARROW'

•   'based-arrow-down' / 'GDK_BASED_ARROW_DOWN'

•   'based-arrow-up' / 'GDK_BASED_ARROW_UP'

•   'boat' / 'GDK_BOAT'

•   'bogosity' / 'GDK_BOGOSITY'

•   'bottom-left-corner' / 'GDK_BOTTOM_LEFT_CORNER'

•   'bottom-right-corner' / 'GDK_BOTTOM_RIGHT_CORNER'

•   'bottom-side' / 'GDK_BOTTOM_SIDE'

•   'bottom-tee' / 'GDK_BOTTOM_TEE'

•   'box-spiral' / 'GDK_BOX_SPIRAL'

•   'center-ptr' / 'GDK_CENTER_PTR'

•   'circle' / 'GDK_CIRCLE'

•   'clock' / 'GDK_CLOCK'

•   'coffee-mug' / 'GDK_COFFEE_MUG'

•   'cross' / 'GDK_CROSS'

•   'cross-reverse' / 'GDK_CROSS_REVERSE'

•   'crosshair' / 'GDK_CROSSHAIR'

•   'diamond-cross' / 'GDK_DIAMOND_CROSS'

•   'dot' / 'GDK_DOT'

•   'dotbox' / 'GDK_DOTBOX'

•   'double-arrow' / 'GDK_DOUBLE_ARROW'

•   'draft-large' / 'GDK_DRAFT_LARGE'

•   'draft-small' / 'GDK_DRAFT_SMALL'

•   'draped-box' / 'GDK_DRAPED_BOX'

•   'exchange' / 'GDK_EXCHANGE'

•   'fleur' / 'GDK_FLEUR'

•   'gobbler' / 'GDK_GOBBLER'

•   'gumby' / 'GDK_GUMBY'

•   'hand1' / 'GDK_HAND1'

•   'hand2' / 'GDK_HAND2'

•   'heart' / 'GDK_HEART'

•   'icon' / 'GDK_ICON'

•   'iron-cross' / 'GDK_IRON_CROSS'

•   'left-ptr' / 'GDK_LEFT_PTR'

•   'left-side' / 'GDK_LEFT_SIDE'

•   'left-tee' / 'GDK_LEFT_TEE'

•   'leftbutton' / 'GDK_LEFTBUTTON'

•   'll-angle' / 'GDK_LL_ANGLE'

•   'lr-angle' / 'GDK_LR_ANGLE'

•   'man' / 'GDK_MAN'

•   'middlebutton' / 'GDK_MIDDLEBUTTON'

•   'mouse' / 'GDK_MOUSE'

•   'pencil' / 'GDK_PENCIL'

•   'pirate' / 'GDK_PIRATE'

•   'plus' / 'GDK_PLUS'

•   'question-arrow' / 'GDK_QUESTION_ARROW'

•   'right-ptr' / 'GDK_RIGHT_PTR'

•   'right-side' / 'GDK_RIGHT_SIDE'

•   'right-tee' / 'GDK_RIGHT_TEE'

•   'rightbutton' / 'GDK_RIGHTBUTTON'

•   'rtl-logo' / 'GDK_RTL_LOGO'

•   'sailboat' / 'GDK_SAILBOAT'

•   'sb-down-arrow' / 'GDK_SB_DOWN_ARROW'

•   'sb-h-double-arrow' / 'GDK_SB_H_DOUBLE_ARROW'

•   'sb-left-arrow' / 'GDK_SB_LEFT_ARROW'

•   'sb-right-arrow' / 'GDK_SB_RIGHT_ARROW'

•   'sb-up-arrow' / 'GDK_SB_UP_ARROW'

•   'sb-v-double-arrow' / 'GDK_SB_V_DOUBLE_ARROW'

•   'shuttle' / 'GDK_SHUTTLE'

•   'sizing' / 'GDK_SIZING'

•   'spider' / 'GDK_SPIDER'

•   'spraycan' / 'GDK_SPRAYCAN'

•   'star' / 'GDK_STAR'

•   'target' / 'GDK_TARGET'

•   'tcross' / 'GDK_TCROSS'

•   'top-left-arrow' / 'GDK_TOP_LEFT_ARROW'

•   'top-left-corner' / 'GDK_TOP_LEFT_CORNER'

•   'top-right-corner' / 'GDK_TOP_RIGHT_CORNER'

•   'top-side' / 'GDK_TOP_SIDE'

•   'top-tee' / 'GDK_TOP_TEE'

•   'trek' / 'GDK_TREK'

•   'ul-angle' / 'GDK_UL_ANGLE'

•   'umbrella' / 'GDK_UMBRELLA'

•   'ur-angle' / 'GDK_UR_ANGLE'

•   'watch' / 'GDK_WATCH'

•   'xterm' / 'GDK_XTERM'

•   'last-cursor' / 'GDK_LAST_CURSOR'

•   'blank-cursor' / 'GDK_BLANK_CURSOR'

•   'cursor-is-pixmap' / 'GDK_CURSOR_IS_PIXMAP'

  enum VteTerminalCursorBlinkMode

•   'system' / 'VTE_CURSOR_BLINK_SYSTEM'

•   'on' / 'VTE_CURSOR_BLINK_ON'

•   'off' / 'VTE_CURSOR_BLINK_OFF'

  enum VteTerminalCursorShape

•   'block' / 'VTE_CURSOR_SHAPE_BLOCK'

•   'ibeam' / 'VTE_CURSOR_SHAPE_IBEAM'

•   'underline' / 'VTE_CURSOR_SHAPE_UNDERLINE'

SEE ALSO
Gnome2::Vte, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget

COPYRIGHT
Copyright (C) 2003-2006 by the gtk2-perl team.

This software is licensed under the LGPL. See Gnome2::Vte for a full notice.