SearchBar

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

CSS nodes

GtkSearchBar has a single CSS node with name searchbar.

Creating a search bar

A simple example

class SearchBar : Bin {

protected

GtkSearchBar* gtkSearchBar;

GtkSearchBar* getSearchBarStruct(bool transferOwnership);

void* getStruct();

void setStruct(GObject* obj);

this(GtkSearchBar* gtkSearchBar, bool ownedRef);

static GType getType();

this();

void connectEntry(Entry entry);

bool getSearchMode();

bool getShowCloseButton();

bool handleEvent(Event event);

void setSearchMode(bool searchMode);

void setShowCloseButton(bool visible);

}

Constructors

this this(GtkSearchBar* gtkSearchBar, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a #GtkSearchBar. You will need to tell it about which widget is going to be your text entry using gtk_search_bar_connect_entry().

Members

Functions

connectEntry void connectEntry(Entry entry): Connects the #GtkEntry widget passed as the one to be used in this search bar. The entry should be a descendant of the search bar. This is only required if the entry isn’t the direct child of the search bar (as in our main example).
getSearchBarStruct GtkSearchBar* getSearchBarStruct(bool transferOwnership): Get the main Gtk struct
getSearchMode bool getSearchMode(): Returns whether the search mode is on or off.
getShowCloseButton bool getShowCloseButton(): Returns whether the close button is shown.
getStruct void* getStruct(): the main Gtk struct as a void*
handleEvent bool handleEvent(Event event): This function should be called when the top-level window which contains the search bar received a key event.
setSearchMode void setSearchMode(bool searchMode): Switches the search mode on or off.
setShowCloseButton void setShowCloseButton(bool visible): 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.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

getType GType getType()

Variables

gtkSearchBar GtkSearchBar* gtkSearchBar;: the main Gtk struct

Inherited Members

From Bin

gtkBin GtkBin* gtkBin;: the main Gtk struct
getBinStruct GtkBin* getBinStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
getType GType getType()
getChild Widget getChild(): Gets the child of the #GtkBin, or %NULL if the bin contains no child widget. The returned widget does not have a reference added, so you do not need to unref it.