~ubuntu-branches/ubuntu/trusty/libgnome/trusty-proposed
» Revision
55
: doc/reference/html/libgnome-gnome-help.html
« back to all changes in this revision
Viewing changes to doc/reference/html/libgnome-gnome-help.html
- browse files at revision 55
- compare with another revision
- download diff
- download tarball
- view history from revision 55
- Committer: Bazaar Package Importer
- Author(s): Sebastien Bacher
- Date: 2009-03-06 17:27:16 UTC
- mfrom: (1.1.29 upstream)
- Revision ID: james.westby@ubuntu.com-20090306172716-lnh6jr51eoy0x2qo
Tags: 2.25.1-0ubuntu1
* New upstream version
* debian/control.in:
- set vcs location
* debian/watch:
- track unstable series
* debian/control.in:
- set vcs location
* debian/watch:
- track unstable series
- files added:
- doc/reference/xml/api-index-2.14.xml
- files modified:
- ChangeLog
added
removed
doc/reference/html/libgnome-gnome-help.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>gnome-help</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.2">
7
7
<link rel="home" 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="ch03.html" title="Displaying Help and External Info">
10
10
<link rel="next" href="libgnome-gnome-url.html" title="gnome-url">
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgnome.html" title="Part I. GNOME Library (libgnome)">
14
14
<link rel="chapter" href="ch01.html" title="Initializing Applications and Starting Programs">
37
37
<th width="100%" align="center">GNOME Library Reference Manual</th>
38
38
<td><a accesskey="n" href="libgnome-gnome-url.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="#libgnome-gnome-help.synopsis" class="shortcut">Top</a>
41
|
42
<a href="#libgnome-gnome-help.description" class="shortcut">Description</a></nobr></td></tr>
40
<tr><td colspan="5" class="shortcuts">
41
<a href="#libgnome-gnome-help.synopsis" class="shortcut">Top</a>
42
|
43
<a href="#libgnome-gnome-help.description" class="shortcut">Description</a>
44
</td></tr>
43
45
</table>
44
46
<div class="refentry" lang="en">
45
47
<a name="libgnome-gnome-help"></a><div class="titlepage"></div>
57
59
#include <libgnome/libgnome.h>
58
60
59
61
enum <a class="link" href="libgnome-gnome-help.html#GnomeHelpError" title="enum GnomeHelpError">GnomeHelpError</a>;
60
#define <a class="link" href="libgnome-gnome-help.html#GNOME-HELP-ERROR:CAPS" title="GNOME_HELP_ERROR">GNOME_HELP_ERROR</a>
62
#define <a class="link" href="libgnome-gnome-help.html#GNOME-HELP-ERROR--CAPS" title="GNOME_HELP_ERROR">GNOME_HELP_ERROR</a>
61
63
<a
62
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
64
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
63
65
>gboolean</a> <a class="link" href="libgnome-gnome-help.html#gnome-help-display" title="gnome_help_display ()">gnome_help_display</a> (const char *file_name,
64
66
const char *link_id,
65
67
<a
66
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
68
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
67
69
>GError</a> **error);
68
70
<a
69
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
71
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
70
72
>gboolean</a> <a class="link" href="libgnome-gnome-help.html#gnome-help-display-with-doc-id" title="gnome_help_display_with_doc_id ()">gnome_help_display_with_doc_id</a> (<a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="GnomeProgram">GnomeProgram</a> *program,
71
73
const char *doc_id,
72
74
const char *file_name,
73
75
const char *link_id,
74
76
<a
75
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
77
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
76
78
>GError</a> **error);
77
79
<a
78
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
80
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
79
81
>gboolean</a> <a class="link" href="libgnome-gnome-help.html#gnome-help-display-with-doc-id-and-env" title="gnome_help_display_with_doc_id_and_env ()">gnome_help_display_with_doc_id_and_env</a>
80
82
(<a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="GnomeProgram">GnomeProgram</a> *program,
81
83
const char *doc_id,
83
85
const char *link_id,
84
86
char **envp,
85
87
<a
86
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
88
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
87
89
>GError</a> **error);
88
90
<a
89
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
91
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
90
92
>gboolean</a> <a class="link" href="libgnome-gnome-help.html#gnome-help-display-desktop" title="gnome_help_display_desktop ()">gnome_help_display_desktop</a> (<a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="GnomeProgram">GnomeProgram</a> *program,
91
93
const char *doc_id,
92
94
const char *file_name,
93
95
const char *link_id,
94
96
<a
95
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
97
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
96
98
>GError</a> **error);
97
99
<a
98
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
100
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
99
101
>gboolean</a> <a class="link" href="libgnome-gnome-help.html#gnome-help-display-desktop-with-env" title="gnome_help_display_desktop_with_env ()">gnome_help_display_desktop_with_env</a> (<a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="GnomeProgram">GnomeProgram</a> *program,
100
102
const char *doc_id,
101
103
const char *file_name,
102
104
const char *link_id,
103
105
char **envp,
104
106
<a
105
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
107
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
106
108
>GError</a> **error);
107
109
<a
108
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
110
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
109
111
>gboolean</a> <a class="link" href="libgnome-gnome-help.html#gnome-help-display-uri" title="gnome_help_display_uri ()">gnome_help_display_uri</a> (const char *help_uri,
110
112
<a
111
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
113
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
112
114
>GError</a> **error);
113
115
<a
114
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
116
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
115
117
>gboolean</a> <a class="link" href="libgnome-gnome-help.html#gnome-help-display-uri-with-env" title="gnome_help_display_uri_with_env ()">gnome_help_display_uri_with_env</a> (const char *help_uri,
116
118
char **envp,
117
119
<a
118
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
120
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
119
121
>GError</a> **error);
120
122
</pre>
121
123
</div>
137
139
} GnomeHelpError;
138
140
</pre>
139
141
<p>
140
The different error codes which can be thrown in the <a class="link" href="libgnome-gnome-help.html#GNOME-HELP-ERROR:CAPS" title="GNOME_HELP_ERROR"><span class="type">GNOME_HELP_ERROR</span></a> domain.
142
The different error codes which can be thrown in the <a class="link" href="libgnome-gnome-help.html#GNOME-HELP-ERROR--CAPS" title="GNOME_HELP_ERROR"><span class="type">GNOME_HELP_ERROR</span></a> domain.
141
143
</p>
142
144
<div class="variablelist"><table border="0">
143
145
<col align="left" valign="top">
144
146
<tbody>
145
147
<tr>
146
<td><p><a name="GNOME-HELP-ERROR-INTERNAL:CAPS"></a><span class="term"><code class="literal">GNOME_HELP_ERROR_INTERNAL</code></span></p></td>
148
<td><p><a name="GNOME-HELP-ERROR-INTERNAL--CAPS"></a><span class="term"><code class="literal">GNOME_HELP_ERROR_INTERNAL</code></span></p></td>
147
149
<td>Something went wrong internally. This is most
148
150
likely caused by a resource problem or bad installation.
149
151
</td>
150
152
</tr>
151
153
<tr>
152
<td><p><a name="GNOME-HELP-ERROR-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">GNOME_HELP_ERROR_NOT_FOUND</code></span></p></td>
154
<td><p><a name="GNOME-HELP-ERROR-NOT-FOUND--CAPS"></a><span class="term"><code class="literal">GNOME_HELP_ERROR_NOT_FOUND</code></span></p></td>
153
155
<td>Help file does not exist.
154
155
156
</td>
156
157
</tr>
157
158
</tbody>
159
160
</div>
160
161
<hr>
161
162
<div class="refsect2" lang="en">
162
<a name="GNOME-HELP-ERROR:CAPS"></a><h3>GNOME_HELP_ERROR</h3>
163
<a name="GNOME-HELP-ERROR--CAPS"></a><h3>GNOME_HELP_ERROR</h3>
163
164
<pre class="programlisting">#define GNOME_HELP_ERROR (gnome_help_error_quark ())
164
165
</pre>
165
166
<p>
166
167
The class (or domain) of errors raised directly by the gnome-help module. This
167
168
is used as a value in the domain field of the <a
168
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
169
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
169
170
><span class="type">GError</span></a> structure.
170
171
</p>
171
172
</div>
173
174
<div class="refsect2" lang="en">
174
175
<a name="gnome-help-display"></a><h3>gnome_help_display ()</h3>
175
176
<pre class="programlisting"><a
176
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
177
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
177
178
>gboolean</a> gnome_help_display (const char *file_name,
178
179
const char *link_id,
179
180
<a
180
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
181
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
181
182
>GError</a> **error);</pre>
182
183
<p>
183
184
Displays the help file specified by <em class="parameter"><code>file_name</code></em> at location <em class="parameter"><code>link_id</code></em> in the
184
185
preferred help browser of the user.</p>
185
186
<p>
186
187
187
</p>
188
188
<div class="variablelist"><table border="0">
189
189
<col align="left" valign="top">
196
196
<tr>
197
197
<td><p><span class="term"><em class="parameter"><code>link_id</code></em> :</span></p></td>
198
198
<td> Can be <a
199
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
199
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
200
200
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
201
201
requested document.
202
202
</td>
204
204
<tr>
205
205
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
206
206
<td> A <a
207
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
207
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
208
208
><span class="type">GError</span></a> instance that will hold the specifics of any error which
209
209
occurs during processing, or <a
210
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
210
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
211
211
><code class="literal">NULL</code></a>
212
212
</td>
213
213
</tr>
214
214
<tr>
215
215
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
216
216
<td> <a
217
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
217
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
218
218
><code class="literal">TRUE</code></a> on success, <a
219
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
219
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
220
220
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
221
221
contain the actual error).
222
222
</td>
228
228
<div class="refsect2" lang="en">
229
229
<a name="gnome-help-display-with-doc-id"></a><h3>gnome_help_display_with_doc_id ()</h3>
230
230
<pre class="programlisting"><a
231
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
231
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
232
232
>gboolean</a> gnome_help_display_with_doc_id (<a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="GnomeProgram">GnomeProgram</a> *program,
233
233
const char *doc_id,
234
234
const char *file_name,
235
235
const char *link_id,
236
236
<a
237
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
237
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
238
238
>GError</a> **error);</pre>
239
239
<p>
240
240
Displays the help file specified by <em class="parameter"><code>file_name</code></em> at location <em class="parameter"><code>link_id</code></em> within
244
244
<p>
245
245
This function will display the help through creating a "ghelp" URI, by
246
246
looking for <em class="parameter"><code>file_name</code></em> in the applications installed help location (found by
247
<a class="link" href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-APP-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_APP_HELP</span></a>) and its app_id. The resulting URI is roughly
247
<a class="link" href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-APP-HELP--CAPS"><span class="type">GNOME_FILE_DOMAIN_APP_HELP</span></a>) and its app_id. The resulting URI is roughly
248
248
in the form "ghelp:appid/file_name?link_id". If a matching file cannot be
249
249
found, <a
250
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
250
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
251
251
><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em> is set.
252
252
</p>
253
253
<p>
255
255
from the global GNOME domain, you will want to use
256
256
<a class="link" href="libgnome-gnome-help.html#gnome-help-display-desktop" title="gnome_help_display_desktop ()"><code class="function">gnome_help_display_desktop()</code></a>.</p>
257
257
<p>
258
259
258
</p>
260
259
<div class="variablelist"><table border="0">
261
260
<col align="left" valign="top">
263
262
<tr>
264
263
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
265
264
<td> The current application object, or <a
266
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
265
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
267
266
><code class="literal">NULL</code></a> for the default one.
268
267
</td>
269
268
</tr>
270
269
<tr>
271
270
<td><p><span class="term"><em class="parameter"><code>doc_id</code></em> :</span></p></td>
272
271
<td> The document identifier, or <a
273
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
272
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
274
273
><code class="literal">NULL</code></a> to default to the application ID
275
274
(app_id) of the specified <em class="parameter"><code>program</code></em>.
276
275
</td>
283
282
<tr>
284
283
<td><p><span class="term"><em class="parameter"><code>link_id</code></em> :</span></p></td>
285
284
<td> Can be <a
286
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
285
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
287
286
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
288
287
requested document.
289
288
</td>
291
290
<tr>
292
291
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
293
292
<td> A <a
294
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
293
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
295
294
><span class="type">GError</span></a> instance that will hold the specifics of any error which
296
295
occurs during processing, or <a
297
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
296
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
298
297
><code class="literal">NULL</code></a>
299
298
</td>
300
299
</tr>
301
300
<tr>
302
301
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
303
302
<td> <a
304
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
303
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
305
304
><code class="literal">TRUE</code></a> on success, <a
306
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
305
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
307
306
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
308
307
contain the actual error).
309
308
</td>
315
314
<div class="refsect2" lang="en">
316
315
<a name="gnome-help-display-with-doc-id-and-env"></a><h3>gnome_help_display_with_doc_id_and_env ()</h3>
317
316
<pre class="programlisting"><a
318
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
317
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
319
318
>gboolean</a> gnome_help_display_with_doc_id_and_env
320
319
(<a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="GnomeProgram">GnomeProgram</a> *program,
321
320
const char *doc_id,
323
322
const char *link_id,
324
323
char **envp,
325
324
<a
326
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
325
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
327
326
>GError</a> **error);</pre>
328
327
<p>
329
328
Like <code class="function">gnome_display_with_doc_id()</code>, but the the contents of <em class="parameter"><code>envp</code></em>
330
329
will become the url viewer's environment rather than inheriting
331
330
from the parents environment.</p>
332
331
<p>
333
334
332
</p>
335
333
<div class="variablelist"><table border="0">
336
334
<col align="left" valign="top">
338
336
<tr>
339
337
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
340
338
<td> The current application object, or <a
341
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
339
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
342
340
><code class="literal">NULL</code></a> for the default one.
343
341
</td>
344
342
</tr>
345
343
<tr>
346
344
<td><p><span class="term"><em class="parameter"><code>doc_id</code></em> :</span></p></td>
347
345
<td> The document identifier, or <a
348
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
346
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
349
347
><code class="literal">NULL</code></a> to default to empty string.
350
348
(app_id) of the specified <em class="parameter"><code>program</code></em>.
351
349
</td>
358
356
<tr>
359
357
<td><p><span class="term"><em class="parameter"><code>link_id</code></em> :</span></p></td>
360
358
<td> Can be <a
361
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
359
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
362
360
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
363
361
requested document.
364
362
</td>
366
364
<tr>
367
365
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
368
366
<td> child's environment, or <a
369
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
367
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
370
368
><code class="literal">NULL</code></a> to inherit parent's.
371
369
</td>
372
370
</tr>
373
371
<tr>
374
372
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
375
373
<td> A <a
376
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
374
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
377
375
><span class="type">GError</span></a> instance that will hold the specifics of any error which
378
376
occurs during processing, or <a
379
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
377
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
380
378
><code class="literal">NULL</code></a>
381
379
</td>
382
380
</tr>
383
381
<tr>
384
382
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
385
383
<td> <a
386
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
384
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
387
385
><code class="literal">TRUE</code></a> on success, <a
388
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
386
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
389
387
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
390
388
contain the actual error).
391
389
393
391
</tr>
394
392
</tbody>
395
393
</table></div>
396
<p class="since">Since 2.2
397
</p>
394
<p class="since">Since 2.2</p>
398
395
</div>
399
396
<hr>
400
397
<div class="refsect2" lang="en">
401
398
<a name="gnome-help-display-desktop"></a><h3>gnome_help_display_desktop ()</h3>
402
399
<pre class="programlisting"><a
403
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
400
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
404
401
>gboolean</a> gnome_help_display_desktop (<a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="GnomeProgram">GnomeProgram</a> *program,
405
402
const char *doc_id,
406
403
const char *file_name,
407
404
const char *link_id,
408
405
<a
409
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
406
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
410
407
>GError</a> **error);</pre>
411
408
<p>
412
409
Displays the GNOME system help file specified by <em class="parameter"><code>file_name</code></em> at location
413
410
<em class="parameter"><code>link_id</code></em> in the preferred help browser of the user. This is done by creating
414
411
a "ghelp" URI, by looking for <em class="parameter"><code>file_name</code></em> in the system help domain
415
(<a class="link" href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>) and it's app_id. This domain is determined when
412
(<a class="link" href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP--CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>) and it's app_id. This domain is determined when
416
413
the library is compiled. If a matching file cannot be found, <a
417
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
414
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
418
415
><code class="literal">FALSE</code></a> is
419
416
returned and <em class="parameter"><code>error</code></em> is set.
420
417
</p>
422
419
Please note that this only displays system help. To display help files
423
420
for an application, you will want to use <a class="link" href="libgnome-gnome-help.html#gnome-help-display" title="gnome_help_display ()"><code class="function">gnome_help_display()</code></a>.</p>
424
421
<p>
425
426
422
</p>
427
423
<div class="variablelist"><table border="0">
428
424
<col align="left" valign="top">
430
426
<tr>
431
427
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
432
428
<td> The current application object, or <a
433
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
429
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
434
430
><code class="literal">NULL</code></a> for the default one.
435
431
</td>
436
432
</tr>
437
433
<tr>
438
434
<td><p><span class="term"><em class="parameter"><code>doc_id</code></em> :</span></p></td>
439
435
<td> The name of the help file relative to the system's help domain
440
(<a class="link" href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>).
436
(<a class="link" href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP--CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>).
441
437
</td>
442
438
</tr>
443
439
<tr>
448
444
<tr>
449
445
<td><p><span class="term"><em class="parameter"><code>link_id</code></em> :</span></p></td>
450
446
<td> Can be <a
451
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
447
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
452
448
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
453
449
requested document.
454
450
</td>
456
452
<tr>
457
453
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
458
454
<td> A <a
459
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
455
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
460
456
><span class="type">GError</span></a> instance that will hold the specifics of any error which
461
457
occurs during processing, or <a
462
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
458
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
463
459
><code class="literal">NULL</code></a>
464
460
</td>
465
461
</tr>
466
462
<tr>
467
463
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
468
464
<td> <a
469
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
465
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
470
466
><code class="literal">TRUE</code></a> on success, <a
471
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
467
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
472
468
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
473
469
contain the actual error).
474
470
</td>
480
476
<div class="refsect2" lang="en">
481
477
<a name="gnome-help-display-desktop-with-env"></a><h3>gnome_help_display_desktop_with_env ()</h3>
482
478
<pre class="programlisting"><a
483
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
479
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
484
480
>gboolean</a> gnome_help_display_desktop_with_env (<a class="link" href="libgnome-gnome-program.html#GnomeProgram" title="GnomeProgram">GnomeProgram</a> *program,
485
481
const char *doc_id,
486
482
const char *file_name,
487
483
const char *link_id,
488
484
char **envp,
489
485
<a
490
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
486
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
491
487
>GError</a> **error);</pre>
492
488
<p>
493
489
Like <a class="link" href="libgnome-gnome-help.html#gnome-help-display-desktop" title="gnome_help_display_desktop ()"><code class="function">gnome_help_display_desktop()</code></a>, but the the contents of <em class="parameter"><code>envp</code></em>
494
490
will become the url viewer's environment rather than inheriting
495
491
from the parents environment.</p>
496
492
<p>
497
498
493
</p>
499
494
<div class="variablelist"><table border="0">
500
495
<col align="left" valign="top">
502
497
<tr>
503
498
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
504
499
<td> The current application object, or <a
505
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
500
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
506
501
><code class="literal">NULL</code></a> for the default one.
507
502
</td>
508
503
</tr>
509
504
<tr>
510
505
<td><p><span class="term"><em class="parameter"><code>doc_id</code></em> :</span></p></td>
511
506
<td> The name of the help file relative to the system's help domain
512
(<a class="link" href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>).
507
(<a class="link" href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP--CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>).
513
508
</td>
514
509
</tr>
515
510
<tr>
520
515
<tr>
521
516
<td><p><span class="term"><em class="parameter"><code>link_id</code></em> :</span></p></td>
522
517
<td> Can be <a
523
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
518
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
524
519
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
525
520
requested document.
526
521
</td>
528
523
<tr>
529
524
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
530
525
<td> child's environment, or <a
531
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
526
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
532
527
><code class="literal">NULL</code></a> to inherit parent's.
533
528
</td>
534
529
</tr>
535
530
<tr>
536
531
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
537
532
<td> A <a
538
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
533
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
539
534
><span class="type">GError</span></a> instance that will hold the specifics of any error which
540
535
occurs during processing, or <a
541
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
536
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
542
537
><code class="literal">NULL</code></a>
543
538
</td>
544
539
</tr>
545
540
<tr>
546
541
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
547
542
<td> <a
548
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
543
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
549
544
><code class="literal">TRUE</code></a> on success, <a
550
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
545
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
551
546
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
552
547
contain the actual error).
553
548
555
550
</tr>
556
551
</tbody>
557
552
</table></div>
558
<p class="since">Since 2.2
559
</p>
553
<p class="since">Since 2.2</p>
560
554
</div>
561
555
<hr>
562
556
<div class="refsect2" lang="en">
563
557
<a name="gnome-help-display-uri"></a><h3>gnome_help_display_uri ()</h3>
564
558
<pre class="programlisting"><a
565
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
559
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
566
560
>gboolean</a> gnome_help_display_uri (const char *help_uri,
567
561
<a
568
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
562
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
569
563
>GError</a> **error);</pre>
570
564
<p>
571
565
Displays <em class="parameter"><code>help_uri</code></em> in the user's preferred viewer. You should never need to
574
568
depends upon the scheme of the URI (so it is not strictly a help-only
575
569
function).</p>
576
570
<p>
577
578
571
</p>
579
572
<div class="variablelist"><table border="0">
580
573
<col align="left" valign="top">
587
580
<tr>
588
581
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
589
582
<td> A <a
590
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
583
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
591
584
><span class="type">GError</span></a> instance that will hold the specifics of any error which
592
585
occurs during processing, or <a
593
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
586
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
594
587
><code class="literal">NULL</code></a>
595
588
</td>
596
589
</tr>
597
590
<tr>
598
591
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
599
592
<td> <a
600
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
593
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
601
594
><code class="literal">TRUE</code></a> on success, <a
602
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
595
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
603
596
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
604
597
contain the actual error).
605
598
</td>
611
604
<div class="refsect2" lang="en">
612
605
<a name="gnome-help-display-uri-with-env"></a><h3>gnome_help_display_uri_with_env ()</h3>
613
606
<pre class="programlisting"><a
614
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
607
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
615
608
>gboolean</a> gnome_help_display_uri_with_env (const char *help_uri,
616
609
char **envp,
617
610
<a
618
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
611
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
619
612
>GError</a> **error);</pre>
620
613
<p>
621
614
Like <a class="link" href="libgnome-gnome-help.html#gnome-help-display-uri" title="gnome_help_display_uri ()"><code class="function">gnome_help_display_uri()</code></a>, but the the contents of <em class="parameter"><code>envp</code></em>
622
615
will become the help viewer's environment rather than inheriting
623
616
from the parents environment.</p>
624
617
<p>
625
626
618
</p>
627
619
<div class="variablelist"><table border="0">
628
620
<col align="left" valign="top">
635
627
<tr>
636
628
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
637
629
<td> child's environment, or <a
638
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
630
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
639
631
><code class="literal">NULL</code></a> to inherit parent's.
640
632
</td>
641
633
</tr>
642
634
<tr>
643
635
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
644
636
<td> A <a
645
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
637
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
646
638
><span class="type">GError</span></a> instance that will hold the specifics of any error which
647
639
occurs during processing, or <a
648
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
640
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
649
641
><code class="literal">NULL</code></a>
650
642
</td>
651
643
</tr>
652
644
<tr>
653
645
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
654
646
<td> <a
655
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
647
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
656
648
><code class="literal">TRUE</code></a> on success, <a
657
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
649
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
658
650
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
659
651
contain the actual error).
660
652
662
654
</tr>
663
655
</tbody>
664
656
</table></div>
665
<p class="since">Since 2.2
666
</p>
657
<p class="since">Since 2.2</p>
667
658
</div>
668
659
</div>
669
660
</div>
670
661
<div class="footer">
671
662
<hr>
672
Generated by GTK-Doc V1.10</div>
663
Generated by GTK-Doc V1.11</div>
673
664
</body>
674
665
</html>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1