<refentry id="libgnomeui-gnome-ui-init">
<refmeta>
<refentrytitle role="top_of_page" id="libgnomeui-gnome-ui-init.top_of_page">gnome-ui-init</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gnome-ui-init</refname>
<refpurpose>Parameters (and deprecated functions) for initializing libgnomeui applications.</refpurpose>
</refnamediv>

<refsynopsisdiv id="libgnomeui-gnome-ui-init.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;libgnomeui/libgnomeui.h&gt;

#define             <link linkend="LIBGNOMEUI-MODULE--CAPS">LIBGNOMEUI_MODULE</link>
#define             <link linkend="LIBGNOMEUI-PARAM-CRASH-DIALOG--CAPS">LIBGNOMEUI_PARAM_CRASH_DIALOG</link>
#define             <link linkend="LIBGNOMEUI-PARAM-DISPLAY--CAPS">LIBGNOMEUI_PARAM_DISPLAY</link>
#define             <link linkend="LIBGNOMEUI-PARAM-DEFAULT-ICON--CAPS">LIBGNOMEUI_PARAM_DEFAULT_ICON</link>
<link linkend="int">int</link>                 <link linkend="gnome-init-with-popt-table">gnome_init_with_popt_table</link>          (const <link linkend="char">char</link> *app_id,
                                                         const <link linkend="char">char</link> *app_version,
                                                         <link linkend="int">int</link> argc,
                                                         <link linkend="char">char</link> **argv,
                                                         const <link linkend="struct-poptOption">struct poptOption</link> *options,
                                                         <link linkend="int">int</link> flags,
                                                         <link linkend="poptContext">poptContext</link> *return_ctx);
#define             <link linkend="gnome-init">gnome_init</link>                          (app_id,app_version,argc,argv)
const <link linkend="GnomeModuleInfo">GnomeModuleInfo</link> * <link linkend="gnome-gtk-module-info-get">gnome_gtk_module_info_get</link>       (void);
</synopsis>
</refsynopsisdiv>









<refsect1 id="libgnomeui-gnome-ui-init.description" role="desc">
<title role="desc.title">Description</title>
<para>
The initialization functions in this module are deprecated in favour of calls
to <link linkend="gnome-program-init"><function>gnome_program_init()</function></link> in the libgnome library.
</para>
<para>
However, this module does provide some extra parameters on top of those already
defined in libgnome that can be passed to the <link linkend="gnome-program-init"><function>gnome_program_init()</function></link> call. These
should enable libgnomeui applications to control their appearance precisely.
</para>
</refsect1>

<refsect1 id="libgnomeui-gnome-ui-init.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="LIBGNOMEUI-MODULE--CAPS" role="macro">
<title>LIBGNOMEUI_MODULE</title>
<indexterm zone="LIBGNOMEUI-MODULE--CAPS"><primary sortas="LIBGNOMEUI_MODULE">LIBGNOMEUI_MODULE</primary></indexterm><programlisting>#define LIBGNOMEUI_MODULE libgnomeui_module_info_get()
</programlisting>
<para>
A module containing all the information required to initialize libgnomeui and
its dependents. This should be passed to the <link linkend="gnome-program-init"><function>gnome_program_init()</function></link> call by
applications using libgnomeui.
</para></refsect2>
<refsect2 id="LIBGNOMEUI-PARAM-CRASH-DIALOG--CAPS" role="macro">
<title>LIBGNOMEUI_PARAM_CRASH_DIALOG</title>
<indexterm zone="LIBGNOMEUI-PARAM-CRASH-DIALOG--CAPS"><primary sortas="LIBGNOMEUI_PARAM_CRASH_DIALOG">LIBGNOMEUI_PARAM_CRASH_DIALOG</primary></indexterm><programlisting>#define LIBGNOMEUI_PARAM_CRASH_DIALOG	"show-crash-dialog"
</programlisting>
<para>
If set to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, 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 (<link linkend="FALSE--CAPS"><literal>FALSE</literal></link>). The user may change it however by setting the
<envar>GNOME_DISABLE_CRASH_DIALOG</envar> environment variable or passing
<literal>--disable-crash-dialog</literal> on the command line.
</para></refsect2>
<refsect2 id="LIBGNOMEUI-PARAM-DISPLAY--CAPS" role="macro">
<title>LIBGNOMEUI_PARAM_DISPLAY</title>
<indexterm zone="LIBGNOMEUI-PARAM-DISPLAY--CAPS"><primary sortas="LIBGNOMEUI_PARAM_DISPLAY">LIBGNOMEUI_PARAM_DISPLAY</primary></indexterm><programlisting>#define LIBGNOMEUI_PARAM_DISPLAY	"display"
</programlisting>
<para>
Initially set to the value of the <envar>DISPLAY</envar> environment variable
or the <literal>--display</literal> value passed on the command line, this
parameter determines which X display the application will start on.
</para></refsect2>
<refsect2 id="LIBGNOMEUI-PARAM-DEFAULT-ICON--CAPS" role="macro">
<title>LIBGNOMEUI_PARAM_DEFAULT_ICON</title>
<indexterm zone="LIBGNOMEUI-PARAM-DEFAULT-ICON--CAPS"><primary sortas="LIBGNOMEUI_PARAM_DEFAULT_ICON">LIBGNOMEUI_PARAM_DEFAULT_ICON</primary></indexterm><programlisting>#define LIBGNOMEUI_PARAM_DEFAULT_ICON	"default-icon"
</programlisting>
<para>
Set to the full path of the application's default icon. This can only be set by
the application.
</para></refsect2>
<refsect2 id="gnome-init-with-popt-table" role="function" condition="deprecated:">
<title>gnome_init_with_popt_table ()</title>
<indexterm zone="gnome-init-with-popt-table" role="deprecated"><primary sortas="gnome_init_with_popt_table">gnome_init_with_popt_table</primary></indexterm><programlisting><link linkend="int">int</link>                 gnome_init_with_popt_table          (const <link linkend="char">char</link> *app_id,
                                                         const <link linkend="char">char</link> *app_version,
                                                         <link linkend="int">int</link> argc,
                                                         <link linkend="char">char</link> **argv,
                                                         const <link linkend="struct-poptOption">struct poptOption</link> *options,
                                                         <link linkend="int">int</link> flags,
                                                         <link linkend="poptContext">poptContext</link> *return_ctx);</programlisting>
<warning><para><literal>gnome_init_with_popt_table</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Initializes the application.  This sets up all of the GNOME
internals and prepares them (imlib, gdk, session-management, triggers,
sound, user preferences).
</para>
<para>
Unlike <link linkend="gnome-init"><type>gnome_init</type></link>, with <link linkend="gnome-init-with-popt-table"><type>gnome_init_with_popt_table</type></link> you can provide
a table of popt options (popt is the command line argument parsing
library).
</para>
<para>
Deprecated, use <link linkend="gnome-program-init"><type>gnome_program_init</type></link> with the LIBGNOMEUI_MODULE.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app_id</parameter>&#160;:</term>
<listitem><simpara> Application id.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>app_version</parameter>&#160;:</term>
<listitem><simpara> Application version.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argc</parameter>&#160;:</term>
<listitem><simpara> argument count (for example argc as received by main)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argv</parameter>&#160;:</term>
<listitem><simpara> argument vector (for example argv as received by main)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>options</parameter>&#160;:</term>
<listitem><simpara> poptOption table with options to parse
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
<listitem><simpara> popt flags.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>return_ctx</parameter>&#160;:</term>
<listitem><simpara> if non-NULL, the popt context is returned here.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> 0 (always)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-init" role="macro" condition="deprecated:">
<title>gnome_init()</title>
<indexterm zone="gnome-init" role="deprecated"><primary sortas="gnome_init">gnome_init</primary></indexterm><programlisting>#define             gnome_init(app_id,app_version,argc,argv)</programlisting>
<warning><para><literal>gnome_init</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This is identical to a call to gnome_init_with_popt_table with <link linkend="NULL--CAPS"><literal>NULL</literal></link> passed in
as the poptOption table.
</para><variablelist role="params">
<varlistentry><term><parameter>app_id</parameter>&#160;:</term>
<listitem><simpara>Application id.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>app_version</parameter>&#160;:</term>
<listitem><simpara>Application version.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argc</parameter>&#160;:</term>
<listitem><simpara>Argument count (for example, argc as received by the main function).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argv</parameter>&#160;:</term>
<listitem><simpara>Argument vector (for example, argv as received by the main function).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-gtk-module-info-get" role="function">
<title>gnome_gtk_module_info_get ()</title>
<indexterm zone="gnome-gtk-module-info-get"><primary sortas="gnome_gtk_module_info_get">gnome_gtk_module_info_get</primary></indexterm><programlisting>const <link linkend="GnomeModuleInfo">GnomeModuleInfo</link> * gnome_gtk_module_info_get       (void);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
