1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
<refentry id="libgnomeui-gnome-ui-init">
<refmeta>
<refentrytitle role="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>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libgnomeui/libgnomeui.h>
#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 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 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="LIBGNOMEUI-MODULE:CAPS" role="macro"/>LIBGNOMEUI_MODULE</title>
<indexterm><primary>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>
<title><anchor id="LIBGNOMEUI-PARAM-CRASH-DIALOG:CAPS" role="macro"/>LIBGNOMEUI_PARAM_CRASH_DIALOG</title>
<indexterm><primary>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>
<title><anchor id="LIBGNOMEUI-PARAM-DISPLAY:CAPS" role="macro"/>LIBGNOMEUI_PARAM_DISPLAY</title>
<indexterm><primary>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>
<title><anchor id="LIBGNOMEUI-PARAM-DEFAULT-ICON:CAPS" role="macro"/>LIBGNOMEUI_PARAM_DEFAULT_ICON</title>
<indexterm><primary>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>
<title><anchor id="gnome-init-with-popt-table" role="function" condition="deprecated:"/>gnome_init_with_popt_table ()</title>
<indexterm role="deprecated"><primary>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> :</term>
<listitem><simpara> Application id.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>app_version</parameter> :</term>
<listitem><simpara> Application version.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argc</parameter> :</term>
<listitem><simpara> argument count (for example argc as received by main)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argv</parameter> :</term>
<listitem><simpara> argument vector (for example argv as received by main)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>options</parameter> :</term>
<listitem><simpara> poptOption table with options to parse
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> popt flags.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>return_ctx</parameter> :</term>
<listitem><simpara> if non-NULL, the popt context is returned here.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 (always)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-init" role="macro" condition="deprecated:"/>gnome_init()</title>
<indexterm role="deprecated"><primary>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> :</term>
<listitem><simpara>Application id.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>app_version</parameter> :</term>
<listitem><simpara>Application version.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argc</parameter> :</term>
<listitem><simpara>Argument count (for example, argc as received by the main function).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argv</parameter> :</term>
<listitem><simpara>Argument vector (for example, argv as received by the main function).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-gtk-module-info-get" role="function"/>gnome_gtk_module_info_get ()</title>
<indexterm><primary>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> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
