Interface: SearchEntryProps

Defined in: react/src/generated/jsx.ts:4844

Props for the SearchEntry widget.

Extends

• WidgetProps

Properties

activatesDefault?

optional activatesDefault: boolean

Defined in: react/src/generated/jsx.ts:4846

Whether to activate the default widget when Enter is pressed.

---

canFocus?

optional canFocus: boolean

Defined in: react/src/generated/jsx.ts:412

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: react/src/generated/jsx.ts:414

Whether the widget can receive pointer events.

Inherited from

WidgetProps.canTarget

---

children?

optional children: ReactNode

Defined in: react/src/generated/jsx.ts:688

Inherited from

WidgetProps.children

---

cssClasses?

optional cssClasses: string[]

Defined in: react/src/generated/jsx.ts:416

A list of css classes applied to this widget.

Inherited from

WidgetProps.cssClasses

---

cssName?

optional cssName: string

Defined in: react/src/generated/jsx.ts:423

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: number

Defined in: react/src/generated/jsx.ts:425

The cursor used by @widget.

Inherited from

WidgetProps.cursor

---

cursorPosition?

optional cursorPosition: number

Defined in: react/src/generated/jsx.ts:4868

The current position of the insertion cursor in chars.

---

editable?

optional editable: boolean

Defined in: react/src/generated/jsx.ts:4870

Whether the entry contents can be edited.

---

enableUndo?

optional enableUndo: boolean

Defined in: react/src/generated/jsx.ts:4872

If undo/redo should be enabled for the editable.

---

focusable?

optional focusable: boolean

Defined in: react/src/generated/jsx.ts:433

Whether this widget itself will accept the input focus.

Inherited from

WidgetProps.focusable

---

focusOnClick?

optional focusOnClick: boolean

Defined in: react/src/generated/jsx.ts:431

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: react/src/generated/jsx.ts:435

How to distribute horizontal space if widget gets extra space.

Inherited from

WidgetProps.halign

---

hasDefault?

optional hasDefault: boolean

Defined in: react/src/generated/jsx.ts:437

Whether the widget is the default widget.

Inherited from

WidgetProps.hasDefault

---

hasFocus?

optional hasFocus: boolean

Defined in: react/src/generated/jsx.ts:439

Whether the widget has the input focus.

Inherited from

WidgetProps.hasFocus

---

hasTooltip?

optional hasTooltip: boolean

Defined in: react/src/generated/jsx.ts:448

Enables or disables the emission of the [signal@Gtk.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 [signal@Gtk.Widget::query-tooltip] to determine whether it will provide a tooltip or not.

Inherited from

WidgetProps.hasTooltip

---

heightRequest?

optional heightRequest: number

Defined in: react/src/generated/jsx.ts:454

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: react/src/generated/jsx.ts:456

Whether to expand horizontally.

Inherited from

WidgetProps.hexpand

---

hexpandSet?

optional hexpandSet: boolean

Defined in: react/src/generated/jsx.ts:458

Whether to use the hexpand property.

Inherited from

WidgetProps.hexpandSet

---

inputHints?

optional inputHints: InputHints

Defined in: react/src/generated/jsx.ts:4851

The hints about input for the GtkSearchEntry used to alter the behaviour of input methods.

---

inputPurpose?

optional inputPurpose: InputPurpose

Defined in: react/src/generated/jsx.ts:4856

The purpose for the GtkSearchEntry input used to alter the behaviour of input methods.

---

layoutManager?

optional layoutManager: LayoutManager

Defined in: react/src/generated/jsx.ts:466

The [class@Gtk.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

WidgetProps.layoutManager

---

limitEvents?

optional limitEvents: boolean

Defined in: react/src/generated/jsx.ts:475

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 [method@Gtk.EventController.set_propagation_limit].

Inherited from

WidgetProps.limitEvents

---

marginBottom?

optional marginBottom: number

Defined in: react/src/generated/jsx.ts:483

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 [method@Gtk.Widget.set_size_request] for example.

Inherited from

WidgetProps.marginBottom

---

marginEnd?

optional marginEnd: number

Defined in: react/src/generated/jsx.ts:494

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 [method@Gtk.Widget.set_size_request] for example.

Inherited from

WidgetProps.marginEnd

---

marginStart?

optional marginStart: number

Defined in: react/src/generated/jsx.ts:505

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 [method@Gtk.Widget.set_size_request] for example.

Inherited from

WidgetProps.marginStart

---

marginTop?

optional marginTop: number

Defined in: react/src/generated/jsx.ts:513

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 [method@Gtk.Widget.set_size_request] for example.

Inherited from

WidgetProps.marginTop

---

maxWidthChars?

optional maxWidthChars: number

Defined in: react/src/generated/jsx.ts:4874

The desired maximum width of the entry, in characters.

---

name?

optional name: string

Defined in: react/src/generated/jsx.ts:515

The name of the widget.

Inherited from

WidgetProps.name

---

onActivate()?

optional onActivate: (self) => void

Defined in: react/src/generated/jsx.ts:4893

Emitted when the entry is activated.

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

Parameters

Parameter	Type
self	SearchEntry

Returns

void

---

onChanged()?

optional onChanged: (self) => void

Defined in: react/src/generated/jsx.ts:4948

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

Parameters

Parameter	Type
self	SearchEntry

Returns

void

---

onDeleteText()?

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

Defined in: react/src/generated/jsx.ts:4960

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 [method@Gtk.Editable.delete_text].

Parameters

Parameter	Type
self	SearchEntry
startPos	number
endPos	number

Returns

void

---

onDestroy()?

optional onDestroy: (self) => void

Defined in: react/src/generated/jsx.ts:593

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.

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onDestroy

---

onDirectionChanged()?

optional onDirectionChanged: (self, previousDirection) => void

Defined in: react/src/generated/jsx.ts:595

Emitted when the text direction of a widget changes.

Parameters

Parameter	Type
self	Widget
previousDirection	TextDirection

Returns

void

Inherited from

WidgetProps.onDirectionChanged

---

onHide()?

optional onHide: (self) => void

Defined in: react/src/generated/jsx.ts:600

Emitted when widget is hidden.

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onHide

---

onInsertText()?

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

Defined in: react/src/generated/jsx.ts:4973

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.

Parameters

Parameter	Type
self	SearchEntry
text	string
length	number
position	Ref<number>

Returns

void

---

onKeynavFailed()?

optional onKeynavFailed: (self, direction) => boolean

Defined in: react/src/generated/jsx.ts:606

Emitted if keyboard navigation fails.

See [method@Gtk.Widget.keynav_failed] for details.

Parameters

Parameter	Type
self	Widget
direction	DirectionType

Returns

boolean

Inherited from

WidgetProps.onKeynavFailed

---

onMap()?

optional onMap: (self) => void

Defined in: react/src/generated/jsx.ts:618

Emitted when widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with [property@Gtk.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 [signal@Gtk.Widget::unmap].

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onMap

---

onMnemonicActivate()?

optional onMnemonicActivate: (self, groupCycling) => boolean

Defined in: react/src/generated/jsx.ts:624

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.

Parameters

Parameter	Type
self	Widget
groupCycling	boolean

Returns

boolean

Inherited from

WidgetProps.onMnemonicActivate

---

onMoveFocus()?

optional onMoveFocus: (self, direction) => void

Defined in: react/src/generated/jsx.ts:633

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.

Parameters

Parameter	Type
self	Widget
direction	DirectionType

Returns

void

Inherited from

WidgetProps.onMoveFocus

---

onNextMatch()?

optional onNextMatch: (self) => void

Defined in: react/src/generated/jsx.ts:4905

Emitted when the user initiates a move to the next match for the current search string.

This is a keybinding signal.

Applications should connect to it, to implement moving between matches.

The default bindings for this signal is Ctrl+g.

Parameters

Parameter	Type
self	SearchEntry

Returns

void

---

onPreviousMatch()?

optional onPreviousMatch: (self) => void

Defined in: react/src/generated/jsx.ts:4918

Emitted when the user initiates a move to the previous match for the current search string.

This is a keybinding signal.

Applications should connect to it, to implement moving between matches.

The default bindings for this signal is Ctrl+Shift+g.

Parameters

Parameter	Type
self	SearchEntry

Returns

void

---

onQueryTooltip()?

optional onQueryTooltip: (self, x, y, keyboardMode, tooltip) => boolean

Defined in: react/src/generated/jsx.ts:648

Emitted when the widget’s tooltip is about to be shown.

This happens when the [property@Gtk.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.

Parameters

Parameter	Type
self	Widget
x	number
y	number
keyboardMode	boolean
tooltip	Tooltip

Returns

boolean

Inherited from

WidgetProps.onQueryTooltip

---

onRealize()?

optional onRealize: (self) => void

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

Emitted when widget is associated with a GdkSurface.

This means that [method@Gtk.Widget.realize] has been called or the widget has been mapped (that is, it is going to be drawn).

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onRealize

---

onSearchChanged()?

optional onSearchChanged: (self) => void

Defined in: react/src/generated/jsx.ts:4924

Emitted with a delay. The length of the delay can be changed with the [property@Gtk.SearchEntry:search-delay] property.

Parameters

Parameter	Type
self	SearchEntry

Returns

void

---

onSearchStarted()?

optional onSearchStarted: (self) => void

Defined in: react/src/generated/jsx.ts:4926

Emitted when the user initiated a search on the entry.

Parameters

Parameter	Type
self	SearchEntry

Returns

void

---

onShow()?

optional onShow: (self) => void

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

Emitted when widget is shown.

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onShow

---

onStateFlagsChanged()?

optional onStateFlagsChanged: (self, flags) => void

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

Emitted when the widget state changes.

See [method@Gtk.Widget.get_state_flags].

Parameters

Parameter	Type
self	Widget
flags	StateFlags

Returns

void

Inherited from

WidgetProps.onStateFlagsChanged

---

onStopSearch()?

optional onStopSearch: (self) => void

Defined in: react/src/generated/jsx.ts:4937

Emitted when the user stops a search via keyboard input.

This is a keybinding signal.

Applications should connect to it, to implement hiding the search entry in this case.

The default bindings for this signal is Escape.

Parameters

Parameter	Type
self	SearchEntry

Returns

void

---

onUnmap()?

optional onUnmap: (self) => void

Defined in: react/src/generated/jsx.ts:679

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.

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onUnmap

---

onUnrealize()?

optional onUnrealize: (self) => void

Defined in: react/src/generated/jsx.ts:686

Emitted when the GdkSurface associated with widget is destroyed.

This means that [method@Gtk.Widget.unrealize] has been called or the widget has been unmapped (that is, it is going to be hidden).

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onUnrealize

---

opacity?

optional opacity: number

Defined in: react/src/generated/jsx.ts:517

The requested opacity of the widget.

Inherited from

WidgetProps.opacity

---

overflow?

optional overflow: Overflow

Defined in: react/src/generated/jsx.ts:524

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

---

parent?

optional parent: Widget

Defined in: react/src/generated/jsx.ts:526

The parent widget of this widget.

Inherited from

WidgetProps.parent

---

placeholderText?

optional placeholderText: string

Defined in: react/src/generated/jsx.ts:4861

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

---

receivesDefault?

optional receivesDefault: boolean

Defined in: react/src/generated/jsx.ts:528

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

Inherited from

WidgetProps.receivesDefault

---

ref?

optional ref: Ref<SearchEntry>

Defined in: react/src/generated/jsx.ts:4980

---

root?

optional root: Root

Defined in: react/src/generated/jsx.ts:534

The GtkRoot widget of the widget tree containing this widget.

This will be NULL if the widget is not contained in a root widget.

Inherited from

WidgetProps.root

---

scaleFactor?

optional scaleFactor: number

Defined in: react/src/generated/jsx.ts:536

The scale factor of the widget.

Inherited from

WidgetProps.scaleFactor

---

searchDelay?

optional searchDelay: number

Defined in: react/src/generated/jsx.ts:4866

The delay in milliseconds from last keypress to the search changed signal.

---

selectionBound?

optional selectionBound: number

Defined in: react/src/generated/jsx.ts:4876

The position of the opposite end of the selection from the cursor in chars.

---

sensitive?

optional sensitive: boolean

Defined in: react/src/generated/jsx.ts:538

Whether the widget responds to input.

Inherited from

WidgetProps.sensitive

---

text?

optional text: string

Defined in: react/src/generated/jsx.ts:4878

The contents of the entry.

---

tooltipMarkup?

optional tooltipMarkup: string

Defined in: react/src/generated/jsx.ts:554

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see [method@Gtk.Tooltip.set_markup].

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: [property@Gtk.Widget:has-tooltip] will automatically be set to true and there will be taken care of [signal@Gtk.Widget::query-tooltip] in the default signal handler.

Note that if both [property@Gtk.Widget:tooltip-text] and [property@Gtk.Widget:tooltip-markup] are set, the last one wins.

Inherited from

WidgetProps.tooltipMarkup

---

tooltipText?

optional tooltipText: string

Defined in: react/src/generated/jsx.ts:569

Sets the text of tooltip to be the given string.

Also see [method@Gtk.Tooltip.set_text].

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: [property@Gtk.Widget:has-tooltip] will automatically be set to true and there will be taken care of [signal@Gtk.Widget::query-tooltip] in the default signal handler.

Note that if both [property@Gtk.Widget:tooltip-text] and [property@Gtk.Widget:tooltip-markup] are set, the last one wins.

Inherited from

WidgetProps.tooltipText

---

valign?

optional valign: Align

Defined in: react/src/generated/jsx.ts:571

How to distribute vertical space if widget gets extra space.

Inherited from

WidgetProps.valign

---

vexpand?

optional vexpand: boolean

Defined in: react/src/generated/jsx.ts:573

Whether to expand vertically.

Inherited from

WidgetProps.vexpand

---

vexpandSet?

optional vexpandSet: boolean

Defined in: react/src/generated/jsx.ts:575

Whether to use the vexpand property.

Inherited from

WidgetProps.vexpandSet

---

visible?

optional visible: boolean

Defined in: react/src/generated/jsx.ts:577

Whether the widget is visible.

Inherited from

WidgetProps.visible

---

widthChars?

optional widthChars: number

Defined in: react/src/generated/jsx.ts:4880

Number of characters to leave space for in the entry.

---

widthRequest?

optional widthRequest: number

Defined in: react/src/generated/jsx.ts:583

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: react/src/generated/jsx.ts:4886

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

Reversed for RTL layouts.