~ubuntu-branches/ubuntu/feisty/libgnome/feisty
» Revision
22
: 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 22
- compare with another revision
- download diff
- download tarball
- view history from revision 22
- Committer: Bazaar Package Importer
- Author(s): Daniel Holbach
- Date: 2007-01-09 10:07:49 UTC
- mfrom: (1.1.12 upstream)
- Revision ID: james.westby@ubuntu.com-20070109100749-uc3lve73086th31g
Tags: 2.17.2-0ubuntu1
New upstream release.
- files modified:
- ChangeLog
added
removed
doc/reference/html/libgnome-gnome-program.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gnome-program</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
7
7
<link rel="start" href="index.html" title="GNOME Library Reference Manual">
8
8
<link rel="up" href="ch01.html" title="Initializing Applications and Starting Programs">
9
9
<link rel="prev" 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-init.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="#id2682122" class="shortcut">Top</a>
40
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2477556" class="shortcut">Top</a>
41
41
 | 
42
<a href="#id2721995" class="shortcut">Description</a></nobr></td></tr>
42
<a href="#id2523495" class="shortcut">Description</a></nobr></td></tr>
43
43
</table>
44
44
<div class="refentry" lang="en">
45
45
<a name="libgnome-gnome-program"></a><div class="titlepage"></div>
46
46
<div class="refnamediv"><table width="100%"><tr>
47
47
<td valign="top">
48
48
<h2>
49
<a name="id2682122"></a><span class="refentrytitle">gnome-program</span>
49
<a name="id2477556"></a><span class="refentrytitle">gnome-program</span>
50
50
</h2>
51
51
<p>gnome-program — Initialize and retrieve information about a GNOME application.</p>
52
52
</td>
137
137
</pre>
138
138
</div>
139
139
<div class="refsect1" lang="en">
140
<a name="id2721995"></a><h2>Description</h2>
140
<a name="id2523495"></a><h2>Description</h2>
141
141
<p>
142
142
143
143
</p>
144
144
</div>
145
145
<div class="refsect1" lang="en">
146
<a name="id2722009"></a><h2>Details</h2>
146
<a name="id2523509"></a><h2>Details</h2>
147
147
<div class="refsect2" lang="en">
148
<a name="id2722019"></a><h3>
148
<a name="id2523519"></a><h3>
149
149
<a name="GnomeFileDomain"></a>enum GnomeFileDomain</h3>
150
<a class="indexterm" name="id2722032"></a><pre class="programlisting">typedef enum {
150
<a class="indexterm" name="id2523532"></a><pre class="programlisting">typedef enum {
151
151
GNOME_FILE_DOMAIN_UNKNOWN = 0,
152
152
153
153
/* Gnome installed files */
182
182
<col align="left" valign="top">
183
183
<tbody>
184
184
<tr>
185
<td><span class="term"><a name="GNOME-FILE-DOMAIN-UNKNOWN:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_UNKNOWN</code></span></td>
185
<td>
186
<span class="term"><a name="GNOME-FILE-DOMAIN-UNKNOWN:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_UNKNOWN</code></span></td>
186
187
<td>An unknown file domain (should never be used).
187
188
</td>
188
189
</tr>
189
190
<tr>
190
<td><span class="term"><a name="GNOME-FILE-DOMAIN-LIBDIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_LIBDIR</code></span></td>
191
<td>
192
<span class="term"><a name="GNOME-FILE-DOMAIN-LIBDIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_LIBDIR</code></span></td>
191
193
<td>Libraries in the main GNOME installation.
192
194
</td>
193
195
</tr>
194
196
<tr>
195
<td><span class="term"><a name="GNOME-FILE-DOMAIN-DATADIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_DATADIR</code></span></td>
197
<td>
198
<span class="term"><a name="GNOME-FILE-DOMAIN-DATADIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_DATADIR</code></span></td>
196
199
<td>Data files in the main GNOME installation.
197
200
</td>
198
201
</tr>
199
202
<tr>
200
<td><span class="term"><a name="GNOME-FILE-DOMAIN-SOUND:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_SOUND</code></span></td>
203
<td>
204
<span class="term"><a name="GNOME-FILE-DOMAIN-SOUND:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_SOUND</code></span></td>
201
205
<td>Sound files in the main GNOME installation.
202
206
</td>
203
207
</tr>
204
208
<tr>
205
<td><span class="term"><a name="GNOME-FILE-DOMAIN-PIXMAP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_PIXMAP</code></span></td>
209
<td>
210
<span class="term"><a name="GNOME-FILE-DOMAIN-PIXMAP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_PIXMAP</code></span></td>
206
211
<td>Pixmap files in the main GNOME installation.
207
212
</td>
208
213
</tr>
209
214
<tr>
210
<td><span class="term"><a name="GNOME-FILE-DOMAIN-CONFIG:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_CONFIG</code></span></td>
215
<td>
216
<span class="term"><a name="GNOME-FILE-DOMAIN-CONFIG:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_CONFIG</code></span></td>
211
217
<td>Config files in the main GNOME installation.
212
218
</td>
213
219
</tr>
214
220
<tr>
215
<td><span class="term"><a name="GNOME-FILE-DOMAIN-HELP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_HELP</code></span></td>
221
<td>
222
<span class="term"><a name="GNOME-FILE-DOMAIN-HELP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_HELP</code></span></td>
216
223
<td>Help files in the main GNOME installation.
217
224
</td>
218
225
</tr>
219
226
<tr>
220
<td><span class="term"><a name="GNOME-FILE-DOMAIN-APP-LIBDIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_LIBDIR</code></span></td>
227
<td>
228
<span class="term"><a name="GNOME-FILE-DOMAIN-APP-LIBDIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_LIBDIR</code></span></td>
221
229
<td>Application specific libraries.
222
230
</td>
223
231
</tr>
224
232
<tr>
225
<td><span class="term"><a name="GNOME-FILE-DOMAIN-APP-DATADIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_DATADIR</code></span></td>
233
<td>
234
<span class="term"><a name="GNOME-FILE-DOMAIN-APP-DATADIR:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_DATADIR</code></span></td>
226
235
<td>Application specific data files.
227
236
</td>
228
237
</tr>
229
238
<tr>
230
<td><span class="term"><a name="GNOME-FILE-DOMAIN-APP-SOUND:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_SOUND</code></span></td>
239
<td>
240
<span class="term"><a name="GNOME-FILE-DOMAIN-APP-SOUND:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_SOUND</code></span></td>
231
241
<td>Application specific sound files.
232
242
</td>
233
243
</tr>
234
244
<tr>
235
<td><span class="term"><a name="GNOME-FILE-DOMAIN-APP-PIXMAP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_PIXMAP</code></span></td>
245
<td>
246
<span class="term"><a name="GNOME-FILE-DOMAIN-APP-PIXMAP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_PIXMAP</code></span></td>
236
247
<td>Application specific pixmap files.
237
248
</td>
238
249
</tr>
239
250
<tr>
240
<td><span class="term"><a name="GNOME-FILE-DOMAIN-APP-CONFIG:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_CONFIG</code></span></td>
251
<td>
252
<span class="term"><a name="GNOME-FILE-DOMAIN-APP-CONFIG:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_CONFIG</code></span></td>
241
253
<td>Application specific config files.
242
254
</td>
243
255
</tr>
244
256
<tr>
245
<td><span class="term"><a name="GNOME-FILE-DOMAIN-APP-HELP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_HELP</code></span></td>
257
<td>
258
<span class="term"><a name="GNOME-FILE-DOMAIN-APP-HELP:CAPS"></a><code class="literal">GNOME_FILE_DOMAIN_APP_HELP</code></span></td>
246
259
<td>Application specific help files.
247
260
248
261
</td>
252
265
</div>
253
266
<hr>
254
267
<div class="refsect2" lang="en">
255
<a name="id2722379"></a><h3>
268
<a name="id2523879"></a><h3>
256
269
<a name="GnomeProgram"></a>GnomeProgram</h3>
257
<a class="indexterm" name="id2722392"></a><pre class="programlisting">typedef struct {
270
<a class="indexterm" name="id2523892"></a><pre class="programlisting">typedef struct {
258
271
GObject object;
259
272
260
273
GnomeProgramPrivate *_priv;
268
281
<col align="left" valign="top">
269
282
<tbody>
270
283
<tr>
271
<td><span class="term">GObject <em class="structfield"><code>object</code></em>;</span></td>
284
<td>
285
<span class="term">GObject <em class="structfield"><code>object</code></em>;</span></td>
272
286
<td>A <span class="type">GObject</span> containing the parameters and their values which were set
273
287
dring initialisation.
274
288
</td>
275
289
</tr>
276
290
<tr>
277
<td><span class="term">GnomeProgramPrivate *<em class="structfield"><code>_priv</code></em>;</span></td>
291
<td>
292
<span class="term">GnomeProgramPrivate *<em class="structfield"><code>_priv</code></em>;</span></td>
278
293
<td>Private data about the program instance.
279
294
280
295
</td>
284
299
</div>
285
300
<hr>
286
301
<div class="refsect2" lang="en">
287
<a name="id2722476"></a><h3>
302
<a name="id2523976"></a><h3>
288
303
<a name="GnomeModuleInfo"></a>GnomeModuleInfo</h3>
289
<a class="indexterm" name="id2722493"></a><pre class="programlisting">typedef struct {
304
<a class="indexterm" name="id2523992"></a><pre class="programlisting">typedef struct {
290
305
const char *name;
291
306
const char *version;
292
307
const char *description;
296
311
GnomeModuleHook pre_args_parse, post_args_parse;
297
312
298
313
#ifdef GNOME_DISABLE_DEPRECATED
299
struct poptOption *_options;
314
void *_options;
300
315
#else
301
316
struct poptOption *options;
302
317
#endif
318
333
<col align="left" valign="top">
319
334
<tbody>
320
335
<tr>
321
<td><span class="term">const char *<em class="structfield"><code>name</code></em>;</span></td>
336
<td>
337
<span class="term">const char *<em class="structfield"><code>name</code></em>;</span></td>
322
338
<td>The module name.
323
339
</td>
324
340
</tr>
325
341
<tr>
326
<td><span class="term">const char *<em class="structfield"><code>version</code></em>;</span></td>
342
<td>
343
<span class="term">const char *<em class="structfield"><code>version</code></em>;</span></td>
327
344
<td>The module's version string.
328
345
</td>
329
346
</tr>
330
347
<tr>
331
<td><span class="term">const char *<em class="structfield"><code>description</code></em>;</span></td>
332
<td>A string describing the module (can be <a
333
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
334
><code class="literal">NULL</code></a>).
348
<td>
349
<span class="term">const char *<em class="structfield"><code>description</code></em>;</span></td>
350
<td>A string describing the module (can be <code class="literal">NULL</code>).
335
351
</td>
336
352
</tr>
337
353
<tr>
338
<td><span class="term"><a href="libgnome-gnome-program.html#GnomeModuleRequirement">GnomeModuleRequirement</a> *<em class="structfield"><code>requirements</code></em>;</span></td>
354
<td>
355
<span class="term"><a href="libgnome-gnome-program.html#GnomeModuleRequirement">GnomeModuleRequirement</a> *<em class="structfield"><code>requirements</code></em>;</span></td>
339
356
<td>A pointer to an array of modules that are required by this
340
357
module. The last module in the array should have its required_version field set
341
to <a
342
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
343
><code class="literal">NULL</code></a>.
358
to <code class="literal">NULL</code>.
344
359
</td>
345
360
</tr>
346
361
<tr>
347
<td><span class="term"><a href="libgnome-gnome-program.html#GnomeModuleHook">GnomeModuleHook</a> <em class="structfield"><code>instance_init</code></em>;</span></td>
362
<td>
363
<span class="term"><a href="libgnome-gnome-program.html#GnomeModuleHook">GnomeModuleHook</a> <em class="structfield"><code>instance_init</code></em>;</span></td>
348
364
<td>A function to call to initialise an instance of this module
349
(can be <a
350
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
351
><code class="literal">NULL</code></a>).
365
(can be <code class="literal">NULL</code>).
352
366
</td>
353
367
</tr>
354
368
<tr>
355
<td><span class="term"><a href="libgnome-gnome-program.html#GnomeModuleHook">GnomeModuleHook</a> <em class="structfield"><code>pre_args_parse</code></em>;</span></td>
369
<td>
370
<span class="term"><a href="libgnome-gnome-program.html#GnomeModuleHook">GnomeModuleHook</a> <em class="structfield"><code>pre_args_parse</code></em>;</span></td>
356
371
<td>A function to call before parsing the arguments for this
357
module (can be <a
358
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
359
><code class="literal">NULL</code></a>).
372
module (can be <code class="literal">NULL</code>).
360
373
</td>
361
374
</tr>
362
375
<tr>
363
<td><span class="term"><a href="libgnome-gnome-program.html#GnomeModuleHook">GnomeModuleHook</a> <em class="structfield"><code>post_args_parse</code></em>;</span></td>
376
<td>
377
<span class="term"><a href="libgnome-gnome-program.html#GnomeModuleHook">GnomeModuleHook</a> <em class="structfield"><code>post_args_parse</code></em>;</span></td>
364
378
<td>A function to call after parsing the arguments for this
365
module (can be <a
366
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
367
><code class="literal">NULL</code></a>).
379
module (can be <code class="literal">NULL</code>).
368
380
</td>
369
381
</tr>
370
382
<tr>
371
<td><span class="term"><a href="libgnome-gnome-program.html#GnomeModuleClassInitHook">GnomeModuleClassInitHook</a> <em class="structfield"><code>class_init</code></em>;</span></td>
383
<td>
384
<span class="term"><a href="libgnome-gnome-program.html#GnomeModuleClassInitHook">GnomeModuleClassInitHook</a> <em class="structfield"><code>class_init</code></em>;</span></td>
372
385
<td>A function to call to initialise this module prior to creating any
373
instances (can be <a
374
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
375
><code class="literal">NULL</code></a>).
386
instances (can be <code class="literal">NULL</code>).
376
387
</td>
377
388
</tr>
378
389
<tr>
379
<td><span class="term">const char *<em class="structfield"><code>opt_prefix</code></em>;</span></td>
390
<td>
391
<span class="term">const char *<em class="structfield"><code>opt_prefix</code></em>;</span></td>
380
392
<td>Unused.
381
393
</td>
382
394
</tr>
383
395
<tr>
384
<td><span class="term">GnomeModuleGetGOptionGroupFunc <em class="structfield"><code>get_goption_group_func</code></em>;</span></td>
385
<td>A function which must return a non-<a
386
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
387
><code class="literal">NULL</code></a> <span class="type">GOptionGroup</span>,
396
<td>
397
<span class="term">GnomeModuleGetGOptionGroupFunc <em class="structfield"><code>get_goption_group_func</code></em>;</span></td>
398
<td>A function which must return a non-<code class="literal">NULL</code> <span class="type">GOptionGroup</span>,
388
399
which will be added to the <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> s <span class="type">GOptionContext</span> during
389
400
#<a href="libgnome-gnome-program.html#gnome-program-init"><code class="function">gnome_program_init()</code></a>.
390
401
395
406
</div>
396
407
<hr>
397
408
<div class="refsect2" lang="en">
398
<a name="id2722860"></a><h3>
409
<a name="id2524359"></a><h3>
399
410
<a name="GnomeModuleRequirement"></a>GnomeModuleRequirement</h3>
400
<a class="indexterm" name="id2722872"></a><pre class="programlisting">typedef struct {
411
<a class="indexterm" name="id2524372"></a><pre class="programlisting">typedef struct {
401
412
const char *required_version;
402
413
const GnomeModuleInfo *module_info;
403
414
} GnomeModuleRequirement;
410
421
<col align="left" valign="top">
411
422
<tbody>
412
423
<tr>
413
<td><span class="term">const char *<em class="structfield"><code>required_version</code></em>;</span></td>
424
<td>
425
<span class="term">const char *<em class="structfield"><code>required_version</code></em>;</span></td>
414
426
<td>The version required by the parent module.
415
427
</td>
416
428
</tr>
417
429
<tr>
418
<td><span class="term">const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *<em class="structfield"><code>module_info</code></em>;</span></td>
430
<td>
431
<span class="term">const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *<em class="structfield"><code>module_info</code></em>;</span></td>
419
432
<td>A <a href="libgnome-gnome-program.html#GnomeModuleInfo"><span class="type">GnomeModuleInfo</span></a> structure detailing the required module.
420
433
421
434
</td>
425
438
</div>
426
439
<hr>
427
440
<div class="refsect2" lang="en">
428
<a name="id2722948"></a><h3>
441
<a name="id2524448"></a><h3>
429
442
<a name="GnomeModuleInitHook"></a>GnomeModuleInitHook ()</h3>
430
<a class="indexterm" name="id2722961"></a><pre class="programlisting">void (*GnomeModuleInitHook) (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *mod_info);</pre>
443
<a class="indexterm" name="id2524461"></a><pre class="programlisting">void (*GnomeModuleInitHook) (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *mod_info);</pre>
431
444
<p>
432
445
A function that will be called to allow a module to do any pre-initialisation
433
446
it might need to do prior to having arguments parsed by the controlling parent
437
450
<div class="variablelist"><table border="0">
438
451
<col align="left" valign="top">
439
452
<tbody><tr>
440
<td><span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
453
<td>
454
<span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
441
455
<td>The current module.
442
456
443
457
447
461
</div>
448
462
<hr>
449
463
<div class="refsect2" lang="en">
450
<a name="id2723012"></a><h3>
464
<a name="id2524511"></a><h3>
451
465
<a name="GnomeModuleClassInitHook"></a>GnomeModuleClassInitHook ()</h3>
452
<a class="indexterm" name="id2723025"></a><pre class="programlisting">void (*GnomeModuleClassInitHook) (GnomeProgramClass *klass,
466
<a class="indexterm" name="id2524524"></a><pre class="programlisting">void (*GnomeModuleClassInitHook) (GnomeProgramClass *klass,
453
467
const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *mod_info);</pre>
454
468
<p>
455
469
A function called to perform any class specific setup that is required by each
459
473
<col align="left" valign="top">
460
474
<tbody>
461
475
<tr>
462
<td><span class="term"><em class="parameter"><code>klass</code></em> :</span></td>
476
<td>
477
<span class="term"><em class="parameter"><code>klass</code></em> :</span></td>
463
478
<td>The class of the parent module (which could be this module's class).
464
479
This will usually be <span class="type">GnomeProgramClass</span>.
465
480
</td>
466
481
</tr>
467
482
<tr>
468
<td><span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
483
<td>
484
<span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
469
485
<td>The current module.
470
486
471
487
476
492
</div>
477
493
<hr>
478
494
<div class="refsect2" lang="en">
479
<a name="id2723105"></a><h3>
495
<a name="id2524604"></a><h3>
480
496
<a name="GnomeModuleHook"></a>GnomeModuleHook ()</h3>
481
<a class="indexterm" name="id2723117"></a><pre class="programlisting">void (*GnomeModuleHook) (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
497
<a class="indexterm" name="id2524617"></a><pre class="programlisting">void (*GnomeModuleHook) (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
482
498
<a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *mod_info);</pre>
483
499
<p>
484
500
A function that is called to perform some intialisation in a module (which
489
505
<col align="left" valign="top">
490
506
<tbody>
491
507
<tr>
492
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
508
<td>
509
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
493
510
<td>The <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> instance which is being initialised.
494
511
</td>
495
512
</tr>
496
513
<tr>
497
<td><span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
514
<td>
515
<span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
498
516
<td>The current module's <a href="libgnome-gnome-program.html#GnomeModuleInfo"><span class="type">GnomeModuleInfo</span></a> structure.
499
517
500
518
505
523
</div>
506
524
<hr>
507
525
<div class="refsect2" lang="en">
508
<a name="id2723206"></a><h3>
526
<a name="id2524706"></a><h3>
509
527
<a name="gnome-program-init"></a>gnome_program_init ()</h3>
510
<a class="indexterm" name="id2723219"></a><pre class="programlisting"><a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* gnome_program_init (const char *app_id,
528
<a class="indexterm" name="id2524719"></a><pre class="programlisting"><a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* gnome_program_init (const char *app_id,
511
529
const char *app_version,
512
530
const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *module_info,
513
531
int argc,
526
544
</p>
527
545
<p>
528
546
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
529
<a
530
href="../libgnomeui/libgnomeui-gnome-ui-init.html#LIBGNOMEUI-MODULE:CAPS"
531
><span class="type">LIBGNOMEUI_MODULE</span></a> and pulls in all the dependencies. Programs that are not
547
<span class="type">LIBGNOMEUI_MODULE</span> and pulls in all the dependencies. Programs that are not
532
548
running in setuid or setgid mode will also load modules specified in the
533
549
<em class="parameter"><code>--load-modules</code></em> and also in the <em class="parameter"><code>GNOME_MODULES</code></em> environment variable.
534
550
</p>
535
<p>
536
After setting up the module loading, this function then calls (in order)
537
<a href="libgnome-gnome-program.html#gnome-program-preinit"><code class="function">gnome_program_preinit()</code></a>, <a href="libgnome-gnome-program.html#gnome-program-parse-args"><code class="function">gnome_program_parse_args()</code></a> and
538
<a href="libgnome-gnome-program.html#gnome-program-postinit"><code class="function">gnome_program_postinit()</code></a>.
539
</p>
540
551
<p>The following example shows how one might initialise a typical program
541
552
using a goption table that is defined elsewhere.
542
553
</p>
543
554
<div class="example">
544
<a name="id2723400"></a><p class="title"><b>Example 1. Initializing a GNOME application (deprecated, using popt)</b></p>
555
<a name="id2524862"></a><p class="title"><b>Example 1. Initializing a GNOME application (deprecated, using popt)</b></p>
545
556
<pre class="programlisting">
546
557
int main(int argc, char **argv) {
547
558
GnomeProgram *my_app;
570
581
elaborate example of an option entry table):
571
582
</p>
572
583
<div class="example">
573
<a name="id2723442"></a><p class="title"><b>Example 2. Initializing a GNOME application (new, using GOption)</b></p>
584
<a name="id2524904"></a><p class="title"><b>Example 2. Initializing a GNOME application (new, using GOption)</b></p>
574
585
<pre class="programlisting">
575
586
int main(int argc, char **argv) {
576
587
gchar **remaining_args = NULL;
629
640
<col align="left" valign="top">
630
641
<tbody>
631
642
<tr>
632
<td><span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
643
<td>
644
<span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
633
645
<td> Application ID string.
634
646
</td>
635
647
</tr>
636
648
<tr>
637
<td><span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
649
<td>
650
<span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
638
651
<td> Application version string.
639
652
</td>
640
653
</tr>
641
654
<tr>
642
<td><span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
655
<td>
656
<span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
643
657
<td> The module to init with this program.
644
658
</td>
645
659
</tr>
646
660
<tr>
647
<td><span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
661
<td>
662
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
648
663
<td> The number of commmand line arguments contained in <em class="parameter"><code>argv</code></em>.
649
664
</td>
650
665
</tr>
651
666
<tr>
652
<td><span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
667
<td>
668
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
653
669
<td> A string array of command line arguments.
654
670
</td>
655
671
</tr>
656
672
<tr>
657
<td><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></td>
658
<td> The first item in a <a
659
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
660
><code class="literal">NULL</code></a>-terminated list of attribute
661
name and value pairs (so this will be an attribute name or <a
662
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
663
><code class="literal">NULL</code></a>).
673
<td>
674
<span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></td>
675
<td> The first item in a <code class="literal">NULL</code>-terminated list of attribute
676
name and value pairs (so this will be an attribute name or <code class="literal">NULL</code>).
664
677
</td>
665
678
</tr>
666
679
<tr>
667
<td><span class="term"><em class="parameter"><code>...</code></em> :</span></td>
668
<td> The continuation of a <a
669
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
670
><code class="literal">NULL</code></a>-terminated list of attribute name/value
680
<td>
681
<span class="term"><em class="parameter"><code>...</code></em> :</span></td>
682
<td> The continuation of a <code class="literal">NULL</code>-terminated list of attribute name/value
671
683
pairs.
672
684
</td>
673
685
</tr>
674
686
<tr>
675
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
687
<td>
688
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
676
689
<td> A <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> instance representing the current application.
677
690
</td>
678
691
</tr>
681
694
</div>
682
695
<hr>
683
696
<div class="refsect2" lang="en">
684
<a name="id2723674"></a><h3>
697
<a name="id2525136"></a><h3>
685
698
<a name="gnome-program-initv"></a>gnome_program_initv ()</h3>
686
<a class="indexterm" name="id2723687"></a><pre class="programlisting"><a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* gnome_program_initv (GType type,
699
<a class="indexterm" name="id2525149"></a><pre class="programlisting"><a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* gnome_program_initv (GType type,
687
700
const char *app_id,
688
701
const char *app_version,
689
702
const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *module_info,
701
714
<col align="left" valign="top">
702
715
<tbody>
703
716
<tr>
704
<td><span class="term"><em class="parameter"><code>type</code></em> :</span></td>
717
<td>
718
<span class="term"><em class="parameter"><code>type</code></em> :</span></td>
705
719
<td> The type of application to be initialized (usually
706
720
<span class="type">GNOME_TYPE_PROGRAM</span>).
707
721
</td>
708
722
</tr>
709
723
<tr>
710
<td><span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
724
<td>
725
<span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
711
726
<td> Application ID string.
712
727
</td>
713
728
</tr>
714
729
<tr>
715
<td><span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
730
<td>
731
<span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
716
732
<td> Application version string.
717
733
</td>
718
734
</tr>
719
735
<tr>
720
<td><span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
736
<td>
737
<span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
721
738
<td> The modules to init with the application.
722
739
</td>
723
740
</tr>
724
741
<tr>
725
<td><span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
742
<td>
743
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
726
744
<td> The number of command line arguments contained in <em class="parameter"><code>argv</code></em>.
727
745
</td>
728
746
</tr>
729
747
<tr>
730
<td><span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
748
<td>
749
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
731
750
<td> A string array of command line arguments.
732
751
</td>
733
752
</tr>
734
753
<tr>
735
<td><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></td>
736
<td> The first item in a <a
737
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
738
><code class="literal">NULL</code></a>-terminated list of attribute
754
<td>
755
<span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></td>
756
<td> The first item in a <code class="literal">NULL</code>-terminated list of attribute
739
757
name/value.
740
758
</td>
741
759
</tr>
742
760
<tr>
743
<td><span class="term"><em class="parameter"><code>args</code></em> :</span></td>
744
<td> The remaining elements in the <a
745
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
746
><code class="literal">NULL</code></a> terminated list (of which
761
<td>
762
<span class="term"><em class="parameter"><code>args</code></em> :</span></td>
763
<td> The remaining elements in the <code class="literal">NULL</code> terminated list (of which
747
764
<em class="parameter"><code>first_property_name</code></em> is the first element).
748
765
</td>
749
766
</tr>
750
767
<tr>
751
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
768
<td>
769
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
752
770
<td> A <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> instance representing the current application.
753
771
</td>
754
772
</tr>
757
775
</div>
758
776
<hr>
759
777
<div class="refsect2" lang="en">
760
<a name="id2723966"></a><h3>
778
<a name="id2525428"></a><h3>
761
779
<a name="gnome-program-get"></a>gnome_program_get ()</h3>
762
<a class="indexterm" name="id2723979"></a><pre class="programlisting"><a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* gnome_program_get (void);</pre>
780
<a class="indexterm" name="id2525441"></a><pre class="programlisting"><a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a>* gnome_program_get (void);</pre>
763
781
<p>
764
782
Retrieves an object that stored information about the application's state.
765
783
Other functions assume this will always return a <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> object which
766
(if not <a
767
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
768
><code class="literal">NULL</code></a>) has already been initialized.</p>
784
(if not <code class="literal">NULL</code>) has already been initialized.</p>
769
785
<p>
770
786
771
787
</p>
772
788
<div class="variablelist"><table border="0">
773
789
<col align="left" valign="top">
774
790
<tbody><tr>
775
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
776
<td> The application's <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> instance, or <a
777
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
778
><code class="literal">NULL</code></a> if it does not
791
<td>
792
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
793
<td> The application's <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> instance, or <code class="literal">NULL</code> if it does not
779
794
exist.
780
795
</td>
781
796
</tr></tbody>
783
798
</div>
784
799
<hr>
785
800
<div class="refsect2" lang="en">
786
<a name="id2724059"></a><h3>
801
<a name="id2525521"></a><h3>
787
802
<a name="gnome-program-get-human-readable-name"></a>gnome_program_get_human_readable_name ()</h3>
788
<a class="indexterm" name="id2724073"></a><pre class="programlisting">const char* gnome_program_get_human_readable_name
803
<a class="indexterm" name="id2525535"></a><pre class="programlisting">const char* gnome_program_get_human_readable_name
789
804
(<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
790
805
<p>
791
806
This function returns a pointer to a static string that the
792
807
application has provided as a human readable name. The app
793
808
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>
794
init argument. Returns <a
795
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
796
><code class="literal">NULL</code></a> if no name was set.</p>
809
init argument. Returns <code class="literal">NULL</code> if no name was set.</p>
797
810
<p>
798
811
799
812
</p>
801
814
<col align="left" valign="top">
802
815
<tbody>
803
816
<tr>
804
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
817
<td>
818
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
805
819
<td> The application object
806
820
</td>
807
821
</tr>
808
822
<tr>
809
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
823
<td>
824
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
810
825
<td> Application human-readable name string.
811
826
</td>
812
827
</tr>
815
830
</div>
816
831
<hr>
817
832
<div class="refsect2" lang="en">
818
<a name="id2724159"></a><h3>
833
<a name="id2525621"></a><h3>
819
834
<a name="gnome-program-get-app-id"></a>gnome_program_get_app_id ()</h3>
820
<a class="indexterm" name="id2724172"></a><pre class="programlisting">const char* gnome_program_get_app_id (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
835
<a class="indexterm" name="id2525634"></a><pre class="programlisting">const char* gnome_program_get_app_id (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
821
836
<p>
822
837
This function returns a pointer to a static string that the
823
838
application has provided as an identifier. This is not meant as a
830
845
<col align="left" valign="top">
831
846
<tbody>
832
847
<tr>
833
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
848
<td>
849
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
834
850
<td> The program object
835
851
</td>
836
852
</tr>
837
853
<tr>
838
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
854
<td>
855
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
839
856
<td> Application ID string.
840
857
</td>
841
858
</tr>
844
861
</div>
845
862
<hr>
846
863
<div class="refsect2" lang="en">
847
<a name="id2724238"></a><h3>
864
<a name="id2525700"></a><h3>
848
865
<a name="gnome-program-get-app-version"></a>gnome_program_get_app_version ()</h3>
849
<a class="indexterm" name="id2724251"></a><pre class="programlisting">const char* gnome_program_get_app_version (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
866
<a class="indexterm" name="id2525713"></a><pre class="programlisting">const char* gnome_program_get_app_version (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
850
867
<p>
851
868
This function returns a pointer to a static string that the
852
869
application has provided as a version number. This is not meant as a
859
876
<col align="left" valign="top">
860
877
<tbody>
861
878
<tr>
862
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
879
<td>
880
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
863
881
<td> The application object
864
882
</td>
865
883
</tr>
866
884
<tr>
867
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
885
<td>
886
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
868
887
<td> Application version string.
869
888
</td>
870
889
</tr>
873
892
</div>
874
893
<hr>
875
894
<div class="refsect2" lang="en">
876
<a name="id2724317"></a><h3>
895
<a name="id2525779"></a><h3>
877
896
<a name="gnome-program-locate-file"></a>gnome_program_locate_file ()</h3>
878
<a class="indexterm" name="id2724330"></a><pre class="programlisting">gchar* gnome_program_locate_file (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
897
<a class="indexterm" name="id2525792"></a><pre class="programlisting">gchar* gnome_program_locate_file (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
879
898
<a href="libgnome-gnome-program.html#GnomeFileDomain">GnomeFileDomain</a> domain,
880
899
const gchar *file_name,
881
900
gboolean only_if_exists,
886
905
For example, common domains are "libdir", "pixmap", and "config".
887
906
</p>
888
907
<p>
889
If <em class="parameter"><code>ret_locations</code></em> is <a
890
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
891
><code class="literal">NULL</code></a>, only one pathname is returned. Otherwise,
908
If <em class="parameter"><code>ret_locations</code></em> is <code class="literal">NULL</code>, only one pathname is returned. Otherwise,
892
909
alternative paths are returned in <em class="parameter"><code>ret_locations</code></em>.
893
910
</p>
894
911
<p>
907
924
<col align="left" valign="top">
908
925
<tbody>
909
926
<tr>
910
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
911
<td> A valid <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> object or <a
912
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
913
><code class="literal">NULL</code></a> (in which case the current
927
<td>
928
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
929
<td> A valid <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> object or <code class="literal">NULL</code> (in which case the current
914
930
application is used).
915
931
</td>
916
932
</tr>
917
933
<tr>
918
<td><span class="term"><em class="parameter"><code>domain</code></em> :</span></td>
934
<td>
935
<span class="term"><em class="parameter"><code>domain</code></em> :</span></td>
919
936
<td> A <a href="libgnome-gnome-program.html#GnomeFileDomain"><span class="type">GnomeFileDomain</span></a>.
920
937
</td>
921
938
</tr>
922
939
<tr>
923
<td><span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
940
<td>
941
<span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
924
942
<td> A file name or path inside the 'domain' to find.
925
943
</td>
926
944
</tr>
927
945
<tr>
928
<td><span class="term"><em class="parameter"><code>only_if_exists</code></em> :</span></td>
946
<td>
947
<span class="term"><em class="parameter"><code>only_if_exists</code></em> :</span></td>
929
948
<td> Only return a full pathname if the specified file
930
949
actually exists
931
950
</td>
932
951
</tr>
933
952
<tr>
934
<td><span class="term"><em class="parameter"><code>ret_locations</code></em> :</span></td>
935
<td> If this is not <a
936
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
937
><code class="literal">NULL</code></a>, a list of all the possible locations
953
<td>
954
<span class="term"><em class="parameter"><code>ret_locations</code></em> :</span></td>
955
<td> If this is not <code class="literal">NULL</code>, a list of all the possible locations
938
956
of the file will be returned.
939
957
</td>
940
958
</tr>
941
959
<tr>
942
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
960
<td>
961
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
943
962
<td> The full path to the file (if it exists or only_if_exists is
944
<code class="literal">FALSE</code>) or <a
945
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
946
><code class="literal">NULL</code></a>.
963
<code class="literal">FALSE</code>) or <code class="literal">NULL</code>.
947
964
</td>
948
965
</tr>
949
966
</tbody>
951
968
</div>
952
969
<hr>
953
970
<div class="refsect2" lang="en">
954
<a name="id2724602"></a><h3>
971
<a name="id2526064"></a><h3>
955
972
<a name="gnome-program-module-register"></a>gnome_program_module_register ()</h3>
956
<a class="indexterm" name="id2724615"></a><pre class="programlisting">void gnome_program_module_register (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *module_info);</pre>
973
<a class="indexterm" name="id2526077"></a><pre class="programlisting">void gnome_program_module_register (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *module_info);</pre>
957
974
<p>
958
975
This function is used to register a module to be initialized by the
959
976
GNOME library framework. The memory pointed to by <em class="parameter"><code>module_info</code></em> must be
966
983
<div class="variablelist"><table border="0">
967
984
<col align="left" valign="top">
968
985
<tbody><tr>
969
<td><span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
986
<td>
987
<span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
970
988
<td> A pointer to a GnomeModuleInfo structure describing the module
971
989
to be initialized
972
990
</td>
975
993
</div>
976
994
<hr>
977
995
<div class="refsect2" lang="en">
978
<a name="id2724689"></a><h3>
996
<a name="id2526151"></a><h3>
979
997
<a name="gnome-program-module-registered"></a>gnome_program_module_registered ()</h3>
980
<a class="indexterm" name="id2724702"></a><pre class="programlisting">gboolean gnome_program_module_registered (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *module_info);</pre>
998
<a class="indexterm" name="id2526164"></a><pre class="programlisting">gboolean gnome_program_module_registered (const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a> *module_info);</pre>
981
999
<p>
982
1000
This method checks to see whether a specific module has been
983
1001
initialized in the specified program.</p>
988
1006
<col align="left" valign="top">
989
1007
<tbody>
990
1008
<tr>
991
<td><span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
1009
<td>
1010
<span class="term"><em class="parameter"><code>module_info</code></em> :</span></td>
992
1011
<td> A pointer to a GnomeModuleInfo structure describing the module
993
1012
to be queried
994
1013
</td>
995
1014
</tr>
996
1015
<tr>
997
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1016
<td>
1017
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
998
1018
<td> A value indicating whether the specified module has been
999
1019
registered/initialized in the current program
1000
1020
</td>
1004
1024
</div>
1005
1025
<hr>
1006
1026
<div class="refsect2" lang="en">
1007
<a name="id2724768"></a><h3>
1027
<a name="id2526230"></a><h3>
1008
1028
<a name="gnome-program-module-load"></a>gnome_program_module_load ()</h3>
1009
<a class="indexterm" name="id2724782"></a><pre class="programlisting">const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a>* gnome_program_module_load
1029
<a class="indexterm" name="id2526244"></a><pre class="programlisting">const <a href="libgnome-gnome-program.html#GnomeModuleInfo">GnomeModuleInfo</a>* gnome_program_module_load
1010
1030
(const char *mod_name);</pre>
1011
1031
<p>
1012
1032
Loads a shared library that contains a
1018
1038
<col align="left" valign="top">
1019
1039
<tbody>
1020
1040
<tr>
1021
<td><span class="term"><em class="parameter"><code>mod_name</code></em> :</span></td>
1041
<td>
1042
<span class="term"><em class="parameter"><code>mod_name</code></em> :</span></td>
1022
1043
<td> module name
1023
1044
</td>
1024
1045
</tr>
1025
1046
<tr>
1026
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1027
<td> The <a href="libgnome-gnome-program.html#GnomeModuleInfo"><span class="type">GnomeModuleInfo</span></a> structure that was loaded, or <a
1028
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
1029
><code class="literal">NULL</code></a> if the
1047
<td>
1048
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1049
<td> The <a href="libgnome-gnome-program.html#GnomeModuleInfo"><span class="type">GnomeModuleInfo</span></a> structure that was loaded, or <code class="literal">NULL</code> if the
1030
1050
module could not be loaded.
1031
1051
</td>
1032
1052
</tr>
1035
1055
</div>
1036
1056
<hr>
1037
1057
<div class="refsect2" lang="en">
1038
<a name="id2724873"></a><h3>
1058
<a name="id2526335"></a><h3>
1039
1059
<a name="gnome-program-install-property"></a>gnome_program_install_property ()</h3>
1040
<a class="indexterm" name="id2724887"></a><pre class="programlisting">guint gnome_program_install_property (GnomeProgramClass *pclass,
1060
<a class="indexterm" name="id2526349"></a><pre class="programlisting">guint gnome_program_install_property (GnomeProgramClass *pclass,
1041
1061
GObjectGetPropertyFunc get_fn,
1042
1062
GObjectSetPropertyFunc set_fn,
1043
1063
GParamSpec *pspec);</pre>
1055
1075
<col align="left" valign="top">
1056
1076
<tbody>
1057
1077
<tr>
1058
<td><span class="term"><em class="parameter"><code>pclass</code></em> :</span></td>
1078
<td>
1079
<span class="term"><em class="parameter"><code>pclass</code></em> :</span></td>
1059
1080
<td> A <span class="type">GnomeProgramClass</span>.
1060
1081
</td>
1061
1082
</tr>
1062
1083
<tr>
1063
<td><span class="term"><em class="parameter"><code>get_fn</code></em> :</span></td>
1084
<td>
1085
<span class="term"><em class="parameter"><code>get_fn</code></em> :</span></td>
1064
1086
<td> A function to get property values.
1065
1087
</td>
1066
1088
</tr>
1067
1089
<tr>
1068
<td><span class="term"><em class="parameter"><code>set_fn</code></em> :</span></td>
1090
<td>
1091
<span class="term"><em class="parameter"><code>set_fn</code></em> :</span></td>
1069
1092
<td> A function to set property values.
1070
1093
</td>
1071
1094
</tr>
1072
1095
<tr>
1073
<td><span class="term"><em class="parameter"><code>pspec</code></em> :</span></td>
1096
<td>
1097
<span class="term"><em class="parameter"><code>pspec</code></em> :</span></td>
1074
1098
<td> A collection of properties.
1075
1099
</td>
1076
1100
</tr>
1077
1101
<tr>
1078
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1102
<td>
1103
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1079
1104
<td> The number of properties installed.
1080
1105
</td>
1081
1106
</tr>
1084
1109
</div>
1085
1110
<hr>
1086
1111
<div class="refsect2" lang="en">
1087
<a name="id2725030"></a><h3>
1112
<a name="id2526492"></a><h3>
1088
1113
<a name="gnome-program-preinit"></a>gnome_program_preinit ()</h3>
1089
<a class="indexterm" name="id2725043"></a><pre class="programlisting">poptContext gnome_program_preinit (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
1114
<a class="indexterm" name="id2526508"></a><pre class="programlisting">poptContext gnome_program_preinit (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
1090
1115
const char *app_id,
1091
1116
const char *app_version,
1092
1117
int argc,
1093
1118
char **argv);</pre>
1119
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1120
<h3 class="title">Warning</h3>
1121
<p><code class="literal">gnome_program_preinit</code> has been deprecated since version 2.18 and should not be used in newly-written code. Use <a href="libgnome-gnome-program.html#gnome-program-init"><code class="function">gnome_program_init()</code></a> instead.</p>
1122
</div>
1094
1123
<p>
1095
1124
This function performs the portion of application initialization that
1096
1125
needs to be done prior to command line argument parsing. The poptContext
1102
1131
<col align="left" valign="top">
1103
1132
<tbody>
1104
1133
<tr>
1105
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
1134
<td>
1135
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
1106
1136
<td> Application object
1107
1137
</td>
1108
1138
</tr>
1109
1139
<tr>
1110
<td><span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
1140
<td>
1141
<span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
1111
1142
<td> application ID string
1112
1143
</td>
1113
1144
</tr>
1114
1145
<tr>
1115
<td><span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
1146
<td>
1147
<span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
1116
1148
<td> application version string
1117
1149
</td>
1118
1150
</tr>
1119
1151
<tr>
1120
<td><span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
1152
<td>
1153
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
1121
1154
<td> The number of commmand line arguments contained in 'argv'
1122
1155
</td>
1123
1156
</tr>
1124
1157
<tr>
1125
<td><span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
1158
<td>
1159
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
1126
1160
<td> A string array of command line arguments
1127
1161
</td>
1128
1162
</tr>
1129
1163
<tr>
1130
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1164
<td>
1165
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1131
1166
<td> A poptContext representing the argument parsing state,
1132
or <a
1133
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
1134
><code class="literal">NULL</code></a> if using GOption argument parsing.
1167
or <code class="literal">NULL</code> if using GOption argument parsing.
1135
1168
</td>
1136
1169
</tr>
1137
1170
</tbody>
1139
1172
</div>
1140
1173
<hr>
1141
1174
<div class="refsect2" lang="en">
1142
<a name="id2725217"></a><h3>
1175
<a name="id2526706"></a><h3>
1143
1176
<a name="gnome-program-parse-args"></a>gnome_program_parse_args ()</h3>
1144
<a class="indexterm" name="id2725230"></a><pre class="programlisting">void gnome_program_parse_args (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
1177
<a class="indexterm" name="id2526722"></a><pre class="programlisting">void gnome_program_parse_args (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
1178
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1179
<h3 class="title">Warning</h3>
1180
<p><code class="literal">gnome_program_parse_args</code> has been deprecated since version 2.18 and should not be used in newly-written code. Use <a href="libgnome-gnome-program.html#gnome-program-init"><code class="function">gnome_program_init()</code></a> instead.</p>
1181
</div>
1145
1182
<p>
1146
1183
Parses the command line arguments for the application</p>
1147
1184
<p>
1150
1187
<div class="variablelist"><table border="0">
1151
1188
<col align="left" valign="top">
1152
1189
<tbody><tr>
1153
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
1190
<td>
1191
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
1154
1192
<td> Application object
1155
1193
</td>
1156
1194
</tr></tbody>
1158
1196
</div>
1159
1197
<hr>
1160
1198
<div class="refsect2" lang="en">
1161
<a name="id2725281"></a><h3>
1199
<a name="id2526797"></a><h3>
1162
1200
<a name="gnome-program-postinit"></a>gnome_program_postinit ()</h3>
1163
<a class="indexterm" name="id2725294"></a><pre class="programlisting">void gnome_program_postinit (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
1201
<a class="indexterm" name="id2526813"></a><pre class="programlisting">void gnome_program_postinit (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program);</pre>
1202
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1203
<h3 class="title">Warning</h3>
1204
<p><code class="literal">gnome_program_postinit</code> has been deprecated since version 2.18 and should not be used in newly-written code. Use <a href="libgnome-gnome-program.html#gnome-program-init"><code class="function">gnome_program_init()</code></a> instead.</p>
1205
</div>
1164
1206
<p>
1165
1207
Called after <a href="libgnome-gnome-program.html#gnome-program-parse-args"><code class="function">gnome_program_parse_args()</code></a>, this function
1166
1208
takes care of post-parse initialization and cleanup</p>
1170
1212
<div class="variablelist"><table border="0">
1171
1213
<col align="left" valign="top">
1172
1214
<tbody><tr>
1173
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
1215
<td>
1216
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
1174
1217
<td> Application object
1175
1218
</td>
1176
1219
</tr></tbody>
1178
1221
</div>
1179
1222
<hr>
1180
1223
<div class="refsect2" lang="en">
1181
<a name="id2725357"></a><h3>
1224
<a name="id2526899"></a><h3>
1182
1225
<a name="GNOME-PARAM-POPT-TABLE:CAPS"></a>GNOME_PARAM_POPT_TABLE</h3>
1183
<a class="indexterm" name="id2725372"></a><pre class="programlisting">#define GNOME_PARAM_POPT_TABLE "popt-table"
1226
<a class="indexterm" name="id2526914"></a><pre class="programlisting">#define GNOME_PARAM_POPT_TABLE "popt-table"
1184
1227
</pre>
1185
1228
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1186
1229
<h3 class="title">Warning</h3>
1195
1238
</div>
1196
1239
<hr>
1197
1240
<div class="refsect2" lang="en">
1198
<a name="id2725422"></a><h3>
1241
<a name="id2526964"></a><h3>
1199
1242
<a name="GNOME-PARAM-POPT-FLAGS:CAPS"></a>GNOME_PARAM_POPT_FLAGS</h3>
1200
<a class="indexterm" name="id2725438"></a><pre class="programlisting">#define GNOME_PARAM_POPT_FLAGS "popt-flags"
1243
<a class="indexterm" name="id2526980"></a><pre class="programlisting">#define GNOME_PARAM_POPT_FLAGS "popt-flags"
1201
1244
</pre>
1202
1245
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1203
1246
<h3 class="title">Warning</h3>
1209
1252
</div>
1210
1253
<hr>
1211
1254
<div class="refsect2" lang="en">
1212
<a name="id2725468"></a><h3>
1255
<a name="id2527011"></a><h3>
1213
1256
<a name="GNOME-PARAM-POPT-CONTEXT:CAPS"></a>GNOME_PARAM_POPT_CONTEXT</h3>
1214
<a class="indexterm" name="id2725484"></a><pre class="programlisting">#define GNOME_PARAM_POPT_CONTEXT "popt-context"
1257
<a class="indexterm" name="id2527027"></a><pre class="programlisting">#define GNOME_PARAM_POPT_CONTEXT "popt-context"
1215
1258
</pre>
1216
1259
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1217
1260
<h3 class="title">Warning</h3>
1224
1267
</div>
1225
1268
<hr>
1226
1269
<div class="refsect2" lang="en">
1227
<a name="id2725523"></a><h3>
1270
<a name="id2527066"></a><h3>
1228
1271
<a name="GNOME-PARAM-GOPTION-CONTEXT:CAPS"></a>GNOME_PARAM_GOPTION_CONTEXT</h3>
1229
<a class="indexterm" name="id2725539"></a><pre class="programlisting">#define GNOME_PARAM_GOPTION_CONTEXT "goption-context"
1272
<a class="indexterm" name="id2527081"></a><pre class="programlisting">#define GNOME_PARAM_GOPTION_CONTEXT "goption-context"
1230
1273
</pre>
1231
1274
<p>
1232
1275
This parameter contains the GOptionContext pointer that <a href="libgnome-gnome-program.html#GnomeProgram"><span class="type">GnomeProgram</span></a> is using for
1234
1277
passed <span class="type">GOptionContext</span>.
1235
1278
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.
1236
1279
</p>
1237
<p class="since">Since 2.14
1280
<p>Since 2.14
1238
1281
1239
1282
1240
1283
</p>
1241
1284
</div>
1242
1285
<hr>
1243
1286
<div class="refsect2" lang="en">
1244
<a name="id2725599"></a><h3>
1287
<a name="id2527139"></a><h3>
1245
1288
<a name="GNOME-PARAM-CREATE-DIRECTORIES:CAPS"></a>GNOME_PARAM_CREATE_DIRECTORIES</h3>
1246
<a class="indexterm" name="id2725611"></a><pre class="programlisting">#define GNOME_PARAM_CREATE_DIRECTORIES "create-directories"
1289
<a class="indexterm" name="id2527151"></a><pre class="programlisting">#define GNOME_PARAM_CREATE_DIRECTORIES "create-directories"
1247
1290
</pre>
1248
1291
<p>
1249
1292
This parameter contains <code class="literal">TRUE</code> if the standard GNOME directories should be
1252
1295
</div>
1253
1296
<hr>
1254
1297
<div class="refsect2" lang="en">
1255
<a name="id2725640"></a><h3>
1298
<a name="id2527180"></a><h3>
1256
1299
<a name="GNOME-PARAM-ENABLE-SOUND:CAPS"></a>GNOME_PARAM_ENABLE_SOUND</h3>
1257
<a class="indexterm" name="id2725654"></a><pre class="programlisting">#define GNOME_PARAM_ENABLE_SOUND "enable-sound"
1300
<a class="indexterm" name="id2527194"></a><pre class="programlisting">#define GNOME_PARAM_ENABLE_SOUND "enable-sound"
1258
1301
</pre>
1259
1302
<p>
1260
1303
This parameter determines whether or not to enable sound on startup.
1262
1305
</div>
1263
1306
<hr>
1264
1307
<div class="refsect2" lang="en">
1265
<a name="id2725671"></a><h3>
1308
<a name="id2527211"></a><h3>
1266
1309
<a name="GNOME-PARAM-ESPEAKER:CAPS"></a>GNOME_PARAM_ESPEAKER</h3>
1267
<a class="indexterm" name="id2725684"></a><pre class="programlisting">#define GNOME_PARAM_ESPEAKER "espeaker"
1310
<a class="indexterm" name="id2527224"></a><pre class="programlisting">#define GNOME_PARAM_ESPEAKER "espeaker"
1268
1311
</pre>
1269
1312
<p>
1270
1313
This parameter describes how to connect to esd.
1272
1315
</div>
1273
1316
<hr>
1274
1317
<div class="refsect2" lang="en">
1275
<a name="id2725700"></a><h3>
1318
<a name="id2527240"></a><h3>
1276
1319
<a name="GNOME-PARAM-APP-ID:CAPS"></a>GNOME_PARAM_APP_ID</h3>
1277
<a class="indexterm" name="id2725713"></a><pre class="programlisting">#define GNOME_PARAM_APP_ID "app-id"
1320
<a class="indexterm" name="id2527253"></a><pre class="programlisting">#define GNOME_PARAM_APP_ID "app-id"
1278
1321
</pre>
1279
1322
<p>
1280
1323
This parameter contains the ID string to use for the application (readable).
1282
1325
</div>
1283
1326
<hr>
1284
1327
<div class="refsect2" lang="en">
1285
<a name="id2725730"></a><h3>
1328
<a name="id2527270"></a><h3>
1286
1329
<a name="GNOME-PARAM-APP-VERSION:CAPS"></a>GNOME_PARAM_APP_VERSION</h3>
1287
<a class="indexterm" name="id2725743"></a><pre class="programlisting">#define GNOME_PARAM_APP_VERSION "app-version"
1330
<a class="indexterm" name="id2527283"></a><pre class="programlisting">#define GNOME_PARAM_APP_VERSION "app-version"
1288
1331
</pre>
1289
1332
<p>
1290
1333
This parameter contains the application version (readable).
1292
1335
</div>
1293
1336
<hr>
1294
1337
<div class="refsect2" lang="en">
1295
<a name="id2725760"></a><h3>
1338
<a name="id2527300"></a><h3>
1296
1339
<a name="GNOME-PARAM-GNOME-PREFIX:CAPS"></a>GNOME_PARAM_GNOME_PREFIX</h3>
1297
<a class="indexterm" name="id2725773"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_PREFIX "gnome-prefix"
1340
<a class="indexterm" name="id2527313"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_PREFIX "gnome-prefix"
1298
1341
</pre>
1299
1342
<p>
1300
1343
This parameter contains the prefix where the main GNOME system is installed
1303
1346
</div>
1304
1347
<hr>
1305
1348
<div class="refsect2" lang="en">
1306
<a name="id2725791"></a><h3>
1349
<a name="id2527331"></a><h3>
1307
1350
<a name="GNOME-PARAM-GNOME-SYSCONFDIR:CAPS"></a>GNOME_PARAM_GNOME_SYSCONFDIR</h3>
1308
<a class="indexterm" name="id2725804"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_SYSCONFDIR "gnome-sysconfdir"
1351
<a class="indexterm" name="id2527344"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_SYSCONFDIR "gnome-sysconfdir"
1309
1352
</pre>
1310
1353
<p>
1311
1354
This parameter contains the prefix where the GNOME configuration files
1314
1357
</div>
1315
1358
<hr>
1316
1359
<div class="refsect2" lang="en">
1317
<a name="id2725822"></a><h3>
1360
<a name="id2527362"></a><h3>
1318
1361
<a name="GNOME-PARAM-GNOME-DATADIR:CAPS"></a>GNOME_PARAM_GNOME_DATADIR</h3>
1319
<a class="indexterm" name="id2725835"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_DATADIR "gnome-datadir"
1362
<a class="indexterm" name="id2527375"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_DATADIR "gnome-datadir"
1320
1363
</pre>
1321
1364
<p>
1322
1365
This parameter contains the prefix where the GNOME data files are installed
1325
1368
</div>
1326
1369
<hr>
1327
1370
<div class="refsect2" lang="en">
1328
<a name="id2725853"></a><h3>
1371
<a name="id2527393"></a><h3>
1329
1372
<a name="GNOME-PARAM-GNOME-LIBDIR:CAPS"></a>GNOME_PARAM_GNOME_LIBDIR</h3>
1330
<a class="indexterm" name="id2725866"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_LIBDIR "gnome-libdir"
1373
<a class="indexterm" name="id2527406"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_LIBDIR "gnome-libdir"
1331
1374
</pre>
1332
1375
<p>
1333
1376
This parameter contains the prefix where the GNOME library files are installed
1336
1379
</div>
1337
1380
<hr>
1338
1381
<div class="refsect2" lang="en">
1339
<a name="id2725884"></a><h3>
1382
<a name="id2527424"></a><h3>
1340
1383
<a name="GNOME-PARAM-APP-PREFIX:CAPS"></a>GNOME_PARAM_APP_PREFIX</h3>
1341
<a class="indexterm" name="id2725897"></a><pre class="programlisting">#define GNOME_PARAM_APP_PREFIX "app-prefix"
1384
<a class="indexterm" name="id2527437"></a><pre class="programlisting">#define GNOME_PARAM_APP_PREFIX "app-prefix"
1342
1385
</pre>
1343
1386
<p>
1344
1387
This parameter contains the prefix where this application was installed
1347
1390
</div>
1348
1391
<hr>
1349
1392
<div class="refsect2" lang="en">
1350
<a name="id2725914"></a><h3>
1393
<a name="id2527454"></a><h3>
1351
1394
<a name="GNOME-PARAM-APP-SYSCONFDIR:CAPS"></a>GNOME_PARAM_APP_SYSCONFDIR</h3>
1352
<a class="indexterm" name="id2725928"></a><pre class="programlisting">#define GNOME_PARAM_APP_SYSCONFDIR "app-sysconfdir"
1395
<a class="indexterm" name="id2527468"></a><pre class="programlisting">#define GNOME_PARAM_APP_SYSCONFDIR "app-sysconfdir"
1353
1396
</pre>
1354
1397
<p>
1355
1398
This parameter contains the prefix where this application's configuration files
1358
1401
</div>
1359
1402
<hr>
1360
1403
<div class="refsect2" lang="en">
1361
<a name="id2725945"></a><h3>
1404
<a name="id2527485"></a><h3>
1362
1405
<a name="GNOME-PARAM-APP-DATADIR:CAPS"></a>GNOME_PARAM_APP_DATADIR</h3>
1363
<a class="indexterm" name="id2725958"></a><pre class="programlisting">#define GNOME_PARAM_APP_DATADIR "app-datadir"
1406
<a class="indexterm" name="id2527498"></a><pre class="programlisting">#define GNOME_PARAM_APP_DATADIR "app-datadir"
1364
1407
</pre>
1365
1408
<p>
1366
1409
This parameter contains the prefix where this application's data files are
1369
1412
</div>
1370
1413
<hr>
1371
1414
<div class="refsect2" lang="en">
1372
<a name="id2725976"></a><h3>
1415
<a name="id2527516"></a><h3>
1373
1416
<a name="GNOME-PARAM-APP-LIBDIR:CAPS"></a>GNOME_PARAM_APP_LIBDIR</h3>
1374
<a class="indexterm" name="id2725990"></a><pre class="programlisting">#define GNOME_PARAM_APP_LIBDIR "app-libdir"
1417
<a class="indexterm" name="id2527530"></a><pre class="programlisting">#define GNOME_PARAM_APP_LIBDIR "app-libdir"
1375
1418
</pre>
1376
1419
<p>
1377
1420
This parameter contains the prefix where this application's library files are
1380
1423
</div>
1381
1424
<hr>
1382
1425
<div class="refsect2" lang="en">
1383
<a name="id2726007"></a><h3>
1426
<a name="id2527547"></a><h3>
1384
1427
<a name="GNOME-PARAM-HUMAN-READABLE-NAME:CAPS"></a>GNOME_PARAM_HUMAN_READABLE_NAME</h3>
1385
<a class="indexterm" name="id2726021"></a><pre class="programlisting">#define GNOME_PARAM_HUMAN_READABLE_NAME "human-readable-name"
1428
<a class="indexterm" name="id2527561"></a><pre class="programlisting">#define GNOME_PARAM_HUMAN_READABLE_NAME "human-readable-name"
1386
1429
</pre>
1387
1430
<p>
1388
1431
This parameter contains the human readable name of the application (readable).
1390
1433
</div>
1391
1434
<hr>
1392
1435
<div class="refsect2" lang="en">
1393
<a name="id2726038"></a><h3>
1436
<a name="id2527578"></a><h3>
1394
1437
<a name="GNOME-PARAM-GNOME-PATH:CAPS"></a>GNOME_PARAM_GNOME_PATH</h3>
1395
<a class="indexterm" name="id2726051"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_PATH "gnome-path"
1438
<a class="indexterm" name="id2527591"></a><pre class="programlisting">#define GNOME_PARAM_GNOME_PATH "gnome-path"
1396
1439
</pre>
1397
1440
<p>
1398
1441
This parameter contains the path in which to look for installed files (taken
1401
1444
</div>
1402
1445
<hr>
1403
1446
<div class="refsect2" lang="en">
1404
<a name="id2726069"></a><h3>
1447
<a name="id2527609"></a><h3>
1405
1448
<a name="GNOME-PARAM-NONE:CAPS"></a>GNOME_PARAM_NONE</h3>
1406
<a class="indexterm" name="id2726082"></a><pre class="programlisting">#define GNOME_PARAM_NONE NULL
1449
<a class="indexterm" name="id2527622"></a><pre class="programlisting">#define GNOME_PARAM_NONE NULL
1407
1450
</pre>
1408
1451
<p>
1409
1452
Used to terminate a list of parameters and their values.
1411
1454
</div>
1412
1455
<hr>
1413
1456
<div class="refsect2" lang="en">
1414
<a name="id2726099"></a><h3>
1457
<a name="id2527639"></a><h3>
1415
1458
<a name="GNOME-PROGRAM-STANDARD-PROPERTIES:CAPS"></a>GNOME_PROGRAM_STANDARD_PROPERTIES</h3>
1416
<a class="indexterm" name="id2726113"></a><pre class="programlisting">#define GNOME_PROGRAM_STANDARD_PROPERTIES</pre>
1459
<a class="indexterm" name="id2527653"></a><pre class="programlisting">#define GNOME_PROGRAM_STANDARD_PROPERTIES</pre>
1417
1460
<p>
1418
1461
When PREFIX, SYSCONFDIR, DATADIR and LIBDIR are defined during the build
1419
1462
process, this macro can be used to assign these values to
Loggerhead is a web-based interface for Breezy
Version: 2.0.1