Functions ========= .. currentmodule:: gi.repository.Vte .. function:: get_encoding_supported(encoding: str) -> bool Queries whether the legacy encoding ``encoding`` is supported. If ICU support is not available, this function always returns :const:`False`. Note that UTF-8 is always supported; you can select it by passing :const:`None` to :func:`~gi.repository.Vte.Terminal.set_encoding`. .. versionadded:: 0.60 .. deprecated:: 0.60 Please do not use it in newly written code :param encoding: the name of the legacy encoding :return: :const:`True` iff the legacy encoding ``encoding`` is supported .. function:: get_encodings(include_aliases: bool) -> list[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 :const:`None` to :func:`~gi.repository.Vte.Terminal.set_encoding`. .. versionadded:: 0.60 .. deprecated:: 0.60 Please do not use it in newly written code :param include_aliases: whether to include alias names :return: the list of supported encodings; free with :func:`~gi.repository.GLib.strfreev` .. function:: get_feature_flags() -> ~gi.repository.Vte.FeatureFlags Gets features VTE was compiled with. .. versionadded:: 0.62 :return: flags from :obj:`~gi.repository.Vte.FeatureFlags` .. function:: get_features() -> str Gets a list of features vte was compiled with. .. versionadded:: 0.40 :return: a string with features .. function:: get_major_version() -> int Returns the major version of the VTE library at runtime. Contrast this with :const:`~gi.repository.Vte.MAJOR_VERSION` which represents the version of the VTE library that the code was compiled with. .. versionadded:: 0.40 :return: the major version .. function:: get_micro_version() -> int Returns the micro version of the VTE library at runtime. Contrast this with :const:`~gi.repository.Vte.MICRO_VERSION` which represents the version of the VTE library that the code was compiled with. .. versionadded:: 0.40 :return: the micro version .. function:: get_minor_version() -> int Returns the minor version of the VTE library at runtime. Contrast this with :const:`~gi.repository.Vte.MINOR_VERSION` which represents the version of the VTE library that the code was compiled with. .. versionadded:: 0.40 :return: the minor version .. function:: get_termprops() -> list[str] | None Gets the names of the installed termprops in an unspecified order. .. versionadded:: 0.78 :return: the names of the installed termprops, or :const:`None` if there are no termprops .. function:: get_user_shell() -> str Gets the user's shell, or :const:`None`. In the latter case, the system default (usually "/bin/sh") should be used. :return: a newly allocated string with the user's shell, or :const:`None` .. function:: install_termprop(name: str, type: ~gi.repository.Vte.PropertyType, flags: ~gi.repository.Vte.PropertyFlags) -> 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 :const:`~gi.repository.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 :obj:`~gi.repository.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. .. versionadded:: 0.78 :param name: a namespaced property name :param type: a :obj:`~gi.repository.Vte.PropertyType` to use for the property :param flags: flags from :obj:`~gi.repository.Vte.PropertyFlags` :return: an ID for the termprop .. function:: install_termprop_alias(name: str, target_name: str) -> int Installs a new terminal property ``name`` as an alias for the terminal property ``target_name``\. .. versionadded:: 0.78 :param name: a namespaced property name :param target_name: the target property name :return: the ID for the termprop ``target_name`` .. function:: pty_error_quark() -> int .. function:: query_termprop(name: str) -> ~typing.Tuple[bool, str, int, ~gi.repository.Vte.PropertyType, ~gi.repository.Vte.PropertyFlags] Gets the property type of the termprop. For properties installed by :func:`~gi.repository.Vte.install_termprop`, the name starts with "vte.ext.". For an alias termprop (see :func:`~gi.repository.Vte.install_termprop_alias`), ``resolved_name`` will be name of the alias' target termprop; otherwise it will be ``name``\. .. versionadded:: 0.78 :param name: a termprop name :return: :const:`True` iff the termprop exists, and then ``prop``\, ``type`` and ``flags`` will be filled in .. function:: query_termprop_by_id(prop: int) -> ~typing.Tuple[bool, str, ~gi.repository.Vte.PropertyType, ~gi.repository.Vte.PropertyFlags] Like :func:`~gi.repository.Vte.query_termprop` except that it takes the termprop by ID. See that function for more information. For an alias termprop (see :func:`~gi.repository.Vte.install_termprop_alias`), ``resolved_name`` will be name of the alias' target termprop; otherwise it will be ``name``\. .. versionadded:: 0.78 :param prop: a termprop ID :return: :const:`True` iff the termprop exists, and then ``name``\, ``type`` and ``flags`` will be filled in .. function:: regex_error_quark() -> int .. function:: uuid_validate_string(str: str, len: int, fmt: ~gi.repository.Vte.UuidFormat) -> bool :param str: :param len: :param fmt: