/usr/share/gtk-doc/html/evolution-shell/EShellBackend.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 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EShellBackend</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="EShell.html" title="EShell">
<link rel="next" href="EShellWindow.html" title="EShellWindow">
<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="EShell.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="EShellWindow.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EShellBackend.synopsis" class="shortcut">Top</a>
|
<a href="#EShellBackend.description" class="shortcut">Description</a>
|
<a href="#EShellBackend.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EShellBackend.properties" class="shortcut">Properties</a>
|
<a href="#EShellBackend.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="EShellBackend"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EShellBackend.top_of_page"></a>EShellBackend</span></h2>
<p>EShellBackend — dynamically loaded capabilities</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EShellBackend.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <shell/e-shell-backend.h>
struct <a class="link" href="EShellBackend.html#EShellBackend-struct" title="struct EShellBackend">EShellBackend</a>;
<span class="returnvalue">gint</span> <a class="link" href="EShellBackend.html#e-shell-backend-compare" title="e_shell_backend_compare ()">e_shell_backend_compare</a> (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend_a</code></em>,
<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend_b</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EShellBackend.html#e-shell-backend-get-config-dir" title="e_shell_backend_get_config_dir ()">e_shell_backend_get_config_dir</a> (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EShellBackend.html#e-shell-backend-get-data-dir" title="e_shell_backend_get_data_dir ()">e_shell_backend_get_data_dir</a> (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);
struct <a class="link" href="EShell.html" title="EShell"><span class="returnvalue">_EShell</span></a> * <a class="link" href="EShellBackend.html#e-shell-backend-get-shell" title="e_shell_backend_get_shell ()">e_shell_backend_get_shell</a> (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellBackend.html#e-shell-backend-add-activity" title="e_shell_backend_add_activity ()">e_shell_backend_add_activity</a> (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>,
<em class="parameter"><code><a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a> *activity</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellBackend.html#e-shell-backend-cancel-all" title="e_shell_backend_cancel_all ()">e_shell_backend_cancel_all</a> (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EShellBackend.html#e-shell-backend-is-busy" title="e_shell_backend_is_busy ()">e_shell_backend_is_busy</a> (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EShellBackend.html#e-shell-backend-get-prefer-new-item" title="e_shell_backend_get_prefer_new_item ()">e_shell_backend_get_prefer_new_item</a> (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellBackend.html#e-shell-backend-set-prefer-new-item" title="e_shell_backend_set_prefer_new_item ()">e_shell_backend_set_prefer_new_item</a> (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *prefer_new_item</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellBackend.html#e-shell-backend-start" title="e_shell_backend_start ()">e_shell_backend_start</a> (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EShellBackend.html#e-shell-backend-is-started" title="e_shell_backend_is_started ()">e_shell_backend_is_started</a> (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EShellBackend.html#e-shell-backend-migrate" title="e_shell_backend_migrate ()">e_shell_backend_migrate</a> (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>,
<em class="parameter"><code><span class="type">gint</span> major</code></em>,
<em class="parameter"><code><span class="type">gint</span> minor</code></em>,
<em class="parameter"><code><span class="type">gint</span> micro</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EShellBackend.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a href="../libebackend/EExtension.html">EExtension</a>
+----EShellBackend
</pre>
</div>
<div class="refsect1">
<a name="EShellBackend.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="EShellBackend.html#EShellBackend--busy" title='The "busy" property'>busy</a>" <span class="type">gboolean</span> : Read
"<a class="link" href="EShellBackend.html#EShellBackend--prefer-new-item" title='The "prefer-new-item" property'>prefer-new-item</a>" <span class="type">gchar</span>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="EShellBackend.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="EShellBackend.html#EShellBackend-activity-added" title='The "activity-added" signal'>activity-added</a>" : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="EShellBackend.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EShellBackend.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EShellBackend-struct"></a><h3>struct EShellBackend</h3>
<pre class="programlisting">struct EShellBackend;</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-backend-compare"></a><h3>e_shell_backend_compare ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> e_shell_backend_compare (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend_a</code></em>,
<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend_b</code></em>);</pre>
<p>
Using the <structfield>sort_order</structfield> field from both backends'
<span class="type">EShellBackendClass</span>, compares <em class="parameter"><code>shell_backend_a</code></em> with <em class="parameter"><code>shell_mobule_b</code></em> and
returns -1, 0 or +1 if <em class="parameter"><code>shell_backend_a</code></em> is found to be less than, equal
to or greater than <em class="parameter"><code>shell_backend_b</code></em>, respectively.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_backend_a</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_backend_b</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>-1, 0 or +1, for a less than, equal to or greater than result</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-backend-get-config-dir"></a><h3>e_shell_backend_get_config_dir ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_shell_backend_get_config_dir (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<p>
Returns the absolute path to the configuration directory for
<em class="parameter"><code>shell_backend</code></em>. The string is owned by <em class="parameter"><code>shell_backend</code></em> and should
not be modified or freed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_backend</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the backend's configuration directory</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-backend-get-data-dir"></a><h3>e_shell_backend_get_data_dir ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_shell_backend_get_data_dir (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<p>
Returns the absolute path to the data directory for <em class="parameter"><code>shell_backend</code></em>.
The string is owned by <em class="parameter"><code>shell_backend</code></em> and should not be modified or
freed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_backend</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the backend's data directory</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-backend-get-shell"></a><h3>e_shell_backend_get_shell ()</h3>
<pre class="programlisting">struct <a class="link" href="EShell.html" title="EShell"><span class="returnvalue">_EShell</span></a> * e_shell_backend_get_shell (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<p>
Returns the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> singleton.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_backend</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</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="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-backend-add-activity"></a><h3>e_shell_backend_add_activity ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_backend_add_activity (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>,
<em class="parameter"><code><a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a> *activity</code></em>);</pre>
<p>
Emits an <a class="link" href="EShellBackend.html#EShellBackend-activity-added" title='The "activity-added" signal'><span class="type">"activity-added"</span></a> signal and tracks the <em class="parameter"><code>activity</code></em>
until it is finalized.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_backend</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>activity</code></em> :</span></p></td>
<td>an <a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-backend-cancel-all"></a><h3>e_shell_backend_cancel_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_backend_cancel_all (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<p>
Cancels all activities passed to <a class="link" href="EShellBackend.html#e-shell-backend-add-activity" title="e_shell_backend_add_activity ()"><code class="function">e_shell_backend_add_activity()</code></a> that
have not already been finalized. Note that an <a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a> can only be
cancelled if it was given a <span class="type">GCancellable</span> object.
</p>
<p>
Also, assuming all activities are cancellable, there may still be a
delay before <a class="link" href="EShellBackend.html#e-shell-backend-is-busy" title="e_shell_backend_is_busy ()"><code class="function">e_shell_backend_is_busy()</code></a> returns <code class="literal">FALSE</code>, because some
activities may not be able to respond to the cancellation request
immediately. Connect to the "notify::busy" signal if you need
notification of <em class="parameter"><code>shell_backend</code></em> becoming idle.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>shell_backend</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-backend-is-busy"></a><h3>e_shell_backend_is_busy ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_backend_is_busy (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<p>
Returns <code class="literal">TRUE</code> if any activities passed to <a class="link" href="EShellBackend.html#e-shell-backend-add-activity" title="e_shell_backend_add_activity ()"><code class="function">e_shell_backend_add_activity()</code></a>
are still in progress, <code class="literal">FALSE</code> if the <em class="parameter"><code>shell_backend</code></em> is currently idle.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_backend</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if activities are still in progress</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-backend-get-prefer-new-item"></a><h3>e_shell_backend_get_prefer_new_item ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_shell_backend_get_prefer_new_item (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_backend</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Name of a preferred item in New toolbar button, <code class="literal">NULL</code> or
an empty string for no preference.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-backend-set-prefer-new-item"></a><h3>e_shell_backend_set_prefer_new_item ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_backend_set_prefer_new_item (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *prefer_new_item</code></em>);</pre>
<p>
Sets name of a preferred item in New toolbar button. Use <code class="literal">NULL</code> or
an empty string for no preference.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_backend</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefer_new_item</code></em> :</span></p></td>
<td>name of an item</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-backend-start"></a><h3>e_shell_backend_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_backend_start (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<p>
Tells the <em class="parameter"><code>shell_backend</code></em> to begin loading data or running background
tasks which may consume significant resources. This gets called in
reponse to the user switching to the corresponding <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> for
the first time. The function is idempotent for each <em class="parameter"><code>shell_backend</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_backend</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-backend-is-started"></a><h3>e_shell_backend_is_started ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_backend_is_started (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<p>
Returns whether <a class="link" href="EShellBackend.html#e-shell-backend-start" title="e_shell_backend_start ()"><code class="function">e_shell_backend_start()</code></a> was called for <em class="parameter"><code>shell_backend</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_backend</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether <em class="parameter"><code>shell_backend</code></em> is started</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-backend-migrate"></a><h3>e_shell_backend_migrate ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_backend_migrate (<em class="parameter"><code><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>,
<em class="parameter"><code><span class="type">gint</span> major</code></em>,
<em class="parameter"><code><span class="type">gint</span> minor</code></em>,
<em class="parameter"><code><span class="type">gint</span> micro</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Attempts to migrate data and settings from version <code class="literal">major</code>.<code class="literal">minor</code>.<code class="literal">micro</code>.
Returns <code class="literal">TRUE</code> if the migration was successful or if no action was
necessary. Returns <code class="literal">FALSE</code> and sets <code class="literal">error</code> if the migration failed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_backend</code></em> :</span></p></td>
<td>an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
<td>major part of version to migrate from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
<td>minor part of version to migrate from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
<td>micro part of version to migrate from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="EShellBackend.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EShellBackend--busy"></a><h3>The <code class="literal">"busy"</code> property</h3>
<pre class="programlisting"> "busy" <span class="type">gboolean</span> : Read</pre>
<p>
Whether any activities are still in progress.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellBackend--prefer-new-item"></a><h3>The <code class="literal">"prefer-new-item"</code> property</h3>
<pre class="programlisting"> "prefer-new-item" <span class="type">gchar</span>* : Read / Write</pre>
<p>
Name of an item to prefer in New toolbar button; can be NULL
</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="EShellBackend.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="EShellBackend-activity-added"></a><h3>The <code class="literal">"activity-added"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend,
<a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a> *activity,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
Broadcasts a newly added activity.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_backend</code></em> :</span></p></td>
<td>the <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> that emitted the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>activity</code></em> :</span></p></td>
<td>an <a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|