SearchEntry

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_search_entry_get_type ()" ) ]
[ Version ( since = "3.6" ) ]
public class SearchEntry : Entry, Implementor, Buildable, CellEditable, Editable

SearchEntry is a subclass of Entry that has been tailored for use as a search entry.

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.

Note that the search/clear icon is shown using a secondary icon, and thus does not work if you are using the secondary icon position for some other purpose.

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, SearchEntry emits the search_changed signal which can be used instead of the changed signal.

The previous_match, next_match and 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 handle_event to pass events.

Namespace: Gtk

Package: gtk+-3.0

Content:

Creation methods:

public SearchEntry ()
Creates a SearchEntry, with a find icon when the search field is empty, and a clear icon when it isn't.

Methods:

public bool handle_event (Event event)
This function should be called when the top-level window which contains the search entry received a key event.

Signals:

public virtual signal void next_match ()
The next_match signal is a keybinding signal which gets emitted when the user initiates a move to the next match for the current search string.
public virtual signal void previous_match ()
The previous_match signal is a keybinding signal which gets emitted when the user initiates a move to the previous match for the current search string.
public virtual signal void search_changed ()
The search_changed signal is emitted with a short delay of 150 milliseconds after the last change to the entry text.
public virtual signal void stop_search ()
The stop_search signal is a keybinding signal which gets emitted when the user stops a search via keyboard input.

Inherited Members:

All known members inherited from class Gtk.Entry

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Atk.Implementor

ref_accessible

All known members inherited from interface Gtk.Buildable

All known members inherited from interface Gtk.CellEditable

remove_widget

start_editing

All known members inherited from interface Gtk.Editable