GI.Gtk.Objects.SearchEntry

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 SearchEntry::search-changed signal which can be used instead of the Editable::changed signal.

The SearchEntry::previous-match, SearchEntry::next-match and 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 searchEntryHandleEvent to pass events.

Since: 3.6

Exported types

newtype SearchEntry

Memory-managed wrapper type.

Constructors

SearchEntry (ManagedPtr SearchEntry)

Instances

GObject SearchEntry

Defined in GI.Gtk.Objects.SearchEntry

Methods

gobjectType :: IO GType

HasParentTypes SearchEntry

Defined in GI.Gtk.Objects.SearchEntry

type ParentTypes SearchEntry

Defined in GI.Gtk.Objects.SearchEntry

type ParentTypes SearchEntry = Entry ': (Widget ': (Object ': (ImplementorIface ': (Buildable ': (CellEditable ': (Editable ': ([] :: [Type])))))))

class (GObject o, IsDescendantOf SearchEntry o) => IsSearchEntry o

Type class for types which can be safely cast to SearchEntry, for instance with toSearchEntry.

Instances

(GObject o, IsDescendantOf SearchEntry o) => IsSearchEntry o

Defined in GI.Gtk.Objects.SearchEntry

toSearchEntry :: (MonadIO m, IsSearchEntry o) => o -> m SearchEntry

Cast to SearchEntry, for types for which this is known to be safe. For general casts, use castTo.

noSearchEntry :: Maybe SearchEntry

A convenience alias for Nothing :: Maybe SearchEntry.

Methods

handleEvent

searchEntryHandleEvent

Arguments

:: (HasCallStack, MonadIO m, IsSearchEntry a)

=> a

entry: a SearchEntry

-> Event

event: a key event

-> m Bool

Returns: EVENT_STOP if the key press event resulted in a search beginning or continuing, EVENT_PROPAGATE otherwise.

This function should be called when the top-level window which contains the search entry received a key event. If the entry is part of a SearchBar, it is preferable to call searchBarHandleEvent instead, which will reveal the entry in addition to passing the event to this function.

If the key event is handled by the search entry and starts or continues a search, EVENT_STOP will be returned. The caller should ensure that the entry is shown in this case, and not propagate the event further.

Since: 3.16

new

searchEntryNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SearchEntry

Returns: a new SearchEntry

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

Since: 3.6

Signals

nextMatch

type C_SearchEntryNextMatchCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type SearchEntryNextMatchCallback = IO ()

The ::next-match signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a move to the next match for the current search string.

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

The default bindings for this signal is Ctrl-g.

Since: 3.16

afterSearchEntryNextMatch :: (IsSearchEntry a, MonadIO m) => a -> SearchEntryNextMatchCallback -> m SignalHandlerId

Connect a signal handler for the “next-match” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after searchEntry #nextMatch callback

genClosure_SearchEntryNextMatch :: MonadIO m => SearchEntryNextMatchCallback -> m (GClosure C_SearchEntryNextMatchCallback)

Wrap the callback into a GClosure.

mk_SearchEntryNextMatchCallback :: C_SearchEntryNextMatchCallback -> IO (FunPtr C_SearchEntryNextMatchCallback)

Generate a function pointer callable from C code, from a C_SearchEntryNextMatchCallback.

noSearchEntryNextMatchCallback :: Maybe SearchEntryNextMatchCallback

A convenience synonym for Nothing :: Maybe SearchEntryNextMatchCallback.

onSearchEntryNextMatch :: (IsSearchEntry a, MonadIO m) => a -> SearchEntryNextMatchCallback -> m SignalHandlerId

Connect a signal handler for the “next-match” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on searchEntry #nextMatch callback

wrap_SearchEntryNextMatchCallback :: SearchEntryNextMatchCallback -> C_SearchEntryNextMatchCallback

Wrap a SearchEntryNextMatchCallback into a C_SearchEntryNextMatchCallback.

previousMatch

type C_SearchEntryPreviousMatchCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type SearchEntryPreviousMatchCallback = IO ()

The ::previous-match signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a move to the previous match for the current search string.

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

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

Since: 3.16

afterSearchEntryPreviousMatch :: (IsSearchEntry a, MonadIO m) => a -> SearchEntryPreviousMatchCallback -> m SignalHandlerId

Connect a signal handler for the “previous-match” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after searchEntry #previousMatch callback

genClosure_SearchEntryPreviousMatch :: MonadIO m => SearchEntryPreviousMatchCallback -> m (GClosure C_SearchEntryPreviousMatchCallback)

Wrap the callback into a GClosure.

mk_SearchEntryPreviousMatchCallback :: C_SearchEntryPreviousMatchCallback -> IO (FunPtr C_SearchEntryPreviousMatchCallback)

Generate a function pointer callable from C code, from a C_SearchEntryPreviousMatchCallback.

noSearchEntryPreviousMatchCallback :: Maybe SearchEntryPreviousMatchCallback

A convenience synonym for Nothing :: Maybe SearchEntryPreviousMatchCallback.

onSearchEntryPreviousMatch :: (IsSearchEntry a, MonadIO m) => a -> SearchEntryPreviousMatchCallback -> m SignalHandlerId

Connect a signal handler for the “previous-match” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on searchEntry #previousMatch callback

wrap_SearchEntryPreviousMatchCallback :: SearchEntryPreviousMatchCallback -> C_SearchEntryPreviousMatchCallback

Wrap a SearchEntryPreviousMatchCallback into a C_SearchEntryPreviousMatchCallback.

searchChanged

type C_SearchEntrySearchChangedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type SearchEntrySearchChangedCallback = IO ()

The SearchEntry::search-changed signal is emitted with a short delay of 150 milliseconds after the last change to the entry text.

Since: 3.10

afterSearchEntrySearchChanged :: (IsSearchEntry a, MonadIO m) => a -> SearchEntrySearchChangedCallback -> m SignalHandlerId

Connect a signal handler for the “search-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after searchEntry #searchChanged callback

genClosure_SearchEntrySearchChanged :: MonadIO m => SearchEntrySearchChangedCallback -> m (GClosure C_SearchEntrySearchChangedCallback)

Wrap the callback into a GClosure.

mk_SearchEntrySearchChangedCallback :: C_SearchEntrySearchChangedCallback -> IO (FunPtr C_SearchEntrySearchChangedCallback)

Generate a function pointer callable from C code, from a C_SearchEntrySearchChangedCallback.

noSearchEntrySearchChangedCallback :: Maybe SearchEntrySearchChangedCallback

A convenience synonym for Nothing :: Maybe SearchEntrySearchChangedCallback.

onSearchEntrySearchChanged :: (IsSearchEntry a, MonadIO m) => a -> SearchEntrySearchChangedCallback -> m SignalHandlerId

Connect a signal handler for the “search-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on searchEntry #searchChanged callback

wrap_SearchEntrySearchChangedCallback :: SearchEntrySearchChangedCallback -> C_SearchEntrySearchChangedCallback

Wrap a SearchEntrySearchChangedCallback into a C_SearchEntrySearchChangedCallback.

stopSearch

type C_SearchEntryStopSearchCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type SearchEntryStopSearchCallback = IO ()

The ::stop-search signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user stops a search via keyboard input.

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

The default bindings for this signal is Escape.

Since: 3.16

afterSearchEntryStopSearch :: (IsSearchEntry a, MonadIO m) => a -> SearchEntryStopSearchCallback -> m SignalHandlerId

Connect a signal handler for the “stop-search” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after searchEntry #stopSearch callback

genClosure_SearchEntryStopSearch :: MonadIO m => SearchEntryStopSearchCallback -> m (GClosure C_SearchEntryStopSearchCallback)

Wrap the callback into a GClosure.

mk_SearchEntryStopSearchCallback :: C_SearchEntryStopSearchCallback -> IO (FunPtr C_SearchEntryStopSearchCallback)

Generate a function pointer callable from C code, from a C_SearchEntryStopSearchCallback.

noSearchEntryStopSearchCallback :: Maybe SearchEntryStopSearchCallback

A convenience synonym for Nothing :: Maybe SearchEntryStopSearchCallback.

onSearchEntryStopSearch :: (IsSearchEntry a, MonadIO m) => a -> SearchEntryStopSearchCallback -> m SignalHandlerId

Connect a signal handler for the “stop-search” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on searchEntry #stopSearch callback

wrap_SearchEntryStopSearchCallback :: SearchEntryStopSearchCallback -> C_SearchEntryStopSearchCallback

Wrap a SearchEntryStopSearchCallback into a C_SearchEntryStopSearchCallback.