Type Alias: VteTerminalProps
VteTerminalProps =
WidgetProps&object
Defined in: generated/jsx.ts:7785
Props for the VteTerminal widget.
Type Declaration
| Name | Type | Description | Defined in |
|---|---|---|---|
allowBold? | boolean | Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant. | generated/jsx.ts:7790 |
allowHyperlink? | boolean | Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed. | generated/jsx.ts:7792 |
audibleBell? | boolean | Controls whether or not the terminal will beep when the child outputs the "bl" sequence. | generated/jsx.ts:7797 |
backspaceBinding? | Vte.EraseBinding | Controls what string or control sequence the terminal sends to its child when the user presses the backspace key. | generated/jsx.ts:7802 |
boldIsBright? | boolean | 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. | generated/jsx.ts:7808 |
cellHeightScale? | number | Scale factor for the cell height, to increase line spacing. (The font's height is not affected.) | generated/jsx.ts:7810 |
cellWidthScale? | number | Scale factor for the cell width, to increase letter spacing. (The font's width is not affected.) | generated/jsx.ts:7812 |
children? | ReactNode | - | generated/jsx.ts:8103 |
cjkAmbiguousWidth? | number | 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.) This setting only takes effect the next time the terminal is reset, either via escape sequence or with vte_terminal_reset(). | generated/jsx.ts:7822 |
contextMenu? | Gtk.Popover | 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. | generated/jsx.ts:7828 |
contextMenuModel? | Gio.MenuModel | 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(). | generated/jsx.ts:7834 |
cursorBlinkMode? | Vte.CursorBlinkMode | Sets whether or not the cursor will blink. Using %VTE_CURSOR_BLINK_SYSTEM will use the #GtkSettings:gtk-cursor-blink setting. | generated/jsx.ts:7839 |
cursorShape? | Vte.CursorShape | Controls the shape of the cursor. | generated/jsx.ts:7841 |
deleteBinding? | Vte.EraseBinding | Controls what string or control sequence the terminal sends to its child when the user presses the delete key. | generated/jsx.ts:7846 |
enableA11y? | boolean | Controls whether or not a11y is enabled for the widget. | generated/jsx.ts:7848 |
enableBidi? | boolean | Controls whether or not the terminal will perform bidirectional text rendering. | generated/jsx.ts:7850 |
enableFallbackScrolling? | boolean | - | generated/jsx.ts:7851 |
enableLegacyOsc777? | boolean | Whether legacy OSC 777 sequences are translated to their corresponding termprops. | generated/jsx.ts:7856 |
enableShaping? | boolean | Controls whether or not the terminal will shape Arabic text. | generated/jsx.ts:7858 |
enableSixel? | boolean | Controls whether SIXEL image support is enabled. | generated/jsx.ts:7860 |
encoding? | string | null | 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. | generated/jsx.ts:7867 |
fontOptions? | cairo.FontOptions | null | The terminal's font options, or %NULL to use the default font options. Note that on GTK4, the terminal by default uses font options with %CAIRO_HINT_METRICS_ON set; to override that, use this function to set a #cairo_font_options_t that has %CAIRO_HINT_METRICS_OFF set. | generated/jsx.ts:7876 |
fontScale? | number | The terminal's font scale. | generated/jsx.ts:7878 |
hadjustment? | Gtk.Adjustment | Horizontal GtkAdjustment of the scrollable widget. This adjustment is shared between the scrollable widget and its parent. | generated/jsx.ts:7953 |
hscrollPolicy? | Gtk.ScrollablePolicy | Determines when horizontal scrolling should start. | generated/jsx.ts:7955 |
inputEnabled? | boolean | 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. | generated/jsx.ts:7884 |
onBell? | (self) => void | null | This signal is emitted when the a child sends a bell request to the terminal. | generated/jsx.ts:7968 |
onCharSizeChanged? | (width, height, self) => void | null | Emitted whenever the cell size changes, e.g. due to a change in font, font-scale or cell-width/height-scale. Note that this signal should rather be called "cell-size-changed". | generated/jsx.ts:7975 |
onChildExited? | (status, self) => void | null | This signal is emitted when the terminal detects that a child watched using vte_terminal_watch_child() has exited. | generated/jsx.ts:7980 |
onCommit? | (text, size, self) => void | null | Emitted whenever the terminal receives input from the user and prepares to send it to the child process. | generated/jsx.ts:7985 |
onContentsChanged? | (self) => void | null | Emitted whenever the visible appearance of the terminal has changed. Used primarily by #VteTerminalAccessible. | generated/jsx.ts:7990 |
onCopyClipboard? | (self) => void | null | Emitted whenever vte_terminal_copy_clipboard() is called. | generated/jsx.ts:7992 |
onCurrentDirectoryUriChanged? | (self) => void | null | Emitted when the current directory URI is modified. | generated/jsx.ts:7994 |
onCurrentFileUriChanged? | (self) => void | null | Emitted when the current file URI is modified. | generated/jsx.ts:7996 |
onCursorMoved? | (self) => void | null | Emitted whenever the cursor moves to a new character cell. Used primarily by #VteTerminalAccessible. | generated/jsx.ts:8001 |
onDecreaseFontSize? | (self) => void | null | Emitted when the user hits the '-' key while holding the Control key. | generated/jsx.ts:8003 |
onDeiconifyWindow? | (self) => void | null | Never emitted. | generated/jsx.ts:8005 |
onEncodingChanged? | (self) => void | null | Emitted whenever the terminal's current encoding has changed. Note: support for non-UTF-8 is deprecated. | generated/jsx.ts:8011 |
onEof? | (self) => void | null | 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. | generated/jsx.ts:8017 |
onHyperlinkHoverUriChanged? | (object, p0, self) => void | null | Emitted when the hovered hyperlink changes. uri and bbox are owned by VTE, must not be modified, and might change after the signal handlers returns. The signal is not re-emitted when the bounding box changes for the same hyperlink. This might change in a future VTE version without notice. | generated/jsx.ts:8027 |
onIconifyWindow? | (self) => void | null | Never emitted. | generated/jsx.ts:8030 |
onIconTitleChanged? | (self) => void | null | - | generated/jsx.ts:8028 |
onIncreaseFontSize? | (self) => void | null | Emitted when the user hits the '+' key while holding the Control key. | generated/jsx.ts:8032 |
onLowerWindow? | (self) => void | null | Never emitted. | generated/jsx.ts:8034 |
onMaximizeWindow? | (self) => void | null | Never emitted. | generated/jsx.ts:8036 |
onMoveWindow? | (x, y, self) => void | null | Never emitted. | generated/jsx.ts:8038 |
onPasteClipboard? | (self) => void | null | Emitted whenever vte_terminal_paste_clipboard() is called. | generated/jsx.ts:8040 |
onRaiseWindow? | (self) => void | null | Never emitted. | generated/jsx.ts:8042 |
onRefreshWindow? | (self) => void | null | Never emitted. | generated/jsx.ts:8044 |
onResizeWindow? | (width, height, self) => void | null | Emitted at the child application's request. | generated/jsx.ts:8046 |
onRestoreWindow? | (self) => void | null | Never emitted. | generated/jsx.ts:8048 |
onSelectionChanged? | (self) => void | null | Emitted whenever the contents of terminal's selection changes. | generated/jsx.ts:8050 |
onSetupContextMenu? | (context, self) => void | null | 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. Note that context is only valid during the signal emission; you may not retain it to call methods on it afterwards. Also emitted with %NULL context after the context menu has been dismissed. | generated/jsx.ts:8066 |
onTermpropChanged? | (name, self) => void | null | The "termprop-changed" signal is emitted when a termprop has changed or been reset. The handler may use the vte_terminal_get_termprop_*() functions (and their by-ID variants), to retrieve the value of any termprop (not just name); but it must not call any other API on terminal, including API of its parent classes. This signal supports detailed connections, so e.g. subscribing to "termprop-changed::name" only runs the callback when the termprop "name" has changed. | generated/jsx.ts:8080 |
onTermpropsChanged? | (props, nProps, self) => boolean | null | 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. The default handler for this signal emits the "termprop-changed" signal for each changed property. Returning %TRUE from a handler running before the default will prevent this. The handler may use the vte_terminal_get_termprop_*() functions (and their by-ID variants), to retrieve the value of any termprop, as well as call vte_terminal_reset_termprop() (and its by-ID variant) to reset any termprop, or emit the VteTerminal::termprop-changed signal; but it must not call any other API on terminal, including API of its parent classes. | generated/jsx.ts:8100 |
onWindowTitleChanged? | (self) => void | null | Emitted when the #VteTerminal:window-title property is modified. | generated/jsx.ts:8102 |
pointerAutohide? | boolean | 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. | generated/jsx.ts:7890 |
pty? | Vte.Pty | null | The PTY object for the terminal. | generated/jsx.ts:7892 |
ref? | Ref<Vte.Terminal> | - | generated/jsx.ts:8104 |
rewrapOnResize? | boolean | Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal's width changes. | generated/jsx.ts:7897 |
scrollbackLines? | number | 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. Note that any value greater or equal to %G_MAXINT is interpreted as unlimited scrollback, i.e. like -1 when passed to vte_terminal_set_scrollback_lines(), and the value of this property for unlimited scrollback is %G_MAXUINT. | generated/jsx.ts:7932 |
scrollOnInsert? | boolean | 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). | generated/jsx.ts:7902 |
scrollOnKeystroke? | boolean | 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. | generated/jsx.ts:7908 |
scrollOnOutput? | boolean | 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. | generated/jsx.ts:7913 |
scrollUnitIsPixels? | boolean | 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. | generated/jsx.ts:7919 |
textBlinkMode? | Vte.TextBlinkMode | Controls whether or not the terminal will allow blinking text. | generated/jsx.ts:7934 |
vadjustment? | Gtk.Adjustment | Vertical GtkAdjustment of the scrollable widget. This adjustment is shared between the scrollable widget and its parent. | generated/jsx.ts:7961 |
vscrollPolicy? | Gtk.ScrollablePolicy | Determines when vertical scrolling should start. | generated/jsx.ts:7963 |
xalign? | Vte.Align | The horizontal alignment of terminal within its allocation. | generated/jsx.ts:7936 |
xfill? | boolean | The horizontal fillment of terminal within its allocation. | generated/jsx.ts:7938 |
yalign? | Vte.Align | The vertical alignment of terminal within its allocation | generated/jsx.ts:7940 |
yfill? | boolean | 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. | generated/jsx.ts:7947 |