/usr/share/gtk-doc/html/evolution-shell/EShell.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 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 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EShell</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="ch01.html" title="The Shell">
<link rel="next" href="EShellBackend.html" title="EShellBackend">
<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="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution Shell Reference Manual</th>
<td><a accesskey="n" href="EShellBackend.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EShell.synopsis" class="shortcut">Top</a>
|
<a href="#EShell.description" class="shortcut">Description</a>
|
<a href="#EShell.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EShell.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#EShell.properties" class="shortcut">Properties</a>
|
<a href="#EShell.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="EShell"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EShell.top_of_page"></a>EShell</span></h2>
<p>EShell — the backbone of Evolution</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EShell.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <shell/e-shell.h>
struct <a class="link" href="EShell.html#EShell-struct" title="struct EShell">EShell</a>;
<a class="link" href="EShell.html" title="EShell"><span class="returnvalue">EShell</span></a> * <a class="link" href="EShell.html#e-shell-get-default" title="e_shell_get_default ()">e_shell_get_default</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShell.html#e-shell-load-modules" title="e_shell_load_modules ()">e_shell_load_modules</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="EShell.html#e-shell-get-shell-backends" title="e_shell_get_shell_backends ()">e_shell_get_shell_backends</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EShell.html#e-shell-get-canonical-name" title="e_shell_get_canonical_name ()">e_shell_get_canonical_name</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<a class="link" href="EShellBackend.html" title="EShellBackend"><span class="returnvalue">EShellBackend</span></a> * <a class="link" href="EShell.html#e-shell-get-backend-by-name" title="e_shell_get_backend_by_name ()">e_shell_get_backend_by_name</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<a class="link" href="EShellBackend.html" title="EShellBackend"><span class="returnvalue">EShellBackend</span></a> * <a class="link" href="EShell.html#e-shell-get-backend-by-scheme" title="e_shell_get_backend_by_scheme ()">e_shell_get_backend_by_scheme</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *scheme</code></em>);
<a href="../evolution-util/EClientCache.html"><span class="returnvalue">EClientCache</span></a> * <a class="link" href="EShell.html#e-shell-get-client-cache" title="e_shell_get_client_cache ()">e_shell_get_client_cache</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
<a href="../libedataserver/ESourceRegistry.html"><span class="returnvalue">ESourceRegistry</span></a> * <a class="link" href="EShell.html#e-shell-get-registry" title="e_shell_get_registry ()">e_shell_get_registry</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="EShell.html#e-shell-create-shell-window" title="e_shell_create_shell_window ()">e_shell_create_shell_window</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *view_name</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="EShell.html#e-shell-handle-uris" title="e_shell_handle_uris ()">e_shell_handle_uris</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> * const *uris</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> do_import</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShell.html#e-shell-submit-alert" title="e_shell_submit_alert ()">e_shell_submit_alert</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code><a href="../evolution-util/EAlert.html"><span class="type">EAlert</span></a> *alert</code></em>);
<span class="returnvalue">GtkWindow</span> * <a class="link" href="EShell.html#e-shell-get-active-window" title="e_shell_get_active_window ()">e_shell_get_active_window</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EShell.html#e-shell-get-express-mode" title="e_shell_get_express_mode ()">e_shell_get_express_mode</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EShell.html#e-shell-get-module-directory" title="e_shell_get_module_directory ()">e_shell_get_module_directory</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EShell.html#e-shell-get-network-available" title="e_shell_get_network_available ()">e_shell_get_network_available</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShell.html#e-shell-set-network-available" title="e_shell_set_network_available ()">e_shell_set_network_available</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> network_available</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShell.html#e-shell-lock-network-available" title="e_shell_lock_network_available ()">e_shell_lock_network_available</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EShell.html#e-shell-get-online" title="e_shell_get_online ()">e_shell_get_online</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShell.html#e-shell-set-online" title="e_shell_set_online ()">e_shell_set_online</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> online</code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="EShell.html#e-shell-get-preferences-window" title="e_shell_get_preferences_window ()">e_shell_get_preferences_window</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShell.html#e-shell-event" title="e_shell_event ()">e_shell_event</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *event_name</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> event_data</code></em>);
enum <a class="link" href="EShell.html#EShellQuitReason" title="enum EShellQuitReason">EShellQuitReason</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="EShell.html#e-shell-quit" title="e_shell_quit ()">e_shell_quit</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code><a class="link" href="EShell.html#EShellQuitReason" title="enum EShellQuitReason"><span class="type">EShellQuitReason</span></a> reason</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShell.html#e-shell-cancel-quit" title="e_shell_cancel_quit ()">e_shell_cancel_quit</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EShell.html#e-shell-migrate-attempt" title="e_shell_migrate_attempt ()">e_shell_migrate_attempt</a> (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EShell.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GApplication
+----GtkApplication
+----EShell
</pre>
</div>
<div class="refsect1">
<a name="EShell.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EShell implements
GActionGroup, GActionMap, GInitable and <a href="../libebackend/EExtensible.html">EExtensible</a>.</p>
</div>
<div class="refsect1">
<a name="EShell.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="EShell.html#EShell--client-cache" title='The "client-cache" property'>client-cache</a>" <a href="../evolution-util/EClientCache.html"><span class="type">EClientCache</span></a>* : Read
"<a class="link" href="EShell.html#EShell--express-mode" title='The "express-mode" property'>express-mode</a>" <span class="type">gboolean</span> : Read / Write / Construct Only
"<a class="link" href="EShell.html#EShell--geometry" title='The "geometry" property'>geometry</a>" <span class="type">gchar</span>* : Write / Construct Only
"<a class="link" href="EShell.html#EShell--module-directory" title='The "module-directory" property'>module-directory</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
"<a class="link" href="EShell.html#EShell--network-available" title='The "network-available" property'>network-available</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="EShell.html#EShell--online" title='The "online" property'>online</a>" <span class="type">gboolean</span> : Read / Write / Construct
"<a class="link" href="EShell.html#EShell--registry" title='The "registry" property'>registry</a>" <a href="../libedataserver/ESourceRegistry.html"><span class="type">ESourceRegistry</span></a>* : Read
</pre>
</div>
<div class="refsect1">
<a name="EShell.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="EShell.html#EShell-event" title='The "event" signal'>event</a>" : <code class="literal">Action</code>
"<a class="link" href="EShell.html#EShell-handle-uri" title='The "handle-uri" signal'>handle-uri</a>" : <code class="literal">Action</code>
"<a class="link" href="EShell.html#EShell-prepare-for-offline" title='The "prepare-for-offline" signal'>prepare-for-offline</a>" : <code class="literal">Run First</code>
"<a class="link" href="EShell.html#EShell-prepare-for-online" title='The "prepare-for-online" signal'>prepare-for-online</a>" : <code class="literal">Run First</code>
"<a class="link" href="EShell.html#EShell-prepare-for-quit" title='The "prepare-for-quit" signal'>prepare-for-quit</a>" : <code class="literal">Run First</code>
"<a class="link" href="EShell.html#EShell-quit-requested" title='The "quit-requested" signal'>quit-requested</a>" : <code class="literal">Run First</code>
</pre>
</div>
<div class="refsect1">
<a name="EShell.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EShell.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EShell-struct"></a><h3>struct EShell</h3>
<pre class="programlisting">struct EShell;</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-get-default"></a><h3>e_shell_get_default ()</h3>
<pre class="programlisting"><a class="link" href="EShell.html" title="EShell"><span class="returnvalue">EShell</span></a> * e_shell_get_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> created by <function><code class="function">main()</code></function>.
</p>
<p>
Try to obtain the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> from elsewhere if you can. This function
is intended as a temporary workaround for when that proves difficult.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><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> singleton</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-load-modules"></a><h3>e_shell_load_modules ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_load_modules (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
<p>
Loads all installed modules and performs some internal bookkeeping.
This function should be called after creating the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> instance
but before initiating migration or starting the main loop.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <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-get-shell-backends"></a><h3>e_shell_get_shell_backends ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * e_shell_get_shell_backends (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
<p>
Returns a list of loaded <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> instances. The list is
owned by <em class="parameter"><code>shell</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</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of loaded <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> instances</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-get-canonical-name"></a><h3>e_shell_get_canonical_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_shell_get_canonical_name (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Returns the canonical name for the <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> whose name or alias
is <em class="parameter"><code>name</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</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name or alias of 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 canonical <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> name</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-get-backend-by-name"></a><h3>e_shell_get_backend_by_name ()</h3>
<pre class="programlisting"><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="returnvalue">EShellBackend</span></a> * e_shell_get_backend_by_name (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Returns the corresponding <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> for the given name or alias,
or <code class="literal">NULL</code> if <em class="parameter"><code>name</code></em> is not recognized.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name or alias of 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="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> named <em class="parameter"><code>name</code></em>, or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-get-backend-by-scheme"></a><h3>e_shell_get_backend_by_scheme ()</h3>
<pre class="programlisting"><a class="link" href="EShellBackend.html" title="EShellBackend"><span class="returnvalue">EShellBackend</span></a> * e_shell_get_backend_by_scheme (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *scheme</code></em>);</pre>
<p>
Returns the <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> that implements the given URI scheme,
or <code class="literal">NULL</code> if <em class="parameter"><code>scheme</code></em> is not recognized.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>scheme</code></em> :</span></p></td>
<td>a URI scheme</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> that implements <em class="parameter"><code>scheme</code></em>, or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-get-client-cache"></a><h3>e_shell_get_client_cache ()</h3>
<pre class="programlisting"><a href="../evolution-util/EClientCache.html"><span class="returnvalue">EClientCache</span></a> * e_shell_get_client_cache (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
<p>
Returns the <a href="../evolution-util/EClientCache.html"><span class="type">EClientCache</span></a> instance for <em class="parameter"><code>shell</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</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a href="../evolution-util/EClientCache.html"><span class="type">EClientCache</span></a> instance for <em class="parameter"><code>shell</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-get-registry"></a><h3>e_shell_get_registry ()</h3>
<pre class="programlisting"><a href="../libedataserver/ESourceRegistry.html"><span class="returnvalue">ESourceRegistry</span></a> * e_shell_get_registry (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
<p>
Returns the shell's <a href="../libedataserver/ESourceRegistry.html"><span class="type">ESourceRegistry</span></a> which holds all <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> instances.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a href="../libedataserver/ESourceRegistry.html"><span class="type">ESourceRegistry</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-create-shell-window"></a><h3>e_shell_create_shell_window ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * e_shell_create_shell_window (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *view_name</code></em>);</pre>
<p>
Creates a new <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>. Use this function instead of
<a class="link" href="EShellWindow.html#e-shell-window-new" title="e_shell_window_new ()"><code class="function">e_shell_window_new()</code></a> so that <em class="parameter"><code>shell</code></em> can properly configure
the window.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>view_name</code></em> :</span></p></td>
<td>name of the initial shell view, 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>a new <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-handle-uris"></a><h3>e_shell_handle_uris ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> e_shell_handle_uris (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> * const *uris</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> do_import</code></em>);</pre>
<p>
Emits the <a class="link" href="EShell.html#EShell-handle-uri" title='The "handle-uri" signal'><span class="type">"handle-uri"</span></a> signal for each URI.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uris</code></em> :</span></p></td>
<td>
<code class="literal">NULL</code>-terminated list of URIs</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>do_import</code></em> :</span></p></td>
<td>request an import of the URIs</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of URIs successfully handled</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-submit-alert"></a><h3>e_shell_submit_alert ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_submit_alert (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code><a href="../evolution-util/EAlert.html"><span class="type">EAlert</span></a> *alert</code></em>);</pre>
<p>
Broadcasts <em class="parameter"><code>alert</code></em> to all <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a><!-- -->s. This should only
be used for application-wide alerts such as a network outage. Submit
view-specific alerts to the appropriate <a class="link" href="EShellContent.html" title="EShellContent"><span class="type">EShellContent</span></a> instance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>alert</code></em> :</span></p></td>
<td>an <a href="../evolution-util/EAlert.html"><span class="type">EAlert</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-get-active-window"></a><h3>e_shell_get_active_window ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWindow</span> * e_shell_get_active_window (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
<p>
Returns the most recently focused watched window, according to
<code class="function">gtk_application_get_windows()</code>. Convenient for finding a parent
for a transient window.
</p>
<p>
Note the returned window is not necessarily an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></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</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> or <code class="literal">NULL</code> to use the default shell</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the most recently focused watched window</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-get-express-mode"></a><h3>e_shell_get_express_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_get_express_mode (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
<p>
Returns <code class="literal">TRUE</code> if Evolution is in express mode.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</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 Evolution is in express mode</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-get-module-directory"></a><h3>e_shell_get_module_directory ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_shell_get_module_directory (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
<p>
Returns the directory from which <a href="../libebackend/EModule.html"><span class="type">EModule</span></a><!-- -->s were loaded.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a href="../libebackend/EModule.html"><span class="type">EModule</span></a> directory</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-get-network-available"></a><h3>e_shell_get_network_available ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_get_network_available (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
<p>
Returns <code class="literal">TRUE</code> if a network is available.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</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 a network is available</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-set-network-available"></a><h3>e_shell_set_network_available ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_set_network_available (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> network_available</code></em>);</pre>
<p>
Sets whether a network is available. This is usually called in
response to a status change signal from NetworkManager. If the
network becomes unavailable while <a class="link" href="EShell.html#EShell--online" title='The "online" property'><span class="type">"online"</span></a> is <code class="literal">TRUE</code>, the
<em class="parameter"><code>shell</code></em> will force <a class="link" href="EShell.html#EShell--online" title='The "online" property'><span class="type">"online"</span></a> to <code class="literal">FALSE</code> until the network
becomes available again.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>network_available</code></em> :</span></p></td>
<td>whether a network is available</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-lock-network-available"></a><h3>e_shell_lock_network_available ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_lock_network_available (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
<p>
Locks the value of <a class="link" href="EShell.html#EShell--network-available" title='The "network-available" property'><span class="type">"network-available"</span></a> to <code class="literal">TRUE</code>. Further
attempts to set the property will be ignored.
</p>
<p>
This is used for the --force-online command-line option, which is
intended to override the network availability status as reported
by NetworkManager or other network monitoring software.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <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-get-online"></a><h3>e_shell_get_online ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_get_online (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
<p>
Returns <code class="literal">TRUE</code> if Evolution is online, <code class="literal">FALSE</code> if Evolution is offline.
Evolution may be offline because the user elected to work offline, or
because the network has become unavailable.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</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 Evolution is online</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-set-online"></a><h3>e_shell_set_online ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_set_online (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> online</code></em>);</pre>
<p>
Asynchronously places Evolution in online or offline mode.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>online</code></em> :</span></p></td>
<td>
<code class="literal">TRUE</code> to go online, <code class="literal">FALSE</code> to go offline</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-get-preferences-window"></a><h3>e_shell_get_preferences_window ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * e_shell_get_preferences_window (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
<p>
Returns the Evolution Preferences window.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the preferences window</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-event"></a><h3>e_shell_event ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_event (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *event_name</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> event_data</code></em>);</pre>
<p>
The <a class="link" href="EShell.html#EShell-event" title='The "event" signal'><span class="type">"event"</span></a> signal acts as a cheap mechanism for broadcasting
events to the rest of the application, such as new mail arriving. The
<em class="parameter"><code>event_name</code></em> is used as the signal detail, and <em class="parameter"><code>event_data</code></em> may point to
an object or data structure associated with the event.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>event_name</code></em> :</span></p></td>
<td>the name of the event</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>event_data</code></em> :</span></p></td>
<td>data associated with the event</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="EShellQuitReason"></a><h3>enum EShellQuitReason</h3>
<pre class="programlisting">typedef enum {
E_SHELL_QUIT_ACTION,
E_SHELL_QUIT_LAST_WINDOW,
E_SHELL_QUIT_OPTION,
E_SHELL_QUIT_REMOTE_REQUEST,
E_SHELL_QUIT_SESSION_REQUEST
} EShellQuitReason;
</pre>
<p>
These values are passed in the <a class="link" href="EShell.html#EShell-quit-requested" title='The "quit-requested" signal'><span class="type">"quit-requested"</span></a> signal to
indicate why the shell is requesting to shut down.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="E-SHELL-QUIT-ACTION:CAPS"></a><span class="term"><code class="literal">E_SHELL_QUIT_ACTION</code></span></p></td>
<td> <em class="parameter"><code>E_SHELL_WINDOW_ACTION_QUIT</code></em> was activated.
</td>
</tr>
<tr>
<td><p><a name="E-SHELL-QUIT-LAST-WINDOW:CAPS"></a><span class="term"><code class="literal">E_SHELL_QUIT_LAST_WINDOW</code></span></p></td>
<td> The last watched window has been destroyed.
</td>
</tr>
<tr>
<td><p><a name="E-SHELL-QUIT-OPTION:CAPS"></a><span class="term"><code class="literal">E_SHELL_QUIT_OPTION</code></span></p></td>
<td> The program was invoked with --quit. Extensions will never
see this value because they are not loaded when --quit is given.
</td>
</tr>
<tr>
<td><p><a name="E-SHELL-QUIT-REMOTE-REQUEST:CAPS"></a><span class="term"><code class="literal">E_SHELL_QUIT_REMOTE_REQUEST</code></span></p></td>
<td> Another Evolution process requested we quit.
</td>
</tr>
<tr>
<td><p><a name="E-SHELL-QUIT-SESSION-REQUEST:CAPS"></a><span class="term"><code class="literal">E_SHELL_QUIT_SESSION_REQUEST</code></span></p></td>
<td> The desktop session requested we quit.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-quit"></a><h3>e_shell_quit ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_quit (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
<em class="parameter"><code><a class="link" href="EShell.html#EShellQuitReason" title="enum EShellQuitReason"><span class="type">EShellQuitReason</span></a> reason</code></em>);</pre>
<p>
Requests an application shutdown. This happens in two phases: the
first is synchronous, the second is asynchronous.
</p>
<p>
In the first phase, the <em class="parameter"><code>shell</code></em> emits a <a class="link" href="EShell.html#EShell-quit-requested" title='The "quit-requested" signal'><span class="type">"quit-requested"</span></a> signal
to potentially give the user a chance to cancel shutdown. If the user
cancels shutdown, the function returns <code class="literal">FALSE</code>. Otherwise it proceeds
into the second phase.
</p>
<p>
In the second phase, the <em class="parameter"><code>shell</code></em> emits a <a class="link" href="EShell.html#EShell-prepare-for-quit" title='The "prepare-for-quit" signal'><span class="type">"prepare-for-quit"</span></a>
signal and immediately returns <code class="literal">TRUE</code>. Signal handlers may delay the
actual application shutdown while they clean up resources, but there
is no way to cancel shutdown at this point.
</p>
<p>
Consult the documentation for these two signals for details on how
to handle them.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>reason</code></em> :</span></p></td>
<td>the reason for quitting</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 shutdown is underway, <code class="literal">FALSE</code> if it was cancelled</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-cancel-quit"></a><h3>e_shell_cancel_quit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_cancel_quit (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
<p>
This function may only be called from <a class="link" href="EShell.html#EShell-quit-requested" title='The "quit-requested" signal'><span class="type">"quit-requested"</span></a> signal
handlers to prevent Evolution from quitting. Calling this will stop
further emission of the <a class="link" href="EShell.html#EShell-quit-requested" title='The "quit-requested" signal'><span class="type">"quit-requested"</span></a> signal.
</p>
<p>
Note: This function has no effect during a <a class="link" href="EShell.html#EShell-prepare-for-quit" title='The "prepare-for-quit" signal'><span class="type">"prepare-for-quit"</span></a>
signal emission.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>an <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-migrate-attempt"></a><h3>e_shell_migrate_attempt ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_migrate_attempt (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="EShell.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EShell--client-cache"></a><h3>The <code class="literal">"client-cache"</code> property</h3>
<pre class="programlisting"> "client-cache" <a href="../evolution-util/EClientCache.html"><span class="type">EClientCache</span></a>* : Read</pre>
<p>
Shared <a href="../libedataserver/EClient.html"><span class="type">EClient</span></a> instances.
</p>
</div>
<hr>
<div class="refsect2">
<a name="EShell--express-mode"></a><h3>The <code class="literal">"express-mode"</code> property</h3>
<pre class="programlisting"> "express-mode" <span class="type">gboolean</span> : Read / Write / Construct Only</pre>
<p>
Express mode alters Evolution's user interface to be mode
usable on devices with small screens.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="EShell--geometry"></a><h3>The <code class="literal">"geometry"</code> property</h3>
<pre class="programlisting"> "geometry" <span class="type">gchar</span>* : Write / Construct Only</pre>
<p>
User-specified initial window geometry string to apply
to the first <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> created.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EShell--module-directory"></a><h3>The <code class="literal">"module-directory"</code> property</h3>
<pre class="programlisting"> "module-directory" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
<p>
The directory from which to load <a href="../libebackend/EModule.html"><span class="type">EModule</span></a><!-- -->s.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EShell--network-available"></a><h3>The <code class="literal">"network-available"</code> property</h3>
<pre class="programlisting"> "network-available" <span class="type">gboolean</span> : Read / Write</pre>
<p>
Whether the network is available.
</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="EShell--online"></a><h3>The <code class="literal">"online"</code> property</h3>
<pre class="programlisting"> "online" <span class="type">gboolean</span> : Read / Write / Construct</pre>
<p>
Whether the shell is online.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="EShell--registry"></a><h3>The <code class="literal">"registry"</code> property</h3>
<pre class="programlisting"> "registry" <a href="../libedataserver/ESourceRegistry.html"><span class="type">ESourceRegistry</span></a>* : Read</pre>
<p>
The <a href="../libedataserver/ESourceRegistry.html"><span class="type">ESourceRegistry</span></a> manages <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> instances.
</p>
</div>
</div>
<div class="refsect1">
<a name="EShell.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="EShell-event"></a><h3>The <code class="literal">"event"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell,
<span class="type">gpointer</span> event_data,
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
<p>
This signal is used to broadcast custom events to the entire
application. The nature of <em class="parameter"><code>event_data</code></em> depends on the event
being broadcast. The signal's detail denotes the event.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> which emitted the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>event_data</code></em> :</span></p></td>
<td>data associated with the event</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>
<hr>
<div class="refsect2">
<a name="EShell-handle-uri"></a><h3>The <code class="literal">"handle-uri"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> user_function (<a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell,
<span class="type">gchar</span> *uri,
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
<p>
Emitted when <em class="parameter"><code>shell</code></em> receives a URI to be handled, usually by
way of a command-line argument. An <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> should listen
for this signal and try to handle the URI, usually by opening an
editor window for the identified resource.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> which emitted the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>the URI to be handled</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>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the URI could be handled, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="EShell-prepare-for-offline"></a><h3>The <code class="literal">"prepare-for-offline"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell,
<a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a> *activity,
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
<p>
Emitted when the user elects to work offline. An <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
should listen for this signal and make preparations for working
in offline mode.
</p>
<p>
If preparations for working offline cannot immediately be
completed (such as when synchronizing with a remote server),
the <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> should reference the <em class="parameter"><code>activity</code></em> until
preparations are complete, and then unreference the <em class="parameter"><code>activity</code></em>.
This will delay Evolution from actually going to offline mode
until all backends have unreferenced <em class="parameter"><code>activity</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</code></em> :</span></p></td>
<td>the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> which emitted the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>activity</code></em> :</span></p></td>
<td>the <a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a> for offline preparations</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>
<hr>
<div class="refsect2">
<a name="EShell-prepare-for-online"></a><h3>The <code class="literal">"prepare-for-online"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell,
<a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a> *activity,
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
<p>
Emitted when the user elects to work online. An <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
should listen for this signal and make preparations for working
in online mode.
</p>
<p>
If preparations for working online cannot immediately be
completed (such as when re-connecting to a remote server), the
<a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> should reference the <em class="parameter"><code>activity</code></em> until preparations
are complete, and then unreference the <em class="parameter"><code>activity</code></em>. This will
delay Evolution from actually going to online mode until all
backends have unreferenced <em class="parameter"><code>activity</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</code></em> :</span></p></td>
<td>the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> which emitted the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>activity</code></em> :</span></p></td>
<td>the <a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a> for offline preparations</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>
<hr>
<div class="refsect2">
<a name="EShell-prepare-for-quit"></a><h3>The <code class="literal">"prepare-for-quit"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell,
<a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a> *activity,
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
<p>
Emitted when the user elects to quit the application, after
<a class="link" href="EShell.html#EShell-quit-requested" title='The "quit-requested" signal'><span class="type">"quit-requested"</span></a>. An <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> should listen for
this signal and make preparations for shutting down.
</p>
<p>
If preparations for shutting down cannot immediately be completed
(such as when there are uncompleted network operations), the
<a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> should reference the <em class="parameter"><code>activity</code></em> until preparations
are complete, and then unreference the <em class="parameter"><code>activity</code></em>. This will
delay Evolution from actually shutting down until all backends
have unreferenced <em class="parameter"><code>activity</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</code></em> :</span></p></td>
<td>the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> which emitted the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>activity</code></em> :</span></p></td>
<td>the <a href="../evolution-util/EActivity.html"><span class="type">EActivity</span></a> for quit preparations</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>
<hr>
<div class="refsect2">
<a name="EShell-quit-requested"></a><h3>The <code class="literal">"quit-requested"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell,
<a class="link" href="EShell.html#EShellQuitReason" title="enum EShellQuitReason"><span class="type">EShellQuitReason</span></a> reason,
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
<p>
Emitted when the user elects to quit the application, before
<a class="link" href="EShell.html#EShell-prepare-for-quit" title='The "prepare-for-quit" signal'><span class="type">"prepare-for-quit"</span></a>.
</p>
<p>
<a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a><!-- -->s and editor windows can listen for
this signal to prompt the user to save changes or finish
scheduled operations immediately (such as sending mail in
Outbox). If the user elects to cancel, the signal handler
should call <a class="link" href="EShell.html#e-shell-cancel-quit" title="e_shell_cancel_quit ()"><code class="function">e_shell_cancel_quit()</code></a> to abort the quit.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td>the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> which emitted the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>reason</code></em> :</span></p></td>
<td>the reason for quitting</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>
|