← 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: Package Import Robot
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2011-09-08 09:38:57 UTC
  • mfrom: (1.1.84 upstream)
  • Revision ID: package-import@ubuntu.com-20110908093857-6lfl04ke2ns3kx2o
Tags: 3.1.91-0ubuntu1
https://launchpad.net/bugs/843769
* New upstream release. (LP: #843769)
* debian/control: bump e-d-s Build-Depends to 3.1.91. 

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.17 (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">
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">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>,
46
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
47
 
                                                         <em class="parameter"><code><span class="type">GtkCallback</span> customize_func</code></em>,
48
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> customize_data</code></em>);
49
 
<span class="returnvalue">GFile</span> *             <a class="link" href="eshell-Shell-Utilities.html#e-shell-run-save-dialog" title="e_shell_run_save_dialog ()">e_shell_run_save_dialog</a>             (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
50
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
51
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *suggestion</code></em>,
52
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *filters</code></em>,
53
 
                                                         <em class="parameter"><code><span class="type">GtkCallback</span> customize_func</code></em>,
54
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> customize_data</code></em>);
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>,
56
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> * const *uris</code></em>);
 
45
<a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> *                      <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>,
 
46
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
 
47
                                                         <em class="parameter"><code><span class="type">GtkCallback</span> customize_func</code></em>,
 
48
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> customize_data</code></em>);
 
49
<a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> *                      <a class="link" href="eshell-Shell-Utilities.html#e-shell-run-save-dialog" title="e_shell_run_save_dialog ()">e_shell_run_save_dialog</a>             (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
 
50
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
 
51
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *suggestion</code></em>,
 
52
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filters</code></em>,
 
53
                                                         <em class="parameter"><code><span class="type">GtkCallback</span> customize_func</code></em>,
 
54
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> customize_data</code></em>);
 
55
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <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>,
 
56
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const *uris</code></em>);
57
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>
58
58
                                                        (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
59
59
                                                         <em class="parameter"><code><span class="type">GtkBuilder</span> *builder</code></em>,
60
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *widget_name</code></em>,
 
60
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *widget_name</code></em>,
61
61
                                                         <em class="parameter"><code>...</code></em>);
62
62
</pre>
63
63
</div>
94
94
<hr>
95
95
<div class="refsect2">
96
96
<a name="e-shell-run-open-dialog"></a><h3>e_shell_run_open_dialog ()</h3>
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>,
98
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
 
97
<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> *                          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>,
 
98
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
99
99
                                                         <em class="parameter"><code><span class="type">GtkCallback</span> customize_func</code></em>,
100
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> customize_data</code></em>);</pre>
 
100
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> customize_data</code></em>);</pre>
101
101
<p>
102
102
Runs a <span class="type">GtkFileChooserDialog</span> in open mode with the given title and
103
 
returns the selected <span class="type">GFile</span>.  It automatically remembers the selected
 
103
returns the selected <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a>.  It automatically remembers the selected
104
104
folder.  If <em class="parameter"><code>customize_func</code></em> is provided, the function is called just
105
105
prior to running the dialog (the file chooser is the first argument,
106
106
<em class="parameter"><code>customize</code></em> data is the second).  If the user cancels the dialog the
107
 
function will return <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.
 
107
function will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
108
108
</p>
109
109
<div class="variablelist"><table border="0">
110
110
<col align="left" valign="top">
129
129
</tr>
130
130
<tr>
131
131
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
132
 
<td>the <span class="type">GFile</span> to open, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
132
<td>the <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> to open, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
133
133
</td>
134
134
</tr>
135
135
</tbody>
138
138
<hr>
139
139
<div class="refsect2">
140
140
<a name="e-shell-run-save-dialog"></a><h3>e_shell_run_save_dialog ()</h3>
141
 
<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>,
142
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
143
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *suggestion</code></em>,
144
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *filters</code></em>,
 
141
<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> *                          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>,
 
142
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
 
143
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *suggestion</code></em>,
 
144
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filters</code></em>,
145
145
                                                         <em class="parameter"><code><span class="type">GtkCallback</span> customize_func</code></em>,
146
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> customize_data</code></em>);</pre>
 
146
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> customize_data</code></em>);</pre>
147
147
<p>
148
148
Runs a <span class="type">GtkFileChooserDialog</span> in save mode with the given title and
149
 
returns the selected <span class="type">GFile</span>.  It automatically remembers the selected
 
149
returns the selected <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a>.  It automatically remembers the selected
150
150
folder.  If <em class="parameter"><code>customize_func</code></em> is provided, the function is called just
151
151
prior to running the dialog (the file chooser is the first argument,
152
152
<em class="parameter"><code>customize_data</code></em> is the second).  If the user cancels the dialog the
153
 
function will return <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.
 
153
function will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
154
154
</p>
155
155
<p>
156
 
With non-<a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>filters</code></em> will be added also file filters to the dialog.
 
156
With non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>filters</code></em> will be added also file filters to the dialog.
157
157
The string format is "pat1:mt1;pat2:mt2:...", where 'pat' is a pattern
158
158
and 'mt' is a MIME type for the pattern to be used.
159
159
There can be more than one MIME type, those are separated by comma.
172
172
</tr>
173
173
<tr>
174
174
<td><p><span class="term"><em class="parameter"><code>suggestion</code></em> :</span></p></td>
175
 
<td>file name suggestion, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
175
<td>file name suggestion, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
176
176
</td>
177
177
</tr>
178
178
<tr>
179
179
<td><p><span class="term"><em class="parameter"><code>filters</code></em> :</span></p></td>
180
 
<td>Possible filters for dialog, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
180
<td>Possible filters for dialog, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
181
181
</td>
182
182
</tr>
183
183
<tr>
191
191
</tr>
192
192
<tr>
193
193
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
194
 
<td>the <span class="type">GFile</span> to save to, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
194
<td>the <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> to save to, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
195
195
</td>
196
196
</tr>
197
197
</tbody>
200
200
<hr>
201
201
<div class="refsect2">
202
202
<a name="e-shell-utils-import-uris"></a><h3>e_shell_utils_import_uris ()</h3>
203
 
<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>,
204
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> * const *uris</code></em>);</pre>
 
203
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               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>,
 
204
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const *uris</code></em>);</pre>
205
205
<p>
206
206
Imports given URIs to Evolution, giving user a choice what to import
207
207
if more than one importer can be applied, and where to import it, if
221
221
<tr>
222
222
<td><p><span class="term"><em class="parameter"><code>uris</code></em> :</span></p></td>
223
223
<td>
224
 
<a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>-terminated list of URIs to import</td>
 
224
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of URIs to import</td>
225
225
</tr>
226
226
<tr>
227
227
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
236
236
<pre class="programlisting"><span class="returnvalue">void</span>                e_shell_hide_widgets_for_express_mode
237
237
                                                        (<em class="parameter"><code><a class="link" href="EShell.html" title="EShell"><span class="type">EShell</span></a> *shell</code></em>,
238
238
                                                         <em class="parameter"><code><span class="type">GtkBuilder</span> *builder</code></em>,
239
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *widget_name</code></em>,
 
239
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *widget_name</code></em>,
240
240
                                                         <em class="parameter"><code>...</code></em>);</pre>
241
241
<p>
242
242
If Evolution is running in Express mode (i.e. if the specified <em class="parameter"><code>shell</code></em> is
276
276
</div>
277
277
<div class="footer">
278
278
<hr>
279
 
          Generated by GTK-Doc V1.17.1</div>
 
279
          Generated by GTK-Doc V1.17</div>
280
280
</body>
281
281
</html>
 
 
b'\\ No newline at end of file'