File: //usr/share/gtk-doc/html/libgnomeui/libgnomeui-gnome-ui-init.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gnome-ui-init</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="ch01.html#initialization" title="Initialization and session management">
<link rel="prev" href="ch01.html" title="GNOME UI Library (libgnomeui)">
<link rel="next" href="GnomeClient.html" title="GnomeClient">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="GNOME UI Library (libgnomeui)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html#initialization"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME UI Library Reference Manual</th>
<td><a accesskey="n" href="GnomeClient.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2896673" class="shortcut">Top</a>
 | 
<a href="#id2861404" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgnomeui-gnome-ui-init"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2896673"></a><span class="refentrytitle">gnome-ui-init</span>
</h2>
<p>gnome-ui-init — Parameters (and deprecated functions) for initializing libgnomeui applications.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
#define <a href="libgnomeui-gnome-ui-init.html#LIBGNOMEUI-MODULE:CAPS">LIBGNOMEUI_MODULE</a>
#define <a href="libgnomeui-gnome-ui-init.html#LIBGNOMEUI-PARAM-CRASH-DIALOG:CAPS">LIBGNOMEUI_PARAM_CRASH_DIALOG</a>
#define <a href="libgnomeui-gnome-ui-init.html#LIBGNOMEUI-PARAM-DISPLAY:CAPS">LIBGNOMEUI_PARAM_DISPLAY</a>
#define <a href="libgnomeui-gnome-ui-init.html#LIBGNOMEUI-PARAM-DEFAULT-ICON:CAPS">LIBGNOMEUI_PARAM_DEFAULT_ICON</a>
int <a href="libgnomeui-gnome-ui-init.html#gnome-init-with-popt-table">gnome_init_with_popt_table</a> (const char *app_id,
const char *app_version,
int argc,
char **argv,
const struct poptOption *options,
int flags,
poptContext *return_ctx);
#define <a href="libgnomeui-gnome-ui-init.html#gnome-init">gnome_init</a> (app_id,app_version,argc,argv)
const <a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#GnomeModuleInfo"
>GnomeModuleInfo</a>* <a href="libgnomeui-gnome-ui-init.html#gnome-gtk-module-info-get">gnome_gtk_module_info_get</a>
(void);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2861404"></a><h2>Description</h2>
<p>
The initialization functions in this module are deprecated in favour of calls
to <a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#gnome-program-init"
><code class="function">gnome_program_init()</code></a> in the libgnome library.
</p>
<p>
However, this module does provide some extra parameters on top of those already
defined in libgnome that can be passed to the <a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#gnome-program-init"
><code class="function">gnome_program_init()</code></a> call. These
should enable libgnomeui applications to control their appearance precisely.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2905586"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2905596"></a><h3>
<a name="LIBGNOMEUI-MODULE:CAPS"></a>LIBGNOMEUI_MODULE</h3>
<a class="indexterm" name="id2905609"></a><pre class="programlisting">#define LIBGNOMEUI_MODULE libgnomeui_module_info_get()
</pre>
<p>
A module containing all the information required to initialize libgnomeui and
its dependents. This should be passed to the <a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#gnome-program-init"
><code class="function">gnome_program_init()</code></a> call by
applications using libgnomeui.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2905638"></a><h3>
<a name="LIBGNOMEUI-PARAM-CRASH-DIALOG:CAPS"></a>LIBGNOMEUI_PARAM_CRASH_DIALOG</h3>
<a class="indexterm" name="id2905651"></a><pre class="programlisting">#define LIBGNOMEUI_PARAM_CRASH_DIALOG "show-crash-dialog"
</pre>
<p>
If set to <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>, the standard GNOME crash dialog will appear (offering the user
a chance to automatically file a bug report) should the application crash while
running. Application authors will almost never want to change the default value
of this parameter (<a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a>). The user may change it however by setting the
<code class="envar">GNOME_DISABLE_CRASH_DIALOG</code> environment variable or passing
<code class="literal">--disable-crash-dialog</code> on the command line.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2905704"></a><h3>
<a name="LIBGNOMEUI-PARAM-DISPLAY:CAPS"></a>LIBGNOMEUI_PARAM_DISPLAY</h3>
<a class="indexterm" name="id2905718"></a><pre class="programlisting">#define LIBGNOMEUI_PARAM_DISPLAY "display"
</pre>
<p>
Initially set to the value of the <code class="envar">DISPLAY</code> environment variable
or the <code class="literal">--display</code> value passed on the command line, this
parameter determines which X display the application will start on.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2905745"></a><h3>
<a name="LIBGNOMEUI-PARAM-DEFAULT-ICON:CAPS"></a>LIBGNOMEUI_PARAM_DEFAULT_ICON</h3>
<a class="indexterm" name="id2905759"></a><pre class="programlisting">#define LIBGNOMEUI_PARAM_DEFAULT_ICON "default-icon"
</pre>
<p>
Set to the full path of the application's default icon. This can only be set by
the application.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2905776"></a><h3>
<a name="gnome-init-with-popt-table"></a>gnome_init_with_popt_table ()</h3>
<a class="indexterm" name="id2905792"></a><pre class="programlisting">int gnome_init_with_popt_table (const char *app_id,
const char *app_version,
int argc,
char **argv,
const struct poptOption *options,
int flags,
poptContext *return_ctx);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_init_with_popt_table</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Initializes the application. This sets up all of the GNOME
internals and prepares them (imlib, gdk, session-management, triggers,
sound, user preferences).
</p>
<p>
Unlike <a href="libgnomeui-gnome-ui-init.html#gnome-init"><span class="type">gnome_init</span></a>, with <a href="libgnomeui-gnome-ui-init.html#gnome-init-with-popt-table"><span class="type">gnome_init_with_popt_table</span></a> you can provide
a table of popt options (popt is the command line argument parsing
library).
</p>
<p>
Deprecated, use <a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#gnome-program-init"
><span class="type">gnome_program_init</span></a> with the LIBGNOMEUI_MODULE.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
<td> Application id.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
<td> Application version.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
<td> argument count (for example argc as received by main)
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
<td> argument vector (for example argv as received by main)
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>options</code></em> :</span></td>
<td> poptOption table with options to parse
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>flags</code></em> :</span></td>
<td> popt flags.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>return_ctx</code></em> :</span></td>
<td> if non-NULL, the popt context is returned here.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> 0 (always)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2906037"></a><h3>
<a name="gnome-init"></a>gnome_init()</h3>
<a class="indexterm" name="id2906050"></a><pre class="programlisting">#define gnome_init(app_id,app_version,argc,argv)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_init</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This is identical to a call to gnome_init_with_popt_table with <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> passed in
as the poptOption table.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_id</code></em> :</span></td>
<td>Application id.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_version</code></em> :</span></td>
<td>Application version.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
<td>Argument count (for example, argc as received by the main function).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
<td>Argument vector (for example, argv as received by the main function).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2906152"></a><h3>
<a name="gnome-gtk-module-info-get"></a>gnome_gtk_module_info_get ()</h3>
<a class="indexterm" name="id2906165"></a><pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#GnomeModuleInfo"
>GnomeModuleInfo</a>* gnome_gtk_module_info_get
(void);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>