Class

VteTerminal

unstable since: 3.91

Description

class Vte.Terminal : Gtk.Widget
  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Scrollable {
  /* No available fields */
}
No description available.

Available since: 3.91

Constructors

vte_terminal_new

Creates a new terminal widget.

unstable since: 3.91

Instance methods

vte_terminal_check_hyperlink_at

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

since: 0.70

vte_terminal_check_match_at

Checks if the text in and around the position (x, y) 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.

since: 0.70

vte_terminal_check_regex_array_at

Like vte_terminal_check_regex_simple_at(), but returns an array of strings, containing the matching text (or NULL if no match) corresponding to each of the regexes in regexes.

since: 0.70

vte_terminal_check_regex_simple_at

Checks each regex in regexes if the text in and around the position (x, y) 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. Each non-NULL element of matches should be freed with g_free().

since: 0.70

vte_terminal_copy_clipboard

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

unstable deprecated: 0.50 since: 3.91

vte_terminal_copy_clipboard_format

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

since: 0.50

vte_terminal_copy_primary

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

unstable since: 3.91

vte_terminal_feed

Interprets data as if it were data received from a child process.

unstable since: 3.91

vte_terminal_feed_child

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

unstable since: 3.91

vte_terminal_feed_child_binary

Sends a block of binary data to the child.

unstable deprecated: 0.60 since: 3.91

vte_terminal_get_allow_bold

Checks whether or not the terminal will attempt to draw bold text, by using a bold font variant.

unstable deprecated: 0.60 since: 3.91

vte_terminal_get_allow_hyperlink

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

since: 0.50

vte_terminal_get_audible_bell

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

unstable since: 3.91

vte_terminal_get_bold_is_bright

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_get_cell_height_scale
No description available.

since: 0.52

vte_terminal_get_cell_width_scale
No description available.

since: 0.52

vte_terminal_get_char_height
No description available.

unstable since: 3.91

vte_terminal_get_char_width
No description available.

unstable since: 3.91

vte_terminal_get_cjk_ambiguous_width

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

unstable since: 3.91

vte_terminal_get_color_background_for_draw

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

since: 0.54

vte_terminal_get_column_count
No description available.

unstable since: 3.91

vte_terminal_get_current_directory_uri
No description available.

unstable since: 3.91

vte_terminal_get_current_file_uri
No description available.

unstable since: 3.91

vte_terminal_get_cursor_blink_mode

Returns the currently set cursor blink mode.

unstable since: 3.91

vte_terminal_get_cursor_position

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

unstable since: 3.91

vte_terminal_get_cursor_shape

Returns the currently set cursor shape.

unstable since: 3.91

vte_terminal_get_enable_bidi

Checks whether the terminal performs bidirectional text rendering.

since: 0.58

vte_terminal_get_enable_fallback_scrolling
No description available.

since: 0.64

vte_terminal_get_enable_shaping

Checks whether the terminal shapes Arabic text.

since: 0.58

vte_terminal_get_enable_sixel
No description available.

since: 0.62

vte_terminal_get_encoding

Determines the name of the encoding in which the terminal expects data to be encoded, or NULL if UTF-8 is in use.

unstable deprecated: 0.54 since: 3.91

vte_terminal_get_font

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.

unstable since: 3.91

vte_terminal_get_font_options
No description available.

since: 0.74

vte_terminal_get_font_scale
No description available.

unstable since: 3.91

vte_terminal_get_has_selection

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.

unstable since: 3.91

vte_terminal_get_icon_title
No description available.

unstable deprecated: 0.54 since: 3.91

vte_terminal_get_input_enabled

Returns whether the terminal allow user input.

unstable since: 3.91

vte_terminal_get_mouse_autohide

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

unstable since: 3.91

vte_terminal_get_pty

Returns the VtePty of terminal.

unstable since: 3.91

vte_terminal_get_rewrap_on_resize

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

unstable deprecated: 0.58 since: 3.91

vte_terminal_get_row_count
No description available.

unstable since: 3.91

vte_terminal_get_scroll_on_keystroke
No description available.

since: 0.52

vte_terminal_get_scroll_on_output
No description available.

since: 0.52

vte_terminal_get_scroll_unit_is_pixels
No description available.

since: 0.66

vte_terminal_get_scrollback_lines
No description available.

since: 0.52

vte_terminal_get_text

Extracts a view of the visible part of the terminal.

unstable since: 3.91

vte_terminal_get_text_blink_mode

Checks whether or not the terminal will allow blinking text.

since: 0.52

vte_terminal_get_text_include_trailing_spaces

Extracts a view of the visible part of the terminal.

unstable deprecated: 0.56 since: 3.91

vte_terminal_get_text_range

Extracts a view of the visible part of the terminal. The entire scrollback buffer is scanned, so it is possible to read the entire contents of the buffer using this function.

unstable since: 3.91

vte_terminal_get_text_range_format

Returns the specified range of text in the specified format.

since: 0.72

vte_terminal_get_text_selected

Gets the currently selected text in the format specified by format. Since 0.72, this function also supports VTE_FORMAT_HTML format.xg.

since: 0.70

vte_terminal_get_text_selected_full

Gets the currently selected text in the format specified by format.

since: 0.72

vte_terminal_get_window_title
No description available.

unstable since: 3.91

vte_terminal_get_word_char_exceptions

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.

since: 0.40

vte_terminal_match_add_regex

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_check

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.

unstable deprecated: 0.46 since: 3.91

vte_terminal_match_remove

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.

unstable since: 3.91

vte_terminal_match_remove_all

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

unstable since: 3.91

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

unstable deprecated: 0.40 since: 3.91

vte_terminal_match_set_cursor_name

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

unstable since: 3.91

vte_terminal_paste_clipboard

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.

unstable since: 3.91

vte_terminal_paste_primary

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.

unstable since: 3.91

vte_terminal_paste_text

Sends text to the terminal’s child as if retrived from the clipboard, this differs from vte_terminal_feed_child() in that it may process text before passing it to the child (e.g. apply bracketed mode)

since: 0.68

vte_terminal_pty_new_sync

Creates a new VtePty, sets the emulation property from VteTerminal:emulation, and sets the size using terminals size.

unstable since: 3.91

vte_terminal_reset

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.

unstable since: 3.91

vte_terminal_search_find_next

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

unstable since: 3.91

vte_terminal_search_find_previous

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

unstable since: 3.91

vte_terminal_search_get_regex
No description available.

since: 0.46

vte_terminal_search_get_wrap_around
No description available.

unstable since: 3.91

vte_terminal_search_set_regex

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

since: 0.46

vte_terminal_search_set_wrap_around

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

unstable since: 3.91

vte_terminal_select_all

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

unstable since: 3.91

vte_terminal_set_allow_bold

Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.

unstable deprecated: 0.60 since: 3.91

vte_terminal_set_allow_hyperlink

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

since: 0.50

vte_terminal_set_audible_bell

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

unstable since: 3.91

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

unstable since: 3.91

vte_terminal_set_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_set_cell_height_scale

Sets the terminal’s cell height scale to scale.

since: 0.52

vte_terminal_set_cell_width_scale

Sets the terminal’s cell width scale to scale.

since: 0.52

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

unstable since: 3.91

vte_terminal_set_clear_background

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

since: 0.52

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

unstable since: 3.91

vte_terminal_set_color_bold

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

unstable since: 3.91

vte_terminal_set_color_cursor

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.

unstable since: 3.91

vte_terminal_set_color_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_foreground

Sets the foreground color used to draw normal text.

unstable since: 3.91

vte_terminal_set_color_highlight

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.

unstable since: 3.91

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

unstable since: 3.91

vte_terminal_set_colors

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.

unstable since: 3.91

vte_terminal_set_cursor_blink_mode

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

unstable since: 3.91

vte_terminal_set_cursor_shape

Sets the shape of the cursor drawn.

unstable since: 3.91

vte_terminal_set_default_colors

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

unstable since: 3.91

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

unstable since: 3.91

vte_terminal_set_enable_bidi

Controls whether or not the terminal will perform bidirectional text rendering.

since: 0.58

vte_terminal_set_enable_fallback_scrolling

Controls whether the terminal uses scroll events to scroll the history if the event was not otherwise consumed by it.

since: 0.64

vte_terminal_set_enable_shaping

Controls whether or not the terminal will shape Arabic text.

since: 0.58

vte_terminal_set_enable_sixel

Set whether to enable SIXEL images.

since: 0.62

vte_terminal_set_encoding

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

unstable deprecated: 0.54 since: 3.91

vte_terminal_set_font

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.

unstable since: 3.91

vte_terminal_set_font_options

Sets the terminal’s font options to options.

since: 0.74

vte_terminal_set_font_scale

Sets the terminal’s font scale to scale.

unstable since: 3.91

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

unstable since: 3.91

vte_terminal_set_mouse_autohide

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

unstable since: 3.91

vte_terminal_set_pty

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

unstable since: 3.91

vte_terminal_set_rewrap_on_resize

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

unstable deprecated: 0.58 since: 3.91

vte_terminal_set_scroll_on_keystroke

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.

unstable since: 3.91

vte_terminal_set_scroll_on_output

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.

unstable since: 3.91

vte_terminal_set_scroll_unit_is_pixels

Controls whether the terminal’s scroll unit is lines or pixels.

since: 0.66

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

unstable since: 3.91

vte_terminal_set_size

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.

unstable since: 3.91

vte_terminal_set_text_blink_mode

Controls whether or not the terminal will allow blinking text.

since: 0.52

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

since: 0.40

vte_terminal_spawn_async

A convenience function that wraps creating the VtePty and spawning the child process on it. Like vte_terminal_spawn_with_fds_async(), except that this function does not allow passing file descriptors to the child process. See vte_terminal_spawn_with_fds_async() for more information.

since: 0.48

vte_terminal_spawn_sync

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.

unstable deprecated: 0.48 since: 3.91

vte_terminal_spawn_with_fds_async

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

since: 0.62

vte_terminal_unselect_all

Clears the current selection.

unstable since: 3.91

vte_terminal_watch_child

Watches child_pid. When the process exists, the VteTerminal::child-exited signal will be called with the child’s exit status.

unstable since: 3.91

vte_terminal_write_contents_sync

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

unstable since: 3.91

Methods inherited from GtkWidget (162)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkAccessible (19)
gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

unstable since: 4.14

gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

unstable since: 4.10

gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

unstable since: 4.0

gtk_accessible_get_at_context

Retrieves the accessible implementation for the given GtkAccessible.

unstable since: 4.10

gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

unstable since: 4.10

gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

unstable since: 4.10

gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

unstable since: 4.10

gtk_accessible_get_platform_state

Query a platform state, such as focus.

unstable since: 4.10

gtk_accessible_reset_property

Resets the accessible property to its default value.

unstable since: 4.0

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

unstable since: 4.0

gtk_accessible_reset_state

Resets the accessible state to its default value.

unstable since: 4.0

gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

unstable since: 4.10

gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of self.

unstable since: 4.10

gtk_accessible_update_property

Updates a list of accessible properties.

unstable since: 4.0

gtk_accessible_update_property_value

Updates an array of accessible properties.

unstable since: 4.0

gtk_accessible_update_relation

Updates a list of accessible relations.

unstable since: 4.0

gtk_accessible_update_relation_value

Updates an array of accessible relations.

unstable since: 4.0

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

unstable since: 4.0

gtk_accessible_update_state_value

Updates an array of accessible states.

unstable since: 4.0

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

unstable since: 4.0

Methods inherited from GtkScrollable (9)
gtk_scrollable_get_border

Returns the size of a non-scrolling border around the outside of the scrollable.

unstable since: 4.0

gtk_scrollable_get_hadjustment

Retrieves the GtkAdjustment used for horizontal scrolling.

unstable since: 4.0

gtk_scrollable_get_hscroll_policy

Gets the horizontal GtkScrollablePolicy.

unstable since: 4.0

gtk_scrollable_get_vadjustment

Retrieves the GtkAdjustment used for vertical scrolling.

unstable since: 4.0

gtk_scrollable_get_vscroll_policy

Gets the vertical GtkScrollablePolicy.

unstable since: 4.0

gtk_scrollable_set_hadjustment

Sets the horizontal adjustment of the GtkScrollable.

unstable since: 4.0

gtk_scrollable_set_hscroll_policy

Sets the GtkScrollablePolicy.

unstable since: 4.0

gtk_scrollable_set_vadjustment

Sets the vertical adjustment of the GtkScrollable.

unstable since: 4.0

gtk_scrollable_set_vscroll_policy

Sets the GtkScrollablePolicy.

unstable since: 4.0

Properties

Vte.Terminal:allow-bold

Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.

unstable deprecated: 0.60 since: 3.91

Vte.Terminal:allow-hyperlink

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

since: 0.50

Vte.Terminal:audible-bell

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

unstable since: 3.91

Vte.Terminal:backspace-binding

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

unstable since: 3.91

Vte.Terminal:bold-is-bright

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:cell-height-scale

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

since: 0.52

Vte.Terminal:cell-width-scale

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

since: 0.52

Vte.Terminal:cjk-ambiguous-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.)

unstable since: 3.91

Vte.Terminal:current-directory-uri

The current directory URI, or NULL if unset.

unstable since: 3.91

Vte.Terminal:current-file-uri

The current file URI, or NULL if unset.

unstable since: 3.91

Vte.Terminal:cursor-blink-mode

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

unstable since: 3.91

Vte.Terminal:cursor-shape

Controls the shape of the cursor.

unstable since: 3.91

Vte.Terminal:delete-binding

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

unstable since: 3.91

Vte.Terminal:enable-bidi

Controls whether or not the terminal will perform bidirectional text rendering.

since: 0.58

Vte.Terminal:enable-fallback-scrolling
No description available.

unstable since: 3.91

Vte.Terminal:enable-shaping

Controls whether or not the terminal will shape Arabic text.

since: 0.58

Vte.Terminal:enable-sixel

Controls whether SIXEL image support is enabled.

since: 0.62

Vte.Terminal:encoding

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.

unstable deprecated: 0.54 since: 3.91

Vte.Terminal:font-desc

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.

unstable since: 3.91

Vte.Terminal:font-options

The terminal’s font options, or NULL to use the default font options.

since: 0.74

Vte.Terminal:font-scale

The terminal’s font scale.

unstable since: 3.91

Vte.Terminal:hyperlink-hover-uri

The currently hovered hyperlink URI, or NULL if unset.

since: 0.50

Vte.Terminal:icon-title
No description available.

unstable deprecated: 0.54 since: 3.91

Vte.Terminal:input-enabled

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.

unstable since: 3.91

Vte.Terminal:pointer-autohide

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.

unstable since: 3.91

Vte.Terminal:pty

The PTY object for the terminal.

unstable since: 3.91

Vte.Terminal:rewrap-on-resize

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

unstable deprecated: 0.58 since: 3.91

Vte.Terminal:scroll-on-keystroke

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.

unstable since: 3.91

Vte.Terminal:scroll-on-output

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.

unstable since: 3.91

Vte.Terminal:scroll-unit-is-pixels

Controls whether the terminal’s GtkAdjustment values unit is lines or pixels. This can be enabled when the terminal is the child of a GtkScrolledWindow to fix some bugs with its kinetic scrolling.

since: 0.66

Vte.Terminal:scrollback-lines

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.

unstable since: 3.91

Vte.Terminal:text-blink-mode

Controls whether or not the terminal will allow blinking text.

since: 0.52

Vte.Terminal:window-title

The terminal’s title.

unstable since: 3.91

Vte.Terminal:word-char-exceptions

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.

since: 0.40

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

unstable since: 4.0

Gtk.Widget:can-target

Whether the widget can receive pointer events.

unstable since: 4.0

Gtk.Widget:css-classes

A list of css classes applied to this widget.

unstable since: 4.0

Gtk.Widget:css-name

The name of this widget in the CSS tree.

unstable since: 4.0

Gtk.Widget:cursor

The cursor used by widget.

unstable since: 4.0

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

unstable since: 4.0

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

unstable since: 4.0

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

unstable since: 4.0

Gtk.Widget:has-default

Whether the widget is the default widget.

unstable since: 4.0

Gtk.Widget:has-focus

Whether the widget has the input focus.

unstable since: 4.0

Gtk.Widget:has-tooltip

Enables or disables the emission of the ::query-tooltip signal on widget.

unstable since: 4.0

Gtk.Widget:height-request

Override for height request of the widget.

unstable since: 4.0

Gtk.Widget:hexpand

Whether to expand horizontally.

unstable since: 4.0

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

unstable since: 4.0

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

unstable since: 4.0

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

unstable since: 4.0

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

unstable since: 4.0

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

unstable since: 4.0

Gtk.Widget:margin-top

Margin on top side of widget.

unstable since: 4.0

Gtk.Widget:name

The name of the widget.

unstable since: 4.0

Gtk.Widget:opacity

The requested opacity of the widget.

unstable since: 4.0

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

unstable since: 4.0

Gtk.Widget:parent

The parent widget of this widget.

unstable since: 4.0

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

unstable since: 4.0

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

unstable since: 4.0

Gtk.Widget:scale-factor

The scale factor of the widget.

unstable since: 4.0

Gtk.Widget:sensitive

Whether the widget responds to input.

unstable since: 4.0

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

unstable since: 4.0

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

unstable since: 4.0

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

unstable since: 4.0

Gtk.Widget:vexpand

Whether to expand vertically.

unstable since: 4.0

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

unstable since: 4.0

Gtk.Widget:visible

Whether the widget is visible.

unstable since: 4.0

Gtk.Widget:width-request

Override for width request of the widget.

unstable since: 4.0

Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

unstable since: 4.0

Properties inherited from GtkScrollable (4)
Gtk.Scrollable:hadjustment

Horizontal GtkAdjustment of the scrollable widget.

unstable since: 4.0

Gtk.Scrollable:hscroll-policy

Determines when horizontal scrolling should start.

unstable since: 4.0

Gtk.Scrollable:vadjustment

Vertical GtkAdjustment of the scrollable widget.

unstable since: 4.0

Gtk.Scrollable:vscroll-policy

Determines when vertical scrolling should start.

unstable since: 4.0

Signals

Vte.Terminal::bell

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

unstable since: 3.91

Vte.Terminal::char-size-changed

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

unstable since: 3.91

Vte.Terminal::child-exited

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

unstable since: 3.91

Vte.Terminal::commit

Emitted whenever the terminal receives input from the user and prepares to send it to the child process.

unstable since: 3.91

Vte.Terminal::contents-changed

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

unstable since: 3.91

Vte.Terminal::copy-clipboard

Emitted whenever vte_terminal_copy_clipboard() is called.

unstable since: 3.91

Vte.Terminal::current-directory-uri-changed

Emitted when the current directory URI is modified.

unstable since: 3.91

Vte.Terminal::current-file-uri-changed

Emitted when the current file URI is modified.

unstable since: 3.91

Vte.Terminal::cursor-moved

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

unstable since: 3.91

Vte.Terminal::decrease-font-size

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

unstable since: 3.91

Vte.Terminal::deiconify-window

Never emitted.

unstable deprecated: 0.60 since: 3.91

Vte.Terminal::encoding-changed

Emitted whenever the terminal’s current encoding has changed.

unstable since: 3.91

Vte.Terminal::eof

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 VteTerminal::child-exited signal.

unstable since: 3.91

Vte.Terminal::hyperlink-hover-uri-changed

Emitted when the hovered hyperlink changes.

since: 0.50

Vte.Terminal::icon-title-changed
No description available.

unstable deprecated: 0.54 since: 3.91

Vte.Terminal::iconify-window

Never emitted.

unstable deprecated: 0.60 since: 3.91

Vte.Terminal::increase-font-size

Emitted when the user hits the ‘+’ key while holding the Control key.

unstable since: 3.91

Vte.Terminal::lower-window

Never emitted.

unstable deprecated: 0.60 since: 3.91

Vte.Terminal::maximize-window

Never emitted.

unstable deprecated: 0.60 since: 3.91

Vte.Terminal::move-window

Never emitted.

unstable deprecated: 0.60 since: 3.91

Vte.Terminal::paste-clipboard

Emitted whenever vte_terminal_paste_clipboard() is called.

unstable since: 3.91

Vte.Terminal::raise-window

Never emitted.

unstable deprecated: 0.60 since: 3.91

Vte.Terminal::refresh-window

Never emitted.

unstable deprecated: 0.60 since: 3.91

Vte.Terminal::resize-window

Emitted at the child application’s request.

unstable since: 3.91

Vte.Terminal::restore-window

Never emitted.

unstable deprecated: 0.60 since: 3.91

Vte.Terminal::selection-changed

Emitted whenever the contents of terminal’s selection changes.

unstable since: 3.91

Vte.Terminal::window-title-changed

Emitted when the VteTerminal:window-title property is modified.

unstable since: 3.91

Signals inherited from GtkWidget (13)
GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

unstable since: 4.0

GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

unstable since: 4.0

GtkWidget::hide

Emitted when widget is hidden.

unstable since: 4.0

GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

unstable since: 4.0

GtkWidget::map

Emitted when widget is going to be mapped.

unstable since: 4.0

GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

unstable since: 4.0

GtkWidget::move-focus

Emitted when the focus is moved.

unstable since: 4.0

GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

unstable since: 4.0

GtkWidget::realize

Emitted when widget is associated with a GdkSurface.

unstable since: 4.0

GtkWidget::show

Emitted when widget is shown.

unstable since: 4.0

GtkWidget::state-flags-changed

Emitted when the widget state changes.

unstable since: 4.0

GtkWidget::unmap

Emitted when widget is going to be unmapped.

unstable since: 4.0

GtkWidget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

unstable since: 4.0

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

unstable since: 2.0

Class structure

struct VteTerminalClass {
  GtkWidgetClass parent_class;
  void (* eof) (
    VteTerminal* terminal
  );
  void (* child_exited) (
    VteTerminal* terminal,
    int status
  );
  void (* encoding_changed) (
    VteTerminal* terminal
  );
  void (* char_size_changed) (
    VteTerminal* terminal,
    guint char_width,
    guint char_height
  );
  void (* window_title_changed) (
    VteTerminal* terminal
  );
  void (* icon_title_changed) (
    VteTerminal* terminal
  );
  void (* selection_changed) (
    VteTerminal* terminal
  );
  void (* contents_changed) (
    VteTerminal* terminal
  );
  void (* cursor_moved) (
    VteTerminal* terminal
  );
  void (* commit) (
    VteTerminal* terminal,
    const gchar* text,
    guint size
  );
  void (* deiconify_window) (
    VteTerminal* terminal
  );
  void (* iconify_window) (
    VteTerminal* terminal
  );
  void (* raise_window) (
    VteTerminal* terminal
  );
  void (* lower_window) (
    VteTerminal* terminal
  );
  void (* refresh_window) (
    VteTerminal* terminal
  );
  void (* restore_window) (
    VteTerminal* terminal
  );
  void (* maximize_window) (
    VteTerminal* terminal
  );
  void (* resize_window) (
    VteTerminal* terminal,
    guint width,
    guint height
  );
  void (* move_window) (
    VteTerminal* terminal,
    guint x,
    guint y
  );
  void (* increase_font_size) (
    VteTerminal* terminal
  );
  void (* decrease_font_size) (
    VteTerminal* terminal
  );
  void (* copy_clipboard) (
    VteTerminal* terminal
  );
  void (* paste_clipboard) (
    VteTerminal* terminal
  );
  void (* bell) (
    VteTerminal* terminal
  );
  None _padding;
  VteTerminalClassPrivate* priv;
  
}

All of these fields should be considered read-only, except for derived classes.

Class members
parent_class: GtkWidgetClass
No description available.
eof: void (* eof) ( VteTerminal* terminal )
No description available.
child_exited: void (* child_exited) ( VteTerminal* terminal, int status )
No description available.
encoding_changed: void (* encoding_changed) ( VteTerminal* terminal )
No description available.
char_size_changed: void (* char_size_changed) ( VteTerminal* terminal, guint char_width, guint char_height )
No description available.
window_title_changed: void (* window_title_changed) ( VteTerminal* terminal )
No description available.
icon_title_changed: void (* icon_title_changed) ( VteTerminal* terminal )
No description available.
selection_changed: void (* selection_changed) ( VteTerminal* terminal )
No description available.
contents_changed: void (* contents_changed) ( VteTerminal* terminal )
No description available.
cursor_moved: void (* cursor_moved) ( VteTerminal* terminal )
No description available.
commit: void (* commit) ( VteTerminal* terminal, const gchar* text, guint size )
No description available.
deiconify_window: void (* deiconify_window) ( VteTerminal* terminal )
No description available.
iconify_window: void (* iconify_window) ( VteTerminal* terminal )
No description available.
raise_window: void (* raise_window) ( VteTerminal* terminal )
No description available.
lower_window: void (* lower_window) ( VteTerminal* terminal )
No description available.
refresh_window: void (* refresh_window) ( VteTerminal* terminal )
No description available.
restore_window: void (* restore_window) ( VteTerminal* terminal )
No description available.
maximize_window: void (* maximize_window) ( VteTerminal* terminal )
No description available.
resize_window: void (* resize_window) ( VteTerminal* terminal, guint width, guint height )
No description available.
move_window: void (* move_window) ( VteTerminal* terminal, guint x, guint y )
No description available.
increase_font_size: void (* increase_font_size) ( VteTerminal* terminal )
No description available.
decrease_font_size: void (* decrease_font_size) ( VteTerminal* terminal )
No description available.
copy_clipboard: void (* copy_clipboard) ( VteTerminal* terminal )
No description available.
paste_clipboard: void (* paste_clipboard) ( VteTerminal* terminal )
No description available.
bell: void (* bell) ( VteTerminal* terminal )
No description available.
_padding: None
No description available.
priv: VteTerminalClassPrivate*
No description available.

Virtual methods

Vte.TerminalClass.bell
No description available.

unstable since: 3.91

Vte.TerminalClass.char_size_changed
No description available.

unstable since: 3.91

Vte.TerminalClass.child_exited
No description available.

unstable since: 3.91

Vte.TerminalClass.commit
No description available.

unstable since: 3.91

Vte.TerminalClass.contents_changed
No description available.

unstable since: 3.91

Vte.TerminalClass.copy_clipboard

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

unstable deprecated: 0.50 since: 3.91

Vte.TerminalClass.cursor_moved
No description available.

unstable since: 3.91

Vte.TerminalClass.decrease_font_size
No description available.

unstable since: 3.91

Vte.TerminalClass.deiconify_window
No description available.

unstable since: 3.91

Vte.TerminalClass.encoding_changed
No description available.

unstable since: 3.91

Vte.TerminalClass.eof
No description available.

unstable since: 3.91

Vte.TerminalClass.icon_title_changed
No description available.

unstable since: 3.91

Vte.TerminalClass.iconify_window
No description available.

unstable since: 3.91

Vte.TerminalClass.increase_font_size
No description available.

unstable since: 3.91

Vte.TerminalClass.lower_window
No description available.

unstable since: 3.91

Vte.TerminalClass.maximize_window
No description available.

unstable since: 3.91

Vte.TerminalClass.move_window
No description available.

unstable since: 3.91

Vte.TerminalClass.paste_clipboard

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.

unstable since: 3.91

Vte.TerminalClass.raise_window
No description available.

unstable since: 3.91

Vte.TerminalClass.refresh_window
No description available.

unstable since: 3.91

Vte.TerminalClass.resize_window
No description available.

unstable since: 3.91

Vte.TerminalClass.restore_window
No description available.

unstable since: 3.91

Vte.TerminalClass.selection_changed
No description available.

unstable since: 3.91

Vte.TerminalClass.window_title_changed
No description available.

unstable since: 3.91