Skip to main content

Interface: GtkSourceViewProps

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

Props for the GtkSourceView 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.

Inherited from

GtkTextViewProps.acceptsTab


accessibleActiveDescendant?

optional accessibleActiveDescendant: Widget

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

Inherited from

GtkTextViewProps.accessibleActiveDescendant


accessibleAutocomplete?

optional accessibleAutocomplete: AccessibleAutocomplete

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

Inherited from

GtkTextViewProps.accessibleAutocomplete


accessibleBusy?

optional accessibleBusy: boolean

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

Inherited from

GtkTextViewProps.accessibleBusy


accessibleChecked?

optional accessibleChecked: AccessibleTristate

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

Inherited from

GtkTextViewProps.accessibleChecked


accessibleColCount?

optional accessibleColCount: number

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

Inherited from

GtkTextViewProps.accessibleColCount


accessibleColIndex?

optional accessibleColIndex: number

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

Inherited from

GtkTextViewProps.accessibleColIndex


accessibleColIndexText?

optional accessibleColIndexText: string

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

Inherited from

GtkTextViewProps.accessibleColIndexText


accessibleColSpan?

optional accessibleColSpan: number

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

Inherited from

GtkTextViewProps.accessibleColSpan


accessibleControls?

optional accessibleControls: Widget[]

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

Inherited from

GtkTextViewProps.accessibleControls


accessibleDescribedBy?

optional accessibleDescribedBy: Widget[]

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

Inherited from

GtkTextViewProps.accessibleDescribedBy


accessibleDescription?

optional accessibleDescription: string

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

Inherited from

GtkTextViewProps.accessibleDescription


accessibleDetails?

optional accessibleDetails: Widget[]

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

Inherited from

GtkTextViewProps.accessibleDetails


accessibleDisabled?

optional accessibleDisabled: boolean

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

Inherited from

GtkTextViewProps.accessibleDisabled


accessibleErrorMessage?

optional accessibleErrorMessage: Widget[]

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

Inherited from

GtkTextViewProps.accessibleErrorMessage


accessibleExpanded?

optional accessibleExpanded: boolean

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

Inherited from

GtkTextViewProps.accessibleExpanded


accessibleFlowTo?

optional accessibleFlowTo: Widget[]

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

Inherited from

GtkTextViewProps.accessibleFlowTo


accessibleHasPopup?

optional accessibleHasPopup: boolean

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

Inherited from

GtkTextViewProps.accessibleHasPopup


accessibleHelpText?

optional accessibleHelpText: string

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

Inherited from

GtkTextViewProps.accessibleHelpText


accessibleHidden?

optional accessibleHidden: boolean

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

Inherited from

GtkTextViewProps.accessibleHidden


accessibleInvalid?

optional accessibleInvalid: AccessibleInvalidState

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

Inherited from

GtkTextViewProps.accessibleInvalid


accessibleKeyShortcuts?

optional accessibleKeyShortcuts: string

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

Inherited from

GtkTextViewProps.accessibleKeyShortcuts


accessibleLabel?

optional accessibleLabel: string

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

Inherited from

GtkTextViewProps.accessibleLabel


accessibleLabelledBy?

optional accessibleLabelledBy: Widget[]

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

Inherited from

GtkTextViewProps.accessibleLabelledBy


accessibleLevel?

optional accessibleLevel: number

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

Inherited from

GtkTextViewProps.accessibleLevel


accessibleModal?

optional accessibleModal: boolean

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

Inherited from

GtkTextViewProps.accessibleModal


accessibleMultiLine?

optional accessibleMultiLine: boolean

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

Inherited from

GtkTextViewProps.accessibleMultiLine


accessibleMultiSelectable?

optional accessibleMultiSelectable: boolean

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

Inherited from

GtkTextViewProps.accessibleMultiSelectable


accessibleOrientation?

optional accessibleOrientation: Orientation

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

Inherited from

GtkTextViewProps.accessibleOrientation


accessibleOwns?

optional accessibleOwns: Widget[]

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

Inherited from

GtkTextViewProps.accessibleOwns


accessiblePlaceholder?

optional accessiblePlaceholder: string

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

Inherited from

GtkTextViewProps.accessiblePlaceholder


accessiblePosInSet?

optional accessiblePosInSet: number

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

Inherited from

GtkTextViewProps.accessiblePosInSet


accessiblePressed?

optional accessiblePressed: AccessibleTristate

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

Inherited from

GtkTextViewProps.accessiblePressed


accessibleReadOnly?

optional accessibleReadOnly: boolean

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

Inherited from

GtkTextViewProps.accessibleReadOnly


accessibleRequired?

optional accessibleRequired: boolean

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

Inherited from

GtkTextViewProps.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

GtkTextViewProps.accessibleRole


accessibleRoleDescription?

optional accessibleRoleDescription: string

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

Inherited from

GtkTextViewProps.accessibleRoleDescription


accessibleRowCount?

optional accessibleRowCount: number

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

Inherited from

GtkTextViewProps.accessibleRowCount


accessibleRowIndex?

optional accessibleRowIndex: number

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

Inherited from

GtkTextViewProps.accessibleRowIndex


accessibleRowIndexText?

optional accessibleRowIndexText: string

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

Inherited from

GtkTextViewProps.accessibleRowIndexText


accessibleRowSpan?

optional accessibleRowSpan: number

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

Inherited from

GtkTextViewProps.accessibleRowSpan


accessibleSelected?

optional accessibleSelected: boolean

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

Inherited from

GtkTextViewProps.accessibleSelected


accessibleSetSize?

optional accessibleSetSize: number

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

Inherited from

GtkTextViewProps.accessibleSetSize


accessibleSort?

optional accessibleSort: AccessibleSort

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

Inherited from

GtkTextViewProps.accessibleSort


accessibleValueMax?

optional accessibleValueMax: number

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

Inherited from

GtkTextViewProps.accessibleValueMax


accessibleValueMin?

optional accessibleValueMin: number

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

Inherited from

GtkTextViewProps.accessibleValueMin


accessibleValueNow?

optional accessibleValueNow: number

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

Inherited from

GtkTextViewProps.accessibleValueNow


accessibleValueText?

optional accessibleValueText: string

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

Inherited from

GtkTextViewProps.accessibleValueText


accessibleVisited?

optional accessibleVisited: boolean

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

Inherited from

GtkTextViewProps.accessibleVisited


autoIndent?

optional autoIndent: boolean

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


backgroundPattern?

optional backgroundPattern: BackgroundPatternType

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

Draw a specific background pattern on the view.


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.

Inherited from

GtkTextViewProps.bottomMargin


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

GtkTextViewProps.canFocus


canTarget?

optional canTarget: boolean

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

Whether the widget can receive pointer events.

Inherited from

GtkTextViewProps.canTarget


children?

optional children: ReactNode

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

Children elements (child widgets or event controllers).

Inherited from

GtkTextViewProps.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

GtkTextViewProps.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

GtkTextViewProps.cssName


cursor?

optional cursor: Cursor | null

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

The cursor used by widget.

Inherited from

GtkTextViewProps.cursor


cursorVisible?

optional cursorVisible: boolean

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

If the insertion cursor is shown.

Inherited from

GtkTextViewProps.cursorVisible


editable?

optional editable: boolean

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

Whether the text can be modified by the user.

Inherited from

GtkTextViewProps.editable


enableSnippets?

optional enableSnippets: boolean

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

The property denotes if snippets should be expanded when the user presses Tab after having typed a word matching the snippets found in GtkSourceSnippetManager.

The user may tab through focus-positions of the snippet if any are available by pressing Tab repeatedly until the desired focus position is selected.


enableUndo?

optional enableUndo: boolean

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

Whether undo/redo is enabled on the text buffer

Inherited from

GtkTextViewProps.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.

Inherited from

GtkSourceViewProps.extraMenu


focusable?

optional focusable: boolean

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

Whether this widget itself will accept the input focus.

Inherited from

GtkTextViewProps.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

GtkTextViewProps.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.

Inherited from

GtkTextViewProps.hadjustment


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

GtkTextViewProps.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

GtkTextViewProps.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

GtkTextViewProps.heightRequest


hexpand?

optional hexpand: boolean

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

Whether to expand horizontally.

Inherited from

GtkTextViewProps.hexpand


hexpandSet?

optional hexpandSet: boolean

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

Whether to use the hexpand property.

Inherited from

GtkTextViewProps.hexpandSet


highlightCurrentLine?

optional highlightCurrentLine: boolean

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


highlightMatchingBrackets?

optional highlightMatchingBrackets: boolean

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

Whether matching brackets are highlighted


highlightSyntax?

optional highlightSyntax: boolean

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

Whether syntax highlighting is enabled


hscrollPolicy?

optional hscrollPolicy: ScrollablePolicy

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

Determines when horizontal scrolling should start.

Inherited from

GtkTextViewProps.hscrollPolicy


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.

Inherited from

GtkTextViewProps.imModule


implicitTrailingNewline?

optional implicitTrailingNewline: boolean

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

Whether the buffer has an implicit trailing newline


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.

Inherited from

GtkTextViewProps.indent


indenter?

optional indenter: Indenter | null

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

The property is a GtkSourceIndenter to use to indent as the user types into the GtkSourceView.


indentOnTab?

optional indentOnTab: boolean

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


indentWidth?

optional indentWidth: number

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

Width of an indentation step expressed in number of spaces.


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.

Inherited from

GtkTextViewProps.inputHints


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.

Inherited from

GtkTextViewProps.inputPurpose


insertSpacesInsteadOfTabs?

optional insertSpacesInsteadOfTabs: boolean

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


justification?

optional justification: Justification

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

Left, right, or center justification.

Inherited from

GtkTextViewProps.justification


language?

optional language: string | Language

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

Language for syntax highlighting (ID string or Language object)


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

GtkTextViewProps.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.

Inherited from

GtkTextViewProps.leftMargin


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

GtkTextViewProps.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

GtkTextViewProps.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

GtkTextViewProps.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

GtkTextViewProps.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

GtkTextViewProps.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.

Inherited from

GtkTextViewProps.monospace


name?

optional name: string

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

The name of the widget.

Inherited from

GtkTextViewProps.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.

Inherited from

GtkTextViewProps.onBackspace


onBufferChanged?

optional onBufferChanged: (buffer) => void | null

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

Callback fired when the buffer content changes

Inherited from

GtkTextViewProps.onBufferChanged


onCanRedoChanged?

optional onCanRedoChanged: (canRedo) => void | null

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

Callback fired when the redo availability changes

Inherited from

GtkTextViewProps.onCanRedoChanged


onCanUndoChanged?

optional onCanUndoChanged: (canUndo) => void | null

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

Callback fired when the undo availability changes

Inherited from

GtkTextViewProps.onCanUndoChanged


onChangeCase?

optional onChangeCase: (caseType, self) => void | null

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

Keybinding signal to change case of the text at the current cursor position.


onChangeNumber?

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

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

Keybinding signal to edit a number at the current cursor position.


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.

Inherited from

GtkTextViewProps.onCopyClipboard


onCursorMoved?

optional onCursorMoved: () => void | null

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

Callback fired when the cursor position changes


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.

Inherited from

GtkTextViewProps.onCutClipboard


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.

Inherited from

GtkTextViewProps.onDeleteFromCursor


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

GtkTextViewProps.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

GtkTextViewProps.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.

Inherited from

GtkTextViewProps.onExtendSelection


onHide?

optional onHide: (self) => void | null

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

Emitted when widget is hidden.

Inherited from

GtkTextViewProps.onHide


onHighlightUpdated?

optional onHighlightUpdated: (start, end) => void | null

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

Callback fired when the highlighted region is updated


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.

Inherited from

GtkTextViewProps.onInsertAtCursor


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+;

Inherited from

GtkTextViewProps.onInsertEmoji


onJoinLines?

optional onJoinLines: (self) => void | null

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

Keybinding signal to join the lines currently selected.


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

GtkTextViewProps.onKeynavFailed


onLineMarkActivated?

optional onLineMarkActivated: (iter, button, state, nPresses, self) => void | null

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

Emitted when a line mark has been activated (for instance when there was a button press in the line marks gutter).

You can use iter to determine on which line the activation took place.


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

GtkTextViewProps.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

GtkTextViewProps.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

Inherited from

GtkTextViewProps.onMoveCursor


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

GtkTextViewProps.onMoveFocus


onMoveLines?

optional onMoveLines: (down, self) => void | null

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

The signal is a keybinding which gets emitted when the user initiates moving a line.

The default binding key is Alt+Up/Down arrow. And moves the currently selected lines, or the current line up or down by one line.


onMoveToMatchingBracket?

optional onMoveToMatchingBracket: (extendSelection, self) => void | null

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

Keybinding signal to move the cursor to the matching bracket.


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.

Inherited from

GtkTextViewProps.onMoveViewport


onMoveWords?

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

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

The signal is a keybinding which gets emitted when the user initiates moving a word.

The default binding key is Alt+Left/Right Arrow and moves the current selection, or the current word by one word.


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

GtkTextViewProps.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.

Inherited from

GtkTextViewProps.onPasteClipboard


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.

Inherited from

GtkTextViewProps.onPreeditChanged


onPushSnippet?

optional onPushSnippet: (snippet, location, self) => void | null

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

The signal is emitted to insert a new snippet into the view.

If another snippet was active, it will be paused until all focus positions of snippet have been exhausted.

location will be updated to point at the end of the snippet.


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

GtkTextViewProps.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

GtkTextViewProps.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.

Inherited from

GtkTextViewProps.onSelectAll


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.

Inherited from

GtkTextViewProps.onSetAnchor


onShow?

optional onShow: (self) => void | null

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

Emitted when widget is shown.

Inherited from

GtkTextViewProps.onShow


onShowCompletion?

optional onShowCompletion: (self) => void | null

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

The signal is a key binding signal which gets emitted when the user requests a completion, by pressing Controlspace.

This will create a GtkSourceCompletionContext with the activation type as %GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED.

Applications should not connect to it, but may emit it with GObjectsignal_emit_by_name if they need to activate the completion by another means, for example with another key binding or a menu entry.


onSmartHomeEnd?

optional onSmartHomeEnd: (iter, count, self) => void | null

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

Emitted when a the cursor was moved according to the smart home end setting.

The signal is emitted after the cursor is moved, but during the TextView.:move-cursor action. This can be used to find out whether the cursor was moved by a normal home/end or by a smart home/end.


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

GtkTextViewProps.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

GtkTextViewProps.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

GtkTextViewProps.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.

Inherited from

GtkTextViewProps.onToggleCursorVisible


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.

Inherited from

GtkTextViewProps.onToggleOverwrite


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

GtkTextViewProps.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

GtkTextViewProps.onUnrealize


opacity?

optional opacity: number

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

The requested opacity of the widget.

Inherited from

GtkTextViewProps.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

GtkTextViewProps.overflow


overwrite?

optional overwrite: boolean

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

Whether entered text overwrites existing contents.

Inherited from

GtkTextViewProps.overwrite


pixelsAboveLines?

optional pixelsAboveLines: number

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

Pixels of blank space above paragraphs.

Inherited from

GtkTextViewProps.pixelsAboveLines


pixelsBelowLines?

optional pixelsBelowLines: number

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

Pixels of blank space below paragraphs.

Inherited from

GtkTextViewProps.pixelsBelowLines


pixelsInsideWrap?

optional pixelsInsideWrap: number

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

Pixels of blank space between wrapped lines in a paragraph.

Inherited from

GtkTextViewProps.pixelsInsideWrap


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

GtkTextViewProps.receivesDefault


ref?

optional ref: Ref<View>

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

Overrides

GtkTextViewProps.ref


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.

Inherited from

GtkTextViewProps.rightMargin


rightMarginPosition?

optional rightMarginPosition: number

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

Position of the right margin.


sensitive?

optional sensitive: boolean

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

Whether the widget responds to input.

Inherited from

GtkTextViewProps.sensitive


showLineMarks?

optional showLineMarks: boolean

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

Whether to display line mark pixbufs


showLineNumbers?

optional showLineNumbers: boolean

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

Whether to display line numbers


showRightMargin?

optional showRightMargin: boolean

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

Whether to display the right margin.


smartBackspace?

optional smartBackspace: boolean

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

Whether smart Backspace should be used.


smartHomeEnd?

optional smartHomeEnd: SmartHomeEndType

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

Set the behavior of the HOME and END keys.


styleScheme?

optional styleScheme: string | StyleScheme

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

Color scheme for syntax highlighting (ID string or StyleScheme object)


tabs?

optional tabs: TabArray

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

Custom tabs for this text.

Inherited from

GtkTextViewProps.tabs


tabWidth?

optional tabWidth: number

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

Width of a tab character expressed in number of spaces.


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

GtkTextViewProps.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

GtkTextViewProps.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.

Inherited from

GtkTextViewProps.topMargin


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.

Inherited from

GtkTextViewProps.vadjustment


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

GtkTextViewProps.valign


vexpand?

optional vexpand: boolean

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

Whether to expand vertically.

Inherited from

GtkTextViewProps.vexpand


vexpandSet?

optional vexpandSet: boolean

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

Whether to use the vexpand property.

Inherited from

GtkTextViewProps.vexpandSet


visible?

optional visible: boolean

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

Whether the widget is visible.

Inherited from

GtkTextViewProps.visible


vscrollPolicy?

optional vscrollPolicy: ScrollablePolicy

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

Determines when vertical scrolling should start.

Inherited from

GtkTextViewProps.vscrollPolicy


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

GtkTextViewProps.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.

Inherited from

GtkTextViewProps.wrapMode