/usr/share/gtk-doc/html/evolution-shell/evolution-shell-EShellBackend.html is in evolution-dev 3.28.1-2.
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 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 | <!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: Evolution Shell Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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="evolution-shell-EShell.html" title="EShell">
<link rel="next" href="evolution-shell-EShellWindow.html" title="EShellWindow">
<meta name="generator" content="GTK-Doc V1.27 (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="#evolution-shell-EShellBackend.description" class="shortcut">Description</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-shell-EShell.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="evolution-shell-EShellWindow.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="evolution-shell-EShellBackend"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-shell-EShellBackend.top_of_page"></a>EShellBackend</span></h2>
<p>EShellBackend — dynamically loaded capabilities</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-shell-EShellBackend.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">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="evolution-shell-EShellBackend.html#e-shell-backend-compare" title="e_shell_backend_compare ()">e_shell_backend_compare</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-shell-EShellBackend.html#e-shell-backend-get-config-dir" title="e_shell_backend_get_config_dir ()">e_shell_backend_get_config_dir</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-shell-EShellBackend.html#e-shell-backend-get-data-dir" title="e_shell_backend_get_data_dir ()">e_shell_backend_get_data_dir</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <a class="link" href="evolution-shell-EShell.html#EShell" title="struct EShell"><span class="returnvalue">_EShell</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-shell-EShellBackend.html#e-shell-backend-get-shell" title="e_shell_backend_get_shell ()">e_shell_backend_get_shell</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="evolution-shell-EShellBackend.html#e-shell-backend-add-activity" title="e_shell_backend_add_activity ()">e_shell_backend_add_activity</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="evolution-shell-EShellBackend.html#e-shell-backend-is-busy" title="e_shell_backend_is_busy ()">e_shell_backend_is_busy</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="evolution-shell-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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-shell-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> <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="evolution-shell-EShellBackend.html#e-shell-backend-cancel-all" title="e_shell_backend_cancel_all ()">e_shell_backend_cancel_all</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="evolution-shell-EShellBackend.html#e-shell-backend-start" title="e_shell_backend_start ()">e_shell_backend_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="evolution-shell-EShellBackend.html#e-shell-backend-is-started" title="e_shell_backend_is_started ()">e_shell_backend_is_started</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="evolution-shell-EShellBackend.html#e-shell-backend-migrate" title="e_shell_backend_migrate ()">e_shell_backend_migrate</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-shell-EShellBackend.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="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend">EShellBackend</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="evolution-shell-EShellBackend.html#EShellBackendClass" title="struct EShellBackendClass">EShellBackendClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-shell-EShellBackend.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <shell/e-shell-backend.h>
</pre>
</div>
<div class="refsect1">
<a name="evolution-shell-EShellBackend.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="evolution-shell-EShellBackend.functions_details"></a><h2>Functions</h2>
<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="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend_a</code></em>,
<em class="parameter"><code><a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend_b</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_backend_compare</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Using the <em class="structfield"><code>sort_order</code></em> field from both backends'
<a class="link" href="evolution-shell-EShellBackend.html#EShellBackendClass" title="struct EShellBackendClass"><span class="type">EShellBackendClass</span></a>, 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="refsect3">
<a name="e-shell-backend-compare.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>shell_backend_a</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>shell_backend_b</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-shell-backend-compare.returns"></a><h4>Returns</h4>
<p> -1, 0 or +1, for a less than, equal to or greater than result</p>
</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="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_backend_get_config_dir</code> is deprecated and should not be used in newly-written code.</p></div>
<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="refsect3">
<a name="e-shell-backend-get-config-dir.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>shell_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-shell-backend-get-config-dir.returns"></a><h4>Returns</h4>
<p> the backend's configuration directory</p>
</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="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_backend_get_data_dir</code> is deprecated and should not be used in newly-written code.</p></div>
<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="refsect3">
<a name="e-shell-backend-get-data-dir.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>shell_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-shell-backend-get-data-dir.returns"></a><h4>Returns</h4>
<p> the backend's data directory</p>
</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="evolution-shell-EShell.html#EShell" title="struct EShell"><span class="returnvalue">_EShell</span></a> *
e_shell_backend_get_shell (<em class="parameter"><code><a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_backend_get_shell</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Returns the <a class="link" href="evolution-shell-EShell.html#EShell" title="struct EShell"><span class="type">EShell</span></a> singleton.</p>
<div class="refsect3">
<a name="e-shell-backend-get-shell.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>shell_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-shell-backend-get-shell.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="evolution-shell-EShell.html#EShell" title="struct EShell"><span class="type">EShell</span></a></p>
</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="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>,
<em class="parameter"><code><span class="type">EActivity</span> *activity</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_backend_add_activity</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Emits an <span class="type">“activity-added”</span> signal and tracks the <em class="parameter"><code>activity</code></em>
until it is finalized.</p>
<div class="refsect3">
<a name="e-shell-backend-add-activity.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>shell_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>activity</p></td>
<td class="parameter_description"><p>an <span class="type">EActivity</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_backend_is_busy</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Returns <code class="literal">TRUE</code> if any activities passed to <a class="link" href="evolution-shell-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="refsect3">
<a name="e-shell-backend-is-busy.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>shell_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-shell-backend-is-busy.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if activities are still in progress</p>
</div>
</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="evolution-shell-EShellBackend.html#EShellBackend" title="struct 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>
<div class="warning"><p><code class="literal">e_shell_backend_set_prefer_new_item</code> is deprecated and should not be used in newly-written code.</p></div>
<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="refsect3">
<a name="e-shell-backend-set-prefer-new-item.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>shell_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prefer_new_item</p></td>
<td class="parameter_description"><p>name of an item</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-4.html#api-index-3.4">3.4</a></p>
</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="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_backend_get_prefer_new_item</code> is deprecated and should not be used in newly-written code.</p></div>
<div class="refsect3">
<a name="e-shell-backend-get-prefer-new-item.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>shell_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-shell-backend-get-prefer-new-item.returns"></a><h4>Returns</h4>
<p> Name of a preferred item in New toolbar button, <code class="literal">NULL</code> or
an empty string for no preference.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-4.html#api-index-3.4">3.4</a></p>
</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="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_backend_cancel_all</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Cancels all activities passed to <a class="link" href="evolution-shell-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 <span class="type">EActivity</span> 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="evolution-shell-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="refsect3">
<a name="e-shell-backend-cancel-all.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>shell_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</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="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_backend_start</code> is deprecated and should not be used in newly-written code.</p></div>
<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="evolution-shell-EShellView.html#EShellView" title="struct 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="refsect3">
<a name="e-shell-backend-start.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>shell_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</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="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a> *shell_backend</code></em>);</pre>
<div class="warning"><p><code class="literal">e_shell_backend_is_started</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Returns whether <a class="link" href="evolution-shell-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="refsect3">
<a name="e-shell-backend-is-started.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>shell_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-shell-backend-is-started.returns"></a><h4>Returns</h4>
<p> whether <em class="parameter"><code>shell_backend</code></em>
is started</p>
</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="evolution-shell-EShellBackend.html#EShellBackend" title="struct 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 class="warning"><p><code class="literal">e_shell_backend_migrate</code> is deprecated and should not be used in newly-written code.</p></div>
<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="refsect3">
<a name="e-shell-backend-migrate.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>shell_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-shell-EShellBackend.html#EShellBackend" title="struct EShellBackend"><span class="type">EShellBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>major</p></td>
<td class="parameter_description"><p>major part of version to migrate from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minor</p></td>
<td class="parameter_description"><p>minor part of version to migrate from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>micro</p></td>
<td class="parameter_description"><p>micro part of version to migrate from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-shell-backend-migrate.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="evolution-shell-EShellBackend.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EShellBackend"></a><h3>struct EShellBackend</h3>
<pre class="programlisting">struct EShellBackend {
EExtension parent;
EShellBackendPrivate *priv;
};
</pre>
<div class="warning"><p><code class="literal">EShellBackend</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellBackendClass"></a><h3>struct EShellBackendClass</h3>
<pre class="programlisting">struct EShellBackendClass {
EExtensionClass parent_class;
GType shell_view_type;
const gchar *name;
const gchar *aliases;
const gchar *schemes;
gint sort_order;
const gchar *preferences_page;
/* Methods */
void (*start) (EShellBackend *shell_backend);
gboolean (*migrate) (EShellBackend *shell_backend,
gint major,
gint minor,
gint micro,
GError **error);
const gchar * (*get_config_dir) (EShellBackend *shell_backend);
const gchar * (*get_data_dir) (EShellBackend *shell_backend);
};
</pre>
<div class="warning"><p><code class="literal">EShellBackendClass</code> is deprecated and should not be used in newly-written code.</p></div>
<p><a class="link" href="evolution-shell-EShellBackend.html#EShellBackendClass" title="struct EShellBackendClass"><span class="type">EShellBackendClass</span></a> contains a number of important settings for subclasses.</p>
<div class="refsect3">
<a name="EShellBackendClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">GType</span> <em class="structfield"><code><a name="EShellBackendClass.shell-view-type"></a>shell_view_type</code></em>;</p></td>
<td class="struct_member_description"><p><span class="type">GType</span> for the corresponding <a class="link" href="evolution-shell-EShellView.html#EShellView" title="struct EShellView"><span class="type">EShellView</span></a> subclass.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="EShellBackendClass.name"></a>name</code></em>;</p></td>
<td class="struct_member_description"><p>The name of the backend. Also becomes the name of
the corresponding <a class="link" href="evolution-shell-EShellView.html#EShellView" title="struct EShellView"><span class="type">EShellView</span></a> subclass that the
backend will register.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="EShellBackendClass.aliases"></a>aliases</code></em>;</p></td>
<td class="struct_member_description"><p>Colon-separated list of aliases that can be used
when referring to a backend by name.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="EShellBackendClass.schemes"></a>schemes</code></em>;</p></td>
<td class="struct_member_description"><p>Colon-separated list of URI schemes. The <a class="link" href="evolution-shell-EShell.html#EShell" title="struct EShell"><span class="type">EShell</span></a>
will forward command-line URIs to the appropriate
backend based on this list.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="EShellBackendClass.sort-order"></a>sort_order</code></em>;</p></td>
<td class="struct_member_description"><p>Used to determine the order of backends listed in
the main menu and in the switcher. See
<a class="link" href="evolution-shell-EShellBackend.html#e-shell-backend-compare" title="e_shell_backend_compare ()"><code class="function">e_shell_backend_compare()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="EShellBackendClass.preferences-page"></a>preferences_page</code></em>;</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="EShellBackendClass.start"></a>start</code></em> ()</p></td>
<td class="struct_member_description"><p>Method for notifying the backend to begin loading
data and running background tasks. This is called
just before the first instantiation of the
corresponding <a class="link" href="evolution-shell-EShellView.html#EShellView" title="struct EShellView"><span class="type">EShellView</span></a> subclass. It allows the
backend to delay initialization steps that consume
significant resources until they are actually needed.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="EShellBackendClass.migrate"></a>migrate</code></em> ()</p></td>
<td class="struct_member_description"><p>Method for notifying the backend to migrate data and
settings from the given version. 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 a <span class="type">GError</span> if the migration
failed.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="EShellBackendClass.get-config-dir"></a>get_config_dir</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="EShellBackendClass.get-data-dir"></a>get_data_dir</code></em> ()</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|