GtkSearchBar

GtkSearchBar — An toolbar to integrate a search entry with

Synopsis

#include <gtk/gtk.h>

struct              GtkSearchBar;
GtkWidget *         gtk_search_bar_new                  (void);
gboolean            gtk_search_bar_handle_event         (GtkSearchBar *bar,
                                                         GdkEvent *event);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBin
                           +----GtkSearchBar

Implemented Interfaces

GtkSearchBar implements AtkImplementorIface and GtkBuildable.

Properties

  "search-mode-enabled"      gboolean              : Read / Write
  "show-close-button"        gboolean              : Read / Write / Construct

Description

GtkSearchBar 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 gtk_search_bar_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 gtk_search_bar_connect_entry(). The following example shows you how to create a more complex search entry.

Example 58. Creating a search bar

1
2
3
4
5
6
7
8
9
10
11
12
13
bar = gtk_search_bar_new ();

/<!---->* Create a box for the search entry and related widgets *<---->/
entry = gtk_search_entry_new ();
box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 6);
gtk_box_pack_start (GTK_BOX (box), entry, TRUE, TRUE, 0);
/<!---->* Add a menu button to select the category of the search *<---->/
menu_button = gtk_menu_button_new ();
gtk_box_pack_start (GTK_BOX (box), menu_button, FALSE, FALSE, 0);
gtk_container_add (GTK_CONTAINER (searchbar), box);

/<!---->* And tell the search bar about the search entry *<---->/
gtk_search_bar_set_search_entry (GTK_SEARCH_BAR (bar), entry);


Details

struct GtkSearchBar

struct GtkSearchBar;

gtk_search_bar_new ()

GtkWidget *         gtk_search_bar_new                  (void);

Creates a GtkSearchBar. You will need to tell it about which widget is going to be your text entry using gtk_search_bar_set_entry().

Returns :

a new GtkSearchBar

Since 3.10


gtk_search_bar_handle_event ()

gboolean            gtk_search_bar_handle_event         (GtkSearchBar *bar,
                                                         GdkEvent *event);

This function should be called when the top-level window which contains the search bar received a key event.

If the key event is handled by the search bar, the bar will be shown, the entry populated with the entered text and GDK_EVENT_STOP will be returned. The caller should ensure that events are not propagated further.

If no entry has been connected to the search bar, using gtk_search_bar_connect_entry(), this function will return immediately with a warning.

Example 59. Showing the search bar on key presses

1
2
3
4
5
6
7
8
9
10
static gboolean
window_key_press_event_cb (GtkWidget *widget,
                           GdkEvent  *event,
                           gpointer   user_data)
{
  return gtk_search_bar_handle_event (GTK_SEARCH_BAR (user_data), event);
}

g_signal_connect (window, "key-press-event",
                  G_CALLBACK (window_key_press_event_cb), search_bar);


bar :

a GtkSearchBar

event :

a GdkEvent containing key press events

Returns :

GDK_EVENT_STOP if the key press event resulted in text being * entered in the search entry (and revealing the search bar if necessary), GDK_EVENT_PROPAGATE otherwise.

Since 3.10

Property Details

The "search-mode-enabled" property

  "search-mode-enabled"      gboolean              : Read / Write

Whether the search mode is on and the search bar shown.

Default value: FALSE


The "show-close-button" property

  "show-close-button"        gboolean              : Read / Write / Construct

Whether to show the close button in the toolbar.

Default value: TRUE