SearchBar

class SearchBar(**properties: Any)

Superclasses: Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, Buildable, ConstraintTarget

GtkSearchBar is a container made to have a search entry.

It can also contain additional widgets, such as drop-down menus, or buttons. The search bar would appear when a search is started through typing on the keyboard, or the application’s search mode is toggled on.

For keyboard presses to start a search, the search bar must be told of a widget to capture key events from through set_key_capture_widget. This widget will typically be the top-level window, or a parent container of the search bar. Common shortcuts such as Ctrl+F should be handled as an application action, or through the menu items.

You will also need to tell the search bar about which entry you are using as your search entry using connect_entry.

Creating a search bar

The following example shows you how to create a more complex search entry.

A simple example

Shortcuts and Gestures

GtkSearchBar supports the following keyboard shortcuts:

• Escape hides the search bar.

CSS nodes

searchbar
╰── revealer
    ╰── box
         ├── [child]
         ╰── [button.close]

GtkSearchBar has a main CSS node with name searchbar. It has a child node with name revealer that contains a node with name box. The box node contains both the CSS node of the child widget as well as an optional button node which gets the .close style class applied.

Accessibility

GtkSearchBar uses the SEARCH role.

Constructors

class SearchBar

classmethod new() → Widget

Creates a GtkSearchBar.

You will need to tell it about which widget is going to be your text entry using connect_entry.

Methods

class SearchBar

connect_entry(entry: Editable) → None

Connects the GtkEditable widget passed as the one to be used in this search bar.

The entry should be a descendant of the search bar. Calling this function manually is only required if the entry isn’t the direct child of the search bar (as in our main example).

Parameters:

entry – a GtkEditable

get_child() → Widget | None

Gets the child widget of bar.

get_key_capture_widget() → Widget | None

Gets the widget that bar is capturing key events from.

get_search_mode() → bool

Returns whether the search mode is on or off.

get_show_close_button() → bool

Returns whether the close button is shown.

set_child(child: Widget | None = None) → None

Sets the child widget of bar.

Parameters:

child – the child widget

set_key_capture_widget(widget: Widget | None = None) → None

Sets widget as the widget that bar will capture key events from.

If key events are handled by the search bar, the bar will be shown, and the entry populated with the entered text.

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 forward.

Parameters:

widget – a GtkWidget

set_search_mode(search_mode: bool) → None

Switches the search mode on or off.

Parameters:

search_mode – the new state of the search mode

set_show_close_button(visible: bool) → None

Shows or hides the close button.

Applications that already have a “search” toggle button should not show a close button in their search bar, as it duplicates the role of the toggle button.

Parameters:

visible – whether the close button will be shown or not

Properties

class SearchBar

props.child: Widget

The type of the None singleton.

props.key_capture_widget: Widget

The type of the None singleton.

props.search_mode_enabled: bool

The type of the None singleton.

props.show_close_button: bool

The type of the None singleton.