path: root/docs/reference/gtk/tmpl/gtkaboutdialog.sgml

<!-- ##### 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: