Skip to main content

Interface: GtkTextViewProps

Defined in: packages/react/src/generated/jsx.ts:8192

Props for the GtkTextView widget.

Extends

Extended by

Properties

acceptsTab?

optional acceptsTab: boolean

Defined in: packages/react/src/generated/jsx.ts:8194

Whether Tab will result in a tab character being entered.


accessibleActiveDescendant?

optional accessibleActiveDescendant: Widget

Defined in: packages/react/src/jsx.ts:1175

Inherited from

WidgetProps.accessibleActiveDescendant


accessibleAutocomplete?

optional accessibleAutocomplete: AccessibleAutocomplete

Defined in: packages/react/src/jsx.ts:1144

Inherited from

WidgetProps.accessibleAutocomplete


accessibleBusy?

optional accessibleBusy: boolean

Defined in: packages/react/src/jsx.ts:1165

Inherited from

WidgetProps.accessibleBusy


accessibleChecked?

optional accessibleChecked: AccessibleTristate

Defined in: packages/react/src/jsx.ts:1166

Inherited from

WidgetProps.accessibleChecked


accessibleColCount?

optional accessibleColCount: number

Defined in: packages/react/src/jsx.ts:1176

Inherited from

WidgetProps.accessibleColCount


accessibleColIndex?

optional accessibleColIndex: number

Defined in: packages/react/src/jsx.ts:1177

Inherited from

WidgetProps.accessibleColIndex


accessibleColIndexText?

optional accessibleColIndexText: string

Defined in: packages/react/src/jsx.ts:1178

Inherited from

WidgetProps.accessibleColIndexText


accessibleColSpan?

optional accessibleColSpan: number

Defined in: packages/react/src/jsx.ts:1179

Inherited from

WidgetProps.accessibleColSpan


accessibleControls?

optional accessibleControls: Widget[]

Defined in: packages/react/src/jsx.ts:1180

Inherited from

WidgetProps.accessibleControls


accessibleDescribedBy?

optional accessibleDescribedBy: Widget[]

Defined in: packages/react/src/jsx.ts:1181

Inherited from

WidgetProps.accessibleDescribedBy


accessibleDescription?

optional accessibleDescription: string

Defined in: packages/react/src/jsx.ts:1145

Inherited from

WidgetProps.accessibleDescription


accessibleDetails?

optional accessibleDetails: Widget[]

Defined in: packages/react/src/jsx.ts:1182

Inherited from

WidgetProps.accessibleDetails


accessibleDisabled?

optional accessibleDisabled: boolean

Defined in: packages/react/src/jsx.ts:1167

Inherited from

WidgetProps.accessibleDisabled


accessibleErrorMessage?

optional accessibleErrorMessage: Widget[]

Defined in: packages/react/src/jsx.ts:1183

Inherited from

WidgetProps.accessibleErrorMessage


accessibleExpanded?

optional accessibleExpanded: boolean

Defined in: packages/react/src/jsx.ts:1168

Inherited from

WidgetProps.accessibleExpanded


accessibleFlowTo?

optional accessibleFlowTo: Widget[]

Defined in: packages/react/src/jsx.ts:1184

Inherited from

WidgetProps.accessibleFlowTo


accessibleHasPopup?

optional accessibleHasPopup: boolean

Defined in: packages/react/src/jsx.ts:1146

Inherited from

WidgetProps.accessibleHasPopup


accessibleHelpText?

optional accessibleHelpText: string

Defined in: packages/react/src/jsx.ts:1163

Inherited from

WidgetProps.accessibleHelpText


accessibleHidden?

optional accessibleHidden: boolean

Defined in: packages/react/src/jsx.ts:1169

Inherited from

WidgetProps.accessibleHidden


accessibleInvalid?

optional accessibleInvalid: AccessibleInvalidState

Defined in: packages/react/src/jsx.ts:1170

Inherited from

WidgetProps.accessibleInvalid


accessibleKeyShortcuts?

optional accessibleKeyShortcuts: string

Defined in: packages/react/src/jsx.ts:1147

Inherited from

WidgetProps.accessibleKeyShortcuts


accessibleLabel?

optional accessibleLabel: string

Defined in: packages/react/src/jsx.ts:1148

Inherited from

WidgetProps.accessibleLabel


accessibleLabelledBy?

optional accessibleLabelledBy: Widget[]

Defined in: packages/react/src/jsx.ts:1185

Inherited from

WidgetProps.accessibleLabelledBy


accessibleLevel?

optional accessibleLevel: number

Defined in: packages/react/src/jsx.ts:1149

Inherited from

WidgetProps.accessibleLevel


accessibleModal?

optional accessibleModal: boolean

Defined in: packages/react/src/jsx.ts:1150

Inherited from

WidgetProps.accessibleModal


accessibleMultiLine?

optional accessibleMultiLine: boolean

Defined in: packages/react/src/jsx.ts:1151

Inherited from

WidgetProps.accessibleMultiLine


accessibleMultiSelectable?

optional accessibleMultiSelectable: boolean

Defined in: packages/react/src/jsx.ts:1152

Inherited from

WidgetProps.accessibleMultiSelectable


accessibleOrientation?

optional accessibleOrientation: Orientation

Defined in: packages/react/src/jsx.ts:1153

Inherited from

WidgetProps.accessibleOrientation


accessibleOwns?

optional accessibleOwns: Widget[]

Defined in: packages/react/src/jsx.ts:1186

Inherited from

WidgetProps.accessibleOwns


accessiblePlaceholder?

optional accessiblePlaceholder: string

Defined in: packages/react/src/jsx.ts:1154

Inherited from

WidgetProps.accessiblePlaceholder


accessiblePosInSet?

optional accessiblePosInSet: number

Defined in: packages/react/src/jsx.ts:1187

Inherited from

WidgetProps.accessiblePosInSet


accessiblePressed?

optional accessiblePressed: AccessibleTristate

Defined in: packages/react/src/jsx.ts:1171

Inherited from

WidgetProps.accessiblePressed


accessibleReadOnly?

optional accessibleReadOnly: boolean

Defined in: packages/react/src/jsx.ts:1155

Inherited from

WidgetProps.accessibleReadOnly


accessibleRequired?

optional accessibleRequired: boolean

Defined in: packages/react/src/jsx.ts:1156

Inherited from

WidgetProps.accessibleRequired


accessibleRole?

optional accessibleRole: 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

WidgetProps.accessibleRole


accessibleRoleDescription?

optional accessibleRoleDescription: string

Defined in: packages/react/src/jsx.ts:1157

Inherited from

WidgetProps.accessibleRoleDescription


accessibleRowCount?

optional accessibleRowCount: number

Defined in: packages/react/src/jsx.ts:1188

Inherited from

WidgetProps.accessibleRowCount


accessibleRowIndex?

optional accessibleRowIndex: number

Defined in: packages/react/src/jsx.ts:1189

Inherited from

WidgetProps.accessibleRowIndex


accessibleRowIndexText?

optional accessibleRowIndexText: string

Defined in: packages/react/src/jsx.ts:1190

Inherited from

WidgetProps.accessibleRowIndexText


accessibleRowSpan?

optional accessibleRowSpan: number

Defined in: packages/react/src/jsx.ts:1191

Inherited from

WidgetProps.accessibleRowSpan


accessibleSelected?

optional accessibleSelected: boolean

Defined in: packages/react/src/jsx.ts:1172

Inherited from

WidgetProps.accessibleSelected


accessibleSetSize?

optional accessibleSetSize: number

Defined in: packages/react/src/jsx.ts:1192

Inherited from

WidgetProps.accessibleSetSize


accessibleSort?

optional accessibleSort: AccessibleSort

Defined in: packages/react/src/jsx.ts:1158

Inherited from

WidgetProps.accessibleSort


accessibleValueMax?

optional accessibleValueMax: number

Defined in: packages/react/src/jsx.ts:1159

Inherited from

WidgetProps.accessibleValueMax


accessibleValueMin?

optional accessibleValueMin: number

Defined in: packages/react/src/jsx.ts:1160

Inherited from

WidgetProps.accessibleValueMin


accessibleValueNow?

optional accessibleValueNow: number

Defined in: packages/react/src/jsx.ts:1161

Inherited from

WidgetProps.accessibleValueNow


accessibleValueText?

optional accessibleValueText: string

Defined in: packages/react/src/jsx.ts:1162

Inherited from

WidgetProps.accessibleValueText


accessibleVisited?

optional accessibleVisited: boolean

Defined in: packages/react/src/jsx.ts:1173

Inherited from

WidgetProps.accessibleVisited


bottomMargin?

optional bottomMargin: number

Defined in: packages/react/src/generated/jsx.ts:8204

The bottom margin for text in the text view.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

Don't confuse this property with Widget.margin-bottom.


canFocus?

optional canFocus: 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

WidgetProps.canFocus


canTarget?

optional canTarget: boolean

Defined in: packages/react/src/generated/jsx.ts:26

Whether the widget can receive pointer events.

Inherited from

WidgetProps.canTarget


children?

optional children: ReactNode

Defined in: packages/react/src/generated/jsx.ts:314

Children elements (child widgets or event controllers).

Inherited from

WidgetProps.children


cssClasses?

optional cssClasses: string[]

Defined in: packages/react/src/generated/jsx.ts:28

A list of css classes applied to this widget.

Inherited from

WidgetProps.cssClasses


cssName?

optional cssName: 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

WidgetProps.cssName


cursor?

optional cursor: Cursor | null

Defined in: packages/react/src/generated/jsx.ts:37

The cursor used by widget.

Inherited from

AdwWindowProps.cursor


cursorVisible?

optional cursorVisible: boolean

Defined in: packages/react/src/generated/jsx.ts:8206

If the insertion cursor is shown.


editable?

optional editable: boolean

Defined in: packages/react/src/generated/jsx.ts:8208

Whether the text can be modified by the user.


enableUndo?

optional enableUndo: boolean

Defined in: packages/react/src/jsx.ts:659

Whether undo/redo is enabled on the text buffer

Inherited from

TextBufferProps.enableUndo


extraMenu?

optional extraMenu: MenuModel | null

Defined in: packages/react/src/generated/jsx.ts:8210

A menu model whose contents will be appended to the context menu.


focusable?

optional focusable: boolean

Defined in: packages/react/src/generated/jsx.ts:45

Whether this widget itself will accept the input focus.

Inherited from

WidgetProps.focusable


focusOnClick?

optional focusOnClick: 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

WidgetProps.focusOnClick


hadjustment?

optional hadjustment: Adjustment

Defined in: packages/react/src/generated/jsx.ts:8296

Horizontal GtkAdjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.


halign?

optional halign: Align

Defined in: packages/react/src/generated/jsx.ts:47

How to distribute horizontal space if widget gets extra space.

Inherited from

WidgetProps.halign


hasTooltip?

optional hasTooltip: 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

WidgetProps.hasTooltip


heightRequest?

optional heightRequest: 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

WidgetProps.heightRequest


hexpand?

optional hexpand: boolean

Defined in: packages/react/src/generated/jsx.ts:64

Whether to expand horizontally.

Inherited from

WidgetProps.hexpand


hexpandSet?

optional hexpandSet: boolean

Defined in: packages/react/src/generated/jsx.ts:66

Whether to use the hexpand property.

Inherited from

WidgetProps.hexpandSet


hscrollPolicy?

optional hscrollPolicy: ScrollablePolicy

Defined in: packages/react/src/generated/jsx.ts:8298

Determines when horizontal scrolling should start.


imModule?

optional imModule: string

Defined in: packages/react/src/generated/jsx.ts:8219

Which IM (input method) module should be used for this text_view.

See IMMulticontext.

Setting this to a non-%NULL value overrides the system-wide IM module setting. See the GtkSettings Settings.gtk-im-module property.


indent?

optional indent: number

Defined in: packages/react/src/generated/jsx.ts:8227

Amount to indent the paragraph, in pixels.

A negative value of indent will produce a hanging indentation. That is, the first line will have the full width, and subsequent lines will be indented by the absolute value of indent.


inputHints?

optional inputHints: InputHints

Defined in: packages/react/src/generated/jsx.ts:8232

Additional hints (beyond TextView.input-purpose) that allow input methods to fine-tune their behaviour.


inputPurpose?

optional inputPurpose: InputPurpose

Defined in: packages/react/src/generated/jsx.ts:8239

The purpose of this text field.

This property can be used by on-screen keyboards and other input methods to adjust their behaviour.


justification?

optional justification: Justification

Defined in: packages/react/src/generated/jsx.ts:8241

Left, right, or center justification.


layoutManager?

optional layoutManager: 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

AdwWindowProps.layoutManager


leftMargin?

optional leftMargin: number

Defined in: packages/react/src/generated/jsx.ts:8251

The default left margin for text in the text view.

Tags in the buffer may override the default.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.


limitEvents?

optional limitEvents: 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

WidgetProps.limitEvents


marginBottom?

optional marginBottom: 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

WidgetProps.marginBottom


marginEnd?

optional marginEnd: 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

WidgetProps.marginEnd


marginStart?

optional marginStart: 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

WidgetProps.marginStart


marginTop?

optional marginTop: 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

WidgetProps.marginTop


monospace?

optional monospace: boolean

Defined in: packages/react/src/generated/jsx.ts:8258

Whether text should be displayed in a monospace font.

If %TRUE, set the .monospace style class on the text view to indicate that a monospace font is desired.


name?

optional name: string

Defined in: packages/react/src/generated/jsx.ts:123

The name of the widget.

Inherited from

WidgetProps.name


onBackspace?

optional onBackspace: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8315

Gets emitted when the user asks for it.

The ::backspace signal is a keybinding signal.

The default bindings for this signal are Backspace and Shift+Backspace.


onBufferChanged?

optional onBufferChanged: (buffer) => void | null

Defined in: packages/react/src/jsx.ts:661

Callback fired when the buffer content changes

Inherited from

TextBufferProps.onBufferChanged


onCanRedoChanged?

optional onCanRedoChanged: (canRedo) => void | null

Defined in: packages/react/src/jsx.ts:669

Callback fired when the redo availability changes

Inherited from

TextBufferProps.onCanRedoChanged


onCanUndoChanged?

optional onCanUndoChanged: (canUndo) => void | null

Defined in: packages/react/src/jsx.ts:667

Callback fired when the undo availability changes

Inherited from

TextBufferProps.onCanUndoChanged


onCopyClipboard?

optional onCopyClipboard: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8325

Gets emitted to copy the selection to the clipboard.

The ::copy-clipboard signal is a keybinding signal.

The default bindings for this signal are Ctrl+c and Ctrl+Insert.


onCutClipboard?

optional onCutClipboard: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8335

Gets emitted to cut the selection to the clipboard.

The ::cut-clipboard signal is a keybinding signal.

The default bindings for this signal are Ctrl+x and Shift+Delete.


onDeleteFromCursor?

optional onDeleteFromCursor: (type, count, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8350

Gets emitted when the user initiates a text deletion.

The ::delete-from-cursor signal is a keybinding signal.

If the type is %GTK_DELETE_CHARS, GTK deletes the selection if there is one, otherwise it deletes the requested number of characters.

The default bindings for this signal are Delete for deleting a character, Ctrl+Delete for deleting a word and Ctrl+Backspace for deleting a word backwards.


onDestroy?

optional onDestroy: (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

WidgetProps.onDestroy


onDirectionChanged?

optional onDirectionChanged: (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


onExtendSelection?

optional onExtendSelection: (granularity, location, start, end, self) => boolean | null

Defined in: packages/react/src/generated/jsx.ts:8352

Emitted when the selection needs to be extended at location.


onHide?

optional onHide: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:200

Emitted when widget is hidden.

Inherited from

WidgetProps.onHide


onInsertAtCursor?

optional onInsertAtCursor: (string, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8369

Gets emitted when the user initiates the insertion of a fixed string at the cursor.

The ::insert-at-cursor signal is a keybinding signal.

This signal has no default bindings.


onInsertEmoji?

optional onInsertEmoji: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8379

Gets emitted to present the Emoji chooser for the text_view.

The ::insert-emoji signal is a keybinding signal.

The default bindings for this signal are Ctrl+. and Ctrl+;


onKeynavFailed?

optional onKeynavFailed: (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

WidgetProps.onKeynavFailed


onMap?

optional onMap: (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

WidgetProps.onMap


onMnemonicActivate?

optional onMnemonicActivate: (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


onMoveCursor?

optional onMoveCursor: (step, count, extendSelection, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8404

Gets emitted when the user initiates a cursor movement.

The ::move-cursor signal is a keybinding signal. If the cursor is not visible in text_view, this signal causes the viewport to be moved instead.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without it does not. There are too many key combinations to list them all here.

  • , , , move by individual characters/lines
  • Ctrl+, etc. move by words/paragraphs
  • Home and End move to the ends of the buffer
  • PgUp and PgDn move vertically by pages
  • Ctrl+PgUp and Ctrl+PgDn move horizontally by pages

onMoveFocus?

optional onMoveFocus: (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

WidgetProps.onMoveFocus


onMoveViewport?

optional onMoveViewport: (step, count, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8417

Gets emitted to move the viewport.

The ::move-viewport signal is a keybinding signal, which can be bound to key combinations to allow the user to move the viewport, i.e. change what part of the text view is visible in a containing scrolled window.

There are no default bindings for this signal.


onNotify?

optional onNotify: (pspec, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:312

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

WidgetProps.onNotify


onPasteClipboard?

optional onPasteClipboard: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8428

Gets emitted to paste the contents of the clipboard into the text view.

The ::paste-clipboard signal is a keybinding signal.

The default bindings for this signal are Ctrl+v and Shift+Insert.


onPreeditChanged?

optional onPreeditChanged: (preedit, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8439

Emitted when preedit text of the active IM changes.

If an input method is used, the typed text will not immediately be committed to the buffer. So if you are interested in the text, connect to this signal.

This signal is only emitted if the text at the given position is actually editable.


onQueryTooltip?

optional onQueryTooltip: (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

WidgetProps.onQueryTooltip


onRealize?

optional onRealize: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:259

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

WidgetProps.onRealize


onSelectAll?

optional onSelectAll: (select, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8451

Gets emitted to select or unselect the complete contents of the text view.

The ::select-all signal is a keybinding signal.

The default bindings for this signal are Ctrl+a and Ctrl+/ for selecting and Shift+Ctrl+a and Ctrl+`` for unselecting.


onSetAnchor?

optional onSetAnchor: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8462

Gets emitted when the user initiates settings the "anchor" mark.

The ::set-anchor signal is a keybinding signal which gets emitted when the user initiates setting the "anchor" mark. The "anchor" mark gets placed at the same position as the "insert" mark.

This signal has no default bindings.


onShow?

optional onShow: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:261

Emitted when widget is shown.

Inherited from

WidgetProps.onShow


onStateFlagsChanged?

optional onStateFlagsChanged: (flags, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:267

Emitted when the widget state changes.

See Widget.get_state_flags.

Inherited from

WidgetProps.onStateFlagsChanged


onTextDeleted?

optional onTextDeleted: (buffer, startOffset, endOffset) => void | null

Defined in: packages/react/src/jsx.ts:665

Callback fired when text is deleted from the buffer

Inherited from

TextBufferProps.onTextDeleted


onTextInserted?

optional onTextInserted: (buffer, offset, text) => void | null

Defined in: packages/react/src/jsx.ts:663

Callback fired when text is inserted into the buffer

Inherited from

TextBufferProps.onTextInserted


onToggleCursorVisible?

optional onToggleCursorVisible: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8471

Gets emitted to toggle the cursor-visible property.

The ::toggle-cursor-visible signal is a keybinding signal.

The default binding for this signal is F7.


onToggleOverwrite?

optional onToggleOverwrite: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:8479

Gets emitted to toggle the overwrite mode of the text view.

The ::toggle-overwrite signal is a keybinding signal.

The default binding for this signal is Insert.


onUnmap?

optional onUnmap: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:277

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

WidgetProps.onUnmap


onUnrealize?

optional onUnrealize: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:284

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

WidgetProps.onUnrealize


opacity?

optional opacity: number

Defined in: packages/react/src/generated/jsx.ts:125

The requested opacity of the widget.

Inherited from

WidgetProps.opacity


overflow?

optional overflow: 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

WidgetProps.overflow


overwrite?

optional overwrite: boolean

Defined in: packages/react/src/generated/jsx.ts:8260

Whether entered text overwrites existing contents.


pixelsAboveLines?

optional pixelsAboveLines: number

Defined in: packages/react/src/generated/jsx.ts:8262

Pixels of blank space above paragraphs.


pixelsBelowLines?

optional pixelsBelowLines: number

Defined in: packages/react/src/generated/jsx.ts:8264

Pixels of blank space below paragraphs.


pixelsInsideWrap?

optional pixelsInsideWrap: number

Defined in: packages/react/src/generated/jsx.ts:8266

Pixels of blank space between wrapped lines in a paragraph.


receivesDefault?

optional receivesDefault: boolean

Defined in: packages/react/src/generated/jsx.ts:134

Whether the widget will receive the default action when it is focused.

Inherited from

WidgetProps.receivesDefault


ref?

optional ref: Ref<TextView>

Defined in: packages/react/src/generated/jsx.ts:8480


rightMargin?

optional rightMargin: number

Defined in: packages/react/src/generated/jsx.ts:8276

The default right margin for text in the text view.

Tags in the buffer may override the default.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.


sensitive?

optional sensitive: boolean

Defined in: packages/react/src/generated/jsx.ts:136

Whether the widget responds to input.

Inherited from

WidgetProps.sensitive


tabs?

optional tabs: TabArray

Defined in: packages/react/src/generated/jsx.ts:8278

Custom tabs for this text.


tooltipMarkup?

optional tooltipMarkup: 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

AdwWindowProps.tooltipMarkup


tooltipText?

optional tooltipText: 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

AdwWindowProps.tooltipText


topMargin?

optional topMargin: number

Defined in: packages/react/src/generated/jsx.ts:8288

The top margin for text in the text view.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

Don't confuse this property with Widget.margin-top.


vadjustment?

optional vadjustment: Adjustment

Defined in: packages/react/src/generated/jsx.ts:8304

Vertical GtkAdjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.


valign?

optional valign: Align

Defined in: packages/react/src/generated/jsx.ts:169

How to distribute vertical space if widget gets extra space.

Inherited from

WidgetProps.valign


vexpand?

optional vexpand: boolean

Defined in: packages/react/src/generated/jsx.ts:171

Whether to expand vertically.

Inherited from

WidgetProps.vexpand


vexpandSet?

optional vexpandSet: boolean

Defined in: packages/react/src/generated/jsx.ts:173

Whether to use the vexpand property.

Inherited from

WidgetProps.vexpandSet


visible?

optional visible: boolean

Defined in: packages/react/src/generated/jsx.ts:175

Whether the widget is visible.

Inherited from

WidgetProps.visible


vscrollPolicy?

optional vscrollPolicy: ScrollablePolicy

Defined in: packages/react/src/generated/jsx.ts:8306

Determines when vertical scrolling should start.


widthRequest?

optional widthRequest: 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

WidgetProps.widthRequest


wrapMode?

optional wrapMode: WrapMode

Defined in: packages/react/src/generated/jsx.ts:8290

Whether to wrap lines never, at word boundaries, or at character boundaries.