VteTerminal

VteTerminal — A terminal widget implementation

Functions

gboolean (*VteSelectionFunc) ()
GtkWidget * vte_terminal_new ()
void vte_terminal_feed ()
void vte_terminal_feed_child ()
void vte_terminal_feed_child_binary ()
void vte_terminal_select_all ()
void vte_terminal_unselect_all ()
void vte_terminal_copy_clipboard ()
void vte_terminal_paste_clipboard ()
void vte_terminal_copy_primary ()
void vte_terminal_paste_primary ()
void vte_terminal_set_size ()
void vte_terminal_set_font_scale ()
gdouble vte_terminal_get_font_scale ()
void vte_terminal_set_audible_bell ()
gboolean vte_terminal_get_audible_bell ()
void vte_terminal_set_allow_bold ()
gboolean vte_terminal_get_allow_bold ()
void vte_terminal_set_scroll_on_output ()
void vte_terminal_set_scroll_on_keystroke ()
void vte_terminal_set_rewrap_on_resize ()
gboolean vte_terminal_get_rewrap_on_resize ()
void vte_terminal_set_color_bold ()
void vte_terminal_set_color_foreground ()
void vte_terminal_set_color_background ()
void vte_terminal_set_color_cursor ()
void vte_terminal_set_color_cursor_foreground ()
void vte_terminal_set_color_highlight ()
void vte_terminal_set_color_highlight_foreground ()
void vte_terminal_set_colors ()
void vte_terminal_set_default_colors ()
void vte_terminal_set_cursor_shape ()
VteCursorShape vte_terminal_get_cursor_shape ()
VteCursorBlinkMode vte_terminal_get_cursor_blink_mode ()
void vte_terminal_set_cursor_blink_mode ()
void vte_terminal_set_scrollback_lines ()
void vte_terminal_set_font ()
const PangoFontDescription * vte_terminal_get_font ()
gboolean vte_terminal_get_has_selection ()
void vte_terminal_set_backspace_binding ()
void vte_terminal_set_delete_binding ()
void vte_terminal_set_mouse_autohide ()
gboolean vte_terminal_get_mouse_autohide ()
void vte_terminal_reset ()
char * vte_terminal_get_text ()
char * vte_terminal_get_text_include_trailing_spaces ()
char * vte_terminal_get_text_range ()
void vte_terminal_get_cursor_position ()
int vte_terminal_match_add_regex ()
void vte_terminal_match_remove ()
void vte_terminal_match_remove_all ()
char * vte_terminal_match_check ()
char * vte_terminal_match_check_event ()
void vte_terminal_match_set_cursor_type ()
void vte_terminal_match_set_cursor_name ()
void vte_terminal_set_cjk_ambiguous_width ()
int vte_terminal_get_cjk_ambiguous_width ()
gboolean vte_terminal_set_encoding ()
const char * vte_terminal_get_encoding ()
void vte_terminal_set_word_char_exceptions ()
const char * vte_terminal_get_word_char_exceptions ()
gboolean vte_terminal_write_contents_sync ()
gboolean vte_terminal_search_find_next ()
gboolean vte_terminal_search_find_previous ()
VteRegex * vte_terminal_search_get_regex ()
gboolean vte_terminal_search_get_wrap_around ()
void vte_terminal_search_set_regex ()
void vte_terminal_search_set_wrap_around ()
gboolean vte_terminal_event_check_regex_simple ()
char * vte_get_user_shell ()
const char * vte_get_features ()
gboolean vte_terminal_spawn_sync ()
VtePty * vte_terminal_get_pty ()
void vte_terminal_set_pty ()
VtePty * vte_terminal_pty_new_sync ()
void vte_terminal_watch_child ()
void vte_terminal_get_geometry_hints ()
void vte_terminal_set_geometry_hints_for_window ()
glong vte_terminal_get_char_height ()
glong vte_terminal_get_char_width ()
glong vte_terminal_get_column_count ()
const char * vte_terminal_get_icon_title ()
glong vte_terminal_get_row_count ()
const char * vte_terminal_get_window_title ()
const char * vte_terminal_get_current_directory_uri ()
const char * vte_terminal_get_current_file_uri ()
void vte_terminal_match_set_cursor ()
int vte_terminal_match_add_gregex ()
GRegex * vte_terminal_search_get_gregex ()
void vte_terminal_search_set_gregex ()
gboolean vte_terminal_event_check_gregex_simple ()

Properties

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

Types and Values

Object Hierarchy

    GEnum
    ├── VteCursorBlinkMode
    ├── VteCursorShape
    ├── VteEraseBinding
    ╰── VteWriteFlags
    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── VteTerminal

Implemented Interfaces

VteTerminal implements AtkImplementorIface, GtkBuildable and GtkScrollable.

Description

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

Note that altough VteTerminal implements the GtkScrollable interface, you should not place a VteTerminal inside a GtkScrolledWindow container, since they are incompatible. Instead, pack the terminal in a horizontal GtkBox together with a GtkScrollbar which uses the GtkAdjustment returned from gtk_scrollable_get_vadjustment().

Functions

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.

Parameters

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.

Parameters

terminal

a VteTerminal

 

data

a string in the terminal's current encoding.

[array length=length][element-type guint8][allow-none]

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.

Parameters

terminal

a VteTerminal

 

text

data to send to the child.

[element-type utf8][allow-none]

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.

Parameters

terminal

a VteTerminal

 

data

data to send to the child.

[array length=length][element-type guint8][allow-none]

length

length of data

 

vte_terminal_select_all ()

void
vte_terminal_select_all (VteTerminal *terminal);

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

Parameters

terminal

a VteTerminal

 

vte_terminal_unselect_all ()

void
vte_terminal_unselect_all (VteTerminal *terminal);

Clears the current selection.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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 .

Parameters

terminal

a VteTerminal

 

scale

the font scale

 

vte_terminal_get_font_scale ()

gdouble
vte_terminal_get_font_scale (VteTerminal *terminal);

Parameters

terminal

a VteTerminal

 

Returns

the terminal's font scale


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.

Parameters

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.

Parameters

terminal

a VteTerminal

 

Returns

TRUE if audible 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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

terminal

a VteTerminal

 

rewrap

TRUE if the terminal should rewrap on resize

 

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.

Parameters

terminal

a VteTerminal

 

Returns

TRUE if rewrapping is enabled, FALSE if not


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.

Parameters

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.

Parameters

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.

Parameters

terminal

a VteTerminal

 

background

the new background color

 

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.

Parameters

terminal

a VteTerminal

 

cursor_background

the new color to use for the text cursor, or NULL.

[allow-none]

vte_terminal_set_color_cursor_foreground ()

void
vte_terminal_set_color_cursor_foreground
                               (VteTerminal *terminal,
                                const GdkRGBA *cursor_foreground);

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

Parameters

terminal

a VteTerminal

 

cursor_foreground

the new color to use for the text cursor, or NULL.

[allow-none]

Since: 0.44


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.

Parameters

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.

Parameters

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);

palette specifies the new values for the 256 palette colors: 8 standard colors, their 8 bright counterparts, 6x6x6 color cube, and 24 grayscale colors. Omitted entries will default to a hardcoded value.

palette_size must be 0, 8, 16, 232 or 256.

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].

Parameters

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.

Parameters

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.

Parameters

terminal

a VteTerminal

 

shape

the VteCursorShape to use

 

vte_terminal_get_cursor_shape ()

VteCursorShape
vte_terminal_get_cursor_shape (VteTerminal *terminal);

Returns the currently set cursor shape.

Parameters

terminal

a VteTerminal

 

Returns

cursor shape.


vte_terminal_get_cursor_blink_mode ()

VteCursorBlinkMode
vte_terminal_get_cursor_blink_mode (VteTerminal *terminal);

Returns the currently set cursor blink mode.

Parameters

terminal

a VteTerminal

 

Returns

cursor blink mode.


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.

Parameters

terminal

a VteTerminal

 

mode

the VteCursorBlinkMode to use

 

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. No scrollback is allowed on the alternate screen buffer.

Parameters

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);

Sets 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. The font scale is applied to the specified font.

Parameters

terminal

a VteTerminal

 

font_desc

a PangoFontDescription for the desired font, or NULL.

[allow-none]

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. The actual font takes the font scale into account, this is not reflected in the return value, the unscaled font is returned.

Parameters

terminal

a VteTerminal

 

Returns

a PangoFontDescription describing the font the terminal uses to render text at the default font scale of 1.0.

[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.

Parameters

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.

Parameters

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.

Parameters

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().

Parameters

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().

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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_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.

Parameters

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.

Parameters

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_regex ()

int
vte_terminal_match_add_regex (VteTerminal *terminal,
                              VteRegex *regex,
                              guint32 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.

Parameters

terminal

a VteTerminal

 

regex

a VteRegex.

[transfer none]

flags

PCRE2 match flags, or 0

 

Returns

an integer associated with this expression

Since: 0.46


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.

Parameters

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.

Parameters

terminal

a VteTerminal

 

vte_terminal_match_check ()

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

vte_terminal_match_check has been deprecated since version 0.46 and should not be used in newly-written code.

Use vte_terminal_match_check_event() instead.

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.

Parameters

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.

Parameters

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_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 .

Parameters

terminal

a VteTerminal

 

tag

the tag of the regex which should use the specified cursor

 

cursor_type

a GdkCursorType

 

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 .

Parameters

terminal

a VteTerminal

 

tag

the tag of the regex which should use the specified cursor

 

cursor_name

the name of the cursor

 

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.

Parameters

terminal

a VteTerminal

 

width

either 1 (narrow) or 2 (wide)

 

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()).

Parameters

terminal

a VteTerminal

 

Returns

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


vte_terminal_set_encoding ()

gboolean
vte_terminal_set_encoding (VteTerminal *terminal,
                           const char *codeset,
                           GError **error);

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. If codeset is NULL, it uses "UTF-8".

Parameters

terminal

a VteTerminal

 

codeset

a valid GIConv target, or NULL to use UTF-8.

[allow-none]

error

return location for a GError, or NULL.

[allow-none]

Returns

TRUE if the encoding could be changed to the specified one, or FALSE with error set to G_CONVERT_ERROR_NO_CONVERSION.


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.

Parameters

terminal

a VteTerminal

 

Returns

the current encoding for the terminal.

[transfer none]


vte_terminal_set_word_char_exceptions ()

void
vte_terminal_set_word_char_exceptions (VteTerminal *terminal,
                                       const char *exceptions);

With this function you can provide a set of characters which will be considered parts of a word when doing word-wise selection, in addition to the default which only considers alphanumeric characters part of a word.

The characters in exceptions must be non-alphanumeric, each character must occur only once, and if exceptions contains the character U+002D HYPHEN-MINUS, it must be at the start of the string.

Use NULL to reset the set of exception characters to the default.

Parameters

terminal

a VteTerminal

 

exceptions

a string of ASCII punctuation characters, or NULL

 

Since: 0.40


vte_terminal_get_word_char_exceptions ()

const char *
vte_terminal_get_word_char_exceptions (VteTerminal *terminal);

Returns the set of characters which will be considered parts of a word when doing word-wise selection, in addition to the default which only considers alphanumeric characters part of a word.

If NULL, a built-in set is used.

Parameters

terminal

a VteTerminal

 

Returns

a string, or NULL.

[transfer none]

Since: 0.40


vte_terminal_write_contents_sync ()

gboolean
vte_terminal_write_contents_sync (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.

Parameters

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


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_regex().

Parameters

terminal

a VteTerminal

 

Returns

TRUE if a match was found


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_regex().

Parameters

terminal

a VteTerminal

 

Returns

TRUE if a match was found


vte_terminal_search_get_regex ()

VteRegex *
vte_terminal_search_get_regex (VteTerminal *terminal);

Parameters

terminal

a VteTerminal

 

Returns

the search VteRegex regex set in terminal , or NULL.

[transfer none]

Since: 0.46


vte_terminal_search_get_wrap_around ()

gboolean
vte_terminal_search_get_wrap_around (VteTerminal *terminal);

Parameters

terminal

a VteTerminal

 

Returns

whether searching will wrap around


vte_terminal_search_set_regex ()

void
vte_terminal_search_set_regex (VteTerminal *terminal,
                               VteRegex *regex,
                               guint32 flags);

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

Parameters

terminal

a VteTerminal

 

regex

a VteRegex, or NULL.

[allow-none]

flags

PCRE2 match flags, or 0

 

Since: 0.46


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.

Parameters

terminal

a VteTerminal

 

wrap_around

whether search should wrap

 

vte_terminal_event_check_regex_simple ()

gboolean
vte_terminal_event_check_regex_simple (VteTerminal *terminal,
                                       GdkEvent *event,
                                       VteRegex **regexes,
                                       gsize n_regexes,
                                       guint32 match_flags,
                                       char **matches);

Checks each regex in regexes if the text in and around the position of the event matches the regular expressions. If a match exists, the matched text is stored in matches at the position of the regex in regexes ; otherwise NULL is stored there.

Parameters

terminal

a VteTerminal

 

event

a GdkEvent

 

regexes

an array of VteRegex.

[array length=n_regexes]

n_regexes

number of items in regexes

 

match_flags

PCRE2 match flags, or 0

 

matches

a location to store the matches.

[out caller-allocates][array length=n_regexes]

Returns

TRUE iff any of the regexes produced a match

Since: 0.46


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]


vte_get_features ()

const char *
vte_get_features (void);

Gets a list of features vte was compiled with.

Returns

a string with features.

[transfer none]

Since: 0.40


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 a default value, but can be overridden from envv . 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 all open file descriptors will be closed in the child. If you want to keep some file descriptor open for use in the child process, you need to use a child setup function that unsets the FD_CLOEXEC flag on that file descriptor.

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

Parameters

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


vte_terminal_get_pty ()

VtePty *
vte_terminal_get_pty (VteTerminal *terminal);

Returns the VtePty of terminal .

Parameters

terminal

a VteTerminal

 

Returns

a VtePty, or NULL.

[transfer none]


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.

Parameters

terminal

a VteTerminal

 

pty

a VtePty, or NULL.

[allow-none]

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.

Parameters

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]


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.

Parameters

terminal

a VteTerminal

 

child_pid

a GPid

 

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()).

Parameters

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()).

Parameters

terminal

a VteTerminal

 

window

a GtkWindow

 

vte_terminal_get_char_height ()

glong
vte_terminal_get_char_height (VteTerminal *terminal);

Parameters

terminal

a VteTerminal

 

Returns

the height of a character cell


vte_terminal_get_char_width ()

glong
vte_terminal_get_char_width (VteTerminal *terminal);

Parameters

terminal

a VteTerminal

 

Returns

the width of a character cell


vte_terminal_get_column_count ()

glong
vte_terminal_get_column_count (VteTerminal *terminal);

Parameters

terminal

a VteTerminal

 

Returns

the number of columns


vte_terminal_get_icon_title ()

const char *
vte_terminal_get_icon_title (VteTerminal *terminal);

Parameters

terminal

a VteTerminal

 

Returns

the icon title.

[transfer none]


vte_terminal_get_row_count ()

glong
vte_terminal_get_row_count (VteTerminal *terminal);

Parameters

terminal

a VteTerminal

 

Returns

the number of rows


vte_terminal_get_window_title ()

const char *
vte_terminal_get_window_title (VteTerminal *terminal);

Parameters

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);

Parameters

terminal

a VteTerminal

 

Returns

the URI of the current directory of the process running in the terminal, or NULL.

[transfer none]


vte_terminal_get_current_file_uri ()

const char *
vte_terminal_get_current_file_uri (VteTerminal *terminal);

Parameters

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]


vte_terminal_match_set_cursor ()

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

vte_terminal_match_set_cursor has been deprecated since version 0.40 and should not be used in newly-written code.

Use vte_terminal_match_set_cursor_type() or vte_terminal_match_set_cursor_named() instead.

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

Parameters

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]

vte_terminal_match_add_gregex ()

int
vte_terminal_match_add_gregex (VteTerminal *terminal,
                               GRegex *gregex,
                               GRegexMatchFlags gflags);

vte_terminal_match_add_gregex has been deprecated since version 0.46 and should not be used in newly-written code.

Use vte_terminal_match_add_regex() or vte_terminal_match_add_regex_full() instead.

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.

Parameters

terminal

a VteTerminal

 

gregex

a GRegex

 

gflags

the GRegexMatchFlags to use when matching the regex

 

Returns

an integer associated with this expression, or -1 if gregex could not be transformed into a VteRegex or gflags were incompatible


vte_terminal_search_get_gregex ()

GRegex *
vte_terminal_search_get_gregex (VteTerminal *terminal);

vte_terminal_search_get_gregex has been deprecated since version 0.46 and should not be used in newly-written code.

use vte_terminal_search_get_regex() instead.

Parameters

terminal

a VteTerminal

 

Returns

NULL.

[transfer none]


vte_terminal_search_set_gregex ()

void
vte_terminal_search_set_gregex (VteTerminal *terminal,
                                GRegex *gregex,
                                GRegexMatchFlags gflags);

vte_terminal_search_set_gregex has been deprecated since version 0.46 and should not be used in newly-written code.

use vte_terminal_search_set_regex() instead.

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

Parameters

terminal

a VteTerminal

 

gregex

a GRegex, or NULL.

[allow-none]

gflags

flags from GRegexMatchFlags

 

vte_terminal_event_check_gregex_simple ()

gboolean
vte_terminal_event_check_gregex_simple
                               (VteTerminal *terminal,
                                GdkEvent *event,
                                GRegex **regexes,
                                gsize n_regexes,
                                GRegexMatchFlags match_flags,
                                char **matches);

vte_terminal_event_check_gregex_simple has been deprecated since version 0.46 and should not be used in newly-written code.

Use vte_terminal_event_check_regex_simple() instead.

This function does nothing.

Parameters

terminal

a VteTerminal

 

event

a GdkEvent

 

regexes

an array of GRegex.

[array length=n_regexes]

n_regexes

number of items in regexes

 

match_flags

the GRegexMatchFlags to use when matching the regexes

 

matches

a location to store the matches.

[out caller-allocates][array length=n_regexes]

Returns

FALSE

Since: 0.44

Types and Values

struct VteTerminal

struct VteTerminal;

enum VteCursorBlinkMode

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

Members

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

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

Members

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

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.

Members

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

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

Members

VTE_WRITE_DEFAULT

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

 

Property Details

The “allow-bold” property

  “allow-bold”               gboolean

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.

Flags: Read / Write

Default value: TRUE


The “audible-bell” property

  “audible-bell”             gboolean

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

Flags: Read / Write

Default value: TRUE


The “backspace-binding” property

  “backspace-binding”        VteEraseBinding

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

Flags: Read / Write

Default value: VTE_ERASE_AUTO


The “cjk-ambiguous-width” property

  “cjk-ambiguous-width”      gint

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().

Flags: Read / Write

Allowed values: [1,2]

Default value: 1


The “current-directory-uri” property

  “current-directory-uri”    gchar *

The current directory URI, or NULL if unset.

Flags: Read

Default value: NULL


The “current-file-uri” property

  “current-file-uri”         gchar *

The current file URI, or NULL if unset.

Flags: Read

Default value: NULL


The “cursor-blink-mode” property

  “cursor-blink-mode”        VteCursorBlinkMode

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

Flags: Read / Write

Default value: VTE_CURSOR_BLINK_SYSTEM


The “cursor-shape” property

  “cursor-shape”             VteCursorShape

Controls the shape of the cursor.

Flags: Read / Write

Default value: VTE_CURSOR_SHAPE_BLOCK


The “delete-binding” property

  “delete-binding”           VteEraseBinding

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

Flags: Read / Write

Default value: VTE_ERASE_AUTO


The “encoding” property

  “encoding”                 gchar *

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.

Flags: Read / Write

Default value: NULL


The “font-desc” property

  “font-desc”                PangoFontDescription *

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.

Flags: Read / Write


The “font-scale” property

  “font-scale”               gdouble

The terminal's font scale.

Flags: Read / Write

Allowed values: [0.25,4]

Default value: 1


The “icon-title” property

  “icon-title”               gchar *

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

Flags: Read

Default value: NULL


The “input-enabled” property

  “input-enabled”            gboolean

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.

Flags: Read / Write

Default value: TRUE


The “pointer-autohide” property

  “pointer-autohide”         gboolean

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.

Flags: Read / Write

Default value: FALSE


The “pty” property

  “pty”                      VtePty *

The PTY object for the terminal.

Flags: Read / Write


The “rewrap-on-resize” property

  “rewrap-on-resize”         gboolean

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

Flags: Read / Write

Default value: TRUE


The “scroll-on-keystroke” property

  “scroll-on-keystroke”      gboolean

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.

Flags: Read / Write

Default value: FALSE


The “scroll-on-output” property

  “scroll-on-output”         gboolean

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.

Flags: Read / Write

Default value: TRUE


The “scrollback-lines” property

  “scrollback-lines”         guint

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.

Flags: Read / Write

Default value: 512


The “window-title” property

  “window-title”             gchar *

The terminal's title.

Flags: Read

Default value: NULL


The “word-char-exceptions” property

  “word-char-exceptions”     gchar *

The set of characters which will be considered parts of a word when doing word-wise selection, in addition to the default which only considers alphanumeric characters part of a word.

If NULL, a built-in set is used.

Flags: Read

Default value: NULL

Since: 0.40

Signal Details

The “bell” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

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

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “char-size-changed” signal

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

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

Parameters

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.

 

Flags: Run Last


The “child-exited” signal

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

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

Parameters

vteterminal

the object which received the signal

 

status

the child's exit status

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “commit” signal

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

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.

Parameters

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.

 

Flags: Run Last


The “contents-changed” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

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

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “copy-clipboard” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted whenever vte_terminal_copy_clipboard() is called.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “current-directory-uri-changed” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted when the current directory URI is modified.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “current-file-uri-changed” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted when the current file URI is modified.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “cursor-moved” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

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

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “decrease-font-size” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

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

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “deiconify-window” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted at the child application's request.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “encoding-changed” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

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.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “eof” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

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.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “icon-title-changed” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted when the terminal's icon_title field is modified.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “iconify-window” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted at the child application's request.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “increase-font-size” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

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

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “lower-window” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted at the child application's request.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “maximize-window” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted at the child application's request.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “move-window” signal

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

Emitted at the child application's request.

Parameters

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.

 

Flags: Run Last


The “paste-clipboard” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted whenever vte_terminal_paste_clipboard() is called.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “raise-window” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted at the child application's request.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “refresh-window” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted at the child application's request.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “resize-window” signal

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

Emitted at the child application's request.

Parameters

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.

 

Flags: Run Last


The “restore-window” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted at the child application's request.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “selection-changed” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted whenever the contents of terminal's selection changes.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “text-deleted” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

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

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “text-inserted” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

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

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “text-modified” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

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

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “text-scrolled” signal

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

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

Parameters

vteterminal

the object which received the signal

 

delta

the number of lines scrolled

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “window-title-changed” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted when the terminal's window_title field is modified.

Parameters

vteterminal

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last