SearchEntryProtocol

public protocol SearchEntryProtocol : EditableProtocol

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.

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 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
init(raw:)
Required Initialiser for types conforming to SearchEntryProtocol
Declaration
Swift

init(raw: UnsafeMutableRawPointer)
Show on GitHub

SearchEntry Class


                    
                    
                    bind(property:to:_:flags:transformFrom:transformTo:)

Extension method

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(signal:flags:handler:)

Extension method

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(signal:flags:data:destroyData:signalHandler:)

Extension method

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


                    
                    
                    onActivate(flags:handler:)

Extension method

Emitted when the entry is activated.

The keybindings for this signal are all forms of the Enter key.

Note

This represents the underlying activate signal

Declaration

Swift

@discardableResult
@inlinable
func onActivate(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 `activate` signal is emitted

Show on GitHub

activateSignal Extension method
Typed activate signal for using the connect(signal:) methods
Declaration
Swift

static var activateSignal: SearchEntrySignalName { get }
Show on GitHub


                    
                    
                    onNextMatch(flags:handler:)

Extension method

Emitted when the user initiates a move to the next match for the current search string.

This is a keybinding signal.

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


                    
                    
                    onPreviousMatch(flags:handler:)

Extension method

Emitted when the user initiates a move to the previous match for the current search string.

This is a keybinding signal.

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


                    
                    
                    onSearchChanged(flags:handler:)

Extension method

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


                    
                    
                    onSearchStarted(flags:handler:)

Extension method

Emitted when the user initiated a search on the entry.

Note

This represents the underlying search-started signal

Declaration

Swift

@discardableResult
@inlinable
func onSearchStarted(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 `searchStarted` signal is emitted

Show on GitHub

searchStartedSignal Extension method
Typed search-started signal for using the connect(signal:) methods
Declaration
Swift

static var searchStartedSignal: SearchEntrySignalName { get }
Show on GitHub


                    
                    
                    onStopSearch(flags:handler:)

Extension method

Emitted when the user stops a search via keyboard input.

This is a keybinding signal.

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


                    
                    
                    onNotifyActivatesDefault(flags:handler:)

Extension method

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

(C Language Example):

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use canonical parameter names as detail strings for the notify signal.

Note

This represents the underlying notify::activates-default signal

Declaration

Swift

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

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`pspec`	the `GParamSpec` of the property which changed.
`handler`	The signal handler to call Run the given callback whenever the `notifyActivatesDefault` signal is emitted

Show on GitHub

notifyActivatesDefaultSignal Extension method
Typed notify::activates-default signal for using the connect(signal:) methods
Declaration
Swift

static var notifyActivatesDefaultSignal: SearchEntrySignalName { get }
Show on GitHub


                    
                    
                    onNotifyPlaceholderText(flags:handler:)

Extension method

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

(C Language Example):

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use canonical parameter names as detail strings for the notify signal.

Note

This represents the underlying notify::placeholder-text signal

Declaration

Swift

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

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`pspec`	the `GParamSpec` of the property which changed.
`handler`	The signal handler to call Run the given callback whenever the `notifyPlaceholderText` signal is emitted

Show on GitHub

notifyPlaceholderTextSignal Extension method
Typed notify::placeholder-text signal for using the connect(signal:) methods
Declaration
Swift

static var notifyPlaceholderTextSignal: SearchEntrySignalName { get }
Show on GitHub

SearchEntry Class: SearchEntryProtocol extension (methods and fields)

getKeyCaptureWidget() Extension method
Gets the widget that entry is capturing key events from.
Declaration
Swift

@inlinable func getKeyCaptureWidget() -> WidgetRef!
Show on GitHub
setKeyCapture(widget:) Extension method
Sets widget as the widget that entry will capture key events from.

Key events are consumed by the search entry to start or continue a search.

If the entry is part of a GtkSearchBar, it is preferable to call [methodGtk.SearchBar.set_key_capture_widget] instead, which will reveal the entry in addition to triggering the search entry.

Note that despite the name of this function, the events are only ‘captured’ in the bubble phase, which means that editable child widgets of widget will receive text input before it gets captured. If that is not desired, you can capture and forward the events yourself with [methodGtk.EventControllerKey.forward].
Declaration
Swift

@inlinable func setKeyCapture(widget: WidgetRef? = nil)
Show on GitHub
setKeyCapture(widget:) Extension method
Sets widget as the widget that entry will capture key events from.

Key events are consumed by the search entry to start or continue a search.

If the entry is part of a GtkSearchBar, it is preferable to call [methodGtk.SearchBar.set_key_capture_widget] instead, which will reveal the entry in addition to triggering the search entry.

Note that despite the name of this function, the events are only ‘captured’ in the bubble phase, which means that editable child widgets of widget will receive text input before it gets captured. If that is not desired, you can capture and forward the events yourself with [methodGtk.EventControllerKey.forward].
Declaration
Swift

@inlinable func setKeyCapture<WidgetT>(widget: WidgetT?) where WidgetT : WidgetProtocol
Show on GitHub
keyCaptureWidget Extension method
Gets the widget that entry is capturing key events from.
Declaration
Swift

@inlinable var keyCaptureWidget: WidgetRef! { get nonmutating set }
Show on GitHub

SearchEntryProtocol

CSS Nodes

Accessibility

Declaration

Default Implementation

Declaration

Declaration

SearchEntry Class

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

SearchEntry signals

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

SearchEntry Class: SearchEntryProtocol extension (methods and fields)

Declaration

Declaration

Declaration

Declaration