← Back to branch summary

~ubuntu-branches/ubuntu/feisty/libgnome/feisty

« back to all changes in this revision

Viewing changes to doc/reference/html/libgnome-gnome-url.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-01-09 10:07:49 UTC
  • mfrom: (1.1.12 upstream)
  • Revision ID: james.westby@ubuntu.com-20070109100749-uc3lve73086th31g
Tags: 2.17.2-0ubuntu1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/libgnome-gnome-url.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gnome-url</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
7
7
<link rel="start" href="index.html" title="GNOME Library Reference Manual">
8
8
<link rel="up" href="ch03.html" title="Displaying Help and External Info">
9
9
<link rel="prev" href="libgnome-gnome-help.html" title="gnome-help">
37
37
<th width="100%" align="center">GNOME Library Reference Manual</th>
38
38
<td><a accesskey="n" href="ch04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
39
39
</tr>
40
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2740589" class="shortcut">Top</a>
 
40
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2542158" class="shortcut">Top</a>
41
41
                  &#160;|&#160;
42
 
                  <a href="#id2740684" class="shortcut">Description</a></nobr></td></tr>
 
42
                  <a href="#id2542252" class="shortcut">Description</a></nobr></td></tr>
43
43
</table>
44
44
<div class="refentry" lang="en">
45
45
<a name="libgnome-gnome-url"></a><div class="titlepage"></div>
46
46
<div class="refnamediv"><table width="100%"><tr>
47
47
<td valign="top">
48
48
<h2>
49
 
<a name="id2740589"></a><span class="refentrytitle">gnome-url</span>
 
49
<a name="id2542158"></a><span class="refentrytitle">gnome-url</span>
50
50
</h2>
51
51
<p>gnome-url &#8212; Display urls using appropriate viewers.</p>
52
52
</td>
70
70
</pre>
71
71
</div>
72
72
<div class="refsect1" lang="en">
73
 
<a name="id2740684"></a><h2>Description</h2>
 
73
<a name="id2542252"></a><h2>Description</h2>
74
74
<p>
75
75
A GNOME user can configure which viewers they wish to use to view certain
76
76
protocols. Protocols can include http, ftp (where "view" might mean
80
80
</p>
81
81
</div>
82
82
<div class="refsect1" lang="en">
83
 
<a name="id2740704"></a><h2>Details</h2>
 
83
<a name="id2542272"></a><h2>Details</h2>
84
84
<div class="refsect2" lang="en">
85
 
<a name="id2740714"></a><h3>
 
85
<a name="id2542282"></a><h3>
86
86
<a name="GnomeURLError"></a>enum GnomeURLError</h3>
87
 
<a class="indexterm" name="id2740727"></a><pre class="programlisting">typedef enum {
 
87
<a class="indexterm" name="id2542295"></a><pre class="programlisting">typedef enum {
88
88
  GNOME_URL_ERROR_PARSE,
89
89
  GNOME_URL_ERROR_LAUNCH,
90
90
  GNOME_URL_ERROR_URL,
104
104
<col align="left" valign="top">
105
105
<tbody>
106
106
<tr>
107
 
<td><span class="term"><a name="GNOME-URL-ERROR-PARSE:CAPS"></a><code class="literal">GNOME_URL_ERROR_PARSE</code></span></td>
 
107
<td>
 
108
<span class="term"><a name="GNOME-URL-ERROR-PARSE:CAPS"></a><code class="literal">GNOME_URL_ERROR_PARSE</code></span></td>
108
109
<td> The parsing of the handler failed.
109
110
</td>
110
111
</tr>
111
112
<tr>
112
 
<td><span class="term"><a name="GNOME-URL-ERROR-LAUNCH:CAPS"></a><code class="literal">GNOME_URL_ERROR_LAUNCH</code></span></td>
113
 
<td>
114
 
</td>
115
 
</tr>
116
 
<tr>
117
 
<td><span class="term"><a name="GNOME-URL-ERROR-URL:CAPS"></a><code class="literal">GNOME_URL_ERROR_URL</code></span></td>
118
 
<td>
119
 
</td>
120
 
</tr>
121
 
<tr>
122
 
<td><span class="term"><a name="GNOME-URL-ERROR-NO-DEFAULT:CAPS"></a><code class="literal">GNOME_URL_ERROR_NO_DEFAULT</code></span></td>
123
 
<td>
124
 
</td>
125
 
</tr>
126
 
<tr>
127
 
<td><span class="term"><a name="GNOME-URL-ERROR-NOT-SUPPORTED:CAPS"></a><code class="literal">GNOME_URL_ERROR_NOT_SUPPORTED</code></span></td>
128
 
<td>
129
 
</td>
130
 
</tr>
131
 
<tr>
132
 
<td><span class="term"><a name="GNOME-URL-ERROR-VFS:CAPS"></a><code class="literal">GNOME_URL_ERROR_VFS</code></span></td>
133
 
<td>
134
 
</td>
135
 
</tr>
136
 
<tr>
137
 
<td><span class="term"><a name="GNOME-URL-ERROR-CANCELLED:CAPS"></a><code class="literal">GNOME_URL_ERROR_CANCELLED</code></span></td>
 
113
<td>
 
114
<span class="term"><a name="GNOME-URL-ERROR-LAUNCH:CAPS"></a><code class="literal">GNOME_URL_ERROR_LAUNCH</code></span></td>
 
115
<td>
 
116
</td>
 
117
</tr>
 
118
<tr>
 
119
<td>
 
120
<span class="term"><a name="GNOME-URL-ERROR-URL:CAPS"></a><code class="literal">GNOME_URL_ERROR_URL</code></span></td>
 
121
<td>
 
122
</td>
 
123
</tr>
 
124
<tr>
 
125
<td>
 
126
<span class="term"><a name="GNOME-URL-ERROR-NO-DEFAULT:CAPS"></a><code class="literal">GNOME_URL_ERROR_NO_DEFAULT</code></span></td>
 
127
<td>
 
128
</td>
 
129
</tr>
 
130
<tr>
 
131
<td>
 
132
<span class="term"><a name="GNOME-URL-ERROR-NOT-SUPPORTED:CAPS"></a><code class="literal">GNOME_URL_ERROR_NOT_SUPPORTED</code></span></td>
 
133
<td>
 
134
</td>
 
135
</tr>
 
136
<tr>
 
137
<td>
 
138
<span class="term"><a name="GNOME-URL-ERROR-VFS:CAPS"></a><code class="literal">GNOME_URL_ERROR_VFS</code></span></td>
 
139
<td>
 
140
</td>
 
141
</tr>
 
142
<tr>
 
143
<td>
 
144
<span class="term"><a name="GNOME-URL-ERROR-CANCELLED:CAPS"></a><code class="literal">GNOME_URL_ERROR_CANCELLED</code></span></td>
138
145
<td>
139
146
 
140
147
</td>
144
151
</div>
145
152
<hr>
146
153
<div class="refsect2" lang="en">
147
 
<a name="id2740920"></a><h3>
 
154
<a name="id2542488"></a><h3>
148
155
<a name="GNOME-URL-ERROR:CAPS"></a>GNOME_URL_ERROR</h3>
149
 
<a class="indexterm" name="id2740934"></a><pre class="programlisting">#define GNOME_URL_ERROR (gnome_url_error_quark ())
 
156
<a class="indexterm" name="id2542501"></a><pre class="programlisting">#define GNOME_URL_ERROR (gnome_url_error_quark ())
150
157
</pre>
151
158
<p>
152
159
The class (domain) of errors raised by this module.
154
161
</div>
155
162
<hr>
156
163
<div class="refsect2" lang="en">
157
 
<a name="id2740950"></a><h3>
 
164
<a name="id2542518"></a><h3>
158
165
<a name="gnome-url-show"></a>gnome_url_show ()</h3>
159
 
<a class="indexterm" name="id2740963"></a><pre class="programlisting">gboolean    gnome_url_show                  (const char *url,
 
166
<a class="indexterm" name="id2542530"></a><pre class="programlisting">gboolean    gnome_url_show                  (const char *url,
160
167
                                             GError **error);</pre>
161
168
<p>
162
169
Once the input has been converted into a fully qualified url this function
169
176
<col align="left" valign="top">
170
177
<tbody>
171
178
<tr>
172
 
<td><span class="term"><em class="parameter"><code>url</code></em>&#160;:</span></td>
 
179
<td>
 
180
<span class="term"><em class="parameter"><code>url</code></em>&#160;:</span></td>
173
181
<td> The url or path to display. The path can be relative to the current working
174
182
directory or the user's home directory. This function will convert it into a fully
175
183
qualified url using the gnome_url_get_from_input function.
176
184
</td>
177
185
</tr>
178
186
<tr>
179
 
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
187
<td>
 
188
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
180
189
<td> Used to store any errors that result from trying to display the <em class="parameter"><code>url</code></em>.
181
190
</td>
182
191
</tr>
183
192
<tr>
184
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
193
<td>
 
194
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
185
195
<td> <code class="literal">TRUE</code> if everything went fine, <code class="literal">FALSE</code> otherwise (in which case
186
196
<em class="parameter"><code>error</code></em> will contain the actual error).
187
197
</td>
191
201
</div>
192
202
<hr>
193
203
<div class="refsect2" lang="en">
194
 
<a name="id2741094"></a><h3>
 
204
<a name="id2542662"></a><h3>
195
205
<a name="gnome-url-show-with-env"></a>gnome_url_show_with_env ()</h3>
196
 
<a class="indexterm" name="id2741110"></a><pre class="programlisting">gboolean    gnome_url_show_with_env         (const char *url,
 
206
<a class="indexterm" name="id2542677"></a><pre class="programlisting">gboolean    gnome_url_show_with_env         (const char *url,
197
207
                                             char **envp,
198
208
                                             GError **error);</pre>
199
209
<p>
206
216
<col align="left" valign="top">
207
217
<tbody>
208
218
<tr>
209
 
<td><span class="term"><em class="parameter"><code>url</code></em>&#160;:</span></td>
 
219
<td>
 
220
<span class="term"><em class="parameter"><code>url</code></em>&#160;:</span></td>
210
221
<td> The url or path to display.
211
222
</td>
212
223
</tr>
213
224
<tr>
214
 
<td><span class="term"><em class="parameter"><code>envp</code></em>&#160;:</span></td>
215
 
<td> child's environment, or <a
216
 
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
217
 
><code class="literal">NULL</code></a> to inherit parent's.
 
225
<td>
 
226
<span class="term"><em class="parameter"><code>envp</code></em>&#160;:</span></td>
 
227
<td> child's environment, or <code class="literal">NULL</code> to inherit parent's.
218
228
</td>
219
229
</tr>
220
230
<tr>
221
 
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
231
<td>
 
232
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
222
233
<td> Used to store any errors that result from trying to display the <em class="parameter"><code>url</code></em>.
223
234
</td>
224
235
</tr>
225
236
<tr>
226
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
237
<td>
 
238
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
227
239
<td> <code class="literal">TRUE</code> if everything went fine, <code class="literal">FALSE</code> otherwise (in which case
228
240
<em class="parameter"><code>error</code></em> will contain the actual error).
229
241
 
231
243
</tr>
232
244
</tbody>
233
245
</table></div>
234
 
<p class="since">Since  2.2
 
246
<p>Since  2.2
235
247
</p>
236
248
</div>
237
249
</div>