Gtk.SearchBar – gtk4 Reference Manual

SearchBar

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_search_bar_get_type ()" ) ]
public class SearchBar : Widget, Accessible, Buildable, ConstraintTarget

`GtkSearchBar` is a container made to have a search entry.

![An example GtkSearchBar](search-bar.png)

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 [ [email protected]_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 [[email protected]_entry] .

Creating a search bar

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

A simple example

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 gtk_accessible_role_search role.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public Widget child { get; set construct; }
The child widget.
public Widget key_capture_widget { get; set construct; }
The key capture widget.
public bool search_mode_enabled { get; set; }
Whether the search mode is on and the search bar shown.
public bool show_close_button { get; set construct; }
Whether to show the close button in the search bar.

Creation methods:

public SearchBar ()
Creates a `GtkSearchBar`.

Methods:

public void connect_entry (Editable entry)
Connects the `GtkEditable widget passed as the one to be used in this search bar.
public unowned Widget? get_child ()
Gets the child widget of this.
public unowned Widget? get_key_capture_widget ()
Gets the widget that this is capturing key events from.
public bool get_search_mode ()
Returns whether the search mode is on or off.
public bool get_show_close_button ()
Returns whether the close button is shown.
public void set_child (Widget? child)
Sets the child widget of this.
public void set_key_capture_widget (Widget? widget)
Sets widget as the widget that this will capture key events from.
public void set_search_mode (bool search_mode)
Switches the search mode on or off.
public void set_show_close_button (bool visible)
Shows or hides the close button.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable

2022 vala-language.org