SearchEntry
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 signal@Gtk.SearchEntry::search-changed signal which can be used instead of the signal@Gtk.Editable::changed signal.
The signal@Gtk.SearchEntry::previous-match, signal@Gtk.SearchEntry::next-match and signal@Gtk.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 class@Gtk.SearchBar. If that is not the case, you can use method@Gtk.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 iface@Gtk.Editable API.
Shortcuts and Gestures
The following signals have default keybindings:
signal@Gtk.SearchEntry::activate
signal@Gtk.SearchEntry::next-match
signal@Gtk.SearchEntry::previous-match
signal@Gtk.SearchEntry::stop-search
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.
Skipped during bindings generation
method
activates-default
: Property has no getter nor setter
Constructors
Properties
The accessible role of the given GtkAccessible
implementation.
A list of css classes applied to this widget.
The current position of the insertion cursor in chars.
If undo/redo should be enabled for the editable.
Whether the widget should grab focus when it is clicked with the mouse.
Enables or disables the emission of the ::query-tooltip signal on @widget.
Whether to use the hexpand
property.
The hints about input for the GtkSearchEntry
used to alter the behaviour of input methods.
The purpose for the GtkSearchEntry
input used to alter the behaviour of input methods.
The GtkLayoutManager
instance to use to compute the preferred size of the widget, and allocate its children.
Margin on bottom side of widget.
Margin on start of widget, horizontally.
The desired maximum width of the entry, in characters.
The text that will be displayed in the GtkSearchEntry
when it is empty and unfocused.
Whether the widget will receive the default action when it is focused.
The scale factor of the widget.
The delay in milliseconds from last keypress to the search changed signal.
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Sets the text of tooltip to be the given string.
Whether to use the vexpand
property.
Number of characters to leave space for in the entry.
Functions
Enable or disable an action installed with gtk_widget_class_install_action().
Looks up the action in the action groups associated with
Activates the default.activate
action from @widget.
Adds @controller to @widget so that it will receive events.
Adds a style class to @widget.
Adds a widget to the list of mnemonic labels for this widget.
Queues an animation frame update and adds a callback to be called before each frame.
Requests the user's screen reader to announce the given message.
Called by widgets as the user moves around the window using keyboard shortcuts.
Computes the bounds for @widget in the coordinate space of @target.
Computes whether a container should give this widget extra space when possible.
Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.
Computes a matrix suitable to describe a transformation from
Emitted when the entry is activated.
Emitted at the end of a single user-visible operation on the contents.
Emitted when text is deleted from the widget by the user.
Signals that all holders of a reference to the widget should release the reference that they hold.
Emitted when the text direction of a widget changes.
Emitted when @widget is hidden.
Emitted if keyboard navigation fails.
Emitted when @widget is going to be mapped.
Emitted when a widget is activated via a mnemonic.
Emitted when the focus is moved.
Emitted when the user initiates a move to the next match for the current search string.
Emitted when the user initiates a move to the previous match for the current search string.
Emitted when @widget is associated with a GdkSurface
.
Emitted with a delay. The length of the delay can be changed with the property@Gtk.SearchEntry:search-delay property.
Emitted when the user initiated a search on the entry.
Emitted when @widget is shown.
Emitted when the widget state changes.
Emitted when the user stops a search via keyboard input.
Emitted when @widget is going to be unmapped.
Emitted when the GdkSurface
associated with @widget is destroyed.
Creates a new PangoLayout
with the appropriate font map, font description, and base direction for drawing text for this widget.
Retrieves the accessible platform state from the editable delegate.
Deletes the currently selected text of the editable.
Deletes a sequence of characters.
Clears the template children for the given widget.
Undoes the setup done by method@Gtk.Editable.init_delegate.
Retrieves the accessible parent for an accessible object.
Retrieves the accessible role of an accessible object.
Gets the alignment of the editable.
Returns the baseline that has currently been allocated to @widget.
Returns the height that has currently been allocated to @widget.
Returns the width that has currently been allocated to @widget.
Gets the first ancestor of @widget with type @widget_type.
Retrieves the accessible implementation for the given GtkAccessible
.
Returns the baseline that has currently been allocated to @widget.
Gets the ID of the @buildable object.
Determines whether the input focus can enter @widget or any of its children.
Queries whether @widget can be the target of pointer events.
Gets the value set with gtk_widget_set_child_visible().
Gets the clipboard object for @widget.
Returns the list of style classes applied to @widget.
Returns the CSS name that is used for @self.
Gets the GtkEditable
that @editable is delegating its implementation to.
Gets the reading direction for a particular widget.
Get the GdkDisplay
for the toplevel window associated with this widget.
Retrieves whether @editable is editable.
Gets if undo/redo actions are enabled for @editable
Retrieves the first accessible child of an accessible object.
Returns the widget’s first child.
Determines whether @widget can own the input focus.
Returns the current focus child of @widget.
Returns whether the widget should grab focus when it is clicked with the mouse.
Gets the font map of @widget.
Obtains the frame clock for a widget.
Returns the current value of the has-tooltip
property.
Gets whether the widget would like any available extra horizontal space.
Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.
Gets the input purpose for @entry.
Gets the input purpose of @entry.
Gets the widget that @entry is capturing key events from.
Returns the widget’s last child.
Retrieves the layout manager used by @widget.
Gets the bottom margin of @widget.
Gets the end margin of @widget.
Gets the start margin of @widget.
Gets the top margin of @widget.
Retrieves the desired maximum width of @editable, in characters.
Retrieves the next accessible sibling of an accessible object
Returns the widget’s next sibling.
#Fetches the requested opacity for this widget.
Returns the widget’s overflow value.
Gets the placeholder text associated with @entry.
Query a platform state, such as focus.
Retrieves the current position of the cursor relative to the start of the content of the editable.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Returns the widget’s previous sibling.
Gets the primary clipboard of @widget.
Determines whether @widget is realized.
Determines whether @widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.
Get the delay to be used between the last keypress and the signal@Gtk.SearchEntry::search-changed signal being emitted.
Returns the widget’s sensitivity.
Gets the settings object holding the settings used for this widget.
Returns the content width or height of the widget.
Returns the widget state as a flag set.
Returns the style context associated to @widget.
Fetch an object build from the template XML for @widget_type in this @widget instance.
Gets the contents of the tooltip for @widget.
Gets the contents of the tooltip for @widget.
Gets whether the widget would like any available extra vertical space.
Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.
Determines whether the widget is visible.
Gets the number of characters of space reserved for the contents of the editable.
Returns whether @css_class is currently applied to @widget.
Determines whether @widget is the current default widget within its toplevel.
Determines if the widget should show a visible indication that it has the global input focus.
Returns whether the widget is currently being destroyed.
Sets up a delegate for GtkEditable
.
Creates and initializes child widgets defined in templates.
Inserts @group into @widget.
Inserts @widget into the child widget list of @parent.
Inserts @widget into the child widget list of @parent.
Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.
Determines whether @widget can be drawn to.
Returns the widget’s effective sensitivity.
Emits the ::keynav-failed
signal on the widget.
Returns the widgets for which this widget is the target of a mnemonic.
Emits the ::mnemonic-activate signal.
Returns a GListModel
to track the children of @widget.
Returns a GListModel
to track the class@Gtk.EventControllers of @widget.
Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.
Flags a widget to have its size renegotiated.
Removes @controller from @widget, so that it doesn't process events anymore.
Removes a style from @widget.
Removes a widget from the list of mnemonic labels for this widget.
Removes a tick callback previously registered with gtk_widget_add_tick_callback().
Resets the accessible @property to its default value.
Resets the accessible @relation to its default value.
Resets the accessible @state to its default value.
Selects a region of text.
Sets the parent and sibling of an accessible object.
Sets the alignment for the contents of the editable.
Specifies whether the input focus can enter the widget or any of its children.
Sets whether @widget can be the target of pointer events.
Sets whether @widget should be mapped along with its parent.
Clear all style classes applied to @widget and replace them with @classes.
Sets a named cursor to be shown when pointer devices point towards @widget.
Sets the reading direction on a particular widget.
Determines if the user can edit the text in the editable widget.
If enabled, changes to @editable will be saved for undo/redo actions.
Specifies whether @widget can own the input focus.
Set @child as the current focus child of @widget.
Sets whether the widget should grab focus when it is clicked with the mouse.
Sets the font map to use for Pango rendering.
Sets the has-tooltip
property on @widget to @has_tooltip.
Sets whether the widget would like any available extra horizontal space.
Sets whether the hexpand flag will be used.
Sets the input hints for @entry.
Sets the input purpose of @entry.
Sets @widget as the widget that @entry will capture key events from.
Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @widget.
Sets the bottom margin of @widget.
Sets the end margin of @widget.
Set all margins to the same value.
Set start and end margin to horizontal and top and bottom margin to vertical
Set margins.
Sets the start margin of @widget.
Sets the top margin of @widget.
Sets the desired maximum width in characters of @editable.
Request the @widget to be rendered partially transparent.
Sets how @widget treats content that is drawn outside the widget's content area.
Sets the placeholder text associated with @entry.
Sets the cursor position in the editable to the given value.
Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
Set the delay to be used between the last keypress and the signal@Gtk.SearchEntry::search-changed signal being emitted.
Sets the sensitivity of a widget.
Sets the minimum size of a widget.
Turns on flag values in the current widget state.
Sets @markup as the contents of the tooltip, which is marked up with Pango markup.
Sets @text as the contents of the tooltip.
Sets whether the widget would like any available extra vertical space.
Sets whether the vexpand flag will be used.
Sets the visibility state of @widget.
Changes the size request of the editable to be about the right size for @n_chars characters.
Returns whether @widget should contribute to the measuring and allocation of its parent.
Triggers a tooltip query on the display where the toplevel of @widget is located.
Turns off flag values for the current widget state.
Updates the next accessible sibling of @self.