Package: gtk

Class gtk-search-entry

Superclasses

gtk-entry, gtk-widget, gtk-buildable, gtk-editable, gtk-cell-editable, g-object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

None

Direct Slots

None

Details

The gtk-search-entry class is a subclass of the gtk-entry class 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, the gtk-search-entry widget emits the "search-changed" signal which can be used instead of the "changed" signal.

Signal Details

The "next-match" signal
 lambda (entry)    :action      
The 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 the Ctrl-g key.
entry
The gtk-search-entry widget on which the signal was emitted.
The "previous-match" signal
 lambda (entry)    :action      
The 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 the Ctrl-Shift-g key.
entry
The gtk-search-entry widget on which the signal was emitted.
The "search-changed" signal
 lambda (entry)    :run-last      
The signal is emitted with a short delay of 150 milliseconds after the last change to the entry text.
entry
The gtk-search-entry widget on which the signal was emitted.
The "stop-search" signal
 lambda (entry)    :action      
The 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 the Escape key.
entry
The gtk-search-entry widget on which the signal was emitted.
 

Inherited Slot Access Functions

gtk-cell-editable-editing-canceled
gtk-entry-activates-default
gtk-entry-attributes
gtk-entry-buffer
gtk-entry-caps-lock-warning
gtk-entry-completion
gtk-entry-cursor-position
gtk-entry-editable
gtk-entry-has-frame
gtk-entry-im-module
gtk-entry-inner-border
gtk-entry-input-hints
gtk-entry-input-purpose
gtk-entry-invisible-char
gtk-entry-invisible-char-set
gtk-entry-max-length
gtk-entry-overwrite-mode
gtk-entry-placeholder-text
gtk-entry-populate-all
gtk-entry-primary-icon-activatable
gtk-entry-primary-icon-gicon
gtk-entry-primary-icon-name
gtk-entry-primary-icon-pixbuf
gtk-entry-primary-icon-sensitive
gtk-entry-primary-icon-stock
gtk-entry-primary-icon-storage-type
gtk-entry-primary-icon-tooltip-markup
gtk-entry-primary-icon-tooltip-text
gtk-entry-progress-fraction
gtk-entry-progress-pulse-step
gtk-entry-scroll-offset
gtk-entry-secondary-icon-activatable
gtk-entry-secondary-icon-gicon
gtk-entry-secondary-icon-name
gtk-entry-secondary-icon-pixbuf
gtk-entry-secondary-icon-sensitive
gtk-entry-secondary-icon-stock
gtk-entry-secondary-icon-storage-type
gtk-entry-secondary-icon-tooltip-markup
gtk-entry-secondary-icon-tooltip-text
gtk-entry-selection-bound
gtk-entry-shadow-type
gtk-entry-tabs
gtk-entry-text
gtk-entry-text-length
gtk-entry-truncate-multiline
gtk-entry-visibility
gtk-entry-width-chars
gtk-entry-xalign
gtk-widget-app-paintable
gtk-widget-can-default
gtk-widget-can-focus
gtk-widget-composite-child
gtk-widget-double-buffered
gtk-widget-events
gtk-widget-expand
gtk-widget-focus-on-click
gtk-widget-halign
gtk-widget-has-default
gtk-widget-has-focus
gtk-widget-has-tooltip
gtk-widget-height-request
gtk-widget-hexpand
gtk-widget-hexpand-set
gtk-widget-is-focus
gtk-widget-margin
gtk-widget-margin-bottom
gtk-widget-margin-end
gtk-widget-margin-left
gtk-widget-margin-right
gtk-widget-margin-start
gtk-widget-margin-top
gtk-widget-name
gtk-widget-no-show-all
gtk-widget-opacity
gtk-widget-parent
gtk-widget-receives-default
gtk-widget-scale-factor
gtk-widget-sensitive
gtk-widget-style
gtk-widget-tooltip-markup
gtk-widget-tooltip-text
gtk-widget-valign
gtk-widget-vexpand
gtk-widget-vexpand-set
gtk-widget-visible
gtk-widget-width-request
gtk-widget-window
g-object-has-reference
g-object-pointer
g-object-signal-handlers

See also

*2021-12-27