/usr/share/gtk-doc/html/evolution-shell/EShellSidebar.html is in evolution-dev 3.10.4-0ubuntu1.
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 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EShellSidebar</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution Shell Reference Manual">
<link rel="up" href="ch01.html" title="The Shell">
<link rel="prev" href="EShellContent.html" title="EShellContent">
<link rel="next" href="EShellTaskbar.html" title="EShellTaskbar">
<meta name="generator" content="GTK-Doc V1.19 (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="EShellContent.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">Evolution Shell Reference Manual</th>
<td><a accesskey="n" href="EShellTaskbar.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EShellSidebar.synopsis" class="shortcut">Top</a>
|
<a href="#EShellSidebar.description" class="shortcut">Description</a>
|
<a href="#EShellSidebar.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EShellSidebar.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#EShellSidebar.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="EShellSidebar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EShellSidebar.top_of_page"></a>EShellSidebar</span></h2>
<p>EShellSidebar — the left side of the main window</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EShellSidebar.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <shell/e-shell-sidebar.h>
struct <a class="link" href="EShellSidebar.html#EShellSidebar-struct" title="struct EShellSidebar">EShellSidebar</a>;
<span class="returnvalue">GtkWidget</span> * <a class="link" href="EShellSidebar.html#e-shell-sidebar-new" title="e_shell_sidebar_new ()">e_shell_sidebar_new</a> (<em class="parameter"><code><span class="type">struct _EShellView</span> *shell_view</code></em>);
<span class="returnvalue">guint32</span> <a class="link" href="EShellSidebar.html#e-shell-sidebar-check-state" title="e_shell_sidebar_check_state ()">e_shell_sidebar_check_state</a> (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>);
struct <a class="link" href="EShellView.html" title="EShellView"><span class="returnvalue">_EShellView</span></a> * <a class="link" href="EShellSidebar.html#e-shell-sidebar-get-shell-view" title="e_shell_sidebar_get_shell_view ()">e_shell_sidebar_get_shell_view</a> (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EShellSidebar.html#e-shell-sidebar-get-icon-name" title="e_shell_sidebar_get_icon_name ()">e_shell_sidebar_get_icon_name</a> (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellSidebar.html#e-shell-sidebar-set-icon-name" title="e_shell_sidebar_set_icon_name ()">e_shell_sidebar_set_icon_name</a> (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EShellSidebar.html#e-shell-sidebar-get-primary-text" title="e_shell_sidebar_get_primary_text ()">e_shell_sidebar_get_primary_text</a> (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellSidebar.html#e-shell-sidebar-set-primary-text" title="e_shell_sidebar_set_primary_text ()">e_shell_sidebar_set_primary_text</a> (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *primary_text</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EShellSidebar.html#e-shell-sidebar-get-secondary-text" title="e_shell_sidebar_get_secondary_text ()">e_shell_sidebar_get_secondary_text</a> (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellSidebar.html#e-shell-sidebar-set-secondary-text" title="e_shell_sidebar_set_secondary_text ()">e_shell_sidebar_set_secondary_text</a> (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *secondary_text</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EShellSidebar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkWidget
+----GtkContainer
+----GtkBin
+----EShellSidebar
</pre>
</div>
<div class="refsect1">
<a name="EShellSidebar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EShellSidebar implements
AtkImplementorIface, GtkBuildable, <a href="../evolution-util/EAlertSink.html">EAlertSink</a> and <a href="../libebackend/EExtensible.html">EExtensible</a>.</p>
</div>
<div class="refsect1">
<a name="EShellSidebar.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="EShellSidebar.html#EShellSidebar--icon-name" title='The "icon-name" property'>icon-name</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="EShellSidebar.html#EShellSidebar--primary-text" title='The "primary-text" property'>primary-text</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="EShellSidebar.html#EShellSidebar--secondary-text" title='The "secondary-text" property'>secondary-text</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="EShellSidebar.html#EShellSidebar--shell-view" title='The "shell-view" property'>shell-view</a>" <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="EShellSidebar.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EShellSidebar.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EShellSidebar-struct"></a><h3>struct EShellSidebar</h3>
<pre class="programlisting">struct EShellSidebar;</pre>
<p>
Contains only private data that should be read and manipulated using the
functions below.
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-sidebar-new"></a><h3>e_shell_sidebar_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * e_shell_sidebar_new (<em class="parameter"><code><span class="type">struct _EShellView</span> *shell_view</code></em>);</pre>
<p>
Creates a new <a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> instance belonging to <em class="parameter"><code>shell_view</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_view</code></em> :</span></p></td>
<td>an <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> instance</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-sidebar-check-state"></a><h3>e_shell_sidebar_check_state ()</h3>
<pre class="programlisting"><span class="returnvalue">guint32</span> e_shell_sidebar_check_state (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>);</pre>
<p>
<a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> subclasses should implement the
<structfield>check_state</structfield> method in <span class="type">EShellSidebarClass</span>
to return a set of flags describing the current sidebar selection.
Subclasses are responsible for defining their own flags. This is
primarily used to assist shell views with updating actions (see
<a class="link" href="EShellView.html#e-shell-view-update-actions" title="e_shell_view_update_actions ()"><code class="function">e_shell_view_update_actions()</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>shell_sidebar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a set of flags describing the current <em class="parameter"><code>shell_sidebar</code></em> selection</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-sidebar-get-shell-view"></a><h3>e_shell_sidebar_get_shell_view ()</h3>
<pre class="programlisting">struct <a class="link" href="EShellView.html" title="EShellView"><span class="returnvalue">_EShellView</span></a> * e_shell_sidebar_get_shell_view (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>);</pre>
<p>
Returns the <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> that was passed to <a class="link" href="EShellSidebar.html#e-shell-sidebar-new" title="e_shell_sidebar_new ()"><code class="function">e_shell_sidebar_new()</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>shell_sidebar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> to which <em class="parameter"><code>shell_sidebar</code></em> belongs</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-sidebar-get-icon-name"></a><h3>e_shell_sidebar_get_icon_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_shell_sidebar_get_icon_name (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>);</pre>
<p>
Returns the icon name displayed at the top of the sidebar.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_sidebar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the icon name for <em class="parameter"><code>shell_sidebar</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-sidebar-set-icon-name"></a><h3>e_shell_sidebar_set_icon_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_sidebar_set_icon_name (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>);</pre>
<p>
Sets the icon name displayed at the top of the sidebar.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_sidebar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon_name</code></em> :</span></p></td>
<td>a themed icon name</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-sidebar-get-primary-text"></a><h3>e_shell_sidebar_get_primary_text ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_shell_sidebar_get_primary_text (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>);</pre>
<p>
Returns the primary text for <em class="parameter"><code>shell_sidebar</code></em>.
</p>
<p>
The primary text is displayed in bold at the top of the sidebar. It
defaults to the shell view's label (as seen on the switcher button),
but typically shows the name of the selected item in the sidebar.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_sidebar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the primary text for <em class="parameter"><code>shell_sidebar</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-sidebar-set-primary-text"></a><h3>e_shell_sidebar_set_primary_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_sidebar_set_primary_text (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *primary_text</code></em>);</pre>
<p>
Sets the primary text for <em class="parameter"><code>shell_sidebar</code></em>.
</p>
<p>
The primary text is displayed in bold at the top of the sidebar. It
defaults to the shell view's label (as seen on the switcher button),
but typically shows the name of the selected item in the sidebar.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_sidebar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>primary_text</code></em> :</span></p></td>
<td>text to be displayed in a bold font</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-sidebar-get-secondary-text"></a><h3>e_shell_sidebar_get_secondary_text ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_shell_sidebar_get_secondary_text (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>);</pre>
<p>
Returns the secondary text for <em class="parameter"><code>shell_sidebar</code></em>.
</p>
<p>
The secondary text is displayed in a smaller font at the top of the
sidebar. It typically shows information about the contents of the
selected sidebar item, such as total number of items, number of
selected items, etc.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_sidebar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the secondary text for <em class="parameter"><code>shell_sidebar</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-sidebar-set-secondary-text"></a><h3>e_shell_sidebar_set_secondary_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_sidebar_set_secondary_text (<em class="parameter"><code><a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a> *shell_sidebar</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *secondary_text</code></em>);</pre>
<p>
Sets the secondary text for <em class="parameter"><code>shell_sidebar</code></em>.
</p>
<p>
The secondary text is displayed in a smaller font at the top of the
sidebar. It typically shows information about the contents of the
selected sidebar item, such as total number of items, number of
selected items, etc.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_sidebar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellSidebar.html" title="EShellSidebar"><span class="type">EShellSidebar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>secondary_text</code></em> :</span></p></td>
<td>text to be displayed in a smaller font</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="EShellSidebar.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EShellSidebar--icon-name"></a><h3>The <code class="literal">"icon-name"</code> property</h3>
<pre class="programlisting"> "icon-name" <span class="type">gchar</span>* : Read / Write</pre>
<p>
The named icon is displayed at the top of the sidebar.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellSidebar--primary-text"></a><h3>The <code class="literal">"primary-text"</code> property</h3>
<pre class="programlisting"> "primary-text" <span class="type">gchar</span>* : Read / Write</pre>
<p>
The primary text is displayed in bold at the top of the sidebar.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellSidebar--secondary-text"></a><h3>The <code class="literal">"secondary-text"</code> property</h3>
<pre class="programlisting"> "secondary-text" <span class="type">gchar</span>* : Read / Write</pre>
<p>
The secondary text is displayed in a smaller font at the top of
the sidebar.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellSidebar--shell-view"></a><h3>The <code class="literal">"shell-view"</code> property</h3>
<pre class="programlisting"> "shell-view" <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a>* : Read / Write / Construct Only</pre>
<p>
The <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> to which the sidebar widget belongs.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|