source-git / devhelp

Clone
Source Code
GIT

Files

c8 master
  1.   c8
  2.   docs
  3.   reference
  4.   html
  5.   DhBookTree.html
Blob Blame History Raw 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DhBookTree: 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="DhSidebar.html" title="DhSidebar">
<link rel="next" href="DhKeywordModel.html" title="DhKeywordModel">
<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="#DhBookTree.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#DhBookTree.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#DhBookTree.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#DhBookTree.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="DhSidebar.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="DhKeywordModel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="DhBookTree"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="DhBookTree.top_of_page"></a>DhBookTree</span></h2>
<p>DhBookTree — A <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTreeView.html#GtkTreeView-struct"><span class="type">GtkTreeView</span></a> containing the tree structure of all
enabled <a class="link" href="DhBook.html" title="DhBook"><span class="type">DhBook</span></a>'s</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="DhBookTree.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 class="link" href="DhBookTree.html" title="DhBookTree"><span class="returnvalue">DhBookTree</span></a> *
</td>
<td class="function_name">
<a class="link" href="DhBookTree.html#dh-book-tree-new" title="dh_book_tree_new ()">dh_book_tree_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="DhBookTree.html#dh-book-tree-select-uri" title="dh_book_tree_select_uri ()">dh_book_tree_select_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="DhLink.html" title="DhLink"><span class="returnvalue">DhLink</span></a> *
</td>
<td class="function_name">
<a class="link" href="DhBookTree.html#dh-book-tree-get-selected-book" title="dh_book_tree_get_selected_book ()">dh_book_tree_get_selected_book</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DhBookTree.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="DhBookTree.html#DhBookTree-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="DhBookTree.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="DhBookTree.html#DhBookTree-struct" title="struct DhBookTree">DhBookTree</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DhBookTree.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/GtkTreeView.html#GtkTreeView-struct">GtkTreeView</a>
                    <span class="lineart">╰──</span> DhBookTree
</pre>
</div>
<div class="refsect1">
<a name="DhBookTree.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
DhBookTree 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/GtkScrollable.html#GtkScrollable-struct">GtkScrollable</a>.</p>
</div>
<div class="refsect1">
<a name="DhBookTree.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;devhelp/devhelp.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="DhBookTree.description"></a><h2>Description</h2>
<p><a class="link" href="DhBookTree.html" title="DhBookTree"><span class="type">DhBookTree</span></a> is a <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTreeView.html#GtkTreeView-struct"><span class="type">GtkTreeView</span></a> (showing a tree, not a list) containing the
general tree structure of all enabled <a class="link" href="DhBook.html" title="DhBook"><span class="type">DhBook</span></a>'s.</p>
<p>The <a class="link" href="DhBook.html#dh-book-get-tree" title="dh_book_get_tree ()"><code class="function">dh_book_get_tree()</code></a> function is called to get the tree structure of a
<a class="link" href="DhBook.html" title="DhBook"><span class="type">DhBook</span></a>. As such the tree contains only <a class="link" href="DhLink.html" title="DhLink"><span class="type">DhLink</span></a>'s of type <a class="link" href="DhLink.html#DH-LINK-TYPE-BOOK:CAPS"><code class="literal">DH_LINK_TYPE_BOOK</code></a>
or <a class="link" href="DhLink.html#DH-LINK-TYPE-PAGE:CAPS"><code class="literal">DH_LINK_TYPE_PAGE</code></a>.</p>
<p>When an element is selected, the <a class="link" href="DhBookTree.html#DhBookTree-link-selected" title="The “link-selected” signal"><span class="type">“link-selected”</span></a> signal is
emitted. Only one element can be selected at a time.</p>
</div>
<div class="refsect1">
<a name="DhBookTree.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dh-book-tree-new"></a><h3>dh_book_tree_new ()</h3>
<pre class="programlisting"><a class="link" href="DhBookTree.html" title="DhBookTree"><span class="returnvalue">DhBookTree</span></a> *
dh_book_tree_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="refsect3">
<a name="dh-book-tree-new.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="DhBookTree.html" title="DhBookTree"><span class="type">DhBookTree</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-book-tree-select-uri"></a><h3>dh_book_tree_select_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dh_book_tree_select_uri (<em class="parameter"><code><a class="link" href="DhBookTree.html" title="DhBookTree"><span class="type">DhBookTree</span></a> *tree</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>
<p>Selects the given <em class="parameter"><code>uri</code></em>
.</p>
<div class="refsect3">
<a name="dh-book-tree-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>tree</p></td>
<td class="parameter_description"><p>a <a class="link" href="DhBookTree.html" title="DhBookTree"><span class="type">DhBookTree</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-book-tree-get-selected-book"></a><h3>dh_book_tree_get_selected_book ()</h3>
<pre class="programlisting"><a class="link" href="DhLink.html" title="DhLink"><span class="returnvalue">DhLink</span></a> *
dh_book_tree_get_selected_book (<em class="parameter"><code><a class="link" href="DhBookTree.html" title="DhBookTree"><span class="type">DhBookTree</span></a> *tree</code></em>);</pre>
<div class="refsect3">
<a name="dh-book-tree-get-selected-book.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>tree</p></td>
<td class="parameter_description"><p>a <a class="link" href="DhBookTree.html" title="DhBookTree"><span class="type">DhBookTree</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dh-book-tree-get-selected-book.returns"></a><h4>Returns</h4>
<p>the <a class="link" href="DhLink.html" title="DhLink"><span class="type">DhLink</span></a> of the selected book, or
<a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no selection. Unref with <a class="link" href="DhLink.html#dh-link-unref" title="dh_link_unref ()"><code class="function">dh_link_unref()</code></a> when no longer
needed. </p>
<p><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>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="DhBookTree.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DhBookTree-struct"></a><h3>struct DhBookTree</h3>
<pre class="programlisting">struct DhBookTree;</pre>
</div>
</div>
<div class="refsect1">
<a name="DhBookTree.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="DhBookTree-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="DhBookTree.html" title="DhBookTree"><span class="type">DhBookTree</span></a> *tree,
               <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="DhBookTree-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>tree</p></td>
<td class="parameter_description"><p>the <a class="link" href="DhBookTree.html" title="DhBookTree"><span class="type">DhBookTree</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>

Powered by Pagure 5.14.1

SSH Hostkey/Fingerprint | Documentation