← 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): Sebastien Bacher
  • Date: 2006-11-15 15:52:31 UTC
  • mfrom: (1.1.10 upstream)
  • Revision ID: james.westby@ubuntu.com-20061115155231-gbp2xt8ns20vf1vh
Tags: 2.17.0-0ubuntu1
* New upstream version:
  - Enable a11y by default in devel releases 
  - Don't check for null before calling g_free/g_strdup
  - Improve strings in error messages and other places
  - GThread initialization fix 
* debian/patches/08_dont_force_a11y_activation.patch:
  - don't force a11y activation
* debian/patches/09_run_app_message_fix.patch:
  - fixed with the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/libgnome-gnome-url.html
5
5
<title>gnome-url</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
7
7
<link rel="start" href="index.html" title="GNOME Library Reference Manual">
8
 
<link rel="up" href="ch01s03.html" title="Displaying help and external info">
 
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">
10
 
<link rel="next" href="libgnome-gnome-score.html" title="gnome-score">
 
10
<link rel="next" href="ch04.html" title="Miscellaneous">
11
11
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="chapter" href="libgnome.html" title="GNOME Library (libgnome)">
 
13
<link rel="part" href="libgnome.html" title="Part&#160;I.&#160;GNOME Library (libgnome)">
 
14
<link rel="chapter" href="ch01.html" title="Initializing Applications and Starting Programs">
 
15
<link rel="chapter" href="ch02.html" title="Configuration">
 
16
<link rel="chapter" href="ch03.html" title="Displaying Help and External Info">
 
17
<link rel="chapter" href="ch04.html" title="Miscellaneous">
 
18
<link rel="chapter" href="ch05.html" title="Lower Level Interactions">
 
19
<link rel="chapter" href="ch06.html" title="Deprecated Modules">
 
20
<link rel="index" href="ix01.html" title="Index">
 
21
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
 
22
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
 
23
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
 
24
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
 
25
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
 
26
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
 
27
<link rel="index" href="ix08.html" title="Index of new symbols in 2.12">
 
28
<link rel="index" href="ix09.html" title="Index of new symbols in 2.14">
 
29
<link rel="index" href="ix10.html" title="Index of new symbols in 2.16">
14
30
</head>
15
31
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16
32
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
33
<tr valign="middle">
18
34
<td><a accesskey="p" href="libgnome-gnome-help.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
19
 
<td><a accesskey="u" href="ch01s03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
35
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
20
36
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
21
37
<th width="100%" align="center">GNOME Library Reference Manual</th>
22
 
<td><a accesskey="n" href="libgnome-gnome-score.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
38
<td><a accesskey="n" href="ch04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
39
</tr>
24
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2819442" class="shortcut">Top</a>
 
40
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2988722" class="shortcut">Top</a>
25
41
                  &#160;|&#160;
26
 
                  <a href="#id2819537" class="shortcut">Description</a></nobr></td></tr>
 
42
                  <a href="#id2988818" class="shortcut">Description</a></nobr></td></tr>
27
43
</table>
28
44
<div class="refentry" lang="en">
29
45
<a name="libgnome-gnome-url"></a><div class="titlepage"></div>
30
46
<div class="refnamediv"><table width="100%"><tr>
31
47
<td valign="top">
32
48
<h2>
33
 
<a name="id2819442"></a><span class="refentrytitle">gnome-url</span>
 
49
<a name="id2988722"></a><span class="refentrytitle">gnome-url</span>
34
50
</h2>
35
51
<p>gnome-url &#8212; Display urls using appropriate viewers.</p>
36
52
</td>
46
62
enum        <a href="libgnome-gnome-url.html#GnomeURLError">GnomeURLError</a>;
47
63
#define     <a href="libgnome-gnome-url.html#GNOME-URL-ERROR:CAPS">GNOME_URL_ERROR</a>
48
64
<a
49
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
65
href="../glib/glib-Basic-Types.html#gboolean"
50
66
>gboolean</a>    <a href="libgnome-gnome-url.html#gnome-url-show">gnome_url_show</a>                  (const char *url,
51
67
                                             <a
52
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
68
href="../glib/glib-Error-Reporting.html#GError"
53
69
>GError</a> **error);
54
70
<a
55
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
71
href="../glib/glib-Basic-Types.html#gboolean"
56
72
>gboolean</a>    <a href="libgnome-gnome-url.html#gnome-url-show-with-env">gnome_url_show_with_env</a>         (const char *url,
57
73
                                             char **envp,
58
74
                                             <a
59
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
75
href="../glib/glib-Error-Reporting.html#GError"
60
76
>GError</a> **error);
61
77
 
62
78
</pre>
63
79
</div>
64
80
<div class="refsect1" lang="en">
65
 
<a name="id2819537"></a><h2>Description</h2>
 
81
<a name="id2988818"></a><h2>Description</h2>
66
82
<p>
67
83
A GNOME user can configure which viewers they wish to use to view certain
68
84
protocols. Protocols can include http, ftp (where "view" might mean
72
88
</p>
73
89
</div>
74
90
<div class="refsect1" lang="en">
75
 
<a name="id2819557"></a><h2>Details</h2>
 
91
<a name="id2988837"></a><h2>Details</h2>
76
92
<div class="refsect2" lang="en">
77
 
<a name="id2819567"></a><h3>
 
93
<a name="id2988848"></a><h3>
78
94
<a name="GnomeURLError"></a>enum GnomeURLError</h3>
79
 
<a class="indexterm" name="id2819580"></a><pre class="programlisting">typedef enum {
 
95
<a class="indexterm" name="id2988860"></a><pre class="programlisting">typedef enum {
80
96
  GNOME_URL_ERROR_PARSE,
81
97
  GNOME_URL_ERROR_LAUNCH,
82
98
  GNOME_URL_ERROR_URL,
96
112
<col align="left" valign="top">
97
113
<tbody>
98
114
<tr>
99
 
<td>
100
 
<span class="term"><a name="GNOME-URL-ERROR-PARSE:CAPS"></a><code class="literal">GNOME_URL_ERROR_PARSE</code></span></td>
 
115
<td><span class="term"><a name="GNOME-URL-ERROR-PARSE:CAPS"></a><code class="literal">GNOME_URL_ERROR_PARSE</code></span></td>
101
116
<td> The parsing of the handler failed.
102
117
</td>
103
118
</tr>
104
119
<tr>
105
 
<td>
106
 
<span class="term"><a name="GNOME-URL-ERROR-LAUNCH:CAPS"></a><code class="literal">GNOME_URL_ERROR_LAUNCH</code></span></td>
107
 
<td>
108
 
</td>
109
 
</tr>
110
 
<tr>
111
 
<td>
112
 
<span class="term"><a name="GNOME-URL-ERROR-URL:CAPS"></a><code class="literal">GNOME_URL_ERROR_URL</code></span></td>
113
 
<td>
114
 
</td>
115
 
</tr>
116
 
<tr>
117
 
<td>
118
 
<span class="term"><a name="GNOME-URL-ERROR-NO-DEFAULT:CAPS"></a><code class="literal">GNOME_URL_ERROR_NO_DEFAULT</code></span></td>
119
 
<td>
120
 
</td>
121
 
</tr>
122
 
<tr>
123
 
<td>
124
 
<span class="term"><a name="GNOME-URL-ERROR-NOT-SUPPORTED:CAPS"></a><code class="literal">GNOME_URL_ERROR_NOT_SUPPORTED</code></span></td>
125
 
<td>
126
 
</td>
127
 
</tr>
128
 
<tr>
129
 
<td>
130
 
<span class="term"><a name="GNOME-URL-ERROR-VFS:CAPS"></a><code class="literal">GNOME_URL_ERROR_VFS</code></span></td>
131
 
<td>
132
 
</td>
133
 
</tr>
134
 
<tr>
135
 
<td>
136
 
<span class="term"><a name="GNOME-URL-ERROR-CANCELLED:CAPS"></a><code class="literal">GNOME_URL_ERROR_CANCELLED</code></span></td>
 
120
<td><span class="term"><a name="GNOME-URL-ERROR-LAUNCH:CAPS"></a><code class="literal">GNOME_URL_ERROR_LAUNCH</code></span></td>
 
121
<td>
 
122
</td>
 
123
</tr>
 
124
<tr>
 
125
<td><span class="term"><a name="GNOME-URL-ERROR-URL:CAPS"></a><code class="literal">GNOME_URL_ERROR_URL</code></span></td>
 
126
<td>
 
127
</td>
 
128
</tr>
 
129
<tr>
 
130
<td><span class="term"><a name="GNOME-URL-ERROR-NO-DEFAULT:CAPS"></a><code class="literal">GNOME_URL_ERROR_NO_DEFAULT</code></span></td>
 
131
<td>
 
132
</td>
 
133
</tr>
 
134
<tr>
 
135
<td><span class="term"><a name="GNOME-URL-ERROR-NOT-SUPPORTED:CAPS"></a><code class="literal">GNOME_URL_ERROR_NOT_SUPPORTED</code></span></td>
 
136
<td>
 
137
</td>
 
138
</tr>
 
139
<tr>
 
140
<td><span class="term"><a name="GNOME-URL-ERROR-VFS:CAPS"></a><code class="literal">GNOME_URL_ERROR_VFS</code></span></td>
 
141
<td>
 
142
</td>
 
143
</tr>
 
144
<tr>
 
145
<td><span class="term"><a name="GNOME-URL-ERROR-CANCELLED:CAPS"></a><code class="literal">GNOME_URL_ERROR_CANCELLED</code></span></td>
137
146
<td>
138
147
 
139
148
</td>
143
152
</div>
144
153
<hr>
145
154
<div class="refsect2" lang="en">
146
 
<a name="id2819774"></a><h3>
 
155
<a name="id2989054"></a><h3>
147
156
<a name="GNOME-URL-ERROR:CAPS"></a>GNOME_URL_ERROR</h3>
148
 
<a class="indexterm" name="id2819788"></a><pre class="programlisting">#define GNOME_URL_ERROR (gnome_url_error_quark ())
 
157
<a class="indexterm" name="id2989067"></a><pre class="programlisting">#define GNOME_URL_ERROR (gnome_url_error_quark ())
149
158
</pre>
150
159
<p>
151
160
The class (domain) of errors raised by this module.
153
162
</div>
154
163
<hr>
155
164
<div class="refsect2" lang="en">
156
 
<a name="id2819804"></a><h3>
 
165
<a name="id2989083"></a><h3>
157
166
<a name="gnome-url-show"></a>gnome_url_show ()</h3>
158
 
<a class="indexterm" name="id2819817"></a><pre class="programlisting"><a
159
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
167
<a class="indexterm" name="id2989096"></a><pre class="programlisting"><a
 
168
href="../glib/glib-Basic-Types.html#gboolean"
160
169
>gboolean</a>    gnome_url_show                  (const char *url,
161
170
                                             <a
162
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
171
href="../glib/glib-Error-Reporting.html#GError"
163
172
>GError</a> **error);</pre>
164
173
<p>
165
174
Once the input has been converted into a fully qualified url this function
172
181
<col align="left" valign="top">
173
182
<tbody>
174
183
<tr>
175
 
<td>
176
 
<span class="term"><em class="parameter"><code>url</code></em>&#160;:</span></td>
 
184
<td><span class="term"><em class="parameter"><code>url</code></em>&#160;:</span></td>
177
185
<td> The url or path to display. The path can be relative to the current working
178
186
directory or the user's home directory. This function will convert it into a fully
179
187
qualified url using the gnome_url_get_from_input function.
180
188
</td>
181
189
</tr>
182
190
<tr>
183
 
<td>
184
 
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
191
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
185
192
<td> Used to store any errors that result from trying to display the <em class="parameter"><code>url</code></em>.
186
193
</td>
187
194
</tr>
188
195
<tr>
189
 
<td>
190
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
196
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
191
197
<td> <a
192
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
198
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
193
199
><code class="literal">TRUE</code></a> if everything went fine, <a
194
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
200
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
195
201
><code class="literal">FALSE</code></a> otherwise (in which case
196
202
<em class="parameter"><code>error</code></em> will contain the actual error).
197
203
</td>
201
207
</div>
202
208
<hr>
203
209
<div class="refsect2" lang="en">
204
 
<a name="id2819948"></a><h3>
 
210
<a name="id2989228"></a><h3>
205
211
<a name="gnome-url-show-with-env"></a>gnome_url_show_with_env ()</h3>
206
 
<a class="indexterm" name="id2819964"></a><pre class="programlisting"><a
207
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
212
<a class="indexterm" name="id2989243"></a><pre class="programlisting"><a
 
213
href="../glib/glib-Basic-Types.html#gboolean"
208
214
>gboolean</a>    gnome_url_show_with_env         (const char *url,
209
215
                                             char **envp,
210
216
                                             <a
211
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
217
href="../glib/glib-Error-Reporting.html#GError"
212
218
>GError</a> **error);</pre>
213
219
<p>
214
220
Like <a href="libgnome-gnome-url.html#gnome-url-show"><code class="function">gnome_url_show()</code></a>, but gnome_vfs_url_show_with_env
220
226
<col align="left" valign="top">
221
227
<tbody>
222
228
<tr>
223
 
<td>
224
 
<span class="term"><em class="parameter"><code>url</code></em>&#160;:</span></td>
 
229
<td><span class="term"><em class="parameter"><code>url</code></em>&#160;:</span></td>
225
230
<td> The url or path to display.
226
231
</td>
227
232
</tr>
228
233
<tr>
229
 
<td>
230
 
<span class="term"><em class="parameter"><code>envp</code></em>&#160;:</span></td>
 
234
<td><span class="term"><em class="parameter"><code>envp</code></em>&#160;:</span></td>
231
235
<td> child's environment, or <a
232
 
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
 
236
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
233
237
><code class="literal">NULL</code></a> to inherit parent's.
234
238
</td>
235
239
</tr>
236
240
<tr>
237
 
<td>
238
 
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
241
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
239
242
<td> Used to store any errors that result from trying to display the <em class="parameter"><code>url</code></em>.
240
243
</td>
241
244
</tr>
242
245
<tr>
243
 
<td>
244
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
246
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
245
247
<td> <a
246
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
248
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
247
249
><code class="literal">TRUE</code></a> if everything went fine, <a
248
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
250
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
249
251
><code class="literal">FALSE</code></a> otherwise (in which case
250
252
<em class="parameter"><code>error</code></em> will contain the actual error).
251
253