Namespace

Vte – 3.91

Virtual TErminal widget

Version0.74.2
AuthorsVTE developers
LicenseLGPL-3.0-or-later
Websitehttps://wiki.gnome.org/Apps/Terminal
Sourcehttps://gitlab.gnome.org/GNOME/vte/

Build

C headersvte/vte.h
pkg-config filesvte-2.91-gtk4

Dependencies

GObject—2.0 The GObject 2.0 toolkit
Browse documentation
Pango—1.0 The Pango 1.0 toolkit
Browse documentation
Graphene—1.0 The GSK 1.0 toolkit
Browse documentation

Additional documentation

Classes

Pty

unstable since: 3.91

Terminal

unstable since: 3.91

Structs

CharAttributes

unstable deprecated: 0.68 since: 3.91

Regex

unstable since: 3.91

Enumerations

Align

An enumeration type that can be used to specify how the terminal uses extra allocated space.

since: 0.68

CursorBlinkMode

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

unstable since: 3.91

CursorShape

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

unstable since: 3.91

EraseBinding

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

unstable since: 3.91

Format

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

since: 0.50

TextBlinkMode

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

since: 0.52

WriteFlags

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

unstable since: 3.91

Bitfields

FeatureFlags

An enumeration type for features.

since: 0.62

PtyFlags

unstable since: 3.91

Error Domains

PtyError

unstable since: 3.91

RegexError

An enum type for regex errors. In addition to the values listed above, any PCRE2 error values may occur.

since: 0.46

Callbacks

SelectionFunc

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

unstable since: 3.91

TerminalSpawnAsyncCallback

Callback for vte_terminal_spawn_async().

since: 0.48

Functions

get_encoding_supported

Queries whether the legacy encoding encoding is supported.

deprecated: 0.60 since: 0.60

get_encodings

Gets the list of supported legacy encodings.

deprecated: 0.60 since: 0.60

get_feature_flags

Gets features VTE was compiled with.

since: 0.62

get_features

Gets a list of features vte was compiled with.

since: 0.40

get_major_version

Returns the major version of the VTE library at runtime. Contrast this with VTE_MAJOR_VERSION which represents the version of the VTE library that the code was compiled with.

since: 0.40

get_micro_version

Returns the micro version of the VTE library at runtime. Contrast this with VTE_MICRO_VERSION which represents the version of the VTE library that the code was compiled with.

since: 0.40

get_minor_version

Returns the minor version of the VTE library at runtime. Contrast this with VTE_MINOR_VERSION which represents the version of the VTE library that the code was compiled with.

since: 0.40

get_user_shell

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

unstable since: 3.91

set_test_flags

Sets test flags. This function is only useful for implementing unit tests for vte itself; it is a no-op in non-debug builds.

since: 0.54

Function Macros

CHECK_VERSION

Macro to check the library version at compile time. It returns 1 if the version of VTE is greater or equal to the required one, and 0 otherwise.

unstable since: 3.91

Constants

MAJOR_VERSION

The major version number of the VTE library (e.g. in version 3.1.4 this is 3).

unstable since: 3.91

MICRO_VERSION

The micro version number of the VTE library (e.g. in version 3.1.4 this is 4).

unstable since: 3.91

MINOR_VERSION

The minor version number of the VTE library (e.g. in version 3.1.4 this is 1).

unstable since: 3.91

REGEX_FLAGS_DEFAULT

unstable since: 3.91

SPAWN_NO_PARENT_ENVV

Use this as a spawn flag (together with flags from GSpawnFlags) in vte_pty_spawn_async().

unstable since: 3.91

SPAWN_NO_SYSTEMD_SCOPE

Use this as a spawn flag (together with flags from GSpawnFlags) in vte_pty_spawn_async().

unstable since: 3.91

SPAWN_REQUIRE_SYSTEMD_SCOPE

Use this as a spawn flag (together with flags from GSpawnFlags) in vte_pty_spawn_async().

unstable since: 3.91

TEST_FLAGS_ALL

unstable since: 3.91

TEST_FLAGS_NONE

unstable since: 3.91