<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DhAssistantView: 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="assistant.html" title="Assistant">
<link rel="prev" href="assistant.html" title="Assistant">
<link rel="next" href="misc.html" title="Misc">
<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="#DhAssistantView.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#DhAssistantView.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#DhAssistantView.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#DhAssistantView.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="assistant.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="assistant.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="misc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="DhAssistantView"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="DhAssistantView.top_of_page"></a>DhAssistantView</span></h2>
<p>DhAssistantView — A small “assistant” widget for displaying just one hit</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="DhAssistantView.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="DhAssistantView.html#dh-assistant-view-new" title="dh_assistant_view_new ()">dh_assistant_view_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/seb/jhbuild/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="DhAssistantView.html#dh-assistant-view-set-link" title="dh_assistant_view_set_link ()">dh_assistant_view_set_link</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/seb/jhbuild/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="DhAssistantView.html#dh-assistant-view-search" title="dh_assistant_view_search ()">dh_assistant_view_search</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DhAssistantView.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="DhAssistantView.html#DhAssistantView-open-uri" title="The “open-uri” signal">open-uri</a></td>
<td class="signal_flags"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DhAssistantView.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="DhAssistantView.html#DhAssistantView-struct" title="struct DhAssistantView">DhAssistantView</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DhAssistantView.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> WebKitWebViewBase
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/webkit2gtk-4.0/WebKitWebView.html#WebKitWebView-struct">WebKitWebView</a>
<span class="lineart">╰──</span> DhAssistantView
</pre>
</div>
<div class="refsect1">
<a name="DhAssistantView.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
DhAssistantView implements
AtkImplementorIface and <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="DhAssistantView.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <devhelp/devhelp.h>
</pre>
</div>
<div class="refsect1">
<a name="DhAssistantView.description"></a><h2>Description</h2>
<p><a class="link" href="DhAssistantView.html" title="DhAssistantView"><span class="type">DhAssistantView</span></a> is a subclass of <a href="/usr/share/gtk-doc/html/webkit2gtk-4.0/WebKitWebView.html#WebKitWebView-struct"><span class="type">WebKitWebView</span></a> for displaying the
documentation of just one symbol.</p>
<p>A possible use-case: in a text editor, pressing a keyboard shortcut could
display this widget for the symbol under the cursor.</p>
<p>With the Devhelp application, an assistant can easily be launched with the
command line option <code class="literal">--search-assistant</code>.</p>
</div>
<div class="refsect1">
<a name="DhAssistantView.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dh-assistant-view-new"></a><h3>dh_assistant_view_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_assistant_view_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="refsect3">
<a name="dh-assistant-view-new.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="DhAssistantView.html" title="DhAssistantView"><span class="type">DhAssistantView</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-assistant-view-set-link"></a><h3>dh_assistant_view_set_link ()</h3>
<pre class="programlisting"><a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
dh_assistant_view_set_link (<em class="parameter"><code><a class="link" href="DhAssistantView.html" title="DhAssistantView"><span class="type">DhAssistantView</span></a> *view</code></em>,
<em class="parameter"><code><a class="link" href="DhLink.html" title="DhLink"><span class="type">DhLink</span></a> *link</code></em>);</pre>
<p>Open <em class="parameter"><code>link</code></em>
in the assistant view, if <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> the view will be blanked.</p>
<div class="refsect3">
<a name="dh-assistant-view-set-link.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>view</p></td>
<td class="parameter_description"><p>a <a class="link" href="DhAssistantView.html" title="DhAssistantView"><span class="type">DhAssistantView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>link</p></td>
<td class="parameter_description"><p>a <a class="link" href="DhLink.html" title="DhLink"><span class="type">DhLink</span></a> to set or <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-assistant-view-set-link.returns"></a><h4>Returns</h4>
<p> <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the requested link is open, <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dh-assistant-view-search"></a><h3>dh_assistant_view_search ()</h3>
<pre class="programlisting"><a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
dh_assistant_view_search (<em class="parameter"><code><a class="link" href="DhAssistantView.html" title="DhAssistantView"><span class="type">DhAssistantView</span></a> *view</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>
<p>Search for <em class="parameter"><code>str</code></em>
in the current assistant view.</p>
<div class="refsect3">
<a name="dh-assistant-view-search.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>view</p></td>
<td class="parameter_description"><p>a <a class="link" href="DhAssistantView.html" title="DhAssistantView"><span class="type">DhAssistantView</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 search query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dh-assistant-view-search.returns"></a><h4>Returns</h4>
<p> <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>str</code></em>
was found, <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="DhAssistantView.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DhAssistantView-struct"></a><h3>struct DhAssistantView</h3>
<pre class="programlisting">struct DhAssistantView;</pre>
</div>
</div>
<div class="refsect1">
<a name="DhAssistantView.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="DhAssistantView-open-uri"></a><h3>The <code class="literal">“open-uri”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="DhAssistantView.html" title="DhAssistantView"><span class="type">DhAssistantView</span></a> *view,
<a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri,
<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="DhAssistantView-open-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>view</p></td>
<td class="parameter_description"><p>the view on which the signal is emitted</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 open</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>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28.1</div>
</body>
</html>