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

Exported types

newtype SearchEntry

Constructors

SearchEntry (ManagedPtr SearchEntry)

Instances

GObject SearchEntry

Methods

gobjectType :: SearchEntry -> IO GType

IsImplementorIface SearchEntry

IsObject SearchEntry

IsWidget SearchEntry

IsEntry SearchEntry

IsEditable SearchEntry

IsCellEditable SearchEntry

IsBuildable SearchEntry

IsSearchEntry SearchEntry

((~) * info (ResolveSearchEntryMethod t SearchEntry), MethodInfo * info SearchEntry p) => IsLabel t (SearchEntry -> p)

Methods

fromLabel :: Proxy# Symbol t -> SearchEntry -> p

((~) * info (ResolveSearchEntryMethod t SearchEntry), MethodInfo * info SearchEntry p) => IsLabelProxy t (SearchEntry -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> SearchEntry -> p

HasAttributeList * SearchEntry

type AttributeList SearchEntry

type AttributeList SearchEntry

type SignalList SearchEntry

type SignalList SearchEntry

class GObject o => IsSearchEntry o

Instances

(GObject a, UnknownAncestorError Constraint SearchEntry a) => IsSearchEntry a

IsSearchEntry SearchEntry

toSearchEntry :: IsSearchEntry o => o -> IO SearchEntry

noSearchEntry :: Maybe SearchEntry

Methods

handleEvent

data SearchEntryHandleEventMethodInfo

Instances

((~) * signature (Event -> m Bool), MonadIO m, IsSearchEntry a) => MethodInfo * SearchEntryHandleEventMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SearchEntryHandleEventMethodInfo a -> signature -> s

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 SearchEntryNextMatchCallback = IO ()

data SearchEntryNextMatchSignalInfo

Instances

SignalInfo SearchEntryNextMatchSignalInfo

Associated Types

type HaskellCallbackType SearchEntryNextMatchSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o SearchEntryNextMatchSignalInfo -> o -> HaskellCallbackType SearchEntryNextMatchSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType SearchEntryNextMatchSignalInfo

type HaskellCallbackType SearchEntryNextMatchSignalInfo = SearchEntryNextMatchCallback

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

genClosure_SearchEntryNextMatch :: SearchEntryNextMatchCallback -> IO Closure

mk_SearchEntryNextMatchCallback :: C_SearchEntryNextMatchCallback -> IO (FunPtr C_SearchEntryNextMatchCallback)

noSearchEntryNextMatchCallback :: Maybe SearchEntryNextMatchCallback

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

wrap_SearchEntryNextMatchCallback :: SearchEntryNextMatchCallback -> Ptr () -> Ptr () -> IO ()

previousMatch

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

type SearchEntryPreviousMatchCallback = IO ()

data SearchEntryPreviousMatchSignalInfo

Instances

SignalInfo SearchEntryPreviousMatchSignalInfo

Associated Types

type HaskellCallbackType SearchEntryPreviousMatchSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o SearchEntryPreviousMatchSignalInfo -> o -> HaskellCallbackType SearchEntryPreviousMatchSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType SearchEntryPreviousMatchSignalInfo

type HaskellCallbackType SearchEntryPreviousMatchSignalInfo = SearchEntryPreviousMatchCallback

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

genClosure_SearchEntryPreviousMatch :: SearchEntryPreviousMatchCallback -> IO Closure

mk_SearchEntryPreviousMatchCallback :: C_SearchEntryPreviousMatchCallback -> IO (FunPtr C_SearchEntryPreviousMatchCallback)

noSearchEntryPreviousMatchCallback :: Maybe SearchEntryPreviousMatchCallback

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

wrap_SearchEntryPreviousMatchCallback :: SearchEntryPreviousMatchCallback -> Ptr () -> Ptr () -> IO ()

searchChanged

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

type SearchEntrySearchChangedCallback = IO ()

data SearchEntrySearchChangedSignalInfo

Instances

SignalInfo SearchEntrySearchChangedSignalInfo

Associated Types

type HaskellCallbackType SearchEntrySearchChangedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o SearchEntrySearchChangedSignalInfo -> o -> HaskellCallbackType SearchEntrySearchChangedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType SearchEntrySearchChangedSignalInfo

type HaskellCallbackType SearchEntrySearchChangedSignalInfo = SearchEntrySearchChangedCallback

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

genClosure_SearchEntrySearchChanged :: SearchEntrySearchChangedCallback -> IO Closure

mk_SearchEntrySearchChangedCallback :: C_SearchEntrySearchChangedCallback -> IO (FunPtr C_SearchEntrySearchChangedCallback)

noSearchEntrySearchChangedCallback :: Maybe SearchEntrySearchChangedCallback

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

wrap_SearchEntrySearchChangedCallback :: SearchEntrySearchChangedCallback -> Ptr () -> Ptr () -> IO ()

stopSearch

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

type SearchEntryStopSearchCallback = IO ()

data SearchEntryStopSearchSignalInfo

Instances

SignalInfo SearchEntryStopSearchSignalInfo

Associated Types

type HaskellCallbackType SearchEntryStopSearchSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o SearchEntryStopSearchSignalInfo -> o -> HaskellCallbackType SearchEntryStopSearchSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType SearchEntryStopSearchSignalInfo

type HaskellCallbackType SearchEntryStopSearchSignalInfo = SearchEntryStopSearchCallback

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

genClosure_SearchEntryStopSearch :: SearchEntryStopSearchCallback -> IO Closure

mk_SearchEntryStopSearchCallback :: C_SearchEntryStopSearchCallback -> IO (FunPtr C_SearchEntryStopSearchCallback)

noSearchEntryStopSearchCallback :: Maybe SearchEntryStopSearchCallback

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

wrap_SearchEntryStopSearchCallback :: SearchEntryStopSearchCallback -> Ptr () -> Ptr () -> IO ()