SearchEntry

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_search_entry_get_type ()" ) ]
public class SearchEntry : Widget, Accessible, Buildable, ConstraintTarget, Editable

A single-line text entry widget 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 [signal@Gtk.SearchEntry:GtkSearchEntry:search-changed] signal which can be used instead of the [signal@Gtk.Editable:GtkSearchEntry:changed] signal.

The [signal@Gtk.SearchEntry:GtkSearchEntry:previous-match], [signal@Gtk.SearchEntry:GtkSearchEntry:next-match] and [signal@Gtk.SearchEntry:GtkSearchEntry: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 [class@Gtk.SearchBar]. If that is not the case, you can use [method@Gtk.SearchEntry.set_key_capture_widget] to let it capture key input from another widget.

`GtkSearchEntry` provides only minimal API and should be used with the [iface@Gtk.Editable] API.

Shortcuts and Gestures

The following signals have default keybindings:

[signal@Gtk.SearchEntry:GtkSearchEntry:activate]
[signal@Gtk.SearchEntry:GtkSearchEntry:next-match]
[signal@Gtk.SearchEntry:GtkSearchEntry:previous-match]
[signal@Gtk.SearchEntry:GtkSearchEntry: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 [enum@Gtk.AccessibleRole.search_box] role.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public bool activates_default { get; set; }
Whether to activate the default widget when Enter is pressed.
public InputHints input_hints { get; set; }
The hints about input for the `GtkSearchEntry` used to alter the behaviour of input methods.
public InputPurpose input_purpose { get; set; }
The purpose for the `GtkSearchEntry` input used to alter the behaviour of input methods.
public Widget key_capture_widget { get; set construct; }
The widget that the entry will use to capture key events.
public string placeholder_text { owned get; set; }
The text that will be displayed in the `GtkSearchEntry` when it is empty and unfocused.
public uint search_delay { get; set; }
The delay in milliseconds from last keypress to the search changed signal.

Creation methods:

public SearchEntry ()
Creates a `GtkSearchEntry`.

Methods:

public InputHints get_input_hints ()
Gets the input purpose for this.
public InputPurpose get_input_purpose ()
Gets the input purpose of this.
public unowned Widget? get_key_capture_widget ()
Gets the widget that this is capturing key events from.
public unowned string? get_placeholder_text ()
Gets the placeholder text associated with this.
public uint get_search_delay ()
Get the delay to be used between the last keypress and the [ signal@Gtk.
public void set_input_hints (InputHints hints)
Sets the input hints for this.
public void set_input_purpose (InputPurpose purpose)
Sets the input purpose of this.
public void set_key_capture_widget (Widget? widget)
Sets widget as the widget that this will capture key events from.
public void set_placeholder_text (string? text)
Sets the placeholder text associated with this.
public void set_search_delay (uint delay)
Set the delay to be used between the last keypress and the [ signal@Gtk.

Signals:

public signal void activate ()
Emitted when the entry is activated.
public signal void next_match ()
Emitted when the user initiates a move to the next match for the current search string.
public signal void previous_match ()
Emitted when the user initiates a move to the previous match for the current search string.
public signal void search_changed ()
Emitted with a delay.
public signal void search_started ()
Emitted when the user initiated a search on the entry.
public signal void stop_search ()
Emitted when the user stops a search via keyboard input.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable

All known members inherited from interface Gtk.Editable