gtk.AboutDialog.AboutDialog Class Reference

Inheritance diagram for gtk.AboutDialog.AboutDialog:

gtk.Dialog.Dialog gdk.Window.Window gdk.Drawable.Drawable gobject.ObjectG.ObjectG List of all members.

Public Member Functions

GtkAboutDialoggetAboutDialogStruct ()
 this (GtkAboutDialog *gtkAboutDialog)
 Sets our main struct and passes it to the parent class.
 this ()
 Creates a new GtkAboutDialog.
char[] getName ()
 Returns the program name displayed in the about dialog.
void setName (char[] name)
 Sets the name to display in the about dialog.
char[] getVersion ()
 Returns the version string.
void setVersion (char[] versio)
 Sets the version string to display in the about dialog.
char[] getCopyright ()
 Returns the copyright string.
void setCopyright (char[] copyright)
 Sets the copyright string to display in the about dialog.
char[] getComments ()
 Returns the comments string.
void setComments (char[] comments)
 Sets the comments string to display in the about dialog.
char[] getLicense ()
 Returns the license information.
void setLicense (char[] license)
 Sets the license information to be displayed in the secondary license dialog.
int getWrapLicense ()
 Returns whether the license text in about is automatically wrapped.
void setWrapLicense (int wrapLicense)
 Sets whether the license text in about is automatically wrapped.
char[] getWebsite ()
 Returns the website URL.
void setWebsite (char[] website)
 Sets the URL to use for the website link.
char[] getWebsiteLabel ()
 Returns the label used for the website link.
void setWebsiteLabel (char[] websiteLabel)
 Sets the label to be used for the website link.
char ** getAuthors ()
 Returns the string which are displayed in the authors tab of the secondary credits dialog.
void setAuthors (char **authors)
 Sets the strings which are displayed in the authors tab of the secondary credits dialog.
char ** getArtists ()
 Returns the string which are displayed in the artists tab of the secondary credits dialog.
void setArtists (char **artists)
 Sets the strings which are displayed in the artists tab of the secondary credits dialog.
char ** getDocumenters ()
 Returns the string which are displayed in the documenters tab of the secondary credits dialog.
void setDocumenters (char **documenters)
 Sets the strings which are displayed in the documenters tab of the secondary credits dialog.
char[] getTranslatorCredits ()
 Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog.
void setTranslatorCredits (char[] translatorCredits)
 Sets the translator credits string which is displayed in the translators tab of the secondary credits dialog.
Pixbuf getLogo ()
 Returns the pixbuf displayed as logo in the about dialog.
void setLogo (Pixbuf logo)
 Sets the pixbuf to be displayed as logo in the about dialog.
char[] getLogoIconName ()
 Returns the icon name displayed as logo in the about dialog.
void setLogoIconName (char[] iconName)
 Sets the pixbuf to be displayed as logo in the about dialog.

Static Public Member Functions

static GtkAboutDialogActivateLinkFunc setEmailHook (GtkAboutDialogActivateLinkFunc func, void *data, GDestroyNotify destroy)
 Installs a global function to be called whenever the user activates an email link in an about dialog.
static GtkAboutDialogActivateLinkFunc setUrlHook (GtkAboutDialogActivateLinkFunc func, void *data, GDestroyNotify destroy)
 Installs a global function to be called whenever the user activates a URL link in an about dialog.
static void showAboutDialog (Window parent, char[] firstPropertyName,...)
 This is a convenience function for showing an application's about box.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

GtkAboutDialoggtkAboutDialog
 the main Gtk struct

Constructor & Destructor Documentation

gtk.AboutDialog.AboutDialog.this ( GtkAboutDialog gtkAboutDialog  ) 

Sets our main struct and passes it to the parent class.

gtk.AboutDialog.AboutDialog.this (  ) 

Creates a new GtkAboutDialog.

Returns: a newly created GtkAboutDialog Since 2.6


Member Function Documentation

GtkAboutDialog* gtk.AboutDialog.AboutDialog.getAboutDialogStruct (  ) 

char** gtk.AboutDialog.AboutDialog.getArtists (  ) 

Returns the string which are displayed in the artists tab of the secondary credits dialog.

about: a GtkAboutDialog Returns: A NULL-terminated string array containing the artists. The array is owned by the about dialog and must not be modified. Since 2.6

char** gtk.AboutDialog.AboutDialog.getAuthors (  ) 

Returns the string which are displayed in the authors tab of the secondary credits dialog.

about: a GtkAboutDialog Returns: A NULL-terminated string array containing the authors. The array is owned by the about dialog and must not be modified. Since 2.6

char [] gtk.AboutDialog.AboutDialog.getComments (  ) 

Returns the comments string.

about: a GtkAboutDialog Returns: The comments. The string is owned by the about dialog and must not be modified. Since 2.6

char [] gtk.AboutDialog.AboutDialog.getCopyright (  ) 

Returns the copyright string.

about: a GtkAboutDialog Returns: The copyright string. The string is owned by the about dialog and must not be modified. Since 2.6

char** gtk.AboutDialog.AboutDialog.getDocumenters (  ) 

Returns the string which are displayed in the documenters tab of the secondary credits dialog.

about: a GtkAboutDialog Returns: A NULL-terminated string array containing the documenters. The array is owned by the about dialog and must not be modified. Since 2.6

char [] gtk.AboutDialog.AboutDialog.getLicense (  ) 

Returns the license information.

about: a GtkAboutDialog Returns: The license information. The string is owned by the about dialog and must not be modified. Since 2.6

Pixbuf gtk.AboutDialog.AboutDialog.getLogo (  ) 

Returns the pixbuf displayed as logo in the about dialog.

about: a GtkAboutDialog Returns: the pixbuf displayed as logo. The pixbuf is owned by the about dialog. If you want to keep a reference to it, you have to call g_object_ref() on it. Since 2.6

char [] gtk.AboutDialog.AboutDialog.getLogoIconName (  ) 

Returns the icon name displayed as logo in the about dialog.

about: a GtkAboutDialog Returns: the icon name displayed as logo. The string is owned by the dialog. If you want to keep a reference to it, you have to call g_strdup() on it. Since 2.6

char [] gtk.AboutDialog.AboutDialog.getName (  ) 

Returns the program name displayed in the about dialog.

about: a GtkAboutDialog Returns: The program name. The string is owned by the about dialog and must not be modified. Since 2.6

void* gtk.AboutDialog.AboutDialog.getStruct (  )  [protected]

the main Gtk struct as a void*

Reimplemented from gtk.Dialog.Dialog.

char [] gtk.AboutDialog.AboutDialog.getTranslatorCredits (  ) 

Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog.

about: a GtkAboutDialog Returns: The translator credits string. The string is owned by the about dialog and must not be modified. Since 2.6

char [] gtk.AboutDialog.AboutDialog.getVersion (  ) 

Returns the version string.

about: a GtkAboutDialog Returns: The version string. The string is owned by the about dialog and must not be modified. Since 2.6

char [] gtk.AboutDialog.AboutDialog.getWebsite (  ) 

Returns the website URL.

about: a GtkAboutDialog Returns: The website URL. The string is owned by the about dialog and must not be modified. Since 2.6

char [] gtk.AboutDialog.AboutDialog.getWebsiteLabel (  ) 

Returns the label used for the website link.

about: a GtkAboutDialog Returns: The label used for the website link. The string is owned by the about dialog and must not be modified. Since 2.6

int gtk.AboutDialog.AboutDialog.getWrapLicense (  ) 

Returns whether the license text in about is automatically wrapped.

about: a GtkAboutDialog Returns: TRUE if the license text is wrapped Since 2.8

void gtk.AboutDialog.AboutDialog.setArtists ( char **  artists  ) 

Sets the strings which are displayed in the artists tab of the secondary credits dialog.

about: a GtkAboutDialog artists: a NULL-terminated array of strings Since 2.6

void gtk.AboutDialog.AboutDialog.setAuthors ( char **  authors  ) 

Sets the strings which are displayed in the authors tab of the secondary credits dialog.

about: a GtkAboutDialog authors: a NULL-terminated array of strings Since 2.6

void gtk.AboutDialog.AboutDialog.setComments ( char[]  comments  ) 

Sets the comments string to display in the about dialog.

This should be a short string of one or two lines. about: a GtkAboutDialog comments: a comments string Since 2.6

void gtk.AboutDialog.AboutDialog.setCopyright ( char[]  copyright  ) 

Sets the copyright string to display in the about dialog.

This should be a short string of one or two lines. about: a GtkAboutDialog copyright: the copyright string Since 2.6

void gtk.AboutDialog.AboutDialog.setDocumenters ( char **  documenters  ) 

Sets the strings which are displayed in the documenters tab of the secondary credits dialog.

about: a GtkAboutDialog documenters: a NULL-terminated array of strings Since 2.6

static GtkAboutDialogActivateLinkFunc gtk.AboutDialog.AboutDialog.setEmailHook ( GtkAboutDialogActivateLinkFunc  func,
void *  data,
GDestroyNotify  destroy 
) [static]

Installs a global function to be called whenever the user activates an email link in an about dialog.

func: a function to call when an email link is activated. data: data to pass to func destroy: GDestroyNotify for data Returns: the previous email hook. Since 2.6

void gtk.AboutDialog.AboutDialog.setLicense ( char[]  license  ) 

Sets the license information to be displayed in the secondary license dialog.

If license is NULL, the license button is hidden. about: a GtkAboutDialog license: the license information or NULL Since 2.6

void gtk.AboutDialog.AboutDialog.setLogo ( Pixbuf  logo  ) 

Sets the pixbuf to be displayed as logo in the about dialog.

If it is NULL, the default window icon set with gtk_window_set_default_icon() will be used. about: a GtkAboutDialog logo: a GdkPixbuf, or NULL Since 2.6

void gtk.AboutDialog.AboutDialog.setLogoIconName ( char[]  iconName  ) 

Sets the pixbuf to be displayed as logo in the about dialog.

If it is NULL, the default window icon set with gtk_window_set_default_icon() will be used. about: a GtkAboutDialog icon_name: an icon name, or NULL Since 2.6

void gtk.AboutDialog.AboutDialog.setName ( char[]  name  ) 

Sets the name to display in the about dialog.

If this is not set, it defaults to g_get_application_name(). about: a GtkAboutDialog name: the program name Since 2.6

void gtk.AboutDialog.AboutDialog.setTranslatorCredits ( char[]  translatorCredits  ) 

Sets the translator credits string which is displayed in the translators tab of the secondary credits dialog.

The intended use for this string is to display the translator of the language which is currently used in the user interface. Using gettext(), a simple way to achieve that is to mark the string for translation: gtk_about_dialog_set_translator_credits (about, _("translator-credits")); It is a good idea to use the customary msgid "translator-credits" for this purpose, since translators will already know the purpose of that msgid, and since GtkAboutDialog will detect if "translator-credits" is untranslated and hide the tab. about: a GtkAboutDialog translator_credits: the translator credits Since 2.6

static GtkAboutDialogActivateLinkFunc gtk.AboutDialog.AboutDialog.setUrlHook ( GtkAboutDialogActivateLinkFunc  func,
void *  data,
GDestroyNotify  destroy 
) [static]

Installs a global function to be called whenever the user activates a URL link in an about dialog.

func: a function to call when a URL link is activated. data: data to pass to func destroy: GDestroyNotify for data Returns: the previous URL hook. Since 2.6

void gtk.AboutDialog.AboutDialog.setVersion ( char[]  versio  ) 

Sets the version string to display in the about dialog.

about: a GtkAboutDialog version: the version string Since 2.6

void gtk.AboutDialog.AboutDialog.setWebsite ( char[]  website  ) 

Sets the URL to use for the website link.

about: a GtkAboutDialog website: a URL string starting with "http://" Since 2.6

void gtk.AboutDialog.AboutDialog.setWebsiteLabel ( char[]  websiteLabel  ) 

Sets the label to be used for the website link.

It defaults to the website URL. about: a GtkAboutDialog website_label: the label used for the website link Since 2.6

void gtk.AboutDialog.AboutDialog.setWrapLicense ( int  wrapLicense  ) 

Sets whether the license text in about is automatically wrapped.

about: a GtkAboutDialog wrap_license: whether to wrap the license Since 2.8

static void gtk.AboutDialog.AboutDialog.showAboutDialog ( Window  parent,
char[]  firstPropertyName,
  ... 
) [static]

This is a convenience function for showing an application's about box.

The constructed dialog is associated with the parent window and reused for future invocations of this function. parent: transient parent, or NULL for none first_property_name: the name of the first property ...: value of first property, followed by more properties, NULL-terminated Since 2.6 Property Details The "artists" property "artists" GStrv : Read / Write The people who contributed artwork to the program, as a NULL-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details. Since 2.6


Member Data Documentation

GtkAboutDialog* gtk.AboutDialog.AboutDialog.gtkAboutDialog [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo