### Class

# Vte Terminal

#### Description

    class Vte.Terminal : Gtk.Widget
      implements Atk.ImplementorIface, Gtk.Buildable, Gtk.Scrollable {
      /* No available fields */
    }

No description available.

#### Hierarchy

#### Ancestors

- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- AtkImplementorIface
- GtkBuildable
- GtkScrollable

#### Constructors

###### vte_terminal_new

Creates a new terminal widget.

#### Instance methods

###### vte_terminal_copy_clipboard

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

deprecated: 0.50

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

###### vte_terminal_dup_termprop_string

Returns the value of a `VTE_PROPERTY_STRING` termprop, or `NULL` if `prop` is unset, or `prop` is not a registered property.

since: 0.78

###### vte_terminal_dup_termprop_string_by_id

Like `vte_terminal_dup_termprop_string()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

###### vte_terminal_dup_termprop_uuid

Returns the value of a `VTE_PROPERTY_UUID` termprop as a `VteUuid`, or `NULL` if `prop` is unset, or `prop` is not a registered property.

since: 0.78

###### vte_terminal_dup_termprop_uuid_by_id

Like `vte_terminal_dup_termprop_uuid()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

###### vte_terminal_event_check_gregex_simple

This function does nothing.

deprecated: 0.46 since: 0.44

###### vte_terminal_event_check_regex_array

Like vte_terminal_event_check_regex_simple(), 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.62

###### vte_terminal_event_check_regex_simple

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. Each non-`NULL` element of `matches` should be freed with g_free().

since: 0.46

###### vte_terminal_feed

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

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

###### vte_terminal_feed_child_binary

Sends a block of binary data to the child.

deprecated: 0.60

###### vte_terminal_get_allow_bold

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

deprecated: 0.60

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

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

###### vte_terminal_get_char_width

No description available.

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

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

###### vte_terminal_get_context_menu

No description available.

since: 0.76

###### vte_terminal_get_context_menu_model

No description available.

since: 0.76

###### vte_terminal_get_current_directory_uri

No description available.

deprecated: 0.78

###### vte_terminal_get_current_file_uri

No description available.

deprecated: 0.78

###### vte_terminal_get_cursor_blink_mode

Returns the currently set cursor blink mode.

###### vte_terminal_get_cursor_position

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

###### vte_terminal_get_cursor_shape

Returns the currently set cursor shape.

###### vte_terminal_get_enable_a11y

Checks whether the terminal communicates with a11y backends.

since: 0.78

###### 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_legacy_osc777

No description available.

since: 0.78

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

deprecated: 0.54

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

###### vte_terminal_get_font_options

No description available.

since: 0.74

###### vte_terminal_get_font_scale

No description available.

###### vte_terminal_get_geometry_hints

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.

deprecated: 0.52

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

###### vte_terminal_get_icon_title

No description available.

deprecated: 0.54

###### vte_terminal_get_input_enabled

Returns whether the terminal allow user input.

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

###### vte_terminal_get_pty

Returns the `VtePty` of `terminal`.

###### vte_terminal_get_rewrap_on_resize

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

deprecated: 0.58

###### vte_terminal_get_row_count

No description available.

###### vte_terminal_get_scroll_on_insert

No description available.

since: 0.76

###### 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_termprop_bool

For a `VTE_PROPERTY_BOOL` termprop, sets `value` to `prop`‘s value, or to `FALSE` if `prop` is unset, or `prop` is not a registered property.

since: 0.78

###### vte_terminal_get_termprop_bool_by_id

Like `vte_terminal_get_termprop_bool()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

###### vte_terminal_get_termprop_data

Returns the value of a `VTE_PROPERTY_DATA` termprop, or `NULL` if `prop` is unset, or `prop` is not a registered property.

since: 0.78

###### vte_terminal_get_termprop_data_by_id

Like `vte_terminal_get_termprop_data()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

###### vte_terminal_get_termprop_double

For a `VTE_PROPERTY_DOUBLE` termprop, sets `value` to `prop`‘s value, which is finite; or to 0.0 if `prop` is unset, or `prop` is not a registered property.

since: 0.78

###### vte_terminal_get_termprop_double_by_id

Like `vte_terminal_get_termprop_double()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

###### vte_terminal_get_termprop_enum

See `vte_properties_get_property_enum()` for more information.

since: 0.82

###### vte_terminal_get_termprop_enum_by_id

Like `vte_terminal_get_termprop_enum()` except that it takes the property by ID. See that function for more information.

since: 0.82

###### vte_terminal_get_termprop_flags

See `vte_properties_get_property_flags()` for more information.

since: 0.82

###### vte_terminal_get_termprop_flags_by_id

Like `vte_terminal_get_termprop_flags()` except that it takes the property by ID. See that function for more information.

since: 0.82

###### vte_terminal_get_termprop_int

For a `VTE_PROPERTY_INT` termprop, sets `value` to `prop`‘s value, or to 0 if `prop` is unset, or if `prop` is not a registered property.

since: 0.78

###### vte_terminal_get_termprop_int_by_id

Like `vte_terminal_get_termprop_int()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

###### vte_terminal_get_termprop_rgba

Stores the value of a `VTE_PROPERTY_RGB` or `VTE_PROPERTY_RGBA` termprop in `color` and returns `TRUE` if the termprop is set, or stores rgb(0,0,0) or rgba(0,0,0,1) in `color` and returns `FALSE` if the termprop is unset.

since: 0.78

###### vte_terminal_get_termprop_rgba_by_id

Like `vte_terminal_get_termprop_rgba()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

###### vte_terminal_get_termprop_string

Returns the value of a `VTE_PROPERTY_STRING` termprop, or `NULL` if `prop` is unset, or `prop` is not a registered property.

since: 0.78

###### vte_terminal_get_termprop_string_by_id

Like `vte_terminal_get_termprop_string()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

###### vte_terminal_get_termprop_uint

For a `VTE_PROPERTY_UINT` termprop, sets `value` to `prop`‘s value, or to 0 if `prop` is unset, or `prop` is not a registered property.

since: 0.78

###### vte_terminal_get_termprop_uint_by_id

Like `vte_terminal_get_termprop_uint()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

###### vte_terminal_get_termprop_value

Returns `TRUE` with the value of `prop` stored in `value` (if not `NULL`) if, the termprop has a value, or `FALSE` if `prop` is unset, or `prop` is not a registered property; in that case `value` will not be set.

since: 0.78

###### vte_terminal_get_termprop_value_by_id

Like `vte_terminal_get_termprop_value()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

###### vte_terminal_get_text

Extracts a view of the visible part of the terminal.

deprecated: 0.76

###### vte_terminal_get_text_blink_mode

Checks whether or not the terminal will allow blinking text.

since: 0.52

###### vte_terminal_get_text_format

Returns text from the visible part of the terminal in the specified format.

since: 0.76

###### vte_terminal_get_text_include_trailing_spaces

Extracts a view of the visible part of the terminal.

deprecated: 0.56

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

deprecated: 0.76

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

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.

deprecated: 0.78

###### 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_get_xalign

No description available.

since: 0.76

###### vte_terminal_get_xfill

No description available.

since: 0.76

###### vte_terminal_get_yalign

No description available.

since: 0.76

###### vte_terminal_get_yfill

No description available.

since: 0.76

###### vte_terminal_hyperlink_check_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`.

since: 0.50

###### vte_terminal_match_add_gregex

This function does nothing since version 0.60.

deprecated: 0.46

###### 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`.

deprecated: 0.46

###### vte_terminal_match_check_event

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

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

###### vte_terminal_match_remove_all

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

###### 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`.

deprecated: 0.40

###### vte_terminal_match_set_cursor_name

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

###### vte_terminal_match_set_cursor_type

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

deprecated: 0.54

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

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

###### 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 `terminal`‘s size.

###### vte_terminal_ref_termprop_data_bytes

Returns the value of a `VTE_PROPERTY_DATA` termprop as a `GBytes`, or `NULL` if `prop` is unset, or `prop` is not a registered property.

since: 0.78

###### vte_terminal_ref_termprop_data_bytes_by_id

Like `vte_terminal_ref_termprop_data_bytes()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

###### vte_terminal_ref_termprop_image_pixbuf

Returns the value of a `VTE_PROPERTY_IMAGE` termprop as a `GdkPixbuf`, or `NULL` if `prop` is unset, or `prop` is not a registered property.

since: 0.80

###### vte_terminal_ref_termprop_image_pixbuf_by_id

Like `vte_terminal_ref_termprop_image_pixbuf()` except that it takes the termprop by ID. See that function for more information.

since: 0.80

###### vte_terminal_ref_termprop_image_surface

Returns the value of a `VTE_PROPERTY_IMAGE` termprop as a #cairo_surface_t, or `NULL` if `prop` is unset, or `prop` is not a registered property.

since: 0.80

###### vte_terminal_ref_termprop_image_surface_by_id

Like `vte_terminal_ref_termprop_image_surface()` except that it takes the termprop by ID. See that function for more information.

since: 0.80

###### vte_terminal_ref_termprop_uri

Returns the value of a `VTE_PROPERTY_URI` termprop as a `GUri`, or `NULL` if `prop` is unset, or `prop` is not a registered property.

since: 0.78

###### vte_terminal_ref_termprop_uri_by_id

Like `vte_terminal_ref_termprop_uri()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

###### vte_terminal_ref_termprop_variant

Returns the value of `prop` as a `GVariant`, or `NULL` if `prop` unset, or `prop` is not a registered property.

since: 0.78

###### vte_terminal_ref_termprop_variant_by_id

Like `vte_terminal_ref_termprop_variant()` except that it takes the termprop by ID. See that function for more information.

since: 0.78

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

###### vte_terminal_reset_termprop

Resets the termprop `prop` to its default value.

since: 0.84

###### vte_terminal_reset_termprop_by_id

Like `vte_terminal_reset_termprop()` except that it takes the termprop by ID. See that function for more information.

since: 0.84

###### vte_terminal_search_find_next

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

###### vte_terminal_search_find_previous

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

###### vte_terminal_search_get_gregex

No description available.

deprecated: 0.46

###### vte_terminal_search_get_regex

No description available.

since: 0.46

###### vte_terminal_search_get_wrap_around

No description available.

###### vte_terminal_search_set_gregex

This function does nothing since version 0.60.

deprecated: 0.46

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

###### vte_terminal_select_all

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

###### vte_terminal_set_allow_bold

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

deprecated: 0.60

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

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

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

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

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

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

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

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

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

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

###### vte_terminal_set_context_menu

Sets `menu` as the context menu in `terminal`. Use `NULL` to unset the current menu.

since: 0.76

###### vte_terminal_set_context_menu_model

Sets `model` as the context menu model in `terminal`. Use `NULL` to unset the current menu model.

since: 0.76

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

###### vte_terminal_set_cursor_shape

Sets the shape of the cursor drawn.

###### vte_terminal_set_default_colors

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

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

###### vte_terminal_set_enable_a11y

Controls whether or not the terminal will communicate with a11y backends.

since: 0.78

###### 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_legacy_osc777

Sets whether legacy OSC 777 sequences are translated to their corresponding termprops.

since: 0.78

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

deprecated: 0.54

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

###### 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`.

###### vte_terminal_set_geometry_hints_for_window

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

deprecated: 0.52

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

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

###### vte_terminal_set_pty

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

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

deprecated: 0.58

###### vte_terminal_set_scroll_on_insert

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when text is inserted, e.g. by a paste.

since: 0.76

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

since: 0.52

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

since: 0.52

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

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

###### vte_terminal_set_suppress_legacy_signals

Suppress emissions of signals and property notifications that are deprecated.

since: 0.78

###### 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_set_xalign

Sets the horizontal alignment of `terminal` within its allocation.

since: 0.76

###### vte_terminal_set_xfill

Sets the horizontal fillment of `terminal` within its allocation.

since: 0.76

###### vte_terminal_set_yalign

Sets the vertical alignment of `terminal` within its allocation.

since: 0.76

###### vte_terminal_set_yfill

Sets the vertical fillment of `terminal` within its allocation. Note that yfill is only supported with yalign set to `VTE_ALIGN_START`, and is ignored for all other yalign values.

since: 0.76

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

deprecated: 0.48

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

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

###### vte_terminal_write_contents_sync

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

##### Methods inherited from GtkWidget (263)

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 GtkBuildable (10)

###### gtk_buildable_add_child

Adds a child to `buildable`. `type` is an optional string describing how the child should be added.

###### gtk_buildable_construct_child

Constructs a child of `buildable` with the name `name`.

###### gtk_buildable_custom_finished

This is similar to `gtk_buildable_parser_finished()` but is called once for each custom tag handled by the `buildable`.

###### gtk_buildable_custom_tag_end

This is called at the end of each custom element handled by the buildable.

###### gtk_buildable_custom_tag_start

This is called for each unknown element under `<child>`.

###### gtk_buildable_get_internal_child

Get the internal child called `childname` of the `buildable` object.

###### gtk_buildable_get_name

Gets the name of the `buildable` object.

###### gtk_buildable_parser_finished

Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time `gtk_builder_add_from_file()` or `gtk_builder_add_from_string()` is called on a builder.

###### gtk_buildable_set_buildable_property

Sets the property name `name` to `value` on the `buildable` object.

###### gtk_buildable_set_name

Sets the name of the `buildable` object.

##### Methods inherited from GtkScrollable (9)

###### gtk_scrollable_get_border

Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK+ can use this information to display overlayed graphics, like the overshoot indication, at the right position.

###### gtk_scrollable_get_hadjustment

Retrieves the `GtkAdjustment` used for horizontal scrolling.

###### gtk_scrollable_get_hscroll_policy

Gets the horizontal `GtkScrollablePolicy`.

###### gtk_scrollable_get_vadjustment

Retrieves the `GtkAdjustment` used for vertical scrolling.

###### gtk_scrollable_get_vscroll_policy

Gets the vertical `GtkScrollablePolicy`.

###### gtk_scrollable_set_hadjustment

Sets the horizontal adjustment of the `GtkScrollable`.

###### gtk_scrollable_set_hscroll_policy

Sets the `GtkScrollablePolicy` to determine whether horizontal scrolling should start below the minimum width or below the natural width.

###### gtk_scrollable_set_vadjustment

Sets the vertical adjustment of the `GtkScrollable`.

###### gtk_scrollable_set_vscroll_policy

Sets the `GtkScrollablePolicy` to determine whether vertical scrolling should start below the minimum height or below the natural height.

#### Properties

###### Vte.Terminal:allow-bold

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

deprecated: 0.60

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

###### Vte.Terminal:backspace-binding

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

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

###### Vte.Terminal:context-menu

The menu used for context menus. Note that context menu model set with the `VteTerminal::context-menu-model` property or `vte_terminal_set_context_menu_model()` takes precedence over this.

since: 0.76

###### Vte.Terminal:context-menu-model

The menu model used for context menus. If non-`NULL`, the context menu is generated from this model, and overrides a context menu set with the `VteTerminal::context-menu` property or vte_terminal_set_context_menu().

since: 0.76

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

The current directory URI, or `NULL` if unset.

deprecated: 0.78

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

The current file URI, or `NULL` if unset.

deprecated: 0.78

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

###### Vte.Terminal:cursor-shape

Controls the shape of the cursor.

###### Vte.Terminal:delete-binding

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

###### Vte.Terminal:enable-a11y

Controls whether or not a11y is enabled for the widget.

since: 0.78

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

###### Vte.Terminal:enable-legacy-osc777

Whether legacy OSC 777 sequences are translated to their corresponding termprops.

since: 0.78

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

deprecated: 0.54

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

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

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

The currently hovered hyperlink URI, or `NULL` if unset.

since: 0.50

###### Vte.Terminal:icon-title

No description available.

deprecated: 0.54

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

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

###### Vte.Terminal:pty

The PTY object for the terminal.

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

deprecated: 0.58

###### Vte.Terminal:scroll-on-insert

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the text is inserted (e.g. by a paste).

since: 0.76

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

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

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

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

deprecated: 0.78

###### 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

###### Vte.Terminal:xalign

The horizontal alignment of `terminal` within its allocation.

since: 0.76

###### Vte.Terminal:xfill

The horizontal fillment of `terminal` within its allocation.

since: 0.76

###### Vte.Terminal:yalign

The vertical alignment of `terminal` within its allocation.

since: 0.76

###### Vte.Terminal:yfill

The vertical fillment of `terminal` within its allocation. Note that `VteTerminal:yfill`=`TRUE` is only supported with `VteTerminal:yalign`=`VTE_ALIGN_START`, and is ignored for all other yalign values.

since: 0.76

##### Properties inherited from GtkWidget (39)

###### Gtk.Widget:app-paintable

No description available.

###### Gtk.Widget:can-default

No description available.

###### Gtk.Widget:can-focus

No description available.

###### Gtk.Widget:composite-child

No description available.

###### Gtk.Widget:double-buffered

Whether the widget is double buffered.

###### Gtk.Widget:events

No description available.

###### Gtk.Widget:expand

Whether to expand in both directions. Setting this sets both `GtkWidget:hexpand` and `GtkWidget:vexpand`.

###### Gtk.Widget:focus-on-click

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

###### Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space, see `GtkAlign`.

###### Gtk.Widget:has-default

No description available.

###### Gtk.Widget:has-focus

No description available.

###### Gtk.Widget:has-tooltip

Enables or disables the emission of `GtkWidget::query-tooltip` on `widget`. A value of `TRUE` indicates that `widget` can have a tooltip, in this case the widget will be queried using `GtkWidget::query-tooltip` to determine whether it will provide a tooltip or not.

###### Gtk.Widget:height-request

No description available.

###### Gtk.Widget:hexpand

Whether to expand horizontally. See gtk_widget_set_hexpand().

###### Gtk.Widget:hexpand-set

Whether to use the `GtkWidget:hexpand` property. See gtk_widget_get_hexpand_set().

###### Gtk.Widget:is-focus

No description available.

###### Gtk.Widget:margin

Sets all four sides’ margin at once. If read, returns max margin on any side.

###### Gtk.Widget:margin-bottom

Margin on bottom side of widget.

###### Gtk.Widget:margin-end

Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.

###### Gtk.Widget:margin-left

Margin on left side of widget.

###### Gtk.Widget:margin-right

Margin on right side of widget.

###### Gtk.Widget:margin-start

Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.

###### Gtk.Widget:margin-top

Margin on top side of widget.

###### Gtk.Widget:name

No description available.

###### Gtk.Widget:no-show-all

No description available.

###### Gtk.Widget:opacity

The requested opacity of the widget. See `gtk_widget_set_opacity()` for more details about window opacity.

###### Gtk.Widget:parent

No description available.

###### Gtk.Widget:receives-default

No description available.

###### Gtk.Widget:scale-factor

The scale factor of the widget. See `gtk_widget_get_scale_factor()` for more details about widget scaling.

###### Gtk.Widget:sensitive

No description available.

###### Gtk.Widget:style

The style of the widget, which contains information about how it will look (colors, etc).

###### Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_tooltip_set_markup().

###### Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

###### Gtk.Widget:valign

How to distribute vertical space if widget gets extra space, see `GtkAlign`.

###### Gtk.Widget:vexpand

Whether to expand vertically. See gtk_widget_set_vexpand().

###### Gtk.Widget:vexpand-set

Whether to use the `GtkWidget:vexpand` property. See gtk_widget_get_vexpand_set().

###### Gtk.Widget:visible

No description available.

###### Gtk.Widget:width-request

No description available.

###### Gtk.Widget:window

The widget’s window if it is realized, `NULL` otherwise.

##### Properties inherited from GtkScrollable (4)

###### Gtk.Scrollable:hadjustment

Horizontal `GtkAdjustment` of the scrollable widget. This adjustment is shared between the scrollable widget and its parent.

###### Gtk.Scrollable:hscroll-policy

Determines whether horizontal scrolling should start once the scrollable widget is allocated less than its minimum width or less than its natural width.

###### Gtk.Scrollable:vadjustment

Verical `GtkAdjustment` of the scrollable widget. This adjustment is shared between the scrollable widget and its parent.

###### Gtk.Scrollable:vscroll-policy

Determines whether vertical scrolling should start once the scrollable widget is allocated less than its minimum height or less than its natural height.

#### Signals

###### Vte.Terminal::bell

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

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

###### Vte.Terminal::child-exited

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

###### Vte.Terminal::commit

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

###### Vte.Terminal::contents-changed

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

###### Vte.Terminal::copy-clipboard

Emitted whenever `vte_terminal_copy_clipboard()` is called.

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

Emitted when the current directory URI is modified.

deprecated: 0.78

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

Emitted when the current file URI is modified.

deprecated: 0.78

###### Vte.Terminal::cursor-moved

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

###### Vte.Terminal::decrease-font-size

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

###### Vte.Terminal::deiconify-window

Never emitted.

deprecated: 0.60

###### Vte.Terminal::encoding-changed

Emitted whenever the terminal’s current encoding has changed.

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

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

Emitted when the hovered hyperlink changes.

since: 0.50

###### Vte.Terminal::icon-title-changed

No description available.

deprecated: 0.54

###### Vte.Terminal::iconify-window

Never emitted.

deprecated: 0.60

###### Vte.Terminal::increase-font-size

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

###### Vte.Terminal::lower-window

Never emitted.

deprecated: 0.60

###### Vte.Terminal::maximize-window

Never emitted.

deprecated: 0.60

###### Vte.Terminal::move-window

Never emitted.

deprecated: 0.60

###### Vte.Terminal::paste-clipboard

Emitted whenever `vte_terminal_paste_clipboard()` is called.

###### Vte.Terminal::raise-window

Never emitted.

deprecated: 0.60

###### Vte.Terminal::refresh-window

Never emitted.

deprecated: 0.60

###### Vte.Terminal::resize-window

Emitted at the child application’s request.

###### Vte.Terminal::restore-window

Never emitted.

deprecated: 0.60

###### Vte.Terminal::selection-changed

Emitted whenever the contents of terminal’s selection changes.

###### Vte.Terminal::setup-context-menu

Emitted with non-`NULL` context before `terminal` shows a context menu. The handler may set either a menu model using vte_terminal_set_context_menu_model(), or a menu using vte_terminal_set_context_menu(), which will then be used as context menu, or keep a previously set context menu or context menu model, but update the menu and/or its `GAction:s` visibility and sensitivity. If neither a menu model nor a menu are set, a context menu will not be shown.

###### Vte.Terminal::termprop-changed

The “termprop-changed” signal is emitted when a termprop has changed or been reset.

since: 0.78

###### Vte.Terminal::termprops-changed

Emitted when termprops have changed. `props` is an array containing the IDs of the terminal properties that may have changed since the last emission of this signal, in an undefined order. Note that emission of this signal is delayed from the receipt of the OSC sequences, and a termprop may have been changed more than once inbetween signal emissions, but only the value set last is retrievable.

since: 0.78

###### Vte.Terminal::text-deleted

No description available.

deprecated: 0.66

###### Vte.Terminal::text-inserted

No description available.

deprecated: 0.66

###### Vte.Terminal::text-modified

No description available.

deprecated: 0.66

###### Vte.Terminal::text-scrolled

No description available.

deprecated: 0.66

###### Vte.Terminal::window-title-changed

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

deprecated: 0.78

##### Signals inherited from GtkWidget (69)

###### GtkWidget::accel-closures-changed

No description available.

###### GtkWidget::button-press-event

The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed.

###### GtkWidget::button-release-event

The ::button-release-event signal will be emitted when a button (typically from a mouse) is released.

###### GtkWidget::can-activate-accel

Determines whether an accelerator that activates the signal identified by `signal_id` can currently be activated. This signal is present to allow applications and derived widgets to override the default `GtkWidget` handling for determining whether an accelerator can be activated.

###### GtkWidget::child-notify

The ::child-notify signal is emitted for each [child property][child-properties] that has changed on an object. The signal’s detail holds the property name.

###### GtkWidget::composited-changed

The ::composited-changed signal is emitted when the composited status of `widgets` screen changes. See gdk_screen_is_composited().

###### GtkWidget::configure-event

The ::configure-event signal will be emitted when the size, position or stacking of the `widget`‘s window has changed.

###### GtkWidget::damage-event

Emitted when a redirected window belonging to `widget` gets drawn into. The region/area members of the event shows what area of the redirected drawable was drawn into.

###### GtkWidget::delete-event

The ::delete-event signal is emitted if a user requests that a toplevel window is closed. The default handler for this signal destroys the window. Connecting `gtk_widget_hide_on_delete()` to this signal will cause the window to be hidden instead, so that it can later be shown again without reconstructing it.

###### GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold. May result in finalization of the widget if all references are released.

###### GtkWidget::destroy-event

The ::destroy-event signal is emitted when a `GdkWindow` is destroyed. You rarely get this signal, because most widgets disconnect themselves from their window before they destroy it, so no widget owns the window at destroy time.

###### GtkWidget::direction-changed

The ::direction-changed signal is emitted when the text direction of a widget changes.

###### GtkWidget::drag-begin

The ::drag-begin signal is emitted on the drag source when a drag is started. A typical reason to connect to this signal is to set up a custom drag icon with e.g. gtk_drag_source_set_icon_pixbuf().

###### GtkWidget::drag-data-delete

The ::drag-data-delete signal is emitted on the drag source when a drag with the action `GDK_ACTION_MOVE` is successfully completed. The signal handler is responsible for deleting the data that has been dropped. What “delete” means depends on the context of the drag operation.

###### GtkWidget::drag-data-get

The ::drag-data-get signal is emitted on the drag source when the drop site requests the data which is dragged. It is the responsibility of the signal handler to fill `data` with the data in the format which is indicated by `info`. See `gtk_selection_data_set()` and gtk_selection_data_set_text().

###### GtkWidget::drag-data-received

The ::drag-data-received signal is emitted on the drop site when the dragged data has been received. If the data was received in order to determine whether the drop will be accepted, the handler is expected to call `gdk_drag_status()` and not finish the drag. If the data was received in response to a `GtkWidget::drag-drop` signal (and this is the last target to be received), the handler for this signal is expected to process the received data and then call gtk_drag_finish(), setting the `success` parameter depending on whether the data was processed successfully.

###### GtkWidget::drag-drop

The ::drag-drop signal is emitted on the drop site when the user drops the data onto the widget. The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns `FALSE` and no further processing is necessary. Otherwise, the handler returns `TRUE`. In this case, the handler must ensure that `gtk_drag_finish()` is called to let the source know that the drop is done. The call to `gtk_drag_finish()` can be done either directly or in a `GtkWidget::drag-data-received` handler which gets triggered by calling `gtk_drag_get_data()` to receive the data for one or more of the supported targets.

###### GtkWidget::drag-end

The ::drag-end signal is emitted on the drag source when a drag is finished. A typical reason to connect to this signal is to undo things done in `GtkWidget::drag-begin`.

###### GtkWidget::drag-failed

The ::drag-failed signal is emitted on the drag source when a drag has failed. The signal handler may hook custom code to handle a failed DnD operation based on the type of error, it returns `TRUE` is the failure has been already handled (not showing the default “drag operation failed” animation), otherwise it returns `FALSE`.

###### GtkWidget::drag-leave

The ::drag-leave signal is emitted on the drop site when the cursor leaves the widget. A typical reason to connect to this signal is to undo things done in `GtkWidget::drag-motion`, e.g. undo highlighting with gtk_drag_unhighlight().

###### GtkWidget::drag-motion

The ::drag-motion signal is emitted on the drop site when the user moves the cursor over the widget during a drag. The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns `FALSE` and no further processing is necessary. Otherwise, the handler returns `TRUE`. In this case, the handler is responsible for providing the necessary information for displaying feedback to the user, by calling gdk_drag_status().

###### GtkWidget::draw

This signal is emitted when a widget is supposed to render itself. The `widget`‘s top left corner must be painted at the origin of the passed in context and be sized to the values returned by `gtk_widget_get_allocated_width()` and gtk_widget_get_allocated_height().

###### GtkWidget::enter-notify-event

The ::enter-notify-event will be emitted when the pointer enters the `widget`‘s window.

###### GtkWidget::event

The GTK+ main loop will emit three signals for each GDK event delivered to a widget: one generic ::event signal, another, more specific, signal that matches the type of event delivered (e.g. `GtkWidget::key-press-event`) and finally a generic `GtkWidget::event-after` signal.

###### GtkWidget::event-after

After the emission of the `GtkWidget::event` signal and (optionally) the second more specific signal, ::event-after will be emitted regardless of the previous two signals handlers return values.

###### GtkWidget::focus

No description available.

###### GtkWidget::focus-in-event

The ::focus-in-event signal will be emitted when the keyboard focus enters the `widget`‘s window.

###### GtkWidget::focus-out-event

The ::focus-out-event signal will be emitted when the keyboard focus leaves the `widget`‘s window.

###### GtkWidget::grab-broken-event

Emitted when a pointer or keyboard grab on a window belonging to `widget` gets broken.

###### GtkWidget::grab-focus

No description available.

###### GtkWidget::grab-notify

The ::grab-notify signal is emitted when a widget becomes shadowed by a GTK+ grab (not a pointer or keyboard grab) on another widget, or when it becomes unshadowed due to a grab being removed.

###### GtkWidget::hide

The ::hide signal is emitted when `widget` is hidden, for example with gtk_widget_hide().

###### GtkWidget::hierarchy-changed

The ::hierarchy-changed signal is emitted when the anchored state of a widget changes. A widget is “anchored” when its toplevel ancestor is a `GtkWindow`. This signal is emitted when a widget changes from un-anchored to anchored or vice-versa.

###### GtkWidget::key-press-event

The ::key-press-event signal is emitted when a key is pressed. The signal emission will reoccur at the key-repeat rate when the key is kept pressed.

###### GtkWidget::key-release-event

The ::key-release-event signal is emitted when a key is released.

###### GtkWidget::keynav-failed

Gets emitted if keyboard navigation fails. See `gtk_widget_keynav_failed()` for details.

###### GtkWidget::leave-notify-event

The ::leave-notify-event will be emitted when the pointer leaves the `widget`‘s window.

###### GtkWidget::map

The ::map signal is emitted when `widget` is going to be mapped, that is when the widget is visible (which is controlled with gtk_widget_set_visible()) and all its parents up to the toplevel widget are also visible. Once the map has occurred, `GtkWidget::map-event` will be emitted.

###### GtkWidget::map-event

The ::map-event signal will be emitted when the `widget`‘s window is mapped. A window is mapped when it becomes visible on the screen.

###### GtkWidget::mnemonic-activate

The default handler for this signal activates `widget` if `group_cycling` is `FALSE`, or just makes `widget` grab focus if `group_cycling` is `TRUE`.

###### GtkWidget::motion-notify-event

The ::motion-notify-event signal is emitted when the pointer moves over the widget’s `GdkWindow`.

###### GtkWidget::move-focus

No description available.

###### GtkWidget::parent-set

The ::parent-set signal is emitted when a new parent has been set on a widget.

###### GtkWidget::popup-menu

This signal gets emitted whenever a widget should pop up a context menu. This usually happens through the standard key binding mechanism; by pressing a certain key while a widget is focused, the user can cause the widget to pop up a menu. For example, the `GtkEntry` widget creates a menu with clipboard commands. See the [Popup Menu Migration Checklist][checklist-popup-menu] for an example of how to use this signal.

###### GtkWidget::property-notify-event

The ::property-notify-event signal will be emitted when a property on the `widget`‘s window has been changed or deleted.

###### GtkWidget::proximity-in-event

To receive this signal the `GdkWindow` associated to the widget needs to enable the #GDK_PROXIMITY_IN_MASK mask.

###### GtkWidget::proximity-out-event

To receive this signal the `GdkWindow` associated to the widget needs to enable the #GDK_PROXIMITY_OUT_MASK mask.

###### GtkWidget::query-tooltip

Emitted when `GtkWidget:has-tooltip` is `TRUE` and the hover timeout has expired with the cursor hovering “above” `widget`; or emitted when `widget` got focus in keyboard mode.

###### GtkWidget::realize

The ::realize signal is emitted when `widget` is associated with a `GdkWindow`, which means that `gtk_widget_realize()` has been called or the widget has been mapped (that is, it is going to be drawn).

###### GtkWidget::screen-changed

The ::screen-changed signal gets emitted when the screen of a widget has changed.

###### GtkWidget::scroll-event

The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.

###### GtkWidget::selection-clear-event

The ::selection-clear-event signal will be emitted when the the `widget`‘s window has lost ownership of a selection.

###### GtkWidget::selection-get

No description available.

###### GtkWidget::selection-notify-event

No description available.

###### GtkWidget::selection-received

No description available.

###### GtkWidget::selection-request-event

The ::selection-request-event signal will be emitted when another client requests ownership of the selection owned by the `widget`‘s window.

###### GtkWidget::show

The ::show signal is emitted when `widget` is shown, for example with gtk_widget_show().

###### GtkWidget::show-help

No description available.

###### GtkWidget::size-allocate

No description available.

###### GtkWidget::state-changed

The ::state-changed signal is emitted when the widget state changes. See gtk_widget_get_state().

###### GtkWidget::state-flags-changed

The ::state-flags-changed signal is emitted when the widget state changes, see gtk_widget_get_state_flags().

###### GtkWidget::style-set

The ::style-set signal is emitted when a new style has been set on a widget. Note that style-modifying functions like `gtk_widget_modify_base()` also cause this signal to be emitted.

###### GtkWidget::style-updated

The ::style-updated signal is a convenience signal that is emitted when the `GtkStyleContext::changed` signal is emitted on the `widget`‘s associated `GtkStyleContext` as returned by gtk_widget_get_style_context().

###### GtkWidget::touch-event

No description available.

###### GtkWidget::unmap

The ::unmap signal is emitted when `widget` is going to be unmapped, which means that either it or any of its parents up to the toplevel widget have been set as hidden.

###### GtkWidget::unmap-event

The ::unmap-event signal will be emitted when the `widget`‘s window is unmapped. A window is unmapped when it becomes invisible on the screen.

###### GtkWidget::unrealize

The ::unrealize signal is emitted when the `GdkWindow` associated with `widget` is destroyed, which means that `gtk_widget_unrealize()` has been called or the widget has been unmapped (that is, it is going to be hidden).

###### GtkWidget::visibility-notify-event

The ::visibility-notify-event will be emitted when the `widget`‘s window is obscured or unobscured.

###### GtkWidget::window-state-event

The ::window-state-event will be emitted when the state of the toplevel window associated to the `widget` changes.

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

#### 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 (* text_modified) (
        VteTerminal* terminal
      );
      void (* text_inserted) (
        VteTerminal* terminal
      );
      void (* text_deleted) (
        VteTerminal* terminal
      );
      void (* text_scrolled) (
        VteTerminal* terminal,
        gint delta
      );
      void (* copy_clipboard) (
        VteTerminal* terminal
      );
      void (* paste_clipboard) (
        VteTerminal* terminal
      );
      void (* bell) (
        VteTerminal* terminal
      );
      void (* setup_context_menu) (
        VteTerminal* terminal,
        const VteEventContext* context
      );
      gboolean (* termprops_changed) (
        VteTerminal* terminal,
        const int* props,
        int n_props
      );
      void (* termprop_changed) (
        VteTerminal* terminal,
        const char* prop
      );

    }

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.

`text_modified: void (* text_modified) ( VteTerminal* terminal )`

  No description available.

`text_inserted: void (* text_inserted) ( VteTerminal* terminal )`

  No description available.

`text_deleted: void (* text_deleted) ( VteTerminal* terminal )`

  No description available.

`text_scrolled: void (* text_scrolled) ( VteTerminal* terminal, gint delta )`

  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.

`setup_context_menu: void (* setup_context_menu) ( VteTerminal* terminal, const VteEventContext* context )`

  No description available.

`termprops_changed: gboolean (* termprops_changed) ( VteTerminal* terminal, const int* props, int n_props )`

  No description available.

`termprop_changed: void (* termprop_changed) ( VteTerminal* terminal, const char* prop )`

  No description available.

#### Virtual methods

###### Vte.TerminalClass.bell

No description available.

###### Vte.TerminalClass.char_size_changed

No description available.

###### Vte.TerminalClass.child_exited

No description available.

###### Vte.TerminalClass.commit

No description available.

###### Vte.TerminalClass.contents_changed

No description available.

###### Vte.TerminalClass.copy_clipboard

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

deprecated: 0.50

###### Vte.TerminalClass.cursor_moved

No description available.

###### Vte.TerminalClass.decrease_font_size

No description available.

###### Vte.TerminalClass.deiconify_window

No description available.

###### Vte.TerminalClass.encoding_changed

No description available.

###### Vte.TerminalClass.eof

No description available.

###### Vte.TerminalClass.icon_title_changed

No description available.

###### Vte.TerminalClass.iconify_window

No description available.

###### Vte.TerminalClass.increase_font_size

No description available.

###### Vte.TerminalClass.lower_window

No description available.

###### Vte.TerminalClass.maximize_window

No description available.

###### Vte.TerminalClass.move_window

No description available.

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

###### Vte.TerminalClass.raise_window

No description available.

###### Vte.TerminalClass.refresh_window

No description available.

###### Vte.TerminalClass.resize_window

No description available.

###### Vte.TerminalClass.restore_window

No description available.

###### Vte.TerminalClass.selection_changed

No description available.

###### Vte.TerminalClass.setup_context_menu

No description available.

###### Vte.TerminalClass.termprop_changed

No description available.

###### Vte.TerminalClass.termprops_changed

No description available.

###### Vte.TerminalClass.text_deleted

No description available.

###### Vte.TerminalClass.text_inserted

No description available.

###### Vte.TerminalClass.text_modified

No description available.

###### Vte.TerminalClass.text_scrolled

No description available.

###### Vte.TerminalClass.window_title_changed

No description available.