GNOME UI Library Reference Manual | ||||
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties |
Synopsis
#include <libgnomeui/libgnomeui.h> struct GnomeAbout; GtkWidget * gnome_about_new (const gchar *name
,const gchar *version
,const gchar *copyright
,const gchar *comments
,const gchar **authors
,const gchar **documenters
,const gchar *translator_credits
,GdkPixbuf *logo_pixbuf
); void gnome_about_construct (GnomeAbout *about
,const gchar *name
,const gchar *version
,const gchar *copyright
,const gchar *comments
,const gchar **authors
,const gchar **documenters
,const gchar *translator_credits
,GdkPixbuf *logo_pixbuf
);
Object Hierarchy
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkContainer +----GtkBin +----GtkWindow +----GtkDialog +----GnomeAbout
Properties
"authors" GValueArray* : Write "comments" gchar* : Read / Write "copyright" gchar* : Read / Write "documenters" GValueArray* : Write "logo" GdkPixbuf* : Write "name" gchar* : Read / Write "translator-credits" gchar* : Read / Write "version" gchar* : Read / Write
Description
The GnomeAbout widget is used as the standard way of displaying credits in an
application. Typically, it will be called when a user selects the
About...
option from the Help
menu. With
one simple function call, the application can then display all of the
appropriate information.
Details
struct GnomeAbout
struct GnomeAbout;
Warning
GnomeAbout
is deprecated and should not be used in newly-written code.
A dialog box widget containing all of the relevant credit information and displaying as three notebook pages.
gnome_about_new ()
GtkWidget * gnome_about_new (const gchar *name
,const gchar *version
,const gchar *copyright
,const gchar *comments
,const gchar **authors
,const gchar **documenters
,const gchar *translator_credits
,GdkPixbuf *logo_pixbuf
);
Warning
gnome_about_new
is deprecated and should not be used in newly-written code.
Construct an application's credits box. The authors
array cannot be empty
and the translator_credits
should be marked as a translatable string (so
that only the translator for the currently active locale is displayed).
|
The name of the application. |
|
The version string of the application. |
|
The application's copyright statement. |
|
A short miscellaneous string. |
|
An NULL terminated array of the application authors. |
|
An array of the application documenters. |
|
The translator for the current locale. |
|
The application's logo. |
Returns : |
A new "About" dialog. |
gnome_about_construct ()
void gnome_about_construct (GnomeAbout *about
,const gchar *name
,const gchar *version
,const gchar *copyright
,const gchar *comments
,const gchar **authors
,const gchar **documenters
,const gchar *translator_credits
,GdkPixbuf *logo_pixbuf
);
Warning
gnome_about_construct
is deprecated and should not be used in newly-written code.
Similar to gnome_about_new()
except that the pre-existing about
widget is
used. Note that in this version of the function, authors
is not checked to
be non-NULL
, so callers must be careful, since bad things will happen if
this condition is not met.
|
An existing GnomeAbout instance. |
|
The name of the application. |
|
The version string of the application. |
|
The application's copyright statement. |
|
A short miscellaneous string. |
|
An NULL terminated array of the application authors. |
|
An array of the application documenters. |
|
The translator for the current locale. |
|
The application's logo. |
Property Details
The "comments"
property
"comments" gchar* : Read / Write
Comments about the program.
Default value: NULL
The "copyright"
property
"copyright" gchar* : Read / Write
Copyright information for the program.
Default value: NULL
The "documenters"
property
"documenters" GValueArray* : Write
List of people documenting the program.
The "translator-credits"
property
"translator-credits" gchar* : Read / Write
Credits to the translators. This string should be marked as translatable.
Default value: NULL
The "version"
property
"version" gchar* : Read / Write
The version of the program.
Default value: NULL