VteTerminal

VteTerminal — A terminal widget implementation

Synopsis

struct              VteTerminal;
enum                VteCursorBlinkMode;
enum                VteCursorShape;
enum                VteEraseBinding;
enum                VteWriteFlags;
gboolean            (*VteSelectionFunc)                 (VteTerminal *terminal,
                                                         glong column,
                                                         glong row,
                                                         gpointer data);
GtkWidget *         vte_terminal_new                    (void);
void                vte_terminal_feed                   (VteTerminal *terminal,
                                                         const char *data,
                                                         gssize length);
void                vte_terminal_feed_child             (VteTerminal *terminal,
                                                         const char *text,
                                                         gssize length);
void                vte_terminal_feed_child_binary      (VteTerminal *terminal,
                                                         const guint8 *data,
                                                         gsize length);
void                vte_terminal_select_all             (VteTerminal *terminal);
void                vte_terminal_unselect_all           (VteTerminal *terminal);
void                vte_terminal_copy_clipboard         (VteTerminal *terminal);
void                vte_terminal_paste_clipboard        (VteTerminal *terminal);
void                vte_terminal_copy_primary           (VteTerminal *terminal);
void                vte_terminal_paste_primary          (VteTerminal *terminal);
void                vte_terminal_set_size               (VteTerminal *terminal,
                                                         glong columns,
                                                         glong rows);
void                vte_terminal_set_font_scale         (VteTerminal *terminal,
                                                         gdouble scale);
gdouble             vte_terminal_get_font_scale         (VteTerminal *terminal);
void                vte_terminal_set_audible_bell       (VteTerminal *terminal,
                                                         gboolean is_audible);
gboolean            vte_terminal_get_audible_bell       (VteTerminal *terminal);
void                vte_terminal_set_visible_bell       (VteTerminal *terminal,
                                                         gboolean is_visible);
gboolean            vte_terminal_get_visible_bell       (VteTerminal *terminal);
void                vte_terminal_set_allow_bold         (VteTerminal *terminal,
                                                         gboolean allow_bold);
gboolean            vte_terminal_get_allow_bold         (VteTerminal *terminal);
void                vte_terminal_set_scroll_on_output   (VteTerminal *terminal,
                                                         gboolean scroll);
void                vte_terminal_set_scroll_on_keystroke
                                                        (VteTerminal *terminal,
                                                         gboolean scroll);
void                vte_terminal_set_rewrap_on_resize   (VteTerminal *terminal,
                                                         gboolean rewrap);
gboolean            vte_terminal_get_rewrap_on_resize   (VteTerminal *terminal);
void                vte_terminal_set_color_bold         (VteTerminal *terminal,
                                                         const GdkRGBA *bold);
void                vte_terminal_set_color_foreground   (VteTerminal *terminal,
                                                         const GdkRGBA *foreground);
void                vte_terminal_set_color_background   (VteTerminal *terminal,
                                                         const GdkRGBA *background);
void                vte_terminal_set_color_dim          (VteTerminal *terminal,
                                                         const GdkRGBA *dim);
void                vte_terminal_set_color_cursor       (VteTerminal *terminal,
                                                         const GdkRGBA *cursor_background);
void                vte_terminal_set_color_highlight    (VteTerminal *terminal,
                                                         const GdkRGBA *highlight_background);
void                vte_terminal_set_color_highlight_foreground
                                                        (VteTerminal *terminal,
                                                         const GdkRGBA *highlight_foreground);
void                vte_terminal_set_colors             (VteTerminal *terminal,
                                                         const GdkRGBA *foreground,
                                                         const GdkRGBA *background,
                                                         const GdkRGBA *palette,
                                                         gsize palette_size);
void                vte_terminal_set_default_colors     (VteTerminal *terminal);
void                vte_terminal_set_cursor_shape       (VteTerminal *terminal,
                                                         VteCursorShape shape);
VteCursorShape      vte_terminal_get_cursor_shape       (VteTerminal *terminal);
VteCursorBlinkMode  vte_terminal_get_cursor_blink_mode  (VteTerminal *terminal);
void                vte_terminal_set_cursor_blink_mode  (VteTerminal *terminal,
                                                         VteCursorBlinkMode mode);
void                vte_terminal_set_scrollback_lines   (VteTerminal *terminal,
                                                         glong lines);
void                vte_terminal_set_font               (VteTerminal *terminal,
                                                         const PangoFontDescription *font_desc);
const PangoFontDescription * vte_terminal_get_font      (VteTerminal *terminal);
gboolean            vte_terminal_get_has_selection      (VteTerminal *terminal);
void                vte_terminal_set_backspace_binding  (VteTerminal *terminal,
                                                         VteEraseBinding binding);
void                vte_terminal_set_delete_binding     (VteTerminal *terminal,
                                                         VteEraseBinding binding);
void                vte_terminal_set_mouse_autohide     (VteTerminal *terminal,
                                                         gboolean setting);
gboolean            vte_terminal_get_mouse_autohide     (VteTerminal *terminal);
void                vte_terminal_reset                  (VteTerminal *terminal,
                                                         gboolean clear_tabstops,
                                                         gboolean clear_history);
char *              vte_terminal_get_text               (VteTerminal *terminal,
                                                         VteSelectionFunc is_selected,
                                                         gpointer user_data,
                                                         GArray *attributes);
char *              vte_terminal_get_text_include_trailing_spaces
                                                        (VteTerminal *terminal,
                                                         VteSelectionFunc is_selected,
                                                         gpointer user_data,
                                                         GArray *attributes);
char *              vte_terminal_get_text_range         (VteTerminal *terminal,
                                                         glong start_row,
                                                         glong start_col,
                                                         glong end_row,
                                                         glong end_col,
                                                         VteSelectionFunc is_selected,
                                                         gpointer user_data,
                                                         GArray *attributes);
void                vte_terminal_get_cursor_position    (VteTerminal *terminal,
                                                         glong *column,
                                                         glong *row);
int                 vte_terminal_match_add_gregex       (VteTerminal *terminal,
                                                         GRegex *regex,
                                                         GRegexMatchFlags flags);
void                vte_terminal_match_remove           (VteTerminal *terminal,
                                                         int tag);
void                vte_terminal_match_remove_all       (VteTerminal *terminal);
char *              vte_terminal_match_check            (VteTerminal *terminal,
                                                         glong column,
                                                         glong row,
                                                         int *tag);
char *              vte_terminal_match_check_event      (VteTerminal *terminal,
                                                         GdkEvent *event,
                                                         int *tag);
void                vte_terminal_match_set_cursor       (VteTerminal *terminal,
                                                         int tag,
                                                         GdkCursor *cursor);
void                vte_terminal_match_set_cursor_type  (VteTerminal *terminal,
                                                         int tag,
                                                         GdkCursorType cursor_type);
void                vte_terminal_match_set_cursor_name  (VteTerminal *terminal,
                                                         int tag,
                                                         const char *cursor_name);
void                vte_terminal_set_cjk_ambiguous_width
                                                        (VteTerminal *terminal,
                                                         int width);
int                 vte_terminal_get_cjk_ambiguous_width
                                                        (VteTerminal *terminal);
void                vte_terminal_set_emulation          (VteTerminal *terminal,
                                                         const char *emulation);
const char *        vte_terminal_get_emulation          (VteTerminal *terminal);
void                vte_terminal_set_encoding           (VteTerminal *terminal,
                                                         const char *codeset);
const char *        vte_terminal_get_encoding           (VteTerminal *terminal);
const char *        vte_terminal_get_status_line        (VteTerminal *terminal);
gboolean            vte_terminal_write_contents         (VteTerminal *terminal,
                                                         GOutputStream *stream,
                                                         VteWriteFlags flags,
                                                         GCancellable *cancellable,
                                                         GError **error);
gboolean            vte_terminal_search_find_next       (VteTerminal *terminal);
gboolean            vte_terminal_search_find_previous   (VteTerminal *terminal);
GRegex *            vte_terminal_search_get_gregex      (VteTerminal *terminal);
gboolean            vte_terminal_search_get_wrap_around (VteTerminal *terminal);
void                vte_terminal_search_set_gregex      (VteTerminal *terminal,
                                                         GRegex *regex,
                                                         GRegexMatchFlags flags);
void                vte_terminal_search_set_wrap_around (VteTerminal *terminal,
                                                         gboolean wrap_around);

const char *        vte_get_default_emulation           (void);
char *              vte_get_user_shell                  (void);

gboolean            vte_terminal_spawn_sync             (VteTerminal *terminal,
                                                         VtePtyFlags pty_flags,
                                                         const char *working_directory,
                                                         char **argv,
                                                         char **envv,
                                                         GSpawnFlags spawn_flags,
                                                         GSpawnChildSetupFunc child_setup,
                                                         gpointer child_setup_data,
                                                         GPid *child_pid,
                                                         GCancellable *cancellable,
                                                         GError **error);
VtePty *            vte_terminal_get_pty                (VteTerminal *terminal);
void                vte_terminal_set_pty                (VteTerminal *terminal,
                                                         VtePty *pty);
VtePty *            vte_terminal_pty_new_sync           (VteTerminal *terminal,
                                                         VtePtyFlags flags,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                vte_terminal_watch_child            (VteTerminal *terminal,
                                                         GPid child_pid);

void                vte_terminal_get_geometry_hints     (VteTerminal *terminal,
                                                         GdkGeometry *hints,
                                                         int min_rows,
                                                         int min_columns);
void                vte_terminal_set_geometry_hints_for_window
                                                        (VteTerminal *terminal,
                                                         GtkWindow *window);


glong               vte_terminal_get_char_height        (VteTerminal *terminal);
glong               vte_terminal_get_char_width         (VteTerminal *terminal);
glong               vte_terminal_get_column_count       (VteTerminal *terminal);
const char *        vte_terminal_get_icon_title         (VteTerminal *terminal);
glong               vte_terminal_get_row_count          (VteTerminal *terminal);
const char *        vte_terminal_get_window_title       (VteTerminal *terminal);
const char *        vte_terminal_get_current_directory_uri
                                                        (VteTerminal *terminal);
const char *        vte_terminal_get_current_file_uri   (VteTerminal *terminal);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----VteTerminal
  GEnum
   +----VteCursorBlinkMode
  GEnum
   +----VteCursorShape
  GEnum
   +----VteEraseBinding
  GEnum
   +----VteWriteFlags

Implemented Interfaces

VteTerminal implements AtkImplementorIface, GtkBuildable and GtkScrollable.

Properties

  "allow-bold"               gboolean              : Read / Write
  "audible-bell"             gboolean              : Read / Write
  "backspace-binding"        VteEraseBinding       : Read / Write
  "cjk-ambiguous-width"      gint                  : Read / Write
  "current-directory-uri"    gchar*                : Read
  "current-file-uri"         gchar*                : Read
  "cursor-blink-mode"        VteCursorBlinkMode    : Read / Write
  "cursor-shape"             VteCursorShape        : Read / Write
  "delete-binding"           VteEraseBinding       : Read / Write
  "emulation"                gchar*                : Read / Write
  "encoding"                 gchar*                : Read / Write
  "font-desc"                PangoFontDescription*  : Read / Write
  "font-scale"               gdouble               : Read / Write
  "icon-title"               gchar*                : Read
  "input-enabled"            gboolean              : Read / Write
  "pointer-autohide"         gboolean              : Read / Write
  "pty"                      VtePty*               : Read / Write
  "rewrap-on-resize"         gboolean              : Read / Write
  "scroll-on-keystroke"      gboolean              : Read / Write
  "scroll-on-output"         gboolean              : Read / Write
  "scrollback-lines"         guint                 : Read / Write
  "visible-bell"             gboolean              : Read / Write
  "window-title"             gchar*                : Read

Signals

  "beep"                                           : Run Last
  "char-size-changed"                              : Run Last
  "child-exited"                                   : Run Last
  "commit"                                         : Run Last
  "contents-changed"                               : Run Last
  "copy-clipboard"                                 : Action
  "current-directory-uri-changed"                  : Run Last
  "current-file-uri-changed"                       : Run Last
  "cursor-moved"                                   : Run Last
  "decrease-font-size"                             : Run Last
  "deiconify-window"                               : Run Last
  "emulation-changed"                              : Run Last
  "encoding-changed"                               : Run Last
  "eof"                                            : Run Last
  "icon-title-changed"                             : Run Last
  "iconify-window"                                 : Run Last
  "increase-font-size"                             : Run Last
  "lower-window"                                   : Run Last
  "maximize-window"                                : Run Last
  "move-window"                                    : Run Last
  "paste-clipboard"                                : Action
  "raise-window"                                   : Run Last
  "refresh-window"                                 : Run Last
  "resize-window"                                  : Run Last
  "restore-window"                                 : Run Last
  "selection-changed"                              : Run Last
  "status-line-changed"                            : Run Last
  "text-deleted"                                   : Run Last
  "text-inserted"                                  : Run Last
  "text-modified"                                  : Run Last
  "text-scrolled"                                  : Run Last
  "window-title-changed"                           : Run Last

Description

A VteTerminal is a terminal emulator implemented as a GTK3 widget.

Details

struct VteTerminal

struct VteTerminal;

enum VteCursorBlinkMode

typedef enum {
        VTE_CURSOR_BLINK_SYSTEM,
        VTE_CURSOR_BLINK_ON,
        VTE_CURSOR_BLINK_OFF
} VteCursorBlinkMode;

An enumerated type which can be used to indicate the cursor blink mode for the terminal.

VTE_CURSOR_BLINK_SYSTEM

Follow GTK+ settings for cursor blinking.

VTE_CURSOR_BLINK_ON

Cursor blinks.

VTE_CURSOR_BLINK_OFF

Cursor does not blink.

enum VteCursorShape

typedef enum {
        VTE_CURSOR_SHAPE_BLOCK,
        VTE_CURSOR_SHAPE_IBEAM,
        VTE_CURSOR_SHAPE_UNDERLINE
} VteCursorShape;

An enumerated type which can be used to indicate what should the terminal draw at the cursor position.

VTE_CURSOR_SHAPE_BLOCK

Draw a block cursor. This is the default.

VTE_CURSOR_SHAPE_IBEAM

Draw a vertical bar on the left side of character. This is similar to the default cursor for other GTK+ widgets.

VTE_CURSOR_SHAPE_UNDERLINE

Draw a horizontal bar below the character.

enum VteEraseBinding

typedef enum {
	VTE_ERASE_AUTO,
	VTE_ERASE_ASCII_BACKSPACE,
	VTE_ERASE_ASCII_DELETE,
	VTE_ERASE_DELETE_SEQUENCE,
	VTE_ERASE_TTY
} VteEraseBinding;

An enumerated type which can be used to indicate which string the terminal should send to an application when the user presses the Delete or Backspace keys.

VTE_ERASE_AUTO

For backspace, attempt to determine the right value from the terminal's IO settings. For delete, use the control sequence.

VTE_ERASE_ASCII_BACKSPACE

Send an ASCII backspace character (0x08).

VTE_ERASE_ASCII_DELETE

Send an ASCII delete character (0x7F).

VTE_ERASE_DELETE_SEQUENCE

Send the "@7" control sequence.

VTE_ERASE_TTY

Send terminal's "erase" setting.

enum VteWriteFlags

typedef enum {
  VTE_WRITE_DEFAULT = 0
} VteWriteFlags;

A flag type to determine how terminal contents should be written to an output stream.

VTE_WRITE_DEFAULT

Write contents as UTF-8 text. This is the default.

VteSelectionFunc ()

gboolean            (*VteSelectionFunc)                 (VteTerminal *terminal,
                                                         glong column,
                                                         glong row,
                                                         gpointer data);

Specifies the type of a selection function used to check whether a cell has to be selected or not.

terminal :

terminal in which the cell is.

column :

column in which the cell is.

row :

row in which the cell is.

data :

user data. [closure]

Returns :

TRUE if cell has to be selected; FALSE if otherwise.

vte_terminal_new ()

GtkWidget *         vte_terminal_new                    (void);

Creates a new terminal widget.

Returns :

a new VteTerminal object. [transfer none][type Vte.Terminal]

vte_terminal_feed ()

void                vte_terminal_feed                   (VteTerminal *terminal,
                                                         const char *data,
                                                         gssize length);

Interprets data as if it were data received from a child process. This can either be used to drive the terminal without a child process, or just to mess with your users.

terminal :

a VteTerminal

data :

a string in the terminal's current encoding. [array length=length][element-type guint8]

length :

the length of the string, or -1 to use the full length or a nul-terminated string

vte_terminal_feed_child ()

void                vte_terminal_feed_child             (VteTerminal *terminal,
                                                         const char *text,
                                                         gssize length);

Sends a block of UTF-8 text to the child as if it were entered by the user at the keyboard.

terminal :

a VteTerminal

text :

data to send to the child

length :

length of text in bytes, or -1 if text is NUL-terminated

vte_terminal_feed_child_binary ()

void                vte_terminal_feed_child_binary      (VteTerminal *terminal,
                                                         const guint8 *data,
                                                         gsize length);

Sends a block of binary data to the child.

terminal :

a VteTerminal

data :

data to send to the child

length :

length of data

Since 0.12.1


vte_terminal_select_all ()

void                vte_terminal_select_all             (VteTerminal *terminal);

Selects all text within the terminal (including the scrollback buffer).

terminal :

a VteTerminal

Since 0.16


vte_terminal_unselect_all ()

void                vte_terminal_unselect_all           (VteTerminal *terminal);

Clears the current selection.

terminal :

a VteTerminal

vte_terminal_copy_clipboard ()

void                vte_terminal_copy_clipboard         (VteTerminal *terminal);

Places the selected text in the terminal in the GDK_SELECTION_CLIPBOARD selection.

terminal :

a VteTerminal

vte_terminal_paste_clipboard ()

void                vte_terminal_paste_clipboard        (VteTerminal *terminal);

Sends the contents of the GDK_SELECTION_CLIPBOARD selection to the terminal's child. If necessary, the data is converted from UTF-8 to the terminal's current encoding. It's called on paste menu item, or when user presses Shift+Insert.

terminal :

a VteTerminal

vte_terminal_copy_primary ()

void                vte_terminal_copy_primary           (VteTerminal *terminal);

Places the selected text in the terminal in the GDK_SELECTION_PRIMARY selection.

terminal :

a VteTerminal

vte_terminal_paste_primary ()

void                vte_terminal_paste_primary          (VteTerminal *terminal);

Sends the contents of the GDK_SELECTION_PRIMARY selection to the terminal's child. If necessary, the data is converted from UTF-8 to the terminal's current encoding. The terminal will call also paste the GDK_SELECTION_PRIMARY selection when the user clicks with the the second mouse button.

terminal :

a VteTerminal

vte_terminal_set_size ()

void                vte_terminal_set_size               (VteTerminal *terminal,
                                                         glong columns,
                                                         glong rows);

Attempts to change the terminal's size in terms of rows and columns. If the attempt succeeds, the widget will resize itself to the proper size.

terminal :

a VteTerminal

columns :

the desired number of columns

rows :

the desired number of rows

vte_terminal_set_font_scale ()

void                vte_terminal_set_font_scale         (VteTerminal *terminal,
                                                         gdouble scale);

Sets the terminal's font scale to scale.

terminal :

a VteTerminal

scale :

the font scale

Since 0.30


vte_terminal_get_font_scale ()

gdouble             vte_terminal_get_font_scale         (VteTerminal *terminal);

terminal :

a VteTerminal

Returns :

the terminal's font scale

Since 0.30


vte_terminal_set_audible_bell ()

void                vte_terminal_set_audible_bell       (VteTerminal *terminal,
                                                         gboolean is_audible);

Controls whether or not the terminal will beep when the child outputs the "bl" sequence.

terminal :

a VteTerminal

is_audible :

TRUE if the terminal should beep

vte_terminal_get_audible_bell ()

gboolean            vte_terminal_get_audible_bell       (VteTerminal *terminal);

Checks whether or not the terminal will beep when the child outputs the "bl" sequence.

terminal :

a VteTerminal

Returns :

TRUE if audible bell is enabled, FALSE if not

vte_terminal_set_visible_bell ()

void                vte_terminal_set_visible_bell       (VteTerminal *terminal,
                                                         gboolean is_visible);

Controls whether or not the terminal will present a visible bell to the user when the child outputs the "bl" sequence. The terminal will clear itself to the default foreground color and then repaint itself.

terminal :

a VteTerminal

is_visible :

whether the terminal should flash on bell

vte_terminal_get_visible_bell ()

gboolean            vte_terminal_get_visible_bell       (VteTerminal *terminal);

Checks whether or not the terminal will present a visible bell to the user when the child outputs the "bl" sequence. The terminal will clear itself to the default foreground color and then repaint itself.

terminal :

a VteTerminal

Returns :

TRUE if visible bell is enabled, FALSE if not

vte_terminal_set_allow_bold ()

void                vte_terminal_set_allow_bold         (VteTerminal *terminal,
                                                         gboolean allow_bold);

Controls whether or not the terminal will attempt to draw bold text, either by using a bold font variant or by repainting text with a different offset.

terminal :

a VteTerminal

allow_bold :

TRUE if the terminal should attempt to draw bold text

vte_terminal_get_allow_bold ()

gboolean            vte_terminal_get_allow_bold         (VteTerminal *terminal);

Checks whether or not the terminal will attempt to draw bold text by repainting text with a one-pixel offset.

terminal :

a VteTerminal

Returns :

TRUE if bolding is enabled, FALSE if not

vte_terminal_set_scroll_on_output ()

void                vte_terminal_set_scroll_on_output   (VteTerminal *terminal,
                                                         gboolean scroll);

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child.

terminal :

a VteTerminal

scroll :

whether the terminal should scroll on output

vte_terminal_set_scroll_on_keystroke ()

void                vte_terminal_set_scroll_on_keystroke
                                                        (VteTerminal *terminal,
                                                         gboolean scroll);

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key. Modifier keys do not trigger this behavior.

terminal :

a VteTerminal

scroll :

whether the terminal should scroll on keystrokes

vte_terminal_set_rewrap_on_resize ()

void                vte_terminal_set_rewrap_on_resize   (VteTerminal *terminal,
                                                         gboolean rewrap);

Controls whether or not the terminal will rewrap its contents, including the scrollback history, whenever the terminal's width changes.

terminal :

a VteTerminal

rewrap :

TRUE if the terminal should rewrap on resize

Since 0.36


vte_terminal_get_rewrap_on_resize ()

gboolean            vte_terminal_get_rewrap_on_resize   (VteTerminal *terminal);

Checks whether or not the terminal will rewrap its contents upon resize.

terminal :

a VteTerminal

Returns :

TRUE if rewrapping is enabled, FALSE if not

Since 0.36


vte_terminal_set_color_bold ()

void                vte_terminal_set_color_bold         (VteTerminal *terminal,
                                                         const GdkRGBA *bold);

Sets the color used to draw bold text in the default foreground color. If bold is NULL then the default color is used.

terminal :

a VteTerminal

bold :

the new bold color or NULL. [allow-none]

vte_terminal_set_color_foreground ()

void                vte_terminal_set_color_foreground   (VteTerminal *terminal,
                                                         const GdkRGBA *foreground);

Sets the foreground color used to draw normal text.

terminal :

a VteTerminal

foreground :

the new foreground color

vte_terminal_set_color_background ()

void                vte_terminal_set_color_background   (VteTerminal *terminal,
                                                         const GdkRGBA *background);

Sets the background color for text which does not have a specific background color assigned. Only has effect when no background image is set and when the terminal is not transparent.

terminal :

a VteTerminal

background :

the new background color

vte_terminal_set_color_dim ()

void                vte_terminal_set_color_dim          (VteTerminal *terminal,
                                                         const GdkRGBA *dim);

Sets the color used to draw dim text in the default foreground color. If dim is NULL then the default color is used.

terminal :

a VteTerminal

dim :

the new dim color or NULL. [allow-none]

vte_terminal_set_color_cursor ()

void                vte_terminal_set_color_cursor       (VteTerminal *terminal,
                                                         const GdkRGBA *cursor_background);

Sets the background color for text which is under the cursor. If NULL, text under the cursor will be drawn with foreground and background colors reversed.

terminal :

a VteTerminal

cursor_background :

the new color to use for the text cursor, or NULL. [allow-none]

vte_terminal_set_color_highlight ()

void                vte_terminal_set_color_highlight    (VteTerminal *terminal,
                                                         const GdkRGBA *highlight_background);

Sets the background color for text which is highlighted. If NULL, it is unset. If neither highlight background nor highlight foreground are set, highlighted text (which is usually highlighted because it is selected) will be drawn with foreground and background colors reversed.

terminal :

a VteTerminal

highlight_background :

the new color to use for highlighted text, or NULL. [allow-none]

vte_terminal_set_color_highlight_foreground ()

void                vte_terminal_set_color_highlight_foreground
                                                        (VteTerminal *terminal,
                                                         const GdkRGBA *highlight_foreground);

Sets the foreground color for text which is highlighted. If NULL, it is unset. If neither highlight background nor highlight foreground are set, highlighted text (which is usually highlighted because it is selected) will be drawn with foreground and background colors reversed.

terminal :

a VteTerminal

highlight_foreground :

the new color to use for highlighted text, or NULL. [allow-none]

vte_terminal_set_colors ()

void                vte_terminal_set_colors             (VteTerminal *terminal,
                                                         const GdkRGBA *foreground,
                                                         const GdkRGBA *background,
                                                         const GdkRGBA *palette,
                                                         gsize palette_size);

The terminal widget uses a 28-color model comprised of the default foreground and background colors, the bold foreground color, the dim foreground color, an eight color palette, bold versions of the eight color palette, and a dim version of the the eight color palette.

palette_size must be either 0, 8, 16, or 24, or between 25 and 256 inclusive. If foreground is NULL and palette_size is greater than 0, the new foreground color is taken from palette[7]. If background is NULL and palette_size is greater than 0, the new background color is taken from palette[0]. If palette_size is 8 or 16, the third (dim) and possibly the second (bold) 8-color palettes are extrapolated from the new background color and the items in palette.

terminal :

a VteTerminal

foreground :

the new foreground color, or NULL. [allow-none]

background :

the new background color, or NULL. [allow-none]

palette :

the color palette. [array length=palette_size zero-terminated=0][element-type Gdk.RGBA][allow-none]

palette_size :

the number of entries in palette

vte_terminal_set_default_colors ()

void                vte_terminal_set_default_colors     (VteTerminal *terminal);

Reset the terminal palette to reasonable compiled-in default color.

terminal :

a VteTerminal

vte_terminal_set_cursor_shape ()

void                vte_terminal_set_cursor_shape       (VteTerminal *terminal,
                                                         VteCursorShape shape);

Sets the shape of the cursor drawn.

terminal :

a VteTerminal

shape :

the VteCursorShape to use

Since 0.20


vte_terminal_get_cursor_shape ()

VteCursorShape      vte_terminal_get_cursor_shape       (VteTerminal *terminal);

Returns the currently set cursor shape.

terminal :

a VteTerminal

Returns :

cursor shape.

Since 0.17.6


vte_terminal_get_cursor_blink_mode ()

VteCursorBlinkMode  vte_terminal_get_cursor_blink_mode  (VteTerminal *terminal);

Returns the currently set cursor blink mode.

terminal :

a VteTerminal

Returns :

cursor blink mode.

Since 0.17.1


vte_terminal_set_cursor_blink_mode ()

void                vte_terminal_set_cursor_blink_mode  (VteTerminal *terminal,
                                                         VteCursorBlinkMode mode);

Sets whether or not the cursor will blink. Using VTE_CURSOR_BLINK_SYSTEM will use the "gtk-cursor-blink" setting.

terminal :

a VteTerminal

mode :

the VteCursorBlinkMode to use

Since 0.17.1


vte_terminal_set_scrollback_lines ()

void                vte_terminal_set_scrollback_lines   (VteTerminal *terminal,
                                                         glong lines);

Sets the length of the scrollback buffer used by the terminal. The size of the scrollback buffer will be set to the larger of this value and the number of visible rows the widget can display, so 0 can safely be used to disable scrollback.

A negative value means "infinite scrollback".

Note that this setting only affects the normal screen buffer. For terminal types which have an alternate screen buffer, no scrollback is allowed on the alternate screen buffer.

terminal :

a VteTerminal

lines :

the length of the history buffer

vte_terminal_set_font ()

void                vte_terminal_set_font               (VteTerminal *terminal,
                                                         const PangoFontDescription *font_desc);

vte_terminal_get_font ()

const PangoFontDescription * vte_terminal_get_font      (VteTerminal *terminal);

Queries the terminal for information about the fonts which will be used to draw text in the terminal.

terminal :

a VteTerminal

Returns :

a PangoFontDescription describing the font the terminal is currently using to render text. [transfer none]

vte_terminal_get_has_selection ()

gboolean            vte_terminal_get_has_selection      (VteTerminal *terminal);

Checks if the terminal currently contains selected text. Note that this is different from determining if the terminal is the owner of any GtkClipboard items.

terminal :

a VteTerminal

Returns :

TRUE if part of the text in the terminal is selected.

vte_terminal_set_backspace_binding ()

void                vte_terminal_set_backspace_binding  (VteTerminal *terminal,
                                                         VteEraseBinding binding);

Modifies the terminal's backspace key binding, which controls what string or control sequence the terminal sends to its child when the user presses the backspace key.

terminal :

a VteTerminal

binding :

a VteEraseBinding for the backspace key

vte_terminal_set_delete_binding ()

void                vte_terminal_set_delete_binding     (VteTerminal *terminal,
                                                         VteEraseBinding binding);

Modifies the terminal's delete key binding, which controls what string or control sequence the terminal sends to its child when the user presses the delete key.

terminal :

a VteTerminal

binding :

a VteEraseBinding for the delete key

vte_terminal_set_mouse_autohide ()

void                vte_terminal_set_mouse_autohide     (VteTerminal *terminal,
                                                         gboolean setting);

Changes the value of the terminal's mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse. This setting can be read using vte_terminal_get_mouse_autohide().

terminal :

a VteTerminal

setting :

whether the mouse pointer should autohide

vte_terminal_get_mouse_autohide ()

gboolean            vte_terminal_get_mouse_autohide     (VteTerminal *terminal);

Determines the value of the terminal's mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse. This setting can be changed using vte_terminal_set_mouse_autohide().

terminal :

a VteTerminal

Returns :

TRUE if autohiding is enabled, FALSE if not

vte_terminal_reset ()

void                vte_terminal_reset                  (VteTerminal *terminal,
                                                         gboolean clear_tabstops,
                                                         gboolean clear_history);

Resets as much of the terminal's internal state as possible, discarding any unprocessed input data, resetting character attributes, cursor state, national character set state, status line, terminal modes (insert/delete), selection state, and encoding.

terminal :

a VteTerminal

clear_tabstops :

whether to reset tabstops

clear_history :

whether to empty the terminal's scrollback buffer

vte_terminal_get_text ()

char *              vte_terminal_get_text               (VteTerminal *terminal,
                                                         VteSelectionFunc is_selected,
                                                         gpointer user_data,
                                                         GArray *attributes);

Extracts a view of the visible part of the terminal. If is_selected is not NULL, characters will only be read if is_selected returns TRUE after being passed the column and row, respectively. A VteCharAttributes structure is added to attributes for each byte added to the returned string detailing the character's position, colors, and other characteristics.

terminal :

a VteTerminal

is_selected :

a VteSelectionFunc callback. [scope call][allow-none]

user_data :

user data to be passed to the callback. [closure]

attributes :

location for storing text attributes. [out caller-allocates][transfer full][array][element-type Vte.CharAttributes]

Returns :

a newly allocated text string, or NULL. [transfer full]

vte_terminal_get_text_include_trailing_spaces ()

char *              vte_terminal_get_text_include_trailing_spaces
                                                        (VteTerminal *terminal,
                                                         VteSelectionFunc is_selected,
                                                         gpointer user_data,
                                                         GArray *attributes);

Extracts a view of the visible part of the terminal. If is_selected is not NULL, characters will only be read if is_selected returns TRUE after being passed the column and row, respectively. A VteCharAttributes structure is added to attributes for each byte added to the returned string detailing the character's position, colors, and other characteristics. This function differs from vte_terminal_get_text() in that trailing spaces at the end of lines are included.

terminal :

a VteTerminal

is_selected :

a VteSelectionFunc callback. [scope call][allow-none]

user_data :

user data to be passed to the callback. [closure]

attributes :

location for storing text attributes. [out caller-allocates][transfer full][array][element-type Vte.CharAttributes]

Returns :

a newly allocated text string, or NULL. [transfer full]

Since 0.11.11


vte_terminal_get_text_range ()

char *              vte_terminal_get_text_range         (VteTerminal *terminal,
                                                         glong start_row,
                                                         glong start_col,
                                                         glong end_row,
                                                         glong end_col,
                                                         VteSelectionFunc is_selected,
                                                         gpointer user_data,
                                                         GArray *attributes);

Extracts a view of the visible part of the terminal. If is_selected is not NULL, characters will only be read if is_selected returns TRUE after being passed the column and row, respectively. A VteCharAttributes structure is added to attributes for each byte added to the returned string detailing the character's position, colors, and other characteristics. The entire scrollback buffer is scanned, so it is possible to read the entire contents of the buffer using this function.

terminal :

a VteTerminal

start_row :

first row to search for data

start_col :

first column to search for data

end_row :

last row to search for data

end_col :

last column to search for data

is_selected :

a VteSelectionFunc callback. [scope call][allow-none]

user_data :

user data to be passed to the callback. [closure]

attributes :

location for storing text attributes. [out caller-allocates][transfer full][array][element-type Vte.CharAttributes]

Returns :

a newly allocated text string, or NULL. [transfer full]

vte_terminal_get_cursor_position ()

void                vte_terminal_get_cursor_position    (VteTerminal *terminal,
                                                         glong *column,
                                                         glong *row);

Reads the location of the insertion cursor and returns it. The row coordinate is absolute.

terminal :

a VteTerminal

column :

a location to store the column, or NULL. [out][allow-none]

row :

a location to store the row, or NULL. [out][allow-none]

vte_terminal_match_add_gregex ()

int                 vte_terminal_match_add_gregex       (VteTerminal *terminal,
                                                         GRegex *regex,
                                                         GRegexMatchFlags flags);

Adds the regular expression regex to the list of matching expressions. When the user moves the mouse cursor over a section of displayed text which matches this expression, the text will be highlighted.

terminal :

a VteTerminal

regex :

a GRegex

flags :

the GRegexMatchFlags to use when matching the regex

Returns :

an integer associated with this expression

Since 0.17.1


vte_terminal_match_remove ()

void                vte_terminal_match_remove           (VteTerminal *terminal,
                                                         int tag);

Removes the regular expression which is associated with the given tag from the list of expressions which the terminal will highlight when the user moves the mouse cursor over matching text.

terminal :

a VteTerminal

tag :

the tag of the regex to remove

vte_terminal_match_remove_all ()

void                vte_terminal_match_remove_all       (VteTerminal *terminal);

Clears the list of regular expressions the terminal uses to highlight text when the user moves the mouse cursor.

terminal :

a VteTerminal

Since 0.30


vte_terminal_match_check ()

char *              vte_terminal_match_check            (VteTerminal *terminal,
                                                         glong column,
                                                         glong row,
                                                         int *tag);

Checks if the text in and around the specified position matches any of the regular expressions previously set using vte_terminal_match_add(). If a match exists, the text string is returned and if tag is not NULL, the number associated with the matched regular expression will be stored in tag.

If more than one regular expression has been set with vte_terminal_match_add(), then expressions are checked in the order in which they were added.

terminal :

a VteTerminal

column :

the text column

row :

the text row

tag :

a location to store the tag, or NULL. [out][allow-none]

Returns :

a newly allocated string which matches one of the previously set regular expressions. [transfer full]

vte_terminal_match_check_event ()

char *              vte_terminal_match_check_event      (VteTerminal *terminal,
                                                         GdkEvent *event,
                                                         int *tag);

Checks if the text in and around the position of the event matches any of the regular expressions previously set using vte_terminal_match_add(). If a match exists, the text string is returned and if tag is not NULL, the number associated with the matched regular expression will be stored in tag.

If more than one regular expression has been set with vte_terminal_match_add(), then expressions are checked in the order in which they were added.

terminal :

a VteTerminal

event :

a GdkEvent

tag :

a location to store the tag, or NULL. [out][allow-none]

Returns :

a newly allocated string which matches one of the previously set regular expressions. [transfer full]

vte_terminal_match_set_cursor ()

void                vte_terminal_match_set_cursor       (VteTerminal *terminal,
                                                         int tag,
                                                         GdkCursor *cursor);

Sets which cursor the terminal will use if the pointer is over the pattern specified by tag. The terminal keeps a reference to cursor.

terminal :

a VteTerminal

tag :

the tag of the regex which should use the specified cursor

cursor :

the GdkCursor which the terminal should use when the pattern is highlighted, or NULL to use the standard cursor. [allow-none]

Since 0.11


vte_terminal_match_set_cursor_type ()

void                vte_terminal_match_set_cursor_type  (VteTerminal *terminal,
                                                         int tag,
                                                         GdkCursorType cursor_type);

Sets which cursor the terminal will use if the pointer is over the pattern specified by tag.

terminal :

a VteTerminal

tag :

the tag of the regex which should use the specified cursor

cursor_type :

a GdkCursorType

Since 0.11.9


vte_terminal_match_set_cursor_name ()

void                vte_terminal_match_set_cursor_name  (VteTerminal *terminal,
                                                         int tag,
                                                         const char *cursor_name);

Sets which cursor the terminal will use if the pointer is over the pattern specified by tag.

terminal :

a VteTerminal

tag :

the tag of the regex which should use the specified cursor

cursor_name :

the name of the cursor

Since 0.17.1


vte_terminal_set_cjk_ambiguous_width ()

void                vte_terminal_set_cjk_ambiguous_width
                                                        (VteTerminal *terminal,
                                                         int width);

This setting controls whether ambiguous-width characters are narrow or wide when using the UTF-8 encoding (vte_terminal_set_encoding()). In all other encodings, the width of ambiguous-width characters is fixed.

This setting only takes effect the next time the terminal is reset, either via escape sequence or with vte_terminal_reset().

terminal :

a VteTerminal

width :

either 1 (narrow) or 2 (wide)

Since 0.38


vte_terminal_get_cjk_ambiguous_width ()

int                 vte_terminal_get_cjk_ambiguous_width
                                                        (VteTerminal *terminal);

Returns whether ambiguous-width characters are narrow or wide when using the UTF-8 encoding (vte_terminal_set_encoding()).

terminal :

a VteTerminal

Returns :

1 if ambiguous-width characters are narrow, or 2 if they are wide

Since 0.38


vte_terminal_set_emulation ()

void                vte_terminal_set_emulation          (VteTerminal *terminal,
                                                         const char *emulation);

Sets what type of terminal the widget attempts to emulate by scanning for control sequences defined in the system's termcap file. Unless you are interested in this feature, always use "xterm".

terminal :

a VteTerminal

emulation :

the name of a terminal description, or NULL to use the default. [allow-none]

vte_terminal_get_emulation ()

const char *        vte_terminal_get_emulation          (VteTerminal *terminal);

Queries the terminal for its current emulation, as last set by a call to vte_terminal_set_emulation().

terminal :

a VteTerminal

Returns :

an interned string containing the name of the terminal type the widget is attempting to emulate

vte_terminal_set_encoding ()

void                vte_terminal_set_encoding           (VteTerminal *terminal,
                                                         const char *codeset);

Changes the encoding the terminal will expect data from the child to be encoded with. For certain terminal types, applications executing in the terminal can change the encoding. The default encoding is defined by the application's locale settings.

terminal :

a VteTerminal

codeset :

a valid GIConv target, or NULL to use the default encoding. [allow-none]

vte_terminal_get_encoding ()

const char *        vte_terminal_get_encoding           (VteTerminal *terminal);

Determines the name of the encoding in which the terminal expects data to be encoded.

terminal :

a VteTerminal

Returns :

the current encoding for the terminal. [transfer none]

vte_terminal_get_status_line ()

const char *        vte_terminal_get_status_line        (VteTerminal *terminal);

Some terminal emulations specify a status line which is separate from the main display area, and define a means for applications to move the cursor to the status line and back.

terminal :

a VteTerminal

Returns :

the current contents of the terminal's status line. For terminals like "xterm", this will usually be the empty string. The string must not be modified or freed by the caller. [transfer none]

vte_terminal_write_contents ()

gboolean            vte_terminal_write_contents         (VteTerminal *terminal,
                                                         GOutputStream *stream,
                                                         VteWriteFlags flags,
                                                         GCancellable *cancellable,
                                                         GError **error);

Write contents of the current contents of terminal (including any scrollback history) to stream according to flags.

If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned in error.

This is a synchronous operation and will make the widget (and input processing) during the write operation, which may take a long time depending on scrollback history and stream availability for writing.

terminal :

a VteTerminal

stream :

a GOutputStream to write to

flags :

a set of VteWriteFlags

cancellable :

a GCancellable object, or NULL. [allow-none]

error :

a GError location to store the error occuring, or NULL. [allow-none]

Returns :

TRUE on success, FALSE if there was an error

Since 0.24


vte_terminal_search_find_next ()

gboolean            vte_terminal_search_find_next       (VteTerminal *terminal);

Searches the next string matching the search regex set with vte_terminal_search_set_gregex().

terminal :

a VteTerminal

Returns :

TRUE if a match was found

Since 0.26


vte_terminal_search_find_previous ()

gboolean            vte_terminal_search_find_previous   (VteTerminal *terminal);

Searches the previous string matching the search regex set with vte_terminal_search_set_gregex().

terminal :

a VteTerminal

Returns :

TRUE if a match was found

Since 0.26


vte_terminal_search_get_gregex ()

GRegex *            vte_terminal_search_get_gregex      (VteTerminal *terminal);

terminal :

a VteTerminal

Returns :

the search GRegex regex set in terminal, or NULL. [transfer none]

Since 0.26


vte_terminal_search_get_wrap_around ()

gboolean            vte_terminal_search_get_wrap_around (VteTerminal *terminal);

terminal :

a VteTerminal

Returns :

whether searching will wrap around

Since 0.26


vte_terminal_search_set_gregex ()

void                vte_terminal_search_set_gregex      (VteTerminal *terminal,
                                                         GRegex *regex,
                                                         GRegexMatchFlags flags);

Sets the GRegex regex to search for. Unsets the search regex when passed NULL.

terminal :

a VteTerminal

regex :

a GRegex, or NULL. [allow-none]

flags :

flags from GRegexMatchFlags

Since 0.26


vte_terminal_search_set_wrap_around ()

void                vte_terminal_search_set_wrap_around (VteTerminal *terminal,
                                                         gboolean wrap_around);

Sets whether search should wrap around to the beginning of the terminal content when reaching its end.

terminal :

a VteTerminal

wrap_around :

whether search should wrap

Since 0.26


vte_get_default_emulation ()

const char *        vte_get_default_emulation           (void);

Returns the default emulation, which is used in VteTerminal if the terminal type passed to vte_terminal_set_emulation() is NULL.

Returns :

an interned string containing the name of the default terminal type the widget attempts to emulate. [transfer none][type utf8]

Since 0.30


vte_get_user_shell ()

char *              vte_get_user_shell                  (void);

Gets the user's shell, or NULL. In the latter case, the system default (usually "/bin/sh") should be used.

Returns :

a newly allocated string with the user's shell, or NULL. [transfer full][type filename]

Since 0.28


vte_terminal_spawn_sync ()

gboolean            vte_terminal_spawn_sync             (VteTerminal *terminal,
                                                         VtePtyFlags pty_flags,
                                                         const char *working_directory,
                                                         char **argv,
                                                         char **envv,
                                                         GSpawnFlags spawn_flags,
                                                         GSpawnChildSetupFunc child_setup,
                                                         gpointer child_setup_data,
                                                         GPid *child_pid,
                                                         GCancellable *cancellable,
                                                         GError **error);

Starts the specified command under a newly-allocated controlling pseudo-terminal. The argv and envv lists should be NULL-terminated. The "TERM" environment variable is automatically set to reflect the terminal widget's emulation setting. pty_flags controls logging the session to the specified system log files.

Note that G_SPAWN_DO_NOT_REAP_CHILD will always be added to spawn_flags.

Note that unless spawn_flags contains G_SPAWN_LEAVE_DESCRIPTORS_OPEN, all file descriptors except stdin/stdout/stderr will be closed before calling exec() in the child.

See vte_pty_new(), g_spawn_async() and vte_terminal_watch_child() for more information.

terminal :

a VteTerminal

pty_flags :

flags from VtePtyFlags

working_directory :

the name of a directory the command should start in, or NULL to use the current working directory. [allow-none]

argv :

child's argument vector. [array zero-terminated=1][element-type filename]

envv :

a list of environment variables to be added to the environment before starting the process, or NULL. [allow-none][array zero-terminated=1][element-type filename]

spawn_flags :

flags from GSpawnFlags

child_setup :

an extra child setup function to run in the child just before exec(), or NULL. [allow-none][scope call]

child_setup_data :

user data for child_setup

child_pid :

a location to store the child PID, or NULL. [out][allow-none][transfer full]

cancellable :

a GCancellable, or NULL. [allow-none]

error :

return location for a GError, or NULL. [allow-none]

Returns :

TRUE on success, or FALSE on error with error filled in

Since 0.30


vte_terminal_get_pty ()

VtePty *            vte_terminal_get_pty                (VteTerminal *terminal);

Returns the VtePty of terminal.

terminal :

a VteTerminal

Returns :

a VtePty, or NULL. [transfer none]

Since 0.26


vte_terminal_set_pty ()

void                vte_terminal_set_pty                (VteTerminal *terminal,
                                                         VtePty *pty);

Sets pty as the PTY to use in terminal. Use NULL to unset the PTY.

terminal :

a VteTerminal

pty :

a VtePty, or NULL. [allow-none]

Since 0.26.


vte_terminal_pty_new_sync ()

VtePty *            vte_terminal_pty_new_sync           (VteTerminal *terminal,
                                                         VtePtyFlags flags,
                                                         GCancellable *cancellable,
                                                         GError **error);

Creates a new VtePty, and sets the emulation property from "emulation".

See vte_pty_new() for more information.

terminal :

a VteTerminal

flags :

flags from VtePtyFlags

cancellable :

a GCancellable, or NULL. [allow-none]

error :

return location for a GError, or NULL. [allow-none]

Returns :

a new VtePty. [transfer full]

Since 0.30


vte_terminal_watch_child ()

void                vte_terminal_watch_child            (VteTerminal *terminal,
                                                         GPid child_pid);

Watches child_pid. When the process exists, the "child-exited" signal will be called with the child's exit status.

Prior to calling this function, a VtePty must have been set in terminal using vte_terminal_set_pty(). When the child exits, the terminal's VtePty will be set to NULL.

Note: g_child_watch_add() or g_child_watch_add_full() must not have been called for child_pid, nor a GSource for it been created with g_child_watch_source_new().

Note: when using the g_spawn_async() family of functions, the G_SPAWN_DO_NOT_REAP_CHILD flag MUST have been passed.

terminal :

a VteTerminal

child_pid :

a GPid

Since 0.26


vte_terminal_get_geometry_hints ()

void                vte_terminal_get_geometry_hints     (VteTerminal *terminal,
                                                         GdkGeometry *hints,
                                                         int min_rows,
                                                         int min_columns);

Fills in some hints from terminal's geometry. The hints filled are those covered by the GDK_HINT_RESIZE_INC, GDK_HINT_MIN_SIZE and GDK_HINT_BASE_SIZE flags.

See gtk_window_set_geometry_hints() for more information.

terminal must be realized (see gtk_widget_get_realized()).

terminal :

a VteTerminal

hints :

a GdkGeometry to fill in. [out caller-allocates]

min_rows :

the minimum number of rows to request

min_columns :

the minimum number of columns to request

vte_terminal_set_geometry_hints_for_window ()

void                vte_terminal_set_geometry_hints_for_window
                                                        (VteTerminal *terminal,
                                                         GtkWindow *window);

Sets terminal as window's geometry widget. See gtk_window_set_geometry_hints() for more information.

terminal must be realized (see gtk_widget_get_realized()).

terminal :

a VteTerminal

window :

a GtkWindow

vte_terminal_get_char_height ()

glong               vte_terminal_get_char_height        (VteTerminal *terminal);

terminal :

a VteTerminal

Returns :

the height of a character cell

vte_terminal_get_char_width ()

glong               vte_terminal_get_char_width         (VteTerminal *terminal);

terminal :

a VteTerminal

Returns :

the width of a character cell

vte_terminal_get_column_count ()

glong               vte_terminal_get_column_count       (VteTerminal *terminal);

terminal :

a VteTerminal

Returns :

the number of columns

vte_terminal_get_icon_title ()

const char *        vte_terminal_get_icon_title         (VteTerminal *terminal);

terminal :

a VteTerminal

Returns :

the icon title. [transfer none]

vte_terminal_get_row_count ()

glong               vte_terminal_get_row_count          (VteTerminal *terminal);

terminal :

a VteTerminal

Returns :

the number of rows

vte_terminal_get_window_title ()

const char *        vte_terminal_get_window_title       (VteTerminal *terminal);

terminal :

a VteTerminal

Returns :

the window title. [transfer none]

vte_terminal_get_current_directory_uri ()

const char *        vte_terminal_get_current_directory_uri
                                                        (VteTerminal *terminal);

terminal :

a VteTerminal

Returns :

the URI of the current directory of the process running in the terminal, or NULL. [transfer none]

Since 0.34


vte_terminal_get_current_file_uri ()

const char *        vte_terminal_get_current_file_uri   (VteTerminal *terminal);

terminal :

a VteTerminal

Returns :

the URI of the current file the process running in the terminal is operating on, or NULL if not set. [transfer none]

Since 0.34

Property Details

The "allow-bold" property

  "allow-bold"               gboolean              : Read / Write

Controls whether or not the terminal will attempt to draw bold text. This may happen either by using a bold font variant, or by repainting text with a different offset.

Default value: TRUE

Since 0.20


The "audible-bell" property

  "audible-bell"             gboolean              : Read / Write

Controls whether or not the terminal will beep when the child outputs the "bl" sequence.

Default value: TRUE

Since 0.20


The "backspace-binding" property

  "backspace-binding"        VteEraseBinding       : Read / Write

*Controls what string or control sequence the terminal sends to its child when the user presses the backspace key.

Default value: VTE_ERASE_AUTO

Since 0.20


The "cjk-ambiguous-width" property

  "cjk-ambiguous-width"      gint                  : Read / Write

This setting controls whether ambiguous-width characters are narrow or wide when using the UTF-8 encoding (vte_terminal_set_encoding()). In all other encodings, the width of ambiguous-width characters is fixed.

This setting only takes effect the next time the terminal is reset, either via escape sequence or with vte_terminal_reset().

Allowed values: [1,2]

Default value: 1

Since 0.38


The "current-directory-uri" property

  "current-directory-uri"    gchar*                : Read

The current directory URI, or NULL if unset.

Default value: NULL

Since 0.34


The "current-file-uri" property

  "current-file-uri"         gchar*                : Read

The current file URI, or NULL if unset.

Default value: NULL

Since 0.34


The "cursor-blink-mode" property

  "cursor-blink-mode"        VteCursorBlinkMode    : Read / Write

Sets whether or not the cursor will blink. Using VTE_CURSOR_BLINK_SYSTEM will use the "gtk-cursor-blink" setting.

Default value: VTE_CURSOR_BLINK_SYSTEM

Since 0.20


The "cursor-shape" property

  "cursor-shape"             VteCursorShape        : Read / Write

Controls the shape of the cursor.

Default value: VTE_CURSOR_SHAPE_BLOCK

Since 0.20


The "delete-binding" property

  "delete-binding"           VteEraseBinding       : Read / Write

Controls what string or control sequence the terminal sends to its child when the user presses the delete key.

Default value: VTE_ERASE_AUTO

Since 0.20


The "emulation" property

  "emulation"                gchar*                : Read / Write

Sets what type of terminal the widget attempts to emulate by scanning for control sequences defined in the system's termcap file. Unless you are interested in this feature, always use the default which is "xterm".

Default value: "xterm"

Since 0.20


The "encoding" property

  "encoding"                 gchar*                : Read / Write

Controls the encoding the terminal will expect data from the child to be encoded with. For certain terminal types, applications executing in the terminal can change the encoding. The default is defined by the application's locale settings.

Default value: NULL

Since 0.20


The "font-desc" property

  "font-desc"                PangoFontDescription*  : Read / Write

Specifies the font used for rendering all text displayed by the terminal, overriding any fonts set using gtk_widget_modify_font(). The terminal will immediately attempt to load the desired font, retrieve its metrics, and attempt to resize itself to keep the same number of rows and columns.

Since 0.20


The "font-scale" property

  "font-scale"               gdouble               : Read / Write

The terminal's font scale.

Allowed values: [0.25,4]

Default value: 1

Since 0.30


The "icon-title" property

  "icon-title"               gchar*                : Read

The terminal's so-called icon title, or NULL if no icon title has been set.

Default value: NULL

Since 0.20


The "input-enabled" property

  "input-enabled"            gboolean              : Read / Write

Controls whether the terminal allows user input. When user input is disabled, key press and mouse button press and motion events are not sent to the terminal's child.

Default value: TRUE


The "pointer-autohide" property

  "pointer-autohide"         gboolean              : Read / Write

Controls the value of the terminal's mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse.

Default value: FALSE

Since 0.20


The "pty" property

  "pty"                      VtePty*               : Read / Write

The PTY object for the terminal.

Since 0.26


The "rewrap-on-resize" property

  "rewrap-on-resize"         gboolean              : Read / Write

Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal's width changes.

Default value: TRUE

Since 0.36


The "scroll-on-keystroke" property

  "scroll-on-keystroke"      gboolean              : Read / Write

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key. Modifier keys do not trigger this behavior.

Default value: FALSE

Since 0.20


The "scroll-on-output" property

  "scroll-on-output"         gboolean              : Read / Write

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child.

Default value: TRUE

Since 0.20


The "scrollback-lines" property

  "scrollback-lines"         guint                 : Read / Write

The length of the scrollback buffer used by the terminal. The size of the scrollback buffer will be set to the larger of this value and the number of visible rows the widget can display, so 0 can safely be used to disable scrollback. Note that this setting only affects the normal screen buffer. For terminal types which have an alternate screen buffer, no scrollback is allowed on the alternate screen buffer.

Default value: 512

Since 0.20


The "visible-bell" property

  "visible-bell"             gboolean              : Read / Write

Controls whether the terminal will present a visible bell to the user when the child outputs the "bl" sequence. The terminal will clear itself to the default foreground color and then repaint itself.

Default value: FALSE

Since 0.20


The "window-title" property

  "window-title"             gchar*                : Read

The terminal's title.

Default value: NULL

Since 0.20

Signal Details

The "beep" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

This signal is emitted when the a child sends a beep request to the terminal.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "char-size-changed" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        guint        width,
                                                        guint        height,
                                                        gpointer     user_data)        : Run Last

Emitted whenever selection of a new font causes the values of the char_width or char_height fields to change.

vteterminal :

the object which received the signal

width :

the new character cell width

height :

the new character cell height

user_data :

user data set when the signal handler was connected.

The "child-exited" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gint         status,
                                                        gpointer     user_data)        : Run Last

This signal is emitted when the terminal detects that a child watched using vte_terminal_watch_child() has exited.

vteterminal :

the object which received the signal

status :

the child's exit status

user_data :

user data set when the signal handler was connected.

The "commit" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gchar       *text,
                                                        guint        size,
                                                        gpointer     user_data)        : Run Last

Emitted whenever the terminal receives input from the user and prepares to send it to the child process. The signal is emitted even when there is no child process.

vteterminal :

the object which received the signal

text :

a string of text

size :

the length of that string of text

user_data :

user data set when the signal handler was connected.

The "contents-changed" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted whenever the visible appearance of the terminal has changed. Used primarily by VteTerminalAccessible.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "copy-clipboard" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Action

Emitted whenever vte_terminal_copy_clipboard() is called.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "current-directory-uri-changed" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted when the current directory URI is modified.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

Since 0.34


The "current-file-uri-changed" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted when the current file URI is modified.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

Since 0.34


The "cursor-moved" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted whenever the cursor moves to a new character cell. Used primarily by VteTerminalAccessible.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "decrease-font-size" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted when the user hits the '-' key while holding the Control key.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "deiconify-window" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted at the child application's request.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "emulation-changed" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted whenever the terminal's emulation changes, only possible at the parent application's request.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "encoding-changed" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted whenever the terminal's current encoding has changed, either as a result of receiving a control sequence which toggled between the local and UTF-8 encodings, or at the parent application's request.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "eof" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted when the terminal receives an end-of-file from a child which is running in the terminal. This signal is frequently (but not always) emitted with a "child-exited" signal.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "icon-title-changed" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted when the terminal's icon_title field is modified.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "iconify-window" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted at the child application's request.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "increase-font-size" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted when the user hits the '+' key while holding the Control key.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "lower-window" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted at the child application's request.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "maximize-window" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted at the child application's request.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "move-window" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        guint        x,
                                                        guint        y,
                                                        gpointer     user_data)        : Run Last

Emitted at the child application's request.

vteterminal :

the object which received the signal

x :

the terminal's desired location, X coordinate

y :

the terminal's desired location, Y coordinate

user_data :

user data set when the signal handler was connected.

The "paste-clipboard" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Action

Emitted whenever vte_terminal_paste_clipboard() is called.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "raise-window" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted at the child application's request.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "refresh-window" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted at the child application's request.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "resize-window" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        guint        width,
                                                        guint        height,
                                                        gpointer     user_data)        : Run Last

Emitted at the child application's request.

vteterminal :

the object which received the signal

width :

the desired number of columns

height :

the desired number of rows

user_data :

user data set when the signal handler was connected.

The "restore-window" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted at the child application's request.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "selection-changed" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted whenever the contents of terminal's selection changes.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "status-line-changed" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted whenever the contents of the status line are modified or cleared.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "text-deleted" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "text-inserted" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "text-modified" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.

The "text-scrolled" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gint         delta,
                                                        gpointer     user_data)        : Run Last

An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.

vteterminal :

the object which received the signal

delta :

the number of lines scrolled

user_data :

user data set when the signal handler was connected.

The "window-title-changed" signal

void                user_function                      (VteTerminal *vteterminal,
                                                        gpointer     user_data)        : Run Last

Emitted when the terminal's window_title field is modified.

vteterminal :

the object which received the signal

user_data :

user data set when the signal handler was connected.