Package org.gnome.gtk

Class SearchEntry

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.SearchEntry

All Implemented Interfaces:

Proxy, Accessible, Buildable, ConstraintTarget, Editable

@Generated("io.github.jwharm.JavaGI")
public class SearchEntry
extends Widget
implements Accessible, Buildable, ConstraintTarget, Editable

GtkSearchEntry is an entry widget that has been tailored for use as a search entry.

The main API for interacting with a GtkSearchEntry as entry is the GtkEditable interface.

It will show an inactive symbolic “find” icon when the search entry is empty, and a symbolic “clear” icon when there is text. Clicking on the “clear” icon will empty the search entry.

To make filtering appear more reactive, it is a good idea to not react to every change in the entry text immediately, but only after a short delay. To support this, GtkSearchEntry emits the Gtk.SearchEntry::search-changed signal which can be used instead of the Gtk.Editable::changed signal.

The Gtk.SearchEntry::previous-match, Gtk.SearchEntry::next-match and Gtk.SearchEntry::stop-search signals can be used to implement moving between search results and ending the search.

Often, GtkSearchEntry will be fed events by means of being placed inside a SearchBar. If that is not the case, you can use setKeyCaptureWidget(org.gnome.gtk.Widget) to let it capture key input from another widget.

GtkSearchEntry provides only minimal API and should be used with the Editable API.

Shortcuts and Gestures
The following signals have default keybindings:

• Gtk.SearchEntry::activate
• Gtk.SearchEntry::next-match
• Gtk.SearchEntry::previous-match
• Gtk.SearchEntry::stop-search

CSS Nodes

 entry.search
 ╰── text
 

GtkSearchEntry has a single CSS node with name entry that carries a .search style class, and the text node is a child of that.

Accessibility
GtkSearchEntry uses the AccessibleRole.SEARCH_BOX role.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchEntry.ActivateCallback	Functional interface declaration of the ActivateCallback callback.
static class	SearchEntry.Builder<B extends SearchEntry.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	SearchEntry.NextMatchCallback	Functional interface declaration of the NextMatchCallback callback.
static interface	SearchEntry.PreviousMatchCallback	Functional interface declaration of the PreviousMatchCallback callback.
static interface	SearchEntry.SearchChangedCallback	Functional interface declaration of the SearchChangedCallback callback.
static interface	SearchEntry.SearchStartedCallback	Functional interface declaration of the SearchStartedCallback callback.
static interface	SearchEntry.StopSearchCallback	Functional interface declaration of the StopSearchCallback callback.

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.WidgetClass, Widget.WidgetImpl

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.AccessibleImpl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.BuildableIface, Buildable.BuildableImpl

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTargetImpl, ConstraintTarget.ConstraintTargetInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Editable

Editable.ChangedCallback, Editable.DeleteTextCallback, Editable.EditableImpl, Editable.EditableInterface, Editable.InsertTextCallback

Constructor Summary

Constructors

Constructor	Description
SearchEntry()	Creates a GtkSearchEntry.
SearchEntry(MemorySegment address)	Create a SearchEntry proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected SearchEntry	asParent()	Returns this instance as if it were its parent type.
static SearchEntry.Builder<? extends SearchEntry.Builder>	builder()	A SearchEntry.Builder object constructs a SearchEntry with the specified properties.
void	emitActivate()	Emits the "activate" signal.
void	emitNextMatch()	Emits the "next-match" signal.
void	emitPreviousMatch()	Emits the "previous-match" signal.
void	emitSearchChanged()	Emits the "search-changed" signal.
void	emitSearchStarted()	Emits the "search-started" signal.
void	emitStopSearch()	Emits the "stop-search" signal.
Set<InputHints>	getInputHints()	Gets the input purpose for this SearchEntry.
InputPurpose	getInputPurpose()	Gets the input purpose of this SearchEntry.
Widget	getKeyCaptureWidget()	Gets the widget that this SearchEntry is capturing key events from.
String	getPlaceholderText()	Gets the placeholder text associated with this SearchEntry.
int	getSearchDelay()	Get the delay to be used between the last keypress and the Gtk.SearchEntry::search-changed signal being emitted.
static Type	getType()	Get the GType of the SearchEntry class
SignalConnection<SearchEntry.ActivateCallback>	onActivate(SearchEntry.ActivateCallback handler)	Emitted when the entry is activated.
SignalConnection<SearchEntry.NextMatchCallback>	onNextMatch(SearchEntry.NextMatchCallback handler)	Emitted when the user initiates a move to the next match for the current search string.
SignalConnection<SearchEntry.PreviousMatchCallback>	onPreviousMatch(SearchEntry.PreviousMatchCallback handler)	Emitted when the user initiates a move to the previous match for the current search string.
SignalConnection<SearchEntry.SearchChangedCallback>	onSearchChanged(SearchEntry.SearchChangedCallback handler)	Emitted with a delay.
SignalConnection<SearchEntry.SearchStartedCallback>	onSearchStarted(SearchEntry.SearchStartedCallback handler)	Emitted when the user initiated a search on the entry.
SignalConnection<SearchEntry.StopSearchCallback>	onStopSearch(SearchEntry.StopSearchCallback handler)	Emitted when the user stops a search via keyboard input.
void	setInputHints(Set<InputHints> hints)	Sets the input hints for this SearchEntry.
void	setInputHints(InputHints... hints)	Sets the input hints for this SearchEntry.
void	setInputPurpose(InputPurpose purpose)	Sets the input purpose of this SearchEntry.
void	setKeyCaptureWidget(@Nullable Widget widget)	Sets widget as the widget that this SearchEntry will capture key events from.
void	setPlaceholderText(@Nullable String text)	Sets the placeholder text associated with this SearchEntry.
void	setSearchDelay(int delay)	Set the delay to be used between the last keypress and the Gtk.SearchEntry::search-changed signal being emitted.

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMemoryLayout, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.gnome.gtk.Editable

delegateGetAccessiblePlatformState, deleteSelection, deleteText, emitChanged, emitDeleteText, emitInsertText, finishDelegate, getAlignment, getChars, getDelegate, getEditable, getEnableUndo, getMaxWidthChars, getPosition, getSelectionBounds, getText, getWidthChars, initDelegate, insertText, onChanged, onDeleteText, onInsertText, selectRegion, setAlignment, setEditable, setEnableUndo, setMaxWidthChars, setPosition, setText, setWidthChars

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

SearchEntry

public SearchEntry(MemorySegment address)

Create a SearchEntry proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

SearchEntry

public SearchEntry()

Creates a GtkSearchEntry.

Method Details

getType

public static Type getType()

Get the GType of the SearchEntry class

Returns:

the GType

asParent

protected SearchEntry asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class Widget

getInputHints

public Set<InputHints> getInputHints()

Gets the input purpose for this SearchEntry.

Returns:

The input hints

getInputPurpose

public InputPurpose getInputPurpose()

Gets the input purpose of this SearchEntry.

Returns:

The input hints

getKeyCaptureWidget

public Widget getKeyCaptureWidget()

Gets the widget that this SearchEntry is capturing key events from.

Returns:

The key capture widget.

getPlaceholderText

public String getPlaceholderText()

Gets the placeholder text associated with this SearchEntry.

Returns:

The placeholder text.

getSearchDelay

public int getSearchDelay()

Get the delay to be used between the last keypress and the Gtk.SearchEntry::search-changed signal being emitted.

Returns:

a delay in milliseconds.

setInputHints

public void setInputHints(Set<InputHints> hints)

Sets the input hints for this SearchEntry.

Parameters:

hints - the new input hints

setInputHints

public void setInputHints(InputHints... hints)

Sets the input hints for this SearchEntry.

Parameters:

hints - the new input hints

setInputPurpose

public void setInputPurpose(InputPurpose purpose)

Sets the input purpose of this SearchEntry.

Parameters:

purpose - the new input purpose

setKeyCaptureWidget

public void setKeyCaptureWidget(@Nullable
 @Nullable Widget widget)

Sets widget as the widget that this SearchEntry will capture key events from.

Key events are consumed by the search entry to start or continue a search.

If the entry is part of a GtkSearchBar, it is preferable to call SearchBar.setKeyCaptureWidget(org.gnome.gtk.Widget) instead, which will reveal the entry in addition to triggering the search entry.

Note that despite the name of this function, the events are only 'captured' in the bubble phase, which means that editable child widgets of widget will receive text input before it gets captured. If that is not desired, you can capture and forward the events yourself with EventControllerKey.forward(org.gnome.gtk.Widget).

Parameters:

widget - a GtkWidget

setPlaceholderText

public void setPlaceholderText(@Nullable
 @Nullable String text)

Sets the placeholder text associated with this SearchEntry.

Parameters:

text - the text to set as a placeholder

setSearchDelay

public void setSearchDelay(int delay)

Set the delay to be used between the last keypress and the Gtk.SearchEntry::search-changed signal being emitted.

Parameters:

delay - a delay in milliseconds

onActivate

public SignalConnection<SearchEntry.ActivateCallback> onActivate(SearchEntry.ActivateCallback handler)

Emitted when the entry is activated.

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

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SearchEntry.ActivateCallback.run()

emitActivate

public void emitActivate()

Emits the "activate" signal. See onActivate(org.gnome.gtk.SearchEntry.ActivateCallback).

onNextMatch

public SignalConnection<SearchEntry.NextMatchCallback> onNextMatch(SearchEntry.NextMatchCallback handler)

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:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SearchEntry.NextMatchCallback.run()

emitNextMatch

public void emitNextMatch()

Emits the "next-match" signal. See onNextMatch(org.gnome.gtk.SearchEntry.NextMatchCallback).

onPreviousMatch

public SignalConnection<SearchEntry.PreviousMatchCallback> onPreviousMatch(SearchEntry.PreviousMatchCallback handler)

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:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SearchEntry.PreviousMatchCallback.run()

emitPreviousMatch

public void emitPreviousMatch()

Emits the "previous-match" signal. See onPreviousMatch(org.gnome.gtk.SearchEntry.PreviousMatchCallback).

onSearchChanged

public SignalConnection<SearchEntry.SearchChangedCallback> onSearchChanged(SearchEntry.SearchChangedCallback handler)

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

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SearchEntry.SearchChangedCallback.run()

emitSearchChanged

public void emitSearchChanged()

Emits the "search-changed" signal. See onSearchChanged(org.gnome.gtk.SearchEntry.SearchChangedCallback).

onSearchStarted

public SignalConnection<SearchEntry.SearchStartedCallback> onSearchStarted(SearchEntry.SearchStartedCallback handler)

Emitted when the user initiated a search on the entry.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SearchEntry.SearchStartedCallback.run()

emitSearchStarted

public void emitSearchStarted()

Emits the "search-started" signal. See onSearchStarted(org.gnome.gtk.SearchEntry.SearchStartedCallback).

onStopSearch

public SignalConnection<SearchEntry.StopSearchCallback> onStopSearch(SearchEntry.StopSearchCallback handler)

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:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SearchEntry.StopSearchCallback.run()

emitStopSearch

public void emitStopSearch()

Emits the "stop-search" signal. See onStopSearch(org.gnome.gtk.SearchEntry.StopSearchCallback).

builder

public static SearchEntry.Builder<? extends SearchEntry.Builder> builder()

A SearchEntry.Builder object constructs a SearchEntry with the specified properties. Use the various set...() methods to set properties, and finish construction with SearchEntry.Builder.build().