/usr/share/gtk-doc/html/evolution-shell/EShellTaskbar.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EShellTaskbar</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="EShellSidebar.html" title="EShellSidebar">
<link rel="next" href="EShellSearchbar.html" title="EShellSearchbar">
<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="EShellSidebar.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="EShellSearchbar.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EShellTaskbar.synopsis" class="shortcut">Top</a>
|
<a href="#EShellTaskbar.description" class="shortcut">Description</a>
|
<a href="#EShellTaskbar.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EShellTaskbar.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#EShellTaskbar.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="EShellTaskbar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EShellTaskbar.top_of_page"></a>EShellTaskbar</span></h2>
<p>EShellTaskbar — the bottom of the main window</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EShellTaskbar.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <shell/e-shell-taskbar.h>
struct <a class="link" href="EShellTaskbar.html#EShellTaskbar-struct" title="struct EShellTaskbar">EShellTaskbar</a>;
<span class="returnvalue">GtkWidget</span> * <a class="link" href="EShellTaskbar.html#e-shell-taskbar-new" title="e_shell_taskbar_new ()">e_shell_taskbar_new</a> (<em class="parameter"><code><span class="type">struct _EShellView</span> *shell_view</code></em>);
struct <a class="link" href="EShellView.html" title="EShellView"><span class="returnvalue">_EShellView</span></a> * <a class="link" href="EShellTaskbar.html#e-shell-taskbar-get-shell-view" title="e_shell_taskbar_get_shell_view ()">e_shell_taskbar_get_shell_view</a> (<em class="parameter"><code><a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a> *shell_taskbar</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EShellTaskbar.html#e-shell-taskbar-get-message" title="e_shell_taskbar_get_message ()">e_shell_taskbar_get_message</a> (<em class="parameter"><code><a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a> *shell_taskbar</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellTaskbar.html#e-shell-taskbar-set-message" title="e_shell_taskbar_set_message ()">e_shell_taskbar_set_message</a> (<em class="parameter"><code><a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a> *shell_taskbar</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellTaskbar.html#e-shell-taskbar-unset-message" title="e_shell_taskbar_unset_message ()">e_shell_taskbar_unset_message</a> (<em class="parameter"><code><a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a> *shell_taskbar</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="EShellTaskbar.html#e-shell-taskbar-get-activity-count" title="e_shell_taskbar_get_activity_count ()">e_shell_taskbar_get_activity_count</a> (<em class="parameter"><code><a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a> *shell_taskbar</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EShellTaskbar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkWidget
+----GtkContainer
+----GtkBox
+----GtkHBox
+----EShellTaskbar
</pre>
</div>
<div class="refsect1">
<a name="EShellTaskbar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EShellTaskbar implements
AtkImplementorIface, GtkBuildable, GtkOrientable and <a href="../libebackend/EExtensible.html">EExtensible</a>.</p>
</div>
<div class="refsect1">
<a name="EShellTaskbar.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="EShellTaskbar.html#EShellTaskbar--message" title='The "message" property'>message</a>" <span class="type">gchar</span>* : Read / Write / Construct
"<a class="link" href="EShellTaskbar.html#EShellTaskbar--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="EShellTaskbar.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EShellTaskbar.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EShellTaskbar-struct"></a><h3>struct EShellTaskbar</h3>
<pre class="programlisting">struct EShellTaskbar;</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-taskbar-new"></a><h3>e_shell_taskbar_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * e_shell_taskbar_new (<em class="parameter"><code><span class="type">struct _EShellView</span> *shell_view</code></em>);</pre>
<p>
Creates a new <a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</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="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a> instance</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-taskbar-get-shell-view"></a><h3>e_shell_taskbar_get_shell_view ()</h3>
<pre class="programlisting">struct <a class="link" href="EShellView.html" title="EShellView"><span class="returnvalue">_EShellView</span></a> * e_shell_taskbar_get_shell_view (<em class="parameter"><code><a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a> *shell_taskbar</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="EShellTaskbar.html#e-shell-taskbar-new" title="e_shell_taskbar_new ()"><code class="function">e_shell_taskbar_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_taskbar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</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_taskbar</code></em> belongs</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-taskbar-get-message"></a><h3>e_shell_taskbar_get_message ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_shell_taskbar_get_message (<em class="parameter"><code><a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a> *shell_taskbar</code></em>);</pre>
<p>
Returns the message currently shown in the taskbar, or an empty string
if no message is shown. Taskbar messages are used primarily for menu
tooltips.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_taskbar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the current taskbar message</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-taskbar-set-message"></a><h3>e_shell_taskbar_set_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_taskbar_set_message (<em class="parameter"><code><a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a> *shell_taskbar</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);</pre>
<p>
Shows a message in the taskbar. If <em class="parameter"><code>message</code></em> is <code class="literal">NULL</code> or an empty string,
the taskbar message is cleared. Taskbar messages are used primarily for
menu tooltips.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_taskbar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>the message to show</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-taskbar-unset-message"></a><h3>e_shell_taskbar_unset_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_taskbar_unset_message (<em class="parameter"><code><a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a> *shell_taskbar</code></em>);</pre>
<p>
This is equivalent to passing a <code class="literal">NULL</code> message to
<a class="link" href="EShellTaskbar.html#e-shell-taskbar-set-message" title="e_shell_taskbar_set_message ()"><code class="function">e_shell_taskbar_set_message()</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_taskbar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-taskbar-get-activity-count"></a><h3>e_shell_taskbar_get_activity_count ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> e_shell_taskbar_get_activity_count (<em class="parameter"><code><a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a> *shell_taskbar</code></em>);</pre>
<p>
Returns the number of active <a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a> instances being tracked.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_taskbar</code></em> :</span></p></td>
<td>an <a class="link" href="EShellTaskbar.html" title="EShellTaskbar"><span class="type">EShellTaskbar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of <a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a> instances</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="EShellTaskbar.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EShellTaskbar--message"></a><h3>The <code class="literal">"message"</code> property</h3>
<pre class="programlisting"> "message" <span class="type">gchar</span>* : Read / Write / Construct</pre>
<p>
The message to display in the taskbar.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellTaskbar--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 taskbar widget belongs.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|