← Back to branch summary

~ubuntu-branches/ubuntu/precise/evolution/precise

« back to all changes in this revision

Viewing changes to doc/reference/shell/html/eshell-Shell-Utilities.html

  • Committer: Bazaar Package Importer
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2011-06-24 00:27:53 UTC
  • mfrom: (1.1.80 upstream)
  • Revision ID: james.westby@ubuntu.com-20110624002753-2vh1vjavlya7r103
Tags: 3.1.2-0ubuntu1
* New upstream release 3.1.2.
* debian/control: adjust Build-Depends to match new upstream requirements for
  the new release.
* debian/control: update evolution and evolution-dev Depends to require the
  right versions of e-d-s (>= 3.1, << 3.2), and drop libunique-3.0-dev.
* debian/control,
  debian/evolution.install: remove groupwise-features from the plugin list,
  it's now split out into a separate module.
* debian/patches/03_lpi.patch: refreshed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/shell/html/eshell-Shell-Utilities.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>Shell Utilities</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
7
<link rel="home" href="index.html" title="Evolution Shell Reference Manual">
8
8
<link rel="up" href="ch01.html" title="The Shell">
9
9
<link rel="prev" href="EShellSwitcher.html" title="EShellSwitcher">
10
10
<link rel="next" href="ch02.html" title="Basic Utility Functions">
11
 
<meta name="generator" content="GTK-Doc V1.17.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
26
26
                  <a href="#eshell-Shell-Utilities.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry">
 
29
<div class="refentry" title="Shell Utilities">
30
30
<a name="eshell-Shell-Utilities"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="eshell-Shell-Utilities.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">
41
41
#include &lt;shell/e-shell-utils.h&gt;
42
42
 
43
43
<span class="returnvalue">void</span>                <a class="link" href="eshell-Shell-Utilities.html#e-shell-configure-ui-manager" title="e_shell_configure_ui_manager ()">e_shell_configure_ui_manager</a>        (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
44
44
                                                         <em class="parameter"><code><span class="type">EUIManager</span> *ui_manager</code></em>);
45
 
<span class="returnvalue">void</span>                <a class="link" href="eshell-Shell-Utilities.html#e-shell-configure-web-view" title="e_shell_configure_web_view ()">e_shell_configure_web_view</a>          (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
46
 
                                                         <em class="parameter"><code><a class="link" href="eshell-e-signature-utils.html#EWebView" title="struct EWebView"><span class="type">EWebView</span></a> *web_view</code></em>);
47
45
<span class="returnvalue">GFile</span> *             <a class="link" href="eshell-Shell-Utilities.html#e-shell-run-open-dialog" title="e_shell_run_open_dialog ()">e_shell_run_open_dialog</a>             (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
48
46
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
49
47
                                                         <em class="parameter"><code><span class="type">GtkCallback</span> customize_func</code></em>,
55
53
                                                         <em class="parameter"><code><span class="type">GtkCallback</span> customize_func</code></em>,
56
54
                                                         <em class="parameter"><code><span class="type">gpointer</span> customize_data</code></em>);
57
55
<span class="returnvalue">guint</span>               <a class="link" href="eshell-Shell-Utilities.html#e-shell-utils-import-uris" title="e_shell_utils_import_uris ()">e_shell_utils_import_uris</a>           (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
58
 
                                                         <em class="parameter"><code><span class="type">gchar</span> **uris</code></em>);
 
56
                                                         <em class="parameter"><code>const <span class="type">gchar</span> * const *uris</code></em>);
59
57
<span class="returnvalue">void</span>                <a class="link" href="eshell-Shell-Utilities.html#e-shell-hide-widgets-for-express-mode" title="e_shell_hide_widgets_for_express_mode ()">e_shell_hide_widgets_for_express_mode</a>
60
58
                                                        (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
61
59
                                                         <em class="parameter"><code><span class="type">GtkBuilder</span> *builder</code></em>,
63
61
                                                         <em class="parameter"><code>...</code></em>);
64
62
</pre>
65
63
</div>
66
 
<div class="refsect1">
 
64
<div class="refsect1" title="Description">
67
65
<a name="eshell-Shell-Utilities.description"></a><h2>Description</h2>
68
66
</div>
69
 
<div class="refsect1">
 
67
<div class="refsect1" title="Details">
70
68
<a name="eshell-Shell-Utilities.details"></a><h2>Details</h2>
71
 
<div class="refsect2">
 
69
<div class="refsect2" title="e_shell_configure_ui_manager ()">
72
70
<a name="e-shell-configure-ui-manager"></a><h3>e_shell_configure_ui_manager ()</h3>
73
71
<pre class="programlisting"><span class="returnvalue">void</span>                e_shell_configure_ui_manager        (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
74
72
                                                         <em class="parameter"><code><span class="type">EUIManager</span> *ui_manager</code></em>);</pre>
94
92
</table></div>
95
93
</div>
96
94
<hr>
97
 
<div class="refsect2">
98
 
<a name="e-shell-configure-web-view"></a><h3>e_shell_configure_web_view ()</h3>
99
 
<pre class="programlisting"><span class="returnvalue">void</span>                e_shell_configure_web_view          (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
100
 
                                                         <em class="parameter"><code><a class="link" href="eshell-e-signature-utils.html#EWebView" title="struct EWebView"><span class="type">EWebView</span></a> *web_view</code></em>);</pre>
101
 
<p>
102
 
Adds shell integration to <em class="parameter"><code>web_view</code></em>.  In particular, it configures
103
 
<em class="parameter"><code>web_view</code></em> to honor the printing and save-to-disk lockdown options.
104
 
</p>
105
 
<div class="variablelist"><table border="0">
106
 
<col align="left" valign="top">
107
 
<tbody>
108
 
<tr>
109
 
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
110
 
<td>an <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a>
111
 
</td>
112
 
</tr>
113
 
<tr>
114
 
<td><p><span class="term"><em class="parameter"><code>web_view</code></em> :</span></p></td>
115
 
<td>an <a class="link" href="eshell-e-signature-utils.html#EWebView" title="struct EWebView"><span class="type">EWebView</span></a>
116
 
</td>
117
 
</tr>
118
 
</tbody>
119
 
</table></div>
120
 
</div>
121
 
<hr>
122
 
<div class="refsect2">
 
95
<div class="refsect2" title="e_shell_run_open_dialog ()">
123
96
<a name="e-shell-run-open-dialog"></a><h3>e_shell_run_open_dialog ()</h3>
124
97
<pre class="programlisting"><span class="returnvalue">GFile</span> *             e_shell_run_open_dialog             (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
125
98
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
143
116
</tr>
144
117
<tr>
145
118
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
146
 
<td>file chooser dialog title</td>
 
119
<td>file chooser dialog title
 
120
</td>
147
121
</tr>
148
122
<tr>
149
123
<td><p><span class="term"><em class="parameter"><code>customize_func</code></em> :</span></p></td>
150
 
<td>optional dialog customization function</td>
 
124
<td>optional dialog customization function
 
125
</td>
151
126
</tr>
152
127
<tr>
153
128
<td><p><span class="term"><em class="parameter"><code>customize_data</code></em> :</span></p></td>
156
131
</tr>
157
132
<tr>
158
133
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
159
 
<td>the <span class="type">GFile</span> to open, or <code class="literal">NULL</code>
 
134
<td> the <span class="type">GFile</span> to open, or <code class="literal">NULL</code>
160
135
</td>
161
136
</tr>
162
137
</tbody>
163
138
</table></div>
164
139
</div>
165
140
<hr>
166
 
<div class="refsect2">
 
141
<div class="refsect2" title="e_shell_run_save_dialog ()">
167
142
<a name="e-shell-run-save-dialog"></a><h3>e_shell_run_save_dialog ()</h3>
168
143
<pre class="programlisting"><span class="returnvalue">GFile</span> *             e_shell_run_save_dialog             (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
169
144
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
195
170
</tr>
196
171
<tr>
197
172
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
198
 
<td>file chooser dialog title</td>
 
173
<td>file chooser dialog title
 
174
</td>
199
175
</tr>
200
176
<tr>
201
177
<td><p><span class="term"><em class="parameter"><code>suggestion</code></em> :</span></p></td>
209
185
</tr>
210
186
<tr>
211
187
<td><p><span class="term"><em class="parameter"><code>customize_func</code></em> :</span></p></td>
212
 
<td>optional dialog customization function</td>
 
188
<td>optional dialog customization function
 
189
</td>
213
190
</tr>
214
191
<tr>
215
192
<td><p><span class="term"><em class="parameter"><code>customize_data</code></em> :</span></p></td>
218
195
</tr>
219
196
<tr>
220
197
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
221
 
<td>the <span class="type">GFile</span> to save to, or <code class="literal">NULL</code>
 
198
<td> the <span class="type">GFile</span> to save to, or <code class="literal">NULL</code>
222
199
</td>
223
200
</tr>
224
201
</tbody>
225
202
</table></div>
226
203
</div>
227
204
<hr>
228
 
<div class="refsect2">
 
205
<div class="refsect2" title="e_shell_utils_import_uris ()">
229
206
<a name="e-shell-utils-import-uris"></a><h3>e_shell_utils_import_uris ()</h3>
230
207
<pre class="programlisting"><span class="returnvalue">guint</span>               e_shell_utils_import_uris           (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
231
 
                                                         <em class="parameter"><code><span class="type">gchar</span> **uris</code></em>);</pre>
 
208
                                                         <em class="parameter"><code>const <span class="type">gchar</span> * const *uris</code></em>);</pre>
232
209
<p>
233
210
Imports given URIs to Evolution, giving user a choice what to import
234
211
if more than one importer can be applied, and where to import it, if
243
220
<tbody>
244
221
<tr>
245
222
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
246
 
<td>The <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> instance</td>
 
223
<td>The <a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> instance
 
224
</td>
247
225
</tr>
248
226
<tr>
249
227
<td><p><span class="term"><em class="parameter"><code>uris</code></em> :</span></p></td>
250
228
<td>
251
 
<code class="literal">NULL</code>-terminated list of URIs to import</td>
 
229
<code class="literal">NULL</code>-terminated list of URIs to import
 
230
</td>
252
231
</tr>
253
232
<tr>
254
233
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
255
 
<td>the number of URIs successfully handled</td>
 
234
<td> the number of URIs successfully handled
 
235
</td>
256
236
</tr>
257
237
</tbody>
258
238
</table></div>
259
239
</div>
260
240
<hr>
261
 
<div class="refsect2">
 
241
<div class="refsect2" title="e_shell_hide_widgets_for_express_mode ()">
262
242
<a name="e-shell-hide-widgets-for-express-mode"></a><h3>e_shell_hide_widgets_for_express_mode ()</h3>
263
243
<pre class="programlisting"><span class="returnvalue">void</span>                e_shell_hide_widgets_for_express_mode
264
244
                                                        (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
294
274
</tr>
295
275
<tr>
296
276
<td><p><span class="term"><em class="parameter"><code>widget_name</code></em> :</span></p></td>
297
 
<td>NULL-terminated list of strings</td>
 
277
<td>NULL-terminated list of strings
 
278
</td>
 
279
</tr>
 
280
<tr>
 
281
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 
282
<td>
 
283
</td>
298
284
</tr>
299
285
</tbody>
300
286
</table></div>
303
289
</div>
304
290
<div class="footer">
305
291
<hr>
306
 
          Generated by GTK-Doc V1.17.1</div>
 
292
          Generated by GTK-Doc V1.15</div>
307
293
</body>
308
294
</html>
 
 
b'\\ No newline at end of file'