Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkaboutdialog.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkAboutDialog
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Display information about an application
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkAboutDialog offers a simple way to display information about
  10 a program like its logo, name, copyright, website and license. It is
  11 also possible to give credits to the authors, documenters, translators
  12 and artists who have worked on the program. An about dialog is typically
  13 opened when the user selects the <literal>About</literal> option from
  14 the <literal>Help</literal> menu. All parts of the dialog are optional.
  15 </para>
  16 <para>
  17 About dialog often contain links and email addresses. #GtkAboutDialog
  18 supports this by offering global hooks, which are called when the user
  19 clicks on a link or email address, see gtk_about_dialog_set_email_hook()
  20 and gtk_about_dialog_set_url_hook(). Email addresses in the
  21 authors, documenters and artists properties are recognized by looking for
  22 <literal>&lt;user@<!-- -->host&gt;</literal>, URLs are
  23 recognized by looking for <literal>http://url</literal>, with
  24 <literal>url</literal> extending to the next space, tab or line break.
  25 </para>
  26 <para>
  27 To make constructing a #GtkAboutDialog as convenient as possible, you can
  28 use the function gtk_show_about_dialog() which constructs and shows a dialog
  29 and keeps it around so that it can be shown again.
  30 </para>
  31
  32 <!-- ##### SECTION See_Also ##### -->
  33 <para>
  34 #GTK_STOCK_ABOUT
  35 </para>
  36
  37 <!-- ##### SECTION Stability_Level ##### -->
  38
  39
  40 <!-- ##### STRUCT GtkAboutDialog ##### -->
  41 <para>
  42 The <structname>GtkAboutDialog</structname> struct contains
  43 only private fields and should not be directly accessed.
  44 </para>
  45
  46
  47 <!-- ##### ARG GtkAboutDialog:artists ##### -->
  48 <para>
  49
  50 </para>
  51
  52 <!-- ##### ARG GtkAboutDialog:authors ##### -->
  53 <para>
  54
  55 </para>
  56
  57 <!-- ##### ARG GtkAboutDialog:comments ##### -->
  58 <para>
  59
  60 </para>
  61
  62 <!-- ##### ARG GtkAboutDialog:copyright ##### -->
  63 <para>
  64
  65 </para>
  66
  67 <!-- ##### ARG GtkAboutDialog:documenters ##### -->
  68 <para>
  69
  70 </para>
  71
  72 <!-- ##### ARG GtkAboutDialog:license ##### -->
  73 <para>
  74
  75 </para>
  76
  77 <!-- ##### ARG GtkAboutDialog:logo ##### -->
  78 <para>
  79
  80 </para>
  81
  82 <!-- ##### ARG GtkAboutDialog:logo-icon-name ##### -->
  83 <para>
  84
  85 </para>
  86
  87 <!-- ##### ARG GtkAboutDialog:name ##### -->
  88 <para>
  89
  90 </para>
  91
  92 <!-- ##### ARG GtkAboutDialog:translator-credits ##### -->
  93 <para>
  94
  95 </para>
  96
  97 <!-- ##### ARG GtkAboutDialog:version ##### -->
  98 <para>
  99
 100 </para>
 101
 102 <!-- ##### ARG GtkAboutDialog:website ##### -->
 103 <para>
 104
 105 </para>
 106
 107 <!-- ##### ARG GtkAboutDialog:website-label ##### -->
 108 <para>
 109
 110 </para>
 111
 112 <!-- ##### ARG GtkAboutDialog:wrap-license ##### -->
 113 <para>
 114
 115 </para>
 116
 117 <!-- ##### FUNCTION gtk_about_dialog_new ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @Returns:
 123
 124
 125 <!-- ##### FUNCTION gtk_about_dialog_get_name ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @about:
 131 @Returns:
 132
 133
 134 <!-- ##### FUNCTION gtk_about_dialog_set_name ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @about:
 140 @name:
 141
 142
 143 <!-- ##### FUNCTION gtk_about_dialog_get_version ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @about:
 149 @Returns:
 150
 151
 152 <!-- ##### FUNCTION gtk_about_dialog_set_version ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @about:
 158 @version:
 159
 160
 161 <!-- ##### FUNCTION gtk_about_dialog_get_copyright ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @about:
 167 @Returns:
 168
 169
 170 <!-- ##### FUNCTION gtk_about_dialog_set_copyright ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @about:
 176 @copyright:
 177
 178
 179 <!-- ##### FUNCTION gtk_about_dialog_get_comments ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @about:
 185 @Returns:
 186
 187
 188 <!-- ##### FUNCTION gtk_about_dialog_set_comments ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @about:
 194 @comments:
 195
 196
 197 <!-- ##### FUNCTION gtk_about_dialog_get_license ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @about:
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION gtk_about_dialog_set_license ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @about:
 212 @license:
 213
 214
 215 <!-- ##### FUNCTION gtk_about_dialog_get_wrap_license ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @about:
 221 @Returns:
 222
 223
 224 <!-- ##### FUNCTION gtk_about_dialog_set_wrap_license ##### -->
 225 <para>
 226
 227 </para>
 228
 229 @about:
 230 @wrap_license:
 231
 232
 233 <!-- ##### FUNCTION gtk_about_dialog_get_website ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @about:
 239 @Returns:
 240
 241
 242 <!-- ##### FUNCTION gtk_about_dialog_set_website ##### -->
 243 <para>
 244
 245 </para>
 246
 247 @about:
 248 @website:
 249
 250
 251 <!-- ##### FUNCTION gtk_about_dialog_get_website_label ##### -->
 252 <para>
 253
 254 </para>
 255
 256 @about:
 257 @Returns:
 258
 259
 260 <!-- ##### FUNCTION gtk_about_dialog_set_website_label ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @about:
 266 @website_label:
 267
 268
 269 <!-- ##### FUNCTION gtk_about_dialog_get_authors ##### -->
 270 <para>
 271
 272 </para>
 273
 274 @about:
 275 @Returns:
 276
 277
 278 <!-- ##### FUNCTION gtk_about_dialog_set_authors ##### -->
 279 <para>
 280
 281 </para>
 282
 283 @about:
 284 @authors:
 285
 286
 287 <!-- ##### FUNCTION gtk_about_dialog_get_artists ##### -->
 288 <para>
 289
 290 </para>
 291
 292 @about:
 293 @Returns:
 294
 295
 296 <!-- ##### FUNCTION gtk_about_dialog_set_artists ##### -->
 297 <para>
 298
 299 </para>
 300
 301 @about:
 302 @artists:
 303
 304
 305 <!-- ##### FUNCTION gtk_about_dialog_get_documenters ##### -->
 306 <para>
 307
 308 </para>
 309
 310 @about:
 311 @Returns:
 312
 313
 314 <!-- ##### FUNCTION gtk_about_dialog_set_documenters ##### -->
 315 <para>
 316
 317 </para>
 318
 319 @about:
 320 @documenters:
 321
 322
 323 <!-- ##### FUNCTION gtk_about_dialog_get_translator_credits ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @about:
 329 @Returns:
 330
 331
 332 <!-- ##### FUNCTION gtk_about_dialog_set_translator_credits ##### -->
 333 <para>
 334
 335 </para>
 336
 337 @about:
 338 @translator_credits:
 339
 340
 341 <!-- ##### FUNCTION gtk_about_dialog_get_logo ##### -->
 342 <para>
 343
 344 </para>
 345
 346 @about:
 347 @Returns:
 348
 349
 350 <!-- ##### FUNCTION gtk_about_dialog_set_logo ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @about:
 356 @logo:
 357
 358
 359 <!-- ##### FUNCTION gtk_about_dialog_get_logo_icon_name ##### -->
 360 <para>
 361
 362 </para>
 363
 364 @about:
 365 @Returns:
 366
 367
 368 <!-- ##### FUNCTION gtk_about_dialog_set_logo_icon_name ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @about:
 374 @icon_name:
 375
 376
 377 <!-- ##### USER_FUNCTION GtkAboutDialogActivateLinkFunc ##### -->
 378 <para>
 379 The type of a function which is called when a URL or email
 380 link is activated.
 381 </para>
 382
 383 @about: the #GtkAboutDialog in which the link was activated
 384 @link: the URL or email address to whiche the activated link points
 385 @data: user data that was passed when the function was registered
 386   with gtk_about_dialog_set_email_hook() or
 387   gtk_about_dialog_set_url_hook()
 388
 389
 390 <!-- ##### FUNCTION gtk_about_dialog_set_email_hook ##### -->
 391 <para>
 392
 393 </para>
 394
 395 @func:
 396 @data:
 397 @destroy:
 398 @Returns:
 399
 400
 401 <!-- ##### FUNCTION gtk_about_dialog_set_url_hook ##### -->
 402 <para>
 403
 404 </para>
 405
 406 @func:
 407 @data:
 408 @destroy:
 409 @Returns:
 410
 411
 412 <!-- ##### FUNCTION gtk_show_about_dialog ##### -->
 413 <para>
 414
 415 </para>
 416
 417 @parent:
 418 @first_property_name:
 419 @Varargs:
 420
 421