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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gnome-ui-init</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="initialization.html" title="Initialization and Session Management">
<link rel="prev" href="initialization.html" title="Initialization and Session Management">
<link rel="next" href="libgnomeui-gnome-client.html" title="GnomeClient">
<meta name="generator" content="GTK-Doc V1.16 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="initialization.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="initialization.html"><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="libgnomeui-gnome-client.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgnomeui-gnome-ui-init.synopsis" class="shortcut">Top</a>
|
<a href="#libgnomeui-gnome-ui-init.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgnomeui-gnome-ui-init"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgnomeui-gnome-ui-init.top_of_page"></a>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">
<a name="libgnomeui-gnome-ui-init.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
#define <a class="link" href="libgnomeui-gnome-ui-init.html#LIBGNOMEUI-MODULE:CAPS" title="LIBGNOMEUI_MODULE">LIBGNOMEUI_MODULE</a>
#define <a class="link" href="libgnomeui-gnome-ui-init.html#LIBGNOMEUI-PARAM-CRASH-DIALOG:CAPS" title="LIBGNOMEUI_PARAM_CRASH_DIALOG">LIBGNOMEUI_PARAM_CRASH_DIALOG</a>
#define <a class="link" href="libgnomeui-gnome-ui-init.html#LIBGNOMEUI-PARAM-DISPLAY:CAPS" title="LIBGNOMEUI_PARAM_DISPLAY">LIBGNOMEUI_PARAM_DISPLAY</a>
#define <a class="link" href="libgnomeui-gnome-ui-init.html#LIBGNOMEUI-PARAM-DEFAULT-ICON:CAPS" title="LIBGNOMEUI_PARAM_DEFAULT_ICON">LIBGNOMEUI_PARAM_DEFAULT_ICON</a>
<span class="returnvalue">int</span> <a class="link" href="libgnomeui-gnome-ui-init.html#gnome-init-with-popt-table" title="gnome_init_with_popt_table ()">gnome_init_with_popt_table</a> (<em class="parameter"><code>const <span class="type">char</span> *app_id</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *app_version</code></em>,
<em class="parameter"><code><span class="type">int</span> argc</code></em>,
<em class="parameter"><code><span class="type">char</span> **argv</code></em>,
<em class="parameter"><code>const <span class="type">struct poptOption</span> *options</code></em>,
<em class="parameter"><code><span class="type">int</span> flags</code></em>,
<em class="parameter"><code><span class="type">poptContext</span> *return_ctx</code></em>);
#define <a class="link" href="libgnomeui-gnome-ui-init.html#gnome-init" title="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"><span class="returnvalue">GnomeModuleInfo</span></a> * <a class="link" href="libgnomeui-gnome-ui-init.html#gnome-gtk-module-info-get" title="gnome_gtk_module_info_get ()">gnome_gtk_module_info_get</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgnomeui-gnome-ui-init.description"></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">
<a name="libgnomeui-gnome-ui-init.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="LIBGNOMEUI-MODULE:CAPS"></a><h3>LIBGNOMEUI_MODULE</h3>
<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">
<a name="LIBGNOMEUI-PARAM-CRASH-DIALOG:CAPS"></a><h3>LIBGNOMEUI_PARAM_CRASH_DIALOG</h3>
<pre class="programlisting">#define LIBGNOMEUI_PARAM_CRASH_DIALOG "show-crash-dialog"
</pre>
<p>
If set to <a href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/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">
<a name="LIBGNOMEUI-PARAM-DISPLAY:CAPS"></a><h3>LIBGNOMEUI_PARAM_DISPLAY</h3>
<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">
<a name="LIBGNOMEUI-PARAM-DEFAULT-ICON:CAPS"></a><h3>LIBGNOMEUI_PARAM_DEFAULT_ICON</h3>
<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">
<a name="gnome-init-with-popt-table"></a><h3>gnome_init_with_popt_table ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> gnome_init_with_popt_table (<em class="parameter"><code>const <span class="type">char</span> *app_id</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *app_version</code></em>,
<em class="parameter"><code><span class="type">int</span> argc</code></em>,
<em class="parameter"><code><span class="type">char</span> **argv</code></em>,
<em class="parameter"><code>const <span class="type">struct poptOption</span> *options</code></em>,
<em class="parameter"><code><span class="type">int</span> flags</code></em>,
<em class="parameter"><code><span class="type">poptContext</span> *return_ctx</code></em>);</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 class="link" href="libgnomeui-gnome-ui-init.html#gnome-init" title="gnome_init()"><span class="type">gnome_init</span></a>, with <a class="link" href="libgnomeui-gnome-ui-init.html#gnome-init-with-popt-table" title="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>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_id</code></em> :</span></p></td>
<td>Application id.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_version</code></em> :</span></p></td>
<td>Application version.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>argument count (for example argc as received by main)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>argument vector (for example argv as received by main)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
<td>poptOption table with options to parse</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>popt flags.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>return_ctx</code></em> :</span></p></td>
<td>if non-NULL, the popt context is returned here.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>0 (always)</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-init"></a><h3>gnome_init()</h3>
<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="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.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><p><span class="term"><em class="parameter"><code>app_id</code></em> :</span></p></td>
<td>Application id.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_version</code></em> :</span></p></td>
<td>Application version.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Argument count (for example, argc as received by the main function).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>Argument vector (for example, argv as received by the main function).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-gtk-module-info-get"></a><h3>gnome_gtk_module_info_get ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/libgnome/libgnome-gnome-program.html#GnomeModuleInfo"><span class="returnvalue">GnomeModuleInfo</span></a> * gnome_gtk_module_info_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.16</div>
</body>
</html>
|
