SearchEntry

open class SearchEntry : Widget, SearchEntryProtocol

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.

An example GtkSearchEntry

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

The [signalGtk.SearchEntry::previous-match], [signalGtk.SearchEntry::next-match] and [signalGtk.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 [classGtk.SearchBar]. If that is not the case, you can use [methodGtk.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 [ifaceGtk.Editable] API.

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 GTK_ACCESSIBLE_ROLE_SEARCH_BOX role.

The SearchEntry type acts as a reference-counted owner of an underlying GtkSearchEntry instance. It provides the methods that can operate on this data type through SearchEntryProtocol conformance. Use SearchEntry as a strong reference or owner of a GtkSearchEntry instance.

Show on GitHub 
  • Designated initialiser from the underlying `C` data type.

    This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the SearchEntry instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafeMutablePointer<GtkSearchEntry>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the SearchEntry instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafePointer<GtkSearchEntry>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the SearchEntry instance.

    Declaration

    Swift

    @inlinable
override public init!(gpointer op: gpointer?)

    Parameters

    op

    gpointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gconstpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the SearchEntry instance.

    Declaration

    Swift

    @inlinable
override public init!(gconstpointer op: gconstpointer?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the SearchEntry instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafePointer<GtkSearchEntry>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the SearchEntry instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafeMutablePointer<GtkSearchEntry>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from the underlying C data type. Will retain GtkSearchEntry. i.e., ownership is transferred to the SearchEntry instance.

    Declaration

    Swift

    @inlinable
public init(retaining op: UnsafeMutablePointer<GtkSearchEntry>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Reference intialiser for a related type that implements SearchEntryProtocol Will retain GtkSearchEntry.

    Declaration

    Swift

    @inlinable
public init<T>(searchEntry other: T) where T : SearchEntryProtocol

    Parameters

    other

    an instance of a related type that implements SearchEntryProtocol
    Show on GitHub

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to SearchEntryProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(cPointer p: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to SearchEntryProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to SearchEntryProtocol.

    Declaration

    Swift

    @inlinable
override public init(raw p: UnsafeRawPointer)

    Parameters

    p

    raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to SearchEntryProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingRaw raw: UnsafeRawPointer)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to SearchEntryProtocol.

    Declaration

    Swift

    @inlinable
public required init(raw p: UnsafeMutableRawPointer)

    Parameters

    p

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to SearchEntryProtocol.

    Declaration

    Swift

    @inlinable
required public init(retainingRaw raw: UnsafeMutableRawPointer)

    Parameters

    raw

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to SearchEntryProtocol.

    Declaration

    Swift

    @inlinable
override public init(opaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to SearchEntryProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Creates a GtkSearchEntry.

    Declaration

    Swift

    @inlinable
public init()
    Show on GitHub