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.

vte_terminal_new ()

GtkWidget *
vte_terminal_new (void);

Creates a new terminal widget.

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.

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.

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.

vte_terminal_select_all ()

void
vte_terminal_select_all (VteTerminal *terminal);

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

vte_terminal_unselect_all ()

void
vte_terminal_unselect_all (VteTerminal *terminal);

Clears the current selection.

vte_terminal_copy_clipboard_format ()

void
vte_terminal_copy_clipboard_format (VteTerminal *terminal,
                                    VteFormat format);

Places the selected text in the terminal in the GDK_SELECTION_CLIPBOARD selection in the form specified by format .

For all formats, the selection data (see GtkSelectionData) will include the text targets (see gtk_target_list_add_text_targets() and gtk_selection_data_targets_includes_text()). For VTE_FORMAT_HTML, the selection will also include the "text/html" target, which when requested, returns the HTML data in UTF-16 with a U+FEFF BYTE ORDER MARK character at the start.

Since: 0.50

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. It's called on paste menu item, or when user presses Shift+Insert.

vte_terminal_copy_primary ()

void
vte_terminal_copy_primary (VteTerminal *terminal);

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

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. The terminal will call also paste the GDK_SELECTION_PRIMARY selection when the user clicks with the the second mouse button.

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.

vte_terminal_set_font_scale ()

void
vte_terminal_set_font_scale (VteTerminal *terminal,
                             gdouble scale);

Sets the terminal's font scale to scale .

vte_terminal_get_font_scale ()

gdouble
vte_terminal_get_font_scale (VteTerminal *terminal);

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.

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.

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.

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, either by using a bold font variant or by repainting text with a different offset.

vte_terminal_set_bold_is_bright ()

void
vte_terminal_set_bold_is_bright (VteTerminal *terminal,
                                 gboolean bold_is_bright);

Sets whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact.

Since: 0.52

vte_terminal_get_bold_is_bright ()

gboolean
vte_terminal_get_bold_is_bright (VteTerminal *terminal);

Checks whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact.

Since: 0.52

vte_terminal_set_allow_hyperlink ()

void
vte_terminal_set_allow_hyperlink (VteTerminal *terminal,
                                  gboolean allow_hyperlink);

Controls whether or not hyperlinks (OSC 8 escape sequence) are allowed.

Since: 0.50

vte_terminal_get_allow_hyperlink ()

gboolean
vte_terminal_get_allow_hyperlink (VteTerminal *terminal);

Checks whether or not hyperlinks (OSC 8 escape sequence) are allowed.

Since: 0.50

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.

vte_terminal_get_scroll_on_output ()

gboolean
vte_terminal_get_scroll_on_output (VteTerminal *terminal);

Since: 0.52

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.

vte_terminal_get_scroll_on_keystroke ()

gboolean
vte_terminal_get_scroll_on_keystroke (VteTerminal *terminal);

Since: 0.52

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.

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.

vte_terminal_set_cell_height_scale ()

void
vte_terminal_set_cell_height_scale (VteTerminal *terminal,
                                    double scale);

Sets the terminal's cell height scale to scale .

This can be used to increase the line spacing. (The font's height is not affected.) Valid values go from 1.0 (default) to 2.0 ("double spacing").

Since: 0.52

vte_terminal_get_cell_height_scale ()

double
vte_terminal_get_cell_height_scale (VteTerminal *terminal);

Since: 0.52

vte_terminal_set_cell_width_scale ()

void
vte_terminal_set_cell_width_scale (VteTerminal *terminal,
                                   double scale);

Sets the terminal's cell width scale to scale .

This can be used to increase the letter spacing. (The font's width is not affected.) Valid values go from 1.0 (default) to 2.0.

Since: 0.52

vte_terminal_get_cell_width_scale ()

double
vte_terminal_get_cell_width_scale (VteTerminal *terminal);

Since: 0.52

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.

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.

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.

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.

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.

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.

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.

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

vte_terminal_set_default_colors ()

void
vte_terminal_set_default_colors (VteTerminal *terminal);

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

vte_terminal_set_cursor_shape ()

void
vte_terminal_set_cursor_shape (VteTerminal *terminal,
                               VteCursorShape shape);

Sets the shape of the cursor drawn.

vte_terminal_get_cursor_shape ()

VteCursorShape
vte_terminal_get_cursor_shape (VteTerminal *terminal);

Returns the currently set cursor shape.

vte_terminal_get_cursor_blink_mode ()

VteCursorBlinkMode
vte_terminal_get_cursor_blink_mode (VteTerminal *terminal);

Returns the currently set 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.

vte_terminal_get_text_blink_mode ()

VteTextBlinkMode
vte_terminal_get_text_blink_mode (VteTerminal *terminal);

Checks whether or not the terminal will allow blinking text.

Since: 0.52

vte_terminal_set_text_blink_mode ()

void
vte_terminal_set_text_blink_mode (VteTerminal *terminal,
                                  VteTextBlinkMode text_blink_mode);

Controls whether or not the terminal will allow blinking text.

Since: 0.52

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.

vte_terminal_get_scrollback_lines ()

glong
vte_terminal_get_scrollback_lines (VteTerminal *terminal);

Since: 0.52

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.

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.

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.

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.

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.

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

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

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.

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.

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.

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.

vte_terminal_hyperlink_check_event ()

char *
vte_terminal_hyperlink_check_event (VteTerminal *terminal,
                                    GdkEvent *event);

Returns a nonempty string: the target of the explicit hyperlink (printed using the OSC 8 escape sequence) at the position of the event, or NULL.

Proper use of the escape sequence should result in URI-encoded URIs with a proper scheme like "http://", "https://", "file://", "mailto:" etc. This is, however, not enforced by VTE. The caller must tolerate the returned string potentially not being a valid URI.

Since: 0.50

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.

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.

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.

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.

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.

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 .

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. (Note that when using a non-UTF-8 encoding set via vte_terminal_set_encoding(), the width of ambiguous-width characters is fixed and determined by the encoding itself.)

vte_terminal_get_cjk_ambiguous_width ()

int
vte_terminal_get_cjk_ambiguous_width (VteTerminal *terminal);

Returns whether ambiguous-width characters are narrow or wide. (Note that when using a non-UTF-8 encoding set via vte_terminal_set_encoding(), the width of ambiguous-width characters is fixed and determined by the encoding itself.)

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.

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.

Since: 0.40

vte_terminal_set_input_enabled ()

void
vte_terminal_set_input_enabled (VteTerminal *terminal,
                                gboolean enabled);

Enables or disables user input. When user input is disabled, the terminal's child will not receive any key press, or mouse button press or motion events sent to it.

vte_terminal_get_input_enabled ()

gboolean
vte_terminal_get_input_enabled (VteTerminal *terminal);

Returns whether the terminal allow user input.

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.

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

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

vte_terminal_search_get_regex ()

VteRegex *
vte_terminal_search_get_regex (VteTerminal *terminal);

Since: 0.46

vte_terminal_search_get_wrap_around ()

gboolean
vte_terminal_search_get_wrap_around (VteTerminal *terminal);

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.

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.

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.

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.

vte_get_features ()

const char *
vte_get_features (void);

Gets a list of features vte was compiled with.

Since: 0.40

VteTerminalSpawnAsyncCallback ()

void
(*VteTerminalSpawnAsyncCallback) (VteTerminal *terminal,
                                  GPid pid,
                                  GError *error,
                                  gpointer user_data);

Callback for vte_terminal_spawn_async().

On success, pid contains the PID of the spawned process, and error is NULL. On failure, pid is -1 and error contains the error information.

Since: 0.48

vte_terminal_spawn_async ()

void
vte_terminal_spawn_async (VteTerminal *terminal,
                          VtePtyFlags pty_flags,
                          const char *working_directory,
                          char **argv,
                          char **envv,
                          GSpawnFlags spawn_flags_,
                          GSpawnChildSetupFunc child_setup,
                          gpointer child_setup_data,
                          GDestroyNotify child_setup_data_destroy,
                          int timeout,
                          GCancellable *cancellable,
                          VteTerminalSpawnAsyncCallback callback,
                          gpointer user_data);

A convenience function that wraps creating the VtePty and spawning the child process on it. See vte_pty_new_sync(), vte_pty_spawn_async(), and vte_pty_spawn_finish() for more information.

When the operation is finished successfully, callback will be called with the child GPid, and a NULL GError. The child PID will already be watched via vte_terminal_watch_child().

When the operation fails, callback will be called with a -1 GPid, and a non-NULL GError containing the error information.

Note that if terminal has been destroyed before the operation is called, callback will be called with a NULL terminal ; you must not do anything in the callback besides freeing any resources associated with user_data , but taking care not to access the now-destroyed VteTerminal. Note that in this case, if spawning was successful, the child process will be aborted automatically.

Beginning with 0.52, sets PWD to working_directory in order to preserve symlink components. The caller should also make sure that symlinks were preserved while constructing the value of working_directory , e.g. by using vte_terminal_get_current_directory_uri(), g_get_current_dir() or get_current_dir_name().

Since: 0.48

vte_terminal_get_pty ()

VtePty *
vte_terminal_get_pty (VteTerminal *terminal);

Returns the VtePty of terminal .

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.

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.

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.

vte_terminal_set_clear_background ()

void
vte_terminal_set_clear_background (VteTerminal *terminal,
                                   gboolean setting);

Sets whether to paint the background with the background colour. The default is TRUE.

This function is rarely useful. One use for it is to add a background image to the terminal.

Since: 0.52

vte_terminal_get_color_background_for_draw ()

void
vte_terminal_get_color_background_for_draw
                               (VteTerminal *terminal,
                                GdkRGBA *color);

Returns the background colour, as used by terminal when drawing the background, which may be different from the color set by vte_terminal_set_color_background().

Note: you must only call this function while handling the GtkWidget::draw signal.

This function is rarely useful. One use for it is if you disable drawing the background (see vte_terminal_set_clear_background()) and then need to draw the background yourself.

Since: 0.54

vte_terminal_get_char_height ()

glong
vte_terminal_get_char_height (VteTerminal *terminal);

vte_terminal_get_char_width ()

glong
vte_terminal_get_char_width (VteTerminal *terminal);

vte_terminal_get_column_count ()

glong
vte_terminal_get_column_count (VteTerminal *terminal);

vte_terminal_get_row_count ()

glong
vte_terminal_get_row_count (VteTerminal *terminal);

vte_terminal_get_window_title ()

const char *
vte_terminal_get_window_title (VteTerminal *terminal);

vte_terminal_get_current_directory_uri ()

const char *
vte_terminal_get_current_directory_uri
                               (VteTerminal *terminal);

vte_terminal_get_current_file_uri ()

const char *
vte_terminal_get_current_file_uri (VteTerminal *terminal);

vte_terminal_copy_clipboard ()

void
vte_terminal_copy_clipboard (VteTerminal *terminal);

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

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 .

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 .

vte_terminal_match_add_gregex ()

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

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.

vte_terminal_search_get_gregex ()

GRegex *
vte_terminal_search_get_gregex (VteTerminal *terminal);

vte_terminal_search_set_gregex ()

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

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

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

This function does nothing.

Since: 0.44

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.

Beginning with 0.52, sets PWD to working_directory in order to preserve symlink components. The caller should also make sure that symlinks were preserved while constructing the value of working_directory , e.g. by using vte_terminal_get_current_directory_uri(), g_get_current_dir() or get_current_dir_name().

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

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

vte_terminal_get_icon_title ()

const char *
vte_terminal_get_icon_title (VteTerminal *terminal);

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

Note: Support for non-UTF-8 is deprecated and may get removed altogether. Instead of this function, you should use a wrapper like luit(1) when spawning the child process.

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, or NULL if UTF-8 is in use.

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.

struct VteTerminal

struct VteTerminal;

enum VteCursorBlinkMode

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

enum VteCursorShape

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

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.

enum VteTextBlinkMode

An enumerated type which can be used to indicate whether the terminal allows the text contents to be blinked.

Since: 0.52

enum VteFormat

An enumeratio type that can be used to specify the format the selection should be copied to the clipboard in.

Since: 0.50

enum VteWriteFlags

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

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 “allow-hyperlink” property

  “allow-hyperlink”          gboolean

Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed.

Flags: Read / Write

Default value: FALSE

Since: 0.50

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 “bold-is-bright” property

  “bold-is-bright”           gboolean

Whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact.

Flags: Read / Write

Default value: FALSE

Since: 0.52

The “cell-height-scale” property

  “cell-height-scale”        gdouble

Scale factor for the cell height, to increase line spacing. (The font's height is not affected.)

Flags: Read / Write

Allowed values: [1,2]

Default value: 1

Since: 0.52

The “cell-width-scale” property

  “cell-width-scale”         gdouble

Scale factor for the cell width, to increase letter spacing. (The font's width is not affected.)

Flags: Read / Write

Allowed values: [1,2]

Default value: 1

Since: 0.52

The “cjk-ambiguous-width” property

  “cjk-ambiguous-width”      gint

This setting controls whether ambiguous-width characters are narrow or wide. (Note that when using a non-UTF-8 encoding set via vte_terminal_set_encoding(), the width of ambiguous-width characters is fixed and determined by the encoding itself.)

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 “hyperlink-hover-uri” property

  “hyperlink-hover-uri”      gchar *

The currently hovered hyperlink URI, or NULL if unset.

Flags: Read

Default value: NULL

Since: 0.50

The “icon-title” property

  “icon-title”               gchar *

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 “text-blink-mode” property

  “text-blink-mode”          VteTextBlinkMode

Controls whether or not the terminal will allow blinking text.

Flags: Read / Write

Default value: VTE_TEXT_BLINK_ALWAYS

Since: 0.52

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

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.

Flags: Run Last

The “char-size-changed” signal

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

Emitted whenever the cell size changes, e.g. due to a change in font, font-scale or cell-width/height-scale.

Note that this signal should rather be called "cell-size-changed".

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.

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.

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.

Flags: Run Last

The “copy-clipboard” signal

void
user_function (VteTerminal *vteterminal,
               gpointer     user_data)

Emitted whenever vte_terminal_copy_clipboard() is called.