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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EShellWindow</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Evolution Shell Reference Manual">
<link rel="up" href="ch01.html" title="The Shell">
<link rel="prev" href="EShellBackend.html" title="EShellBackend">
<link rel="next" href="EShellView.html" title="EShellView">
<meta name="generator" content="GTK-Doc V1.17.1 (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="EShellBackend.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="EShellView.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EShellWindow.synopsis" class="shortcut">Top</a>
|
<a href="#EShellWindow.description" class="shortcut">Description</a>
|
<a href="#EShellWindow.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EShellWindow.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#EShellWindow.properties" class="shortcut">Properties</a>
|
<a href="#EShellWindow.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="EShellWindow"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EShellWindow.top_of_page"></a>EShellWindow</span></h2>
<p>EShellWindow — the main window</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EShellWindow.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <shell/e-shell-window.h>
struct <a class="link" href="EShellWindow.html#EShellWindow-struct" title="struct EShellWindow">EShellWindow</a>;
<span class="returnvalue">GtkWidget</span> * <a class="link" href="EShellWindow.html#e-shell-window-new" title="e_shell_window_new ()">e_shell_window_new</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> safe_mode</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *geometry</code></em>);
<a class="link" href="EShell.html" title="EShell"><span class="returnvalue">EShell</span></a> * <a class="link" href="EShellWindow.html#e-shell-window-get-shell" title="e_shell_window_get_shell ()">e_shell_window_get_shell</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);
struct <a class="link" href="EShellView.html" title="EShellView"><span class="returnvalue">_EShellView</span></a> * <a class="link" href="EShellWindow.html#e-shell-window-get-shell-view" title="e_shell_window_get_shell_view ()">e_shell_window_get_shell_view</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *view_name</code></em>);
struct <a class="link" href="EShellView.html" title="EShellView"><span class="returnvalue">_EShellView</span></a> * <a class="link" href="EShellWindow.html#e-shell-window-peek-shell-view" title="e_shell_window_peek_shell_view ()">e_shell_window_peek_shell_view</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *view_name</code></em>);
<span class="returnvalue">GtkAction</span> * <a class="link" href="EShellWindow.html#e-shell-window-get-shell-view-action" title="e_shell_window_get_shell_view_action ()">e_shell_window_get_shell_view_action</a>
(<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *view_name</code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="EShellWindow.html#e-shell-window-get-alert-bar" title="e_shell_window_get_alert_bar ()">e_shell_window_get_alert_bar</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);
<span class="returnvalue">EFocusTracker</span> * <a class="link" href="EShellWindow.html#e-shell-window-get-focus-tracker" title="e_shell_window_get_focus_tracker ()">e_shell_window_get_focus_tracker</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);
<span class="returnvalue">GtkUIManager</span> * <a class="link" href="EShellWindow.html#e-shell-window-get-ui-manager" title="e_shell_window_get_ui_manager ()">e_shell_window_get_ui_manager</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);
<span class="returnvalue">GtkAction</span> * <a class="link" href="EShellWindow.html#e-shell-window-get-action" title="e_shell_window_get_action ()">e_shell_window_get_action</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *action_name</code></em>);
<span class="returnvalue">GtkActionGroup</span> * <a class="link" href="EShellWindow.html#e-shell-window-get-action-group" title="e_shell_window_get_action_group ()">e_shell_window_get_action_group</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *group_name</code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="EShellWindow.html#e-shell-window-get-managed-widget" title="e_shell_window_get_managed_widget ()">e_shell_window_get_managed_widget</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *widget_path</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EShellWindow.html#e-shell-window-get-active-view" title="e_shell_window_get_active_view ()">e_shell_window_get_active_view</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellWindow.html#e-shell-window-set-active-view" title="e_shell_window_set_active_view ()">e_shell_window_set_active_view</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *view_name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EShellWindow.html#e-shell-window-get-safe-mode" title="e_shell_window_get_safe_mode ()">e_shell_window_get_safe_mode</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellWindow.html#e-shell-window-set-safe-mode" title="e_shell_window_set_safe_mode ()">e_shell_window_set_safe_mode</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> safe_mode</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellWindow.html#e-shell-window-add-action-group" title="e_shell_window_add_action_group ()">e_shell_window_add_action_group</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *group_name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EShellWindow.html#e-shell-window-get-sidebar-visible" title="e_shell_window_get_sidebar_visible ()">e_shell_window_get_sidebar_visible</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellWindow.html#e-shell-window-set-sidebar-visible" title="e_shell_window_set_sidebar_visible ()">e_shell_window_set_sidebar_visible</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> sidebar_visible</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EShellWindow.html#e-shell-window-get-switcher-visible" title="e_shell_window_get_switcher_visible ()">e_shell_window_get_switcher_visible</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellWindow.html#e-shell-window-set-switcher-visible" title="e_shell_window_set_switcher_visible ()">e_shell_window_set_switcher_visible</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> switcher_visible</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EShellWindow.html#e-shell-window-get-taskbar-visible" title="e_shell_window_get_taskbar_visible ()">e_shell_window_get_taskbar_visible</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellWindow.html#e-shell-window-set-taskbar-visible" title="e_shell_window_set_taskbar_visible ()">e_shell_window_set_taskbar_visible</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> taskbar_visible</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EShellWindow.html#e-shell-window-get-toolbar-visible" title="e_shell_window_get_toolbar_visible ()">e_shell_window_get_toolbar_visible</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellWindow.html#e-shell-window-set-toolbar-visible" title="e_shell_window_set_toolbar_visible ()">e_shell_window_set_toolbar_visible</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> toolbar_visible</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellWindow.html#e-shell-window-register-new-item-actions" title="e_shell_window_register_new_item_actions ()">e_shell_window_register_new_item_actions</a>
(<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *backend_name</code></em>,
<em class="parameter"><code><span class="type">GtkActionEntry</span> *entries</code></em>,
<em class="parameter"><code><span class="type">guint</span> n_entries</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EShellWindow.html#e-shell-window-register-new-source-actions" title="e_shell_window_register_new_source_actions ()">e_shell_window_register_new_source_actions</a>
(<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *backend_name</code></em>,
<em class="parameter"><code><span class="type">GtkActionEntry</span> *entries</code></em>,
<em class="parameter"><code><span class="type">guint</span> n_entries</code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="EShellWindow.html#e-shell-window-get-menu-bar-box" title="e_shell_window_get_menu_bar_box ()">e_shell_window_get_menu_bar_box</a> (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EShellWindow.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkWidget
+----GtkContainer
+----GtkBin
+----GtkWindow
+----EShellWindow
</pre>
</div>
<div class="refsect1">
<a name="EShellWindow.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EShellWindow implements
AtkImplementorIface, GtkBuildable, EAlertSink and <a class="link" href="EExtensible.html" title="EExtensible">EExtensible</a>.</p>
</div>
<div class="refsect1">
<a name="EShellWindow.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="EShellWindow.html#EShellWindow--active-view" title='The "active-view" property'>active-view</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="EShellWindow.html#EShellWindow--alert-bar" title='The "alert-bar" property'>alert-bar</a>" <span class="type">EAlertBar</span>* : Read
"<a class="link" href="EShellWindow.html#EShellWindow--focus-tracker" title='The "focus-tracker" property'>focus-tracker</a>" <span class="type">EFocusTracker</span>* : Read
"<a class="link" href="EShellWindow.html#EShellWindow--geometry" title='The "geometry" property'>geometry</a>" <span class="type">gchar</span>* : Write / Construct Only
"<a class="link" href="EShellWindow.html#EShellWindow--safe-mode" title='The "safe-mode" property'>safe-mode</a>" <span class="type">gboolean</span> : Read / Write / Construct
"<a class="link" href="EShellWindow.html#EShellWindow--shell" title='The "shell" property'>shell</a>" <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>* : Read / Write / Construct Only
"<a class="link" href="EShellWindow.html#EShellWindow--sidebar-visible" title='The "sidebar-visible" property'>sidebar-visible</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="EShellWindow.html#EShellWindow--switcher-visible" title='The "switcher-visible" property'>switcher-visible</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="EShellWindow.html#EShellWindow--taskbar-visible" title='The "taskbar-visible" property'>taskbar-visible</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="EShellWindow.html#EShellWindow--toolbar-visible" title='The "toolbar-visible" property'>toolbar-visible</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="EShellWindow.html#EShellWindow--ui-manager" title='The "ui-manager" property'>ui-manager</a>" <span class="type">GtkUIManager</span>* : Read
</pre>
</div>
<div class="refsect1">
<a name="EShellWindow.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="EShellWindow.html#EShellWindow-shell-view-created" title='The "shell-view-created" signal'>shell-view-created</a>" : <code class="literal">Has Details</code>
</pre>
</div>
<div class="refsect1">
<a name="EShellWindow.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EShellWindow.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EShellWindow-struct"></a><h3>struct EShellWindow</h3>
<pre class="programlisting">struct EShellWindow;</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-window-new"></a><h3>e_shell_window_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * e_shell_window_new (<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> safe_mode</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *geometry</code></em>);</pre>
<p>
Returns a new <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>.
</p>
<p>
It's up to the various <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a>'s to define exactly
what "safe mode" means, but the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> usually puts the initial
<a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> into "safe mode" if detects the previous Evolution
session crashed.
</p>
<p>
The initial view for the window is determined by GConf key
<code class="filename">/apps/evolution/shell/view_defaults/component_id</code>.
Or, if the GConf key is not set or can't be read, the first view
in the switcher is used.
</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>safe_mode</code></em> :</span></p></td>
<td>whether to initialize the window to "safe mode"</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>geometry</code></em> :</span></p></td>
<td>initial window geometry string, 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-window-get-shell"></a><h3>e_shell_window_get_shell ()</h3>
<pre class="programlisting"><a class="link" href="EShell.html" title="EShell"><span class="returnvalue">EShell</span></a> * e_shell_window_get_shell (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);</pre>
<p>
Returns the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> that was passed to <a class="link" href="EShellWindow.html#e-shell-window-new" title="e_shell_window_new ()"><code class="function">e_shell_window_new()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-shell-view"></a><h3>e_shell_window_get_shell_view ()</h3>
<pre class="programlisting">struct <a class="link" href="EShellView.html" title="EShellView"><span class="returnvalue">_EShellView</span></a> * e_shell_window_get_shell_view (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *view_name</code></em>);</pre>
<p>
Returns the <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> named <em class="parameter"><code>view_name</code></em> (see the
<em class="structfield"><code>name</code></em> field in <span class="type">EShellBackendInfo</span>). This
will also instantiate the <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> the first time it's requested.
To reduce resource consumption, Evolution tries to delay instantiating
shell views until the user switches to them. So in general, only the
active view name, as returned by <a class="link" href="EShellWindow.html#e-shell-window-get-active-view" title="e_shell_window_get_active_view ()"><code class="function">e_shell_window_get_active_view()</code></a>,
should be requested.
</p>
<p>
The function emits a <a class="link" href="EShellWindow.html#EShellWindow-shell-view-created" title='The "shell-view-created" signal'><span class="type">"shell-view-created"</span></a> signal with
<em class="parameter"><code>view_name</code></em> as the signal detail when it instantiates an <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</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_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>view_name</code></em> :</span></p></td>
<td>name of a shell view</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the requested <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a>, or <code class="literal">NULL</code> if no such view is
registered</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-peek-shell-view"></a><h3>e_shell_window_peek_shell_view ()</h3>
<pre class="programlisting">struct <a class="link" href="EShellView.html" title="EShellView"><span class="returnvalue">_EShellView</span></a> * e_shell_window_peek_shell_view (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *view_name</code></em>);</pre>
<p>
Returns the <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> named <em class="parameter"><code>view_name</code></em> (see the
<em class="structfield"><code>name</code></em> field in <span class="type">EShellBackendInfo</span>), or
<code class="literal">NULL</code> if the requested view has not yet been instantiated. Unlike
<a class="link" href="EShellWindow.html#e-shell-window-get-shell-view" title="e_shell_window_get_shell_view ()"><code class="function">e_shell_window_get_shell_view()</code></a>, this function will not instantiate
the view itself.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>view_name</code></em> :</span></p></td>
<td>name of a shell view</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the requested <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a>, or <code class="literal">NULL</code> if no such view is
instantiated</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-shell-view-action"></a><h3>e_shell_window_get_shell_view_action ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkAction</span> * e_shell_window_get_shell_view_action
(<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *view_name</code></em>);</pre>
<p>
Returns the switcher action for <em class="parameter"><code>view_name</code></em>.
</p>
<p>
An <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> creates a <span class="type">GtkRadioAction</span> for each registered subclass
of <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a>. This action gets passed to the <a class="link" href="EShellSwitcher.html" title="EShellSwitcher"><span class="type">EShellSwitcher</span></a>, which
displays a button that proxies the action. When the <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> named
<em class="parameter"><code>view_name</code></em> is active, the action's icon becomes the <em class="parameter"><code>shell_window</code></em> icon.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>view_name</code></em> :</span></p></td>
<td>name of a shell view</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the switcher action for the <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> named <em class="parameter"><code>view_name</code></em>,
or <code class="literal">NULL</code> if no such shell view exists</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-alert-bar"></a><h3>e_shell_window_get_alert_bar ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * e_shell_window_get_alert_bar (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);</pre>
<p>
Returns the <span class="type">EAlertBar</span> used to display informational and error messages.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <span class="type">EAlertBar</span> for <em class="parameter"><code>shell_window</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-focus-tracker"></a><h3>e_shell_window_get_focus_tracker ()</h3>
<pre class="programlisting"><span class="returnvalue">EFocusTracker</span> * e_shell_window_get_focus_tracker (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);</pre>
<p>
Returns <em class="parameter"><code>shell_window</code></em>'s focus tracker, which directs
Cut, Copy, Paste and Select All main menu activations to the
appropriate editable or selectable widget.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <span class="type">EFocusTracker</span> for <em class="parameter"><code>shell_window</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-ui-manager"></a><h3>e_shell_window_get_ui_manager ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkUIManager</span> * e_shell_window_get_ui_manager (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);</pre>
<p>
Returns <em class="parameter"><code>shell_window</code></em>'s user interface manager, which
manages the window's menus and toolbars via <span class="type">GtkAction</span>s.
This is the mechanism by which shell views and plugins can extend
Evolution's menus and toolbars.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <span class="type">GtkUIManager</span> for <em class="parameter"><code>shell_window</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-action"></a><h3>e_shell_window_get_action ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkAction</span> * e_shell_window_get_action (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *action_name</code></em>);</pre>
<p>
Returns the <span class="type">GtkAction</span> named <em class="parameter"><code>action_name</code></em> in <em class="parameter"><code>shell_window</code></em>'s
user interface manager, or <code class="literal">NULL</code> if no such action exists.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_name</code></em> :</span></p></td>
<td>the name of an action</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <span class="type">GtkAction</span> named <em class="parameter"><code>action_name</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-action-group"></a><h3>e_shell_window_get_action_group ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkActionGroup</span> * e_shell_window_get_action_group (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *group_name</code></em>);</pre>
<p>
Returns the <span class="type">GtkActionGroup</span> named <em class="parameter"><code>group_name</code></em> in
<em class="parameter"><code>shell_window</code></em>'s user interface manager, or <code class="literal">NULL</code> if no
such action group exists.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
<td>the name of an action group</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <span class="type">GtkActionGroup</span> named <em class="parameter"><code>group_name</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-managed-widget"></a><h3>e_shell_window_get_managed_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * e_shell_window_get_managed_widget (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *widget_path</code></em>);</pre>
<p>
Looks up a widget in <em class="parameter"><code>shell_window</code></em>'s user interface manager by
following a path. See <code class="function">gtk_ui_manager_get_widget()</code> for more information
about paths.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget_path</code></em> :</span></p></td>
<td>path in the UI definintion</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the widget found by following the path, or <code class="literal">NULL</code> if no widget
was found</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-active-view"></a><h3>e_shell_window_get_active_view ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_shell_window_get_active_view (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);</pre>
<p>
Returns the name of the active <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</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_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the name of the active view</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-set-active-view"></a><h3>e_shell_window_set_active_view ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_window_set_active_view (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *view_name</code></em>);</pre>
<p>
Switches <em class="parameter"><code>shell_window</code></em> to the <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> named <em class="parameter"><code>view_name</code></em>, causing
the entire content of <em class="parameter"><code>shell_window</code></em> to change. This is typically
called as a result of the user clicking one of the switcher buttons.
</p>
<p>
The name of the newly activated shell view is also written to GConf key
<code class="filename">/apps/evolution/shell/view_defaults/component_id</code>.
This makes the active shell view persistent across Evolution sessions.
It also causes new shell windows created within the current Evolution
session to open to the most recently selected shell view.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>view_name</code></em> :</span></p></td>
<td>the name of the shell view to switch to</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-safe-mode"></a><h3>e_shell_window_get_safe_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_window_get_safe_mode (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);</pre>
<p>
Returns <code class="literal">TRUE</code> if <em class="parameter"><code>shell_window</code></em> is in "safe mode".
</p>
<p>
It's up to the various <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a>'s to define exactly
what "safe mode" means. The <em class="parameter"><code>shell_window</code></em> simply manages the
"safe mode" state.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</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 <em class="parameter"><code>shell_window</code></em> is in "safe mode"</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-set-safe-mode"></a><h3>e_shell_window_set_safe_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_window_set_safe_mode (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> safe_mode</code></em>);</pre>
<p>
If <code class="literal">TRUE</code>, puts <em class="parameter"><code>shell_window</code></em> into "safe mode".
</p>
<p>
It's up to the various <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a>'s to define exactly
what "safe mode" means. The <em class="parameter"><code>shell_window</code></em> simply manages the
"safe mode" state.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>safe_mode</code></em> :</span></p></td>
<td>whether to put <em class="parameter"><code>shell_window</code></em> into "safe mode"</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-add-action-group"></a><h3>e_shell_window_add_action_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_window_add_action_group (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *group_name</code></em>);</pre>
<p>
Creates a new <span class="type">GtkActionGroup</span> and adds it to <em class="parameter"><code>shell_window</code></em>'s
user interface manager. This also takes care of details like setting
the translation domain.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
<td>the name of the new action group</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-sidebar-visible"></a><h3>e_shell_window_get_sidebar_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_window_get_sidebar_visible (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);</pre>
<p>
Returns <code class="literal">TRUE</code> if <em class="parameter"><code>shell_window</code></em>'s side bar is visible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</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> is the side bar is visible</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-set-sidebar-visible"></a><h3>e_shell_window_set_sidebar_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_window_set_sidebar_visible (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> sidebar_visible</code></em>);</pre>
<p>
Makes <em class="parameter"><code>shell_window</code></em>'s side bar visible or invisible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sidebar_visible</code></em> :</span></p></td>
<td>whether the side bar should be visible</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-switcher-visible"></a><h3>e_shell_window_get_switcher_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_window_get_switcher_visible (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);</pre>
<p>
Returns <code class="literal">TRUE</code> if <em class="parameter"><code>shell_window</code></em>'s switcher buttons are visible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</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> is the switcher buttons are visible</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-set-switcher-visible"></a><h3>e_shell_window_set_switcher_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_window_set_switcher_visible (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> switcher_visible</code></em>);</pre>
<p>
Makes <em class="parameter"><code>shell_window</code></em>'s switcher buttons visible or invisible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>switcher_visible</code></em> :</span></p></td>
<td>whether the switcher buttons should be visible</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-taskbar-visible"></a><h3>e_shell_window_get_taskbar_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_window_get_taskbar_visible (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);</pre>
<p>
Returns <code class="literal">TRUE</code> if <em class="parameter"><code>shell_window</code></em>'s task bar is visible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</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> is the task bar is visible</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-set-taskbar-visible"></a><h3>e_shell_window_set_taskbar_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_window_set_taskbar_visible (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> taskbar_visible</code></em>);</pre>
<p>
Makes <em class="parameter"><code>shell_window</code></em>'s task bar visible or invisible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>taskbar_visible</code></em> :</span></p></td>
<td>whether the task bar should be visible</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-toolbar-visible"></a><h3>e_shell_window_get_toolbar_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_shell_window_get_toolbar_visible (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);</pre>
<p>
Returns <code class="literal">TRUE</code> if <em class="parameter"><code>shell_window</code></em>'s tool bar is visible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</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 the tool bar is visible</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-set-toolbar-visible"></a><h3>e_shell_window_set_toolbar_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_window_set_toolbar_visible (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> toolbar_visible</code></em>);</pre>
<p>
Makes <em class="parameter"><code>shell_window</code></em>'s tool bar visible or invisible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>toolbar_visible</code></em> :</span></p></td>
<td>whether the tool bar should be visible</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-register-new-item-actions"></a><h3>e_shell_window_register_new_item_actions ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_window_register_new_item_actions
(<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *backend_name</code></em>,
<em class="parameter"><code><span class="type">GtkActionEntry</span> *entries</code></em>,
<em class="parameter"><code><span class="type">guint</span> n_entries</code></em>);</pre>
<p>
Registers a list of <span class="type">GtkAction</span>s to appear in
<em class="parameter"><code>shell_window</code></em>'s "New" menu and toolbar button. This
function should be called from an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>'s
<a class="link" href="EShell.html#EShell-window-created" title='The "window-created" signal'><span class="type">"window-created"</span></a> signal handler. The <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> calling
this function should pass its own name for the <em class="parameter"><code>backend_name</code></em> argument
(i.e. the <em class="structfield"><code>name</code></em> field from its own
<span class="type">EShellBackendInfo</span>).
</p>
<p>
The registered <span class="type">GtkAction</span>s should be for creating individual
items such as an email message or a calendar appointment. The action
labels should be marked for translation with the "New" context using
the <code class="function">NC_()</code> macro.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend_name</code></em> :</span></p></td>
<td>name of an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entries</code></em> :</span></p></td>
<td>an array of <span class="type">GtkActionEntry</span>s</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_entries</code></em> :</span></p></td>
<td>number of elements in the array</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-register-new-source-actions"></a><h3>e_shell_window_register_new_source_actions ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_shell_window_register_new_source_actions
(<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *backend_name</code></em>,
<em class="parameter"><code><span class="type">GtkActionEntry</span> *entries</code></em>,
<em class="parameter"><code><span class="type">guint</span> n_entries</code></em>);</pre>
<p>
Registers a list of <span class="type">GtkAction</span>s to appear in
<em class="parameter"><code>shell_window</code></em>'s "New" menu and toolbar button. This
function should be called from an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>'s
<a class="link" href="EShell.html#EShell-window-created" title='The "window-created" signal'><span class="type">"window-created"</span></a> signal handler. The <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a> calling
this function should pass its own name for the <em class="parameter"><code>backend_name</code></em> argument
(i.e. the <em class="structfield"><code>name</code></em> field from its own
<span class="type">EShellBackendInfo</span>).
</p>
<p>
The registered <span class="type">GtkAction</span>s should be for creating item
containers such as an email folder or a calendar. The action labels
should be marked for translation with the "New" context using the
<code class="function">NC_()</code> macro.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>an <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend_name</code></em> :</span></p></td>
<td>name of an <a class="link" href="EShellBackend.html" title="EShellBackend"><span class="type">EShellBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entries</code></em> :</span></p></td>
<td>an array of <span class="type">GtkActionEntry</span>s</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_entries</code></em> :</span></p></td>
<td>number of elements in the array</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-shell-window-get-menu-bar-box"></a><h3>e_shell_window_get_menu_bar_box ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * e_shell_window_get_menu_bar_box (<em class="parameter"><code><a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window</code></em>);</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="EShellWindow.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EShellWindow--active-view"></a><h3>The <code class="literal">"active-view"</code> property</h3>
<pre class="programlisting"> "active-view" <span class="type">gchar</span>* : Read / Write</pre>
<p>
Name of the active <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a>.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellWindow--alert-bar"></a><h3>The <code class="literal">"alert-bar"</code> property</h3>
<pre class="programlisting"> "alert-bar" <span class="type">EAlertBar</span>* : Read</pre>
<p>
Displays informational and error messages.
</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellWindow--focus-tracker"></a><h3>The <code class="literal">"focus-tracker"</code> property</h3>
<pre class="programlisting"> "focus-tracker" <span class="type">EFocusTracker</span>* : Read</pre>
<p>
The shell window's <span class="type">EFocusTracker</span>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellWindow--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.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellWindow--safe-mode"></a><h3>The <code class="literal">"safe-mode"</code> property</h3>
<pre class="programlisting"> "safe-mode" <span class="type">gboolean</span> : Read / Write / Construct</pre>
<p>
Whether the shell window is in safe mode.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellWindow--shell"></a><h3>The <code class="literal">"shell"</code> property</h3>
<pre class="programlisting"> "shell" <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>* : Read / Write / Construct Only</pre>
<p>
The <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> singleton.
</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellWindow--sidebar-visible"></a><h3>The <code class="literal">"sidebar-visible"</code> property</h3>
<pre class="programlisting"> "sidebar-visible" <span class="type">gboolean</span> : Read / Write</pre>
<p>
Whether the shell window's side bar is visible.
</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellWindow--switcher-visible"></a><h3>The <code class="literal">"switcher-visible"</code> property</h3>
<pre class="programlisting"> "switcher-visible" <span class="type">gboolean</span> : Read / Write</pre>
<p>
Whether the shell window's switcher buttons are visible.
</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellWindow--taskbar-visible"></a><h3>The <code class="literal">"taskbar-visible"</code> property</h3>
<pre class="programlisting"> "taskbar-visible" <span class="type">gboolean</span> : Read / Write</pre>
<p>
Whether the shell window's task bar is visible.
</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellWindow--toolbar-visible"></a><h3>The <code class="literal">"toolbar-visible"</code> property</h3>
<pre class="programlisting"> "toolbar-visible" <span class="type">gboolean</span> : Read / Write</pre>
<p>
Whether the shell window's tool bar is visible.
</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="EShellWindow--ui-manager"></a><h3>The <code class="literal">"ui-manager"</code> property</h3>
<pre class="programlisting"> "ui-manager" <span class="type">GtkUIManager</span>* : Read</pre>
<p>
The shell window's <span class="type">GtkUIManager</span>.
</p>
</div>
</div>
<div class="refsect1">
<a name="EShellWindow.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="EShellWindow-shell-view-created"></a><h3>The <code class="literal">"shell-view-created"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> *shell_window,
<a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> *shell_view,
<span class="type">gpointer</span> user_data) : <code class="literal">Has Details</code></pre>
<p>
Emitted when a new <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> is instantiated by way of
<a class="link" href="EShellWindow.html#e-shell-window-get-shell-view" title="e_shell_window_get_shell_view ()"><code class="function">e_shell_window_get_shell_view()</code></a>. The signal detail denotes
the new view name, which can be used to obtain notification
of when a particular <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a> is created.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_window</code></em> :</span></p></td>
<td>the <a class="link" href="EShellWindow.html" title="EShellWindow"><span class="type">EShellWindow</span></a> which emitted the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell_view</code></em> :</span></p></td>
<td>the new <a class="link" href="EShellView.html" title="EShellView"><span class="type">EShellView</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17.1</div>
</body>
</html>
|