VTE GTK4

https://gnome.pages.gitlab.gnome.org/vte/gtk4/
Admin
VTE GTK4 is a virtual terminal emulator widget library that allows developers to embed a fully...
Tokens:61,688
Snippets:620
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### vte_terminal_spawn_sync

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.spawn_sync.html

Starts the specified command under a newly-allocated controlling pseudo-terminal. Note that this method is deprecated.

```APIDOC
## vte_terminal_spawn_sync

### Description
Starts the specified command under a newly-allocated controlling pseudo-terminal. The argv and envv lists should be NULL-terminated. Note that this method is deprecated since 0.48; use vte_terminal_spawn_async() instead.

### Signature
gboolean vte_terminal_spawn_sync (VteTerminal* terminal, VtePtyFlags pty_flags, const char* working_directory, char** argv, char** envv, GSpawnFlags spawn_flags, GSpawnChildSetupFunc child_setup, gpointer child_setup_data, GPid* child_pid, GCancellable* cancellable, GError** error)

### Parameters
- **terminal** (VteTerminal*) - The VteTerminal instance.
- **pty_flags** (VtePtyFlags) - Flags from VtePtyFlags.
- **working_directory** (const char*) - The name of a directory the command should start in, or NULL.
- **argv** (char**) - Child’s argument vector, must be NULL-terminated.
- **envv** (char**) - A list of environment variables, or NULL.
- **spawn_flags** (GSpawnFlags) - Flags from GSpawnFlags.
- **child_setup** (GSpawnChildSetupFunc) - An extra child setup function to run in the child, or NULL.
- **child_setup_data** (gpointer) - User data for child_setup.
- **child_pid** (GPid*) - A location to store the child PID, or NULL.
- **cancellable** (GCancellable*) - A GCancellable, or NULL.
- **error** (GError**) - The return location for a recoverable error.

### Return Value
- **gboolean** - TRUE on success, or FALSE on error with error filled in.
```

--------------------------------

### vte_install_termprop

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/func.install_termprop.html

Installs a new terminal property that can be set by the application. This function must be called before any VteTerminal instances are created.

```APIDOC
## vte_install_termprop

### Description
Installs a new terminal property that can be set by the application. The name must follow specific naming rules (at least 4 components, starting with 'vte' and 'ext').

### Signature
int vte_install_termprop (const char* name, VtePropertyType type, VtePropertyFlags flags)

### Parameters
- **name** (const char*) - Required - A namespaced property name. Must follow the 'vte.ext.*' prefix convention.
- **type** (VtePropertyType) - Required - The type to use for the property.
- **flags** (VtePropertyFlags) - Required - Flags from VtePropertyFlags.

### Return Value
- **int** - An ID for the installed termprop.
```

--------------------------------

### vte_pty_spawn_with_fds_async

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Pty.spawn_with_fds_async.html

Starts the specified command under the pseudo-terminal pty. This function is asynchronous and supports custom file descriptor mapping for the child process.

```APIDOC
## vte_pty_spawn_with_fds_async

### Description
Starts the specified command under the pseudo-terminal `pty`. 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`.

### Signature
```c
void vte_pty_spawn_with_fds_async (
  VtePty* pty,
  const char* working_directory,
  const char* const* argv,
  const char* const* envv,
  const int* fds,
  int n_fds,
  const int* map_fds,
  int n_map_fds,
  GSpawnFlags spawn_flags,
  GSpawnChildSetupFunc child_setup,
  gpointer child_setup_data,
  GDestroyNotify child_setup_data_destroy,
  int timeout,
  GCancellable* cancellable,
  GAsyncReadyCallback callback,
  gpointer user_data
)
```

### Parameters
- **pty** (VtePty*) - The pseudo-terminal object.
- **working_directory** (const char*) - The working directory for the child process.
- **argv** (const char* const*) - The command line arguments.
- **envv** (const char* const*) - The environment variables.
- **fds** (const int*) - Array of file descriptors to pass to the child.
- **n_fds** (int) - Number of file descriptors in `fds`.
- **map_fds** (const int*) - Mapping for the file descriptors.
- **n_map_fds** (int) - Number of mappings in `map_fds`.
- **spawn_flags** (GSpawnFlags) - Flags controlling the spawn process.
- **child_setup** (GSpawnChildSetupFunc) - Function to call in the child process before exec.
- **child_setup_data** (gpointer) - Data for the child setup function.
- **child_setup_data_destroy** (GDestroyNotify) - Destroy notify for child setup data.
- **timeout** (int) - Timeout for the operation.
- **cancellable** (GCancellable*) - Optional GCancellable object.
- **callback** (GAsyncReadyCallback) - Callback to be called when the operation completes.
- **user_data** (gpointer) - User data for the callback.
```

--------------------------------

### vte_install_termprop_alias

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/func.install_termprop_alias.html

Installs a new terminal property as an alias for an existing terminal property.

```APIDOC
## vte_install_termprop_alias

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

### Signature
`int vte_install_termprop_alias (const char* name, const char* target_name)`

### Parameters
- **name** (const char*) - A namespaced property name. The data is owned by the caller.
- **target_name** (const char*) - The target property name. The data is owned by the caller.

### Return Value
- **int** - The ID for the termprop `target_name`.

### Since
0.78
```

--------------------------------

### vte_install_termprop_alias declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/func.install_termprop_alias.html

The function signature for installing a terminal property alias.

```c
int
vte_install_termprop_alias (
  const char* name,
  const char* target_name
)
```

--------------------------------

### Define VTE_TERMPROP_NAME_PREFIX

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/const.TERMPROP_NAME_PREFIX.html

The constant definition for the required prefix string used by terminal property installation functions.

```c
#define VTE_TERMPROP_NAME_PREFIX "vte.ext."
```

--------------------------------

### vte_get_termprops

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/func.get_termprops.html

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

```APIDOC
## vte_get_termprops

### Description
Gets the names of the installed termprops in an unspecified order. Available since: 0.78.

### Signature
`const char** vte_get_termprops (gsize* length)`

### Parameters
- **length** (gsize*) - Required - A location to store the length of the returned array. The argument will be set by the function and can be NULL.

### Return Value
- **Type**: An array of utf8
- **Description**: The names of the installed termprops, or NULL if there are no termprops. The caller takes ownership of the data container, but not the data inside it.
```

--------------------------------

### void setup_context_menu (VteTerminal* terminal, const VteEventContext* context)

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.setup_context_menu.html

Virtual method to set up the context menu for the VteTerminal.

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

### Description
Virtual method to set up the context menu for the VteTerminal.

### Parameters
- **terminal** (VteTerminal*) - The terminal instance.
- **context** (const VteEventContext*) - The event context. The data is owned by the caller of the method.
```

--------------------------------

### VteTerminal setup_context_menu declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.setup_context_menu.html

The C function signature for the setup_context_menu virtual method.

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

--------------------------------

### vte_pty_child_setup

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Pty.child_setup.html

Sets up the child process for the given VtePty instance.

```APIDOC
## vte_pty_child_setup

### Description
Performs setup operations for the child process associated with the VtePty instance.

### Signature
void vte_pty_child_setup (VtePty* pty)

### Parameters
- **pty** (VtePty*) - Required - The VtePty instance to configure for the child process.
```

--------------------------------

### VteTerminal::setup-context-menu

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.setup-context-menu.html

Emitted when the terminal is about to show a context menu or after it has been dismissed. Handlers can set a menu model or menu to be displayed.

```APIDOC
## Signal: VteTerminal::setup-context-menu

### Description
Emitted with non-NULL context before the terminal shows a context menu. The handler may set a menu model or a menu to be used as the context menu. If neither is set, the menu will not be shown. This signal is also emitted with a NULL context after the context menu has been dismissed.

### Signature
void setup_context_menu (VteTerminal* self, const VteEventContext* context, gpointer user_data)

### Parameters
- **self** (VteTerminal*) - The terminal instance.
- **context** (VteEventContext*) - The event context. Can be NULL.
- **user_data** (gpointer) - User data provided during signal connection.
```

--------------------------------

### void resize_window (VteTerminal* terminal, guint width, guint height)

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.resize_window.html

Resizes the terminal window to the specified width and height.

```APIDOC
## void resize_window (VteTerminal* terminal, guint width, guint height)

### Description
Resizes the terminal window to the specified width and height.

### Parameters
- **terminal** (VteTerminal*) - Required - The VteTerminal instance.
- **width** (guint) - Required - The target width.
- **height** (guint) - Required - The target height.
```

--------------------------------

### vte_terminal_pty_new_sync

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.pty_new_sync.html

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

```APIDOC
## vte_terminal_pty_new_sync

### Description
Creates a new `VtePty`, sets the emulation property from `VteTerminal:emulation`, and sets the size using `terminal`'s size.

### Signature
`VtePty* vte_terminal_pty_new_sync (VteTerminal* terminal, VtePtyFlags flags, GCancellable* cancellable, GError** error)`

### Parameters
- **terminal** (VteTerminal*) - The terminal instance.
- **flags** (VtePtyFlags) - Flags from `VtePtyFlags`.
- **cancellable** (GCancellable*) - A `GCancellable`, or `NULL`.
- **error** (GError**) - The return location for a recoverable error.

### Return Value
- **VtePty*** - A new `VtePty`. The caller takes ownership of the returned data.
```

--------------------------------

### VteTerminalSpawnAsyncCallback

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/callback.TerminalSpawnAsyncCallback.html

Callback signature for vte_terminal_spawn_async().

```APIDOC
## VteTerminalSpawnAsyncCallback

### Description
Callback function invoked when vte_terminal_spawn_async() completes. On success, the pid parameter contains the process ID and error is NULL. On failure, pid is -1 and error contains the error information.

### Signature
void (* VteTerminalSpawnAsyncCallback) (VteTerminal* terminal, GPid pid, GError* error, gpointer user_data)

### Parameters
- **terminal** (VteTerminal*) - The VteTerminal instance.
- **pid** (GPid) - The PID of the spawned process, or -1 on failure.
- **error** (GError*) - A GError object if the operation failed, or NULL on success.
- **user_data** (gpointer) - User data passed to the original vte_terminal_spawn_async call.
```

--------------------------------

### void commit (VteTerminal* terminal, const gchar* text, guint size)

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.commit.html

Commits the specified text to the terminal emulator.

```APIDOC
## void commit (VteTerminal* terminal, const gchar* text, guint size)

### Description
Commits the specified text to the terminal emulator.

### Parameters
- **terminal** (VteTerminal*) - The terminal instance.
- **text** (const gchar*) - The UTF-8 string to commit. The data is owned by the caller.
- **size** (guint) - The size of the text.
```

--------------------------------

### void move_window (VteTerminal* terminal, guint x, guint y)

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.move_window.html

Moves the terminal window to the specified x and y coordinates.

```APIDOC
## void move_window (VteTerminal* terminal, guint x, guint y)

### Description
Moves the terminal window to the specified x and y coordinates.

### Parameters
- **terminal** (VteTerminal*) - The terminal widget instance.
- **x** (guint) - The x coordinate.
- **y** (guint) - The y coordinate.
```

--------------------------------

### Declare enable-legacy-osc777 property

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.enable-legacy-osc777.html

The declaration of the enable-legacy-osc777 property as a readable and writable boolean.

```c
property enable-legacy-osc777: gboolean [ read, write ]
```

--------------------------------

### void raise_window (VteTerminal* terminal)

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.raise_window.html

The raise_window method is a virtual function for the VteTerminal class. It takes a pointer to a VteTerminal instance as its argument.

```APIDOC
## void raise_window (VteTerminal* terminal)

### Description
Raises the terminal window. This is a virtual method for the VteTerminal class.

### Signature
`void raise_window (VteTerminal* terminal)`

### Parameters
- **terminal** (VteTerminal*) - Required - The VteTerminal instance to operate on.
```

--------------------------------

### VteTerminal current-directory-uri property declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.current-directory-uri.html

The property is defined as a read-only UTF-8 string.

```C
property current-directory-uri: utf8 [ read ]
```

--------------------------------

### void iconify_window (VteTerminal* terminal)

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.iconify_window.html

The iconify_window method is a virtual method used to iconify the terminal window associated with the VteTerminal instance.

```APIDOC
## void iconify_window (VteTerminal* terminal)

### Description
Requests the terminal window to be iconified.

### Parameters
- **terminal** (VteTerminal*) - Required - The VteTerminal instance to iconify.
```

--------------------------------

### VteTerminal::iconify-window signal declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.iconify-window.html

The signature for the iconify-window signal handler.

```c
void
iconify_window (
  VteTerminal* self,
  gpointer user_data
)
```

--------------------------------

### vte_terminal_spawn_with_fds_async

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.spawn_with_fds_async.html

Spawns a child process on a VteTerminal with support for custom file descriptor mapping.

```APIDOC
## vte_terminal_spawn_with_fds_async

### Description
A convenience function that wraps creating the VtePty and spawning the child process on it. It handles the lifecycle of the child process and provides callbacks for success or failure.

### Signature
void vte_terminal_spawn_with_fds_async (
  VteTerminal* terminal,
  VtePtyFlags pty_flags,
  const char* working_directory,
  const char* const* argv,
  const char* const* envv,
  const int* fds,
  int n_fds,
  const int* map_fds,
  int n_map_fds,
  GSpawnFlags spawn_flags,
  GSpawnChildSetupFunc child_setup,
  gpointer child_setup_data,
  GDestroyNotify child_setup_data_destroy,
  int timeout,
  GCancellable* cancellable,
  VteTerminalSpawnAsyncCallback callback,
  gpointer user_data
)
```

--------------------------------

### VTE_SPAWN_REQUIRE_SYSTEMD_SCOPE Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/const.SPAWN_REQUIRE_SYSTEMD_SCOPE.html

The constant definition for the systemd scope spawn requirement.

```c
#define VTE_SPAWN_REQUIRE_SYSTEMD_SCOPE 134217728
```

--------------------------------

### Terminal.spawn_with_fds_async

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.spawn_with_fds_async.html

Spawns a child process in the terminal with custom file descriptors and environment settings.

```APIDOC
## Method: spawn_with_fds_async

### Description
Spawns a child process in the terminal. This method supports custom file descriptor mappings, environment variables, and child setup functions.

### Parameters
- **pty_flags** (VtePtyFlags) - Required - Flags from VtePtyFlags.
- **working_directory** (const char*) - Optional - The directory the command should start in.
- **argv** (filename[]) - Required - Child’s argument vector, must be NULL-terminated.
- **envv** (filename[]) - Optional - Environment variables to be added.
- **fds** (int[]) - Optional - Array of file descriptors.
- **n_fds** (int) - Required - Number of file descriptors in fds.
- **map_fds** (int[]) - Optional - Array of integers for mapping.
- **n_map_fds** (int) - Required - Number of elements in map_fds.
- **spawn_flags** (GSpawnFlags) - Required - Flags from GSpawnFlags.
- **child_setup** (GSpawnChildSetupFunc) - Optional - Function to run in the child before exec().
- **child_setup_data** (gpointer) - Optional - User data for child_setup.
- **child_setup_data_destroy** (GDestroyNotify) - Optional - Destroy notify for child_setup_data.
- **timeout** (int) - Required - Timeout in ms.
- **cancellable** (GCancellable) - Optional - A GCancellable object.
- **callback** (VteTerminalSpawnAsyncCallback) - Optional - Callback function.
- **user_data** (gpointer) - Optional - User data for callback.
```

--------------------------------

### Declaration of vte_regex_jit

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Regex.jit.html

The function signature for JIT compiling a regex object.

```C
gboolean
vte_regex_jit (
  VteRegex* regex,
  guint32 flags,
  GError** error
)
```

--------------------------------

### VteTerminalSpawnAsyncCallback Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/callback.TerminalSpawnAsyncCallback.html

The function signature for the asynchronous spawn callback.

```C
void
(* VteTerminalSpawnAsyncCallback) (
  VteTerminal* terminal,
  GPid pid,
  GError* error,
  gpointer user_data
)
```

--------------------------------

### Pty.spawn_with_fds_async

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Pty.spawn_with_fds_async.html

Spawns a process asynchronously in a pseudo-terminal with support for custom file descriptors and environment configuration.

```APIDOC
## Pty.spawn_with_fds_async

### Description
Spawns a process asynchronously in a pseudo-terminal. This method supports custom working directories, argument vectors, environment variables, and file descriptor mapping.

### Parameters
- **working_directory** (const char*) - Optional - The directory the command should start in.
- **argv** (array of filename) - Required - Child's argument vector, must be NULL-terminated.
- **envv** (array of filename) - Optional - Environment variables to add to the process.
- **fds** (array of int) - Optional - Array of file descriptors.
- **n_fds** (int) - Required - Number of file descriptors in fds.
- **map_fds** (array of int) - Optional - Array of integers for mapping file descriptors.
- **n_map_fds** (int) - Required - Number of elements in map_fds.
- **spawn_flags** (GSpawnFlags) - Required - Flags from GSpawnFlags.
- **child_setup** (GSpawnChildSetupFunc) - Optional - Function to run in the child before exec().
- **child_setup_data** (gpointer) - Optional - User data for child_setup.
- **child_setup_data_destroy** (GDestroyNotify) - Optional - Destroy notify for child_setup_data.
- **timeout** (int) - Required - Timeout in ms, -1 for default, G_MAXINT to wait indefinitely.
- **cancellable** (GCancellable) - Optional - GCancellable instance.
- **callback** (GAsyncReadyCallback) - Optional - Callback to invoke when finished.
- **user_data** (gpointer) - Optional - User data for the callback.
```

--------------------------------

### vte_terminal_spawn_async

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.spawn_async.html

Spawns a child process on a VteTerminal asynchronously.

```APIDOC
## vte_terminal_spawn_async

### Description
A convenience function that wraps creating the VtePty and spawning the child process on it. This function does not allow passing file descriptors to the child process.

### Signature
void vte_terminal_spawn_async (VteTerminal* terminal, VtePtyFlags pty_flags, const char* working_directory, char** argv, char** envv, GSpawnFlags spawn_flags, GSpawnChildSetupFunc child_setup, gpointer child_setup_data, GDestroyNotify child_setup_data_destroy, int timeout, GCancellable* cancellable, VteTerminalSpawnAsyncCallback callback, gpointer user_data)

### Parameters
- **terminal** (VteTerminal*) - The terminal instance.
- **pty_flags** (VtePtyFlags) - Flags from VtePtyFlags.
- **working_directory** (const char*) - The directory the command should start in, or NULL.
- **argv** (char**) - Child's argument vector, must be NULL-terminated.
- **envv** (char**) - List of environment variables, or NULL.
- **spawn_flags** (GSpawnFlags) - Flags from GSpawnFlags.
- **child_setup** (GSpawnChildSetupFunc) - Extra child setup function, or NULL.
- **child_setup_data** (gpointer) - User data for child_setup, or NULL.
- **child_setup_data_destroy** (GDestroyNotify) - A GDestroyNotify for child_setup_data, or NULL.
- **timeout** (int) - Timeout value in ms, -1 for default, G_MAXINT for infinite.
- **cancellable** (GCancellable*) - A GCancellable, or NULL.
- **callback** (VteTerminalSpawnAsyncCallback) - A callback function, or NULL.
- **user_data** (gpointer) - User data for callback, or NULL.
```

--------------------------------

### VteTerminal resize_window declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.resize_window.html

The C function signature for resizing the terminal window.

```c
void
resize_window (
  VteTerminal* terminal,
  guint width,
  guint height
)
```

--------------------------------

### vte_pty_spawn_async

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Pty.spawn_async.html

Asynchronously spawns a process in the PTY. This function does not allow passing file descriptors to the child process. Use vte_pty_spawn_finish() in the callback to retrieve the result.

```APIDOC
## vte_pty_spawn_async

### Description
Asynchronously spawns a process in the PTY. This function does not allow passing file descriptors to the child process. Use vte_pty_spawn_finish() in the callback to retrieve the result.

### Signature
void vte_pty_spawn_async (VtePty* pty, const char* working_directory, char** argv, char** envv, GSpawnFlags spawn_flags, GSpawnChildSetupFunc child_setup, gpointer child_setup_data, GDestroyNotify child_setup_data_destroy, int timeout, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer user_data)

### Parameters
- **pty** (VtePty*) - The VtePty instance.
- **working_directory** (const char*) - Optional. The directory the command should start in.
- **argv** (char**) - Child's argument vector, must be NULL-terminated.
- **envv** (char**) - Optional. Environment variables to add, must be NULL-terminated.
- **spawn_flags** (GSpawnFlags) - Flags from GSpawnFlags.
- **child_setup** (GSpawnChildSetupFunc) - Optional. Setup function to run in the child before exec().
- **child_setup_data** (gpointer) - Optional. User data for child_setup.
- **child_setup_data_destroy** (GDestroyNotify) - Optional. Destroy notify for child_setup_data.
- **timeout** (int) - Timeout in ms, -1 for default, G_MAXINT to wait indefinitely.
- **cancellable** (GCancellable*) - Optional. A GCancellable instance.
- **callback** (GAsyncReadyCallback) - Optional. Callback to invoke upon completion.
- **user_data** (gpointer) - Optional. User data for the callback.
```

--------------------------------

### vte_terminal_get_enable_bidi

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.get_enable_bidi.html

Checks whether the terminal performs bidirectional text rendering.

```APIDOC
## vte_terminal_get_enable_bidi

### Description
Checks whether the terminal performs bidirectional text rendering.

### Signature
`gboolean vte_terminal_get_enable_bidi (VteTerminal* terminal)`

### Parameters
- **terminal** (VteTerminal*) - Required - The VteTerminal instance.

### Return Value
- **gboolean** - TRUE if BiDi is enabled, FALSE if not.

### Since
0.58
```

--------------------------------

### VteTerminal::restore-window Signal Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.restore-window.html

The function signature for the restore-window signal handler.

```C
void
restore_window (
  VteTerminal* self,
  gpointer user_data
)
```

--------------------------------

### Declaration of vte_get_user_shell

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/func.get_user_shell.html

The function signature for retrieving the user's shell.

```c
char*
vte_get_user_shell (
  void
)
```

--------------------------------

### VteTerminal::raise-window Signal Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.raise-window.html

The signature for the raise-window signal handler.

```C
void
raise_window (
  VteTerminal* self,
  gpointer user_data
)
```

--------------------------------

### VteTerminal.get_current_directory_uri declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.get_current_directory_uri.html

The C function signature for retrieving the current directory URI from a VteTerminal instance.

```C
const char*
vte_terminal_get_current_directory_uri (
  VteTerminal* terminal
)
```

--------------------------------

### maximize_window

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.maximize_window.html

Maximizes the terminal window.

```APIDOC
## maximize_window

### Description
Maximizes the terminal window.

### Signature
void maximize_window (VteTerminal* terminal)
```

--------------------------------

### VteTerminal::deiconify-window Signal Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.deiconify-window.html

The signature for the deiconify-window signal handler.

```C
void
deiconify_window (
  VteTerminal* self,
  gpointer user_data
)
```

--------------------------------

### VteTerminal raise_window Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.raise_window.html

The C function signature for the raise_window virtual method.

```c
void
raise_window (
  VteTerminal* terminal
)
```

--------------------------------

### vte_pty_set_size

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Pty.set_size.html

Attempts to resize the pseudo terminal’s window size. If successful, the OS kernel will send SIGWINCH to the child process group.

```APIDOC
## vte_pty_set_size

### Description
Attempts to resize the pseudo terminal’s window size. If successful, the OS kernel will send SIGWINCH to the child process group.

### Signature
`gboolean vte_pty_set_size (VtePty* pty, int rows, int columns, GError** error)`

### Parameters
- **pty** (VtePty*) - The VtePty instance.
- **rows** (int) - The desired number of rows.
- **columns** (int) - The desired number of columns.
- **error** (GError**) - The return location for a recoverable error. Can be NULL.

### Return Value
- **Type**: gboolean
- **Description**: TRUE on success, FALSE on failure with error filled in.
```

--------------------------------

### vte_terminal_get_enable_sixel

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.enable-sixel.html

Retrieves the current state of SIXEL image support.

```APIDOC
## gboolean vte_terminal_get_enable_sixel (VteTerminal *terminal);

### Description
Returns whether SIXEL image support is enabled for the terminal.

### Parameters
- **terminal** (VteTerminal*) - Required - The VteTerminal instance.

### Returns
- **gboolean** - TRUE if SIXEL support is enabled, FALSE otherwise.
```

--------------------------------

### VteTerminal::maximize-window Signal Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.maximize-window.html

The function signature for the maximize-window signal handler.

```c
void
maximize_window (
  VteTerminal* self,
  gpointer user_data
)
```

--------------------------------

### vte_terminal_new

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/ctor.Terminal.new.html

Creates a new terminal widget.

```APIDOC
## vte_terminal_new

### Description
Creates a new terminal widget.

### Signature
`GtkWidget* vte_terminal_new (void)`

### Return Value
- **VteTerminal** - A new VteTerminal object.
```

--------------------------------

### vte_get_micro_version

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/func.get_micro_version.html

Returns the micro version of the VTE library at runtime.

```APIDOC
## vte_get_micro_version

### Description
Returns the micro version of the VTE library at runtime. This allows developers to check the version of the library currently in use, as opposed to the version used during compilation.

### Signature
`guint vte_get_micro_version (void)`

### Return Value
- **Type**: guint
- **Description**: The micro version of the VTE library.

### Since
0.40
```

--------------------------------

### vte_pty_new_sync

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/ctor.Pty.new_sync.html

Allocates a new pseudo-terminal. The caller takes ownership of the returned VtePty object.

```APIDOC
## vte_pty_new_sync

### Description
Allocates a new pseudo-terminal. This function is used to initialize a PTY before spawning a child process.

### Signature
`VtePty* vte_pty_new_sync (VtePtyFlags flags, GCancellable* cancellable, GError** error)`

### Parameters
- **flags** (VtePtyFlags) - Flags from VtePtyFlags.
- **cancellable** (GCancellable*) - A GCancellable object, or NULL.
- **error** (GError**) - The return location for a recoverable error, or NULL.

### Return Value
- **VtePty*** - A new VtePty instance, or NULL on error.
```

--------------------------------

### Declare VteTerminal:allow-bold property

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.allow-bold.html

The property declaration showing the type and access flags.

```C
property allow-bold: gboolean [ read, write ]
```

--------------------------------

### Declare enable-bidi property

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.enable-bidi.html

The property declaration for enable-bidi, indicating it is a boolean that can be read and written.

```c
property enable-bidi: gboolean [ read, write ]
```

--------------------------------

### VteTerminal::move-window Signal Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.move-window.html

The signature for the move-window signal handler.

```C
void
move_window (
  VteTerminal* self,
  guint x,
  guint y,
  gpointer user_data
)
```

--------------------------------

### Define VTE_SPAWN_NO_PARENT_ENVV

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/const.SPAWN_NO_PARENT_ENVV.html

The constant definition for the spawn flag used in vte_pty_spawn_async().

```c
#define VTE_SPAWN_NO_PARENT_ENVV 33554432
```

--------------------------------

### VteTerminal:current-file-uri Property Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.current-file-uri.html

The declaration of the current-file-uri property as a read-only UTF-8 string.

```C
property current-file-uri: utf8 [ read ]
```

--------------------------------

### Define VTE_TERMPROP_CURRENT_DIRECTORY_URI

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/const.TERMPROP_CURRENT_DIRECTORY_URI.html

The constant definition for the current directory URI property.

```c
#define VTE_TERMPROP_CURRENT_DIRECTORY_URI "vte.cwd"
```

--------------------------------

### VteTerminal context-menu property declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.context-menu.html

The property declaration for context-menu, indicating it is a read/write GtkPopover.

```text
property context-menu: Gtk.Popover [ read, write ]
```

--------------------------------

### Declaration of vte_get_micro_version

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/func.get_micro_version.html

The function signature for retrieving the runtime micro version of the VTE library.

```c
guint
vte_get_micro_version (
  void
)
```

--------------------------------

### vte_regex_jit

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Regex.jit.html

Compiles the provided VteRegex object using JIT if supported by the platform.

```APIDOC
## gboolean vte_regex_jit (VteRegex* regex, guint32 flags, GError** error)

### Description
If the platform supports JITing, this method JIT compiles the provided `regex` object.

### Parameters
- **regex** (VteRegex*) - The regex object to compile.
- **flags** (guint32) - PCRE2 JIT flags, or 0.
- **error** (GError**) - The return location for a recoverable error, or NULL.

### Return Value
- **gboolean** - TRUE if JITing succeeded (or PCRE2 was built without JIT support), or FALSE with error filled in.
```

--------------------------------

### vte_terminal_get_context_menu

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.context-menu.html

Retrieves the GtkPopover currently set as the context menu for the VteTerminal.

```APIDOC
## GtkPopover* vte_terminal_get_context_menu (VteTerminal *terminal)

### Description
Returns the GtkPopover that is used for context menus in the terminal. Note that the context menu model set via vte_terminal_set_context_menu_model() takes precedence over this property.

### Parameters
- **terminal** (VteTerminal*) - Required - The VteTerminal instance.

### Returns
- **GtkPopover*** - The context menu popover, or NULL if none is set.
```

--------------------------------

### C Declaration of vte_terminal_set_context_menu

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.set_context_menu.html

The C function signature for setting the context menu on a VteTerminal.

```c
void
vte_terminal_set_context_menu (
  VteTerminal* terminal,
  GtkWidget* menu
)
```

--------------------------------

### VteTerminal::resize-window Signal Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.resize-window.html

The signal signature for handling terminal resize requests from child applications.

```C
void
resize_window (
  VteTerminal* self,
  guint width,
  guint height,
  gpointer user_data
)
```

--------------------------------

### Declare word-char-exceptions property

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.word-char-exceptions.html

The property is defined as a read-only UTF-8 string.

```text
property word-char-exceptions: utf8 [ read ]
```

--------------------------------

### vte_terminal_set_enable_legacy_osc777

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.set_enable_legacy_osc777.html

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

```APIDOC
## vte_terminal_set_enable_legacy_osc777

### Description
Sets whether legacy OSC 777 sequences are translated to their corresponding termprops. Available since: 0.78.

### Signature
void vte_terminal_set_enable_legacy_osc777 (VteTerminal* terminal, gboolean enable)

### Parameters
- **terminal** (VteTerminal*) - The VteTerminal instance.
- **enable** (gboolean) - Whether to enable legacy OSC 777.
```

--------------------------------

### Define VTE_SPAWN_NO_SYSTEMD_SCOPE

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/const.SPAWN_NO_SYSTEMD_SCOPE.html

The constant is defined as a bitmask value for use with GSpawnFlags.

```c
#define VTE_SPAWN_NO_SYSTEMD_SCOPE 67108864
```

--------------------------------

### vte_get_minor_version

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/func.get_minor_version.html

Returns the minor version of the VTE library at runtime.

```APIDOC
## vte_get_minor_version

### Description
Returns the minor version of the VTE library at runtime. This allows developers to distinguish between the runtime version and the version the code was compiled with (VTE_MINOR_VERSION).

### Signature
`guint vte_get_minor_version (void)`

### Return Value
- **Type**: guint
- **Description**: The minor version of the VTE library.
```

--------------------------------

### VteTerminal:window-title Property Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.window-title.html

The property is defined as a read-only UTF-8 string.

```c
property window-title: utf8 [ read ]
```

--------------------------------

### Define VTE_TERMPROP_SHELL_POSTEXEC

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/const.TERMPROP_SHELL_POSTEXEC.html

The constant definition for the shell post-execution property.

```c
#define VTE_TERMPROP_SHELL_POSTEXEC "vte.shell.postexec"
```

--------------------------------

### VteTerminal copy_clipboard Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.copy_clipboard.html

The function signature for the copy_clipboard virtual method.

```C
void
copy_clipboard (
  VteTerminal* terminal
)
```

--------------------------------

### Declare VTE_MICRO_VERSION

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/const.MICRO_VERSION.html

Defines the micro version number for the VTE library.

```c
#define VTE_MICRO_VERSION 2
```

--------------------------------

### vte_terminal_set_enable_bidi

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.set_enable_bidi.html

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

```APIDOC
## vte_terminal_set_enable_bidi

### Description
Controls whether or not the terminal will perform bidirectional text rendering. Available since: 0.58.

### Signature
void vte_terminal_set_enable_bidi (VteTerminal* terminal, gboolean enable_bidi)

### Parameters
- **terminal** (VteTerminal*) - The terminal instance.
- **enable_bidi** (gboolean) - TRUE to enable BiDi support.
```

--------------------------------

### VteTerminal.get_termprop_rgba declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.get_termprop_rgba.html

The C function signature for retrieving terminal property colors.

```c
gboolean
vte_terminal_get_termprop_rgba (
  VteTerminal* terminal,
  const char* prop,
  GdkRGBA* color
)
```

--------------------------------

### Declare hyperlink-hover-uri property

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.hyperlink-hover-uri.html

The property is defined as a read-only UTF-8 string representing the hovered URI.

```c
property hyperlink-hover-uri: utf8 [ read ]
```

--------------------------------

### Define VTE_TERMPROP_CONTAINER_RUNTIME

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/const.TERMPROP_CONTAINER_RUNTIME.html

The constant represents the string key "vte.container.runtime" used for VTE_PROPERTY_STRING properties.

```c
#define VTE_TERMPROP_CONTAINER_RUNTIME "vte.container.runtime"
```

--------------------------------

### vte_pty_spawn_finish

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Pty.spawn_finish.html

Completes an asynchronous spawn operation for a VtePty.

```APIDOC
## vte_pty_spawn_finish

### Description
Completes an asynchronous spawn operation for a VtePty object. This method retrieves the child process ID and handles any errors that occurred during the spawn process.

### Signature
`gboolean vte_pty_spawn_finish (VtePty* pty, GAsyncResult* result, GPid* child_pid, GError** error)`

### Parameters
- **pty** (VtePty*) - The VtePty object.
- **result** (GAsyncResult*) - A GAsyncResult object.
- **child_pid** (GPid*) - A location to store the child PID, or NULL.
- **error** (GError**) - The return location for a recoverable error, or NULL.

### Return Value
- **gboolean** - TRUE on success, or FALSE on error with the error parameter filled in.
```

--------------------------------

### VteTerminal::current-directory-uri-changed Signal Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.current-directory-uri-changed.html

The C function signature for the current-directory-uri-changed signal handler.

```c
void
current_directory_uri_changed (
  VteTerminal* self,
  gpointer user_data
)
```

--------------------------------

### VteTerminal::resize-window

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.resize-window.html

Signal emitted when the child application requests a resize of the terminal window.

```APIDOC
## VteTerminal::resize-window

### Description
Emitted at the child application’s request to resize the terminal window. The default handler is executed after any handlers connected via g_signal_connect().

### Parameters
- **self** (VteTerminal*) - The VteTerminal instance.
- **width** (guint) - The desired number of columns.
- **height** (guint) - The desired number of rows.
- **user_data** (gpointer) - User data passed to the signal handler.
```

--------------------------------

### VteTerminal context-menu-model Property Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.context-menu-model.html

The property declaration for context-menu-model, indicating it is a read/write property of type Gio.MenuModel.

```text
property context-menu-model: Gio.MenuModel [ read, write ]
```

--------------------------------

### VTE_SPAWN_REQUIRE_SYSTEMD_SCOPE

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/const.SPAWN_REQUIRE_SYSTEMD_SCOPE.html

A spawn flag constant used with GSpawnFlags in vte_pty_spawn_async() to ensure the child process is placed in a systemd user scope.

```APIDOC
## VTE_SPAWN_REQUIRE_SYSTEMD_SCOPE

### Description
Use this as a spawn flag (together with flags from GSpawnFlags) in vte_pty_spawn_async(). It requires the newly created child process to be moved to a systemd user scope; if the move fails, the spawn operation fails. This flag is supported on Linux only.

### Value
134217728
```

--------------------------------

### vte_terminal_get_context_menu

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.get_context_menu.html

Retrieves the context menu for the specified VteTerminal instance. Available since version 0.76.

```APIDOC
## vte_terminal_get_context_menu

### Description
Gets the context menu associated with the VteTerminal instance. The returned GtkWidget is owned by the instance.

### Signature
GtkWidget* vte_terminal_get_context_menu (VteTerminal* terminal)

### Parameters
- **terminal** (VteTerminal*) - Required - The VteTerminal instance.

### Return Value
- **GtkWidget*** - The context menu, or NULL if none is set.
```

--------------------------------

### Declare scrollback-lines property

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.scrollback-lines.html

The property is defined as a guint that supports both read and write operations.

```c
property scrollback-lines: guint [ read, write ]
```

--------------------------------

### vte_terminal_get_enable_sixel

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.get_enable_sixel.html

Retrieves the value of the Vte.Terminal:enable-sixel property.

```APIDOC
## vte_terminal_get_enable_sixel

### Description
Gets the value of the `Vte.Terminal:enable-sixel` property for the specified terminal.

### Signature
`gboolean vte_terminal_get_enable_sixel (VteTerminal* terminal)`

### Parameters
- **terminal** (VteTerminal*) - The VteTerminal instance.

### Return Value
- **Type**: `gboolean`
- Returns `TRUE` if Sixel support is enabled, otherwise `FALSE`.
```

--------------------------------

### vte_get_encodings

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/func.get_encodings.html

Retrieves a list of supported legacy encodings. UTF-8 is always supported and does not need to be explicitly selected.

```APIDOC
## vte_get_encodings

### Description
Gets the list of supported legacy encodings. If ICU support is not available, this returns an empty vector.

### Signature
`char** vte_get_encodings (gboolean include_aliases)`

### Parameters
- **include_aliases** (gboolean) - Whether to include alias names.

### Return Value
- **Type**: Array of utf8 strings
- **Description**: The list of supported encodings. The array is NULL-terminated. The caller takes ownership of the data and must free it using g_strfreev().

### Notes
- **Deprecated**: Since 0.60. Please do not use in newly written code.
```

--------------------------------

### vte_terminal_get_enable_shaping

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.enable-shaping.html

Retrieves the current state of the enable-shaping property.

```APIDOC
## gboolean vte_terminal_get_enable_shaping (VteTerminal *terminal)

### Description
Returns whether the terminal is currently shaping Arabic text.

### Parameters
- **terminal** (VteTerminal*) - Required - The VteTerminal instance.

### Returns
- **gboolean** - TRUE if shaping is enabled, FALSE otherwise.
```

--------------------------------

### void child_exited (VteTerminal* terminal, int status)

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.child_exited.html

This virtual method is invoked when the child process associated with the terminal exits.

```APIDOC
## void child_exited (VteTerminal* terminal, int status)

### Description
Invoked when the child process associated with the VteTerminal exits.

### Parameters
- **terminal** (VteTerminal*) - The VteTerminal instance.
- **status** (int) - The exit status of the child process.
```

--------------------------------

### Define VTE_TERMPROP_CURRENT_FILE_URI

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/const.TERMPROP_CURRENT_FILE_URI.html

The constant definition for the current file URI terminal property.

```c
#define VTE_TERMPROP_CURRENT_FILE_URI "vte.cwf"
```

--------------------------------

### vte_uuid_new_v5 Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Uuid.new_v5.html

The function signature for creating a new UUID v5 instance.

```C
VteUuid*
vte_uuid_new_v5 (
  const VteUuid* ns,
  const char* data,
  gssize len
)
```

--------------------------------

### VteTerminal.get_text Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.get_text.html

The C function signature for retrieving visible terminal text.

```C
char*
vte_terminal_get_text (
  VteTerminal* terminal,
  VteSelectionFunc is_selected,
  gpointer user_data,
  GArray* attributes
)
```

--------------------------------

### Declare enable-shaping property

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Terminal.enable-shaping.html

The property declaration for enable-shaping in VteTerminal.

```c
property enable-shaping: gboolean [ read, write ]
```

--------------------------------

### deiconify_window

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/vfunc.Terminal.deiconify_window.html

The deiconify_window method is a virtual method for the VteTerminal class.

```APIDOC
## void deiconify_window (VteTerminal* terminal)

### Description
Restores a terminal window from an iconified state.

### Parameters
- **terminal** (VteTerminal*) - The VteTerminal instance.
```

--------------------------------

### vte_terminal_get_enable_legacy_osc777

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.get_enable_legacy_osc777.html

Retrieves whether legacy OSC 777 is enabled for the specified terminal.

```APIDOC
## vte_terminal_get_enable_legacy_osc777

### Description
Returns the status of the legacy OSC 777 feature for the provided VteTerminal instance. Available since version 0.78.

### Signature
`gboolean vte_terminal_get_enable_legacy_osc777 (VteTerminal* terminal)`

### Parameters
- **terminal** (VteTerminal*) - Required - The VteTerminal instance.

### Return Value
- **gboolean** - Returns TRUE if legacy OSC 777 is enabled, otherwise FALSE.
```

--------------------------------

### vte_terminal_copy_primary

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.copy_primary.html

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

```APIDOC
## vte_terminal_copy_primary

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

### Signature
void vte_terminal_copy_primary (VteTerminal* terminal)

### Parameters
- **terminal** (VteTerminal*) - Required - The VteTerminal instance to copy from.
```

--------------------------------

### VteTerminal.set_scroll_on_insert declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.set_scroll_on_insert.html

The C function signature for setting the scroll-on-insert behavior.

```C
void
vte_terminal_set_scroll_on_insert (
  VteTerminal* terminal,
  gboolean scroll
)
```

--------------------------------

### VteTerminal::increase-font-size Signal Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.increase-font-size.html

The signature for the increase-font-size signal handler.

```C
void
increase_font_size (
  VteTerminal* self,
  gpointer user_data
)
```

--------------------------------

### VtePty:fd Property Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/property.Pty.fd.html

The property is defined as a read, write, and construct-only integer.

```C
property fd: int [ read, write, construct-only ]
```

--------------------------------

### VteTerminal current-file-uri-changed signal declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.current-file-uri-changed.html

The C function signature for the current-file-uri-changed signal handler.

```c
void
current_file_uri_changed (
  VteTerminal* self,
  gpointer user_data
)
```

--------------------------------

### VteTerminal::copy-clipboard Signal Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.copy-clipboard.html

The signature for the copy-clipboard signal handler.

```C
void
copy_clipboard (
  VteTerminal* self,
  gpointer user_data
)
```

--------------------------------

### VteTerminal::lower-window Signal Declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/signal.Terminal.lower-window.html

The signature for the lower-window signal handler.

```c
void
lower_window (
  VteTerminal* self,
  gpointer user_data
)
```

--------------------------------

### vte_terminal_copy_clipboard_format

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.copy_clipboard_format.html

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

```APIDOC
## vte_terminal_copy_clipboard_format

### Description
Places the selected text in the terminal in the #GDK_SELECTION_CLIPBOARD selection in the form specified by `format`. For all formats, the selection data will include text targets. For `VTE_FORMAT_HTML`, the selection will also include the “text/html” target.

### Signature
`void vte_terminal_copy_clipboard_format (VteTerminal* terminal, VteFormat format)`

### Parameters
- **terminal** (VteTerminal*) - The terminal instance.
- **format** (VteFormat) - The format to use for the clipboard data.

### Since
0.50
```

--------------------------------

### VteTerminal.get_window_title declaration

Source: https://gnome.pages.gitlab.gnome.org/vte/gtk4/method.Terminal.get_window_title.html

The C function signature for retrieving the terminal window title.

```c
const char*
vte_terminal_get_window_title (
  VteTerminal* terminal
)
```
Tokens:
Raw