~ubuntu-branches/ubuntu/feisty/libgnome/feisty
» Revision
18
: doc/reference/html/libgnome-gnome-program.html
« back to all changes in this revision
Viewing changes to doc/reference/html/libgnome-gnome-program.html
- browse files at revision 18
- compare with another revision
- download diff
- download tarball
- view history from revision 18
- 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
- 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
- files added:
- debian/patches/08_dont_force_a11y_activation.patch
- files removed:
- debian/patches/09_run_app_message_fix.patch
- files modified:
- ChangeLog
added
removed
doc/reference/html/libgnome-gnome-program.html
5
5
<title>gnome-program</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="libgnome.html#id2740192" title="Initializing applications and starting programs">
9
<link rel="prev" href="libgnome.html" title="GNOME Library (libgnome)">
8
<link rel="up" href="ch01.html" title="Initializing Applications and Starting Programs">
9
<link rel="prev" href="ch01.html" title="Initializing Applications and Starting Programs">
10
10
<link rel="next" href="libgnome-gnome-init.html" title="gnome-init">
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 I. 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
<td><a accesskey="p" href="libgnome.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
19
<td><a accesskey="u" href="libgnome.html#id2740192"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
34
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
35
<td><a accesskey="u" href="ch01.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
38
<td><a accesskey="n" href="libgnome-gnome-init.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="#id2776405" class="shortcut">Top</a>
40
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2960588" class="shortcut">Top</a>
25
41
 | 
26
<a href="#id2785922" class="shortcut">Description</a></nobr></td></tr>
42
<a href="#id2970147" class="shortcut">Description</a></nobr></td></tr>
27
43
</table>
28
44
<div class="refentry" lang="en">
29
45
<a name="libgnome-gnome-program"></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="id2776405"></a><span class="refentrytitle">gnome-program</span>
49
<a name="id2960588"></a><span class="refentrytitle">gnome-program</span>
34
50
</h2>
35
51
<p>gnome-program — Initialize and retrieve information about a GNOME application.</p>
36
52
</td>
60
76
const char *first_property_name,
61
77
...);
62
78
<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* <a href="libgnome-gnome-program.html#gnome-program-initv">gnome_program_initv</a> (<a
63
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
79
href="../gobject/gobject-Type-Information.html#GType"
64
80
>GType</a> type,
65
81
const char *app_id,
66
82
const char *app_version,
76
92
const char* <a href="libgnome-gnome-program.html#gnome-program-get-app-id">gnome_program_get_app_id</a> (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);
77
93
const char* <a href="libgnome-gnome-program.html#gnome-program-get-app-version">gnome_program_get_app_version</a> (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);
78
94
<a
79
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
95
href="../glib/glib-Basic-Types.html#gchar"
80
96
>gchar</a>* <a href="libgnome-gnome-program.html#gnome-program-locate-file">gnome_program_locate_file</a> (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
81
97
<a href="libgnome-gnome-program.html#GnomeFileDomain">GnomeFileDomain</a> domain,
82
98
const <a
83
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
99
href="../glib/glib-Basic-Types.html#gchar"
84
100
>gchar</a> *file_name,
85
101
<a
86
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
102
href="../glib/glib-Basic-Types.html#gboolean"
87
103
>gboolean</a> only_if_exists,
88
104
<a
89
href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"
105
href="../glib/glib-Singly-Linked-Lists.html#GSList"
90
106
>GSList</a> **ret_locations);
91
107
92
108
void <a href="libgnome-gnome-program.html#gnome-program-module-register">gnome_program_module_register</a> (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *module_info);
93
109
<a
94
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
110
href="../glib/glib-Basic-Types.html#gboolean"
95
111
>gboolean</a> <a href="libgnome-gnome-program.html#gnome-program-module-registered">gnome_program_module_registered</a> (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *module_info);
96
112
const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a>* <a href="libgnome-gnome-program.html#gnome-program-module-load">gnome_program_module_load</a>
97
113
(const char *mod_name);
98
114
<a
99
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
115
href="../glib/glib-Basic-Types.html#guint"
100
116
>guint</a> <a href="libgnome-gnome-program.html#gnome-program-install-property">gnome_program_install_property</a> (GnomeProgramClass *pclass,
101
117
<a
102
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectGetPropertyFunc"
118
href="../gobject/gobject-The-Base-Object-Type.html#GObjectGetPropertyFunc"
103
119
>GObjectGetPropertyFunc</a> get_fn,
104
120
<a
105
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectSetPropertyFunc"
121
href="../gobject/gobject-The-Base-Object-Type.html#GObjectSetPropertyFunc"
106
122
>GObjectSetPropertyFunc</a> set_fn,
107
123
<a
108
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
124
href="../gobject/gobject-GParamSpec.html#GParamSpec"
109
125
>GParamSpec</a> *pspec);
110
126
poptContext <a href="libgnome-gnome-program.html#gnome-program-preinit">gnome_program_preinit</a> (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
111
127
const char *app_id,
141
157
</pre>
142
158
</div>
143
159
<div class="refsect1" lang="en">
144
<a name="id2785922"></a><h2>Description</h2>
160
<a name="id2970147"></a><h2>Description</h2>
145
161
<p>
146
162
147
163
</p>
148
164
</div>
149
165
<div class="refsect1" lang="en">
150
<a name="id2785936"></a><h2>Details</h2>
166
<a name="id2970161"></a><h2>Details</h2>
151
167
<div class="refsect2" lang="en">
152
<a name="id2785946"></a><h3>
168
<a name="id2970171"></a><h3>
153
169
<a name="GnomeFileDomain"></a>enum GnomeFileDomain</h3>
154
<a class="indexterm" name="id2785959"></a><pre class="programlisting">typedef enum {
170
<a class="indexterm" name="id2970184"></a><pre class="programlisting">typedef enum {
155
171
GNOME_FILE_DOMAIN_UNKNOWN = 0,
156
172
157
173
/* Gnome installed files */
186
202
<col align="left" valign="top">
187
203
<tbody>
188
204
<tr>
189
<td>
190
<span class="term"><a name="GNOME-FILE-DOMAIN-UNKNOWN:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_UNKNOWN</code></span></td>
205
<td><span class="term"><a name="GNOME-FILE-DOMAIN-UNKNOWN:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_UNKNOWN</code></span></td>
191
206
<td>An unknown file domain (should never be used).
192
207
</td>
193
208
</tr>
194
209
<tr>
195
<td>
196
<span class="term"><a name="GNOME-FILE-DOMAIN-LIBDIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_LIBDIR</code></span></td>
210
<td><span class="term"><a name="GNOME-FILE-DOMAIN-LIBDIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_LIBDIR</code></span></td>
197
211
<td>Libraries in the main GNOME installation.
198
212
</td>
199
213
</tr>
200
214
<tr>
201
<td>
202
<span class="term"><a name="GNOME-FILE-DOMAIN-DATADIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_DATADIR</code></span></td>
215
<td><span class="term"><a name="GNOME-FILE-DOMAIN-DATADIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_DATADIR</code></span></td>
203
216
<td>Data files in the main GNOME installation.
204
217
</td>
205
218
</tr>
206
219
<tr>
207
<td>
208
<span class="term"><a name="GNOME-FILE-DOMAIN-SOUND:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_SOUND</code></span></td>
220
<td><span class="term"><a name="GNOME-FILE-DOMAIN-SOUND:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_SOUND</code></span></td>
209
221
<td>Sound files in the main GNOME installation.
210
222
</td>
211
223
</tr>
212
224
<tr>
213
<td>
214
<span class="term"><a name="GNOME-FILE-DOMAIN-PIXMAP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_PIXMAP</code></span></td>
225
<td><span class="term"><a name="GNOME-FILE-DOMAIN-PIXMAP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_PIXMAP</code></span></td>
215
226
<td>Pixmap files in the main GNOME installation.
216
227
</td>
217
228
</tr>
218
229
<tr>
219
<td>
220
<span class="term"><a name="GNOME-FILE-DOMAIN-CONFIG:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_CONFIG</code></span></td>
230
<td><span class="term"><a name="GNOME-FILE-DOMAIN-CONFIG:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_CONFIG</code></span></td>
221
231
<td>Config files in the main GNOME installation.
222
232
</td>
223
233
</tr>
224
234
<tr>
225
<td>
226
<span class="term"><a name="GNOME-FILE-DOMAIN-HELP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_HELP</code></span></td>
235
<td><span class="term"><a name="GNOME-FILE-DOMAIN-HELP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_HELP</code></span></td>
227
236
<td>Help files in the main GNOME installation.
228
237
</td>
229
238
</tr>
230
239
<tr>
231
<td>
232
<span class="term"><a name="GNOME-FILE-DOMAIN-APP-LIBDIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_LIBDIR</code></span></td>
240
<td><span class="term"><a name="GNOME-FILE-DOMAIN-APP-LIBDIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_LIBDIR</code></span></td>
233
241
<td>Application specific libraries.
234
242
</td>
235
243
</tr>
236
244
<tr>
237
<td>
238
<span class="term"><a name="GNOME-FILE-DOMAIN-APP-DATADIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_DATADIR</code></span></td>
245
<td><span class="term"><a name="GNOME-FILE-DOMAIN-APP-DATADIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_DATADIR</code></span></td>
239
246
<td>Application specific data files.
240
247
</td>
241
248
</tr>
242
249
<tr>
243
<td>
244
<span class="term"><a name="GNOME-FILE-DOMAIN-APP-SOUND:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_SOUND</code></span></td>
250
<td><span class="term"><a name="GNOME-FILE-DOMAIN-APP-SOUND:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_SOUND</code></span></td>
245
251
<td>Application specific sound files.
246
252
</td>
247
253
</tr>
248
254
<tr>
249
<td>
250
<span class="term"><a name="GNOME-FILE-DOMAIN-APP-PIXMAP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_PIXMAP</code></span></td>
255
<td><span class="term"><a name="GNOME-FILE-DOMAIN-APP-PIXMAP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_PIXMAP</code></span></td>
251
256
<td>Application specific pixmap files.
252
257
</td>
253
258
</tr>
254
259
<tr>
255
<td>
256
<span class="term"><a name="GNOME-FILE-DOMAIN-APP-CONFIG:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_CONFIG</code></span></td>
260
<td><span class="term"><a name="GNOME-FILE-DOMAIN-APP-CONFIG:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_CONFIG</code></span></td>
257
261
<td>Application specific config files.
258
262
</td>
259
263
</tr>
260
264
<tr>
261
<td>
262
<span class="term"><a name="GNOME-FILE-DOMAIN-APP-HELP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_HELP</code></span></td>
265
<td><span class="term"><a name="GNOME-FILE-DOMAIN-APP-HELP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_HELP</code></span></td>
263
266
<td>Application specific help files.
264
267
265
268
</td>
269
272
</div>
270
273
<hr>
271
274
<div class="refsect2" lang="en">
272
<a name="id2786306"></a><h3>
275
<a name="id2970531"></a><h3>
273
276
<a name="GnomeProgram"></a>GnomeProgram</h3>
274
<a class="indexterm" name="id2786319"></a><pre class="programlisting">typedef struct {
277
<a class="indexterm" name="id2970544"></a><pre class="programlisting">typedef struct {
275
278
GObject object;
276
279
277
280
GnomeProgramPrivate *_priv;
285
288
<col align="left" valign="top">
286
289
<tbody>
287
290
<tr>
288
<td>
289
<span class="term"><a
290
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
291
<td><span class="term"><a
292
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
291
293
>GObject</a> <em class="structfield"><code>object</code></em>;</span></td>
292
294
<td>A <a
293
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
295
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
294
296
><span class="type">GObject</span></a> containing the parameters and their values which were set
295
297
dring initialisation.
296
298
</td>
297
299
</tr>
298
300
<tr>
299
<td>
300
<span class="term">GnomeProgramPrivate *<em class="structfield"><code>_priv</code></em>;</span></td>
301
<td><span class="term">GnomeProgramPrivate *<em class="structfield"><code>_priv</code></em>;</span></td>
301
302
<td>Private data about the program instance.
302
303
303
304
</td>
307
308
</div>
308
309
<hr>
309
310
<div class="refsect2" lang="en">
310
<a name="id2786403"></a><h3>
311
<a name="id2970628"></a><h3>
311
312
<a name="GnomeModuleInfo"></a>GnomeModuleInfo</h3>
312
<a class="indexterm" name="id2786420"></a><pre class="programlisting">typedef struct {
313
<a class="indexterm" name="id2970645"></a><pre class="programlisting">typedef struct {
313
314
const char *name;
314
315
const char *version;
315
316
const char *description;
341
342
<col align="left" valign="top">
342
343
<tbody>
343
344
<tr>
344
<td>
345
<span class="term">const char *<em class="structfield"><code>name</code></em>;</span></td>
345
<td><span class="term">const char *<em class="structfield"><code>name</code></em>;</span></td>
346
346
<td>The module name.
347
347
</td>
348
348
</tr>
349
349
<tr>
350
<td>
351
<span class="term">const char *<em class="structfield"><code>version</code></em>;</span></td>
350
<td><span class="term">const char *<em class="structfield"><code>version</code></em>;</span></td>
352
351
<td>The module's version string.
353
352
</td>
354
353
</tr>
355
354
<tr>
356
<td>
357
<span class="term">const char *<em class="structfield"><code>description</code></em>;</span></td>
355
<td><span class="term">const char *<em class="structfield"><code>description</code></em>;</span></td>
358
356
<td>A string describing the module (can be <a
359
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
357
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
360
358
><code class="literal">NULL</code></a>).
361
359
</td>
362
360
</tr>
363
361
<tr>
364
<td>
365
<span class="term"><a href="libgnome-gnome-program.html#GnomeModuleRequirement">GnomeModuleRequirement</a> *<em class="structfield"><code>requirements</code></em>;</span></td>
362
<td><span class="term"><a href="libgnome-gnome-program.html#GnomeModuleRequirement">GnomeModuleRequirement</a> *<em class="structfield"><code>requirements</code></em>;</span></td>
366
363
<td>A pointer to an array of modules that are required by this
367
364
module. The last module in the array should have its required_version field set
368
365
to <a
369
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
366
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
370
367
><code class="literal">NULL</code></a>.
371
368
</td>
372
369
</tr>
373
370
<tr>
374
<td>
375
<span class="term"><a href="libgnome-gnome-program.html#GnomeModuleHook">GnomeModuleHook</a> <em class="structfield"><code>instance_init</code></em>;</span></td>
371
<td><span class="term"><a href="libgnome-gnome-program.html#GnomeModuleHook">GnomeModuleHook</a> <em class="structfield"><code>instance_init</code></em>;</span></td>
376
372
<td>A function to call to initialise an instance of this module
377
373
(can be <a
378
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
374
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
379
375
><code class="literal">NULL</code></a>).
380
376
</td>
381
377
</tr>
382
378
<tr>
383
<td>
384
<span class="term"><a href="libgnome-gnome-program.html#GnomeModuleHook">GnomeModuleHook</a> <em class="structfield"><code>pre_args_parse</code></em>;</span></td>
379
<td><span class="term"><a href="libgnome-gnome-program.html#GnomeModuleHook">GnomeModuleHook</a> <em class="structfield"><code>pre_args_parse</code></em>;</span></td>
385
380
<td>A function to call before parsing the arguments for this
386
381
module (can be <a
387
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
382
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
388
383
><code class="literal">NULL</code></a>).
389
384
</td>
390
385
</tr>
391
386
<tr>
392
<td>
393
<span class="term"><a href="libgnome-gnome-program.html#GnomeModuleHook">GnomeModuleHook</a> <em class="structfield"><code>post_args_parse</code></em>;</span></td>
387
<td><span class="term"><a href="libgnome-gnome-program.html#GnomeModuleHook">GnomeModuleHook</a> <em class="structfield"><code>post_args_parse</code></em>;</span></td>
394
388
<td>A function to call after parsing the arguments for this
395
389
module (can be <a
396
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
390
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
397
391
><code class="literal">NULL</code></a>).
398
392
</td>
399
393
</tr>
400
394
<tr>
401
<td>
402
<span class="term"><a href="libgnome-gnome-program.html#GnomeModuleClassInitHook">GnomeModuleClassInitHook</a> <em class="structfield"><code>class_init</code></em>;</span></td>
395
<td><span class="term"><a href="libgnome-gnome-program.html#GnomeModuleClassInitHook">GnomeModuleClassInitHook</a> <em class="structfield"><code>class_init</code></em>;</span></td>
403
396
<td>A function to call to initialise this module prior to creating any
404
397
instances (can be <a
405
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
398
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
406
399
><code class="literal">NULL</code></a>).
407
400
</td>
408
401
</tr>
409
402
<tr>
410
<td>
411
<span class="term">const char *<em class="structfield"><code>opt_prefix</code></em>;</span></td>
403
<td><span class="term">const char *<em class="structfield"><code>opt_prefix</code></em>;</span></td>
412
404
<td>Unused.
413
405
</td>
414
406
</tr>
415
407
<tr>
416
<td>
417
<span class="term">GnomeModuleGetGOptionGroupFunc <em class="structfield"><code>get_goption_group_func</code></em>;</span></td>
408
<td><span class="term">GnomeModuleGetGOptionGroupFunc <em class="structfield"><code>get_goption_group_func</code></em>;</span></td>
418
409
<td>A function which must return a non-<a
419
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
410
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
420
411
><code class="literal">NULL</code></a> <a
421
href="/usr/share/gtk-doc/html/glib/glib-Commandline-option-parser.html#GOptionGroup"
412
href="../glib/glib-Commandline-option-parser.html#GOptionGroup"
422
413
><span class="type">GOptionGroup</span></a>,
423
414
which will be added to the <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> s <a
424
href="/usr/share/gtk-doc/html/glib/glib-Commandline-option-parser.html#GOptionContext"
415
href="../glib/glib-Commandline-option-parser.html#GOptionContext"
425
416
><span class="type">GOptionContext</span></a> during
426
417
#<a href="libgnome-gnome-program.html#gnome-program-init"><code class="function">gnome_program_init()</code></a>.
427
418
432
423
</div>
433
424
<hr>
434
425
<div class="refsect2" lang="en">
435
<a name="id2786787"></a><h3>
426
<a name="id2971012"></a><h3>
436
427
<a name="GnomeModuleRequirement"></a>GnomeModuleRequirement</h3>
437
<a class="indexterm" name="id2786799"></a><pre class="programlisting">typedef struct {
428
<a class="indexterm" name="id2971024"></a><pre class="programlisting">typedef struct {
438
429
const char *required_version;
439
430
const GnomeModuleInfo *module_info;
440
431
} GnomeModuleRequirement;
447
438
<col align="left" valign="top">
448
439
<tbody>
449
440
<tr>
450
<td>
451
<span class="term">const char *<em class="structfield"><code>required_version</code></em>;</span></td>
441
<td><span class="term">const char *<em class="structfield"><code>required_version</code></em>;</span></td>
452
442
<td>The version required by the parent module.
453
443
</td>
454
444
</tr>
455
445
<tr>
456
<td>
457
<span class="term">const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *<em class="structfield"><code>module_info</code></em>;</span></td>
446
<td><span class="term">const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *<em class="structfield"><code>module_info</code></em>;</span></td>
458
447
<td>A <a href="libgnome-gnome-program.html#GnomeModuleInfo"><span class="type">GnomeModuleInfo</span></a> structure detailing the required module.
459
448
460
449
</td>
464
453
</div>
465
454
<hr>
466
455
<div class="refsect2" lang="en">
467
<a name="id2786875"></a><h3>
456
<a name="id2971100"></a><h3>
468
457
<a name="GnomeModuleInitHook"></a>GnomeModuleInitHook ()</h3>
469
<a class="indexterm" name="id2786888"></a><pre class="programlisting">void (*GnomeModuleInitHook) (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *mod_info);</pre>
458
<a class="indexterm" name="id2971113"></a><pre class="programlisting">void (*GnomeModuleInitHook) (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *mod_info);</pre>
470
459
<p>
471
460
A function that will be called to allow a module to do any pre-initialisation
472
461
it might need to do prior to having arguments parsed by the controlling parent
476
465
<div class="variablelist"><table border="0">
477
466
<col align="left" valign="top">
478
467
<tbody><tr>
479
<td>
480
<span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
468
<td><span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
481
469
<td>The current module.
482
470
483
471
487
475
</div>
488
476
<hr>
489
477
<div class="refsect2" lang="en">
490
<a name="id2786939"></a><h3>
478
<a name="id2971164"></a><h3>
491
479
<a name="GnomeModuleClassInitHook"></a>GnomeModuleClassInitHook ()</h3>
492
<a class="indexterm" name="id2786952"></a><pre class="programlisting">void (*GnomeModuleClassInitHook) (GnomeProgramClass *klass,
480
<a class="indexterm" name="id2971177"></a><pre class="programlisting">void (*GnomeModuleClassInitHook) (GnomeProgramClass *klass,
493
481
const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *mod_info);</pre>
494
482
<p>
495
483
A function called to perform any class specific setup that is required by each
499
487
<col align="left" valign="top">
500
488
<tbody>
501
489
<tr>
502
<td>
503
<span class="term"><em class="parameter"><code>klass</code></em> :</span></td>
490
<td><span class="term"><em class="parameter"><code>klass</code></em> :</span></td>
504
491
<td>The class of the parent module (which could be this module's class).
505
492
This will usually be <span class="type">GnomeProgramClass</span>.
506
493
</td>
507
494
</tr>
508
495
<tr>
509
<td>
510
<span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
496
<td><span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
511
497
<td>The current module.
512
498
513
499
518
504
</div>
519
505
<hr>
520
506
<div class="refsect2" lang="en">
521
<a name="id2787032"></a><h3>
507
<a name="id2971257"></a><h3>
522
508
<a name="GnomeModuleHook"></a>GnomeModuleHook ()</h3>
523
<a class="indexterm" name="id2787044"></a><pre class="programlisting">void (*GnomeModuleHook) (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
509
<a class="indexterm" name="id2971269"></a><pre class="programlisting">void (*GnomeModuleHook) (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
524
510
<a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *mod_info);</pre>
525
511
<p>
526
512
A function that is called to perform some intialisation in a module (which
531
517
<col align="left" valign="top">
532
518
<tbody>
533
519
<tr>
534
<td>
535
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
520
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
536
521
<td>The <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> instance which is being initialised.
537
522
</td>
538
523
</tr>
539
524
<tr>
540
<td>
541
<span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
525
<td><span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
542
526
<td>The current module's <a href="libgnome-gnome-program.html#GnomeModuleInfo"><span class="type">GnomeModuleInfo</span></a> structure.
543
527
544
528
549
533
</div>
550
534
<hr>
551
535
<div class="refsect2" lang="en">
552
<a name="id2787133"></a><h3>
536
<a name="id2971358"></a><h3>
553
537
<a name="gnome-program-init"></a>gnome_program_init ()</h3>
554
<a class="indexterm" name="id2787146"></a><pre class="programlisting"><a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* gnome_program_init (const char *app_id,
538
<a class="indexterm" name="id2971371"></a><pre class="programlisting"><a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* gnome_program_init (const char *app_id,
555
539
const char *app_version,
556
540
const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *module_info,
557
541
int argc,
571
555
<p>
572
556
It loads the specified <em class="parameter"><code>module_info</code></em>, which is normally <a href="libgnome-gnome-init.html#LIBGNOME-MODULE:CAPS"><span class="type">LIBGNOME_MODULE</span></a> or
573
557
<a
574
href="/usr/share/gtk-doc/html/libgnomeui/libgnomeui-gnome-ui-init.html#LIBGNOMEUI-MODULE:CAPS"
558
href="../libgnomeui/libgnomeui-gnome-ui-init.html#LIBGNOMEUI-MODULE:CAPS"
575
559
><span class="type">LIBGNOMEUI_MODULE</span></a> and pulls in all the dependencies. Programs that are not
576
560
running in setuid or setgid mode will also load modules specified in the
577
561
<em class="parameter"><code>--load-modules</code></em> and also in the <em class="parameter"><code>GNOME_MODULES</code></em> environment variable.
585
569
using a goption table that is defined elsewhere.
586
570
</p>
587
571
<div class="example">
588
<a name="id2787327"></a><p class="title"><b>Example 1. Initializing a GNOME application (deprecated, using popt)</b></p>
572
<a name="id2971552"></a><p class="title"><b>Example 1. Initializing a GNOME application (deprecated, using popt)</b></p>
589
573
<pre class="programlisting">
590
574
int main(int argc, char **argv) {
591
575
GnomeProgram *my_app;
614
598
elaborate example of an option entry table):
615
599
</p>
616
600
<div class="example">
617
<a name="id2787369"></a><p class="title"><b>Example 2. Initializing a GNOME application (new, using GOption)</b></p>
601
<a name="id2971594"></a><p class="title"><b>Example 2. Initializing a GNOME application (new, using GOption)</b></p>
618
602
<pre class="programlisting">
619
603
int main(int argc, char **argv) {
620
604
gchar **remaining_args = NULL;
635
619
/* if you are using any libraries that have command line options
636
620
* of their own and provide a GOptionGroup with them, you can
637
621
* add them here as well using <a
638
href="/usr/share/gtk-doc/html/glib/glib-Commandline-option-parser.html#g-option-context-add-group"
622
href="../glib/glib-Commandline-option-parser.html#g-option-context-add-group"
639
623
><code class="function">g_option_context_add_group()</code></a>
640
624
*/
641
625
675
659
<col align="left" valign="top">
676
660
<tbody>
677
661
<tr>
678
<td>
679
<span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
662
<td><span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
680
663
<td> Application ID string.
681
664
</td>
682
665
</tr>
683
666
<tr>
684
<td>
685
<span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
667
<td><span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
686
668
<td> Application version string.
687
669
</td>
688
670
</tr>
689
671
<tr>
690
<td>
691
<span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
672
<td><span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
692
673
<td> The module to init with this program.
693
674
</td>
694
675
</tr>
695
676
<tr>
696
<td>
697
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
677
<td><span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
698
678
<td> The number of commmand line arguments contained in <em class="parameter"><code>argv</code></em>.
699
679
</td>
700
680
</tr>
701
681
<tr>
702
<td>
703
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
682
<td><span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
704
683
<td> A string array of command line arguments.
705
684
</td>
706
685
</tr>
707
686
<tr>
708
<td>
709
<span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></td>
687
<td><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></td>
710
688
<td> The first item in a <a
711
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
689
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
712
690
><code class="literal">NULL</code></a>-terminated list of attribute
713
691
name and value pairs (so this will be an attribute name or <a
714
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
692
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
715
693
><code class="literal">NULL</code></a>).
716
694
</td>
717
695
</tr>
718
696
<tr>
719
<td>
720
<span class="term"><em class="parameter"><code>...</code></em> :</span></td>
697
<td><span class="term"><em class="parameter"><code>...</code></em> :</span></td>
721
698
<td> The continuation of a <a
722
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
699
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
723
700
><code class="literal">NULL</code></a>-terminated list of attribute name/value
724
701
pairs.
725
702
</td>
726
703
</tr>
727
704
<tr>
728
<td>
729
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
705
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
730
706
<td> A <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> instance representing the current application.
731
707
</td>
732
708
</tr>
735
711
</div>
736
712
<hr>
737
713
<div class="refsect2" lang="en">
738
<a name="id2787602"></a><h3>
714
<a name="id2971826"></a><h3>
739
715
<a name="gnome-program-initv"></a>gnome_program_initv ()</h3>
740
<a class="indexterm" name="id2787614"></a><pre class="programlisting"><a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* gnome_program_initv (<a
741
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
716
<a class="indexterm" name="id2971839"></a><pre class="programlisting"><a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* gnome_program_initv (<a
717
href="../gobject/gobject-Type-Information.html#GType"
742
718
>GType</a> type,
743
719
const char *app_id,
744
720
const char *app_version,
757
733
<col align="left" valign="top">
758
734
<tbody>
759
735
<tr>
760
<td>
761
<span class="term"><em class="parameter"><code>type</code></em> :</span></td>
736
<td><span class="term"><em class="parameter"><code>type</code></em> :</span></td>
762
737
<td> The type of application to be initialized (usually
763
738
<span class="type">GNOME_TYPE_PROGRAM</span>).
764
739
</td>
765
740
</tr>
766
741
<tr>
767
<td>
768
<span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
742
<td><span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
769
743
<td> Application ID string.
770
744
</td>
771
745
</tr>
772
746
<tr>
773
<td>
774
<span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
747
<td><span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
775
748
<td> Application version string.
776
749
</td>
777
750
</tr>
778
751
<tr>
779
<td>
780
<span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
752
<td><span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
781
753
<td> The modules to init with the application.
782
754
</td>
783
755
</tr>
784
756
<tr>
785
<td>
786
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
757
<td><span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
787
758
<td> The number of command line arguments contained in <em class="parameter"><code>argv</code></em>.
788
759
</td>
789
760
</tr>
790
761
<tr>
791
<td>
792
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
762
<td><span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
793
763
<td> A string array of command line arguments.
794
764
</td>
795
765
</tr>
796
766
<tr>
797
<td>
798
<span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></td>
767
<td><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></td>
799
768
<td> The first item in a <a
800
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
769
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
801
770
><code class="literal">NULL</code></a>-terminated list of attribute
802
771
name/value.
803
772
</td>
804
773
</tr>
805
774
<tr>
806
<td>
807
<span class="term"><em class="parameter"><code>args</code></em> :</span></td>
775
<td><span class="term"><em class="parameter"><code>args</code></em> :</span></td>
808
776
<td> The remaining elements in the <a
809
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
777
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
810
778
><code class="literal">NULL</code></a> terminated list (of which
811
779
<em class="parameter"><code>first_property_name</code></em> is the first element).
812
780
</td>
813
781
</tr>
814
782
<tr>
815
<td>
816
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
783
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
817
784
<td> A <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> instance representing the current application.
818
785
</td>
819
786
</tr>
822
789
</div>
823
790
<hr>
824
791
<div class="refsect2" lang="en">
825
<a name="id2787893"></a><h3>
792
<a name="id2972118"></a><h3>
826
793
<a name="gnome-program-get"></a>gnome_program_get ()</h3>
827
<a class="indexterm" name="id2787906"></a><pre class="programlisting"><a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* gnome_program_get (void);</pre>
794
<a class="indexterm" name="id2972131"></a><pre class="programlisting"><a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* gnome_program_get (void);</pre>
828
795
<p>
829
796
Retrieves an object that stored information about the application's state.
830
797
Other functions assume this will always return a <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> object which
831
798
(if not <a
832
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
799
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
833
800
><code class="literal">NULL</code></a>) has already been initialized.</p>
834
801
<p>
835
802
837
804
<div class="variablelist"><table border="0">
838
805
<col align="left" valign="top">
839
806
<tbody><tr>
840
<td>
841
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
807
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
842
808
<td> The application's <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> instance, or <a
843
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
809
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
844
810
><code class="literal">NULL</code></a> if it does not
845
811
exist.
846
812
</td>
849
815
</div>
850
816
<hr>
851
817
<div class="refsect2" lang="en">
852
<a name="id2787986"></a><h3>
818
<a name="id2972211"></a><h3>
853
819
<a name="gnome-program-get-human-readable-name"></a>gnome_program_get_human_readable_name ()</h3>
854
<a class="indexterm" name="id2788000"></a><pre class="programlisting">const char* gnome_program_get_human_readable_name
820
<a class="indexterm" name="id2972225"></a><pre class="programlisting">const char* gnome_program_get_human_readable_name
855
821
(<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
856
822
<p>
857
823
This function returns a pointer to a static string that the
858
824
application has provided as a human readable name. The app
859
825
should provide the name with the <a href="libgnome-gnome-program.html#GNOME-PARAM-HUMAN-READABLE-NAME:CAPS"><span class="type">GNOME_PARAM_HUMAN_READABLE_NAME</span></a>
860
826
init argument. Returns <a
861
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
827
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
862
828
><code class="literal">NULL</code></a> if no name was set.</p>
863
829
<p>
864
830
867
833
<col align="left" valign="top">
868
834
<tbody>
869
835
<tr>
870
<td>
871
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
836
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
872
837
<td> The application object
873
838
</td>
874
839
</tr>
875
840
<tr>
876
<td>
877
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
841
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
878
842
<td> Application human-readable name string.
879
843
</td>
880
844
</tr>
883
847
</div>
884
848
<hr>
885
849
<div class="refsect2" lang="en">
886
<a name="id2788086"></a><h3>
850
<a name="id2972311"></a><h3>
887
851
<a name="gnome-program-get-app-id"></a>gnome_program_get_app_id ()</h3>
888
<a class="indexterm" name="id2788099"></a><pre class="programlisting">const char* gnome_program_get_app_id (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
852
<a class="indexterm" name="id2972324"></a><pre class="programlisting">const char* gnome_program_get_app_id (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
889
853
<p>
890
854
This function returns a pointer to a static string that the
891
855
application has provided as an identifier. This is not meant as a
898
862
<col align="left" valign="top">
899
863
<tbody>
900
864
<tr>
901
<td>
902
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
865
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
903
866
<td> The program object
904
867
</td>
905
868
</tr>
906
869
<tr>
907
<td>
908
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
870
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
909
871
<td> Application ID string.
910
872
</td>
911
873
</tr>
914
876
</div>
915
877
<hr>
916
878
<div class="refsect2" lang="en">
917
<a name="id2788165"></a><h3>
879
<a name="id2972390"></a><h3>
918
880
<a name="gnome-program-get-app-version"></a>gnome_program_get_app_version ()</h3>
919
<a class="indexterm" name="id2788178"></a><pre class="programlisting">const char* gnome_program_get_app_version (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
881
<a class="indexterm" name="id2972403"></a><pre class="programlisting">const char* gnome_program_get_app_version (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
920
882
<p>
921
883
This function returns a pointer to a static string that the
922
884
application has provided as a version number. This is not meant as a
929
891
<col align="left" valign="top">
930
892
<tbody>
931
893
<tr>
932
<td>
933
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
894
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
934
895
<td> The application object
935
896
</td>
936
897
</tr>
937
898
<tr>
938
<td>
939
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
899
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
940
900
<td> Application version string.
941
901
</td>
942
902
</tr>
945
905
</div>
946
906
<hr>
947
907
<div class="refsect2" lang="en">
948
<a name="id2788244"></a><h3>
908
<a name="id2972469"></a><h3>
949
909
<a name="gnome-program-locate-file"></a>gnome_program_locate_file ()</h3>
950
<a class="indexterm" name="id2788257"></a><pre class="programlisting"><a
951
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
910
<a class="indexterm" name="id2972482"></a><pre class="programlisting"><a
911
href="../glib/glib-Basic-Types.html#gchar"
952
912
>gchar</a>* gnome_program_locate_file (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
953
913
<a href="libgnome-gnome-program.html#GnomeFileDomain">GnomeFileDomain</a> domain,
954
914
const <a
955
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
915
href="../glib/glib-Basic-Types.html#gchar"
956
916
>gchar</a> *file_name,
957
917
<a
958
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
918
href="../glib/glib-Basic-Types.html#gboolean"
959
919
>gboolean</a> only_if_exists,
960
920
<a
961
href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"
921
href="../glib/glib-Singly-Linked-Lists.html#GSList"
962
922
>GSList</a> **ret_locations);</pre>
963
923
<p>
964
924
This function finds a full path to the <em class="parameter"><code>file_name</code></em> located in the specified
967
927
</p>
968
928
<p>
969
929
If <em class="parameter"><code>ret_locations</code></em> is <a
970
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
930
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
971
931
><code class="literal">NULL</code></a>, only one pathname is returned. Otherwise,
972
932
alternative paths are returned in <em class="parameter"><code>ret_locations</code></em>.
973
933
</p>
987
947
<col align="left" valign="top">
988
948
<tbody>
989
949
<tr>
990
<td>
991
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
950
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
992
951
<td> A valid <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> object or <a
993
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
952
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
994
953
><code class="literal">NULL</code></a> (in which case the current
995
954
application is used).
996
955
</td>
997
956
</tr>
998
957
<tr>
999
<td>
1000
<span class="term"><em class="parameter"><code>domain</code></em> :</span></td>
958
<td><span class="term"><em class="parameter"><code>domain</code></em> :</span></td>
1001
959
<td> A <a href="libgnome-gnome-program.html#GnomeFileDomain"><span class="type">GnomeFileDomain</span></a>.
1002
960
</td>
1003
961
</tr>
1004
962
<tr>
1005
<td>
1006
<span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
963
<td><span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
1007
964
<td> A file name or path inside the 'domain' to find.
1008
965
</td>
1009
966
</tr>
1010
967
<tr>
1011
<td>
1012
<span class="term"><em class="parameter"><code>only_if_exists</code></em> :</span></td>
968
<td><span class="term"><em class="parameter"><code>only_if_exists</code></em> :</span></td>
1013
969
<td> Only return a full pathname if the specified file
1014
970
actually exists
1015
971
</td>
1016
972
</tr>
1017
973
<tr>
1018
<td>
1019
<span class="term"><em class="parameter"><code>ret_locations</code></em> :</span></td>
974
<td><span class="term"><em class="parameter"><code>ret_locations</code></em> :</span></td>
1020
975
<td> If this is not <a
1021
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
976
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
1022
977
><code class="literal">NULL</code></a>, a list of all the possible locations
1023
978
of the file will be returned.
1024
979
</td>
1025
980
</tr>
1026
981
<tr>
1027
<td>
1028
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
982
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1029
983
<td> The full path to the file (if it exists or only_if_exists is
1030
984
<a
1031
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
985
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
1032
986
><code class="literal">FALSE</code></a>) or <a
1033
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
987
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
1034
988
><code class="literal">NULL</code></a>.
1035
989
</td>
1036
990
</tr>
1039
993
</div>
1040
994
<hr>
1041
995
<div class="refsect2" lang="en">
1042
<a name="id2788529"></a><h3>
996
<a name="id2972754"></a><h3>
1043
997
<a name="gnome-program-module-register"></a>gnome_program_module_register ()</h3>
1044
<a class="indexterm" name="id2788542"></a><pre class="programlisting">void gnome_program_module_register (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *module_info);</pre>
998
<a class="indexterm" name="id2972767"></a><pre class="programlisting">void gnome_program_module_register (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *module_info);</pre>
1045
999
<p>
1046
1000
This function is used to register a module to be initialized by the
1047
1001
GNOME library framework. The memory pointed to by <em class="parameter"><code>module_info</code></em> must be
1054
1008
<div class="variablelist"><table border="0">
1055
1009
<col align="left" valign="top">
1056
1010
<tbody><tr>
1057
<td>
1058
<span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
1011
<td><span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
1059
1012
<td> A pointer to a GnomeModuleInfo structure describing the module
1060
1013
to be initialized
1061
1014
</td>
1064
1017
</div>
1065
1018
<hr>
1066
1019
<div class="refsect2" lang="en">
1067
<a name="id2788616"></a><h3>
1020
<a name="id2972841"></a><h3>
1068
1021
<a name="gnome-program-module-registered"></a>gnome_program_module_registered ()</h3>
1069
<a class="indexterm" name="id2788630"></a><pre class="programlisting"><a
1070
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
1022
<a class="indexterm" name="id2972854"></a><pre class="programlisting"><a
1023
href="../glib/glib-Basic-Types.html#gboolean"
1071
1024
>gboolean</a> gnome_program_module_registered (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *module_info);</pre>
1072
1025
<p>
1073
1026
This method checks to see whether a specific module has been
1079
1032
<col align="left" valign="top">
1080
1033
<tbody>
1081
1034
<tr>
1082
<td>
1083
<span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
1035
<td><span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
1084
1036
<td> A pointer to a GnomeModuleInfo structure describing the module
1085
1037
to be queried
1086
1038
</td>
1087
1039
</tr>
1088
1040
<tr>
1089
<td>
1090
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1041
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1091
1042
<td> A value indicating whether the specified module has been
1092
1043
registered/initialized in the current program
1093
1044
</td>
1097
1048
</div>
1098
1049
<hr>
1099
1050
<div class="refsect2" lang="en">
1100
<a name="id2788695"></a><h3>
1051
<a name="id2972920"></a><h3>
1101
1052
<a name="gnome-program-module-load"></a>gnome_program_module_load ()</h3>
1102
<a class="indexterm" name="id2788709"></a><pre class="programlisting">const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a>* gnome_program_module_load
1053
<a class="indexterm" name="id2972934"></a><pre class="programlisting">const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a>* gnome_program_module_load
1103
1054
(const char *mod_name);</pre>
1104
1055
<p>
1105
1056
Loads a shared library that contains a
1111
1062
<col align="left" valign="top">
1112
1063
<tbody>
1113
1064
<tr>
1114
<td>
1115
<span class="term"><em class="parameter"><code>mod_name</code></em> :</span></td>
1065
<td><span class="term"><em class="parameter"><code>mod_name</code></em> :</span></td>
1116
1066
<td> module name
1117
1067
</td>
1118
1068
</tr>
1119
1069
<tr>
1120
<td>
1121
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1070
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1122
1071
<td> The <a href="libgnome-gnome-program.html#GnomeModuleInfo"><span class="type">GnomeModuleInfo</span></a> structure that was loaded, or <a
1123
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
1072
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
1124
1073
><code class="literal">NULL</code></a> if the
1125
1074
module could not be loaded.
1126
1075
</td>
1130
1079
</div>
1131
1080
<hr>
1132
1081
<div class="refsect2" lang="en">
1133
<a name="id2788800"></a><h3>
1082
<a name="id2973025"></a><h3>
1134
1083
<a name="gnome-program-install-property"></a>gnome_program_install_property ()</h3>
1135
<a class="indexterm" name="id2788814"></a><pre class="programlisting"><a
1136
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
1084
<a class="indexterm" name="id2973039"></a><pre class="programlisting"><a
1085
href="../glib/glib-Basic-Types.html#guint"
1137
1086
>guint</a> gnome_program_install_property (GnomeProgramClass *pclass,
1138
1087
<a
1139
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectGetPropertyFunc"
1088
href="../gobject/gobject-The-Base-Object-Type.html#GObjectGetPropertyFunc"
1140
1089
>GObjectGetPropertyFunc</a> get_fn,
1141
1090
<a
1142
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectSetPropertyFunc"
1091
href="../gobject/gobject-The-Base-Object-Type.html#GObjectSetPropertyFunc"
1143
1092
>GObjectSetPropertyFunc</a> set_fn,
1144
1093
<a
1145
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
1094
href="../gobject/gobject-GParamSpec.html#GParamSpec"
1146
1095
>GParamSpec</a> *pspec);</pre>
1147
1096
<p>
1148
1097
Install a collection of available properties, their default values and the
1158
1107
<col align="left" valign="top">
1159
1108
<tbody>
1160
1109
<tr>
1161
<td>
1162
<span class="term"><em class="parameter"><code>pclass</code></em> :</span></td>
1110
<td><span class="term"><em class="parameter"><code>pclass</code></em> :</span></td>
1163
1111
<td> A <span class="type">GnomeProgramClass</span>.
1164
1112
</td>
1165
1113
</tr>
1166
1114
<tr>
1167
<td>
1168
<span class="term"><em class="parameter"><code>get_fn</code></em> :</span></td>
1115
<td><span class="term"><em class="parameter"><code>get_fn</code></em> :</span></td>
1169
1116
<td> A function to get property values.
1170
1117
</td>
1171
1118
</tr>
1172
1119
<tr>
1173
<td>
1174
<span class="term"><em class="parameter"><code>set_fn</code></em> :</span></td>
1120
<td><span class="term"><em class="parameter"><code>set_fn</code></em> :</span></td>
1175
1121
<td> A function to set property values.
1176
1122
</td>
1177
1123
</tr>
1178
1124
<tr>
1179
<td>
1180
<span class="term"><em class="parameter"><code>pspec</code></em> :</span></td>
1125
<td><span class="term"><em class="parameter"><code>pspec</code></em> :</span></td>
1181
1126
<td> A collection of properties.
1182
1127
</td>
1183
1128
</tr>
1184
1129
<tr>
1185
<td>
1186
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1130
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1187
1131
<td> The number of properties installed.
1188
1132
</td>
1189
1133
</tr>
1192
1136
</div>
1193
1137
<hr>
1194
1138
<div class="refsect2" lang="en">
1195
<a name="id2788957"></a><h3>
1139
<a name="id2973182"></a><h3>
1196
1140
<a name="gnome-program-preinit"></a>gnome_program_preinit ()</h3>
1197
<a class="indexterm" name="id2788970"></a><pre class="programlisting">poptContext gnome_program_preinit (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
1141
<a class="indexterm" name="id2973195"></a><pre class="programlisting">poptContext gnome_program_preinit (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
1198
1142
const char *app_id,
1199
1143
const char *app_version,
1200
1144
int argc,
1210
1154
<col align="left" valign="top">
1211
1155
<tbody>
1212
1156
<tr>
1213
<td>
1214
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
1157
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
1215
1158
<td> Application object
1216
1159
</td>
1217
1160
</tr>
1218
1161
<tr>
1219
<td>
1220
<span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
1162
<td><span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
1221
1163
<td> application ID string
1222
1164
</td>
1223
1165
</tr>
1224
1166
<tr>
1225
<td>
1226
<span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
1167
<td><span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
1227
1168
<td> application version string
1228
1169
</td>
1229
1170
</tr>
1230
1171
<tr>
1231
<td>
1232
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
1172
<td><span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
1233
1173
<td> The number of commmand line arguments contained in 'argv'
1234
1174
</td>
1235
1175
</tr>
1236
1176
<tr>
1237
<td>
1238
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
1177
<td><span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
1239
1178
<td> A string array of command line arguments
1240
1179
</td>
1241
1180
</tr>
1242
1181
<tr>
1243
<td>
1244
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1182
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1245
1183
<td> A poptContext representing the argument parsing state,
1246
1184
or <a
1247
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
1185
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
1248
1186
><code class="literal">NULL</code></a> if using GOption argument parsing.
1249
1187
</td>
1250
1188
</tr>
1253
1191
</div>
1254
1192
<hr>
1255
1193
<div class="refsect2" lang="en">
1256
<a name="id2789144"></a><h3>
1194
<a name="id2973369"></a><h3>
1257
1195
<a name="gnome-program-parse-args"></a>gnome_program_parse_args ()</h3>
1258
<a class="indexterm" name="id2789157"></a><pre class="programlisting">void gnome_program_parse_args (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
1196
<a class="indexterm" name="id2973382"></a><pre class="programlisting">void gnome_program_parse_args (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
1259
1197
<p>
1260
1198
Parses the command line arguments for the application</p>
1261
1199
<p>
1264
1202
<div class="variablelist"><table border="0">
1265
1203
<col align="left" valign="top">
1266
1204
<tbody><tr>
1267
<td>
1268
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
1205
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
1269
1206
<td> Application object
1270
1207
</td>
1271
1208
</tr></tbody>
1273
1210
</div>
1274
1211
<hr>
1275
1212
<div class="refsect2" lang="en">
1276
<a name="id2789208"></a><h3>
1213
<a name="id2973433"></a><h3>
1277
1214
<a name="gnome-program-postinit"></a>gnome_program_postinit ()</h3>
1278
<a class="indexterm" name="id2789221"></a><pre class="programlisting">void gnome_program_postinit (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
1215
<a class="indexterm" name="id2973446"></a><pre class="programlisting">void gnome_program_postinit (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
1279
1216
<p>
1280
1217
Called after <a href="libgnome-gnome-program.html#gnome-program-parse-args"><code class="function">gnome_program_parse_args()</code></a>, this function
1281
1218
takes care of post-parse initialization and cleanup</p>
1285
1222
<div class="variablelist"><table border="0">
1286
1223
<col align="left" valign="top">
1287
1224
<tbody><tr>
1288
<td>
1289
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
1225
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
1290
1226
<td> Application object
1291
1227
</td>
1292
1228
</tr></tbody>
1294
1230
</div>
1295
1231
<hr>
1296
1232
<div class="refsect2" lang="en">
1297
<a name="id2789284"></a><h3>
1233
<a name="id2973509"></a><h3>
1298
1234
<a name="GNOME-PARAM-POPT-TABLE:CAPS"></a>GNOME_PARAM_POPT_TABLE</h3>
1299
<a class="indexterm" name="id2789299"></a><pre class="programlisting">#define GNOME_PARAM_POPT_TABLE "popt-table"
1235
<a class="indexterm" name="id2973524"></a><pre class="programlisting">#define GNOME_PARAM_POPT_TABLE "popt-table"
1300
1236
</pre>
1301
1237
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1302
1238
<h3 class="title">Warning</h3>
1311
1247
</div>
1312
1248
<hr>
1313
1249
<div class="refsect2" lang="en">
1314
<a name="id2789349"></a><h3>
1250
<a name="id2973574"></a><h3>
1315
1251
<a name="GNOME-PARAM-POPT-FLAGS:CAPS"></a>GNOME_PARAM_POPT_FLAGS</h3>
1316
<a class="indexterm" name="id2789365"></a><pre class="programlisting">#define GNOME_PARAM_POPT_FLAGS "popt-flags"
1252
<a class="indexterm" name="id2973590"></a><pre class="programlisting">#define GNOME_PARAM_POPT_FLAGS "popt-flags"
1317
1253
</pre>
1318
1254
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1319
1255
<h3 class="title">Warning</h3>
1325
1261
</div>
1326
1262
<hr>
1327
1263
<div class="refsect2" lang="en">
1328
<a name="id2789395"></a><h3>
1264
<a name="id2973620"></a><h3>
1329
1265
<a name="GNOME-PARAM-POPT-CONTEXT:CAPS"></a>GNOME_PARAM_POPT_CONTEXT</h3>
1330
<a class="indexterm" name="id2789411"></a><pre class="programlisting">#define GNOME_PARAM_POPT_CONTEXT "popt-context"
1266
<a class="indexterm" name="id2973636"></a><pre class="programlisting">#define GNOME_PARAM_POPT_CONTEXT "popt-context"
1331
1267
</pre>
1332
1268
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1333
1269
<h3 class="title">Warning</h3>
1340
1276
</div>
1341
1277
<hr>
1342
1278
<div class="refsect2" lang="en">
1343
<a name="id2789450"></a><h3>
1279
<a name="id2973675"></a><h3>
1344
1280
<a name="GNOME-PARAM-GOPTION-CONTEXT:CAPS"></a>GNOME_PARAM_GOPTION_CONTEXT</h3>
1345
<a class="indexterm" name="id2789466"></a><pre class="programlisting">#define GNOME_PARAM_GOPTION_CONTEXT "goption-context"
1281
<a class="indexterm" name="id2973691"></a><pre class="programlisting">#define GNOME_PARAM_GOPTION_CONTEXT "goption-context"
1346
1282
</pre>
1347
1283
<p>
1348
1284
This parameter contains the GOptionContext pointer that <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> is using for
1349
1285
GOption parsing (write on init only). The <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> will assume ownership of the
1350
1286
passed <a
1351
href="/usr/share/gtk-doc/html/glib/glib-Commandline-option-parser.html#GOptionContext"
1287
href="../glib/glib-Commandline-option-parser.html#GOptionContext"
1352
1288
><span class="type">GOptionContext</span></a>.
1353
1289
Mutually exclusive with using the <a href="libgnome-gnome-program.html#GNOME-PARAM-POPT-TABLE:CAPS"><span class="type">GNOME_PARAM_POPT_TABLE</span></a> parameter.
1354
1290
</p>
1359
1295
</div>
1360
1296
<hr>
1361
1297
<div class="refsect2" lang="en">
1362
<a name="id2789524"></a><h3>
1298
<a name="id2973748"></a><h3>
1363
1299
<a name="GNOME-PARAM-CREATE-DIRECTORIES:CAPS"></a>GNOME_PARAM_CREATE_DIRECTORIES</h3>
1364
<a class="indexterm" name="id2789536"></a><pre class="programlisting">#define GNOME_PARAM_CREATE_DIRECTORIES "create-directories"
1300
<a class="indexterm" name="id2973761"></a><pre class="programlisting">#define GNOME_PARAM_CREATE_DIRECTORIES "create-directories"
1365
1301
</pre>
1366
1302
<p>
1367
1303
This parameter contains <a
1368
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
1304
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
1369
1305
><code class="literal">TRUE</code></a> if the standard GNOME directories should be
1370
1306
created on startup.
1371
1307
</p>
1372
1308
</div>
1373
1309
<hr>
1374
1310
<div class="refsect2" lang="en">
1375
<a name="id2789564"></a><h3>
1311
<a name="id2973789"></a><h3>
1376
1312
<a name="GNOME-PARAM-ENABLE-SOUND:CAPS"></a>GNOME_PARAM_ENABLE_SOUND</h3>
1377
<a class="indexterm" name="id2789578"></a><pre class="programlisting">#define GNOME_PARAM_ENABLE_SOUND "enable-sound"
1313
<a class="indexterm" name="id2973803"></a><pre class="programlisting">#define GNOME_PARAM_ENABLE_SOUND "enable-sound"
1378
1314
</pre>
1379
1315
<p>
1380
1316
This parameter determines whether or not to enable sound on startup.
1382
1318
</div>
1383
1319
<hr>
1384
1320
<div class="refsect2" lang="en">
1385
<a name="id2789595"></a><h3>
1321
<a name="id2973820"></a><h3>
1386
1322
<a name="GNOME-PARAM-ESPEAKER:CAPS"></a>GNOME_PARAM_ESPEAKER</h3>
1387
<a class="indexterm" name="id2789608"></a><pre class="programlisting">#define GNOME_PARAM_ESPEAKER "espeaker"
1323
<a class="indexterm" name="id2973833"></a><pre class="programlisting">#define GNOME_PARAM_ESPEAKER "espeaker"
1388
1324
</pre>
1389
1325
<p>
1390
1326
This parameter describes how to connect to esd.
1392
1328
</div>
1393
1329
<hr>
1394
1330
<div class="refsect2" lang="en">
1395
<a name="id2789625"></a><h3>
1331
<a name="id2973850"></a><h3>
1396
1332
<a name="GNOME-PARAM-APP-ID:CAPS"></a>GNOME_PARAM_APP_ID</h3>
1397
<a class="indexterm" name="id2789638"></a><pre class="programlisting">#define GNOME_PARAM_APP_ID "app-id"
1333
<a class="indexterm" name="id2973863"></a><pre class="programlisting">#define GNOME_PARAM_APP_ID "app-id"
1398
1334
</pre>
1399
1335
<p>
1400
1336
This parameter contains the ID string to use for the application (readable).
1402
1338
</div>
1403
1339
<hr>
1404
1340
<div class="refsect2" lang="en">
1405
<a name="id2789655"></a><h3>
1341
<a name="id2973880"></a><h3>
1406
1342
<a name="GNOME-PARAM-APP-VERSION:CAPS"></a>GNOME_PARAM_APP_VERSION</h3>
1407
<a class="indexterm" name="id2789668"></a><pre class="programlisting">#define GNOME_PARAM_APP_VERSION "app-version"
1343
<a class="indexterm" name="id2973893"></a><pre class="programlisting">#define GNOME_PARAM_APP_VERSION "app-version"
1408
1344
</pre>
1409
1345
<p>
1410
1346
This parameter contains the application version (readable).
1412
1348
</div>
1413
1349
<hr>
1414
1350
<div class="refsect2" lang="en">
1415
<a name="id2789685"></a><h3>
1351
<a name="id2973910"></a><h3>
1416
1352
<a name="GNOME-PARAM-GNOME-PREFIX:CAPS"></a>GNOME_PARAM_GNOME_PREFIX</h3>
1417
<a class="indexterm" name="id2789698"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_PREFIX "gnome-prefix"
1353
<a class="indexterm" name="id2973923"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_PREFIX "gnome-prefix"
1418
1354
</pre>
1419
1355
<p>
1420
1356
This parameter contains the prefix where the main GNOME system is installed
1423
1359
</div>
1424
1360
<hr>
1425
1361
<div class="refsect2" lang="en">
1426
<a name="id2789716"></a><h3>
1362
<a name="id2973941"></a><h3>
1427
1363
<a name="GNOME-PARAM-GNOME-SYSCONFDIR:CAPS"></a>GNOME_PARAM_GNOME_SYSCONFDIR</h3>
1428
<a class="indexterm" name="id2789728"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_SYSCONFDIR "gnome-sysconfdir"
1364
<a class="indexterm" name="id2973953"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_SYSCONFDIR "gnome-sysconfdir"
1429
1365
</pre>
1430
1366
<p>
1431
1367
This parameter contains the prefix where the GNOME configuration files
1434
1370
</div>
1435
1371
<hr>
1436
1372
<div class="refsect2" lang="en">
1437
<a name="id2789746"></a><h3>
1373
<a name="id2973971"></a><h3>
1438
1374
<a name="GNOME-PARAM-GNOME-DATADIR:CAPS"></a>GNOME_PARAM_GNOME_DATADIR</h3>
1439
<a class="indexterm" name="id2789760"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_DATADIR "gnome-datadir"
1375
<a class="indexterm" name="id2973985"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_DATADIR "gnome-datadir"
1440
1376
</pre>
1441
1377
<p>
1442
1378
This parameter contains the prefix where the GNOME data files are installed
1445
1381
</div>
1446
1382
<hr>
1447
1383
<div class="refsect2" lang="en">
1448
<a name="id2789778"></a><h3>
1384
<a name="id2974003"></a><h3>
1449
1385
<a name="GNOME-PARAM-GNOME-LIBDIR:CAPS"></a>GNOME_PARAM_GNOME_LIBDIR</h3>
1450
<a class="indexterm" name="id2789791"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_LIBDIR "gnome-libdir"
1386
<a class="indexterm" name="id2974016"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_LIBDIR "gnome-libdir"
1451
1387
</pre>
1452
1388
<p>
1453
1389
This parameter contains the prefix where the GNOME library files are installed
1456
1392
</div>
1457
1393
<hr>
1458
1394
<div class="refsect2" lang="en">
1459
<a name="id2789809"></a><h3>
1395
<a name="id2974034"></a><h3>
1460
1396
<a name="GNOME-PARAM-APP-PREFIX:CAPS"></a>GNOME_PARAM_APP_PREFIX</h3>
1461
<a class="indexterm" name="id2789822"></a><pre class="programlisting">#define GNOME_PARAM_APP_PREFIX "app-prefix"
1397
<a class="indexterm" name="id2974047"></a><pre class="programlisting">#define GNOME_PARAM_APP_PREFIX "app-prefix"
1462
1398
</pre>
1463
1399
<p>
1464
1400
This parameter contains the prefix where this application was installed
1467
1403
</div>
1468
1404
<hr>
1469
1405
<div class="refsect2" lang="en">
1470
<a name="id2789839"></a><h3>
1406
<a name="id2974064"></a><h3>
1471
1407
<a name="GNOME-PARAM-APP-SYSCONFDIR:CAPS"></a>GNOME_PARAM_APP_SYSCONFDIR</h3>
1472
<a class="indexterm" name="id2789852"></a><pre class="programlisting">#define GNOME_PARAM_APP_SYSCONFDIR "app-sysconfdir"
1408
<a class="indexterm" name="id2974077"></a><pre class="programlisting">#define GNOME_PARAM_APP_SYSCONFDIR "app-sysconfdir"
1473
1409
</pre>
1474
1410
<p>
1475
1411
This parameter contains the prefix where this application's configuration files
1478
1414
</div>
1479
1415
<hr>
1480
1416
<div class="refsect2" lang="en">
1481
<a name="id2789870"></a><h3>
1417
<a name="id2974095"></a><h3>
1482
1418
<a name="GNOME-PARAM-APP-DATADIR:CAPS"></a>GNOME_PARAM_APP_DATADIR</h3>
1483
<a class="indexterm" name="id2789883"></a><pre class="programlisting">#define GNOME_PARAM_APP_DATADIR "app-datadir"
1419
<a class="indexterm" name="id2974108"></a><pre class="programlisting">#define GNOME_PARAM_APP_DATADIR "app-datadir"
1484
1420
</pre>
1485
1421
<p>
1486
1422
This parameter contains the prefix where this application's data files are
1489
1425
</div>
1490
1426
<hr>
1491
1427
<div class="refsect2" lang="en">
1492
<a name="id2789901"></a><h3>
1428
<a name="id2974126"></a><h3>
1493
1429
<a name="GNOME-PARAM-APP-LIBDIR:CAPS"></a>GNOME_PARAM_APP_LIBDIR</h3>
1494
<a class="indexterm" name="id2789914"></a><pre class="programlisting">#define GNOME_PARAM_APP_LIBDIR "app-libdir"
1430
<a class="indexterm" name="id2974139"></a><pre class="programlisting">#define GNOME_PARAM_APP_LIBDIR "app-libdir"
1495
1431
</pre>
1496
1432
<p>
1497
1433
This parameter contains the prefix where this application's library files are
1500
1436
</div>
1501
1437
<hr>
1502
1438
<div class="refsect2" lang="en">
1503
<a name="id2789932"></a><h3>
1439
<a name="id2974157"></a><h3>
1504
1440
<a name="GNOME-PARAM-HUMAN-READABLE-NAME:CAPS"></a>GNOME_PARAM_HUMAN_READABLE_NAME</h3>
1505
<a class="indexterm" name="id2789946"></a><pre class="programlisting">#define GNOME_PARAM_HUMAN_READABLE_NAME "human-readable-name"
1441
<a class="indexterm" name="id2974170"></a><pre class="programlisting">#define GNOME_PARAM_HUMAN_READABLE_NAME "human-readable-name"
1506
1442
</pre>
1507
1443
<p>
1508
1444
This parameter contains the human readable name of the application (readable).
1510
1446
</div>
1511
1447
<hr>
1512
1448
<div class="refsect2" lang="en">
1513
<a name="id2789963"></a><h3>
1449
<a name="id2974188"></a><h3>
1514
1450
<a name="GNOME-PARAM-GNOME-PATH:CAPS"></a>GNOME_PARAM_GNOME_PATH</h3>
1515
<a class="indexterm" name="id2789976"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_PATH "gnome-path"
1451
<a class="indexterm" name="id2974201"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_PATH "gnome-path"
1516
1452
</pre>
1517
1453
<p>
1518
1454
This parameter contains the path in which to look for installed files (taken
1521
1457
</div>
1522
1458
<hr>
1523
1459
<div class="refsect2" lang="en">
1524
<a name="id2789994"></a><h3>
1460
<a name="id2974219"></a><h3>
1525
1461
<a name="GNOME-PARAM-NONE:CAPS"></a>GNOME_PARAM_NONE</h3>
1526
<a class="indexterm" name="id2790007"></a><pre class="programlisting">#define GNOME_PARAM_NONE NULL
1462
<a class="indexterm" name="id2974232"></a><pre class="programlisting">#define GNOME_PARAM_NONE NULL
1527
1463
</pre>
1528
1464
<p>
1529
1465
Used to terminate a list of parameters and their values.
1531
1467
</div>
1532
1468
<hr>
1533
1469
<div class="refsect2" lang="en">
1534
<a name="id2790024"></a><h3>
1470
<a name="id2974249"></a><h3>
1535
1471
<a name="GNOME-PROGRAM-STANDARD-PROPERTIES:CAPS"></a>GNOME_PROGRAM_STANDARD_PROPERTIES</h3>
1536
<a class="indexterm" name="id2790037"></a><pre class="programlisting">#define GNOME_PROGRAM_STANDARD_PROPERTIES</pre>
1472
<a class="indexterm" name="id2974262"></a><pre class="programlisting">#define GNOME_PROGRAM_STANDARD_PROPERTIES</pre>
1537
1473
<p>
1538
1474
When PREFIX, SYSCONFDIR, DATADIR and LIBDIR are defined during the build
1539
1475
process, this macro can be used to assign these values to
Loggerhead is a web-based interface for Breezy
Version: 2.0.1