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.SearchBar.handleEvent 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.SearchBar.connectEntry. 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 {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

SearchBar self();

static SearchBarGidBuilder builder();

bool searchModeEnabled [@property getter];

bool searchModeEnabled [@property setter];

bool showCloseButton [@property getter];

bool showCloseButton [@property setter];

this();

void connectEntry(gtk.entry.Entry entry);

bool getSearchMode();

bool getShowCloseButton();

bool handleEvent(gdk.event.Event event);

void setSearchMode(bool searchMode);

void setShowCloseButton(bool visible);

}

Constructors

this this(void* ptr, Flag!"Take" take)
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.SearchBar.connectEntry.

Members

Functions

connectEntry void connectEntry(gtk.entry.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).
getSearchMode bool getSearchMode(): Returns whether the search mode is on or off.
getShowCloseButton bool getShowCloseButton(): Returns whether the close button is shown.
handleEvent bool handleEvent(gdk.event.Event event): This function should be called when the top-level window which contains the search bar received a key event.
self SearchBar self(): Returns this, for use in with statements.
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.

Properties

_gType GType _gType [@property getter]
searchModeEnabled bool searchModeEnabled [@property getter]
searchModeEnabled bool searchModeEnabled [@property setter]
showCloseButton bool showCloseButton [@property getter]
showCloseButton bool showCloseButton [@property setter]

Static functions

_getGType GType _getGType()
builder SearchBarGidBuilder builder(): Get builder for gtk.search_bar.SearchBar

Inherited Members

From Bin

_getGType GType _getGType()
_gType GType _gType [@property getter]
self Bin self(): Returns this, for use in with statements.
builder BinGidBuilder builder(): Get builder for gtk.bin.Bin
getChild gtk.widget.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.

gtk search_bar classes