Struct gtk4::SearchEntry [−][src]
pub struct SearchEntry(_);Expand description
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 signal::SearchEntry::search-changed signal which
can be used instead of the signal::Editable::changed signal.
The signal::SearchEntry::previous-match,
signal::SearchEntry::next-match and
signal::SearchEntry::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
╰── textSearchEntry 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.
Implements
WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, EditableExt, WidgetExtManual, AccessibleExtManual, EditableExtManual
Implementations
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.
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
Whether to activate the default widget when Enter is pressed.
Whether to activate the default widget when Enter is pressed.
The text that will be displayed in the SearchEntry
when it is empty and unfocused.
The text that will be displayed in the SearchEntry
when it is empty and unfocused.
Emitted when the entry is activated.
The keybindings for this signal are all forms of the Enter key.
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.
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.
Emitted with a short delay of 150 milliseconds after the last change to the entry text.
Emitted when the user initiated a search on the entry.
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 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
Trait Implementations
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
Returns the type identifier of Self.
Auto Trait Implementations
impl RefUnwindSafe for SearchEntry
impl !Send for SearchEntry
impl !Sync for SearchEntry
impl Unpin for SearchEntry
impl UnwindSafe for SearchEntry
Blanket Implementations
Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T. Read more
Upcasts an object to a reference of its superclass or interface T. Read more
Tries to downcast to a subclass or interface implementor T. Read more
Tries to downcast to a reference of its subclass or interface implementor T. Read more
Tries to cast to an object of type T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read more
Tries to cast to reference to an object of type T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read more
Casts to T unconditionally. Read more
Casts to &T unconditionally. Read more
Returns true if the object is an instance of (can be cast to) T.
pub fn set_property<'a, N, V>(
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
N: Into<&'a str>,
V: ToValue,
pub fn set_property_from_value<'a, N>(
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>,
pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>
pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>,
pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>,
Safety Read more
Safety Read more
Safety Read more
Safety Read more
pub fn connect<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
N: Into<&'a str>,
F: 'static + Fn(&[Value]) -> Option<Value> + Send + Sync,
Same as connect but takes a SignalId instead of a signal name.
pub fn connect_local<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
N: Into<&'a str>,
F: 'static + Fn(&[Value]) -> Option<Value>,
Same as connect_local but takes a SignalId instead of a signal name.
pub unsafe fn connect_unsafe<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
N: Into<&'a str>,
F: Fn(&[Value]) -> Option<Value>,
Same as connect_unsafe but takes a SignalId instead of a signal name.
Emit signal by signal id.
Same as emit but takes Value for the arguments.
Emit signal by its name.
Same as emit_by_name but takes Value for the arguments.
Emit signal with details by signal id.
Same as emit_with_details but takes Value for the arguments.
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>,
Returns a SendValue clone of self.