summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkaboutdialog.sgml
blob: 1668a933099e961a1f4516c139556b31f7f22760 (plain)
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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
<!-- ##### SECTION Title ##### -->
GtkAboutDialog

<!-- ##### SECTION Short_Description ##### -->
Display information about an application

<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkAboutDialog offers a simple way to display information about
a program like its logo, name, copyright, website and license. It is
also possible to give credits to the authors, documenters, translators
and artists who have worked on the program. An about dialog is typically
opened when the user selects the <literal>About</literal> option from 
the <literal>Help</literal> menu. All parts of the dialog are optional.
</para>
<para>
About dialog often contain links and email addresses. #GtkAboutDialog 
supports this by offering global hooks, which are called when the user
clicks on a link or email address, see gtk_about_dialog_set_email_hook()
and gtk_about_dialog_set_url_hook(). Email addresses in the 
authors, documenters and artists properties are recognized by looking for
<literal>&lt;user@<!-- -->host&gt;</literal>, URLs are 
recognized by looking for <literal>http://url</literal>, with 
<literal>url</literal> extending to the next space, tab or line break.
</para>
<para>
To make constructing a #GtkAboutDialog as convenient as possible, you can
use the function gtk_show_about_dialog() which constructs and shows a dialog 
and keeps it around so that it can be shown again.
</para>
<para>
Note that GTK+ sets a default title of <literal>_("About &percnt;s")</literal> 
on the dialog window (where &percnt;s is replaced by the name of the 
application, but in order to ensure proper translation of the title, 
applications should set the title property explicitly when constructing 
a #GtkAboutDialog, as shown in the following example:
</para>
<informalexample><programlisting>
gtk_show_about_dialog (NULL, 
                       "name", "ExampleCode",
                       "logo", example_logo,
                       "title" _("About ExampleCode"),
                       NULL);
</programlisting></informalexample>

<!-- ##### SECTION See_Also ##### -->
<para>
#GTK_STOCK_ABOUT
</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT GtkAboutDialog ##### -->
<para>
The <structname>GtkAboutDialog</structname> struct contains
only private fields and should not be directly accessed.
</para>


<!-- ##### ARG GtkAboutDialog:artists ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:authors ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:comments ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:copyright ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:documenters ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:license ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:logo ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:logo-icon-name ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:program-name ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:translator-credits ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:version ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:website ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:website-label ##### -->
<para>

</para>

<!-- ##### ARG GtkAboutDialog:wrap-license ##### -->
<para>

</para>

<!-- ##### FUNCTION gtk_about_dialog_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_get_name ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_name ##### -->
<para>

</para>

@about: 
@name: 


<!-- ##### FUNCTION gtk_about_dialog_get_program_name ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_program_name ##### -->
<para>

</para>

@about: 
@name: 


<!-- ##### FUNCTION gtk_about_dialog_get_version ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_version ##### -->
<para>

</para>

@about: 
@version: 


<!-- ##### FUNCTION gtk_about_dialog_get_copyright ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_copyright ##### -->
<para>

</para>

@about: 
@copyright: 


<!-- ##### FUNCTION gtk_about_dialog_get_comments ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_comments ##### -->
<para>

</para>

@about: 
@comments: 


<!-- ##### FUNCTION gtk_about_dialog_get_license ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_license ##### -->
<para>

</para>

@about: 
@license: 


<!-- ##### FUNCTION gtk_about_dialog_get_wrap_license ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_wrap_license ##### -->
<para>

</para>

@about: 
@wrap_license: 


<!-- ##### FUNCTION gtk_about_dialog_get_website ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_website ##### -->
<para>

</para>

@about: 
@website: 


<!-- ##### FUNCTION gtk_about_dialog_get_website_label ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_website_label ##### -->
<para>

</para>

@about: 
@website_label: 


<!-- ##### FUNCTION gtk_about_dialog_get_authors ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_authors ##### -->
<para>

</para>

@about: 
@authors: 


<!-- ##### FUNCTION gtk_about_dialog_get_artists ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_artists ##### -->
<para>

</para>

@about: 
@artists: 


<!-- ##### FUNCTION gtk_about_dialog_get_documenters ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_documenters ##### -->
<para>

</para>

@about: 
@documenters: 


<!-- ##### FUNCTION gtk_about_dialog_get_translator_credits ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_translator_credits ##### -->
<para>

</para>

@about: 
@translator_credits: 


<!-- ##### FUNCTION gtk_about_dialog_get_logo ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_logo ##### -->
<para>

</para>

@about: 
@logo: 


<!-- ##### FUNCTION gtk_about_dialog_get_logo_icon_name ##### -->
<para>

</para>

@about: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_logo_icon_name ##### -->
<para>

</para>

@about: 
@icon_name: 


<!-- ##### USER_FUNCTION GtkAboutDialogActivateLinkFunc ##### -->
<para>
The type of a function which is called when a URL or email
link is activated. 
</para>

@about: the #GtkAboutDialog in which the link was activated
@link_: 
@data: user data that was passed when the function was registered
  with gtk_about_dialog_set_email_hook() or 
  gtk_about_dialog_set_url_hook()
<!-- # Unused Parameters # -->
@link: the URL or email address to whiche the activated link points


<!-- ##### FUNCTION gtk_about_dialog_set_email_hook ##### -->
<para>

</para>

@func: 
@data: 
@destroy: 
@Returns: 


<!-- ##### FUNCTION gtk_about_dialog_set_url_hook ##### -->
<para>

</para>

@func: 
@data: 
@destroy: 
@Returns: 


<!-- ##### FUNCTION gtk_show_about_dialog ##### -->
<para>

</para>

@parent: 
@first_property_name: 
@Varargs: