SearchEntryProtocol

public protocol SearchEntryProtocol : EntryProtocol

GtkSearchEntry is a subclass of GtkEntry 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, GtkSearchEntry emits the GtkSearchEntry::search-changed signal which can be used instead of the GtkEditable::changed signal.

The GtkSearchEntry::previous-match, GtkSearchEntry::next-match and 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 GtkSearchBar. If that is not the case, you can use gtk_search_entry_handle_event() to pass events.

The SearchEntryProtocol protocol exposes the methods and properties of an underlying GtkSearchEntry instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see SearchEntry. Alternatively, use SearchEntryRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkSearchEntry instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • search_entry_ptr Default implementation

    Typed pointer to the underlying GtkSearchEntry instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkSearchEntry instance.

    Declaration

    Swift

    var search_entry_ptr: UnsafeMutablePointer<GtkSearchEntry>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to SearchEntryProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

SearchEntry Class

  • Bind a SearchEntryPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: SearchEntryPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a SearchEntry property

    Declaration

    Swift

    @inlinable
func get(property: SearchEntryPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a SearchEntry property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: SearchEntryPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

SearchEntry signals

  • Connect a Swift signal handler to the given, typed SearchEntrySignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: SearchEntrySignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    handler

    The Swift signal handler (function or callback) to invoke on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Connect a C signal handler to the given, typed SearchEntrySignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: SearchEntrySignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub
  • onNextMatch(flags:handler:) Extension method

    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.

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

    The default bindings for this signal is Ctrl-g.

    Note

    This represents the underlying next-match signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNextMatch(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: SearchEntryRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the nextMatch signal is emitted
    Show on GitHub
  • nextMatchSignal Extension method

    Typed next-match signal for using the connect(signal:) methods

    Declaration

    Swift

    static var nextMatchSignal: SearchEntrySignalName { get }
    Show on GitHub

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

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

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

    Note

    This represents the underlying previous-match signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onPreviousMatch(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: SearchEntryRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the previousMatch signal is emitted
    Show on GitHub
  • previousMatchSignal Extension method

    Typed previous-match signal for using the connect(signal:) methods

    Declaration

    Swift

    static var previousMatchSignal: SearchEntrySignalName { get }
    Show on GitHub

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

    Note

    This represents the underlying search-changed signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onSearchChanged(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: SearchEntryRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the searchChanged signal is emitted
    Show on GitHub
  • searchChangedSignal Extension method

    Typed search-changed signal for using the connect(signal:) methods

    Declaration

    Swift

    static var searchChangedSignal: SearchEntrySignalName { get }
    Show on GitHub
  • onStopSearch(flags:handler:) Extension method

    The stop-search signal is a keybinding signal 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.

    Note

    This represents the underlying stop-search signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onStopSearch(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: SearchEntryRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the stopSearch signal is emitted
    Show on GitHub
  • stopSearchSignal Extension method

    Typed stop-search signal for using the connect(signal:) methods

    Declaration

    Swift

    static var stopSearchSignal: SearchEntrySignalName { get }
    Show on GitHub

SearchEntry Class: SearchEntryProtocol extension (methods and fields)

  • handle(event:) Extension method

    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 GtkSearchBar, it is preferable to call gtk_search_bar_handle_event() 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, GDK_EVENT_STOP will be returned. The caller should ensure that the entry is shown in this case, and not propagate the event further.

    Declaration

    Swift

    @inlinable
func handle<EventT>(event: EventT) -> Bool where EventT : EventProtocol
    Show on GitHub
  • parent Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var parent: GtkEntry { get }
    Show on GitHub