<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DhSidebar: Devhelp Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Devhelp Reference Manual">
<link rel="up" href="side-panel.html" title="Side Panel">
<link rel="prev" href="side-panel.html" title="Side Panel">
<link rel="next" href="DhBookTree.html" title="DhBookTree">
<meta name="generator" content="GTK-Doc V1.28.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="#DhSidebar.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#DhSidebar.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#DhSidebar.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#DhSidebar.signals" class="shortcut">Signals</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="side-panel.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="side-panel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="DhBookTree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="DhSidebar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="DhSidebar.top_of_page"></a>DhSidebar</span></h2>
<p>DhSidebar — The sidebar</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="DhSidebar.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="DhSidebar.html#dh-sidebar-new" title="dh_sidebar_new ()">dh_sidebar_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="DhSidebar.html#dh-sidebar-select-uri" title="dh_sidebar_select_uri ()">dh_sidebar_select_uri</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="DhSidebar.html#dh-sidebar-set-search-string" title="dh_sidebar_set_search_string ()">dh_sidebar_set_search_string</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="DhSidebar.html#dh-sidebar-set-search-focus" title="dh_sidebar_set_search_focus ()">dh_sidebar_set_search_focus</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DhSidebar.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="DhSidebar.html#DhSidebar-link-selected" title="The “link-selected” signal">link-selected</a></td>
<td class="signal_flags"><a href="/home/seb/jhbuild/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DhSidebar.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" 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="DhSidebar.html#DhSidebar-struct" title="struct DhSidebar">DhSidebar</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DhSidebar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/home/seb/jhbuild/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="/home/seb/jhbuild/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
<span class="lineart">╰──</span> <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
<span class="lineart">╰──</span> <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkGrid.html#GtkGrid-struct">GtkGrid</a>
<span class="lineart">╰──</span> DhSidebar
</pre>
</div>
<div class="refsect1">
<a name="DhSidebar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
DhSidebar implements
AtkImplementorIface, <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a> and <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/gtk3-Orientable.html#GtkOrientable-struct">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="DhSidebar.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <devhelp/devhelp.h>
</pre>
</div>
<div class="refsect1">
<a name="DhSidebar.description"></a><h2>Description</h2>
<p>In the Devhelp application, there is one <a class="link" href="DhSidebar.html" title="DhSidebar"><span class="type">DhSidebar</span></a> per main window,
displayed in the left side panel.</p>
<p>A <a class="link" href="DhSidebar.html" title="DhSidebar"><span class="type">DhSidebar</span></a> contains:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>a <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkSearchEntry.html#GtkSearchEntry-struct"><span class="type">GtkSearchEntry</span></a> at the top;</p></li>
<li class="listitem"><p>a <a class="link" href="DhBookTree.html" title="DhBookTree"><span class="type">DhBookTree</span></a> (a subclass of <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTreeView.html#GtkTreeView-struct"><span class="type">GtkTreeView</span></a>);</p></li>
<li class="listitem"><p>another <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTreeView.html#GtkTreeView-struct"><span class="type">GtkTreeView</span></a> (displaying a list, not a tree) with a <a class="link" href="DhKeywordModel.html" title="DhKeywordModel"><span class="type">DhKeywordModel</span></a>
as its model.</p></li>
</ul></div>
<p>When the <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkSearchEntry.html#GtkSearchEntry-struct"><span class="type">GtkSearchEntry</span></a> is empty, the <a class="link" href="DhBookTree.html" title="DhBookTree"><span class="type">DhBookTree</span></a> is shown. When the
<a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkSearchEntry.html#GtkSearchEntry-struct"><span class="type">GtkSearchEntry</span></a> is not empty, it shows the search results in the other
<a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTreeView.html#GtkTreeView-struct"><span class="type">GtkTreeView</span></a>. The two <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTreeView.html#GtkTreeView-struct"><span class="type">GtkTreeView</span></a>'s cannot be both visible at the same time,
it's either one or the other.</p>
<p>The <a class="link" href="DhSidebar.html#DhSidebar-link-selected" title="The “link-selected” signal"><span class="type">“link-selected”</span></a> signal is emitted when one element in one of
the <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTreeView.html#GtkTreeView-struct"><span class="type">GtkTreeView</span></a>'s is selected. When that happens, the Devhelp application
opens the link in a <a href="/usr/share/gtk-doc/html/webkit2gtk-4.0/WebKitWebView.html#WebKitWebView-struct"><span class="type">WebKitWebView</span></a> shown at the right side of the main
window.</p>
</div>
<div class="refsect1">
<a name="DhSidebar.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dh-sidebar-new"></a><h3>dh_sidebar_new ()</h3>
<pre class="programlisting"><a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
dh_sidebar_new (<em class="parameter"><code><a class="link" href="DhBookManager.html" title="DhBookManager"><span class="type">DhBookManager</span></a> *book_manager</code></em>);</pre>
<div class="refsect3">
<a name="dh-sidebar-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>book_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="DhBookManager.html" title="DhBookManager"><span class="type">DhBookManager</span></a>. This parameter is deprecated,
you should just pass <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dh-sidebar-new.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="DhSidebar.html" title="DhSidebar"><span class="type">DhSidebar</span></a> widget. </p>
<p><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dh-sidebar-select-uri"></a><h3>dh_sidebar_select_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dh_sidebar_select_uri (<em class="parameter"><code><a class="link" href="DhSidebar.html" title="DhSidebar"><span class="type">DhSidebar</span></a> *sidebar</code></em>,
<em class="parameter"><code>const <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);</pre>
<div class="refsect3">
<a name="dh-sidebar-select-uri.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>sidebar</p></td>
<td class="parameter_description"><p>a <a class="link" href="DhSidebar.html" title="DhSidebar"><span class="type">DhSidebar</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>the URI to select.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dh-sidebar-set-search-string"></a><h3>dh_sidebar_set_search_string ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dh_sidebar_set_search_string (<em class="parameter"><code><a class="link" href="DhSidebar.html" title="DhSidebar"><span class="type">DhSidebar</span></a> *sidebar</code></em>,
<em class="parameter"><code>const <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>);</pre>
<div class="refsect3">
<a name="dh-sidebar-set-search-string.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>sidebar</p></td>
<td class="parameter_description"><p>a <a class="link" href="DhSidebar.html" title="DhSidebar"><span class="type">DhSidebar</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>str</p></td>
<td class="parameter_description"><p>the string to search.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dh-sidebar-set-search-focus"></a><h3>dh_sidebar_set_search_focus ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dh_sidebar_set_search_focus (<em class="parameter"><code><a class="link" href="DhSidebar.html" title="DhSidebar"><span class="type">DhSidebar</span></a> *sidebar</code></em>);</pre>
<p>Gives the focus to the search entry.</p>
<div class="refsect3">
<a name="dh-sidebar-set-search-focus.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>sidebar</p></td>
<td class="parameter_description"><p>a <a class="link" href="DhSidebar.html" title="DhSidebar"><span class="type">DhSidebar</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="DhSidebar.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DhSidebar-struct"></a><h3>struct DhSidebar</h3>
<pre class="programlisting">struct DhSidebar;</pre>
</div>
</div>
<div class="refsect1">
<a name="DhSidebar.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="DhSidebar-link-selected"></a><h3>The <code class="literal">“link-selected”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="DhSidebar.html" title="DhSidebar"><span class="type">DhSidebar</span></a> *sidebar,
<a class="link" href="DhLink.html" title="DhLink"><span class="type">DhLink</span></a> *link,
<a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<div class="refsect3">
<a name="DhSidebar-link-selected.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>sidebar</p></td>
<td class="parameter_description"><p>a <a class="link" href="DhSidebar.html" title="DhSidebar"><span class="type">DhSidebar</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>link</p></td>
<td class="parameter_description"><p>the selected <a class="link" href="DhLink.html" title="DhLink"><span class="type">DhLink</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/home/seb/jhbuild/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28.1</div>
</body>
</html>