Docs for GtkAboutDialog.
This commit is contained in:
parent
4ed4ccc737
commit
24162d33a0
@ -1,3 +1,11 @@
|
|||||||
|
2004-07-12 Matthias Clasen <mclasen@redhat.com>
|
||||||
|
|
||||||
|
* gtk/gtk-docs.sgml: Add GtkAboutDialog to "Display
|
||||||
|
Widgets" for now.
|
||||||
|
|
||||||
|
* gtk/gtk-sections.txt: Add GtkAboutDialog section.
|
||||||
|
* gtk/tmpl/gtkaboutdialog.sgml: New file.
|
||||||
|
|
||||||
Mon Jul 12 00:57:32 2004 Matthias Clasen <maclas@gmx.de>
|
Mon Jul 12 00:57:32 2004 Matthias Clasen <maclas@gmx.de>
|
||||||
|
|
||||||
* gtk/tmpl/gtkstock.sgml:
|
* gtk/tmpl/gtkstock.sgml:
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
<?xml version="1.0"?>
|
<?xml version="1.0"?>
|
||||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||||
|
<!ENTITY GtkAboutDialog SYSTEM "xml/gtkaboutdialog.xml">
|
||||||
<!ENTITY GtkAccelLabel SYSTEM "xml/gtkaccellabel.xml">
|
<!ENTITY GtkAccelLabel SYSTEM "xml/gtkaccellabel.xml">
|
||||||
<!ENTITY GtkAction SYSTEM "xml/gtkaction.xml">
|
<!ENTITY GtkAction SYSTEM "xml/gtkaction.xml">
|
||||||
<!ENTITY GtkActionGroup SYSTEM "xml/gtkactiongroup.xml">
|
<!ENTITY GtkActionGroup SYSTEM "xml/gtkactiongroup.xml">
|
||||||
@ -332,6 +333,7 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
|
|||||||
|
|
||||||
<chapter id="DisplayWidgets">
|
<chapter id="DisplayWidgets">
|
||||||
<title>Display Widgets</title>
|
<title>Display Widgets</title>
|
||||||
|
&GtkAboutDialog;
|
||||||
&GtkAccelLabel;
|
&GtkAccelLabel;
|
||||||
&GtkImage;
|
&GtkImage;
|
||||||
&GtkLabel;
|
&GtkLabel;
|
||||||
|
@ -1,6 +1,48 @@
|
|||||||
|
|
||||||
<INCLUDE>gtk/gtk.h</INCLUDE>
|
<INCLUDE>gtk/gtk.h</INCLUDE>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>gtkaboutdialog</FILE>
|
||||||
|
<TITLE>GtkAboutDialog</TITLE>
|
||||||
|
GtkAboutDialog
|
||||||
|
gtk_about_dialog_new
|
||||||
|
gtk_about_dialog_get_name
|
||||||
|
gtk_about_dialog_set_name
|
||||||
|
gtk_about_dialog_get_version
|
||||||
|
gtk_about_dialog_set_version
|
||||||
|
gtk_about_dialog_get_copyright
|
||||||
|
gtk_about_dialog_set_copyright
|
||||||
|
gtk_about_dialog_get_comments
|
||||||
|
gtk_about_dialog_set_comments
|
||||||
|
gtk_about_dialog_get_license
|
||||||
|
gtk_about_dialog_set_license
|
||||||
|
gtk_about_dialog_get_website
|
||||||
|
gtk_about_dialog_set_website
|
||||||
|
gtk_about_dialog_get_website_label
|
||||||
|
gtk_about_dialog_set_website_label
|
||||||
|
gtk_about_dialog_get_authors
|
||||||
|
gtk_about_dialog_set_authors
|
||||||
|
gtk_about_dialog_get_documenters
|
||||||
|
gtk_about_dialog_set_documenters
|
||||||
|
gtk_about_dialog_get_translator_credits
|
||||||
|
gtk_about_dialog_set_translator_credits
|
||||||
|
gtk_about_dialog_get_logo
|
||||||
|
gtk_about_dialog_set_logo
|
||||||
|
GtkAboutDialogActivateLinkFunc
|
||||||
|
gtk_about_dialog_set_email_hook
|
||||||
|
gtk_about_dialog_set_url_hook
|
||||||
|
gtk_show_about_dialog
|
||||||
|
<SUBSECTION Standard>
|
||||||
|
GTK_ABOUT_DIALOG
|
||||||
|
GTK_IS_ABOUT_DIALOG
|
||||||
|
GTK_TYPE_ABOUT_DIALOG
|
||||||
|
GTK_ABOUT_DIALOG_CLASS
|
||||||
|
GTK_IS_ABOUT_DIALOG_CLASS
|
||||||
|
GTK_ABOUT_DIALOG_GET_CLASS
|
||||||
|
<SUBSECTION Private>
|
||||||
|
gtk_about_dialog_get_type
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
<SECTION>
|
<SECTION>
|
||||||
<FILE>gtkaccelgroup</FILE>
|
<FILE>gtkaccelgroup</FILE>
|
||||||
<TITLE>Keyboard Accelerators</TITLE>
|
<TITLE>Keyboard Accelerators</TITLE>
|
||||||
|
268
docs/reference/gtk/tmpl/gtkaboutdialog.sgml
Normal file
268
docs/reference/gtk/tmpl/gtkaboutdialog.sgml
Normal file
@ -0,0 +1,268 @@
|
|||||||
|
<!-- ##### SECTION Title ##### -->
|
||||||
|
GtkAboutDialog
|
||||||
|
|
||||||
|
<!-- ##### SECTION Short_Description ##### -->
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### SECTION See_Also ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### STRUCT GtkAboutDialog ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@parent_instance:
|
||||||
|
|
||||||
|
<!-- ##### 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_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_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_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:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### USER_FUNCTION GtkAboutDialogActivateLinkFunc ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@about:
|
||||||
|
@link:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gtk_about_dialog_set_email_hook ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@func:
|
||||||
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gtk_about_dialog_set_url_hook ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@func:
|
||||||
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gtk_show_about_dialog ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@parent:
|
||||||
|
@first_property_name:
|
||||||
|
@Varargs:
|
||||||
|
|
||||||
|
|
@ -1036,7 +1036,7 @@ gtk_about_dialog_get_documenters (GtkAboutDialog *about)
|
|||||||
/**
|
/**
|
||||||
* gtk_about_dialog_set_documenters:
|
* gtk_about_dialog_set_documenters:
|
||||||
* @about: a #GtkAboutDialog
|
* @about: a #GtkAboutDialog
|
||||||
* @authors: a %NULL-terminated array of strings
|
* @documenters: a %NULL-terminated array of strings
|
||||||
*
|
*
|
||||||
* Sets the strings which are displayed in the documenters tab
|
* Sets the strings which are displayed in the documenters tab
|
||||||
* of the secondary credits dialog.
|
* of the secondary credits dialog.
|
||||||
@ -1092,7 +1092,7 @@ gtk_about_dialog_get_artists (GtkAboutDialog *about)
|
|||||||
/**
|
/**
|
||||||
* gtk_about_dialog_set_artists:
|
* gtk_about_dialog_set_artists:
|
||||||
* @about: a #GtkAboutDialog
|
* @about: a #GtkAboutDialog
|
||||||
* @authors: a %NULL-terminated array of strings
|
* @artists: a %NULL-terminated array of strings
|
||||||
*
|
*
|
||||||
* Sets the strings which are displayed in the artists tab
|
* Sets the strings which are displayed in the artists tab
|
||||||
* of the secondary credits dialog.
|
* of the secondary credits dialog.
|
||||||
@ -1227,7 +1227,7 @@ icon_set_new_from_pixbufs (GList *pixbufs)
|
|||||||
/**
|
/**
|
||||||
* gtk_about_dialog_set_logo:
|
* gtk_about_dialog_set_logo:
|
||||||
* @about: a #GtkAboutDialog
|
* @about: a #GtkAboutDialog
|
||||||
* @pixbuf: a #GdkPixbuf, or %NULL
|
* @logo: a #GdkPixbuf, or %NULL
|
||||||
*
|
*
|
||||||
* Sets the pixbuf to be displayed as logo in
|
* Sets the pixbuf to be displayed as logo in
|
||||||
* the about dialog. If it is %NULL, the default
|
* the about dialog. If it is %NULL, the default
|
||||||
@ -1238,7 +1238,7 @@ icon_set_new_from_pixbufs (GList *pixbufs)
|
|||||||
**/
|
**/
|
||||||
void
|
void
|
||||||
gtk_about_dialog_set_logo (GtkAboutDialog *about,
|
gtk_about_dialog_set_logo (GtkAboutDialog *about,
|
||||||
GdkPixbuf *pixbuf)
|
GdkPixbuf *logo)
|
||||||
{
|
{
|
||||||
GtkAboutDialogPrivate *priv;
|
GtkAboutDialogPrivate *priv;
|
||||||
|
|
||||||
@ -1246,8 +1246,8 @@ gtk_about_dialog_set_logo (GtkAboutDialog *about,
|
|||||||
|
|
||||||
priv = (GtkAboutDialogPrivate *)about->private_data;
|
priv = (GtkAboutDialogPrivate *)about->private_data;
|
||||||
|
|
||||||
if (pixbuf != NULL)
|
if (logo != NULL)
|
||||||
gtk_image_set_from_pixbuf (GTK_IMAGE (priv->logo_image), pixbuf);
|
gtk_image_set_from_pixbuf (GTK_IMAGE (priv->logo_image), logo);
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
GList *pixbufs = gtk_window_get_default_icon_list ();
|
GList *pixbufs = gtk_window_get_default_icon_list ();
|
||||||
@ -1781,7 +1781,7 @@ gtk_about_dialog_set_email_hook (GtkAboutDialogActivateLinkFunc func)
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* gtk_about_dialog_set_email_hook:
|
* gtk_about_dialog_set_url_hook:
|
||||||
* @func: a function to call when a URL link is activated.
|
* @func: a function to call when a URL link is activated.
|
||||||
*
|
*
|
||||||
* Installs a global function to be called whenever the user activates a
|
* Installs a global function to be called whenever the user activates a
|
||||||
|
Loading…
Reference in New Issue
Block a user