Skip to main content

Interface: GtkEntryProps

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

Props for the GtkEntry widget.

Extends

Properties

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


activatesDefault?

optional activatesDefault: boolean

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

Whether to activate the default widget when Enter is pressed.


attributes?

optional attributes: AttrList

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

A list of Pango attributes to apply to the text of the entry.

This is mainly useful to change the size or weight of the text.

The PangoAttribute's start_index and end_index must refer to the EntryBuffer text, i.e. without the preedit string.


buffer?

optional buffer: EntryBuffer

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

The buffer object which actually stores the text.


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


completion?

optional completion: EntryCompletion | null

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

The auxiliary completion object to use with the entry.


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


editable?

optional editable: boolean

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

Whether the entry contents can be edited.


editingCanceled?

optional editingCanceled: boolean

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

Indicates whether editing on the cell has been canceled.


enableEmojiCompletion?

optional enableEmojiCompletion: boolean

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

Whether to suggest Emoji replacements for :-delimited names like :heart:.


enableUndo?

optional enableUndo: boolean

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

If undo/redo should be enabled for the editable.


extraMenu?

optional extraMenu: MenuModel | null

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

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


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


hasFrame?

optional hasFrame: boolean

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

Whether the entry should draw a frame.


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


imModule?

optional imModule: string

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

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

See IMContext.

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


inputHints?

optional inputHints: InputHints

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

Additional hints that allow input methods to fine-tune their behavior.

Also see Entry.input-purpose


inputPurpose?

optional inputPurpose: InputPurpose

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

The purpose of this text field.

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

Note that setting the purpose to %GTK_INPUT_PURPOSE_PASSWORD or %GTK_INPUT_PURPOSE_PIN is independent from setting Entry.visibility.


invisibleChar?

optional invisibleChar: number

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

The character to use when masking entry contents (“password mode”).


invisibleCharSet?

optional invisibleCharSet: boolean

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

Whether the invisible char has been set for the GtkEntry.


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


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


maxLength?

optional maxLength: number

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

Maximum number of characters for this entry.


maxWidthChars?

optional maxWidthChars: number

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

The desired maximum width of the entry, in characters.


optional menuEntryIconPrimaryText: string

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

Text for an item in the context menu to activate the primary icon action.

When the primary icon is activatable and this property has been set, a new entry in the context menu of this GtkEntry will appear with this text. Selecting that menu entry will result in the primary icon being activated, exactly in the same way as it would be activated from a mouse click.

This simplifies adding accessibility support to applications using activatable icons. The activatable icons aren't focusable when navigating the interface with the keyboard This is why Gtk recommends to also add those actions in the context menu. This set of methods greatly simplifies this, by adding a menu item that, when enabled, calls the same callback than clicking on the icon.


optional menuEntryIconSecondaryText: string

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

Text for an item in the context menu to activate the secondary icon action.

When the primary icon is activatable and this property has been set, a new entry in the context menu of this GtkEntry will appear with this text. Selecting that menu entry will result in the primary icon being activated, exactly in the same way as it would be activated from a mouse click.

This simplifies adding accessibility support to applications using activatable icons. The activatable icons aren't focusable when navigating the interface with the keyboard This is why Gtk recommends to also add those actions in the context menu. This set of methods greatly simplifies this, by adding a menu item that, when enabled, calls the same callback than clicking on the icon.


name?

optional name: string

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

The name of the widget.

Inherited from

WidgetProps.name


onActivate?

optional onActivate: (self) => void | null

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

Emitted when the entry is activated.

The keybindings for this signal are all forms of the Enter key.


onChanged?

optional onChanged: (self) => void | null

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

Emitted at the end of a single user-visible operation on the contents.

E.g., a paste operation that replaces the contents of the selection will cause only one signal emission (even though it is implemented by first deleting the selection, then inserting the new content, and may cause multiple ::notify::text signals to be emitted).


onDeleteText?

optional onDeleteText: (startPos, endPos, self) => void | null

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

Emitted when text is deleted from the widget by the user.

The default handler for this signal will normally be responsible for deleting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the range of deleted text, or prevent it from being deleted entirely.

The start_pos and end_pos parameters are interpreted as for Editable.delete_text.


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


onEditingDone?

optional onEditingDone: (self) => void | null

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

This signal is a sign for the cell renderer to update its value from the cell_editable.

Implementations of GtkCellEditable are responsible for emitting this signal when they are done editing, e.g. GtkEntry emits this signal when the user presses Enter. Typical things to do in a handler for ::editing-done are to capture the edited value, disconnect the cell_editable from signals on the GtkCellRenderer, etc.

gtk_cell_editable_editing_done() is a convenience method for emitting GtkCellEditable::editing-done.


onHide?

optional onHide: (self) => void | null

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

Emitted when widget is hidden.

Inherited from

WidgetProps.onHide


onIconPress?

optional onIconPress: (iconPos, self) => void | null

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

Emitted when an activatable icon is clicked.


onIconRelease?

optional onIconRelease: (iconPos, self) => void | null

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

Emitted on the button release from a mouse click over an activatable icon.


onInsertText?

optional onInsertText: (text, length, position, self) => void | null

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

Emitted when text is inserted into the widget by the user.

The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the inserted text, or prevent it from being inserted entirely.


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


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


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


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


onRemoveWidget?

optional onRemoveWidget: (self) => void | null

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

This signal is meant to indicate that the cell is finished editing, and the cell_editable widget is being removed and may subsequently be destroyed.

Implementations of GtkCellEditable are responsible for emitting this signal when they are done editing. It must be emitted after the GtkCellEditable::editing-done signal, to give the cell renderer a chance to update the cell's value before the widget is removed.

gtk_cell_editable_remove_widget() is a convenience method for emitting GtkCellEditable::remove-widget.


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


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


overwriteMode?

optional overwriteMode: boolean

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

If text is overwritten when typing in the GtkEntry.


placeholderText?

optional placeholderText: string | null

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

The text that will be displayed in the GtkEntry when it is empty and unfocused.


primaryIconActivatable?

optional primaryIconActivatable: boolean

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

Whether the primary icon is activatable.

GTK emits the Entry.:icon-press and Entry.:icon-release signals only on sensitive, activatable icons.

Sensitive, but non-activatable icons can be used for purely informational purposes.


primaryIconGicon?

optional primaryIconGicon: Icon

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

The GIcon to use for the primary icon for the entry.


primaryIconName?

optional primaryIconName: string

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

The icon name to use for the primary icon for the entry.


primaryIconPaintable?

optional primaryIconPaintable: Paintable

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

A GdkPaintable to use as the primary icon for the entry.


primaryIconSensitive?

optional primaryIconSensitive: boolean

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

Whether the primary icon is sensitive.

An insensitive icon appears grayed out. GTK does not emit the Entry.:icon-press and Entry.:icon-release signals and does not allow DND from insensitive icons.

An icon should be set insensitive if the action that would trigger when clicked is currently not available.


primaryIconTooltipMarkup?

optional primaryIconTooltipMarkup: string

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

The contents of the tooltip on the primary icon, with markup.

Also see Entry.set_icon_tooltip_markup.


primaryIconTooltipText?

optional primaryIconTooltipText: string

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

The contents of the tooltip on the primary icon.

Also see Entry.set_icon_tooltip_text.


progressFraction?

optional progressFraction: number

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

The current fraction of the task that's been completed.


progressPulseStep?

optional progressPulseStep: number

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

The fraction of total entry width to move the progress bouncing block for each pulse.

See Entry.progress_pulse.


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<Entry>

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


secondaryIconActivatable?

optional secondaryIconActivatable: boolean

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

Whether the secondary icon is activatable.

GTK emits the Entry.:icon-press and Entry.:icon-release signals only on sensitive, activatable icons.

Sensitive, but non-activatable icons can be used for purely informational purposes.


secondaryIconGicon?

optional secondaryIconGicon: Icon

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

The GIcon to use for the secondary icon for the entry.


secondaryIconName?

optional secondaryIconName: string

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

The icon name to use for the secondary icon for the entry.


secondaryIconPaintable?

optional secondaryIconPaintable: Paintable

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

A GdkPaintable to use as the secondary icon for the entry.


secondaryIconSensitive?

optional secondaryIconSensitive: boolean

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

Whether the secondary icon is sensitive.

An insensitive icon appears grayed out. GTK does not emit the Entry.:icon-press[ and [signal`Gtk`.Entryicon-release signals and does not allow DND from insensitive icons.

An icon should be set insensitive if the action that would trigger when clicked is currently not available.


secondaryIconTooltipMarkup?

optional secondaryIconTooltipMarkup: string

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

The contents of the tooltip on the secondary icon, with markup.

Also see Entry.set_icon_tooltip_markup.


secondaryIconTooltipText?

optional secondaryIconTooltipText: string

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

The contents of the tooltip on the secondary icon.

Also see Entry.set_icon_tooltip_text.


sensitive?

optional sensitive: boolean

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

Whether the widget responds to input.

Inherited from

WidgetProps.sensitive


showEmojiIcon?

optional showEmojiIcon: boolean

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

Whether the entry will show an Emoji icon in the secondary icon position to open the Emoji chooser.


tabs?

optional tabs: TabArray | null

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

A list of tabstops to apply to the text of the entry.


text?

optional text: string

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

The contents of the entry.


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


truncateMultiline?

optional truncateMultiline: boolean

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

When %TRUE, pasted multi-line text is truncated to the first line.


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


visibility?

optional visibility: boolean

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

Whether the entry should show the “invisible char” instead of the actual text (“password mode”).


visible?

optional visible: boolean

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

Whether the widget is visible.

Inherited from

WidgetProps.visible


widthChars?

optional widthChars: number

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

Number of characters to leave space for in the entry.


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


xalign?

optional xalign: number

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

The horizontal alignment, from 0 (left) to 1 (right).

Reversed for RTL layouts.