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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GnomeAbout</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="deprecated.html" title="Deprecated Modules">
<link rel="prev" href="deprecated.html" title="Deprecated Modules">
<link rel="next" href="libgnomeui-gnome-app-util.html" title="gnome-app-util">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="pt01.html" title="Part I. GNOME UI Library (libgnomeui)">
<link rel="chapter" href="initialization.html" title="Initialization and Session Management">
<link rel="chapter" href="application-mgmt.html" title="Application Management">
<link rel="chapter" href="druids.html" title="Druids">
<link rel="chapter" href="fixme.html" title="Miscellaneous Widgets">
<link rel="chapter" href="miscellaneous.html" title="Miscellaneous Utility Functions and Macros">
<link rel="chapter" href="deprecated.html" title="Deprecated Modules">
<link rel="chapter" href="libgnomeui-objects.html" title="Object Hierarchy">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
<link rel="index" href="ix08.html" title="Index of new symbols in 2.12">
<link rel="index" href="ix09.html" title="Index of new symbols in 2.14">
<link rel="index" href="ix10.html" title="Index of new symbols in 2.16">
</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="deprecated.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="deprecated.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-app-util.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="#id2695596" class="shortcut">Top</a>
 | 
<a href="#id2696047" class="shortcut">Description</a>
 | 
<a href="#id2695786" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2695862" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2695892" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GnomeAbout"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2695596"></a><span class="refentrytitle">GnomeAbout</span>
</h2>
<p>GnomeAbout — Display author, documenter and translator credits for an application.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
<a href="GnomeAbout.html#GnomeAbout-struct">GnomeAbout</a>;
GtkWidget* <a href="GnomeAbout.html#gnome-about-new">gnome_about_new</a> (const gchar *name,
const gchar *version,
const gchar *copyright,
const gchar *comments,
const gchar **authors,
const gchar **documenters,
const gchar *translator_credits,
GdkPixbuf *logo_pixbuf);
void <a href="GnomeAbout.html#gnome-about-construct">gnome_about_construct</a> (<a href="GnomeAbout.html" title="GnomeAbout">GnomeAbout</a> *about,
const gchar *name,
const gchar *version,
const gchar *copyright,
const gchar *comments,
const gchar **authors,
const gchar **documenters,
const gchar *translator_credits,
GdkPixbuf *logo_pixbuf);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2695786"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBin
+----GtkWindow
+----GtkDialog
+----GnomeAbout
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2695862"></a><h2>Implemented Interfaces</h2>
<p>
GnomeAbout implements
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2695892"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GnomeAbout.html#GnomeAbout--authors">authors</a>" GValueArray : Write
"<a href="GnomeAbout.html#GnomeAbout--comments">comments</a>" gchararray : Read / Write
"<a href="GnomeAbout.html#GnomeAbout--copyright">copyright</a>" gchararray : Read / Write
"<a href="GnomeAbout.html#GnomeAbout--documenters">documenters</a>" GValueArray : Write
"<a href="GnomeAbout.html#GnomeAbout--logo">logo</a>" GdkPixbuf : Write
"<a href="GnomeAbout.html#GnomeAbout--name">name</a>" gchararray : Read / Write
"<a href="GnomeAbout.html#GnomeAbout--translator-credits">translator-credits</a>" gchararray : Read / Write
"<a href="GnomeAbout.html#GnomeAbout--version">version</a>" gchararray : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2696047"></a><h2>Description</h2>
<p>
The GnomeAbout widget is used as the standard way of displaying credits in an
application. Typically, it will be called when a user selects the
<code class="literal">About...</code> option from the <code class="literal">Help</code> menu. With
one simple function call, the application can then display all of the
appropriate information.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2696078"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2696088"></a><h3>
<a name="GnomeAbout-struct"></a>GnomeAbout</h3>
<a class="indexterm" name="id2696102"></a><pre class="programlisting">typedef struct _GnomeAbout GnomeAbout;</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GnomeAbout</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
A dialog box widget containing all of the relevant credit information and
displaying as three notebook pages.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2696131"></a><h3>
<a name="gnome-about-new"></a>gnome_about_new ()</h3>
<a class="indexterm" name="id2696145"></a><pre class="programlisting">GtkWidget* gnome_about_new (const gchar *name,
const gchar *version,
const gchar *copyright,
const gchar *comments,
const gchar **authors,
const gchar **documenters,
const gchar *translator_credits,
GdkPixbuf *logo_pixbuf);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_about_new</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Construct an application's credits box. The <em class="parameter"><code>authors</code></em> array cannot be empty
and the <em class="parameter"><code>translator_credits</code></em> should be marked as a translatable string (so
that only the translator for the currently active locale is displayed).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the application.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>version</code></em> :</span></td>
<td> The version string of the application.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>copyright</code></em> :</span></td>
<td> The application's copyright statement.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>comments</code></em> :</span></td>
<td> A short miscellaneous string.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>authors</code></em> :</span></td>
<td> An <a
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> terminated array of the application authors.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>documenters</code></em> :</span></td>
<td> An array of the application documenters.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>translator_credits</code></em> :</span></td>
<td> The translator for the current locale.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>logo_pixbuf</code></em> :</span></td>
<td> The application's logo.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A new "About" dialog.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2696400"></a><h3>
<a name="gnome-about-construct"></a>gnome_about_construct ()</h3>
<a class="indexterm" name="id2696416"></a><pre class="programlisting">void gnome_about_construct (<a href="GnomeAbout.html" title="GnomeAbout">GnomeAbout</a> *about,
const gchar *name,
const gchar *version,
const gchar *copyright,
const gchar *comments,
const gchar **authors,
const gchar **documenters,
const gchar *translator_credits,
GdkPixbuf *logo_pixbuf);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_about_construct</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Similar to <a href="GnomeAbout.html#gnome-about-new"><code class="function">gnome_about_new()</code></a> except that the pre-existing <em class="parameter"><code>about</code></em> widget is
used. Note that in this version of the function, <em class="parameter"><code>authors</code></em> is not checked to
be non-<a
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>, so callers must be careful, since bad things will happen if
this condition is not met.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>about</code></em> :</span></td>
<td> An existing <a href="GnomeAbout.html" title="GnomeAbout"><span class="type">GnomeAbout</span></a> instance.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the application.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>version</code></em> :</span></td>
<td> The version string of the application.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>copyright</code></em> :</span></td>
<td> The application's copyright statement.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>comments</code></em> :</span></td>
<td> A short miscellaneous string.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>authors</code></em> :</span></td>
<td> An <a
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> terminated array of the application authors.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>documenters</code></em> :</span></td>
<td> An array of the application documenters.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>translator_credits</code></em> :</span></td>
<td> The translator for the current locale.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>logo_pixbuf</code></em> :</span></td>
<td> The application's logo.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2696713"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2696723"></a><h3>
<a name="GnomeAbout--authors"></a>The <code class="literal">"authors"</code> property</h3>
<a class="indexterm" name="id2696739"></a><pre class="programlisting"> "authors" GValueArray : Write</pre>
<p>List of authors of the programs.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2696762"></a><h3>
<a name="GnomeAbout--comments"></a>The <code class="literal">"comments"</code> property</h3>
<a class="indexterm" name="id2696778"></a><pre class="programlisting"> "comments" gchararray : Read / Write</pre>
<p>Comments about the program.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2696804"></a><h3>
<a name="GnomeAbout--copyright"></a>The <code class="literal">"copyright"</code> property</h3>
<a class="indexterm" name="id2696821"></a><pre class="programlisting"> "copyright" gchararray : Read / Write</pre>
<p>Copyright information for the program.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2696848"></a><h3>
<a name="GnomeAbout--documenters"></a>The <code class="literal">"documenters"</code> property</h3>
<a class="indexterm" name="id2696864"></a><pre class="programlisting"> "documenters" GValueArray : Write</pre>
<p>List of people documenting the program.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2696887"></a><h3>
<a name="GnomeAbout--logo"></a>The <code class="literal">"logo"</code> property</h3>
<a class="indexterm" name="id2696903"></a><pre class="programlisting"> "logo" GdkPixbuf : Write</pre>
<p>A logo for the about box.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2696926"></a><h3>
<a name="GnomeAbout--name"></a>The <code class="literal">"name"</code> property</h3>
<a class="indexterm" name="id2696942"></a><pre class="programlisting"> "name" gchararray : Read / Write</pre>
<p>The name of the program.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2696969"></a><h3>
<a name="GnomeAbout--translator-credits"></a>The <code class="literal">"translator-credits"</code> property</h3>
<a class="indexterm" name="id2696986"></a><pre class="programlisting"> "translator-credits" gchararray : Read / Write</pre>
<p>Credits to the translators. This string should be marked as translatable.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2697014"></a><h3>
<a name="GnomeAbout--version"></a>The <code class="literal">"version"</code> property</h3>
<a class="indexterm" name="id2697030"></a><pre class="programlisting"> "version" gchararray : Read / Write</pre>
<p>The version of the program.</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
</body>
</html>
|
