Struct gtk4::SearchEntry

#[repr(transparent)]
pub struct SearchEntry { /* private fields */ }

SearchEntry is an entry widget that has been tailored for use as a search entry.

The main API for interacting with a SearchEntry as entry is the Editable 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, SearchEntry emits the search-changed signal which can be used instead of the changed signal.

The previous-match, next-match and stop-search signals can be used to implement moving between search results and ending the search.

Often, SearchEntry will be fed events by means of being placed inside a SearchBar. If that is not the case, you can use set_key_capture_widget() to let it capture key input from another widget.

SearchEntry provides only minimal API and should be used with the Editable API.

CSS Nodes

entry.search
╰── text

SearchEntry has a single CSS node with name entry that carries a .search style class, and the text node is a child of that.

Accessibility

SearchEntry uses the AccessibleRole::SearchBox role.

Properties

activates-default

Whether to activate the default widget when Enter is pressed.

Readable | Writeable

placeholder-text

The text that will be displayed in the SearchEntry when it is empty and unfocused.

Readable | Writeable

search-delay

The delay in milliseconds from last keypress to the search changed signal.

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Editable

cursor-position

The current position of the insertion cursor in chars.

Readable

editable

Whether the entry contents can be edited.

Readable | Writeable

enable-undo

If undo/redo should be enabled for the editable.

Readable | Writeable

max-width-chars

The desired maximum width of the entry, in characters.

Readable | Writeable

selection-bound

The position of the opposite end of the selection from the cursor in chars.

Readable

text

The contents of the entry.

Readable | Writeable

width-chars

Number of characters to leave space for in the entry.

Readable | Writeable

xalign

The horizontal alignment, from 0 (left) to 1 (right).

Reversed for RTL layouts.

Readable | Writeable

Signals

activate

Emitted when the entry is activated.

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

Action

next-match

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.

Action

previous-match

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.

Action

search-changed

Emitted with a delay. The length of the delay can be changed with the search-delay property.

search-started

Emitted when the user initiated a search on the entry.

stop-search

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.

Action

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

Action

query-tooltip

Emitted when the widgets tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Editable

changed

Emitted at the end of a single user-visible operation on the contents.

E.g., a paste operation that replaces the contents of the selection will cause only one signal emission (even though it is implemented by first deleting the selection, then inserting the new content, and may cause multiple ::notify::text signals to be emitted).

delete-text

Emitted when text is deleted from the widget by the user.

The default handler for this signal will normally be responsible for deleting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the range of deleted text, or prevent it from being deleted entirely.

The @start_pos and @end_pos parameters are interpreted as for EditableExt::delete_text().

insert-text

Emitted when text is inserted into the widget by the user.

The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the inserted text, or prevent it from being inserted entirely.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, EditableExt, WidgetExtManual, AccessibleExtManual, EditableExtManual

Implementations

impl SearchEntry

pub fn new() -> SearchEntry

Creates a SearchEntry.

Returns

a new SearchEntry

pub fn builder() -> SearchEntryBuilder

Creates a new builder-pattern struct instance to construct SearchEntry objects.

This method returns an instance of SearchEntryBuilder which can be used to create SearchEntry objects.

pub fn key_capture_widget(&self) -> Option<Widget>

Gets the widget that @self is capturing key events from.

Returns

The key capture widget.

pub fn search_delay(&self) -> u32

Available on crate feature v4_8 only.

Get the delay to be used between the last keypress and the search-changed signal being emitted.

Returns

a delay in milliseconds.

pub fn set_key_capture_widget(&self, widget: Option<&impl IsA<Widget>>)

Sets @widget as the widget that @self 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 SearchBar, it is preferable to call 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 EventControllerKey::forward().

widget

a Widget

pub fn set_search_delay(&self, delay: u32)

Available on crate feature v4_8 only.

Set the delay to be used between the last keypress and the search-changed signal being emitted.

delay

a delay in milliseconds

pub fn activates_default(&self) -> bool

Whether to activate the default widget when Enter is pressed.

pub fn set_activates_default(&self, activates_default: bool)

Whether to activate the default widget when Enter is pressed.

pub fn placeholder_text(&self) -> Option<GString>

The text that will be displayed in the SearchEntry when it is empty and unfocused.

pub fn set_placeholder_text(&self, placeholder_text: Option<&str>)

The text that will be displayed in the SearchEntry when it is empty and unfocused.

pub fn connect_activate<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when the entry is activated.

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

pub fn emit_activate(&self)

pub fn connect_next_match<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

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.

pub fn emit_next_match(&self)

pub fn connect_previous_match<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

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.

pub fn emit_previous_match(&self)

pub fn connect_search_changed<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted with a delay. The length of the delay can be changed with the search-delay property.

pub fn connect_search_started<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the user initiated a search on the entry.

pub fn connect_stop_search<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

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.

pub fn emit_stop_search(&self)

pub fn connect_activates_default_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_placeholder_text_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_search_delay_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_8 only.

Trait Implementations

impl Clone for SearchEntry

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchEntry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchEntry

fn default() -> Self

Returns the “default value” for a type.

impl Display for SearchEntry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for SearchEntry

type ParamSpec = ParamSpecObject

type SetValue = SearchEntry

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, SearchEntry>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SearchEntry

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SearchEntry

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for SearchEntry

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for SearchEntry

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for SearchEntry

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SearchEntry

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SearchEntry

impl IsA<Accessible> for SearchEntry

impl IsA<Buildable> for SearchEntry

impl IsA<ConstraintTarget> for SearchEntry

impl IsA<Editable> for SearchEntry

impl IsA<Widget> for SearchEntry