vte Reference Manual

Synopsis

public class Terminal : Widget, Implementor, Buildable  {
    public    weak Gtk.Adjustment       adjustment ;
    public    long                      char_width ;
    public    long                      char_height ;
    public    long                      char_ascent ;
    public    long                      char_descent ;
    public    long                      row_count ;
    public    long                      column_count ;
    public    weak string               window_title ;
    public    weak string               icon_title ;


    public                              Terminal                  (  ) ;


    public    signal void               char_size_changed         ( uint                char_width,
                                                                    uint                char_height )  ;
    public    signal void               child_exited              (  )  ;
    public    signal void               commit                    ( string              text,
                                                                    uint                size )  ;
    public    signal void               contents_changed          (  )  ;
    public    signal void               copy_clipboard            (  )  ;
    public    signal void               cursor_moved              (  )  ;
    public    signal void               decrease_font_size        (  )  ;
    public    signal void               deiconify_window          (  )  ;
    public    signal void               emulation_changed         (  )  ;
    public    signal void               encoding_changed          (  )  ;
    public    signal void               eof                       (  )  ;
    public    signal void               icon_title_changed        (  )  ;
    public    signal void               iconify_window            (  )  ;
    public    signal void               increase_font_size        (  )  ;
    public    signal void               lower_window              (  )  ;
    public    signal void               maximize_window           (  )  ;
    public    signal void               move_window               ( uint                x,
                                                                    uint                y )  ;
    public    signal void               paste_clipboard           (  )  ;
    public    signal void               raise_window              (  )  ;
    public    signal void               refresh_window            (  )  ;
    public    signal void               resize_window             ( uint                width,
                                                                    uint                height )  ;
    public    signal void               restore_window            (  )  ;
    public    signal void               selection_changed         (  )  ;
    public    signal void               status_line_changed       (  )  ;
    public    signal void               text_deleted              (  )  ;
    public    signal void               text_inserted             (  )  ;
    public    signal void               text_modified             (  )  ;
    public    signal void               text_scrolled             ( int                 delta )  ;
    public    signal void               window_title_changed      (  )  ;


    public    void                      copy_primary              (  ) ;
    public    void                      feed                      ( string              data,
                                                                    long                length ) ;
    public    void                      feed_child                ( string              text,
                                                                    long                length ) ;
    public    void                      feed_child_binary         ( string              data,
                                                                    long                length ) ;
    public    int                       fork_command              ( string              command,
                                                                    string[]            argv,
                                                                    string[]            envv,
                                                                    string              directory,
                                                                    bool                lastlog,
                                                                    bool                utmp,
                                                                    bool                wtmp ) ;
    public    int                       forkpty                   ( string[]            envv,
                                                                    string              directory,
                                                                    bool                lastlog,
                                                                    bool                utmp,
                                                                    bool                wtmp ) ;
    public    weak Gtk.Adjustment       get_adjustment            (  ) ;
    public    bool                      get_allow_bold            (  ) ;
    public    bool                      get_audible_bell          (  ) ;
    public    long                      get_char_ascent           (  ) ;
    public    long                      get_char_descent          (  ) ;
    public    long                      get_char_height           (  ) ;
    public    long                      get_char_width            (  ) ;
    public    long                      get_column_count          (  ) ;
    public    void                      get_cursor_position       ( long                column,
                                                                    long                row ) ;
    public    weak string               get_default_emulation     (  ) ;
    public    weak string               get_emulation             (  ) ;
    public    weak string               get_encoding              (  ) ;
    public    weak Pango.FontDescription  get_font                  (  ) ;
    public    bool                      get_has_selection         (  ) ;
    public    weak string               get_icon_title            (  ) ;
    public    bool                      get_mouse_autohide        (  ) ;
    public    void                      get_padding               ( int                 xpad,
                                                                    int                 ypad ) ;
    public    long                      get_row_count             (  ) ;
    public    weak string               get_status_line           (  ) ;
    public    weak string               get_text                  ( GLib.Callback       is_selected,
                                                                    void**              data,
                                                                    GLib.Array          attributes ) ;
    public    weak string               get_text_include_trailing_spaces ( GLib.Callback       is_selected,
                                                                    void**              data,
                                                                    GLib.Array          attributes ) ;
    public    weak string               get_text_range            ( long                start_row,
                                                                    long                start_col,
                                                                    long                end_row,
                                                                    long                end_col,
                                                                    GLib.Callback       is_selected,
                                                                    void**              data,
                                                                    GLib.Array          attributes ) ;
    public    bool                      get_using_xft             (  ) ;
    public    bool                      get_visible_bell          (  ) ;
    public    weak string               get_window_title          (  ) ;
    public    void                      im_append_menuitems       ( Gtk.MenuShell       menushell ) ;
    public    bool                      is_word_char              ( unichar             c ) ;
    public    int                       match_add                 ( string              match ) ;
    public    weak string               match_check               ( long                column,
                                                                    long                row,
                                                                    int                 tag ) ;
    public    void                      match_clear_all           (  ) ;
    public    void                      match_remove              ( int                 tag ) ;
    public    void                      match_set_cursor          ( int                 tag,
                                                                    Gdk.Cursor          cursor ) ;
    public    void                      match_set_cursor_type     ( int                 tag,
                                                                    Gdk.CursorType      cursor_type ) ;
    public    void                      paste_primary             (  ) ;
    public    void                      reset                     ( bool                full,
                                                                    bool                clear_history ) ;
    public    void                      select_all                (  ) ;
    public    void                      select_none               (  ) ;
    public    void                      set_allow_bold            ( bool                allow_bold ) ;
    public    void                      set_audible_bell          ( bool                is_audible ) ;
    public    void                      set_background_image      ( Gdk.Pixbuf          image ) ;
    public    void                      set_background_image_file ( string              path ) ;
    public    void                      set_background_saturation ( double              saturation ) ;
    public    void                      set_background_tint_color ( Gdk.Color           color ) ;
    public    void                      set_background_transparent ( bool                transparent ) ;
    public    void                      set_backspace_binding     ( TerminalEraseBindingbinding ) ;
    public    void                      set_color_background      ( Gdk.Color           background ) ;
    public    void                      set_color_bold            ( Gdk.Color           bold ) ;
    public    void                      set_color_cursor          ( Gdk.Color           cursor_background ) ;
    public    void                      set_color_dim             ( Gdk.Color           dim ) ;
    public    void                      set_color_foreground      ( Gdk.Color           foreground ) ;
    public    void                      set_color_highlight       ( Gdk.Color           highlight_background ) ;
    public    void                      set_colors                ( Gdk.Color           foreground,
                                                                    Gdk.Color           background,
                                                                    Gdk.Color[]         palette,
                                                                    long                palette_size ) ;
    public    void                      set_cursor_blinks         ( bool                blink ) ;
    public    void                      set_default_colors        (  ) ;
    public    void                      set_delete_binding        ( TerminalEraseBindingbinding ) ;
    public    void                      set_emulation             ( string              emulation ) ;
    public    void                      set_encoding              ( string              codeset ) ;
    public    void                      set_font                  ( Pango.FontDescription font_desc ) ;
    public    void                      set_font_from_string      ( string              name ) ;
    public    void                      set_font_from_string_full ( string              name,
                                                                    TerminalAntiAlias   antialias ) ;
    public    void                      set_font_full             ( Pango.FontDescription font_desc,
                                                                    TerminalAntiAlias   antialias ) ;
    public    void                      set_mouse_autohide        ( bool                setting ) ;
    public    void                      set_opacity               ( ushort              opacity ) ;
    public    void                      set_pty                   ( int                 pty_master ) ;
    public    void                      set_scroll_background     ( bool                scroll ) ;
    public    void                      set_scroll_on_keystroke   ( bool                scroll ) ;
    public    void                      set_scroll_on_output      ( bool                scroll ) ;
    public    void                      set_scrollback_lines      ( long                lines ) ;
    public    void                      set_size                  ( long                columns,
                                                                    long                rows ) ;
    public    void                      set_visible_bell          ( bool                is_visible ) ;
    public    void                      set_word_chars            ( string              spec ) ;
    public    virtual void              vte_reserved1             (  ) ;
    public    virtual void              vte_reserved2             (  ) ;
    public    virtual void              vte_reserved3             (  ) ;
    public    virtual void              vte_reserved4             (  ) ;
}

Terminal Description

Details

Constructor Details

Terminal ()
    public                              Terminal                  (  ) ;		

Field Details

adjustment
    public    weak Gtk.Adjustment       adjustment ;		

char_width
    public    long                      char_width ;		

char_height
    public    long                      char_height ;		

char_ascent
    public    long                      char_ascent ;		

char_descent
    public    long                      char_descent ;		

row_count
    public    long                      row_count ;		

column_count
    public    long                      column_count ;		

window_title
    public    weak string               window_title ;		

icon_title
    public    weak string               icon_title ;		

Signal Details

char_size_changed
    public    signal void               char_size_changed         ( uint                char_width,
                                                                    uint                char_height )  ;		

child_exited
    public    signal void               child_exited              (  )  ;		

commit
    public    signal void               commit                    ( string              text,
                                                                    uint                size )  ;		

contents_changed
    public    signal void               contents_changed          (  )  ;		

copy_clipboard
    public    signal void               copy_clipboard            (  )  ;		

cursor_moved
    public    signal void               cursor_moved              (  )  ;		

decrease_font_size
    public    signal void               decrease_font_size        (  )  ;		

deiconify_window
    public    signal void               deiconify_window          (  )  ;		

emulation_changed
    public    signal void               emulation_changed         (  )  ;		

encoding_changed
    public    signal void               encoding_changed          (  )  ;		

eof
    public    signal void               eof                       (  )  ;		

icon_title_changed
    public    signal void               icon_title_changed        (  )  ;		

iconify_window
    public    signal void               iconify_window            (  )  ;		

increase_font_size
    public    signal void               increase_font_size        (  )  ;		

lower_window
    public    signal void               lower_window              (  )  ;		

maximize_window
    public    signal void               maximize_window           (  )  ;		

move_window
    public    signal void               move_window               ( uint                x,
                                                                    uint                y )  ;		

paste_clipboard
    public    signal void               paste_clipboard           (  )  ;		

raise_window
    public    signal void               raise_window              (  )  ;		

refresh_window
    public    signal void               refresh_window            (  )  ;		

resize_window
    public    signal void               resize_window             ( uint                width,
                                                                    uint                height )  ;		

restore_window
    public    signal void               restore_window            (  )  ;		

selection_changed
    public    signal void               selection_changed         (  )  ;		

status_line_changed
    public    signal void               status_line_changed       (  )  ;		

text_deleted
    public    signal void               text_deleted              (  )  ;		

text_inserted
    public    signal void               text_inserted             (  )  ;		

text_modified
    public    signal void               text_modified             (  )  ;		

text_scrolled
    public    signal void               text_scrolled             ( int                 delta )  ;		

window_title_changed
    public    signal void               window_title_changed      (  )  ;		

Property Details

Method Details

copy_primary ()
    public    void                      copy_primary              (  ) ;		

feed ()
    public    void                      feed                      ( string              data,
                                                                    long                length ) ;		

feed_child ()
    public    void                      feed_child                ( string              text,
                                                                    long                length ) ;		

feed_child_binary ()
    public    void                      feed_child_binary         ( string              data,
                                                                    long                length ) ;		

fork_command ()
    public    int                       fork_command              ( string              command,
                                                                    string[]            argv,
                                                                    string[]            envv,
                                                                    string              directory,
                                                                    bool                lastlog,
                                                                    bool                utmp,
                                                                    bool                wtmp ) ;		

forkpty ()
    public    int                       forkpty                   ( string[]            envv,
                                                                    string              directory,
                                                                    bool                lastlog,
                                                                    bool                utmp,
                                                                    bool                wtmp ) ;		

get_adjustment ()
    public    weak Gtk.Adjustment       get_adjustment            (  ) ;		

get_allow_bold ()
    public    bool                      get_allow_bold            (  ) ;		

get_audible_bell ()
    public    bool                      get_audible_bell          (  ) ;		

get_char_ascent ()
    public    long                      get_char_ascent           (  ) ;		

get_char_descent ()
    public    long                      get_char_descent          (  ) ;		

get_char_height ()
    public    long                      get_char_height           (  ) ;		

get_char_width ()
    public    long                      get_char_width            (  ) ;		

get_column_count ()
    public    long                      get_column_count          (  ) ;		

get_cursor_position ()
    public    void                      get_cursor_position       ( long                column,
                                                                    long                row ) ;		

get_default_emulation ()
    public    weak string               get_default_emulation     (  ) ;		

get_emulation ()
    public    weak string               get_emulation             (  ) ;		

get_encoding ()
    public    weak string               get_encoding              (  ) ;		

get_font ()
    public    weak Pango.FontDescription  get_font                  (  ) ;		

get_has_selection ()
    public    bool                      get_has_selection         (  ) ;		

get_icon_title ()
    public    weak string               get_icon_title            (  ) ;		

get_mouse_autohide ()
    public    bool                      get_mouse_autohide        (  ) ;		

get_padding ()
    public    void                      get_padding               ( int                 xpad,
                                                                    int                 ypad ) ;		

get_row_count ()
    public    long                      get_row_count             (  ) ;		

get_status_line ()
    public    weak string               get_status_line           (  ) ;		

get_text ()
    public    weak string               get_text                  ( GLib.Callback       is_selected,
                                                                    void**              data,
                                                                    GLib.Array          attributes ) ;		

get_text_include_trailing_spaces ()
    public    weak string               get_text_include_trailing_spaces ( GLib.Callback       is_selected,
                                                                    void**              data,
                                                                    GLib.Array          attributes ) ;		

get_text_range ()
    public    weak string               get_text_range            ( long                start_row,
                                                                    long                start_col,
                                                                    long                end_row,
                                                                    long                end_col,
                                                                    GLib.Callback       is_selected,
                                                                    void**              data,
                                                                    GLib.Array          attributes ) ;		

get_using_xft ()
    public    bool                      get_using_xft             (  ) ;		

get_visible_bell ()
    public    bool                      get_visible_bell          (  ) ;		

get_window_title ()
    public    weak string               get_window_title          (  ) ;		

im_append_menuitems ()
    public    void                      im_append_menuitems       ( Gtk.MenuShell       menushell ) ;		

is_word_char ()
    public    bool                      is_word_char              ( unichar             c ) ;		

match_add ()
    public    int                       match_add                 ( string              match ) ;		

match_check ()
    public    weak string               match_check               ( long                column,
                                                                    long                row,
                                                                    int                 tag ) ;		

match_clear_all ()
    public    void                      match_clear_all           (  ) ;		

match_remove ()
    public    void                      match_remove              ( int                 tag ) ;		

match_set_cursor ()
    public    void                      match_set_cursor          ( int                 tag,
                                                                    Gdk.Cursor          cursor ) ;		

match_set_cursor_type ()
    public    void                      match_set_cursor_type     ( int                 tag,
                                                                    Gdk.CursorType      cursor_type ) ;		

paste_primary ()
    public    void                      paste_primary             (  ) ;		

reset ()
    public    void                      reset                     ( bool                full,
                                                                    bool                clear_history ) ;		

select_all ()
    public    void                      select_all                (  ) ;		

select_none ()
    public    void                      select_none               (  ) ;		

set_allow_bold ()
    public    void                      set_allow_bold            ( bool                allow_bold ) ;		

set_audible_bell ()
    public    void                      set_audible_bell          ( bool                is_audible ) ;		

set_background_image ()
    public    void                      set_background_image      ( Gdk.Pixbuf          image ) ;		

set_background_image_file ()
    public    void                      set_background_image_file ( string              path ) ;		

set_background_saturation ()
    public    void                      set_background_saturation ( double              saturation ) ;		

set_background_tint_color ()
    public    void                      set_background_tint_color ( Gdk.Color           color ) ;		

set_background_transparent ()
    public    void                      set_background_transparent ( bool                transparent ) ;		

set_backspace_binding ()
    public    void                      set_backspace_binding     ( TerminalEraseBindingbinding ) ;		

set_color_background ()
    public    void                      set_color_background      ( Gdk.Color           background ) ;		

set_color_bold ()
    public    void                      set_color_bold            ( Gdk.Color           bold ) ;		

set_color_cursor ()
    public    void                      set_color_cursor          ( Gdk.Color           cursor_background ) ;		

set_color_dim ()
    public    void                      set_color_dim             ( Gdk.Color           dim ) ;		

set_color_foreground ()
    public    void                      set_color_foreground      ( Gdk.Color           foreground ) ;		

set_color_highlight ()
    public    void                      set_color_highlight       ( Gdk.Color           highlight_background ) ;		

set_colors ()
    public    void                      set_colors                ( Gdk.Color           foreground,
                                                                    Gdk.Color           background,
                                                                    Gdk.Color[]         palette,
                                                                    long                palette_size ) ;		

set_cursor_blinks ()
    public    void                      set_cursor_blinks         ( bool                blink ) ;		

set_default_colors ()
    public    void                      set_default_colors        (  ) ;		

set_delete_binding ()
    public    void                      set_delete_binding        ( TerminalEraseBindingbinding ) ;		

set_emulation ()
    public    void                      set_emulation             ( string              emulation ) ;		

set_encoding ()
    public    void                      set_encoding              ( string              codeset ) ;		

set_font ()
    public    void                      set_font                  ( Pango.FontDescription font_desc ) ;		

set_font_from_string ()
    public    void                      set_font_from_string      ( string              name ) ;		

set_font_from_string_full ()
    public    void                      set_font_from_string_full ( string              name,
                                                                    TerminalAntiAlias   antialias ) ;		

set_font_full ()
    public    void                      set_font_full             ( Pango.FontDescription font_desc,
                                                                    TerminalAntiAlias   antialias ) ;		

set_mouse_autohide ()
    public    void                      set_mouse_autohide        ( bool                setting ) ;		

set_opacity ()
    public    void                      set_opacity               ( ushort              opacity ) ;		

set_pty ()
    public    void                      set_pty                   ( int                 pty_master ) ;		

set_scroll_background ()
    public    void                      set_scroll_background     ( bool                scroll ) ;		

set_scroll_on_keystroke ()
    public    void                      set_scroll_on_keystroke   ( bool                scroll ) ;		

set_scroll_on_output ()
    public    void                      set_scroll_on_output      ( bool                scroll ) ;		

set_scrollback_lines ()
    public    void                      set_scrollback_lines      ( long                lines ) ;		

set_size ()
    public    void                      set_size                  ( long                columns,
                                                                    long                rows ) ;		

set_visible_bell ()
    public    void                      set_visible_bell          ( bool                is_visible ) ;		

set_word_chars ()
    public    void                      set_word_chars            ( string              spec ) ;		

vte_reserved1 ()
    public    virtual void              vte_reserved1             (  ) ;		

vte_reserved2 ()
    public    virtual void              vte_reserved2             (  ) ;		

vte_reserved3 ()
    public    virtual void              vte_reserved3             (  ) ;		

vte_reserved4 ()
    public    virtual void              vte_reserved4             (  ) ;		


Created by Valadoc