@gtkx/react / VteTerminalProps
Interface: VteTerminalProps
Defined in: packages/react/src/generated/jsx.ts:7616
Props for the VteTerminal widget.
Extends
Properties
accessibleActiveDescendant?
optionalaccessibleActiveDescendant?:Widget
Defined in: packages/react/src/jsx.ts:834
Inherited from
WidgetProps.accessibleActiveDescendant
accessibleAutocomplete?
optionalaccessibleAutocomplete?:AccessibleAutocomplete
Defined in: packages/react/src/jsx.ts:803
Inherited from
WidgetProps.accessibleAutocomplete
accessibleBusy?
optionalaccessibleBusy?:boolean
Defined in: packages/react/src/jsx.ts:824
Inherited from
accessibleChecked?
optionalaccessibleChecked?:AccessibleTristate
Defined in: packages/react/src/jsx.ts:825
Inherited from
accessibleColCount?
optionalaccessibleColCount?:number
Defined in: packages/react/src/jsx.ts:835
Inherited from
WidgetProps.accessibleColCount
accessibleColIndex?
optionalaccessibleColIndex?:number
Defined in: packages/react/src/jsx.ts:836
Inherited from
WidgetProps.accessibleColIndex
accessibleColIndexText?
optionalaccessibleColIndexText?:string
Defined in: packages/react/src/jsx.ts:837
Inherited from
WidgetProps.accessibleColIndexText
accessibleColSpan?
optionalaccessibleColSpan?:number
Defined in: packages/react/src/jsx.ts:838
Inherited from
accessibleControls?
optionalaccessibleControls?:Widget[]
Defined in: packages/react/src/jsx.ts:839
Inherited from
WidgetProps.accessibleControls
accessibleDescribedBy?
optionalaccessibleDescribedBy?:Widget[]
Defined in: packages/react/src/jsx.ts:840
Inherited from
WidgetProps.accessibleDescribedBy
accessibleDescription?
optionalaccessibleDescription?:string
Defined in: packages/react/src/jsx.ts:804
Inherited from
WidgetProps.accessibleDescription
accessibleDetails?
optionalaccessibleDetails?:Widget[]
Defined in: packages/react/src/jsx.ts:841
Inherited from
accessibleDisabled?
optionalaccessibleDisabled?:boolean
Defined in: packages/react/src/jsx.ts:826
Inherited from
WidgetProps.accessibleDisabled
accessibleErrorMessage?
optionalaccessibleErrorMessage?:Widget[]
Defined in: packages/react/src/jsx.ts:842
Inherited from
WidgetProps.accessibleErrorMessage
accessibleExpanded?
optionalaccessibleExpanded?:boolean
Defined in: packages/react/src/jsx.ts:827
Inherited from
WidgetProps.accessibleExpanded
accessibleFlowTo?
optionalaccessibleFlowTo?:Widget[]
Defined in: packages/react/src/jsx.ts:843
Inherited from
accessibleHasPopup?
optionalaccessibleHasPopup?:boolean
Defined in: packages/react/src/jsx.ts:805
Inherited from
WidgetProps.accessibleHasPopup
accessibleHelpText?
optionalaccessibleHelpText?:string
Defined in: packages/react/src/jsx.ts:822
Inherited from
WidgetProps.accessibleHelpText
accessibleHidden?
optionalaccessibleHidden?:boolean
Defined in: packages/react/src/jsx.ts:828
Inherited from
accessibleInvalid?
optionalaccessibleInvalid?:AccessibleInvalidState
Defined in: packages/react/src/jsx.ts:829
Inherited from
accessibleKeyShortcuts?
optionalaccessibleKeyShortcuts?:string
Defined in: packages/react/src/jsx.ts:806
Inherited from
WidgetProps.accessibleKeyShortcuts
accessibleLabel?
optionalaccessibleLabel?:string
Defined in: packages/react/src/jsx.ts:807
Inherited from
accessibleLabelledBy?
optionalaccessibleLabelledBy?:Widget[]
Defined in: packages/react/src/jsx.ts:844
Inherited from
WidgetProps.accessibleLabelledBy
accessibleLevel?
optionalaccessibleLevel?:number
Defined in: packages/react/src/jsx.ts:808
Inherited from
accessibleModal?
optionalaccessibleModal?:boolean
Defined in: packages/react/src/jsx.ts:809
Inherited from
accessibleMultiLine?
optionalaccessibleMultiLine?:boolean
Defined in: packages/react/src/jsx.ts:810
Inherited from
WidgetProps.accessibleMultiLine
accessibleMultiSelectable?
optionalaccessibleMultiSelectable?:boolean
Defined in: packages/react/src/jsx.ts:811
Inherited from
WidgetProps.accessibleMultiSelectable
accessibleOrientation?
optionalaccessibleOrientation?:Orientation
Defined in: packages/react/src/jsx.ts:812
Inherited from
WidgetProps.accessibleOrientation
accessibleOwns?
optionalaccessibleOwns?:Widget[]
Defined in: packages/react/src/jsx.ts:845
Inherited from
accessiblePlaceholder?
optionalaccessiblePlaceholder?:string
Defined in: packages/react/src/jsx.ts:813
Inherited from
WidgetProps.accessiblePlaceholder
accessiblePosInSet?
optionalaccessiblePosInSet?:number
Defined in: packages/react/src/jsx.ts:846
Inherited from
WidgetProps.accessiblePosInSet
accessiblePressed?
optionalaccessiblePressed?:AccessibleTristate
Defined in: packages/react/src/jsx.ts:830
Inherited from
accessibleReadOnly?
optionalaccessibleReadOnly?:boolean
Defined in: packages/react/src/jsx.ts:814
Inherited from
WidgetProps.accessibleReadOnly
accessibleRequired?
optionalaccessibleRequired?:boolean
Defined in: packages/react/src/jsx.ts:815
Inherited from
WidgetProps.accessibleRequired
accessibleRole?
optionalaccessibleRole?:AccessibleRole
Defined in: packages/react/src/generated/jsx.ts:187
The accessible role of the given GtkAccessible implementation.
The accessible role cannot be changed once set.
Inherited from
accessibleRoleDescription?
optionalaccessibleRoleDescription?:string
Defined in: packages/react/src/jsx.ts:816
Inherited from
WidgetProps.accessibleRoleDescription
accessibleRowCount?
optionalaccessibleRowCount?:number
Defined in: packages/react/src/jsx.ts:847
Inherited from
WidgetProps.accessibleRowCount
accessibleRowIndex?
optionalaccessibleRowIndex?:number
Defined in: packages/react/src/jsx.ts:848
Inherited from
WidgetProps.accessibleRowIndex
accessibleRowIndexText?
optionalaccessibleRowIndexText?:string
Defined in: packages/react/src/jsx.ts:849
Inherited from
WidgetProps.accessibleRowIndexText
accessibleRowSpan?
optionalaccessibleRowSpan?:number
Defined in: packages/react/src/jsx.ts:850
Inherited from
accessibleSelected?
optionalaccessibleSelected?:boolean
Defined in: packages/react/src/jsx.ts:831
Inherited from
WidgetProps.accessibleSelected
accessibleSetSize?
optionalaccessibleSetSize?:number
Defined in: packages/react/src/jsx.ts:851
Inherited from
accessibleSort?
optionalaccessibleSort?:AccessibleSort
Defined in: packages/react/src/jsx.ts:817
Inherited from
accessibleValueMax?
optionalaccessibleValueMax?:number
Defined in: packages/react/src/jsx.ts:818
Inherited from
WidgetProps.accessibleValueMax
accessibleValueMin?
optionalaccessibleValueMin?:number
Defined in: packages/react/src/jsx.ts:819
Inherited from
WidgetProps.accessibleValueMin
accessibleValueNow?
optionalaccessibleValueNow?:number
Defined in: packages/react/src/jsx.ts:820
Inherited from
WidgetProps.accessibleValueNow
accessibleValueText?
optionalaccessibleValueText?:string
Defined in: packages/react/src/jsx.ts:821
Inherited from
WidgetProps.accessibleValueText
accessibleVisited?
optionalaccessibleVisited?:boolean
Defined in: packages/react/src/jsx.ts:832
Inherited from
allowBold?
optionalallowBold?:boolean
Defined in: packages/react/src/generated/jsx.ts:7621
Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.
allowHyperlink?
optionalallowHyperlink?:boolean
Defined in: packages/react/src/generated/jsx.ts:7623
Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed.
audibleBell?
optionalaudibleBell?:boolean
Defined in: packages/react/src/generated/jsx.ts:7628
Controls whether or not the terminal will beep when the child outputs the "bl" sequence.
backspaceBinding?
optionalbackspaceBinding?:EraseBinding
Defined in: packages/react/src/generated/jsx.ts:7633
Controls what string or control sequence the terminal sends to its child when the user presses the backspace key.
boldIsBright?
optionalboldIsBright?:boolean
Defined in: packages/react/src/generated/jsx.ts:7639
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.
canFocus?
optionalcanFocus?:boolean
Defined in: packages/react/src/generated/jsx.ts:24
Whether the widget or any of its descendents can accept the input focus.
This property is meant to be set by widget implementations, typically in their instance init function.
Inherited from
canTarget?
optionalcanTarget?:boolean
Defined in: packages/react/src/generated/jsx.ts:26
Whether the widget can receive pointer events.
Inherited from
cellHeightScale?
optionalcellHeightScale?:number
Defined in: packages/react/src/generated/jsx.ts:7641
Scale factor for the cell height, to increase line spacing. (The font's height is not affected.)
cellWidthScale?
optionalcellWidthScale?:number
Defined in: packages/react/src/generated/jsx.ts:7643
Scale factor for the cell width, to increase letter spacing. (The font's width is not affected.)
children?
optionalchildren?:ReactNode
Defined in: packages/react/src/generated/jsx.ts:312
Children elements (child widgets or event controllers).
Inherited from
cjkAmbiguousWidth?
optionalcjkAmbiguousWidth?:number
Defined in: packages/react/src/generated/jsx.ts:7653
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().
contextMenu?
optionalcontextMenu?:Popover|null
Defined in: packages/react/src/generated/jsx.ts:7659
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.
contextMenuModel?
optionalcontextMenuModel?:MenuModel|null
Defined in: packages/react/src/generated/jsx.ts:7665
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().
cssClasses?
optionalcssClasses?:string[]
Defined in: packages/react/src/generated/jsx.ts:28
A list of css classes applied to this widget.
Inherited from
cssName?
optionalcssName?:string
Defined in: packages/react/src/generated/jsx.ts:35
The name of this widget in the CSS tree.
This property is meant to be set by widget implementations, typically in their instance init function.
Inherited from
cursor?
optionalcursor?:Cursor|null
Defined in: packages/react/src/generated/jsx.ts:37
The cursor used by widget.
Inherited from
cursorBlinkMode?
optionalcursorBlinkMode?:CursorBlinkMode
Defined in: packages/react/src/generated/jsx.ts:7670
Sets whether or not the cursor will blink. Using %VTE_CURSOR_BLINK_SYSTEM will use the #GtkSettings:gtk-cursor-blink setting.
cursorShape?
optionalcursorShape?:CursorShape
Defined in: packages/react/src/generated/jsx.ts:7672
Controls the shape of the cursor.
deleteBinding?
optionaldeleteBinding?:EraseBinding
Defined in: packages/react/src/generated/jsx.ts:7677
Controls what string or control sequence the terminal sends to its child when the user presses the delete key.
enableA11y?
optionalenableA11y?:boolean
Defined in: packages/react/src/generated/jsx.ts:7679
Controls whether or not a11y is enabled for the widget.
enableBidi?
optionalenableBidi?:boolean
Defined in: packages/react/src/generated/jsx.ts:7681
Controls whether or not the terminal will perform bidirectional text rendering.
enableFallbackScrolling?
optionalenableFallbackScrolling?:boolean
Defined in: packages/react/src/generated/jsx.ts:7682
enableLegacyOsc777?
optionalenableLegacyOsc777?:boolean
Defined in: packages/react/src/generated/jsx.ts:7687
Whether legacy OSC 777 sequences are translated to their corresponding termprops.
enableShaping?
optionalenableShaping?:boolean
Defined in: packages/react/src/generated/jsx.ts:7689
Controls whether or not the terminal will shape Arabic text.
enableSixel?
optionalenableSixel?:boolean
Defined in: packages/react/src/generated/jsx.ts:7691
Controls whether SIXEL image support is enabled.
encoding?
optionalencoding?:string|null
Defined in: packages/react/src/generated/jsx.ts:7698
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.
focusable?
optionalfocusable?:boolean
Defined in: packages/react/src/generated/jsx.ts:45
Whether this widget itself will accept the input focus.
Inherited from
focusOnClick?
optionalfocusOnClick?:boolean
Defined in: packages/react/src/generated/jsx.ts:43
Whether the widget should grab focus when it is clicked with the mouse.
This property is only relevant for widgets that can take focus.
Inherited from
fontDesc?
optionalfontDesc?:FontDescription
Defined in: packages/react/src/generated/jsx.ts:7706
Specifies the font used for rendering all text displayed by the terminal, overriding any fonts set using gtk_widget_modify_font(). The terminal will immediately attempt to load the desired font, retrieve its metrics, and attempt to resize itself to keep the same number of rows and columns.
fontOptions?
optionalfontOptions?:FontOptionsImpl|null
Defined in: packages/react/src/generated/jsx.ts:7715
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.
fontScale?
optionalfontScale?:number
Defined in: packages/react/src/generated/jsx.ts:7717
The terminal's font scale.
hadjustment?
optionalhadjustment?:Adjustment
Defined in: packages/react/src/generated/jsx.ts:7792
Horizontal GtkAdjustment of the scrollable widget.
This adjustment is shared between the scrollable widget and its parent.
halign?
optionalhalign?:Align
Defined in: packages/react/src/generated/jsx.ts:47
How to distribute horizontal space if widget gets extra space.
Inherited from
hasTooltip?
optionalhasTooltip?:boolean
Defined in: packages/react/src/generated/jsx.ts:56
Enables or disables the emission of the Widget.:query-tooltip signal on widget.
A true value indicates that widget can have a tooltip, in this case the widget will be queried using Widget.:query-tooltip to determine whether it will provide a tooltip or not.
Inherited from
heightRequest?
optionalheightRequest?:number
Defined in: packages/react/src/generated/jsx.ts:62
Overrides for height request of the widget.
If this is -1, the natural request will be used.
Inherited from
hexpand?
optionalhexpand?:boolean
Defined in: packages/react/src/generated/jsx.ts:64
Whether to expand horizontally.
Inherited from
hexpandSet?
optionalhexpandSet?:boolean
Defined in: packages/react/src/generated/jsx.ts:66
Whether to use the hexpand property.
Inherited from
hscrollPolicy?
optionalhscrollPolicy?:ScrollablePolicy
Defined in: packages/react/src/generated/jsx.ts:7794
Determines when horizontal scrolling should start.
inputEnabled?
optionalinputEnabled?:boolean
Defined in: packages/react/src/generated/jsx.ts:7723
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.
layoutManager?
optionallayoutManager?:LayoutManager|null
Defined in: packages/react/src/generated/jsx.ts:74
The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.
This property is meant to be set by widget implementations, typically in their instance init function.
Inherited from
limitEvents?
optionallimitEvents?:boolean
Defined in: packages/react/src/generated/jsx.ts:83
Makes this widget act like a modal dialog, with respect to event delivery.
Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See EventController.set_propagation_limit.
Inherited from
marginBottom?
optionalmarginBottom?:number
Defined in: packages/react/src/generated/jsx.ts:91
Margin on bottom side of widget.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Widget.set_size_request for example.
Inherited from
marginEnd?
optionalmarginEnd?:number
Defined in: packages/react/src/generated/jsx.ts:102
Margin on end of widget, horizontally.
This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Widget.set_size_request for example.
Inherited from
marginStart?
optionalmarginStart?:number
Defined in: packages/react/src/generated/jsx.ts:113
Margin on start of widget, horizontally.
This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Widget.set_size_request for example.
Inherited from
marginTop?
optionalmarginTop?:number
Defined in: packages/react/src/generated/jsx.ts:121
Margin on top side of widget.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Widget.set_size_request for example.
Inherited from
name?
optionalname?:string
Defined in: packages/react/src/generated/jsx.ts:123
The name of the widget.
Inherited from
onBell?
optionalonBell?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7807
This signal is emitted when the a child sends a bell request to the terminal.
onCharSizeChanged?
optionalonCharSizeChanged?: ((width,height,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7814
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".
onChildExited?
optionalonChildExited?: ((status,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7819
This signal is emitted when the terminal detects that a child watched using vte_terminal_watch_child() has exited.
onCommit?
optionalonCommit?: ((text,size,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7824
Emitted whenever the terminal receives input from the user and prepares to send it to the child process.
onContentsChanged?
optionalonContentsChanged?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7829
Emitted whenever the visible appearance of the terminal has changed. Used primarily by #VteTerminalAccessible.
onCopyClipboard?
optionalonCopyClipboard?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7831
Emitted whenever vte_terminal_copy_clipboard() is called.
onCurrentDirectoryUriChanged?
optionalonCurrentDirectoryUriChanged?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7833
Emitted when the current directory URI is modified.
onCurrentFileUriChanged?
optionalonCurrentFileUriChanged?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7835
Emitted when the current file URI is modified.
onCursorMoved?
optionalonCursorMoved?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7840
Emitted whenever the cursor moves to a new character cell. Used primarily by #VteTerminalAccessible.
onDecreaseFontSize?
optionalonDecreaseFontSize?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7842
Emitted when the user hits the '-' key while holding the Control key.
onDeiconifyWindow?
optionalonDeiconifyWindow?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7844
Never emitted.
onDestroy?
optionalonDestroy?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:196
Signals that all holders of a reference to the widget should release the reference that they hold.
May result in finalization of the widget if all references are released.
This signal is not suitable for saving widget state.
Inherited from
onDirectionChanged?
optionalonDirectionChanged?: ((previousDirection,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:198
Emitted when the text direction of a widget changes.
Inherited from
WidgetProps.onDirectionChanged
onEncodingChanged?
optionalonEncodingChanged?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7850
Emitted whenever the terminal's current encoding has changed.
Note: support for non-UTF-8 is deprecated.
onEof?
optionalonEof?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7856
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.
onHide?
optionalonHide?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:200
Emitted when widget is hidden.
Inherited from
onHyperlinkHoverUriChanged?
optionalonHyperlinkHoverUriChanged?: ((object,p0,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7866
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.
onIconifyWindow?
optionalonIconifyWindow?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7869
Never emitted.
onIconTitleChanged?
optionalonIconTitleChanged?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7867
onIncreaseFontSize?
optionalonIncreaseFontSize?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7871
Emitted when the user hits the '+' key while holding the Control key.
onKeynavFailed?
optionalonKeynavFailed?: ((direction,self) =>boolean) |null
Defined in: packages/react/src/generated/jsx.ts:206
Emitted if keyboard navigation fails.
See Widget.keynav_failed for details.
Inherited from
onLowerWindow?
optionalonLowerWindow?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7873
Never emitted.
onMap?
optionalonMap?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:218
Emitted when widget is going to be mapped.
A widget is mapped when the widget is visible (which is controlled with Widget.visible) and all its parents up to the toplevel widget are also visible.
The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of Widget.:unmap.
Inherited from
onMaximizeWindow?
optionalonMaximizeWindow?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7875
Never emitted.
onMnemonicActivate?
optionalonMnemonicActivate?: ((groupCycling,self) =>boolean) |null
Defined in: packages/react/src/generated/jsx.ts:225
Emitted when a widget is activated via a mnemonic.
The default handler for this signal activates widget if group_cycling is false, or just makes widget grab focus if group_cycling is true.
Inherited from
WidgetProps.onMnemonicActivate
onMoveFocus?
optionalonMoveFocus?: ((direction,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:234
Emitted when the focus is moved.
The ::move-focus signal is a keybinding signal.
The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.
Inherited from
onMoveWindow?
optionalonMoveWindow?: ((x,y,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7877
Never emitted.
onNotify?
optionalonNotify?: ((pspec,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:310
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with %G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass %G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.
This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:
|[ g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view) ]|
It is important to note that you must use [canonical parameter names]GObjectParamSpec#parameter-names as detail strings for the notify signal.
Inherited from
onPasteClipboard?
optionalonPasteClipboard?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7879
Emitted whenever vte_terminal_paste_clipboard() is called.
onQueryTooltip?
optionalonQueryTooltip?: ((x,y,keyboardMode,tooltip,self) =>boolean) |null
Defined in: packages/react/src/generated/jsx.ts:250
Emitted when the widget’s tooltip is about to be shown.
This happens when the Widget.has-tooltip property is true and the hover timeout has expired with the cursor hovering above widget; or emitted when widget got focus in keyboard mode.
Using the given coordinates, the signal handler should determine whether a tooltip should be shown for widget. If this is the case true should be returned, false otherwise. Note that if keyboard_mode is true, the values of x and y are undefined and should not be used.
The signal handler is free to manipulate tooltip with the therefore destined function calls.
Inherited from
onRaiseWindow?
optionalonRaiseWindow?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7881
Never emitted.
onRealize?
optionalonRealize?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:257
Emitted when widget is associated with a GdkSurface.
This means that Widget.realize has been called or the widget has been mapped (that is, it is going to be drawn).
Inherited from
onRefreshWindow?
optionalonRefreshWindow?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7883
Never emitted.
onResizeWindow?
optionalonResizeWindow?: ((width,height,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7885
Emitted at the child application's request.
onRestoreWindow?
optionalonRestoreWindow?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7887
Never emitted.
onSelectionChanged?
optionalonSelectionChanged?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7889
Emitted whenever the contents of terminal's selection changes.
onSetupContextMenu?
optionalonSetupContextMenu?: ((context,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7905
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.
onShow?
optionalonShow?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:259
Emitted when widget is shown.
Inherited from
onStateFlagsChanged?
optionalonStateFlagsChanged?: ((flags,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:265
Emitted when the widget state changes.
Inherited from
WidgetProps.onStateFlagsChanged
onTermpropChanged?
optionalonTermpropChanged?: ((name,self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7919
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.
onTermpropsChanged?
optionalonTermpropsChanged?: ((props,nProps,self) =>boolean) |null
Defined in: packages/react/src/generated/jsx.ts:7939
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.
onUnmap?
optionalonUnmap?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:275
Emitted when widget is going to be unmapped.
A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.
As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.
Inherited from
onUnrealize?
optionalonUnrealize?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:282
Emitted when the GdkSurface associated with widget is destroyed.
This means that Widget.unrealize has been called or the widget has been unmapped (that is, it is going to be hidden).
Inherited from
onWindowTitleChanged?
optionalonWindowTitleChanged?: ((self) =>void) |null
Defined in: packages/react/src/generated/jsx.ts:7941
Emitted when the #VteTerminal:window-title property is modified.
opacity?
optionalopacity?:number
Defined in: packages/react/src/generated/jsx.ts:125
The requested opacity of the widget.
Inherited from
overflow?
optionaloverflow?:Overflow
Defined in: packages/react/src/generated/jsx.ts:132
How content outside the widget's content area is treated.
This property is meant to be set by widget implementations, typically in their instance init function.
Inherited from
pointerAutohide?
optionalpointerAutohide?:boolean
Defined in: packages/react/src/generated/jsx.ts:7729
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.
pty?
optionalpty?:Pty|null
Defined in: packages/react/src/generated/jsx.ts:7731
The PTY object for the terminal.
receivesDefault?
optionalreceivesDefault?:boolean
Defined in: packages/react/src/generated/jsx.ts:134
Whether the widget will receive the default action when it is focused.
Inherited from
ref?
optionalref?:Ref<Terminal>
Defined in: packages/react/src/generated/jsx.ts:7942
rewrapOnResize?
optionalrewrapOnResize?:boolean
Defined in: packages/react/src/generated/jsx.ts:7736
Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal's width changes.
scrollbackLines?
optionalscrollbackLines?:number
Defined in: packages/react/src/generated/jsx.ts:7771
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.
scrollOnInsert?
optionalscrollOnInsert?:boolean
Defined in: packages/react/src/generated/jsx.ts:7741
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).
scrollOnKeystroke?
optionalscrollOnKeystroke?:boolean
Defined in: packages/react/src/generated/jsx.ts:7747
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.
scrollOnOutput?
optionalscrollOnOutput?:boolean
Defined in: packages/react/src/generated/jsx.ts:7752
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.
scrollUnitIsPixels?
optionalscrollUnitIsPixels?:boolean
Defined in: packages/react/src/generated/jsx.ts:7758
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.
sensitive?
optionalsensitive?:boolean
Defined in: packages/react/src/generated/jsx.ts:136
Whether the widget responds to input.
Inherited from
textBlinkMode?
optionaltextBlinkMode?:TextBlinkMode
Defined in: packages/react/src/generated/jsx.ts:7773
Controls whether or not the terminal will allow blinking text.
tooltipMarkup?
optionaltooltipMarkup?:string|null
Defined in: packages/react/src/generated/jsx.ts:152
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Also see Tooltip.set_markup.
This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: Widget.has-tooltip will automatically be set to true and there will be taken care of Widget.:query-tooltip in the default signal handler.
Note that if both Widget.tooltip-text and Widget.tooltip-markup are set, the last one wins.
Inherited from
tooltipText?
optionaltooltipText?:string|null
Defined in: packages/react/src/generated/jsx.ts:167
Sets the text of tooltip to be the given string.
Also see Tooltip.set_text.
This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: Widget.has-tooltip will automatically be set to true and there will be taken care of Widget.:query-tooltip in the default signal handler.
Note that if both Widget.tooltip-text and Widget.tooltip-markup are set, the last one wins.
Inherited from
vadjustment?
optionalvadjustment?:Adjustment
Defined in: packages/react/src/generated/jsx.ts:7800
Vertical GtkAdjustment of the scrollable widget.
This adjustment is shared between the scrollable widget and its parent.
valign?
optionalvalign?:Align
Defined in: packages/react/src/generated/jsx.ts:169
How to distribute vertical space if widget gets extra space.
Inherited from
vexpand?
optionalvexpand?:boolean
Defined in: packages/react/src/generated/jsx.ts:171
Whether to expand vertically.
Inherited from
vexpandSet?
optionalvexpandSet?:boolean
Defined in: packages/react/src/generated/jsx.ts:173
Whether to use the vexpand property.
Inherited from
visible?
optionalvisible?:boolean
Defined in: packages/react/src/generated/jsx.ts:175
Whether the widget is visible.
Inherited from
vscrollPolicy?
optionalvscrollPolicy?:ScrollablePolicy
Defined in: packages/react/src/generated/jsx.ts:7802
Determines when vertical scrolling should start.
widthRequest?
optionalwidthRequest?:number
Defined in: packages/react/src/generated/jsx.ts:181
Overrides for width request of the widget.
If this is -1, the natural request will be used.
Inherited from
xalign?
optionalxalign?:Align
Defined in: packages/react/src/generated/jsx.ts:7775
The horizontal alignment of terminal within its allocation.
xfill?
optionalxfill?:boolean
Defined in: packages/react/src/generated/jsx.ts:7777
The horizontal fillment of terminal within its allocation.
yalign?
optionalyalign?:Align
Defined in: packages/react/src/generated/jsx.ts:7779
The vertical alignment of terminal within its allocation
yfill?
optionalyfill?:boolean
Defined in: packages/react/src/generated/jsx.ts:7786
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.