SearchBar

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_search_bar_get_type ()" ) ]
[ Version ( since = "3.10" ) ]
public class SearchBar : Bin, Implementor, Buildable

SearchBar is a container made to have a search entry (possibly with additional connex widgets, such as drop-down menus, or buttons) built-in.

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, events will need to be forwarded from the top-level window that contains the search bar. See handle_event for example code. 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. The following example shows you how to create a more complex search entry.

CSS nodes

GtkSearchBar has a single CSS node with name searchbar.

Creating a search bar

A simple example

Namespace: Gtk

Package: gtk+-3.0

Content:

Properties:

public bool search_mode_enabled { get; set; }
public bool show_close_button { get; set construct; }

Creation methods:

public SearchBar ()
Creates a SearchBar.

Methods:

public void connect_entry (Entry entry)
Connects the Entry widget passed as the one to be used in this search bar.
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 bool handle_event (Event event)
This function should be called when the top-level window which contains the search bar received a key event.
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.Bin

get_child

All known members inherited from class Gtk.Container

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Atk.Implementor

ref_accessible

All known members inherited from interface Gtk.Buildable