Substitute gtk_widget_ref/unref with g_object_ref/unref

[~andy/gtk] / docs / reference / gtk / tmpl / gtkaboutdialog.sgml

diff --git a/docs/reference/gtk/tmpl/gtkaboutdialog.sgml b/docs/reference/gtk/tmpl/gtkaboutdialog.sgml
index 67b90f4a2ddcb88d3c73d98da76a5325f8b51ffa..6aac589c90ace89950f543bf61b44ad035b76900 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkaboutdialog.sgml
+++ b/docs/reference/gtk/tmpl/gtkaboutdialog.sgml
@@ -23,11 +23,47 @@ authors, documenters and artists properties are recognized by looking for
 recognized by looking for <literal>http://url</literal>, with 
 <literal>url</literal> extending to the next space, tab or line break.
 </para>
+<para id="gtk-about-dialog-hook-setup">
+Since 2.18 #GtkAboutDialog provides default website and email hooks that use
+gtk_show_uri().
+</para>
+<para>
+If you want provide your own hooks overriding the default ones, it is important
+to do so before setting the website and email URL properties, like this:
+</para>
+<informalexample><programlisting>
+gtk_about_dialog_set_url_hook (GTK_ABOUT_DIALOG (dialog), launch_url, NULL, NULL);
+gtk_about_dialog_set_website (GTK_ABOUT_DIALOG (dialog), app_url);
+</programlisting></informalexample>
+<para>
+To disable the default hooks, you can pass %NULL as the hook func. Then,
+the #GtkAboutDialog widget will not display the website or the
+email addresses as clickable.
+</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, 
+                       "program-name", "ExampleCode",
+                       "logo", example_logo,
+                       "title" _("About ExampleCode"),
+                       NULL);
+</programlisting></informalexample>
+<para>
+Note that prior to GTK+ 2.12, the #GtkAboutDialog:program-name property
+was called "name". This was changed to avoid the conflict with the
+#GtkWidget:name property.
+</para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
@@ -84,7 +120,7 @@ only private fields and should not be directly accessed.
 
 </para>
 
-<!-- ##### ARG GtkAboutDialog:name ##### -->
+<!-- ##### ARG GtkAboutDialog:program-name ##### -->
 <para>
 
 </para>
@@ -114,20 +150,33 @@ only private fields and should not be directly accessed.
 
 </para>
 
-<!-- ##### ARG GtkAboutDialog:link-color ##### -->
+<!-- ##### FUNCTION gtk_about_dialog_new ##### -->
 <para>
 
 </para>
 
-<!-- ##### FUNCTION gtk_about_dialog_new ##### -->
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_name ##### -->
 <para>
 
 </para>
 
+@about: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_about_dialog_get_name ##### -->
+<!-- ##### FUNCTION gtk_about_dialog_set_name ##### -->
+<para>
+
+</para>
+
+@about: 
+@name: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_program_name ##### -->
 <para>
 
 </para>
@@ -136,7 +185,7 @@ only private fields and should not be directly accessed.
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_about_dialog_set_name ##### -->
+<!-- ##### FUNCTION gtk_about_dialog_set_program_name ##### -->
 <para>
 
 </para>
@@ -386,7 +435,7 @@ link is activated.
 </para>
 
 @about: the #GtkAboutDialog in which the link was activated
-@link: the URL or email address to whiche the activated link points
+@link_: the URL or email address to which the activated link points
 @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()