/usr/share/gtk-doc/html/emerillon/EmerillonSidebar.html is in emerillon-dev 0.1.90-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EmerillonSidebar</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Emerillon Reference Manual">
<link rel="up" href="ch01.html" title="emerillon">
<link rel="prev" href="ch01.html" title="emerillon">
<link rel="next" href="EmerillonWindow.html" title="EmerillonWindow">
<meta name="generator" content="GTK-Doc V1.17 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Emerillon Reference Manual</th>
<td><a accesskey="n" href="EmerillonWindow.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EmerillonSidebar.synopsis" class="shortcut">Top</a>
|
<a href="#EmerillonSidebar.description" class="shortcut">Description</a>
|
<a href="#EmerillonSidebar.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EmerillonSidebar.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#EmerillonSidebar.properties" class="shortcut">Properties</a>
|
<a href="#EmerillonSidebar.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="EmerillonSidebar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EmerillonSidebar.top_of_page"></a>EmerillonSidebar</span></h2>
<p>EmerillonSidebar</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EmerillonSidebar.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="EmerillonSidebar.html#EmerillonSidebar-struct" title="struct EmerillonSidebar">EmerillonSidebar</a>;
struct <a class="link" href="EmerillonSidebar.html#EmerillonSidebarClass" title="struct EmerillonSidebarClass">EmerillonSidebarClass</a>;
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="EmerillonSidebar.html#emerillon-sidebar-new" title="emerillon_sidebar_new ()">emerillon_sidebar_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="EmerillonSidebar.html#emerillon-sidebar-add-page" title="emerillon_sidebar_add_page ()">emerillon_sidebar_add_page</a> (<em class="parameter"><code><a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> *sidebar</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *main_widget</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EmerillonSidebar.html#emerillon-sidebar-remove-page" title="emerillon_sidebar_remove_page ()">emerillon_sidebar_remove_page</a> (<em class="parameter"><code><a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> *sidebar</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *main_widget</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EmerillonSidebar.html#emerillon-sidebar-set-page" title="emerillon_sidebar_set_page ()">emerillon_sidebar_set_page</a> (<em class="parameter"><code><a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> *sidebar</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *main_widget</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="EmerillonSidebar.html#emerillon-sidebar-get-n-pages" title="emerillon_sidebar_get_n_pages ()">emerillon_sidebar_get_n_pages</a> (<em class="parameter"><code><a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> *sidebar</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="EmerillonSidebar.html#emerillon-sidebar-is-empty" title="emerillon_sidebar_is_empty ()">emerillon_sidebar_is_empty</a> (<em class="parameter"><code><a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> *sidebar</code></em>);
<a class="link" href="EmerillonSidebar.html#EmerillonSidebarPrivate" title="EmerillonSidebarPrivate">EmerillonSidebarPrivate</a>;
</pre>
</div>
<div class="refsect1">
<a name="EmerillonSidebar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html">GtkWidget</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkContainer.html">GtkContainer</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkBox.html">GtkBox</a>
+----EmerillonSidebar
</pre>
</div>
<div class="refsect1">
<a name="EmerillonSidebar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EmerillonSidebar implements
AtkImplementorIface, <a href="http://library.gnome.org/devel/gtk3/GtkBuildable.html">GtkBuildable</a> and <a href="http://library.gnome.org/devel/gtk3/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="EmerillonSidebar.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="EmerillonSidebar.html#EmerillonSidebar--current-page" title='The "current-page" property'>current-page</a>" <a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="EmerillonSidebar.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="EmerillonSidebar.html#EmerillonSidebar-page-added" title='The "page-added" signal'>page-added</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
"<a class="link" href="EmerillonSidebar.html#EmerillonSidebar-page-removed" title='The "page-removed" signal'>page-removed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="EmerillonSidebar.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EmerillonSidebar.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EmerillonSidebar-struct"></a><h3>struct EmerillonSidebar</h3>
<pre class="programlisting">struct EmerillonSidebar;</pre>
</div>
<hr>
<div class="refsect2">
<a name="EmerillonSidebarClass"></a><h3>struct EmerillonSidebarClass</h3>
<pre class="programlisting">struct EmerillonSidebarClass {
GtkBoxClass base_class;
void (* page_added) (EmerillonSidebar *sidebar,
GtkWidget *main_widget);
void (* page_removed) (EmerillonSidebar *sidebar,
GtkWidget *main_widget);
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="emerillon-sidebar-new"></a><h3>emerillon_sidebar_new ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * emerillon_sidebar_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="emerillon-sidebar-add-page"></a><h3>emerillon_sidebar_add_page ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> emerillon_sidebar_add_page (<em class="parameter"><code><a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> *sidebar</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *main_widget</code></em>);</pre>
<p>
Adds a new page to the sidebar
</p>
<p>
See: <a class="link" href="EmerillonWindow.html#emerillon-window-get-sidebar" title="emerillon_window_get_sidebar ()"><code class="function">emerillon_window_get_sidebar()</code></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sidebar</code></em> :</span></p></td>
<td>An <a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> instance. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>Sidebar title. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>main_widget</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> which should be embedded in the sidebar. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="emerillon-sidebar-remove-page"></a><h3>emerillon_sidebar_remove_page ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> emerillon_sidebar_remove_page (<em class="parameter"><code><a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> *sidebar</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *main_widget</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="emerillon-sidebar-set-page"></a><h3>emerillon_sidebar_set_page ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> emerillon_sidebar_set_page (<em class="parameter"><code><a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> *sidebar</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *main_widget</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="emerillon-sidebar-get-n-pages"></a><h3>emerillon_sidebar_get_n_pages ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> emerillon_sidebar_get_n_pages (<em class="parameter"><code><a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> *sidebar</code></em>);</pre>
<p>
Returns the number of pages <em class="parameter"><code>sidebar</code></em> has.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sidebar</code></em> :</span></p></td>
<td>An <a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> instance. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of pages <em class="parameter"><code>sidebar</code></em> has. If <em class="parameter"><code>sidebar</code></em> isn't
an <a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> instance this function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="emerillon-sidebar-is-empty"></a><h3>emerillon_sidebar_is_empty ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> emerillon_sidebar_is_empty (<em class="parameter"><code><a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> *sidebar</code></em>);</pre>
<p>
Checks if the <em class="parameter"><code>sidebar</code></em> is empty
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sidebar</code></em> :</span></p></td>
<td>An <a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> instance. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if <em class="parameter"><code>sidebar</code></em> has no pages or isn't
an <a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> instance</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="EmerillonSidebarPrivate"></a><h3>EmerillonSidebarPrivate</h3>
<pre class="programlisting">typedef struct _EmerillonSidebarPrivate EmerillonSidebarPrivate;</pre>
</div>
</div>
<div class="refsect1">
<a name="EmerillonSidebar.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EmerillonSidebar--current-page"></a><h3>The <code class="literal">"current-page"</code> property</h3>
<pre class="programlisting"> "current-page" <a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a>* : Read / Write</pre>
<p>The currently visible page.</p>
</div>
</div>
<div class="refsect1">
<a name="EmerillonSidebar.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="EmerillonSidebar-page-added"></a><h3>The <code class="literal">"page-added"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> *emerillonsidebar,
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
</div>
<hr>
<div class="refsect2">
<a name="EmerillonSidebar-page-removed"></a><h3>The <code class="literal">"page-removed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EmerillonSidebar.html" title="EmerillonSidebar"><span class="type">EmerillonSidebar</span></a> *emerillonsidebar,
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|