Functions

get_encoding_supported (encoding)

get_encodings (include_aliases)

get_feature_flags ()

get_features ()

get_major_version ()

get_micro_version ()

get_minor_version ()

get_termprops ()

get_user_shell ()

install_termprop (name, type, flags)

install_termprop_alias (name, target_name)

pty_error_quark ()

query_termprop (name)

query_termprop_by_id (prop)

regex_error_quark ()

uuid_validate_string (str, len, fmt)

Details

Vte.get_encoding_supported(encoding)
Parameters:

encoding (str) – the name of the legacy encoding

Returns:

True iff the legacy encoding encoding is supported

Return type:

bool

Queries whether the legacy encoding encoding is supported.

If ICU support is not available, this function always returns False.

Note that UTF-8 is always supported; you can select it by passing None to Vte.Terminal.set_encoding().

New in version 0.60.

Deprecated since version 0.60.

Vte.get_encodings(include_aliases)
Parameters:

include_aliases (bool) – whether to include alias names

Returns:

the list of supported encodings; free with GLib.strfreev()

Return type:

[str]

Gets the list of supported legacy encodings.

If ICU support is not available, this returns an empty vector. Note that UTF-8 is always supported; you can select it by passing None to Vte.Terminal.set_encoding().

New in version 0.60.

Deprecated since version 0.60.

Vte.get_feature_flags()
Returns:

flags from Vte.FeatureFlags

Return type:

Vte.FeatureFlags

Gets features VTE was compiled with.

New in version 0.62.

Vte.get_features()
Returns:

a string with features

Return type:

str

Gets a list of features vte was compiled with.

New in version 0.40.

Vte.get_major_version()
Returns:

the major version

Return type:

int

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.

New in version 0.40.

Vte.get_micro_version()
Returns:

the micro version

Return type:

int

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.

New in version 0.40.

Vte.get_minor_version()
Returns:

the minor version

Return type:

int

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.

New in version 0.40.

Vte.get_termprops()
Returns:

the names of the installed termprops, or None if there are no termprops

Return type:

[str] or None

Gets the names of the installed termprops in an unspecified order.

New in version 0.78.

Vte.get_user_shell()
Returns:

a newly allocated string with the user’s shell, or None

Return type:

str

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

Vte.install_termprop(name, type, flags)
Parameters:
Returns:

an ID for the termprop

Return type:

int

Installs a new terminal property that can be set by the application.

name must follow the rules for termprop names as laid out above; it must have at least 4 components, the first two of which must be “vte”, and “ext”. Use the Vte.TERMPROP_NAME_PREFIX macro which defines this name prefix.

You should use an identifier for your terminal as the first component after the prefix, as a namespace marker.

It is a programming error to call this function with a name that does not meet these requirements.

It is a programming error to call this function after any Vte.Terminal instances have been created.

It is a programming error to call this function if the named termprop is already installed with a different type or flags.

New in version 0.78.

Vte.install_termprop_alias(name, target_name)
Parameters:

  • name (str) – a namespaced property name

  • target_name (str) – the target property name

Returns:

the ID for the termprop target_name

Return type:

int

Installs a new terminal property name as an alias for the terminal property target_name.

New in version 0.78.

Vte.pty_error_quark()
Returns:

the error domain for VTE PTY errors

Return type:

int

Error domain for VTE PTY errors. Errors in this domain will be from the Vte.PtyError enumeration. See GLib.Error for more information on error domains.

Vte.query_termprop(name)
Parameters:

name (str) – a termprop name

Returns:

True iff the termprop exists, and then prop, type and flags will be filled in

resolved_name:

a location to store the termprop’s name

prop:

a location to store the termprop’s ID

type:

a location to store the termprop’s type as a Vte.PropertyType

flags:

a location to store the termprop’s flags as a Vte.PropertyFlags

Return type:

(bool, resolved_name: str, prop: int, type: Vte.PropertyType, flags: Vte.PropertyFlags)

Gets the property type of the termprop. For properties installed by Vte.install_termprop(), the name starts with “vte.ext.”.

For an alias termprop (see Vte.install_termprop_alias()), resolved_name will be name of the alias’ target termprop; otherwise it will be name.

New in version 0.78.

Vte.query_termprop_by_id(prop)
Parameters:

prop (int) – a termprop ID

Returns:

True iff the termprop exists, and then name, type and flags will be filled in

name:

a location to store the termprop’s name

type:

a location to store the termprop’s type as a Vte.PropertyType

flags:

a location to store the termprop’s flags as a Vte.PropertyFlags

Return type:

(bool, name: str, type: Vte.PropertyType, flags: Vte.PropertyFlags)

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

For an alias termprop (see Vte.install_termprop_alias()), resolved_name will be name of the alias’ target termprop; otherwise it will be name.

New in version 0.78.

Vte.regex_error_quark()
Return type:

int

Vte.uuid_validate_string(str, len, fmt)
Parameters:
Return type:

bool