<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSearchBar: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="NumericEntry.html" title="Numeric and Text Data Entry">
<link rel="prev" href="GtkSearchEntry.html" title="GtkSearchEntry">
<link rel="next" href="GtkEditable.html" title="GtkEditable">
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GtkSearchBar.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkSearchBar.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GtkSearchBar.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GtkSearchBar.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="NumericEntry.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkSearchEntry.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkEditable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkSearchBar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSearchBar.top_of_page"></a>GtkSearchBar</span></h2>
<p>GtkSearchBar — A toolbar to integrate a search entry with</p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="search-bar.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkSearchBar.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSearchBar.html#gtk-search-bar-new" title="gtk_search_bar_new ()">gtk_search_bar_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkSearchBar.html#gtk-search-bar-connect-entry" title="gtk_search_bar_connect_entry ()">gtk_search_bar_connect_entry</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkSearchBar.html#gtk-search-bar-get-search-mode" title="gtk_search_bar_get_search_mode ()">gtk_search_bar_get_search_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkSearchBar.html#gtk-search-bar-set-search-mode" title="gtk_search_bar_set_search_mode ()">gtk_search_bar_set_search_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkSearchBar.html#gtk-search-bar-get-show-close-button" title="gtk_search_bar_get_show_close_button ()">gtk_search_bar_get_show_close_button</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkSearchBar.html#gtk-search-bar-set-show-close-button" title="gtk_search_bar_set_show_close_button ()">gtk_search_bar_set_show_close_button</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkSearchBar.html#gtk-search-bar-handle-event" title="gtk_search_bar_handle_event ()">gtk_search_bar_handle_event</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSearchBar.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GtkSearchBar.html#GtkSearchBar--search-mode-enabled" title="The “search-mode-enabled” property">search-mode-enabled</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GtkSearchBar.html#GtkSearchBar--show-close-button" title="The “show-close-button” property">show-close-button</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSearchBar.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkSearchBar.html#GtkSearchBar-struct" title="struct GtkSearchBar">GtkSearchBar</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkSearchBar.html#GtkSearchBarClass" title="struct GtkSearchBarClass">GtkSearchBarClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSearchBar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
<span class="lineart">╰──</span> <a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
<span class="lineart">╰──</span> <a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
<span class="lineart">╰──</span> GtkSearchBar
</pre>
</div>
<div class="refsect1">
<a name="GtkSearchBar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkSearchBar implements
AtkImplementorIface and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkSearchBar.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtk.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkSearchBar.description"></a><h2>Description</h2>
<p><a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a> 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.</p>
<p>For keyboard presses to start a search, events will need to be
forwarded from the top-level window that contains the search bar.
See <a class="link" href="GtkSearchBar.html#gtk-search-bar-handle-event" title="gtk_search_bar_handle_event ()"><code class="function">gtk_search_bar_handle_event()</code></a> for example code. Common shortcuts
such as Ctrl+F should be handled as an application action, or through
the menu items.</p>
<p>You will also need to tell the search bar about which entry you
are using as your search entry using <a class="link" href="GtkSearchBar.html#gtk-search-bar-connect-entry" title="gtk_search_bar_connect_entry ()"><code class="function">gtk_search_bar_connect_entry()</code></a>.
The following example shows you how to create a more complex search
entry.</p>
<div class="refsect3">
<a name="id-1.3.10.8.9.5"></a><h4>Creating a search bar</h4>
<p><a class="ulink" href="https://git.gnome.org/browse/gtk+/tree/examples/search-bar.c" target="_top">A simple example</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkSearchBar.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-search-bar-new"></a><h3>gtk_search_bar_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_search_bar_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a <a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a>. You will need to tell it about
which widget is going to be your text entry using
<a class="link" href="GtkSearchBar.html#gtk-search-bar-connect-entry" title="gtk_search_bar_connect_entry ()"><code class="function">gtk_search_bar_connect_entry()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.10.8.10.2.5"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-search-bar-connect-entry"></a><h3>gtk_search_bar_connect_entry ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_search_bar_connect_entry (<em class="parameter"><code><a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a> *bar</code></em>,
<em class="parameter"><code><a class="link" href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> *entry</code></em>);</pre>
<p>Connects the <a class="link" href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> 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).</p>
<div class="refsect3">
<a name="id-1.3.10.8.10.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>bar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-search-bar-get-search-mode"></a><h3>gtk_search_bar_get_search_mode ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_search_bar_get_search_mode (<em class="parameter"><code><a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a> *bar</code></em>);</pre>
<p>Returns whether the search mode is on or off.</p>
<div class="refsect3">
<a name="id-1.3.10.8.10.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>bar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.10.8.10.4.6"></a><h4>Returns</h4>
<p> whether search mode is toggled on</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-search-bar-set-search-mode"></a><h3>gtk_search_bar_set_search_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_search_bar_set_search_mode (<em class="parameter"><code><a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a> *bar</code></em>,
<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> search_mode</code></em>);</pre>
<p>Switches the search mode on or off.</p>
<div class="refsect3">
<a name="id-1.3.10.8.10.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>bar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>search_mode</p></td>
<td class="parameter_description"><p>the new state of the search mode</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-search-bar-get-show-close-button"></a><h3>gtk_search_bar_get_show_close_button ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_search_bar_get_show_close_button (<em class="parameter"><code><a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a> *bar</code></em>);</pre>
<p>Returns whether the close button is shown.</p>
<div class="refsect3">
<a name="id-1.3.10.8.10.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>bar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.10.8.10.6.6"></a><h4>Returns</h4>
<p> whether the close button is shown</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-search-bar-set-show-close-button"></a><h3>gtk_search_bar_set_show_close_button ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_search_bar_set_show_close_button (<em class="parameter"><code><a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a> *bar</code></em>,
<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> visible</code></em>);</pre>
<p>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.</p>
<div class="refsect3">
<a name="id-1.3.10.8.10.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>bar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>visible</p></td>
<td class="parameter_description"><p>whether the close button will be shown or not</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-search-bar-handle-event"></a><h3>gtk_search_bar_handle_event ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_search_bar_handle_event (<em class="parameter"><code><a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a> *bar</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/gdk2/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
<p>This function should be called when the top-level
window which contains the search bar received a key event.</p>
<p>If the key event is handled by the search bar, the bar will
be shown, the entry populated with the entered text and <a href="http://developer.gnome.org/gdk2/gdk3-Events.html#GDK-EVENT-STOP:CAPS"><code class="literal">GDK_EVENT_STOP</code></a>
will be returned. The caller should ensure that events are
not propagated further.</p>
<p>If no entry has been connected to the search bar, using
<a class="link" href="GtkSearchBar.html#gtk-search-bar-connect-entry" title="gtk_search_bar_connect_entry ()"><code class="function">gtk_search_bar_connect_entry()</code></a>, this function will return
immediately with a warning.</p>
<div class="refsect3">
<a name="id-1.3.10.8.10.8.7"></a><h4>Showing the search bar on key presses</h4>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="keyword">static</span><span class="normal"> <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a></span>
<span class="function">on_key_press_event</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">widget</span><span class="symbol">,</span>
<span class="normal"> </span><span class="usertype">GdkEvent</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">event</span><span class="symbol">,</span>
<span class="normal"> </span><span class="usertype">gpointer</span><span class="normal"> user_data</span><span class="symbol">)</span>
<span class="cbracket">{</span>
<span class="normal"> </span><span class="usertype">GtkSearchBar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">bar </span><span class="symbol">=</span><span class="normal"> </span><span class="function">GTK_SEARCH_BAR</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">user_data</span><span class="symbol">);</span>
<span class="normal"> </span><span class="keyword">return</span><span class="normal"> </span><span class="function"><a href="GtkSearchBar.html#gtk-search-bar-handle-event">gtk_search_bar_handle_event</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">bar</span><span class="symbol">,</span><span class="normal"> event</span><span class="symbol">);</span>
<span class="cbracket">}</span>
<span class="function"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/gobject/gobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">window</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"key-press-event"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="function"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/gobject/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">on_key_press_event</span><span class="symbol">),</span>
<span class="normal"> search_bar</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
</div>
<div class="refsect3">
<a name="id-1.3.10.8.10.8.8"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>bar</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSearchBar.html" title="GtkSearchBar"><span class="type">GtkSearchBar</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event</p></td>
<td class="parameter_description"><p>a <a href="http://developer.gnome.org/gdk2/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> containing key press events</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.10.8.10.8.9"></a><h4>Returns</h4>
<p> <a href="http://developer.gnome.org/gdk2/gdk3-Events.html#GDK-EVENT-STOP:CAPS"><code class="literal">GDK_EVENT_STOP</code></a> if the key press event resulted
in text being entered in the search entry (and revealing
the search bar if necessary), <a href="http://developer.gnome.org/gdk2/gdk3-Events.html#GDK-EVENT-PROPAGATE:CAPS"><code class="literal">GDK_EVENT_PROPAGATE</code></a> otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkSearchBar.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSearchBar-struct"></a><h3>struct GtkSearchBar</h3>
<pre class="programlisting">struct GtkSearchBar;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkSearchBarClass"></a><h3>struct GtkSearchBarClass</h3>
<pre class="programlisting">struct GtkSearchBarClass {
GtkBinClass parent_class;
};
</pre>
<div class="refsect3">
<a name="id-1.3.10.8.11.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><a class="link" href="GtkBin.html#GtkBinClass" title="struct GtkBinClass"><span class="type">GtkBinClass</span></a> <em class="structfield"><code><a name="GtkSearchBarClass.parent-class"></a>parent_class</code></em>;</p></td>
<td class="struct_member_description"><p>The parent class.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkSearchBar.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSearchBar--search-mode-enabled"></a><h3>The <code class="literal">“search-mode-enabled”</code> property</h3>
<pre class="programlisting"> “search-mode-enabled” <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the search mode is on and the search bar shown.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSearchBar--show-close-button"></a><h3>The <code class="literal">“show-close-button”</code> property</h3>
<pre class="programlisting"> “show-close-button” <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether to show the close button in the toolbar.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>